Merge pull request #7 from rarimo/refactor/rename-kyc

Refаctor: rename all 'kyc' occurrences to 'humanornot'
rarimo · Apr 11, 2024 · dd5490a · dd5490a
2 parents deb4dd4 + efb29dd
commit dd5490a
Show file tree

Hide file tree

Showing 58 changed files with 220 additions and 178 deletions.
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -1,4 +1,4 @@
-name: Build KYC service docker image
+name: Build Humanornot service docker image
 on:
   workflow_dispatch:
 

diff --git a/.github/workflows/actions_onlymain.yml b/.github/workflows/actions_onlymain.yml
@@ -1,4 +1,4 @@
-name: Build KYC service docker image
+name: Build Humanornot service docker image
 on:
   push:
     branches:

diff --git a/.github/workflows/tag.yml b/.github/workflows/tag.yml
@@ -1,4 +1,4 @@
-name: Build KYC service docker image
+name: Build Humanornot service docker image
 on:
   push:
     tags:

diff --git a/Dockerfile b/Dockerfile
@@ -2,16 +2,16 @@ FROM golang:1.19-alpine as buildbase
 
 RUN apk add git build-base
 
-WORKDIR /go/src/github.com/rarimo/kyc-service
+WORKDIR /go/src/github.com/rarimo/humanornot-svc
 COPY vendor .
 COPY . .
 
-RUN GOOS=linux go build  -o /usr/local/bin/kyc-service /go/src/github.com/rarimo/kyc-service
+RUN GOOS=linux go build  -o /usr/local/bin/humanornot-svc /go/src/github.com/rarimo/humanornot-svc
 
 
 FROM alpine:3.9
 
-COPY --from=buildbase /usr/local/bin/kyc-service /usr/local/bin/kyc-service
+COPY --from=buildbase /usr/local/bin/humanornot-svc /usr/local/bin/humanornot-svc
 RUN apk add --no-cache ca-certificates
 
-ENTRYPOINT ["kyc-service"]
+ENTRYPOINT ["humanornot-svc"]
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# kyc-service
+# humanornot-svc
 
 ## Description
 
@@ -15,8 +15,8 @@ Integrated identity provider:
 ## Install
 
   ```
-  git clone github.com/rarimo/kyc-service
-  cd kyc-service
+  git clone github.com/rarimo/humanornot-svc
+  cd humanornot-svc
   go build main.go
   export KV_VIPER_FILE=./config.yaml
   ./main migrate up
@@ -47,8 +47,8 @@ Make sure that docker installed.
 use `docker run ` with `-p 8080:80` to expose port 80 to 8080
 
   ```
