Add api_version to Client config (#15)

Author: Will Myers

CHANGELOG.md

@@ -1,3 +1,6 @@
+Current Version
+  - Add api_version to Client config
+
 2.2.0 March 29, 2017
   - Add GET support for `Customers` resource
 

lib/button/client.rb

@@ -39,7 +39,8 @@ def merge_defaults(config)
         secure: secure,
         timeout: config.fetch(:timeout, nil),
         hostname: config.fetch(:hostname, 'api.usebutton.com'),
-        port: config.fetch(:port, secure ? 443 : 80)
+        port: config.fetch(:port, secure ? 443 : 80),
+        api_version: config.fetch(:api_version, nil)
       }
     end
 

lib/button/resources/resource.rb

@@ -76,6 +76,10 @@ def api_request(request, body = nil)
       request.basic_auth(@api_key, '')
       request['User-Agent'] = USER_AGENT
 
+      unless @config[:api_version].nil?
+        request['X-Button-API-Version'] = @config[:api_version]
+      end
+
       if !body.nil? && body.respond_to?(:to_json)
         request['Content-Type'] = 'application/json'
         request.body = body.to_json

test/button/client_test.rb

@@ -27,7 +27,8 @@ def test_sets_default_config_parameters
       hostname: 'api.usebutton.com',
       port: 443,
       secure: true,
-      timeout: nil
+      timeout: nil,
+      api_version: nil
     )
   end
 
@@ -36,7 +37,8 @@ def test_allows_config_overrides
       hostname: 'localhost',
       port: 8080,
       secure: false,
-      timeout: 20
+      timeout: 20,
+      api_version: '2017-01-01'
     }
 
     client = Button::Client.new('sk-XXX', config)

test/button/resources/resource_test.rb

@@ -111,6 +111,30 @@ def test_gets_a_resource
     assert_equal(response.data[:a], 1)
   end
 
+  def test_gets_a_resource_at_an_api_version
+    resource = Button::Resource.new(
+      'sk-XXX',
+      secure: true,
+      timeout: nil,
+      hostname: 'api.usebutton.com',
+      port: 443,
+      api_version: '2017-01-01'
+    )
+
+    headers = {
+      'Authorization' => 'Basic c2stWFhYOg==',
+      'User-Agent' => Button::Resource::USER_AGENT,
+      'X-Button-API-Version' => '2017-01-01'
+    }
+
+    stub_request(:get, 'https://api.usebutton.com/v1/bloop')
+      .with(headers: headers)
+      .to_return(status: 200, body: '{ "meta": { "status": "ok" }, "object": { "a": 1 } }')
+
+    response = resource.api_get('/v1/bloop')
+    assert_equal(response.data[:a], 1)
+  end
+
   def test_gets_a_resource_with_query
     stub_request(:get, 'https://api.usebutton.com/v1/bloop?a=1&b=bloop')
       .with(headers: @headers)