Removed ExcludeHeaderFunc and obsolete issues folder

Makefile

@@ -5,7 +5,7 @@ deps:
 	go get -d -t -v ./... $(DEPS)
 
 test: deps
-	go test -cover -race -parallel 2 ./ ./issues/
+	go test -cover -race -parallel 2 ./
 
 examples: deps
 	go run ./examples/*.go

README.md

@@ -123,7 +123,7 @@ This simply redirects all **govcr** logging to the OS's standard Null device (e.
 
 ### Influencing request comparison programatically at runtime.
 
-`RequestFilters` receives the request Header / Body to allow their transformation. Both the live request  and the replayed request are filtered at comparison time. **Transformations are not persisted and only for the purpose of influencing comparison**.
+`RequestFilters` receives the request Header / Body to allow their transformation. Both the live request and the replayed request are filtered at comparison time. **Transformations are not persisted and only for the purpose of influencing comparison**.
 
 ### Runtime transforming of the response before sending it back to the client.
 

examples/example4.go

@@ -2,10 +2,8 @@ package main
 
 import (
 	"fmt"
-	"strings"
-	"time"
-
 	"net/http"
+	"time"
 
 	"github.com/seborama/govcr"
 )
@@ -21,9 +19,8 @@ const example4CassetteName = "MyCassette4"
 func Example4() {
 	vcr := govcr.NewVCR(example4CassetteName,
 		&govcr.VCRConfig{
-			ExcludeHeaderFunc: func(key string) bool {
-				// HTTP headers are case-insensitive
-				return strings.ToLower(key) == "x-custom-my-date"
+			RequestFilters: govcr.RequestFilters{
+				govcr.RequestDeleteHeaderKeys("X-Transaction-Id"),
 			},
 			Logging: true,
 		})

examples/example5.go

@@ -2,10 +2,8 @@ package main
 
 import (
 	"fmt"
-	"strings"
-	"time"
-
 	"net/http"
+	"time"
 
 	"github.com/seborama/govcr"
 )
@@ -23,9 +21,8 @@ const example5CassetteName = "MyCassette5"
 func Example5() {
 	vcr := govcr.NewVCR(example5CassetteName,
 		&govcr.VCRConfig{
-			ExcludeHeaderFunc: func(key string) bool {
-				// ignore the X-Transaction-Id since it changes per-request
-				return strings.ToLower(key) == "x-transaction-id"
+			RequestFilters: govcr.RequestFilters{
+				govcr.RequestDeleteHeaderKeys("X-Transaction-Id"),
 			},
 			ResponseFilters: govcr.ResponseFilters{
 				// overwrite X-Transaction-Id in the Response with that from the Request

examples/main.go

@@ -11,6 +11,7 @@ func runExample(name, cassetteName string, f func()) {
 	fmt.Println("2nd run =======================================================")
 	f()
 	fmt.Println("Complete ======================================================")
+	fmt.Println()
 }
 func main() {
 	runExample("Example1", example1CassetteName, Example1)

govcr.go

@@ -26,8 +26,7 @@ const defaultCassettePath = "./govcr-fixtures/"
 
 // VCRConfig holds a set of options for the VCR.
 type VCRConfig struct {
-	Client            *http.Client
-	ExcludeHeaderFunc ExcludeHeaderFunc
+	Client *http.Client
 
 	// Filter to run before request is matched against cassettes.
 	RequestFilters RequestFilters
@@ -43,13 +42,12 @@ type VCRConfig struct {
 // PCB stands for Printed Circuit Board. It is a structure that holds some
 // facilities that are passed to the VCR machine to modify its internals.
 type pcb struct {
-	Transport         http.RoundTripper
-	ExcludeHeaderFunc ExcludeHeaderFunc
-	RequestFilter     RequestFilter
-	ResponseFilter    ResponseFilter
-	Logger            *log.Logger
-	DisableRecording  bool
-	CassettePath      string
+	Transport        http.RoundTripper
+	RequestFilter    RequestFilter
+	ResponseFilter   ResponseFilter
+	Logger           *log.Logger
+	DisableRecording bool
+	CassettePath     string
 }
 
 const trackNotFound = -1
@@ -86,13 +84,12 @@ func (pcbr *pcb) trackMatches(cassette *cassette, trackNumber int, req Request)
 func (pcbr *pcb) headerResembles(header1 http.Header, header2 http.Header) bool {
 	for k := range header1 {
 		// TODO: a given header may have several values (and in any order)
-		if GetFirstValue(header1, k) != GetFirstValue(header2, k) && !pcbr.ExcludeHeaderFunc(k) {
+		if GetFirstValue(header1, k) != GetFirstValue(header2, k) {
 			return false
 		}
 	}
 
 	// finally assert the number of headers match
-	// TODO: perhaps should count how many pcb.ExcludeHeaderFunc() returned true and remove that count from the len to compare?
 	return len(header1) == len(header2)
 }
 
@@ -166,13 +163,6 @@ func NewVCR(cassetteName string, vcrConfig *VCRConfig) *VCRControlPanel {
 		vcrConfig.Client.Transport = http.DefaultTransport
 	}
 
-	// use a default set of FilterFunc's
-	if vcrConfig.ExcludeHeaderFunc == nil {
-		vcrConfig.ExcludeHeaderFunc = func(key string) bool {
-			return false
-		}
-	}
-
 	// load cassette
 	cassette, err := loadCassette(cassetteName, vcrConfig.CassettePath)
 	if err != nil {
@@ -182,13 +172,12 @@ func NewVCR(cassetteName string, vcrConfig *VCRConfig) *VCRControlPanel {
 	// create PCB
 	pcbr := &pcb{
 		// TODO: create appropriate test!
-		DisableRecording:  vcrConfig.DisableRecording,
-		Transport:         vcrConfig.Client.Transport,
-		ExcludeHeaderFunc: vcrConfig.ExcludeHeaderFunc,
-		RequestFilter:     vcrConfig.RequestFilters.combined(),
-		ResponseFilter:    vcrConfig.ResponseFilters.combined(),
-		Logger:            logger,
-		CassettePath:      vcrConfig.CassettePath,
+		DisableRecording: vcrConfig.DisableRecording,
+		Transport:        vcrConfig.Client.Transport,
+		RequestFilter:    vcrConfig.RequestFilters.combined(),
+		ResponseFilter:   vcrConfig.ResponseFilters.combined(),
+		Logger:           logger,
+		CassettePath:     vcrConfig.CassettePath,
 	}
 
 	// create VCR's HTTP client
@@ -210,22 +199,6 @@ func NewVCR(cassetteName string, vcrConfig *VCRConfig) *VCRControlPanel {
 	}
 }
 
-// ExcludeHeaderFunc is a hook function that is used to filter the Header.
-//
-// Typically this can be used to remove / amend undesirable custom headers from the request.
-//
-// For instance, if your application sends requests with a timestamp held in a custom header,
-// you likely want to exclude it from the comparison to ensure that the request headers are
-// considered a match with those saved on the cassette's track.
-//
-// Parameters:
-//  - parameter 1 - Name of header key in the Request
-//
-// Return value:
-// true - exclude header key from comparison
-// false - retain header key for comparison
-type ExcludeHeaderFunc func(key string) bool
-
 // vcrTransport is the heart of VCR. It provides
 // an http.RoundTripper that wraps over the default
 // one provided by Go's http package or a custom one

govcr_example3_test.go

@@ -26,9 +26,8 @@ func runTestEx4() {
 	// Create vcr
 	vcr := govcr.NewVCR(example3CassetteName,
 		&govcr.VCRConfig{
-			ExcludeHeaderFunc: func(key string) bool {
-				// HTTP headers are case-insensitive
-				return strings.ToLower(key) == "x-custom-my-date"
+			RequestFilters: govcr.RequestFilters{
+				govcr.RequestDeleteHeaderKeys("X-Custom-My-Date"),
 			},
 		})
 

response.go

@@ -42,7 +42,7 @@ func ResponseAddHeaderValue(key, value string) ResponseFilter {
 	}
 }
 
-// ResponseDeleteHeader will delete one or more headers on the response when returned from vcr playback.
+// ResponseDeleteHeaderKeys will delete one or more headers on the response when returned from vcr playback.
 func ResponseDeleteHeaderKeys(keys ...string) ResponseFilter {
 	return func(resp Response) Response {
 		for _, key := range keys {