gds-api-adapters 37.5.1 → 38.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd0e04ee1ee9e50c2462313ec3d6ef71ff0ed84b
-  data.tar.gz: b6f932bf549ea2810a9076d3e4fd24ba72e436f3
+  metadata.gz: 23123cc90f6e6077cdf5a7de6e74d907edc342ff
+  data.tar.gz: ee93d8020f7a0fe4ed2e5423ba74b0aae2fd1ba5
 SHA512:
-  metadata.gz: cb524b8dc79496b41421261d60e2f219813654f07ffb0a470fc8b22c21b21b01f9fdbfafd09cf76ec26df94521dab71cfd0e2025777cd640916066e35828a056
-  data.tar.gz: 787a2686e3065dbb6f83c2814b22234a995fb5684b8f7e7398b1760d9527270d990bb167198c51e00b2482d41a8bee03dfa5be48bddeb2c07053253b57e6bce5
+  metadata.gz: d3c79f7ac64677d81e32ce74c4d902f0c20df897a64d5f707cafb8e4277a65d837cd39423b00b234e521693e56e3bf99ab25279ecf35ab1986c8869314df7faf
+  data.tar.gz: 0366d6b00750732521a469f260bac9323698f7b6d14986c86267e44adbe63a7d7f726728c4c324d14c141b87e8e50f2cc3ac40bb26a1ba7eda9fe803a38b84ef

data/README.md

