gds-api-adapters 33.2.0 → 33.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3557af538323da5b11bc0f7cab83c990838837ed
-  data.tar.gz: ce61e653825ad488bedf28631ac9b830eaaf6c00
+  metadata.gz: 1e954f66e624097dd778d14c8a52ce96df46b0f9
+  data.tar.gz: 0bec295878dca719388c0ff348a4cb752d7e39af
 SHA512:
-  metadata.gz: f579fa8cfdfdaf6d8fd0b8fb2e9c19d03baa958dbe662d2e04de15cf0469e89e08a010f70205b15219bfc84038dca5660a811ecaa620ed935043aa6a53598268
-  data.tar.gz: dc15adf200f8b9c77b738982fa87ed0ac6a8d0d7d5c5a97235bd35b6fcdb099b2daf92f2f27260cdb0131e84b4711ae8552f0ba6aa918ef59c81b043225db0be
+  metadata.gz: b4b22bfd35db7e5503f19885f7ec64f618c041ecf049b07a59c01ef16bc82d84828d6381699fe851012a1e1121519e6272c6f945ec6383aee99515b0d15651fe
+  data.tar.gz: bb98daf58ed027d1dabfc7fb7395acbd729f4ab6bddb13414fc20c558dca184e60296d8d0e44a07cdd166992845af02781a37b01aea60d310474ea5b8f8d8ea1

data/README.md

@@ -12,9 +12,9 @@ results = rummager.unified_search(q: "taxes")
 
 Example adapters for frequently used applications:
 
-- [Publishing API](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/PublishingApiV2), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/publishing_api_v2.rb), [test helper docs](http://www.rubydoc.info/github/alphagov/gds-api-adapters/master/GdsApi/TestHelpers/PublishingApiV2))
-- [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))
+- [Publishing API](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/PublishingApiV2), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/publishing_api_v2.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/PublishingApiV2))
+- [Content Store](lib/gds_api/content_store.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/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/gems/gds-api-adapters/GdsApi/TestHelpers/ContentStore))
+- [Rummager](lib/gds_api/rummager.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/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/gems/gds-api-adapters/GdsApi/TestHelpers/Rummager))
 
 ## Configuration
 

data/lib/gds_api/base.rb

@@ -22,7 +22,7 @@ class GdsApi::Base
                           :post_json, :post_json!,
                           :put_json, :put_json!,
                           :patch_json, :patch_json!,
-                          :delete_json, :delete_json!,
+                          :delete_json, :delete_json!, :delete_json_with_params!,
                           :get_raw, :get_raw!,
                           :put_multipart,
                           :post_multipart

data/lib/gds_api/json_client.rb

@@ -54,12 +54,17 @@ module GdsApi
     def self.default_request_headers
       {
         'Accept' => 'application/json',
-        'Content-Type' => 'application/json',
         # GOVUK_APP_NAME is set for all apps by Puppet
         'User-Agent' => "gds-api-adapters/#{GdsApi::VERSION} (#{ENV["GOVUK_APP_NAME"]})"
       }
     end
 
+    def self.default_request_with_json_body_headers
+      self.default_request_headers.merge(
+        'Content-Type' => 'application/json',
+      )
+    end
+
     DEFAULT_TIMEOUT_IN_SECONDS = 4
     DEFAULT_CACHE_SIZE = 100
     DEFAULT_CACHE_TTL = 15 * 60 # 15 minutes
@@ -69,8 +74,22 @@ module GdsApi
     end
 
     def get_raw(url)
-      ignoring_missing do
+      if GdsApi.config.always_raise_for_not_found
         get_raw!(url)
+      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
+          get_raw!(url)
+        end
       end
     end
 
@@ -118,7 +137,19 @@ module GdsApi
       do_json_request(:patch, url, params, additional_headers)
     end
 
-    def delete_json!(url, params = nil, additional_headers = {})
+    def delete_json!(url, additional_headers = {})
+      do_json_request(:delete, url, nil, additional_headers)
+    end
+
+    def delete_json_with_params!(url, params, additional_headers = {})
+      warn <<-doc
+        DEPRECATION NOTICE: Delete requests should not include parameters.
+
+        Do not use this method as the ability to do this will be removed.
+
+        Called from: #{caller[2]}
+      doc
+
       do_json_request(:delete, url, params, additional_headers)
     end
 
@@ -195,10 +226,12 @@ module GdsApi
       )
     end
 
-    def with_headers(method_params, headers)
-      headers = headers.merge(GdsApi::GovukHeaders.headers)
+    def with_headers(method_params, default_headers, additional_headers)
       method_params.merge(
-        headers: method_params[:headers].merge(headers)
+        headers: default_headers
+          .merge(method_params[:headers] || {})
+          .merge(GdsApi::GovukHeaders.headers)
+          .merge(additional_headers)
       )
     end
 
@@ -256,12 +289,19 @@ module GdsApi
       method_params = {
         method: method,
         url: url,
-        headers: self.class.default_request_headers
       }
