gds-api-adapters 9.2.0 → 10.0.0

data/README.md

@@ -4,7 +4,7 @@ app.
 Example usage:
 
     publisher_api = GdsApi::Publisher.new("environment")
-    ostruct_publication = publisher.publication_for_slug('my-published-item')
+    ostruct_publication = publisher_api.publication_for_slug('my-published-item')
 
     panopticon_api = GdsApi::Panopticon.new("environment")
     ostruct_metadata = panopticon_api.artefact_for_slug('my-published-item')

data/lib/gds_api/content_api.rb

@@ -108,23 +108,14 @@ class GdsApi::ContentApi < GdsApi::Base
     get_json("#{@endpoint}/licences.json?ids=#{ids}")
   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
+  def business_support_schemes(facets)
+    url = "#{base_url}/business_support_schemes.json"
+    query = facets.map { |k,v| "#{k}=#{v}" }
+    if query.any?
+      url += "?#{query.join("&")}"
     end
-    get_batch(last_batch_url, response)
+
+    get_json!(url)
   end
 
   def get_list!(url)
@@ -158,17 +149,6 @@ class GdsApi::ContentApi < GdsApi::Base
       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
-
     def key_for_tag_type(tag_type)
       tag_type.nil? ? "tag" : CGI.escape(tag_type)
     end

data/lib/gds_api/test_helpers/business_support_api.rb

@@ -1,35 +1,20 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'cgi'
-require 'gds_api/test_helpers/common_responses'
+require 'gds_api/test_helpers/business_support_helper'
 
 module GdsApi
   module TestHelpers
     module BusinessSupportApi
       include GdsApi::TestHelpers::CommonResponses
+      include GdsApi::TestHelpers::BusinessSupportHelper
       # Generally true. If you are initializing the client differently,
       # you could redefine/override the constant or stub directly.
       BUSINESS_SUPPORT_API_ENDPOINT = Plek.current.find('business-support-api')
 
       def setup_business_support_api_schemes_stubs
