BREAKING CHANGE: rename CassetteMaker, WithCassetteCrypto*, WithCasse…

…tteCrypter* (#97)

BREAKING CHANGE: rename CassetteMaker to CassetteLoader
BREAKING CHANGE: Rename WithCassetteCrypto* to WithCipher
BREAKING CHANGE: Rename WithCassetteCrypter to WithCrypter
ci: Update linter config

.golangci.yml

@@ -616,11 +616,6 @@ linters-settings:
     # Default: false
     check-exported: true
 
-  varcheck:
-    # Check usage of exported fields and variables.
-    # Default: false
-    exported-fields: true
-
 linters:
   # Disable all linters.
   # Default: false
@@ -634,7 +629,6 @@ linters:
     - containedctx
     - contextcheck
     - cyclop
-    - deadcode
     # - decorder
     # - depguard
     - dogsled
@@ -695,7 +689,6 @@ linters:
     #- scopelint
     - sqlclosecheck
     - staticcheck
-    - structcheck
     - stylecheck
     - tagliatelle
     - tenv
@@ -706,7 +699,6 @@ linters:
     - unconvert
     - unparam
     - unused
-    - varcheck
     # - varnamelen
     # - wastedassign
     # - whitespace

README.md

@@ -24,12 +24,12 @@
     <img src="https://github.com/seborama/govcr/actions/workflows/codeql-analysis.yml/badge.svg?branch=master" alt="govcr">
   </a>
 
-  <a href="https://pkg.go.dev/github.com/seborama/govcr/v10">
+  <a href="https://pkg.go.dev/github.com/seborama/govcr/v11">
     <img src="https://img.shields.io/badge/godoc-reference-blue.svg" alt="govcr">
   </a>
 
-  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v10">
-    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v10" alt="govcr">
+  <a href="https://goreportcard.com/report/github.com/seborama/govcr/v11">
+    <img src="https://goreportcard.com/badge/github.com/seborama/govcr/v11" alt="govcr">
   </a>
 </p>
 
@@ -77,7 +77,7 @@ This project is an adaptation for Google's Go / Golang programming language.
 
 func TestExample1() {
     vcr := govcr.NewVCR(
-        govcr.NewCassetteMaker("MyCassette1.json"),
+        govcr.NewCassetteLoader("MyCassette1.json"),
         govcr.WithRequestMatcher(govcr.NewMethodURLRequestMatcher()), // use a "relaxed" request matcher
     )
 
@@ -98,15 +98,15 @@ We use a "relaxed" request matcher because `example.com` injects an "`Age`" head
 ## Install
 
 ```bash
-go get github.com/seborama/govcr/v10@latest
+go get github.com/seborama/govcr/v11@latest
 ```
 
 For all available releases, please check the [releases](https://github.com/seborama/govcr/releases) tab on github.
 
 And your source code would use this import:
 
 ```go
-import "github.com/seborama/govcr/v10"
+import "github.com/seborama/govcr/v11"
 ```
 
 For versions of **govcr** before v5 (which don't use go.mod), use a dependency manager to lock the version you wish to use (perhaps v4)!
@@ -136,7 +136,7 @@ go get gopkg.in/seborama/govcr.v4
 
 **govcr** is a wrapper around the Go `http.Client`. It can record live HTTP traffic to files (called "**cassettes**") and later replay HTTP requests ("**tracks**") from them instead of live HTTP calls.
 
-The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v10).
+The code documentation can be found on [godoc](https://pkg.go.dev/github.com/seborama/govcr/v11).
 
 When using **govcr**'s `http.Client`, the request is matched against the **tracks** on the '**cassette**':
 
@@ -286,7 +286,7 @@ func TestExample2() {
 
     // Instantiate VCR.
     vcr := govcr.NewVCR(
-        govcr.NewCassetteMaker(exampleCassetteName2),
+        govcr.NewCassetteLoader(exampleCassetteName2),
         govcr.WithClient(app.httpClient),
     )
 
@@ -309,7 +309,7 @@ Remove Response.TLS from the cassette **recording**:
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     govcr.WithTrackRecordingMutators(track.ResponseDeleteTLS()),
     //             ^^^^^^^^^
 )
@@ -322,7 +322,7 @@ Remove Response.TLS from the track at **playback** time:
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     govcr.WithTrackReplayingMutators(track.ResponseDeleteTLS()),
     //             ^^^^^^^^^
 )
@@ -346,7 +346,7 @@ vcr.AddReplayingMutators(track.ResponseDeleteTLS())
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     // Normal mode is default, no special option required :)
 )
 // or equally:
@@ -357,7 +357,7 @@ vcr.SetNormalMode()
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     govcr.WithLiveOnlyMode(),
 )
 // or equally:
@@ -368,7 +368,7 @@ vcr.SetLiveOnlyMode()
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     govcr.WithReadOnlyMode(),
 )
 // or equally:
