Merge pull request #236 from getyoti/release/3.6.0

Release 3.6.0

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,57 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master, development* ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master, development* ]
+  schedule:
+    - cron: '21 5 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/sonar.yaml

@@ -18,7 +18,7 @@ jobs:
 
       - uses: actions/setup-go@v2
         with:
-          go-version: 1.15
+          go-version: 1.18
 
       - run: go test -json ./... > report.json
 

.github/workflows/tests.yaml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.14, 1.15, 1.16, "^1"]
+        go-version: [1.17, 1.18, "^1"]
 
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -15,3 +15,6 @@ coverage.out
 
 # idea files
 .idea
+
+# Generated binaries
+/_examples/docscan/docscan

.pre-commit-config.yaml

@@ -1,3 +1,5 @@
+default_stages:
+  - commit
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v3.4.0
@@ -25,14 +27,16 @@ repos:
         language: 'script'
         description: "Go imports"
 
-  - repo: git://github.com/dnephin/pre-commit-golang
+  - repo: https://github.com/dnephin/pre-commit-golang
     rev: v0.3.5
     hooks:
       - id: go-vet
         exclude: _examples
       - id: go-cyclo
-        args: [-over=15]
+        exclude: _examples
+        args: [ "-over", "15", "-ignore", ".pb.go" ]
       - id: golangci-lint
         args: ["-e", "SA1019"]
       - id: go-unit-tests
         args: ["-race", "./..."]
+        stages: [ push ] # only run tests on push, not on commit

README.md

@@ -35,13 +35,14 @@ Supported Go Versions:
 
 ## Enabling the SDK
 
-_As of version **2.4.0**, [modules](https://github.com/golang/go/wiki/Modules) are used. This means it's not necessary to get a copy or fetch all dependencies, as the Go toolchain will fetch them as necessary. You can simply add a `require github.com/getyoti/yoti-go-sdk/v3` to go.mod._
-
-You can reference the project URL by adding the following import:
-
+Simply add `github.com/getyoti/yoti-go-sdk/v3` as an import:
 ```Go
 import "github.com/getyoti/yoti-go-sdk/v3"
 ```
+or add the following line to your go.mod file (check https://github.com/getyoti/yoti-go-sdk/releases for the latest version)
+```
+require github.com/getyoti/yoti-go-sdk/v3 v3.0.0
+```
 
 ## Setup
 

_docs/IDV.md

@@ -0,0 +1,9 @@
+ # Yoti IDV (Doc Scan)
+
+ ## About
+ Yoti IDV can be seamlessly integrated with your website, app or custom product so you can perform secure identity checks. You'll be able to request specific ID documents from users directly from your website or app.
+
+ See the [Developer Docs](https://developers.yoti.com/identity-verification/getting-started) for more information.
+
+ ## Running the example
+- See the [_examples/idv](../_examples/idv) folder for instructions on how to run the IDV Example project

_docs/DOC_SCAN_SANDBOX.md → _docs/IDV_SANDBOX.md

@@ -1,6 +1,6 @@
-# Yoti Go Doc Scan Sandbox Module
+# Yoti Go IDV (Doc Scan) Sandbox Module
 
-This module contains the tools you need to test your Go back-end integration with the Doc Scan Sandbox service.
+This module contains the tools you need to test your Go back-end integration with the IDV Sandbox service.
 
 ## Importing the Sandbox
 
@@ -22,4 +22,4 @@ Please do not open the PEM file, as this might corrupt the key, and you will nee
 
 ## Examples
 
-- [Doc Scan Sandbox WebDriver Example](../_examples/docscansandbox/)
+- [IDV Sandbox WebDriver Example](../_examples/docscansandbox/)

_examples/aml/go.mod

@@ -1,10 +1,12 @@
 module aml
 
-go 1.12
+go 1.17
 
 require (
 	github.com/getyoti/yoti-go-sdk/v3 v3.0.0
 	github.com/joho/godotenv v1.3.0
 )
 
+require google.golang.org/protobuf v1.28.0 // indirect
+
 replace github.com/getyoti/yoti-go-sdk/v3 => ../../

_examples/aml/go.sum

@@ -1,24 +1,11 @@
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
-github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
-github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
-github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
 github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=
-github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
-github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
-github.com/spf13/pflag v1.0.3/go.mod h1:DYY7MBk1bdzusC3SYhjObp+wFpr4gzcvqqNjLnInEg4=
-golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
-golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
-golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
-golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
-golang.org/x/tools v0.0.0-20190624222133-a101b041ded4/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
-google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
-google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
-gotest.tools/v3 v3.0.3 h1:4AuOwCGf4lLR9u3YOe2awrHygurzhO/HeQ6laiA6Sx0=
-gotest.tools/v3 v3.0.3/go.mod h1:Z7Lb0S5l+klDB31fvDQX8ss/FlKDxtlFlw3Oa8Ymbl8=
+google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
+google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+gotest.tools/v3 v3.2.0 h1:I0DwBVMGAx26dttAj1BtJLAkVGncrkkUXfJLC4Flt/I=

_examples/docscansandbox/README.md

@@ -1,4 +1,4 @@
-# Doc Scan Sandbox Example
+# IDV (Doc Scan) Sandbox Example
 
 An example of configuring a session response can be found in the [Demo Test](./demo_test.go)
 

_examples/docscansandbox/go.mod

@@ -1,6 +1,6 @@
 module docscansandbox
 
-go 1.12
+go 1.17
 
 require (
 	github.com/cucumber/godog v0.10.0
@@ -10,4 +10,18 @@ require (
 	github.com/tebeka/selenium v0.9.9
 )
 
+require (
+	github.com/blang/semver v3.5.1+incompatible // indirect
+	github.com/cucumber/gherkin-go/v11 v11.0.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/gofrs/uuid v3.2.0+incompatible // indirect
+	github.com/gogo/protobuf v1.3.1 // indirect
+	github.com/hashicorp/go-immutable-radix v1.2.0 // indirect
+	github.com/hashicorp/go-memdb v1.2.1 // indirect
+	github.com/hashicorp/golang-lru v0.5.4 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/testify v1.6.1 // indirect
+	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c // indirect
+)
+
 replace github.com/getyoti/yoti-go-sdk/v3 => ../../