+
+      case method
+      when :get, :delete
+        default_headers = self.class.default_request_headers
+      else
+        default_headers = self.class.default_request_with_json_body_headers
+      end
+
       method_params[:payload] = params
-      method_params = with_auth_options(method_params)
       method_params = with_timeout(method_params)
-      method_params = with_headers(method_params, additional_headers)
+      method_params = with_headers(method_params, default_headers, additional_headers)
+      method_params = with_auth_options(method_params)
       if URI.parse(url).is_a? URI::HTTPS
         method_params = with_ssl_options(method_params)
       end

data/lib/gds_api/need_api.rb

@@ -42,7 +42,8 @@ class GdsApi::NeedApi < GdsApi::Base
 
   def reopen(need_id, author)
     # author params: { "author" => { ... } }"
-    delete_json!("#{endpoint}/needs/#{CGI.escape(need_id.to_s)}/closed", author)
+    # NB: This should really be a POST
+    delete_json_with_params!("#{endpoint}/needs/#{CGI.escape(need_id.to_s)}/closed", author)
   end
 
   def create_note(note)

data/lib/gds_api/publisher.rb

@@ -2,10 +2,6 @@ require_relative 'base'
 require_relative 'part_methods'
 
 class GdsApi::Publisher < GdsApi::Base
-  def reindex_topic_editions(slug)
-    post_json!("#{endpoint}/api/reindex-topic-editions/#{slug}")
-  end
-
   def publication_for_slug(slug, options = {})
     return nil if slug.nil? or slug == ''
 

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '33.2.0'
+  VERSION = '33.2.1'
 end

data/test/json_client_test.rb

@@ -15,6 +15,8 @@ class JsonClientTest < MiniTest::Spec
     GdsApi::JsonClient.cache = nil
 
     @client = GdsApi::JsonClient.new
+
+    WebMock.disable_net_connect!
   end
 
   def teardown
@@ -382,16 +384,124 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
-  def test_get_should_be_nil_if_404_returned_from_endpoint
+  def test_get_should_be_nil_if_404_returned_from_endpoint_and_always_raise_for_not_found_is_disabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = false
+    end
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_return(:body => "{}", :status => 404)
     assert_nil @client.get_json(url)
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
   end
 
-  def test_get_should_be_nil_if_410_returned_from_endpoint
+  def test_get_should_be_nil_if_410_returned_from_endpoint_and_always_raise_for_not_found_is_disabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = false
+    end
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_return(:body => "{}", :status => 410)
     assert_nil @client.get_json(url)
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_should_be_nil_if_404_returned_from_endpoint_and_always_raise_for_not_found_is_enabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = true
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 404)
+    assert_raises GdsApi::HTTPNotFound do
+      @client.get_json(url)
+    end
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_should_be_nil_if_410_returned_from_endpoint_and_always_raise_for_not_found_is_enabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = true
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 410)
+    assert_raises GdsApi::HTTPGone do
+      @client.get_json(url)
+    end
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_raw_should_be_nil_if_404_returned_from_endpoint_and_always_raise_for_not_found_is_disabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = false
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 404)
+    assert_nil @client.get_raw(url)
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_raw_should_be_nil_if_410_returned_from_endpoint_and_always_raise_for_not_found_is_disabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = false
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 410)
+    assert_nil @client.get_raw(url)
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_raw_should_be_nil_if_404_returned_from_endpoint_and_always_raise_for_not_found_is_enabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = true
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 404)
+    assert_raises GdsApi::HTTPNotFound do
+      @client.get_raw(url)
+    end
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
+  end
+
+  def test_get_raw_should_be_nil_if_410_returned_from_endpoint_and_always_raise_for_not_found_is_enabled
+    @old_always_raise = GdsApi.config.always_raise_for_not_found
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = true
+    end
+    url = "http://some.endpoint/some.json"
+    stub_request(:get, url).to_return(:body => "{}", :status => 410)
+    assert_raises GdsApi::HTTPGone do
+      @client.get_raw(url)
+    end
+  ensure
+    GdsApi.configure do |config|
+      config.always_raise_for_not_found = @old_always_raise
+    end
   end
 
   def test_get_should_raise_error_if_non_404_non_410_error_code_returned_from_endpoint
@@ -402,7 +512,7 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
-  def test_get_should_raise_conflict_for_410
+  def test_get_should_raise_conflict_for_409
     url = "http://some.endpoint/some.json"
     stub_request(:delete, url).to_return(:body => "{}", :status => 409)
     assert_raises GdsApi::HTTPConflict do
@@ -662,7 +772,7 @@ class JsonClientTest < MiniTest::Spec
 
   def test_client_can_use_bearer_token
     client = GdsApi::JsonClient.new(bearer_token: 'SOME_BEARER_TOKEN')
-    expected_headers = GdsApi::JsonClient.default_request_headers.
+    expected_headers = GdsApi::JsonClient.default_request_with_json_body_headers.
       merge('Authorization' => 'Bearer SOME_BEARER_TOKEN')
 
     stub_request(:put, "http://some.other.endpoint/some.json").
@@ -712,7 +822,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_set_custom_headers_on_deletes
     stub_request(:delete, "http://some.other.endpoint/some.json").to_return(:status => 200)
 
-    response = GdsApi::JsonClient.new.delete_json("http://some.other.endpoint/some.json", {},
+    response = GdsApi::JsonClient.new.delete_json("http://some.other.endpoint/some.json",
                                                   { "HEADER-A" => "B", "HEADER-C" => "D" })
 
     assert_requested(:delete, %r{/some.json}) do |request|
@@ -862,4 +972,21 @@ class JsonClientTest < MiniTest::Spec
     client = GdsApi::JsonClient.new(logger: custom_logger)
     assert_same client.logger, custom_logger
   end
+
+  def test_should_avoid_content_type_header_on_get_without_body
+    url = "http://some.endpoint/some.json"
+    stub_request(:any, url)
+
+    @client.get_json!(url)
+    assert_requested(:get, url, headers: GdsApi::JsonClient.default_request_headers)
+
+    @client.delete_json!(url)
+    assert_requested(:delete, url, headers: GdsApi::JsonClient.default_request_headers)
+
+    @client.post_json!(url, test: "123")
+    assert_requested(:post, url, headers: GdsApi::JsonClient.default_request_with_json_body_headers)
+
+    @client.put_json!(url, test: "123")
+    assert_requested(:put, url, headers: GdsApi::JsonClient.default_request_with_json_body_headers)
+  end
 end

data/test/publisher_api_test.rb

@@ -106,13 +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 "#reindex_topic_editions(slug)" do
-    it "posts to the reindex URL" do
-      api.expects(:post_json!)
-        .with("#{PUBLISHER_ENDPOINT}/api/reindex-topic-editions/oil-and-gas/licensing")
-
-      api.reindex_topic_editions("oil-and-gas/licensing")
-    end
-  end
 end

data/test/publishing_api_v2_test.rb

@@ -1121,9 +1121,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/linkables",
           query: "document_type=topic",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1150,9 +1148,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=title&fields%5B%5D=base_path",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1196,9 +1192,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1240,9 +1234,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale&locale=fr",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1284,9 +1276,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale&locale=all",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1333,9 +1323,7 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=details",
-          headers: {
-            "Content-Type" => "application/json",
-          },
+          headers: {},
         )
         .will_respond_with(
           status: 200,
@@ -1509,9 +1497,7 @@ describe GdsApi::PublishingApiV2 do
             method: :get,
             path: "/v2/linked/" + @linked_content_item['content_id'],
             query: "fields%5B%5D=content_id&fields%5B%5D=base_path&link_type=topic",
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: {},
           )
           .will_respond_with(
             status: 200,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 33.2.0
+  version: 33.2.1
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-12 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -397,7 +397,6 @@ files:
 - lib/gds_api/test_helpers/whitehall_admin_api.rb
 - lib/gds_api/test_helpers/worldwide.rb
 - lib/gds_api/version.rb
-- lib/gds_api/whitehall_admin_api.rb
 - lib/gds_api/worldwide.rb
 - test/asset_manager_test.rb
 - test/business_support_api_test.rb
@@ -449,7 +448,6 @@ files:
 - test/test_helpers/panopticon_test.rb
 - test/test_helpers/publishing_api_test.rb
 - test/test_helpers/publishing_api_v2_test.rb
-- test/whitehall_admin_api_test.rb
 - test/worldwide_api_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
@@ -526,5 +524,4 @@ test_files:
 - test/publishing_api_v2_test.rb
 - test/rummager_test.rb
 - test/mapit_test.rb
-- test/whitehall_admin_api_test.rb
 has_rdoc: 

data/lib/gds_api/whitehall_admin_api.rb

@@ -1,13 +0,0 @@
-require_relative 'base'
-
-class GdsApi::WhitehallAdminApi < GdsApi::Base
-  def reindex_specialist_sector_editions(slug)
-    post_json!("#{endpoint}/reindex-specialist-sector-editions/#{slug}")
-  end
-
-private
-
-  def endpoint
-    "#{super}/government/admin/api"
-  end
-end

data/test/whitehall_admin_api_test.rb

@@ -1,18 +0,0 @@
-require 'test_helper'
-require 'gds_api/whitehall_admin_api'
-
-describe GdsApi::WhitehallAdminApi do
-
-  before do
-    @api = GdsApi::WhitehallAdminApi.new("http://whitehall-admin.example.com")
-  end
-
-  describe "#reindex_specialist_sector_editions(slug)" do
-    it "posts to the reindex URL" do
-      @api.expects(:post_json!)
-        .with("http://whitehall-admin.example.com/government/admin/api/reindex-specialist-sector-editions/oil-and-gas/licensing")
-
-      @api.reindex_specialist_sector_editions("oil-and-gas/licensing")
-    end
-  end
-end