gds-api-adapters 2.10.0 → 2.11.0

data/lib/gds_api/content_api.rb

@@ -60,8 +60,38 @@ class GdsApi::ContentApi < GdsApi::Base
     get_json!("#{base_url}/local_authorities.json?snac_code=#{CGI.escape(snac_code)}")
   end
 
+  def business_support_schemes(identifiers)
+    identifiers = identifiers.map {|i| CGI.escape(i) }
+    url_template = "#{base_url}/business_support_schemes.json?identifiers="
+    response = nil # assignment necessary for variable scoping
+
+    start_url = "#{url_template}#{identifiers.shift}"
+    last_batch_url = identifiers.inject(start_url) do |url, id|
+      new_url = [url, id].join(',')
+      if new_url.length >= 2000
+        # fetch a batch using the previous url, then return a new start URL with this id
+        response = get_batch(url, response)
+        "#{url_template}#{id}"
+      else
+        new_url
+      end
+    end
+    get_batch(last_batch_url, response)
+  end
+
   private
     def base_url
       endpoint
     end
+
+    def get_batch(batch_url, existing_response = nil)
+      batch_response = get_json!(batch_url)
+      if existing_response
+        existing_response.to_hash["total"] += batch_response["total"]
+        existing_response.to_hash["results"] += batch_response["results"]
+        existing_response
+      else
+        batch_response
+      end
+    end
 end

data/lib/gds_api/test_helpers/content_api.rb

@@ -199,6 +199,24 @@ module GdsApi
         }
       end
 
+      def setup_content_api_business_support_schemes_stubs
+        @stubbed_content_api_business_support_schemes = []
+        stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/business_support_schemes\.json}).to_return do |request|
+          if request.uri.query_values and request.uri.query_values["identifiers"]
+            ids = request.uri.query_values["identifiers"].split(',')
+            results = @stubbed_content_api_business_support_schemes.select {|bs| ids.include? bs["details"]["business_support_identifier"] }
+          else
+            results = []
+          end
+          {:body => plural_response_base.merge("results" => results, "total" => results.size).to_json}
+        end
+      end
+
+      def content_api_has_business_support_scheme(scheme)
+        raise "Need a licence identifier" if scheme["details"]["business_support_identifier"].nil?
+        @stubbed_content_api_business_support_schemes << scheme
+      end
+
       private
 
         def titleize_slug(slug)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '2.10.0'
+  VERSION = '2.11.0'
 end

data/test/content_api_test.rb

@@ -230,4 +230,130 @@ describe GdsApi::ContentApi do
       assert_requested :get, "#{@base_api_url}/local_authorities.json?snac_code=snacks%21"
     end
   end
