gds-api-adapters 3.2.0 → 3.3.0

data/lib/gds_api/content_api.rb

@@ -60,6 +60,11 @@ class GdsApi::ContentApi < GdsApi::Base
     get_json!("#{base_url}/local_authorities.json?snac_code=#{CGI.escape(snac_code)}")
   end
 
+  def licences_for_ids(ids)
+    ids = ids.map(&:to_s).sort.join(',')
+    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="

data/lib/gds_api/publisher.rb

@@ -38,12 +38,6 @@ class GdsApi::Publisher < GdsApi::Base
     json.to_hash if json
   end
 
-  def licences_for_ids(ids)
-    ids = ids.map(&:to_s).sort.join(',')
-    response = get_json("#{@endpoint}/licences.json?ids=#{ids}")
-    response.to_ostruct if response
-  end
-
 private
   def convert_updated_date(container)
     if container.updated_at && container.updated_at.class == String

data/lib/gds_api/test_helpers/content_api.rb

@@ -228,6 +228,60 @@ module GdsApi
         @stubbed_content_api_business_support_schemes << scheme
       end
 
+      def content_api_licence_hash(licence_identifier, options = {})
+        details = {
+          title: "Publisher title",
+          slug: 'licence-slug',
+          licence_short_description: "Short description of licence"
+        }
+        details.merge!(options)
+
+        {
+          "title" => details[:title],
+          "id" => "http://example.org/#{details[:slug]}.json",
+          "web_url" =>  "http://www.test.gov.uk/#{details[:slug]}",
+          "format" => "licence",
+          "details" => {
+            "need_id" => nil,
+            "business_proposition" => false,
+            "alternative_title" => nil,
+            "overview" => nil,
+            "will_continue_on" => nil,
+            "continuation_link" => nil,
+            "licence_identifier" => licence_identifier,
+            "licence_short_description" => details[:licence_short_description],
+            "licence_overview" => nil,
+            "updated_at" => "2012-10-06T12:00:05+01:00"
+          },
+          "tags" => [],
+          "related" => []
+        }
+      end
+
+      def setup_content_api_licences_stubs
+        @stubbed_content_api_licences = []
+        stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/licences}).to_return do |request|
+          if request.uri.query_values and request.uri.query_values["ids"]
+            ids = request.uri.query_values["ids"].split(',')
+            valid_licences = @stubbed_content_api_licences.select { |l| ids.include? l[:licence_identifier] }
+            {
+              :body => {
+                'results' => valid_licences.map { |licence| 
+                  content_api_licence_hash(licence[:licence_identifier], licence)
+                }
+              }.to_json
+            }
+          else
+            {:body => {'results' => []}.to_json}
+          end
+        end
+      end
+
+      def content_api_has_licence(details)
+        raise "Need a licence identifier" if details[:licence_identifier].nil?
+        @stubbed_content_api_licences << details
+      end
+
       private
 
         def titleize_slug(slug)

data/lib/gds_api/test_helpers/publisher.rb

@@ -42,23 +42,6 @@ module GdsApi
         uri = "#{PUBLISHER_ENDPOINT}/local_transactions/#{slug}.json"
         stub_request(:post, uri).to_return(:body => "", :status => 404)
       end
-
-      def setup_publisher_licences_stubs
-        @stubbed_publisher_licences = []
-        stub_request(:get, %r{\A#{PUBLISHER_ENDPOINT}/licences}).to_return do |request|
-          if request.uri.query_values and request.uri.query_values["ids"]
-            ids = request.uri.query_values["ids"].split(',')
-            {:body => @stubbed_publisher_licences.select {|l| ids.include? l[:licence_identifier] }.to_json}
-          else
-            {:body => [].to_json}
-          end
-        end
-      end
-
-      def publisher_has_licence(details)
-        raise "Need a licence identifier" if details[:licence_identifier].nil?
-        @stubbed_publisher_licences << details
-      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

data/test/content_api_test.rb

@@ -99,7 +99,7 @@ describe GdsApi::ContentApi do
 
     it "should return an unpublished artefact with a snac code" do
       body = artefact_for_slug('licence-example')
-      url = "#{CONTENT_API_ENDPOINT}/licence-example.json?snac=1234&edition=1"
+      url = "#{@base_api_url}/licence-example.json?snac=1234&edition=1"
       stub_request(:get, url).to_return(status: 200, body: body.to_json)
 
       api = GdsApi::ContentApi.new('test', { bearer_token: 'MY_BEARER_TOKEN' })
@@ -358,6 +358,42 @@ describe GdsApi::ContentApi do
     end
   end
 
+  describe "getting licence details" do
+    it "should get licence details" do
+      setup_content_api_licences_stubs
+
+      content_api_has_licence :licence_identifier => "1234", :title => 'Test Licence 1', :slug => 'test-licence-1',
+        :licence_short_description => 'A short description'
+      content_api_has_licence :licence_identifier => "1235", :title => 'Test Licence 2', :slug => 'test-licence-2',
+        :licence_short_description => 'A short description'
+      content_api_has_licence :licence_identifier => "AB1234", :title => 'Test Licence 3', :slug => 'test-licence-3',
+        :licence_short_description => 'A short description'
+
+      results = @api.licences_for_ids([1234, 'AB1234', 'something']).to_ostruct.results
+      assert_equal 2, results.size
+      assert_equal ['1234', 'AB1234'], results.map { |r| r.details.licence_identifier }
+      assert_equal ['Test Licence 1', 'Test Licence 3'], results.map(&:title).sort
+      assert_equal ['http://www.test.gov.uk/test-licence-1', 'http://www.test.gov.uk/test-licence-3'], results.map(&:web_url).sort
+      assert_equal 'A short description', results[0].details.licence_short_description
+      assert_equal 'A short description', results[1].details.licence_short_description
+    end
+
+    it "should return empty array with no licences" do
+      setup_content_api_licences_stubs
+
+      assert_equal [], @api.licences_for_ids([123,124]).to_ostruct.results
+    end
+
+    it "should raise an error if publisher returns an error" do
+      stub_request(:get, %r[\A#{@base_api_url}/licences]).
+        to_return(:status => [503, "Service temporarily unabailable"])
+
+      assert_raises GdsApi::HTTPErrorResponse do
+        @api.licences_for_ids([123,124])
+      end
+    end
+  end
+
   def api_response_for_results(results)
     {
       "_response_info" => {

data/test/publisher_api_test.rb

@@ -106,83 +106,4 @@ describe GdsApi::Publisher do
       to_return(:status => 200, :body => '{"snac": "12345"}', :headers => {})
     assert_equal '12345', api.council_for_slug('fake-transaction', [12345])
   end
-
-  describe "getting licence details from publisher" do
-    it "should get licence details from publisher" do
-      setup_publisher_licences_stubs
-
-      publisher_has_licence :licence_identifier => "1234", :title => 'Test Licence 1', :slug => 'test-licence-1',
-        :licence_short_description => 'A short description'
-      publisher_has_licence :licence_identifier => "1235", :title => 'Test Licence 2', :slug => 'test-licence-2',
-        :licence_short_description => 'A short description'
-      publisher_has_licence :licence_identifier => "AB1234", :title => 'Test Licence 3', :slug => 'test-licence-3',
-        :licence_short_description => 'A short description'
-
-      results = api.licences_for_ids([1234, 'AB1234', 'something'])
-      assert_equal 2, results.size
-      assert_equal ['1234', 'AB1234'], results.map(&:licence_identifier)
-      assert_equal ['Test Licence 1', 'Test Licence 3'], results.map(&:title).sort
-      assert_equal ['test-licence-1', 'test-licence-3'], results.map(&:slug).sort
-      assert_equal 'A short description', results[0].licence_short_description
-      assert_equal 'A short description', results[1].licence_short_description
-    end
-
-    it "should return empty array with no licences" do
-      setup_publisher_licences_stubs
-
-      assert_equal [], api.licences_for_ids([123,124])
-    end
-
-    it "should raise an error if publisher returns an error" do
-      stub_request(:get, %r[\A#{PUBLISHER_ENDPOINT}/licences]).
-        to_return(:status => [503, "Service temporarily unabailable"])
-
-      assert_raises GdsApi::HTTPErrorResponse do
-        api.licences_for_ids([123,124])
-      end
-    end
-
-    it "should return nil if a council snac code is not found" do
-      stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_snac?snac=bloop").
-        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-        to_return(:status => 404, :body => " ", :headers => {})
-
-      assert_equal nil, api.council_for_snac_code("bloop")
-    end
-
-    it "should return a council hash for a snac code" do
-      stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_snac?snac=AA00").
-        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_snac_code("AA00")
-    end
-
-    it "should return nil if a council name is not found" do
-      stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=bloop").
-        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-        to_return(:status => 404, :body => " ", :headers => {})
-
-      assert_equal nil, api.council_for_name("bloop")
-    end
-
-    it "should return a council hash for a mixed case council name" do
-      stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=Some%20Council").
-        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_name("Some Council")
-    end
-
-    it "should return a council hash for a lowercase council name" do
-      stub_request(:get, "#{PUBLISHER_ENDPOINT}/local_transactions/find_by_council_name?name=some%20council").
-        with(:headers => GdsApi::JsonClient::DEFAULT_REQUEST_HEADERS).
-        to_return(:status => 200, :body => '{"name": "Some Council", "snac": "AA00"}', :headers => {})
-
-      expected = {"name" => "Some Council", "snac" => "AA00"}
-      assert_equal expected, api.council_for_name("some council")
-    end
-  end
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-05 00:00:00 Z
+date: 2012-10-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -205,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 827207644748547205
+      hash: 604582119140206169
       segments: 
       - 0
       version: "0"
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 827207644748547205
+      hash: 604582119140206169
       segments: 
       - 0
       version: "0"