gds-api-adapters 36.4.1 → 37.0.0

data/test/response_test.rb

@@ -110,7 +110,7 @@ describe GdsApi::Response do
       body = {
         "web_url" => "https://www.gov.uk/test"
       }.to_json
-      assert_equal "/test", build_response(body).web_url
+      assert_equal "/test", build_response(body)['web_url']
     end
 
     it "should leave other properties alone" do
@@ -119,8 +119,8 @@ describe GdsApi::Response do
         "description" => "Description"
       }.to_json
       response = build_response(body)
-      assert_equal "Title", response.title
-      assert_equal "Description", response.description
+      assert_equal "Title", response['title']
+      assert_equal "Description", response['description']
     end
 
     it "should traverse into hashes" do
@@ -132,7 +132,7 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "/left", response.details.web_url
+      assert_equal "/left", response['details']['web_url']
     end
 
     it "should traverse into arrays" do
@@ -144,15 +144,15 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "/pies", response.other_urls[0].web_url
-      assert_equal "/cheese", response.other_urls[1].web_url
+      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
+      assert_nil response['web_url']
     end
 
     it "should handle query parameters" do
@@ -161,7 +161,7 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "/thing?does=stuff", response.web_url
+      assert_equal "/thing?does=stuff", response['web_url']
     end
 
     it "should handle fragments" do
@@ -170,7 +170,7 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "/thing#part-2", response.web_url
+      assert_equal "/thing#part-2", response['web_url']
     end
 
     it "should keep URLs from other domains absolute" do
@@ -179,7 +179,7 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "https://www.example.com/example", response.web_url
+      assert_equal "https://www.example.com/example", response['web_url']
     end
 
     it "should keep URLs with other schemes absolute" do
@@ -188,7 +188,7 @@ describe GdsApi::Response do
       }.to_json
 
       response = build_response(body)
-      assert_equal "http://www.example.com/example", response.web_url
+      assert_equal "http://www.example.com/example", response['web_url']
     end
   end
 
@@ -238,36 +238,65 @@ describe GdsApi::Response do
       end
     end
 
+    # TODO: When we remove `GdsApi.config.hash_response_for_requests`, this
+    # describe block no longer makes sense and it should be removed.
     describe "behaving like a read-only openstruct" do
+      def with_hash_response_for_requests_disabled
+        @old_hash_response_for_requests = GdsApi.config.hash_response_for_requests
+        GdsApi.configure do |config|
+          config.hash_response_for_requests = false
+        end
+
+        yield
+
+        GdsApi.configure do |config|
+          config.hash_response_for_requests = @old_hash_response_for_requests
+        end
+      end
+
       it "should allow accessing members using methods" do
-        assert_equal "VAT rates", @response.title
+        with_hash_response_for_requests_disabled do
+          assert_equal "VAT rates", @response.title
+        end
       end
 
       it "should allow accessing nested values" do
-        assert_equal "1870", @response.details.need_id
+        with_hash_response_for_requests_disabled do
+          assert_equal "1870", @response.details.need_id
+        end
       end
 
       it "should allow accessing values nested within arrays" do
-        assert_equal "bar", @response.tags[1].slug
+        with_hash_response_for_requests_disabled do
+          assert_equal "bar", @response.tags[1].slug
+        end
       end
 
       it "should return nil for a non-existent key" do
-        assert_equal nil, @response.foo
+        with_hash_response_for_requests_disabled do
+          assert_equal nil, @response.foo
+        end
       end
 
       it "should memoize the generated openstruct" do
-        @response.id
-        GdsApi::Response.expects(:build_ostruct_recursively).never
-        assert_equal "VAT rates", @response.title
+        with_hash_response_for_requests_disabled do
+          @response.id
+          GdsApi::Response.expects(:build_ostruct_recursively).never
+          assert_equal "VAT rates", @response.title
+        end
       end
 
       describe "handling respond_to?" do
         it "should respond_to methods for keys that exist" do
-          assert @response.respond_to?(:title)
+          with_hash_response_for_requests_disabled do
+            assert @response.respond_to?(:title)
+          end
         end
 
         it "should not respond_to keys that don't exist" do
-          assert ! @response.respond_to?(:foo)
+          with_hash_response_for_requests_disabled do
+            assert ! @response.respond_to?(:foo)
+          end
         end
       end
     end

data/test/router_test.rb

@@ -17,17 +17,18 @@ describe GdsApi::Router do
 
         response = @api.get_backend("foo")
         assert_equal 200, response.code
-        assert_equal "http://foo.example.com/", response.backend_url
+        assert_equal "http://foo.example.com/", response['backend_url']
 
         assert_requested(req)
       end
 
-      it "should return nil for a non-existend backend" do
+      it "raises for a non-existend backend" do
         req = WebMock.stub_request(:get, "#{@base_api_url}/backends/foo").
           to_return(:status => 404)
 
-        response = @api.get_backend("foo")
-        assert_nil response
+        assert_raises(GdsApi::HTTPNotFound) do
+          @api.get_backend("foo")
+        end
 
         assert_requested(req)
       end
@@ -36,8 +37,9 @@ describe GdsApi::Router do
         req = WebMock.stub_request(:get, "#{@base_api_url}/backends/foo+bar").
           to_return(:status => 404)
 
-        response = @api.get_backend("foo bar")
-        assert_nil response
+        assert_raises(GdsApi::HTTPNotFound) do
+          @api.get_backend("foo bar")
+        end
 
         assert_requested(req)
       end
@@ -52,7 +54,7 @@ describe GdsApi::Router do
 
         response = @api.add_backend("foo", "http://foo.example.com/")
         assert_equal 201, response.code
-        assert_equal "http://foo.example.com/", response.backend_url
+        assert_equal "http://foo.example.com/", response['backend_url']
 
         assert_requested(req)
       end
@@ -100,7 +102,7 @@ describe GdsApi::Router do
 
         response = @api.delete_backend("foo")
         assert_equal 200, response.code
-        assert_equal "http://foo.example.com/", response.backend_url
+        assert_equal "http://foo.example.com/", response['backend_url']
 
         assert_requested(req)
       end
@@ -154,19 +156,20 @@ describe GdsApi::Router do
 
         response = @api.get_route("/foo")
         assert_equal 200, response.code
-        assert_equal "foo", response.backend_id
+        assert_equal "foo", response['backend_id']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
       end
 
-      it "should return nil if nothing found" do
+      it "should raise if nothing found" do
         req = WebMock.stub_request(:get, "#{@base_api_url}/routes").
           with(:query => {"incoming_path" => "/foo"}).
           to_return(:status => 404)
 
-        response = @api.get_route("/foo")
-        assert_nil response
+        assert_raises(GdsApi::HTTPNotFound) do
+          @api.get_route("/foo")
+        end
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -179,8 +182,9 @@ describe GdsApi::Router do
           with(:query => {"incoming_path" => "/foo bar"}).
           to_return(:status => 404)
 
-        response = @api.get_route("/foo bar")
-        assert_nil response
+        assert_raises(GdsApi::HTTPNotFound) do
+          @api.get_route("/foo bar")
+        end
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -196,7 +200,7 @@ describe GdsApi::Router do
 
         response = @api.add_route("/foo", "exact", "foo")
         assert_equal 201, response.code
-        assert_equal "foo", response.backend_id
+        assert_equal "foo", response['backend_id']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -246,7 +250,7 @@ describe GdsApi::Router do
 
         response = @api.add_redirect_route("/foo", "exact", "/bar")
         assert_equal 201, response.code
-        assert_equal "/bar", response.redirect_to
+        assert_equal "/bar", response['redirect_to']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -261,7 +265,7 @@ describe GdsApi::Router do
 
         response = @api.add_redirect_route("/foo", "exact", "/bar", "temporary")
         assert_equal 201, response.code
-        assert_equal "/bar", response.redirect_to
+        assert_equal "/bar", response['redirect_to']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -276,7 +280,7 @@ describe GdsApi::Router do
 
         response = @api.add_redirect_route("/foo", "exact", "/bar", "temporary", :segments_mode => "preserve")
         assert_equal 201, response.code
-        assert_equal "/bar", response.redirect_to
+        assert_equal "/bar", response['redirect_to']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -326,7 +330,7 @@ describe GdsApi::Router do
 
         response = @api.add_gone_route("/foo", "exact")
         assert_equal 201, response.code
-        assert_equal "/foo", response.incoming_path
+        assert_equal "/foo", response['incoming_path']
 
         assert_requested(req)
         assert_not_requested(@commit_req)
@@ -375,7 +379,7 @@ describe GdsApi::Router do
 
         response = @api.delete_route("/foo")
         assert_equal 200, response.code
-        assert_equal "foo", response.backend_id
+        assert_equal "foo", response['backend_id']
 
         assert_requested(req)
         assert_not_requested(@commit_req)

data/test/rummager_helpers_test.rb

@@ -15,6 +15,6 @@ class RummagerHelpersTest < Minitest::Test
     response = rummager_has_no_services_and_info_data_for_organisation
 
     assert_instance_of GdsApi::Response, response
-    assert_equal 0, response.facets.specialist_sectors.total_options
+    assert_equal 0, response['facets']['specialist_sectors']['total_options']
   end
 end

data/test/worldwide_api_test.rb

@@ -16,8 +16,8 @@ describe GdsApi::Worldwide do
       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
+      assert_equal country_slugs, response.map { |r| r['details']['slug'] }
+      assert_equal "Rohan", response['results'][2]['title']
     end
 
     it "should handle the pagination" do
@@ -25,7 +25,10 @@ describe GdsApi::Worldwide do
       worldwide_api_has_locations(country_slugs)
 
       response = @api.world_locations
-      assert_equal country_slugs, response.with_subsequent_pages.map {|r| r.details.slug }
+      assert_equal(
+        country_slugs,
+        response.with_subsequent_pages.map { |r| r['details']['slug'] }
+      )
     end
 
     it "should raise error if endpoint 404s" do
@@ -41,13 +44,15 @@ describe GdsApi::Worldwide do
       worldwide_api_has_location('rohan')
 
       response = @api.world_location('rohan')
-      assert_equal 'Rohan', response.title
+      assert_equal 'Rohan', response['title']
     end
 
-    it "should return nil for a non-existent location" do
+    it "raises for a non-existent location" do
       worldwide_api_does_not_have_location('non-existent')
 
-      assert_nil @api.world_location('non-existent')
+      assert_raises(GdsApi::HTTPNotFound) do
+        @api.world_location('non-existent')
+      end
     end
   end
 
@@ -58,7 +63,13 @@ describe GdsApi::Worldwide do
 
       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)
+      assert_equal(
+        [
+          "UK Trade & Investment Australia",
+          "British High Commission Canberra"
+        ],
+        response.map { |item| item['title'] }
+      )
     end
 
     it "should raise error on 404" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 36.4.1
+  version: 37.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -318,6 +318,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
 email:
 - jystewart@gmail.com
@@ -468,7 +482,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs