gds-api-adapters 7.4.0 → 7.5.0

data/lib/gds_api/json_client.rb

@@ -75,20 +75,20 @@ module GdsApi
       end
     end
 
-    def get_json!(url, &create_response)
-      do_json_request(:get, url, nil, &create_response)
+    def get_json!(url, additional_headers = {}, &create_response)
+      do_json_request(:get, url, nil, additional_headers, &create_response)
     end
 
-    def post_json!(url, params)
-      do_json_request(:post, url, params)
+    def post_json!(url, params, additional_headers = {})
+      do_json_request(:post, url, params, additional_headers)
     end
 
-    def put_json!(url, params)
-      do_json_request(:put, url, params)
+    def put_json!(url, params, additional_headers = {})
+      do_json_request(:put, url, params, additional_headers)
     end
 
-    def delete_json!(url, params = nil)
-      do_request(:delete, url, params)
+    def delete_json!(url, params = nil, additional_headers = {})
+      do_request(:delete, url, params, additional_headers)
     end
 
     def post_multipart(url, params)
@@ -112,12 +112,13 @@ module GdsApi
     # method: the symbolic name of the method to use, e.g. :get, :post
     # url:    the request URL
     # params: the data to send (JSON-serialised) in the request body
+    # additional_headers: headers to set on the request (in addition to the default ones)
     # create_response: optional block to instantiate a custom response object
     #                  from the Net::HTTPResponse
-    def do_json_request(method, url, params = nil, &create_response)
+    def do_json_request(method, url, params = nil, additional_headers = {}, &create_response)
 
       begin
-        response = do_request_with_cache(method, url, (params.to_json if params))
+        response = do_request_with_cache(method, url, (params.to_json if params), additional_headers)
 
       rescue RestClient::ResourceNotFound => e
         raise GdsApi::HTTPNotFound.new(e.http_code)
@@ -163,6 +164,12 @@ module GdsApi
       )
     end
 
+    def with_headers(method_params, headers)
+      method_params.merge(
+        headers: method_params[:headers].merge(headers)
+      )
+    end
+
     def with_ssl_options(method_params)
       method_params.merge(
         # This is the default value anyway, but we should probably be explicit
@@ -170,7 +177,7 @@ module GdsApi
       )
     end
 
-    def do_request_with_cache(method, url, params = nil)
+    def do_request_with_cache(method, url, params = nil, additional_headers = {})
       # Only read GET requests from the cache: any other request methods should
       # always be passed through. Note that this means HEAD requests won't get
       # cached, but that would involve separating the cache by method and URL.
@@ -182,7 +189,7 @@ module GdsApi
         return cached_response if cached_response
       end
 
-      response = do_request(method, url, params)
+      response = do_request(method, url, params, additional_headers)
 
       if use_cache
         cache_time = response_cache_time(response)
@@ -201,7 +208,7 @@ module GdsApi
       end
     end
 
-    def do_request(method, url, params = nil)
+    def do_request(method, url, params = nil, additional_headers = {})
       loggable = {request_uri: url, start_time: Time.now.to_f}
       start_logging = loggable.merge(action: 'start')
       logger.debug start_logging.to_json
@@ -214,6 +221,7 @@ module GdsApi
       method_params[:payload] = params
       method_params = with_auth_options(method_params)
       method_params = with_timeout(method_params)
+      method_params = with_headers(method_params, additional_headers)
       if URI.parse(url).is_a? URI::HTTPS
         method_params = with_ssl_options(method_params)
       end

data/lib/gds_api/support.rb

@@ -1,12 +1,12 @@
 require_relative 'base'
 
 class GdsApi::Support < GdsApi::Base
-  def create_foi_request(request_details)
-    post_json!("#{base_url}/foi_requests", { :foi_request => request_details })
+  def create_foi_request(request_details, options = {})
+    post_json!("#{base_url}/foi_requests", { :foi_request => request_details }, options[:headers] || {})
   end
 
-  def create_problem_report(request_details)
-    post_json!("#{base_url}/problem_reports", { :problem_report => request_details })
+  def create_problem_report(request_details, options = {})
+    post_json!("#{base_url}/problem_reports", { :problem_report => request_details }, options[:headers] || {})
   end
 
   private

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.4.0'
+  VERSION = '7.5.0'
 end

data/test/json_client_test.rb

@@ -468,6 +468,54 @@ class JsonClientTest < MiniTest::Spec
     assert_equal 2, response.a
   end
 