-        @stubbed_business_support_schemes = {}
-        stub_request(:get, %r{\A#{BUSINESS_SUPPORT_API_ENDPOINT}/business-support-schemes\.json}).to_return do |request|
-          if request.uri.query_values
-            key = facet_key(request.uri.query_values)
-            results = @stubbed_business_support_schemes[key] || []
-          else
-            results = @stubbed_business_support_schemes['default']
-          end
-          {:body => plural_response_base.merge("results" => results, "total" => results.size).to_json}
-        end
-
+        setup_business_support_stubs(BUSINESS_SUPPORT_API_ENDPOINT, 'business-support-schemes')
       end
 
       def business_support_api_has_scheme(scheme, facets={})
-        key = facet_key(facets)
-        unless @stubbed_business_support_schemes.has_key?(key)
-          @stubbed_business_support_schemes[key] = []
-        end
-        @stubbed_business_support_schemes[key] << scheme
+        api_has_business_support(scheme, facets)
       end
 
       def business_support_api_has_schemes(schemes, facets={})
@@ -44,14 +29,6 @@ module GdsApi
           {:body => response_base.merge(:format => 'business_support', :title => title, :details => scheme).to_json}
         end
       end
-
-      private
-
-      def facet_key(facets)
-        key = 'default'
-        key = facets.values.sort.hash.to_s if facets and !facets.empty?
-        key
-      end
     end
   end
 end

data/lib/gds_api/test_helpers/business_support_helper.rb

@@ -0,0 +1,40 @@
+require 'gds_api/test_helpers/json_client_helper'
+require 'cgi'
+require 'gds_api/test_helpers/common_responses'
+
+
+module GdsApi
+  module TestHelpers
+    module BusinessSupportHelper
+      def setup_business_support_stubs(endpoint, path)
+        @stubbed_business_supports = {}
+        stub_request(:get, %r{\A#{endpoint}/#{path}\.json}).to_return do |request|
+          if request.uri.query_values
+            key = facet_key(request.uri.query_values)
+            results = @stubbed_business_supports[key] || []
+          else
+            results = @stubbed_business_supports['default']
+          end
+          {:body => plural_response_base.merge("results" => results, "total" => results.size).to_json}
+        end
+
+      end
+
+      def api_has_business_support(business_support, facets={})
+        key = facet_key(facets)
+        unless @stubbed_business_supports.has_key?(key)
+          @stubbed_business_supports[key] = []
+        end
+        @stubbed_business_supports[key] << business_support
+      end
+
+      private
+
+      def facet_key(facets)
+        key = 'default'
+        key = facets.values.flatten.sort.hash.to_s if facets and !facets.empty?
+        key
+      end
+    end
+  end
+end

data/lib/gds_api/test_helpers/content_api.rb

@@ -1,11 +1,13 @@
 require 'gds_api/test_helpers/json_client_helper'
 require 'cgi'
 require 'gds_api/test_helpers/common_responses'
+require 'gds_api/test_helpers/business_support_helper'
 
 module GdsApi
   module TestHelpers
     module ContentApi
       include GdsApi::TestHelpers::CommonResponses
+      include GdsApi::TestHelpers::BusinessSupportHelper
       # Generally true. If you are initializing the client differently,
       # you could redefine/override the constant or stub directly.
       CONTENT_API_ENDPOINT = Plek.current.find('contentapi')
@@ -342,21 +344,23 @@ 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["identifier"] }
-          else
-            results = []
-          end
-          {:body => plural_response_base.merge("results" => results, "total" => results.size).to_json}
-        end
+        setup_business_support_stubs(CONTENT_API_ENDPOINT, 'business_support_schemes')
       end
 
-      def content_api_has_business_support_scheme(scheme)
-        raise "Need an identifier" if scheme["identifier"].nil?
-        @stubbed_content_api_business_support_schemes << scheme
+      def content_api_has_business_support_scheme(scheme, facets)
+        api_has_business_support(scheme, facets)
+      end
+
+      def content_api_has_default_business_support_schemes
+        empty_results = {
+          "_response_info" => {"status" => "ok"},
+          "description" => "Business Support Schemes!",
+          "total" => 0, "startIndex" => 1, "pageSize" => 0, "currentPage" => 1, "pages" => 1,
+          "results" => []
+        }
+
+        stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/business_support_schemes\.json}).
+          to_return(:body => empty_results.to_json)
       end
 
       def content_api_licence_hash(licence_identifier, options = {})

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '9.2.0'
+  VERSION = '10.0.0'
 end

data/test/content_api_test.rb

@@ -576,30 +576,10 @@ describe GdsApi::ContentApi 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'])
+      response = @api.business_support_schemes(:drink => "coffee")
 
       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
+      assert_requested :get, "#{@base_api_url}/business_support_schemes.json?drink=coffee", :times => 1
     end
 
     it "should raise an error if content_api returns 404" do
@@ -620,58 +600,17 @@ describe GdsApi::ContentApi do
       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..191]
-        assert_requested :get, "#{@base_api_url}/business_support_schemes.json?identifiers=#{first_batch.join(',')}"
-        second_batch = ids[192..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..191]
-        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[192..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
-
     describe "test helpers" do
       it "should have representative test helpers" do
         setup_content_api_business_support_schemes_stubs
-        s1 = { "title" => "Scheme 1", "identifier" => "s1", "format" => "business_support" }
-        content_api_has_business_support_scheme(s1)
-        s2 = { "title" => "Scheme 2", "identifier" => "s2", "format" => "business_support" }
-        content_api_has_business_support_scheme(s2)
-        s3 = { "title" => "Scheme 3", "identifier" => "s3", "format" => "business_support" }
-        content_api_has_business_support_scheme(s3)
-
-        response = @api.business_support_schemes(['s1', 's3']).to_hash
+        s1 = { "title" => "Scheme 1", "format" => "business_support" }
+        content_api_has_business_support_scheme(s1, :locations => "england", :sectors => "farming")
+        s2 = { "title" => "Scheme 2", "format" => "business_support" }
+        content_api_has_business_support_scheme(s2, :sectors => "farming")
+        s3 = { "title" => "Scheme 3", "format" => "business_support" }
+        content_api_has_business_support_scheme(s3, :locations => "england", :sectors => "farming")
+
+        response = @api.business_support_schemes(:locations => "england", :sectors => "farming").to_hash
 
         assert_equal 2, response["total"]
         assert_equal [s1, s3], response["results"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 10.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-28 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -294,6 +294,7 @@ files:
 - lib/gds_api/test_helpers/performance_platform/data_in.rb
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/organisations.rb
+- lib/gds_api/test_helpers/business_support_helper.rb
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/worldwide.rb
 - lib/gds_api/test_helpers/mapit.rb
@@ -367,7 +368,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3249051588083426737
+      hash: 21857638136048876
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -376,7 +377,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3249051588083426737
+      hash: 21857638136048876
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23