chore(name): rename jwt-block to jwtblock (#8)

.github/workflows/release.yaml

@@ -52,7 +52,7 @@ jobs:
 
       - name: Update pkg.go.dev records
         if: github.ref_type == 'tag'
-        run: go list -m "github.com/divergentcodes/jwt-block@${{ github.ref_name }}"
+        run: go list -m "github.com/divergentcodes/jwtblock@${{ github.ref_name }}"
         env:
           GOPROXY: proxy.golang.org
 

.goreleaser.yaml

@@ -1,7 +1,7 @@
 # GoReleaser configuration.
 # Documentation: https://goreleaser.com
 
-project_name: jwt-block
+project_name: jwtblock
 
 before:
   hooks:
@@ -24,10 +24,10 @@ builds:
       # -w  disable DWARF generation
       - '-w'
       # -X  set module variables at build time
-      - '-X github.com/divergentcodes/jwt-block/internal/core.Version={{.Version}}'
-      - '-X github.com/divergentcodes/jwt-block/internal/core.Commit={{.Commit}}'
-      - '-X github.com/divergentcodes/jwt-block/internal/core.Date={{.Date}}'
-      - '-X github.com/divergentcodes/jwt-block/internal/core.BuiltBy=goreleaser'
+      - '-X github.com/divergentcodes/jwtblock/internal/core.Version={{.Version}}'
+      - '-X github.com/divergentcodes/jwtblock/internal/core.Commit={{.Commit}}'
+      - '-X github.com/divergentcodes/jwtblock/internal/core.Date={{.Date}}'
+      - '-X github.com/divergentcodes/jwtblock/internal/core.BuiltBy=goreleaser'
 
 dockers:
   -

Dockerfile

@@ -1,12 +1,12 @@
 FROM golang:alpine AS builder
-# Where to find the local built jwt-block binary.
+# Where to find the local built jwtblock binary.
 ARG SRC_BIN_DIR="."
 # Create an unprivileged user.
 RUN adduser --system --no-create-home app
 # Create an unprivileged runtime location with the binary.
 RUN mkdir /app
 # Copy the Golang binary.
-COPY ${SRC_BIN_DIR}/jwt-block /app/jwt-block
+COPY ${SRC_BIN_DIR}/jwtblock /app/jwtblock
 RUN chown -R app /app
 
 
@@ -17,5 +17,5 @@ COPY --from=builder /app /app
 # Run as the unprivileged user.
 USER app
 
-ENTRYPOINT ["/app/jwt-block"]
+ENTRYPOINT ["/app/jwtblock"]
 CMD ["serve"]

README.md

@@ -1,7 +1,7 @@
 # JWT Block
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/divergentcodes/jwt-block.svg)](https://pkg.go.dev/github.com/divergentcodes/jwt-block)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/DivergentCodes/jwt-block/release.yaml?style=flat-square)](https://github.com/DivergentCodes/jwt-block/actions?query=workflow%3Arelease)
+[![Go Reference](https://pkg.go.dev/badge/github.com/divergentcodes/jwtblock.svg)](https://pkg.go.dev/github.com/divergentcodes/jwtblock)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/DivergentCodes/jwtblock/release.yaml?style=flat-square)](https://github.com/DivergentCodes/jwtblock/actions?query=workflow%3Arelease)
 
 Exploring the feasability and performance of a JWT blocklist.
 
@@ -13,13 +13,13 @@ It is a standalone binary that requires a Redis instance to store the blocklist.
 
 ## Installation
 
-Download the [binary release](https://github.com/DivergentCodes/jwt-block/releases) for your platform,
+Download the [binary release](https://github.com/DivergentCodes/jwtblock/releases) for your platform,
 and place it in the executable path.
 
-JWT Block is also available as [a Docker image](https://hub.docker.com/r/divergentcodes/jwt-block).
+JWT Block is also available as [a Docker image](https://hub.docker.com/r/divergentcodes/jwtblock).
 
 ```
-docker run -it --rm divergentcodes/jwt-block:latest
+docker run -it --rm divergentcodes/jwtblock:latest
 ```
 
 
@@ -29,7 +29,7 @@ docker run -it --rm divergentcodes/jwt-block:latest
 JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.
 
 Usage:
-  jwt-block [command]
+  jwtblock [command]
 
 Available Commands:
   block       Block a JWT
@@ -41,12 +41,12 @@ Available Commands:
   serve       Serve the web API
   status      Get status of the blocklist
   unblock     Unblock a JWT
-  version     Print the version of jwt-block
+  version     Print the version of jwtblock
 
 Flags:
-      --config string       config file (default is ./jwt-block.yaml)
+      --config string       config file (default is ./jwtblock.yaml)
       --debug               Enable debug mode
-  -h, --help                help for jwt-block
+  -h, --help                help for jwtblock
       --json                Use JSON output
   -q, --quiet               Quiet CLI output
       --redis-dbnum int     Redis DB number
@@ -58,7 +58,7 @@ Flags:
       --redis-user string   Redis username
       --verbose             Verbose CLI output
 
-Use "jwt-block [command] --help" for more information about a command.
+Use "jwtblock [command] --help" for more information about a command.
 ```
 
 ## Configuration

RELEASE.md

@@ -15,9 +15,9 @@ git tag "v1.0.2-alpha03"; git push --tags
 The `release` Github Actions workflow will be triggered, running GoReleaser.
 A new binary will be built, a Docker image and documentation with be pushed.
 
-Pull the latest image: `docker pull divergentcodes/jwt-block:latest`
+Pull the latest image: `docker pull divergentcodes/jwtblock:latest`
 
-View the latest Docker release: https://hub.docker.com/r/divergentcodes/jwt-block
+View the latest Docker release: https://hub.docker.com/r/divergentcodes/jwtblock
 
 
 ## Changelog Updates
@@ -32,10 +32,10 @@ To be included in a changelog, PR titles must be one of these prefixes:
 
 ## Links
 
-- Binary downloads: https://github.com/DivergentCodes/jwt-block/releases
+- Binary downloads: https://github.com/DivergentCodes/jwtblock/releases
 
-- Docker images: https://hub.docker.com/r/divergentcodes/jwt-block
+- Docker images: https://hub.docker.com/r/divergentcodes/jwtblock
 
-- JWT Block docs: https://pkg.go.dev/github.com/divergentcodes/jwt-block
+- JWT Block docs: https://pkg.go.dev/github.com/divergentcodes/jwtblock
 
 

cmd/jwt-block/block.go → cmd/jwtblock/block.go

@@ -7,9 +7,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var (

cmd/jwt-block/check.go → cmd/jwtblock/check.go

@@ -7,9 +7,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var (

cmd/jwt-block/flush.go → cmd/jwtblock/flush.go

@@ -7,9 +7,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var flushCmd = &cobra.Command{

cmd/jwt-block/list.go → cmd/jwtblock/list.go

@@ -8,9 +8,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var listCmd = &cobra.Command{

cmd/jwt-block/openapi.go → cmd/jwtblock/openapi.go

@@ -6,14 +6,14 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
-	"github.com/divergentcodes/jwt-block/web"
+	"github.com/divergentcodes/jwtblock/internal/core"
+	"github.com/divergentcodes/jwtblock/web"
 )
 
 var openapiCmd = &cobra.Command{
 	Use:   "openapi",
-	Short: "Generate OpenAPI specs for jwt-block",
-	Long:  "Generate OpenAPI specs for jwt-block",
+	Short: "Generate OpenAPI specs for jwtblock",
+	Long:  "Generate OpenAPI specs for jwtblock",
 	Run:   openapi,
 }
 

cmd/jwt-block/root.go → cmd/jwtblock/root.go

@@ -3,7 +3,7 @@ JWT Block is a blocklist & auth proxy service for JWTs, to support immediate ter
 
 Usage:
 
-	jwt-block [command]
+	jwtblock [command]
 
 Available Commands:
 
@@ -16,13 +16,13 @@ Available Commands:
 	serve       Serve the web API
 	status      Get status of the blocklist
 	unblock     Unblock a JWT
-	version     Print the version of jwt-block
+	version     Print the version of jwtblock
 
 Flags:
 
-	    --config string       config file (default is ./jwt-block.yaml)
+	    --config string       config file (default is ./jwtblock.yaml)
 	    --debug               Enable debug mode
-	-h, --help                help for jwt-block
+	-h, --help                help for jwtblock
 	    --json                Use JSON output
 	-q, --quiet               Quiet CLI output
 	    --redis-dbnum int     Redis DB number
@@ -42,12 +42,12 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var (
 	rootCmd = &cobra.Command{
-		Use:   "jwt-block",
+		Use:   "jwtblock",
 		Short: "A JWT blocklist & auth proxy service",
 		Long:  `JWT Block is a blocklist & auth proxy service for JWTs, to support immediate termination of access, since access tokens cannot truly be revoked.`,
 	}
@@ -64,7 +64,7 @@ func initRootFlags() {
 
 	// config
 	var cfgFile string
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is ./jwt-block.yaml)")
+	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is ./jwtblock.yaml)")
 	if cfgFile != "" {
 		// Use config file from the flag.
 		viper.SetConfigFile(cfgFile)

cmd/jwt-block/serve.go → cmd/jwtblock/serve.go

@@ -6,9 +6,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
-	"github.com/divergentcodes/jwt-block/web"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
+	"github.com/divergentcodes/jwtblock/web"
 )
 
 var (
@@ -82,6 +82,6 @@ func serve(cmd *cobra.Command, args []string) {
 
 	host := viper.GetString(core.OptStr_HttpHostname)
 	port := viper.GetInt(core.OptStr_HttpPort)
-	fmt.Printf("Serving the jwt-block web API on %s:%d\n", host, port)
+	fmt.Printf("Serving the jwtblock web API on %s:%d\n", host, port)
 	web.HandleRequests(host, port)
 }

cmd/jwt-block/status.go → cmd/jwtblock/status.go

@@ -7,9 +7,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var statusCmd = &cobra.Command{

cmd/jwt-block/unblock.go → cmd/jwtblock/unblock.go

@@ -7,9 +7,9 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/blocklist"
-	"github.com/divergentcodes/jwt-block/internal/cache"
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/blocklist"
+	"github.com/divergentcodes/jwtblock/internal/cache"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var (

cmd/jwt-block/version.go → cmd/jwtblock/version.go

@@ -5,13 +5,13 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 var versionCmd = &cobra.Command{
 	Use:   "version",
-	Short: "Print the version of jwt-block",
-	Long:  `Print the version of jwt-block`,
+	Short: "Print the version of jwtblock",
+	Long:  `Print the version of jwtblock`,
 	Run:   version,
 }
 

examples/docker-compose/docker-compose.yaml

@@ -83,12 +83,12 @@ services:
 
   # The JWT Block auth service.
   jwtblock:
-    image: "divergentcodes/jwt-block:local"
+    image: "divergentcodes/jwtblock:local"
     build:
       context: "./../../"
       dockerfile: "Dockerfile"
       args:
-        - SRC_BIN_DIR=./dist/jwt-block_linux_amd64_v1
+        - SRC_BIN_DIR=./dist/jwtblock_linux_amd64_v1
     environment:
       - JWTBLOCK_DEBUG=1
       - JWTBLOCK_REDIS_HOST=cache

go.mod

@@ -1,4 +1,4 @@
-module github.com/divergentcodes/jwt-block
+module github.com/divergentcodes/jwtblock
 
 go 1.20
 

internal/blocklist/block.go

@@ -7,8 +7,8 @@ import (
 	"github.com/redis/go-redis/v9"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
-	"github.com/divergentcodes/jwt-block/internal/crypto"
+	"github.com/divergentcodes/jwtblock/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/crypto"
 )
 
 // A BlockResult contains the result of trying to block a token.

internal/blocklist/block_test.go

@@ -16,8 +16,8 @@ import (
 	"github.com/lestrrat-go/jwx/v2/jwt"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
-	"github.com/divergentcodes/jwt-block/internal/crypto"
+	"github.com/divergentcodes/jwtblock/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/crypto"
 )
 
 var rsaPublicKey string = `-----BEGIN PUBLIC KEY-----

internal/blocklist/check.go

@@ -3,7 +3,7 @@ package blocklist
 import (
 	"github.com/redis/go-redis/v9"
 
-	"github.com/divergentcodes/jwt-block/internal/crypto"
+	"github.com/divergentcodes/jwtblock/internal/crypto"
 )
 
 // A CheckResult contains the result of checking for a token in the blocklist.

internal/blocklist/check_test.go

@@ -8,8 +8,8 @@ import (
 	"github.com/go-redis/redismock/v9"
 	"github.com/spf13/viper"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
-	"github.com/divergentcodes/jwt-block/internal/crypto"
+	"github.com/divergentcodes/jwtblock/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/crypto"
 )
 
 func Test_CheckByJwt_ValidToken_ExistsFound_Success(t *testing.T) {

internal/blocklist/flush.go

@@ -3,7 +3,7 @@ package blocklist
 import (
 	"github.com/redis/go-redis/v9"
 
-	"github.com/divergentcodes/jwt-block/internal/core"
+	"github.com/divergentcodes/jwtblock/internal/core"
 )
 
 // A FlushResult contains the result of checking for a token in the blocklist.