@@ -379,7 +379,7 @@ vcr.SetReadOnlyMode(true) // `false` to disable option
 
 ```go
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName2),
+    govcr.NewCassetteLoader(exampleCassetteName2),
     govcr.WithOfflineMode(),
 )
 // or equally:
@@ -396,11 +396,10 @@ At time of creating a new VCR with **govcr**:
 // See TestExample4 in tests for fully working example.
 
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName4).
-        WithCassetteCrypto(
+    govcr.NewCassetteLoader(exampleCassetteName4).
+        WithCipher(
             encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
-            "test-fixtures/TestExample4.unsafe.key",
-        ),
+            "test-fixtures/TestExample4.unsafe.key"),
 )
 ```
 
@@ -410,7 +409,7 @@ Or, at time of loading a cassette from the `ControlPanel`:
 // See TestExample4 in tests for fully working example.
 err := vcr.LoadCassette(
     exampleCassetteName4,
-    govcr.WithCassetteCrypto(
+    govcr.WithCipher(
         encryption.NewChaCha20Poly1305WithRandomNonceGenerator,
         "test-fixtures/TestExample4.unsafe.key"),
 )
@@ -436,12 +435,11 @@ func (ng myNonceGenerator) Generate() ([]byte, error) {
 }
 
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName4).
-        WithCassetteCryptoCustomNonce(
+    govcr.NewCassetteLoader(exampleCassetteName4).
+        WithCipherCustomNonce(
             encryption.NewChaCha20Poly1305,
             "test-fixtures/TestExample4.unsafe.key",
-            nonceGenerator,
-        ),
+            nonceGenerator),
 )
 ```
 
@@ -454,7 +452,7 @@ vcr := govcr.NewVCR(
 The command is located in the `cmd/govcr` folder, to install it:
 
 ```bash