-  docker build -t github.com/rarimo/kyc-service .
-  docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/kyc-service
+  docker build -t github.com/rarimo/humanornot-svc .
+  docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/humanornot-svc
   ```
 
 ## Running from Source

diff --git a/config.yaml b/config.yaml
@@ -46,12 +46,12 @@ kleros:
   eth_rpc_url:
   proof_of_humanity_contract:
 
-kyc_service:
+humanornot_svc:
   nonce_life_time: 30m
 
 cop:
   disabled: true
   endpoint: "http://..."
   upstream: "http://..."
-  service_name: kyc-service
+  service_name: humanornot-svc
   service_port: 80
diff --git a/docs/.redoclyrc b/docs/.redoclyrc
@@ -1,5 +1,5 @@
 
-apiTitle: kyc-service
+apiTitle: humanornot-svc
 splitSpec: true
 codeSamples: false
 swaggerUI: true

diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "kyc-service",
+  "name": "humanornot-svc",
   "version": "1.0.0",
   "dependencies": {
     "@tokend/redoc-cli": "^0.9.9",

diff --git a/docs/spec/components/schemas/VerifyStatus.yaml b/docs/spec/components/schemas/VerifyStatus.yaml
@@ -21,4 +21,4 @@ allOf:
             description: Verification status of the account.
           claim_id:
             type: string
-            description: KYC claim ID.
+            description: Humanornot claim ID.
diff --git a/docs/spec/openapi.yaml b/docs/spec/openapi.yaml
@@ -1,5 +1,5 @@
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: kyc-service
+  title: humanornot-svc
   description: ''
diff --git a/...grations@kyc-service@v1@public@nonce.yaml → ...tions@humanornot-svc@v1@public@nonce.yaml b/...grations@kyc-service@v1@public@nonce.yaml → ...tions@humanornot-svc@v1@public@nonce.yaml
diff --git a/...e@v1@public@status@{verification-id}.yaml → ...c@v1@public@status@{verification-id}.yaml b/...e@v1@public@status@{verification-id}.yaml → ...c@v1@public@status@{verification-id}.yaml
diff --git a/...v1@public@verify@{identity-provider}.yaml → ...v1@public@verify@{identity-provider}.yaml b/...v1@public@verify@{identity-provider}.yaml → ...v1@public@verify@{identity-provider}.yaml
@@ -34,7 +34,7 @@ post:
     '400':
       description: Bad request
     '401':
-      description: Unauthorized. KYC failed
+      description: Unauthorized. Humanornot failed to check humanity.
       content:
         application/json:
           schema:

diff --git a/...ice@v1@public@{identity-id}@provider.yaml → ...svc@v1@public@{identity-id}@provider.yaml b/...ice@v1@public@{identity-id}@provider.yaml → ...svc@v1@public@{identity-id}@provider.yaml
diff --git a/docs/web/index.hbs b/docs/web/index.hbs
@@ -3,7 +3,7 @@
 
 <head>
     <meta charset="utf8" />
-    <title>kyc-service Service Documentation</title>
+    <title>humanornot-svc Service Documentation</title>
     <!-- needed for adaptive design -->
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <style>

diff --git a/docs/web/index.html b/docs/web/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>kyc-service | ReDoc</title>
+    <title>humanornot-svc | ReDoc</title>
     <!-- needed for adaptive design -->
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <link rel="icon" type="image/png" href="favicon.png">

diff --git a/generate.sh b/generate.sh
@@ -3,8 +3,8 @@
 GENERATOR_IMAGE=registry.gitlab.com/tokend/openapi-go-generator:69f004b58152c83f007b593cc13e94b81d7200da
 
 
-GENERATED="${GOPATH}/src/github.com/rarimo/kyc-service/resources"
-OPENAPI_DIR="${GOPATH}/src/github.com/rarimo/kyc-service/docs/web_deploy"
+GENERATED="${GOPATH}/src/github.com/rarimo/humanornot-svc/resources"
+OPENAPI_DIR="${GOPATH}/src/github.com/rarimo/humanornot-svc/docs/web_deploy"
 PACKAGE_NAME=resources
 
 function printHelp {

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/rarimo/kyc-service
+module github.com/rarimo/humanornot-svc
 
 go 1.21
 

diff --git a/internal/cli/main.go b/internal/cli/main.go
@@ -7,14 +7,14 @@ import (
 	"sync"
 	"syscall"
 
-	nonceCleaner "github.com/rarimo/kyc-service/internal/service/nonce_cleaner"
+	nonceCleaner "github.com/rarimo/humanornot-svc/internal/service/nonce_cleaner"
 
 	"github.com/alecthomas/kingpin"
 	"gitlab.com/distributed_lab/kit/kv"
 	"gitlab.com/distributed_lab/logan/v3"
 
-	"github.com/rarimo/kyc-service/internal/config"
-	"github.com/rarimo/kyc-service/internal/service/api"
+	"github.com/rarimo/humanornot-svc/internal/config"
+	"github.com/rarimo/humanornot-svc/internal/service/api"
 )
 
 func Run(args []string) bool {
@@ -29,7 +29,7 @@ func Run(args []string) bool {
 	cfg := config.New(kv.MustFromEnv())
 	log = cfg.Log()
 
-	app := kingpin.New("kyc-service", "")
+	app := kingpin.New("humanornot-svc", "")
 
 	runCmd := app.Command("run", "run command")
 	serviceCmd := runCmd.Command("service", "run service")

diff --git a/internal/cli/migrate.go b/internal/cli/migrate.go
@@ -4,8 +4,8 @@ import (
 	migrate "github.com/rubenv/sql-migrate"
 	"gitlab.com/distributed_lab/logan/v3/errors"
 
-	"github.com/rarimo/kyc-service/internal/assets"
-	"github.com/rarimo/kyc-service/internal/config"
+	"github.com/rarimo/humanornot-svc/internal/assets"
+	"github.com/rarimo/humanornot-svc/internal/config"
 )
 
 var migrations = &migrate.EmbedFileSystemMigrationSource{

diff --git a/internal/cli/models.go b/internal/cli/models.go
@@ -3,7 +3,7 @@ package cli
 import (
 	"context"
 
-	"github.com/rarimo/kyc-service/internal/config"
+	"github.com/rarimo/humanornot-svc/internal/config"
 )
 
 type (

diff --git a/internal/config/kyc_service.go b/internal/config/kyc_service.go
@@ -8,21 +8,21 @@ import (
 	"gitlab.com/distributed_lab/kit/kv"
 )
 
-type KYCService struct {
+type HumanornotSvc struct {
 	NonceLifeTime time.Duration `fig:"nonce_life_time,required"`
 }
 
-func (c *config) KYCService() *KYCService {
-	return c.kycService.Do(func() interface{} {
-		cfg := KYCService{}
+func (c *config) HumanornotSvc() *HumanornotSvc {
+	return c.humanOrNotSvc.Do(func() interface{} {
+		cfg := HumanornotSvc{}
 		err := figure.
 			Out(&cfg).
-			From(kv.MustGetStringMap(c.getter, "kyc_service")).
+			From(kv.MustGetStringMap(c.getter, "humanornot_svc")).
 			Please()
 		if err != nil {
 			panic(errors.Wrap(err, "failed to figure out"))
 		}
 
 		return &cfg
-	}).(*KYCService)
+	}).(*HumanornotSvc)
 }
diff --git a/internal/config/main.go b/internal/config/main.go
@@ -20,7 +20,7 @@ type Config interface {
 	GitcoinPassportSettings() *GitcoinPassportSettings
 	Kleros() *Kleros
 	Issuer() *Issuer
-	KYCService() *KYCService
+	HumanornotSvc() *HumanornotSvc
 }
 
 type config struct {
@@ -36,7 +36,7 @@ type config struct {
 	worldcoinSettings       comfig.Once
 	kleros                  comfig.Once
 	issuer                  comfig.Once
-	kycService              comfig.Once
+	humanOrNotSvc           comfig.Once
 }
 
 func New(getter kv.Getter) Config {

diff --git a/internal/data/pg/main.go b/internal/data/pg/main.go
@@ -3,7 +3,7 @@ package pg
 import (
 	"gitlab.com/distributed_lab/kit/pgdb"
 
-	"github.com/rarimo/kyc-service/internal/data"
+	"github.com/rarimo/humanornot-svc/internal/data"
 )
 
 const (

diff --git a/internal/data/pg/nonces.go b/internal/data/pg/nonces.go
@@ -7,7 +7,7 @@ import (
 
 	"github.com/ethereum/go-ethereum/common"
 
-	"github.com/rarimo/kyc-service/internal/data"
+	"github.com/rarimo/humanornot-svc/internal/data"
 
 	sq "github.com/Masterminds/squirrel"
 	"github.com/fatih/structs"

diff --git a/internal/data/pg/users.go b/internal/data/pg/users.go
@@ -11,7 +11,7 @@ import (
 	sq "github.com/Masterminds/squirrel"
 	"github.com/ethereum/go-ethereum/common"
 
-	"github.com/rarimo/kyc-service/internal/data"
+	"github.com/rarimo/humanornot-svc/internal/data"
 )
 
 type usersQ struct {

diff --git a/internal/service/api/handlers/ctx.go b/internal/service/api/handlers/ctx.go
@@ -6,14 +6,14 @@ import (
 
 	"gitlab.com/distributed_lab/logan/v3"
 
-	"github.com/rarimo/kyc-service/internal/service/core"
+	"github.com/rarimo/humanornot-svc/internal/service/core"
 )
 
 type ctxKey int
 
 const (
 	logCtxKey ctxKey = iota
-	kycServiceCtxKey
+	humanOrNotServiceCtxKey
 )
 
 func CtxLog(entry *logan.Entry) func(context.Context) context.Context {
@@ -26,12 +26,12 @@ func Log(r *http.Request) *logan.Entry {
 	return r.Context().Value(logCtxKey).(*logan.Entry)
 }
 
-func CtxKYCService(kycService core.KYCService) func(context.Context) context.Context {
+func CtxHumanornotSvc(humanOrNotSvc core.HumanornotSvc) func(context.Context) context.Context {
 	return func(ctx context.Context) context.Context {
-		return context.WithValue(ctx, kycServiceCtxKey, kycService)
+		return context.WithValue(ctx, humanOrNotServiceCtxKey, humanOrNotSvc)
 	}
 }
 
-func KYCService(r *http.Request) core.KYCService {
-	return r.Context().Value(kycServiceCtxKey).(core.KYCService).New()
+func HumanornotSvc(r *http.Request) core.HumanornotSvc {
+	return r.Context().Value(humanOrNotServiceCtxKey).(core.HumanornotSvc).New()
 }
diff --git a/internal/service/api/handlers/get_provider_by_identity_id.go b/internal/service/api/handlers/get_provider_by_identity_id.go
@@ -4,9 +4,9 @@ import (
 	"net/http"
 
 	"github.com/pkg/errors"
-	"github.com/rarimo/kyc-service/internal/service/api/requests"
-	identityproviders "github.com/rarimo/kyc-service/internal/service/core/identity_providers"
-	"github.com/rarimo/kyc-service/resources"
+	"github.com/rarimo/humanornot-svc/internal/service/api/requests"
+	identityproviders "github.com/rarimo/humanornot-svc/internal/service/core/identity_providers"
+	"github.com/rarimo/humanornot-svc/resources"
 	"gitlab.com/distributed_lab/ape"
 	"gitlab.com/distributed_lab/ape/problems"
 )
@@ -19,7 +19,7 @@ func GetProviderByIdentityId(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	provider, err := KYCService(r).GetProviderByIdentityId(req)
+	provider, err := HumanornotSvc(r).GetProviderByIdentityId(req)
 	switch {
 	case errors.Is(err, identityproviders.ErrProviderNotFound), errors.Is(err, identityproviders.ErrUserNotFound):
 		Log(r).WithField("reason", err).Debug("Not found")

diff --git a/internal/service/api/handlers/nonce.go b/internal/service/api/handlers/nonce.go
@@ -6,8 +6,8 @@ import (
 	"gitlab.com/distributed_lab/ape"
 	"gitlab.com/distributed_lab/ape/problems"
 
-	"github.com/rarimo/kyc-service/internal/service/api/requests"
-	"github.com/rarimo/kyc-service/internal/service/api/responses"
+	"github.com/rarimo/humanornot-svc/internal/service/api/requests"
+	"github.com/rarimo/humanornot-svc/internal/service/api/responses"
 )
 
 func GetNonce(w http.ResponseWriter, r *http.Request) {
@@ -17,7 +17,7 @@ func GetNonce(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	nonce, err := KYCService(r).NewNonce(req)
+	nonce, err := HumanornotSvc(r).NewNonce(req)
 	switch {
 	case err != nil:
 		Log(r).WithError(err).Error("Failed to create new nonce")

diff --git a/internal/service/api/handlers/verify.go b/internal/service/api/handlers/verify.go
@@ -7,16 +7,16 @@ import (
 	"gitlab.com/distributed_lab/ape"
 	"gitlab.com/distributed_lab/ape/problems"
 
-	providers "github.com/rarimo/kyc-service/internal/service/core/identity_providers"
-	"github.com/rarimo/kyc-service/internal/service/core/identity_providers/civic"
-	gcpsp "github.com/rarimo/kyc-service/internal/service/core/identity_providers/gitcoin_passport"
-	"github.com/rarimo/kyc-service/internal/service/core/identity_providers/kleros"
-	"github.com/rarimo/kyc-service/internal/service/core/identity_providers/worldcoin"
+	providers "github.com/rarimo/humanornot-svc/internal/service/core/identity_providers"
+	"github.com/rarimo/humanornot-svc/internal/service/core/identity_providers/civic"
+	gcpsp "github.com/rarimo/humanornot-svc/internal/service/core/identity_providers/gitcoin_passport"
+	"github.com/rarimo/humanornot-svc/internal/service/core/identity_providers/kleros"
+	"github.com/rarimo/humanornot-svc/internal/service/core/identity_providers/worldcoin"
 
-	"github.com/rarimo/kyc-service/internal/data"
-	"github.com/rarimo/kyc-service/internal/service/api/requests"
-	"github.com/rarimo/kyc-service/internal/service/api/responses"
-	"github.com/rarimo/kyc-service/internal/service/core"
+	"github.com/rarimo/humanornot-svc/internal/data"
+	"github.com/rarimo/humanornot-svc/internal/service/api/requests"
+	"github.com/rarimo/humanornot-svc/internal/service/api/responses"
+	"github.com/rarimo/humanornot-svc/internal/service/core"
 )
 
 func Verify(w http.ResponseWriter, r *http.Request) {
@@ -27,7 +27,7 @@ func Verify(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	user, err := KYCService(r).NewVerifyRequest(req)
+	user, err := HumanornotSvc(r).NewVerifyRequest(req)
 	switch {
 	case errors.Is(err, providers.ErrInvalidVerificationData):
 		Log(r).WithField("reason", err).