@@ -16,17 +16,6 @@ Example adapters for frequently used applications:
 - [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
-
-From December 1st, 2016 it won't be possible to use the following configuration
-options:
-
-- `always_raise_for_not_found`
-- `hash_response_for_requests`
-
-Please remove these configuration options from your client application and
-migrate to the new behaviour as soon as possible.
-
 ## Logging
 
 Each HTTP request can be logged as JSON. Example:

data/lib/gds-api-adapters.rb

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

data/lib/gds_api/asset_manager.rb

@@ -1,6 +1,7 @@
 require_relative 'base'
 require_relative 'exceptions'
 
+# @api documented
 class GdsApi::AssetManager < GdsApi::Base
 
   # Creates an asset given a hash with one +file+ attribute

data/lib/gds_api/content_store.rb

@@ -10,20 +10,13 @@ class GdsApi::ContentStore < GdsApi::Base
   end
 
   def content_item(base_path)
-    get_json(content_item_url(base_path))
-  end
-
-  def incoming_links!(base_path, params = {})
-    query = query_string(params)
-    get_json!("#{endpoint}/incoming-links#{base_path}#{query}")
+    get_json!(content_item_url(base_path))
   rescue GdsApi::HTTPNotFound => e
     raise ItemNotFound.build_from(e)
   end
 
-  def content_item!(base_path)
-    get_json!(content_item_url(base_path))
-  rescue GdsApi::HTTPNotFound => e
-    raise ItemNotFound.build_from(e)
+  def content_item!(_)
+    raise "`ContentStore#content_item!` is deprecated. Use `ContentStore#content_item` instead"
   end
 
   private

data/lib/gds_api/email_alert_api.rb

@@ -4,6 +4,7 @@ require_relative 'exceptions'
 # Adapter for the Email Alert API
 #
 # @see https://github.com/alphagov/email-alert-api
+# @api documented
 class GdsApi::EmailAlertApi < GdsApi::Base
 
   # Get or Post subscriber list

data/lib/gds_api/helpers.rb

@@ -6,7 +6,6 @@ require 'gds_api/imminence'
 require 'gds_api/licence_application'
 require 'gds_api/need_api'
 require 'gds_api/panopticon'
-require 'gds_api/publisher'
 require 'gds_api/worldwide'
 require 'gds_api/email_alert_api'
 
@@ -28,10 +27,6 @@ module GdsApi
       @content_store ||= GdsApi::ContentStore.new(Plek.current.find("content-store"), options)
     end
 
-    def publisher_api(options = {})
-      @api ||= GdsApi::Publisher.new(Plek.current.find("publisher"), options)
-    end
-
     def imminence_api(options = {})
       @imminence_api ||= GdsApi::Imminence.new(Plek.current.find("imminence"), options)
     end
@@ -62,7 +57,7 @@ module GdsApi
 
     def self.included(klass)
       if klass.respond_to?(:helper_method)
-        klass.helper_method :publisher_api, :panopticon_api, :imminence_api, :content_api, :licence_application_api
+        klass.helper_method :panopticon_api, :imminence_api, :content_api, :licence_application_api
       end
     end
   end

data/lib/gds_api/json_client.rb

@@ -1,4 +1,3 @@
-require_relative 'config'
 require_relative 'response'
 require_relative 'exceptions'
 require_relative 'version'
@@ -75,13 +74,7 @@ module GdsApi
     end
 
     def get_raw(url)
-      if GdsApi.config.always_raise_for_not_found
-        get_raw!(url)
-      else
-        ignoring_missing do
-          get_raw!(url)
-        end
-      end
+      get_raw!(url)
     end
 
     # Define "safe" methods for each supported HTTP method
@@ -92,13 +85,7 @@ module GdsApi
     [:get, :post, :put, :patch, :delete].each do |http_method|
       method_name = "#{http_method}_json"
       define_method method_name do |url, *args, &block|
-        if GdsApi.config.always_raise_for_not_found
-          send (method_name + "!"), url, *args, &block
-        else
-          ignoring_missing do
-            send (method_name + "!"), url, *args, &block
-          end
-        end
+        send (method_name + "!"), url, *args, &block
       end
     end
 

data/lib/gds_api/list_response.rb

@@ -26,11 +26,7 @@ module GdsApi
       # support group_by results from the content api by checking if there is a
       # grouped_results key present first. if it's not, then fallback to the
       # results key
-      if GdsApi.config.hash_response_for_requests
-        to_hash["grouped_results"] || to_hash["results"]
-      else
-        to_ostruct.grouped_results || to_ostruct.results
-      end
+      to_hash["grouped_results"] || to_hash["results"]
     end
 
     def has_next_page?

data/lib/gds_api/need_api.rb

@@ -8,6 +8,10 @@ class GdsApi::NeedApi < GdsApi::Base
     get_list!("#{endpoint}/needs#{query}")
   end
 
+  def content_id(need_id)
+    get_raw("#{endpoint}/needs/#{CGI.escape(need_id.to_s)}/content_id")
+  end
+
   def needs_by_id(*ids)
     ids_string = ids.flatten.map(&:to_i).sort.join(',')
     query = query_string(ids: ids_string)

data/lib/gds_api/publishing_api.rb

@@ -3,14 +3,6 @@ require_relative 'exceptions'
 
 class GdsApi::PublishingApi < GdsApi::Base
 
-  def put_draft_content_item(base_path, payload)
-    put_json!(draft_content_item_url(base_path), payload)
-  end
-
-  def put_content_item(base_path, payload)
-    put_json!(content_item_url(base_path), payload)
-  end
-
   def put_intent(base_path, payload)
     put_json!(intent_url(base_path), payload)
   end
@@ -25,17 +17,8 @@ class GdsApi::PublishingApi < GdsApi::Base
     put_json!(paths_url(base_path), payload)
   end
 
-
   private
 
-  def draft_content_item_url(base_path)
-    "#{endpoint}/draft-content#{base_path}"
-  end
-
-  def content_item_url(base_path)
-    "#{endpoint}/content#{base_path}"
-  end
-
   def intent_url(base_path)
     "#{endpoint}/publish-intent#{base_path}"
   end

data/lib/gds_api/publishing_api_v2.rb

@@ -5,6 +5,7 @@ require_relative 'base'
 # @see https://github.com/alphagov/publishing-api
 # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-application-examples.md
 # @see https://github.com/alphagov/publishing-api/blob/master/doc/model.md
+# @api documented
 class GdsApi::PublishingApiV2 < GdsApi::Base
   # Put a content item
   #
@@ -18,32 +19,23 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
 
   # Return a content item
   #
-  # Returns nil if the content item doesn't exist.
+  # Raises exception if the item doesn't exist.
   #
   # @param content_id [UUID]
   # @param params [Hash]
   # @option params [String] locale The language, defaults to 'en' in publishing-api.
   #
   # @return [GdsApi::Response] a content item
+  #
+  # @raise [HTTPNotFound] when the content item is not found
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2contentcontent_id
   def get_content(content_id, params = {})
     get_json(content_url(content_id, params))
   end
 
-  # Return a content item
-  #
-  # Raises exception if the item doesn't exist.
-  #
-  # @param content_id [UUID]
-  # @param params [Hash]
-  # @option params [String] locale The language, defaults to 'en' in publishing-api.
-  #
-  # @return [GdsApi::Response] a content item
-  #
-  # @raise [HTTPNotFound] when the content item is not found
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2contentcontent_id
-  def get_content!(content_id, params = {})
-    get_json!(content_url(content_id, params))
+  # @private
+  def get_content!(*)
+    raise "`PublishingApiV2#delete_content!` is deprecated. Use `PublishingApiV2#delete_content`"
   end
 
   # Find the content_ids for a list of base_paths.
@@ -88,8 +80,8 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #
   # @param content_id [UUID]
   # @param update_type [String] Either 'major', 'minor' or 'republish'
-  # @param params [Hash]
-  # @option params [String] locale The language, defaults to 'en' in publishing-api.
+  # @param options [Hash]
+  # @option options [String] locale The language, defaults to 'en' in publishing-api.
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idpublish
   def publish(content_id, update_type, options = {})
@@ -142,9 +134,9 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #
   # Deletes the draft content item.
   #
-  # @param params [Hash]
-  # @option params [String] locale The language, defaults to 'en' in publishing-api.
-  # @option params [Integer] previous_version used to ensure the request is discarding the latest lock version of the draft
+  # @param options [Hash]
+  # @option options [String] locale The language, defaults to 'en' in publishing-api.
+  # @option options [Integer] previous_version used to ensure the request is discarding the latest lock version of the draft
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_iddiscard-draft
   def discard_draft(content_id, options = {})

data/lib/gds_api/response.rb

@@ -78,21 +78,6 @@ module GdsApi
       @parsed_content ||= transform_parsed(JSON.parse(@http_response.body))
     end
 
-    def to_ostruct
-      raise NoMethodError if GdsApi.config.hash_response_for_requests
-      @ostruct ||= self.class.build_ostruct_recursively(parsed_content)
-    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
-
     def present?; true; end
     def blank?; false; end
 
@@ -123,16 +108,5 @@ module GdsApi
         value
       end
     end
-
-    def self.build_ostruct_recursively(value)
-      case value
-      when Hash
-        OpenStruct.new(Hash[value.map { |k, v| [k, build_ostruct_recursively(v)] }])
-      when Array
-        value.map { |v| build_ostruct_recursively(v) }
-      else
-        value
-      end
-    end
   end
 end

data/lib/gds_api/rummager.rb

@@ -2,11 +2,12 @@ require 'gds_api/base'
 require 'rack/utils'
 
 module GdsApi
+  # @api documented
   class Rummager < Base
 
     # Perform a search.
     #
-    # @param query [Hash] A valid search query. See Rummager documentation for options.
+    # @param args [Hash] A valid search query. See Rummager documentation for options.
     #
     # @see https://github.com/alphagov/rummager/blob/master/docs/search-api.md
     def search(args)
@@ -49,11 +50,16 @@ module GdsApi
     #
     # @param base_path Base path of the page on GOV.UK.
     # @see https://github.com/alphagov/rummager/blob/master/docs/content-api.md
-    def delete_content!(base_path)
+    def delete_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
       delete_json!(request_url)
     end
 
+    # @private
+    def delete_content!(*)
+      raise "`Rummager#delete_content!` is deprecated. Use `Rummager#delete_content`"
+    end
+
     # Retrieve a content-document from the index.
     #
     # Content documents are pages on GOV.UK that have a base path and are
@@ -62,11 +68,16 @@ module GdsApi
     #
     # @param base_path [String] Base path of the page on GOV.UK.
     # @see https://github.com/alphagov/rummager/blob/master/docs/content-api.md
-    def get_content!(base_path)
+    def get_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
       get_json!(request_url)
     end
 
+    # @private
+    def get_content!(*)
+      raise "`Rummager#get_content!` is deprecated. Use `Rummager#get_content`"
+    end
+
     # Delete a non-content document from the search index.
     #
     # For example, best bets, recommended links, or contacts.

data/lib/gds_api/support_api.rb

@@ -1,5 +1,6 @@
 require_relative 'base'
 
+# @api documented
 class GdsApi::SupportApi < GdsApi::Base
   def create_problem_report(request_details)
     post_json!("#{endpoint}/anonymous-feedback/problem-reports", { :problem_report => request_details })

data/lib/gds_api/test_helpers/need_api.rb

@@ -68,6 +68,13 @@ module GdsApi
         stub_request(:get, url).to_return(status: 200, body: need.to_json, headers: {})
       end
 
+      def need_api_has_content_id_for_need(need)
+        need_id = need["id"] || need[:id]
+
+        url = NEED_API_ENDPOINT + "/needs/#{need_id}/content_id"
+        stub_request(:get, url).to_return(body: need[:content_id])
+      end
+
       def need_api_has_raw_response_for_page(response, page = nil)
         url = NEED_API_ENDPOINT + "/needs"
         url << "?page=#{page}" unless page.nil?

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -11,15 +11,6 @@ module GdsApi
 
       PUBLISHING_API_ENDPOINT = Plek.current.find('publishing-api')
 
-      def stub_publishing_api_put_draft_item(base_path, body = content_item_for_publishing_api(base_path))
-        stub_publishing_api_put_item(base_path, body, '/draft-content')
-      end
-
-      def stub_publishing_api_put_item(base_path, body = content_item_for_publishing_api(base_path), resource_path = '/content')
-        url = PUBLISHING_API_ENDPOINT + resource_path + base_path
-        stub_request(:put, url).with(body: body).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
-      end
-
       def stub_publishing_api_put_intent(base_path, body = intent_for_publishing_api(base_path))
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
         body = body.to_json unless body.is_a?(String)
@@ -31,28 +22,10 @@ module GdsApi
         stub_request(:delete, url).to_return(status: 200, body: '{}', headers: {"Content-Type" => "application/json; charset=utf-8"})
       end
 
-      def stub_default_publishing_api_put()
-        stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/content})
-      end
-
-      def stub_default_publishing_api_put_draft()
-        stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/draft-content})
-      end
-
       def stub_default_publishing_api_put_intent()
         stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/publish-intent})
       end
 