+  def test_client_can_set_custom_headers_on_gets
+    stub_request(:get, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    response = GdsApi::JsonClient.new.get_json("http://some.other.endpoint/some.json", 
+                                               { "HEADER-A" => "B", "HEADER-C" => "D" })
+
+    assert_requested(:get, %r{/some.json}) do |request|
+      headers_with_uppercase_names = Hash[request.headers.collect {|key, value| [key.upcase, value] }]
+      headers_with_uppercase_names["HEADER-A"] == "B" && headers_with_uppercase_names["HEADER-C"] == "D"
+    end
+  end
+
+  def test_client_can_set_custom_headers_on_posts
+    stub_request(:post, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    response = GdsApi::JsonClient.new.post_json("http://some.other.endpoint/some.json", {}, 
+                                                { "HEADER-A" => "B", "HEADER-C" => "D" })
+
+    assert_requested(:post, %r{/some.json}) do |request|
+      headers_with_uppercase_names = Hash[request.headers.collect {|key, value| [key.upcase, value] }]
+      headers_with_uppercase_names["HEADER-A"] == "B" && headers_with_uppercase_names["HEADER-C"] == "D"
+    end
+  end
+
+  def test_client_can_set_custom_headers_on_puts
+    stub_request(:put, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    response = GdsApi::JsonClient.new.put_json("http://some.other.endpoint/some.json", {}, 
+                                               { "HEADER-A" => "B", "HEADER-C" => "D" })
+
+    assert_requested(:put, %r{/some.json}) do |request|
+      headers_with_uppercase_names = Hash[request.headers.collect {|key, value| [key.upcase, value] }]
+      headers_with_uppercase_names["HEADER-A"] == "B" && headers_with_uppercase_names["HEADER-C"] == "D"
+    end
+  end
+
+  def test_client_can_set_custom_headers_on_deletes
+    stub_request(:delete, "http://some.other.endpoint/some.json").to_return(:status => 200)
+
+    response = GdsApi::JsonClient.new.delete_json("http://some.other.endpoint/some.json", {}, 
+                                                  { "HEADER-A" => "B", "HEADER-C" => "D" })
+
+    assert_requested(:delete, %r{/some.json}) do |request|
+      headers_with_uppercase_names = Hash[request.headers.collect {|key, value| [key.upcase, value] }]
+      headers_with_uppercase_names["HEADER-A"] == "B" && headers_with_uppercase_names["HEADER-C"] == "D"
+    end
+  end
+
   def test_client_can_decompress_gzip_responses
     url = "http://some.endpoint/some.json"
     # {"test": "hello"}

data/test/support_api_test.rb

@@ -22,7 +22,17 @@ describe GdsApi::Support do
     assert_requested(stub_post)
   end
 
-  it "throws an exception when the support app  isn't available" do
+  it "can add a custom header onto the FOI request to the support app" do
+    stub_request(:post, "#{@base_api_url}/foi_requests")
+
+    @api.create_foi_request({}, headers: { "X-Varnish" => "12345"})
+
+    assert_requested(:post, %r{/foi_requests}) do |request|
+      request.headers["X-Varnish"] == "12345"
+    end
+  end
+
+  it "throws an exception when the support app isn't available" do
     support_isnt_available
 
     assert_raises(GdsApi::HTTPErrorResponse) { @api.create_foi_request({}) }
@@ -40,7 +50,17 @@ describe GdsApi::Support do
     assert_requested(stub_post)
   end
 
-  it "throws an exception when the support app  isn't available" do
+  it "can add a custom header onto the problem_report request to the support app" do
+    stub_request(:post, "#{@base_api_url}/problem_reports")
+
+    @api.create_problem_report({}, headers: { "X-Varnish" => "12345"})
+
+    assert_requested(:post, %r{/problem_reports}) do |request|
+      request.headers["X-Varnish"] == "12345"
+    end
+  end
+
+  it "throws an exception when the support app isn't available" do
     support_isnt_available
 
     assert_raises(GdsApi::HTTPErrorResponse) { @api.create_problem_report({}) }

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 7.4.0
+  version: 7.5.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-21 00:00:00 Z
+date: 2013-09-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -260,7 +260,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 167124885650140799
+      hash: -3019861468380170636
       segments: 
       - 0
       version: "0"
@@ -269,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 167124885650140799
+      hash: -3019861468380170636
       segments: 
       - 0
       version: "0"