+
+  describe "business support schemes" do
+    it "should query content_api for business_support_schemes" do
+      stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes.json}).
+        to_return(:status => 200, :body => {"foo" => "bar"}.to_json)
+
+      response = @api.business_support_schemes(['foo', 'bar'])
+
+      assert_equal({"foo" => "bar"}, response.to_hash)
+      assert_requested :get, "#{@base_api_url}/business_support_schemes.json?identifiers=foo,bar", :times => 1
+    end
+
+    it "should CGI escape identifiers" do
+      stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes.json}).
+        to_return(:status => 200, :body => {"foo" => "bar"}.to_json)
+
+      response = @api.business_support_schemes(['foo bar', 'baz&bing'])
+
+      assert_equal({"foo" => "bar"}, response.to_hash)
+      assert_requested :get, "#{@base_api_url}/business_support_schemes.json?identifiers=foo%20bar,baz%26bing", :times => 1
+    end
+
+    it "should not modify the given array" do
+      stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes.json}).
+        to_return(:status => 200, :body => {"foo" => "bar"}.to_json)
+
+      ids = %w(foo bar baz)
+      @api.business_support_schemes(ids)
+
+      assert_equal %w(foo bar baz), ids
+    end
+
+    it "should raise an error if content_api returns 404" do
+      stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes.json}).
+        to_return(:status => 404, :body => "Not Found")
+
+      assert_raises GdsApi::HTTPNotFound do
+        @api.business_support_schemes(['foo', 'bar'])
+      end
+    end
+
+    it "should raise an error if content_api returns a 50x error" do
+      stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes.json}).
+        to_return(:status => 503, :body => "Gateway timeout")
+
+      assert_raises GdsApi::HTTPErrorResponse do
+        @api.business_support_schemes(['foo', 'bar'])
+      end
+    end
+
+    describe "handling requests that would have a URI in excess of 2000 chars" do
+      before :each do
+        stub_request(:get, %r{\A#{@base_api_url}/business_support_schemes\.json}).
+          to_return(:status => 200, :body => api_response_for_results([{"foo" => "bar"}]).to_json)
+      end
+
+      it "should do the request in batches" do
+        ids = (1..300).map {|n| sprintf "%09d", n } # each id is 9 chars long
+
+        response = @api.business_support_schemes(ids)
+
+        assert_requested :get, %r{\A#{@base_api_url}/business_support_schemes\.json}, :times => 2
+
+        first_batch = ids[0..190]
+        assert_requested :get, "#{@base_api_url}/business_support_schemes.json?identifiers=#{first_batch.join(',')}"
+        second_batch = ids[191..299]
+        assert_requested :get, "#{@base_api_url}/business_support_schemes.json?identifiers=#{second_batch.join(',')}"
+      end
+
+      it "should merge the responses into a single GdsApi::Response" do
+        ids = (1..300).map {|n| sprintf "%09d", n } # each id is 9 chars long
+        first_batch = ids[0..190]
+        stub_request(:get, "#{@base_api_url}/business_support_schemes.json").
+          with(:query => {"identifiers" => first_batch.join(',')}).
+          to_return(:status => 200, :body => api_response_for_results(first_batch).to_json) # We're stubbing response that just return the requested ids
+        second_batch = ids[191..299]
+        stub_request(:get, "#{@base_api_url}/business_support_schemes.json").
+          with(:query => {"identifiers" => second_batch.join(',')}).
+          to_return(:status => 200, :body => api_response_for_results(second_batch).to_json)
+
+        response = @api.business_support_schemes(ids)
+
+        # Assert both Hash an OpenStruct access to ensure nothing's been memoized part-way through merging stuff
+        assert_equal 300, response["total"]
+        assert_equal ids, response["results"]
+
+        assert_equal 300, response.total
+        assert_equal ids, response.results
+      end
+    end
+
+    it "should do the request in batches if the request path would otherwise exceed 2000 chars" do
+
+    end
+
+    describe "test helpers" do
+      it "should have representative test helpers" do
+        setup_content_api_business_support_schemes_stubs
+
+        s1 = artefact_for_slug('scheme-1')
+        s1["details"].merge!("business_support_identifier" => "s1")
+        content_api_has_business_support_scheme(s1)
+        s2 = artefact_for_slug('scheme-2')
+        s2["details"].merge!("business_support_identifier" => "s2")
+        content_api_has_business_support_scheme(s2)
+        s3 = artefact_for_slug('scheme-3')
+        s3["details"].merge!("business_support_identifier" => "s3")
+        content_api_has_business_support_scheme(s3)
+
+        response = @api.business_support_schemes(['s1', 's3']).to_hash
+
+        assert_equal 2, response["total"]
+        assert_equal [s1, s3], response["results"]
+      end
+    end
+  end
+
+  def api_response_for_results(results)
+    {
+      "_response_info" => {
+        "status" => "ok",
+      },
+      "total" => results.size,
+      "results" => results,
+    }
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-01 00:00:00 Z
+date: 2012-10-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -154,44 +154,44 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/gds_api/helpers.rb
-- lib/gds_api/base.rb
-- lib/gds_api/part_methods.rb
-- lib/gds_api/exceptions.rb
-- lib/gds_api/rummager.rb
+- lib/gds_api/version.rb
+- lib/gds_api/publisher.rb
+- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/typhoeus_client.rb
+- lib/gds_api/content_api.rb
 - lib/gds_api/imminence.rb
-- lib/gds_api/publisher.rb
 - lib/gds_api/contactotron.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/version.rb
-- lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/contactotron.rb
+- lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/test_helpers/licence_application.rb
-- lib/gds_api/test_helpers/content_api.rb
-- lib/gds_api/response.rb
-- lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/json_client.rb
 - lib/gds_api/licence_application.rb
+- lib/gds_api/base.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/response.rb
+- lib/gds_api/rummager.rb
+- lib/gds_api/panopticon.rb
 - lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/content_api.rb
+- lib/gds_api/part_methods.rb
+- lib/gds_api/needotron.rb
+- lib/gds_api/exceptions.rb
+- lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/panopticon_registerer_test.rb
-- test/gds_api_base_test.rb
-- test/json_client_test.rb
-- test/test_helper.rb
-- test/licence_application_api_test.rb
-- test/publisher_api_test.rb
-- test/imminence_api_test.rb
-- test/panopticon_api_test.rb
 - test/contactotron_api_test.rb
+- test/panopticon_api_test.rb
+- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
 - test/content_api_test.rb
+- test/json_client_test.rb
+- test/gds_api_base_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -205,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2662590031199001168
+      hash: 1655582362177723413
       segments: 
       - 0
       version: "0"
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2662590031199001168
+      hash: 1655582362177723413
       segments: 
       - 0
       version: "0"
@@ -226,14 +226,14 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/panopticon_registerer_test.rb
-- test/gds_api_base_test.rb
-- test/json_client_test.rb
-- test/test_helper.rb
-- test/licence_application_api_test.rb
-- test/publisher_api_test.rb
-- test/imminence_api_test.rb
-- test/panopticon_api_test.rb
 - test/contactotron_api_test.rb
+- test/panopticon_api_test.rb
+- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/imminence_api_test.rb
+- test/panopticon_registerer_test.rb
 - test/content_api_test.rb
+- test/json_client_test.rb
+- test/gds_api_base_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb