gds-api-adapters 32.2.1 → 32.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffef8739d56c013b7ddc653f8d1626407623ec50
-  data.tar.gz: 7675818d84eb277c3792bfb9e8b544932c77e71e
+  metadata.gz: 9aeead33f16d7971b151925cf306e1cc3777e94f
+  data.tar.gz: 7d34c0f7607e66742bd58749526b11b0c0c62e4b
 SHA512:
-  metadata.gz: 2729d34b9eb08f0ec00fcf82ffcc546661df3fc9314ecb2115f81898294c5a6a48e425507dd21aff1107a2f39343ba05ab5b89f73924950a92eb83328c428993
-  data.tar.gz: bb927139c619e469bfb6deea4bf68b724179bc828f0f8981c8ae2ce66f62ab3dd5c6ad638459b5d2b87c739909e83282fcd6f75ecb9f123066a1585c746f4585
+  metadata.gz: 4e956ff4cf182f461d7f9fcaad9ffd848506193ec3d5f91bd623f5485860969e728f1b00a3b87bb1d4cf810ea20bc0de3696add35d743b9da5ba8d7634c3e8a9
+  data.tar.gz: 5e46864dfc8b5d777abf26592d141c246c031fb3450f9ec775b0e5bd8134ed8cdd47c48dc7d32998b5a474659d4f89b677663f0562d25f3a7060ac96223915f2

data/README.md

@@ -16,6 +16,22 @@ Example adapters for frequently used applications:
 - [Content Store](lib/gds_api/content_store.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/ContentStore), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/content_store.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/ContentStore))
 - [Rummager](lib/gds_api/rummager.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/Rummager), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/rummager.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/Rummager))
 
+## Configuration
+
+We're currently deprecating some behaviour of this gem. You can opt-in to the
+new behaviour now by adding configuration like this:
+
+```ruby
+# config/initializers/gds_api_adapters.rb
+GdsApi.configure do |config|
+  # Never return nil when a server responds with 404 or 410.
+  config.always_raise_for_not_found = true
+
+  # Return a hash, not an OpenStruct from a request.
+  config.hash_response_for_requests = true
+end
+```
+
 ## Logging
 
 Each HTTP request can be logged as JSON. Example:

data/lib/gds-api-adapters.rb

@@ -1,2 +1,3 @@
 require 'gds_api/railtie' if defined?(Rails)
 require 'gds_api/exceptions'
+require 'gds_api/config'

data/lib/gds_api/config.rb

@@ -0,0 +1,29 @@
+module GdsApi
+  def self.configure
+    yield(config)
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  class Config
+    # Always raise a `HTTPNotFound` exception when the server returns 404 or
+    # 410. This avoids nil-errors in your code and makes debugging easier.
+    #
+    # Currently defaults to false.
+    #
+    # This configuration allows some time to upgrade - you should opt-in to this
+    # behaviour now. We'll change this to default to true on October 1st, 2016
+    # and remove the option entirely on December 1st, 2016.
+    attr_accessor :always_raise_for_not_found
+
+    # Set to true to make `GdsApi::Response` behave like a simple hash, instead
+    # of an OpenStruct. This will prevent nil-errors.
+    #
+    # This configuration allows some time to upgrade - you should opt-in to this
+    # behaviour now. We'll change this to default to true on October 1st, 2016
+    # and remove the option entirely on December 1st, 2016.
+    attr_accessor :hash_response_for_requests
+  end
+end

data/lib/gds_api/json_client.rb

@@ -82,8 +82,22 @@ module GdsApi
     [:get, :post, :put, :patch, :delete].each do |http_method|
       method_name = "#{http_method}_json"
       define_method method_name do |url, *args, &block|
-        ignoring_missing do
+        if GdsApi.config.always_raise_for_not_found
           send (method_name + "!"), url, *args, &block
+        else
+          warn <<-doc
+            DEPRECATION NOTICE: You are making requests that will potentially
+            return nil. Please set `GdsApi.config.always_raise_for_not_found = true`
+            to make sure all responses with 404 or 410 raise an exception.
+
+            Raising exceptions will be the default behaviour from October 1st, 2016.
+
+            Called from: #{caller[2]}
+          doc
+
+          ignoring_missing do
+            send (method_name + "!"), url, *args, &block
+          end
         end
       end
     end

data/lib/gds_api/local_links_manager.rb

@@ -6,4 +6,9 @@ class GdsApi::LocalLinksManager < GdsApi::Base
     url += "&lgil=#{lgil}" if lgil
     get_json(url)
   end
+
+  def local_authority(authority_slug)
+    url = "#{endpoint}/api/local-authority?authority_slug=#{authority_slug}"
+    get_json(url)
+  end
 end

data/lib/gds_api/response.rb

@@ -75,14 +75,17 @@ module GdsApi
     end
 
     def to_ostruct
+      raise NoMethodError if GdsApi.config.hash_response_for_requests
       @ostruct ||= self.class.build_ostruct_recursively(to_hash)
     end
 
     def method_missing(method_sym, *arguments, &block)
+      super if GdsApi.config.hash_response_for_requests
       to_ostruct.public_send(method_sym, *arguments, &block)
     end
 
     def respond_to_missing?(method, include_private)
+      super if GdsApi.config.hash_response_for_requests
       to_ostruct.respond_to?(method, include_private)
     end
 

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -108,6 +108,71 @@ module GdsApi
           .with(query: params)
           .to_return(body: {}.to_json, status: 404)
       end