-      def assert_publishing_api_put_item(base_path, attributes_or_matcher = {}, times = 1)
-        url = PUBLISHING_API_ENDPOINT + "/content" + base_path
-        assert_publishing_api_put(url, attributes_or_matcher, times)
-      end
-
-      def assert_publishing_api_put_draft_item(base_path, attributes_or_matcher = {}, times = 1)
-        url = PUBLISHING_API_ENDPOINT + "/draft-content" + base_path
-        assert_publishing_api_put(url, attributes_or_matcher, times)
-      end
-
       def assert_publishing_api_put_intent(base_path, attributes_or_matcher = {}, times = 1)
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
         assert_publishing_api_put(url, attributes_or_matcher, times)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '37.5.1'.freeze
+  VERSION = '38.0.0'.freeze
 end

data/test/content_store_test.rb

@@ -52,47 +52,4 @@ describe GdsApi::ContentStore do
       end
     end
   end
-
-  describe "#content_item!" do
-    it "returns the item" do
-      base_path = "/test-from-content-store"
-      content_store_has_item(base_path)
-
-      response = @api.content_item!(base_path)
-
-      assert_equal base_path, response["base_path"]
-    end
-
-    it "raises if the item doesn't exist" do
-      content_store_does_not_have_item("/non-existent")
-
-      e = assert_raises GdsApi::ContentStore::ItemNotFound do
-        @api.content_item!("/non-existent")
-      end
-
-      assert_equal 404, e.code
-      assert_equal "URL: #{@base_api_url}/content/non-existent\nResponse body:\n\n\nRequest body:", e.message.strip
-    end
-  end
-
-  describe "#incoming_links!" do
-    it "returns the item" do
-      base_path = "/test-from-content-store?types%5B%5D=a&types%5B%5D=b"
-      content_store_has_incoming_links(base_path, [ { title: "Yolo" }])
-
-      response = @api.incoming_links!('/test-from-content-store', types: [:a, :b])
-
-      assert_equal [ { "title" => "Yolo" } ], response.to_hash
-    end
-
-    it "raises if the item doesn't exist" do
-      content_store_does_not_have_item("/non-existent")
-
-      e = assert_raises GdsApi::ContentStore::ItemNotFound do
-        response = @api.incoming_links!("/non-existent")
-      end
-
-      assert_equal 404, e.code
-    end
-  end
 end