gds-api-adapters 5.5.0 → 6.0.0

data/test/list_response_test.rb

@@ -0,0 +1,179 @@
+require_relative 'test_helper'
+require 'gds_api/list_response'
+
+describe GdsApi::ListResponse do
+
+  describe "accessing results" do
+    before :each do
+    end
+
+    it "should allow Enumerable access to the results array" do
+      data = {
+        "results" => [
+          "foo",
+          "bar",
+          "baz",
+        ],
+        "total" => 3,
+        "_response_info" => {
+          "status" => "ok",
+        }
+      }
+      response = GdsApi::ListResponse.new(stub(:body => data.to_json), nil)
+
+      assert_equal "foo", response.first
+      assert_equal %w(foo bar baz), response.to_a
+      assert response.any?
+    end
+
+    it "should handle an empty result set" do
+      data = {
+        "results" => [],
+        "total" => 0,
+        "_response_info" => {
+          "status" => "ok",
+        }
+      }
+      response = GdsApi::ListResponse.new(stub(:body => data.to_json), nil)
+
+      assert_equal [], response.to_a
+      assert ! response.any?
+    end
+  end
+
+  describe "handling pagination" do
+    before :each do
+      page_1 = {
+        "results" => ["foo1", "bar1"],
+        "total" => 6,
+        "current_page" => 1, "pages" => 3, "page_size" => 2,
+        "_response_info" => {
+          "status" => "ok",
+          "links" => [
+            {"href" => "http://www.example.com/2", "rel" => "next"},
+            {"href" => "http://www.example.com/1", "rel" => "self"},
+          ]
+        }
+      }
+      page_2 = {
+        "results" => ["foo2", "bar2"],
+        "total" => 6,
+        "current_page" => 2, "pages" => 3, "page_size" => 2,
+        "_response_info" => {
+          "status" => "ok",
+          "links" => [
+            {"href" => "http://www.example.com/1", "rel" => "previous"},
+            {"href" => "http://www.example.com/3", "rel" => "next"},
+            {"href" => "http://www.example.com/2", "rel" => "self"},
+          ]
+        }
+      }
+      page_3 = {
+        "results" => ["foo3", "bar3"],
+        "total" => 6,
+        "current_page" => 3, "pages" => 3, "page_size" => 2,
+        "_response_info" => {
+          "status" => "ok",
+          "links" => [
+            {"href" => "http://www.example.com/2", "rel" => "previous"},
+            {"href" => "http://www.example.com/3", "rel" => "self"},
+          ]
+        }
+      }
+      @p1_response = stub(:body => page_1.to_json, :status => 200, 
+         :headers => {:link => '<http://www.example.com/1>; rel="self", <http://www.example.com/2>; rel="next"'})
+      @p2_response = stub(:body => page_2.to_json, :status => 200, 
+         :headers => {:link => '<http://www.example.com/2>; rel="self", <http://www.example.com/3>; rel="next", <http://www.example.com/1>; rel="previous"'})
+      @p3_response = stub(:body => page_3.to_json, :status => 200, 
+         :headers => {:link => '<http://www.example.com/3>; rel="self", <http://www.example.com/1>; rel="previous"'})
+
+      @client = stub()
+      @client.stubs(:get_list!).with("http://www.example.com/1").returns(GdsApi::ListResponse.new(@p1_response, @client))
+      @client.stubs(:get_list!).with("http://www.example.com/2").returns(GdsApi::ListResponse.new(@p2_response, @client))
+      @client.stubs(:get_list!).with("http://www.example.com/3").returns(GdsApi::ListResponse.new(@p3_response, @client))
+    end
+
+    describe "accessing next page" do
+      it "should allow accessing the next page" do
+        resp = GdsApi::ListResponse.new(@p1_response, @client)
+        assert resp.has_next_page?
+        assert_equal %w(foo2 bar2), resp.next_page.results
+      end
+
+      it "should return nil with no next page" do
+        resp = GdsApi::ListResponse.new(@p3_response, @client)
+        assert ! resp.has_next_page?
+        assert_equal nil, resp.next_page
+      end
+
+      it "should memoize the next_page" do
+        resp = GdsApi::ListResponse.new(@p1_response, @client)
+        first_call = resp.next_page
+
+        @client.unstub(:get_list!) # Necessary because of https://github.com/freerange/mocha/issues/44
+        @client.expects(:get_list!).never
+        second_call = resp.next_page
+        assert_equal first_call, second_call
+      end
+    end
+
+    describe "accessing previous page" do
+      it "should allow accessing the previous page" do
+        resp = GdsApi::ListResponse.new(@p2_response, @client)
+        assert resp.has_previous_page?
+        assert_equal %w(foo1 bar1), resp.previous_page.results
+      end
+
+      it "should return nil with no previous page" do
+        resp = GdsApi::ListResponse.new(@p1_response, @client)
+        assert ! resp.has_previous_page?
+        assert_equal nil, resp.previous_page
+      end
+
+      it "should memoize the previous_page" do
+        resp = GdsApi::ListResponse.new(@p3_response, @client)
+        first_call = resp.previous_page
+
+        @client.unstub(:get_list!) # Necessary because of https://github.com/freerange/mocha/issues/44
+        @client.expects(:get_list!).never
+        second_call = resp.previous_page
+        assert_equal first_call, second_call
+      end
+    end
+
+    describe "accessing content across all pages" do
+      before :each do
+        @response = GdsApi::ListResponse.new(@p1_response, @client)
+      end
+
+      it "should allow iteration across multiple pages" do
+        assert_equal 6, @response.with_subsequent_pages.count
+        assert_equal %w(foo1 bar1 foo2 bar2 foo3 bar3), @response.with_subsequent_pages.to_a
+        assert_equal %w(foo1 foo2 foo3), @response.with_subsequent_pages.select {|s| s =~ /foo/}
+      end
+
+      it "should not load a page multiple times" do
+        @client.unstub(:get_list!) # Necessary because of https://github.com/freerange/mocha/issues/44
+        @client.expects(:get_list!).with("http://www.example.com/2").once.returns(GdsApi::ListResponse.new(@p2_response, @client))
+        @client.expects(:get_list!).with("http://www.example.com/3").once.returns(GdsApi::ListResponse.new(@p3_response, @client))
+
+        3.times do
+          @response.with_subsequent_pages.to_a
+        end
+      end
+
+      it "should work with a non-paginated response" do
+        data = {
+          "results" => ["foo1", "bar1"],
+          "total" => 2,
+          "_response_info" => {
+            "status" => "ok",
+          }
+        }
+        response = GdsApi::ListResponse.new(stub(:body => data.to_json, :status => 200, :headers => {}), nil)
+
+        assert_equal %w(foo1 bar1), response.with_subsequent_pages.to_a
+      end
+    end
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,192 @@
+require_relative 'test_helper'
+require 'gds_api/response'
+
+describe GdsApi::Response do
+
+  describe "accessing HTTP response details" do
+    before :each do
+      @mock_http_response = stub(:body => "A Response body", :code => 200)
+      @response = GdsApi::Response.new(@mock_http_response)
+    end
+
+    it "should return the raw response body" do
+      assert_equal "A Response body", @response.raw_response_body
+    end
+
+    it "should return the status code" do
+      assert_equal 200, @response.code
+    end
+  end
+
+  describe "processing web_urls" do
+    def build_response(body_string, relative_to = "https://www.gov.uk")
+      GdsApi::Response.new(stub(:body => body_string), :web_urls_relative_to => relative_to)
+    end
+
+    it "should map web URLs" do
+      body = {
+        "web_url" => "https://www.gov.uk/test"
+      }.to_json
+      assert_equal "/test", build_response(body).web_url
+    end
+
+    it "should leave other properties alone" do
+      body = {
+        "title" => "Title",
+        "description" => "Description"
+      }.to_json
+      response = build_response(body)
+      assert_equal "Title", response.title
+      assert_equal "Description", response.description
+    end
+
+    it "should traverse into hashes" do
+      body = {
+        "details" => {
+          "chirality" => "widdershins",
+          "web_url" => "https://www.gov.uk/left",
+        }
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "/left", response.details.web_url
+    end
+
+    it "should traverse into arrays" do
+      body = {
+        "other_urls" => [
+          { "title" => "Pies", "web_url" => "https://www.gov.uk/pies" },
+          { "title" => "Cheese", "web_url" => "https://www.gov.uk/cheese" },
+        ]
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "/pies", response.other_urls[0].web_url
+      assert_equal "/cheese", response.other_urls[1].web_url
+    end
+
+    it "should handle nil values" do
+      body = {"web_url" => nil}.to_json
+
+      response = build_response(body)
+      assert_nil response.web_url
+    end
+
+    it "should handle query parameters" do
+      body = {
+        "web_url" => "https://www.gov.uk/thing?does=stuff"
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "/thing?does=stuff", response.web_url
+    end
+
+    it "should handle fragments" do
+      body = {
+        "web_url" => "https://www.gov.uk/thing#part-2"
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "/thing#part-2", response.web_url
+    end
+
+    it "should keep URLs from other domains absolute" do
+      body = {
+        "web_url" => "https://www.example.com/example"
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "https://www.example.com/example", response.web_url
+    end
+
+    it "should keep URLs with other schemes absolute" do
+      body = {
+        "web_url" => "http://www.example.com/example"
+      }.to_json
+
+      response = build_response(body)
+      assert_equal "http://www.example.com/example", response.web_url
+    end
+  end
+
+  describe "hash and openstruct access" do
+    before :each do
+      @response_data = {
+        "_response_info" => {
+            "status" => "ok"
+        },
+        "id" => "https://www.gov.uk/api/vat-rates.json",
+        "web_url" => "https://www.gov.uk/vat-rates",
+        "title" => "VAT rates",
+        "format" => "answer",
+        "updated_at" => "2013-04-04T15:51:54+01:00",
+        "details" => {
+            "need_id" => "1870",
+            "business_proposition" => false,
+            "description" => "Current VAT rates - standard 20% and rates for reduced rate and zero-rated items",
+            "language" => "en",
+        },
+        "tags" => [
+          {"slug" => "foo"},
+          {"slug" => "bar"},
+          {"slug" => "baz"},
+        ],
+      }
+      @response = GdsApi::Response.new(stub(:body => @response_data.to_json))
+    end
+
+    describe "behaving like a read-only hash" do
+      it "should allow accessing members by key" do
+        assert_equal "VAT rates", @response["title"]
+      end
+
+      it "should allow accessing nested keys" do
+        assert_equal "1870", @response["details"]["need_id"]
+      end
+
+      it "should return nil for a non-existent key" do
+        assert_equal nil, @response["foo"]
+      end
+
+      it "should memoize the parsed hash" do
+        @response["id"]
+        JSON.expects(:parse).never
+        assert_equal "VAT rates", @response["title"]
+      end
+    end
+
+    describe "behaving like a read-only openstruct" do
+      it "should allow accessing members using methods" do
+        assert_equal "VAT rates", @response.title
+      end
+
+      it "should allow accessing nested values" do
+        assert_equal "1870", @response.details.need_id
+      end
+
+      it "should allow accessing values nested within arrays" do
+        assert_equal "bar", @response.tags[1].slug
+      end
+
+      it "should return nil for a non-existent key" do
+        assert_equal nil, @response.foo
+      end
+
+      it "should memoize the generated openstruct" do
+        @response.id
+        GdsApi::Response.expects(:build_ostruct_recursively).never
+        assert_equal "VAT rates", @response.title
+      end
+
+      describe "handling respond_to?" do
+        it "should respond_to methods for keys that exist" do
+          assert @response.respond_to?(:title)
+        end
+
+        it "should not respond_to keys that don't exist" do
+          assert ! @response.respond_to?(:foo)
+        end
+      end
+    end
+  end
+end

data/test/rummager_test.rb

@@ -8,27 +8,23 @@ describe GdsApi::Rummager do
     stub_request(:get, /example.com\/advanced_search/).to_return(body: "[]")
   end
 
-  it "should raise an exception if the search service uri is not set" do
-    assert_raises(GdsApi::Rummager::SearchUriNotSpecified) { GdsApi::Rummager.new(nil) }
-  end
-
   it "should raise an exception if the service at the search URI returns a 500" do
     stub_request(:get, /example.com\/search/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::Rummager::SearchServiceError) do
+    assert_raises(GdsApi::HTTPErrorResponse) do
       GdsApi::Rummager.new("http://example.com").search("query")
     end
   end
 
   it "should raise an exception if the service at the search URI returns a 404" do
     stub_request(:get, /example.com\/search/).to_return(status: [404, "Not Found"])
-    assert_raises(GdsApi::Rummager::SearchServiceError) do
+    assert_raises(GdsApi::HTTPNotFound) do
       GdsApi::Rummager.new("http://example.com").search("query")
     end
   end
 
   it "should raise an exception if the service at the search URI times out" do
     stub_request(:get, /example.com\/search/).to_timeout
-    assert_raises(GdsApi::Rummager::SearchTimeout) do
+    assert_raises(GdsApi::TimedOutException) do
       GdsApi::Rummager.new("http://example.com").search("query")
     end
   end
@@ -38,7 +34,7 @@ describe GdsApi::Rummager do
     stub_request(:get, /example.com\/search/).to_return(body: search_results.to_json)
     results = GdsApi::Rummager.new("http://example.com").search("query")
 
-    assert_equal search_results, results
+    assert_equal search_results, results.to_hash
   end
 
   it "should return an empty set of results without making request if query is empty" do
@@ -73,26 +69,6 @@ describe GdsApi::Rummager do
     assert_requested :get, /format_filter=specialist_guidance/
   end
 
-  it "should not tell the http client to use ssl if we're connecting to an http host" do
-    response = stub('response', code: '200', body: '[]')
-    http = stub('http', get: response)
-    Net::HTTP.stubs(:new).returns(http)
-
-    http.expects(:use_ssl=).never
-
-    client = GdsApi::Rummager.new("http://example.com").search "search-term"
-  end
-
-  it "should tell the http client to use ssl if we're connecting to an https host" do
-    response = stub('response', code: '200', body: '[]')
-    http = stub('http', get: response)
-    Net::HTTP.stubs(:new).returns(http)
-
-    http.expects(:use_ssl=).with(true)
-
-    client = GdsApi::Rummager.new("https://example.com").search "search-term"
-  end
-
   it "should add a format filter parameter to autocomplete if provided" do
     GdsApi::Rummager.new("http://example.com").autocomplete "search-term", "specialist_guidance"
 
@@ -118,21 +94,21 @@ describe GdsApi::Rummager do
 
   it "#advanced_search should raise an exception if the service at the search URI returns a 500" do
     stub_request(:get, /example.com\/advanced_search/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::Rummager::SearchServiceError) do
+    assert_raises(GdsApi::HTTPErrorResponse) do
       GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
     end
   end
 
   it "#advanced_search should raise an exception if the service at the search URI returns a 404" do
     stub_request(:get, /example.com\/advanced_search/).to_return(status: [404, "Not Found"])
-    assert_raises(GdsApi::Rummager::SearchServiceError) do
+    assert_raises(GdsApi::HTTPNotFound) do
       GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
     end
   end
 
   it "#advanced_search should raise an exception if the service at the search URI times out" do
     stub_request(:get, /example.com\/advanced_search/).to_timeout
-    assert_raises(GdsApi::Rummager::SearchTimeout) do
+    assert_raises(GdsApi::TimedOutException) do
       GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
     end
   end
@@ -142,7 +118,7 @@ describe GdsApi::Rummager do
     stub_request(:get, /example.com\/advanced_search/).to_return(body: search_results.to_json)
     results = GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
 
-    assert_equal search_results, results
+    assert_equal search_results, results.to_hash
   end
 
   it "#advanced_search should return an empty set of results without making request if arguments are empty" do

data/test/test_helper.rb

@@ -31,3 +31,5 @@ end
 
 require 'webmock/minitest'
 WebMock.disable_net_connect!
+
+require 'gds_api/test_helpers/json_client_helper'

data/test/worldwide_api_test.rb

@@ -0,0 +1,71 @@
+require_relative 'test_helper'
+require 'gds_api/worldwide'
+require 'gds_api/test_helpers/worldwide'
+
+describe GdsApi::Worldwide do
+  include GdsApi::TestHelpers::Worldwide
+
+  before do
+    @base_api_url = GdsApi::TestHelpers::Worldwide::WORLDWIDE_API_ENDPOINT
+    @api = GdsApi::Worldwide.new(@base_api_url)
+  end
+
+  describe "fetching list of world locations" do
+    it "should get the world locations" do
+      country_slugs = %w(the-shire rivendel rohan lorien gondor arnor mordor)
+      worldwide_api_has_locations(country_slugs)
+
+      response = @api.world_locations
+      assert_equal country_slugs, response.map {|r| r.details.slug }
+      assert_equal "Rohan", response.results[2].title
+    end
+
+    it "should handle the pagination" do
+      country_slugs = (1..50).map {|n| "country-#{n}" }
+      worldwide_api_has_locations(country_slugs)
+
+      response = @api.world_locations
+      assert_equal country_slugs, response.with_subsequent_pages.map {|r| r.details.slug }
+    end
+
+    it "should raise error if endpoint 404s" do
+      stub_request(:get, "#{@base_api_url}/api/world-locations").to_return(:status => 404)
+      assert_raises GdsApi::HTTPNotFound do
+        @api.world_locations
+      end
+    end
+  end
+
+  describe "fetching a world location" do
+    it "should return the details" do
+      worldwide_api_has_location('rohan')
+
+      response = @api.world_location('rohan')
+      assert_equal 'Rohan', response.title
+    end
+
+    it "should return nil for a non-existent location" do
+      worldwide_api_does_not_have_location('non-existent')
+
+      assert_nil @api.world_location('non-existent')
+    end
+  end
+
+  describe "fetching organisations for a location" do
+    it "should return the organisation details" do
+      details = JSON.parse(load_fixture_file("world_organisations_australia.json").read)
+      worldwide_api_has_organisations_for_location('australia', details)
+
+      response = @api.organisations_for_world_location('australia')
+      assert response.is_a?(GdsApi::ListResponse)
+      assert_equal ["UK Trade & Investment Australia", "British High Commission Canberra"], response.map(&:title)
+    end
+
+    it "should raise error on 404" do
+      stub_request(:get, "#{@base_api_url}/api/world-locations/non-existent/organisations").to_return(:status => 404)
+      assert_raises GdsApi::HTTPNotFound do
+        @api.organisations_for_world_location('non-existent')
+      end
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 5.5.0
+  version: 6.0.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-04-16 00:00:00 Z
+date: 2013-04-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -191,6 +191,7 @@ files:
 - lib/gds_api/base.rb
 - lib/gds_api/gov_uk_delivery.rb
 - lib/gds_api/licence_application.rb
+- lib/gds_api/null_cache.rb
 - lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/needotron.rb
 - lib/gds_api/imminence.rb
@@ -198,14 +199,14 @@ files:
 - lib/gds_api/content_api.rb
 - lib/gds_api/mapit.rb
 - lib/gds_api/exceptions.rb
+- lib/gds_api/list_response.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/response.rb
-- lib/gds_api/content_api/list_response.rb
-- lib/gds_api/content_api/response.rb
 - lib/gds_api/publisher.rb
 - lib/gds_api/test_helpers/gov_uk_delivery.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/common_responses.rb
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/content_api.rb
 - lib/gds_api/test_helpers/mapit.rb
@@ -214,15 +215,16 @@ files:
 - lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
+- lib/gds_api/test_helpers/worldwide.rb
 - lib/gds_api/part_methods.rb
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/panopticon.rb
+- lib/gds_api/worldwide.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
 - test/rummager_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
 - test/licence_application_api_test.rb
 - test/mapit_test.rb
 - test/gov_uk_delivery_test.rb
@@ -230,7 +232,11 @@ files:
 - test/imminence_api_test.rb
 - test/json_client_test.rb
 - test/test_helper.rb
+- test/list_response_test.rb
+- test/worldwide_api_test.rb
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/hello.txt
+- test/response_test.rb
 - test/asset_manager_test.rb
 - test/gds_api_base_test.rb
 - test/content_api_test.rb
@@ -248,7 +254,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3858152326931361631
+      hash: -4292266406700187648
       segments: 
       - 0
       version: "0"
@@ -257,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3858152326931361631
+      hash: -4292266406700187648
       segments: 
       - 0
       version: "0"
@@ -271,7 +277,6 @@ summary: Adapters to work with GDS APIs
 test_files: 
 - test/rummager_test.rb
 - test/publisher_api_test.rb
-- test/content_api_response_test.rb
 - test/licence_application_api_test.rb
 - test/mapit_test.rb
 - test/gov_uk_delivery_test.rb
@@ -279,7 +284,11 @@ test_files:
 - test/imminence_api_test.rb
 - test/json_client_test.rb
 - test/test_helper.rb
+- test/list_response_test.rb
+- test/worldwide_api_test.rb
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/hello.txt
+- test/response_test.rb
 - test/asset_manager_test.rb
 - test/gds_api_base_test.rb
 - test/content_api_test.rb