+
+      def local_links_manager_has_a_local_authority(authority_slug)
+        response = {
+          "local_authorities" => [
+            {
+              "name" => authority_slug.capitalize,
+              "homepage_url" => "http://#{authority_slug}.example.com",
+              "tier" => "unitary"
+            }
+          ]
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+          .with(query: {authority_slug: authority_slug})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_has_a_district_and_county_local_authority(district_slug, county_slug)
+        response = {
+          "local_authorities" => [
+            {
+              "name" => district_slug.capitalize,
+              "homepage_url" => "http://#{district_slug}.example.com",
+              "tier" => "district"
+            },
+            {
+              "name" => county_slug.capitalize,
+              "homepage_url" => "http://#{county_slug}.example.com",
+              "tier" => "county"
+            }
+          ]
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+          .with(query: {authority_slug: district_slug})
+          .to_return(body: response.to_json, status: 200)
+      end
+
+      def local_links_manager_request_without_local_authority_slug
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+        .with(query: {authority_slug: ''})
+        .to_return(body: {}.to_json, status: 400)
+      end
+
+      def local_links_manager_does_not_have_an_authority(authority_slug)
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+        .with(query: {authority_slug: authority_slug})
+        .to_return(body: {}.to_json, status: 404)
+      end
+
+      def local_links_manager_has_a_local_authority_without_homepage(authority_slug)
+        response = {
+          "local_authorities" => [
+            {
+              "name" => authority_slug.capitalize,
+              "homepage_url" => "",
+              "tier" => "unitary"
+            }
+          ]
+        }
+
+        stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
+          .with(query: {authority_slug: authority_slug})
+          .to_return(body: response.to_json, status: 200)
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '32.2.1'
+  VERSION = '32.3.0'
 end

data/test/content_store_test.rb

@@ -25,6 +25,22 @@ describe GdsApi::ContentStore do
 
       assert_nil @api.content_item("/non-existent")
     end
+
+    it "raises if the item doesn't exist and `always_raise_for_not_found` enabled" do
+      GdsApi.configure do |config|
+        config.always_raise_for_not_found = true
+      end
+
+      content_store_does_not_have_item("/non-existent")
+
+      assert_raises GdsApi::HTTPNotFound do
+        @api.content_item("/non-existent")
+      end
+
+      GdsApi.configure do |config|
+        config.always_raise_for_not_found = false
+      end
+    end
   end
 
   describe "#content_item!" do

data/test/json_client_test.rb

@@ -608,6 +608,25 @@ class JsonClientTest < MiniTest::Spec
     assert_equal 2, response.a.b
   end
 
+  def test_cant_access_attributes_of_response_directly_if_hash_only
+    url = "http://some.endpoint/some.json"
+    payload = {a: 1}
+    stub_request(:put, url).with(body: payload.to_json).to_return(:body => '{"a":{"b":2}}', :status => 200)
+    response = @client.put_json(url, payload)
+
+    GdsApi.configure do |config|
+      config.hash_response_for_requests = true
+    end
+
+    assert_raises NoMethodError do
+      response.a.b
+    end
+
+    GdsApi.configure do |config|
+      config.hash_response_for_requests = false
+    end
+  end
+
   def test_accessing_non_existent_attribute_of_response_returns_nil
     url = "http://some.endpoint/some.json"
     stub_request(:put, url).to_return(:body => '{"a":1}', :status => 200)

data/test/local_links_manager_api_test.rb

@@ -1,7 +1,6 @@
 require "test_helper"
 require "gds_api/local_links_manager"
 require "gds_api/test_helpers/local_links_manager"
-require 'pry'
 
 describe GdsApi::LocalLinksManager do
   include GdsApi::TestHelpers::LocalLinksManager
@@ -168,4 +167,68 @@ describe GdsApi::LocalLinksManager do
       end
     end
   end
+
+  describe '#local_authority' do
+    describe 'when making a request for a local authority with a parent' do
+      it 'should return the local authority and its parent' do
+        local_links_manager_has_a_district_and_county_local_authority('blackburn', 'rochester')
+
+        expected_response = {
+          "local_authorities" => [
+            {
+              "name" => 'Blackburn',
+              "homepage_url" => "http://blackburn.example.com",
+              "tier" => "district"
+            },
+            {
+              "name" => 'Rochester',
+              "homepage_url" => "http://rochester.example.com",
+              "tier" => "county"
+            }
+          ]
+        }
+
+        response = @api.local_authority('blackburn')
+        assert_equal expected_response, response.to_hash
+      end
+    end
+
+    describe 'when making a request for a local authority without a parent' do
+      it 'should return the local authority' do
+        local_links_manager_has_a_local_authority('blackburn')
+
+        expected_response = {
+          "local_authorities" => [
+            {
+              "name" => 'Blackburn',
+              "homepage_url" => "http://blackburn.example.com",
+              "tier" => "unitary"
+            }
+          ]
+        }
+
+        response = @api.local_authority('blackburn')
+        assert_equal expected_response, response.to_hash
+      end
+    end
+
+    describe 'when making a request without the required parameters' do
+      it "raises HTTPClientError when authority_slug is missing" do
+        local_links_manager_request_without_local_authority_slug
+
+        assert_raises GdsApi::HTTPClientError do
+          @api.local_authority(nil)
+        end
+      end
+    end
+
+    describe 'when making a request with invalid required parameters' do
+      it "returns nil when authority_slug is invalid" do
+        local_links_manager_does_not_have_an_authority("hogwarts")
+
+        response = @api.local_authority("hogwarts")
+        assert_equal nil, response
+      end
+    end
+  end
 end

data/test/test_helper.rb

@@ -13,6 +13,7 @@ require 'simplecov'
 require 'simplecov-rcov'
 require 'mocha/mini_test'
 require 'timecop'
+require 'gds-api-adapters'
 
 SimpleCov.start do
   add_filter "/test/"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 32.2.1
+  version: 32.3.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -331,6 +331,7 @@ files:
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/base.rb
 - lib/gds_api/business_support_api.rb
+- lib/gds_api/config.rb
 - lib/gds_api/content_api.rb
 - lib/gds_api/content_store.rb
 - lib/gds_api/core-ext/openstruct.rb