Merge pull request #7 from andreykaipov/feature/remote-file-headers

add optional headers to file backend

Author: HeavyHorst

file/client.go

@@ -29,14 +29,41 @@ type Client struct {
 	httpClient http.Client
 }
 
+// transport is a wrapper around any provided underlying transport that will
+// also add any provided headers to any request made with this transport.
+type transport struct {
+	Headers             map[string]string
+	UnderlyingTransport http.RoundTripper
+}
+
+// RoundTrip satisfies the RoundTripper interface for our custom transport above.
+// If an underlying transport is not provided, we default to http.DefaultTransport.
+func (t *transport) RoundTrip(req *http.Request) (*http.Response, error) {
+	for k, v := range t.Headers {
+		req.Header.Add(k, v)
+	}
+	if t.UnderlyingTransport == nil {
+		t.UnderlyingTransport = http.DefaultTransport
+	}
+	return t.UnderlyingTransport.RoundTrip(req)
+}
+
 // New returns a new FileClient
 // The filepath can be a local path to a file or a remote http/https location.
-func New(filepath string) (*Client, error) {
+func New(filepath string, opts ...Option) (*Client, error) {
+	var options Options
+	for _, o := range opts {
+		o(&options)
+	}
+
 	c := &Client{filepath: filepath}
 	if strings.HasPrefix(filepath, "http://") || strings.HasPrefix(filepath, "https://") {
 		c.isURL = true
 		c.httpClient = http.Client{
 			Timeout: 5 * time.Second,
+			Transport: &transport{
+				Headers: options.Headers,
+			},
 		}
 	}
 	return c, nil

file/client_test.go

@@ -10,7 +10,10 @@ package file
 
 import (
 	"context"
+	"fmt"
 	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
 	"os"
 	"sync"
 	"testing"
@@ -173,3 +176,31 @@ func (s *FilterSuite) TestWatchPrefixCancel(t *C) {
 	cancel()
 	wg.Wait()
 }
+
+func (s *FilterSuite) TestHTTPWithHeaders(t *C) {
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintln(w, "---")
+		for name, value := range r.Header {
+			fmt.Fprintf(w, "%s: %q\n", name, value[0])
+		}
+	}))
+	defer ts.Close()
+
+	c, _ := New(ts.URL, WithHeaders(map[string]string{
+		"X-Test-Token": "Hi",
+		"Content-Type": "application/json",
+	}))
+	vals, err := c.GetValues([]string{"/"})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	testHeader := func(header, expected string) {
+		if vals[header] != expected {
+			t.Errorf("Expected %q to equal %q", header, expected)
+		}
+	}
+	testHeader("/X-Test-Token", "Hi")
+	testHeader("/Content-Type", "application/json")
+	testHeader("/X-Nonexistent", "")
+}

file/options.go

@@ -0,0 +1,26 @@
+/*
+ * This file is part of easyKV.
+ * © 2016 The easyKV Authors
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+package file
+
+// Options contains all (possibly optional) values that are needed to fetch
+// JSON or YAML files (either locally or remotely).
+type Options struct {
+	Headers map[string]string
+}
+
+// Option configures the file client.
+type Option func(*Options)
+
+// WithHeaders sets the headers for the HTTP request made when fetching
+// remote files.
+func WithHeaders(headers map[string]string) Option {
+	return func(o *Options) {
+		o.Headers = headers
+	}
+}