-go install github.com/seborama/govcr/v10/cmd/govcr@latest
+go install github.com/seborama/govcr/v11/cmd/govcr@latest
 ```
 
 Example usage:
@@ -517,7 +515,7 @@ How you specifically tackle this in practice really depends on how the API you a
 func TestExample3(t *testing.T) {
 // Instantiate VCR.
 vcr := govcr.NewVCR(
-    govcr.NewCassetteMaker(exampleCassetteName3),
+    govcr.NewCassetteLoader(exampleCassetteName3),
     govcr.WithRequestMatcher(
         govcr.NewBlankRequestMatcher(
             govcr.WithRequestMatcherFunc(

cassette/cassette.go

@@ -14,11 +14,11 @@ import (
 	"github.com/google/uuid"
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v10/cassette/track"
-	"github.com/seborama/govcr/v10/compression"
-	cryptoerr "github.com/seborama/govcr/v10/encryption/errors"
-	govcrerr "github.com/seborama/govcr/v10/errors"
-	"github.com/seborama/govcr/v10/stats"
+	"github.com/seborama/govcr/v11/cassette/track"
+	"github.com/seborama/govcr/v11/compression"
+	cryptoerr "github.com/seborama/govcr/v11/encryption/errors"
+	govcrerr "github.com/seborama/govcr/v11/errors"
+	"github.com/seborama/govcr/v11/stats"
 )
 
 // Cassette contains a set of tracks.
@@ -48,8 +48,8 @@ type Crypter interface {
 // to create a new Cassette.
 type Option func(*Cassette)
 
-// WithCassetteCrypter provides a crypter to encrypt/decrypt cassette content.
-func WithCassetteCrypter(crypter Crypter) Option {
+// WithCrypter provides a crypter to encrypt/decrypt cassette content.
+func WithCrypter(crypter Crypter) Option {
 	return func(k7 *Cassette) {
 		if k7.crypter != nil {
 			log.Println("notice: setting a crypter but another one had already been registered - this is incorrect usage")

cassette/cassette_test.go

@@ -8,9 +8,9 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v10/cassette"
-	"github.com/seborama/govcr/v10/cassette/track"
-	"github.com/seborama/govcr/v10/encryption"
+	"github.com/seborama/govcr/v11/cassette"
+	"github.com/seborama/govcr/v11/cassette/track"
+	"github.com/seborama/govcr/v11/encryption"
 )
 
 func Test_cassette_GzipFilter(t *testing.T) {
@@ -132,7 +132,7 @@ func Test_cassette_Encryption(t *testing.T) {
 	c, err := encryption.NewAESGCMWithRandomNonceGenerator(key)
 	require.NoError(t, err)
 
-	k7 := cassette.NewCassette(cassetteName, cassette.WithCassetteCrypter(c))
+	k7 := cassette.NewCassette(cassetteName, cassette.WithCrypter(c))
 
 	trk := &track.Track{}
 
@@ -142,7 +142,7 @@ func Test_cassette_Encryption(t *testing.T) {
 	// STEP 2: ensure cassette loads.
 	var k8 *cassette.Cassette
 	require.NotPanics(t, func() {
-		k8 = cassette.LoadCassette(cassetteName, cassette.WithCassetteCrypter(c))
+		k8 = cassette.LoadCassette(cassetteName, cassette.WithCrypter(c))
 	})
 
 	// STEP 3: perform high and low-level validation checks on cassette file.
@@ -187,7 +187,7 @@ func Test_cassette_CanEncryptPlainCassette(t *testing.T) {
 	c, err := encryption.NewAESGCMWithRandomNonceGenerator(key)
 	require.NoError(t, err)
 
-	k7 = cassette.LoadCassette(cassetteName, cassette.WithCassetteCrypter(c))
+	k7 = cassette.LoadCassette(cassetteName, cassette.WithCrypter(c))
 
 	trk = &track.Track{UUID: "trk-2"}
 
@@ -197,7 +197,7 @@ func Test_cassette_CanEncryptPlainCassette(t *testing.T) {
 	// STEP 2: ensure cassette loads.
 	var k8 *cassette.Cassette
 	require.NotPanics(t, func() {
-		k8 = cassette.LoadCassette(cassetteName, cassette.WithCassetteCrypter(c))
+		k8 = cassette.LoadCassette(cassetteName, cassette.WithCrypter(c))
 	})
 
 	// STEP 3: perform high and low-level validation checks on cassette file.

cassette/cassette_wb_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v10/stats"
+	"github.com/seborama/govcr/v11/stats"
 )
 
 func Test_cassette_NumberOfTracks_PanicsWhenNoCassette(t *testing.T) {

cassette/track/http_test.go

@@ -9,7 +9,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v10/cassette/track"
+	"github.com/seborama/govcr/v11/cassette/track"
 )
 
 func TestRequest_Clone(t *testing.T) {

cassette/track/mutator_test.go

@@ -10,7 +10,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v10/cassette/track"
+	"github.com/seborama/govcr/v11/cassette/track"
 )
 
 func Test_Mutator_On(t *testing.T) {

cassette/track/track.go

@@ -9,7 +9,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	trkerr "github.com/seborama/govcr/v10/cassette/track/errors"
+	trkerr "github.com/seborama/govcr/v11/cassette/track/errors"
 )
 
 // Track is a recording (HTTP Request + Response) in a cassette.

cmd/govcr/main.go

@@ -7,8 +7,8 @@ import (
 
 	"github.com/pkg/errors"
 
-	"github.com/seborama/govcr/v10/cassette"
-	"github.com/seborama/govcr/v10/encryption"
+	"github.com/seborama/govcr/v11/cassette"
+	"github.com/seborama/govcr/v11/encryption"
 )
 
 func main() {

concurrency_test.go

@@ -15,8 +15,8 @@ import (
 	"github.com/pkg/errors"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v10"
-	"github.com/seborama/govcr/v10/stats"
+	"github.com/seborama/govcr/v11"
+	"github.com/seborama/govcr/v11/stats"
 )
 
 func TestConcurrencySafety(t *testing.T) {
@@ -116,7 +116,7 @@ func TestConcurrencySafety(t *testing.T) {
 
 func createVCR(cassetteName string, client *http.Client) *govcr.ControlPanel {
 	return govcr.NewVCR(
-		govcr.NewCassetteMaker(cassetteName),
+		govcr.NewCassetteLoader(cassetteName),
 		govcr.WithClient(client))
 }
 

controlpanel.go

@@ -3,8 +3,8 @@ package govcr
 import (
 	"net/http"
 
-	"github.com/seborama/govcr/v10/cassette/track"
-	"github.com/seborama/govcr/v10/stats"
+	"github.com/seborama/govcr/v11/cassette/track"
+	"github.com/seborama/govcr/v11/stats"
 )
 
 // ControlPanel holds the parts of a VCR that can be interacted with.

controlpanel_wb_test.go

@@ -6,7 +6,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/seborama/govcr/v10/cassette/track"
+	"github.com/seborama/govcr/v11/cassette/track"
 )
 
 func TestControlPanel_SetRecordingMutators(t *testing.T) {

encryption/.study/rsa.go

@@ -11,7 +11,7 @@ import (
 	"github.com/pkg/errors"
 	"golang.org/x/crypto/ssh"
 
-	cryptoerr "github.com/seborama/govcr/v10/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v11/encryption/errors"
 )
 
 // nolint: deadcode

encryption/aesgcm.go

@@ -4,7 +4,7 @@ import (
 	"crypto/aes"
 	"crypto/cipher"
 
-	cryptoerr "github.com/seborama/govcr/v10/encryption/errors"
+	cryptoerr "github.com/seborama/govcr/v11/encryption/errors"
 )
 
 // NewAESGCMWithRandomNonceGenerator creates a new Cryptor initialised with an

encryption/aesgcm_test.go

@@ -6,7 +6,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/seborama/govcr/v10/encryption"
+	"github.com/seborama/govcr/v11/encryption"
 )
 
 func TestCryptor_AESGCM(t *testing.T) {