gds-api-adapters 59.1.0 → 59.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5545c2f65d5f31f2aaf737590b5204ee385ec783ad553d09515ac0b7e3d73929
-  data.tar.gz: 850f74dc5f709157bad18d79308edd76ae3323b8e33d867ebfda9f075eb82b65
+  metadata.gz: ec24c3b59b3cc1db154edf2b009ef223651a1530067b85931e11201f993276c5
+  data.tar.gz: e3b9c3fa2dab1c6741049a91175290b7277c4630bcc958621ac8f47412f35d12
 SHA512:
-  metadata.gz: ce46e8885c9e7b37cffa51ff0a3666270e825ccc073c17659d23d85ed15598f190eb8b016f599aec26275c829062106e3d7500b76f74a0b88bfa194d76568901
-  data.tar.gz: af840ab6b6d7053d2e746bdfe64fc5a00daeba7105d7bbabf771ba54c74e539579cd95d3de2131936d06113063865644f096a858cd4a0ca352e270f9f6791721
+  metadata.gz: cd38630932fd7eee080846734651f34147924e43cbffdf53636e111c9649ff292fe7ee930f0a4496a4a75c341887246cd564c9d6dc4e38754d13e942685a79df
+  data.tar.gz: fb37484a2789b2a2f0c90faf6fa9f1cd1f45f9011ace188980687555f72141cc1fe9f024f73a758a1ad512f3b6796c341f82920747e0e4f120f0d95f47aa6dfe

data/lib/gds_api.rb

@@ -14,6 +14,7 @@ require 'gds_api/publishing_api'
 require 'gds_api/publishing_api_v2'
 require 'gds_api/router'
 require 'gds_api/rummager'
+require 'gds_api/search'
 require 'gds_api/support'
 require 'gds_api/support_api'
 require 'gds_api/worldwide'
@@ -168,14 +169,16 @@ module GdsApi
   #
   # @return [GdsApi::Rummager]
   def self.rummager(options = {})
+    warn "GdsApi.rummager is deprecated.  Use GdsApi.search instead."
+
     GdsApi::Rummager.new(Plek.find('search'), options)
   end
 
-  # Creates a GdsApi::Rummager adapter to access via a search.* hostname
+  # Creates a GdsApi::Search adapter to access via a search.* hostname
   #
-  # @return [GdsApi::Rummager]
+  # @return [GdsApi::Search]
   def self.search(options = {})
-    GdsApi::Rummager.new(Plek.find('search'), options)
+    GdsApi::Search.new(Plek.find('search'), options)
   end
 
   # Creates a GdsApi::Support adapter

data/lib/gds_api/base.rb

@@ -18,14 +18,15 @@ class GdsApi::Base
     GdsApi::JsonClient.new(options)
   end
 
-  def_delegators :client, :get_json,
-                          :post_json,
-                          :put_json,
-                          :patch_json,
-                          :delete_json,
-                          :get_raw, :get_raw!,
-                          :put_multipart,
-                          :post_multipart
+  def_delegators :client,
+                 :get_json,
+                 :post_json,
+                 :put_json,
+                 :patch_json,
+                 :delete_json,
+                 :get_raw, :get_raw!,
+                 :put_multipart,
+                 :post_multipart
 
   attr_reader :options
 

data/lib/gds_api/rummager.rb

@@ -1,184 +1,7 @@
-require 'gds_api/base'
-require 'rack/utils'
+require 'gds_api/search'
 
 module GdsApi
-  # @api documented
-  class Rummager < Base
-    # @api documented
-    class V1 < SimpleDelegator
-      def add_document(type, id, document)
-        post_json(
-          documents_url,
-          document.merge(
-            _type: type,
-            _id: id,
-          )
-        )
-      end
-
-      def delete_document(type, id)
-        delete_json(
-          "#{documents_url}/#{id}",
-          nil,
-          _type: type,
-        )
-      end
-    end
-
-    # @api documented
-    class V2 < SimpleDelegator
-      class InvalidIndex < StandardError; end
-
-      def add_document(id, document, index_name)
-        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
-
-        post_json(
-          "#{base_url}/v2/metasearch/documents",
-          document.merge(
-            _id: id,
-          )
-        )
-      end
-
-      def delete_document(id, index_name)
-        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
-
-        delete_json("#{base_url}/v2/metasearch/documents/#{id}")
-      end
-    end
-
-    DEFAULT_API_VERSION = 'V1'.freeze
-    API_VERSIONS = {
-      'V1' => GdsApi::Rummager::V1,
-      'V2' => GdsApi::Rummager::V2,
-    }.freeze
-    class UnknownAPIVersion < StandardError; end
-
-    def initialize(endpoint_url, options = {})
-      super
-      # The API version provides a simple wrapper around this base class so that we
-      # can still access the shared methods present in this class.
-      version = options.fetch(:api_version, DEFAULT_API_VERSION)
-      api_class = API_VERSIONS[version] || raise(UnknownAPIVersion)
-      @api = api_class.new(self)
-    end
-
-    # Perform a search.
-    #
-    # @param args [Hash] A valid search query. See Rummager documentation for options.
-    #
-    # @see https://github.com/alphagov/rummager/blob/master/doc/search-api.md
-    def search(args, additional_headers = {})
-      request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
-      get_json(request_url, additional_headers)
-    end
-
-    # Perform a batch search.
-    #
-    # @param searches [Array] An array valid search queries. Maximum of 6. See Rummager documentation for options.
-    #
-    # # @see https://github.com/alphagov/rummager/blob/master/doc/search-api.md
-    def batch_search(searches, additional_headers = {})
-      url_friendly_searches = searches.each_with_index.map do |search, index|
-        { index => search }
-      end
-      searches_query = { search: url_friendly_searches }
-      request_url = "#{base_url}/batch_search.json?#{Rack::Utils.build_nested_query(searches_query)}"
-      get_json(request_url, additional_headers)
-    end
-
-    # Perform a search, returning the results as an enumerator.
-    #
-    # The enumerator abstracts away rummager's pagination and fetches new pages when
-    # necessary.
-    #
-    # @param args [Hash] A valid search query. See Rummager documentation for options.
-    # @param page_size [Integer] Number of results in each page.
-    #
-    # @see https://github.com/alphagov/rummager/blob/master/doc/search-api.md
-    def search_enum(args, page_size: 100, additional_headers: {})
-      Enumerator.new do |yielder|
-        (0..Float::INFINITY).step(page_size).each do |index|
-          search_params = args.merge(start: index.to_i, count: page_size)
-          results = search(search_params, additional_headers).to_h.fetch('results', [])
-          results.each do |result|
-            yielder << result
-          end
-          if results.count < page_size
-            break
-          end
-        end
-      end
-    end
-
-    # Advanced search.
-    #
-    # @deprecated Only in use by Whitehall. Use the `#search` method.
-    def advanced_search(args)
-      raise ArgumentError.new("Args cannot be blank") if args.nil? || args.empty?
-
-      request_path = "#{base_url}/advanced_search?#{Rack::Utils.build_nested_query(args)}"
-      get_json(request_path)
-    end
-
-    # Add a document to the search index.
-    #
-    # @param type [String] The rummager/elasticsearch document type.
-    # @param id [String] The rummager/elasticsearch id. Typically the same as the `link` field, but this is not strictly enforced.
-    # @param document [Hash] The document to add. Must match the rummager schema matchin the `type` parameter and contain a `link` field.
-    # @param index_name (V2 only) Name of the index to be deleted from on
-    #   GOV.UK - we only allow deletion from metasearch
-    # @return [GdsApi::Response] A status code of 202 indicates the document has been successfully queued.
-    #
-    # @see https://github.com/alphagov/rummager/blob/master/doc/documents.md
-    def add_document(*args)
-      @api.add_document(*args)
-    end
-
-    # Delete a content-document from the index by base path.
-    #
-    # Content documents are pages on GOV.UK that have a base path and are
-    # returned in searches. This excludes best bets, recommended-links,
-    # and contacts, which may be deleted with `delete_document`.
-    #
-    # @param base_path Base path of the page on GOV.UK.
-    # @see https://github.com/alphagov/rummager/blob/master/doc/content-api.md
-    def delete_content(base_path)
-      request_url = "#{base_url}/content?link=#{base_path}"
-      delete_json(request_url)
-    end
-
-    # Retrieve a content-document from the index.
-    #
-    # Content documents are pages on GOV.UK that have a base path and are
-    # returned in searches. This excludes best bets, recommended-links,
-    # and contacts.
-    #
-    # @param base_path [String] Base path of the page on GOV.UK.
-    # @see https://github.com/alphagov/rummager/blob/master/doc/content-api.md
-    def get_content(base_path)
-      request_url = "#{base_url}/content?link=#{base_path}"
-      get_json(request_url)
-    end
-
-    # Delete a non-content document from the search index.
-    #
-    # For example, best bets, recommended links, or contacts.
-    #
-    # @param type [String] The rummager/elasticsearch document type.
-    # @param id [String] The rummager/elasticsearch id. Typically the same as the `link` field.
-    # @param index_name (V2 only) Name of the index to be deleted from on
-    #   GOV.UK - we only allow deletion from metasearch
-    def delete_document(*args)
-      @api.delete_document(*args)
-    end
-
-    def base_url
-      endpoint
-    end
-
-    def documents_url
-      "#{base_url}/documents"
-    end
+  class Rummager < Search
+    warn "GdsApi::Rummager is deprecated.  Use GdsApi::Search instead."
   end
 end

data/lib/gds_api/search.rb

@@ -0,0 +1,184 @@
+require 'gds_api/base'
+require 'rack/utils'
+
+module GdsApi
+  # @api documented
+  class Search < Base
+    # @api documented
+    class V1 < SimpleDelegator
+      def add_document(type, id, document)
+        post_json(
+          documents_url,
+          document.merge(
+            _type: type,
+            _id: id,
+          )
+        )
+      end
+
+      def delete_document(type, id)
+        delete_json(
+          "#{documents_url}/#{id}",
+          nil,
+          _type: type,
+        )
+      end
+    end
+
+    # @api documented
+    class V2 < SimpleDelegator
+      class InvalidIndex < StandardError; end
+
+      def add_document(id, document, index_name)
+        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
+
+        post_json(
+          "#{base_url}/v2/metasearch/documents",
+          document.merge(
+            _id: id,
+          )
+        )
+      end
+
+      def delete_document(id, index_name)
+        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
+
+        delete_json("#{base_url}/v2/metasearch/documents/#{id}")
+      end
+    end
+
+    DEFAULT_API_VERSION = 'V1'.freeze
+    API_VERSIONS = {
+      'V1' => GdsApi::Search::V1,
+      'V2' => GdsApi::Search::V2,
+    }.freeze
+    class UnknownAPIVersion < StandardError; end
+
+    def initialize(endpoint_url, options = {})
+      super
+      # The API version provides a simple wrapper around this base class so that we
+      # can still access the shared methods present in this class.
+      version = options.fetch(:api_version, DEFAULT_API_VERSION)
+      api_class = API_VERSIONS[version] || raise(UnknownAPIVersion)
+      @api = api_class.new(self)
+    end
+
+    # Perform a search.
+    #
+    # @param args [Hash] A valid search query. See search-api documentation for options.
+    #
+    # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    def search(args, additional_headers = {})
+      request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
+      get_json(request_url, additional_headers)
+    end
+
+    # Perform a batch search.
+    #
+    # @param searches [Array] An array valid search queries. Maximum of 6. See search-api documentation for options.
+    #
+    # # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    def batch_search(searches, additional_headers = {})
+      url_friendly_searches = searches.each_with_index.map do |search, index|
+        { index => search }
+      end
+      searches_query = { search: url_friendly_searches }
+      request_url = "#{base_url}/batch_search.json?#{Rack::Utils.build_nested_query(searches_query)}"
+      get_json(request_url, additional_headers)
+    end
+
+    # Perform a search, returning the results as an enumerator.
+    #
+    # The enumerator abstracts away search-api's pagination and fetches new pages when
+    # necessary.
+    #
+    # @param args [Hash] A valid search query. See search-api documentation for options.
+    # @param page_size [Integer] Number of results in each page.
+    #
+    # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    def search_enum(args, page_size: 100, additional_headers: {})
+      Enumerator.new do |yielder|
+        (0..Float::INFINITY).step(page_size).each do |index|
+          search_params = args.merge(start: index.to_i, count: page_size)
+          results = search(search_params, additional_headers).to_h.fetch('results', [])
+          results.each do |result|
+            yielder << result
+          end
+          if results.count < page_size
+            break
+          end
+        end
+      end
+    end
+
+    # Advanced search.
+    #
+    # @deprecated Only in use by Whitehall. Use the `#search` method.
+    def advanced_search(args)
+      raise ArgumentError.new("Args cannot be blank") if args.nil? || args.empty?
+
+      request_path = "#{base_url}/advanced_search?#{Rack::Utils.build_nested_query(args)}"
+      get_json(request_path)
+    end
+
+    # Add a document to the search index.
+    #
+    # @param type [String] The search-api document type.
+    # @param id [String] The search-api/elasticsearch id. Typically the same as the `link` field, but this is not strictly enforced.
+    # @param document [Hash] The document to add. Must match the search-api schema matching the `type` parameter and contain a `link` field.
+    # @param index_name (V2 only) Name of the index to be deleted from on
+    #   GOV.UK - we only allow deletion from metasearch
+    # @return [GdsApi::Response] A status code of 202 indicates the document has been successfully queued.
+    #
+    # @see https://github.com/alphagov/search-api/blob/master/doc/documents.md
+    def add_document(*args)
+      @api.add_document(*args)
+    end
+
+    # Delete a content-document from the index by base path.
+    #
+    # Content documents are pages on GOV.UK that have a base path and are
+    # returned in searches. This excludes best bets, recommended-links,
+    # and contacts, which may be deleted with `delete_document`.
+    #
+    # @param base_path Base path of the page on GOV.UK.
+    # @see https://github.com/alphagov/search-api/blob/master/doc/content-api.md
+    def delete_content(base_path)
+      request_url = "#{base_url}/content?link=#{base_path}"
+      delete_json(request_url)
+    end
+
+    # Retrieve a content-document from the index.
+    #
+    # Content documents are pages on GOV.UK that have a base path and are
+    # returned in searches. This excludes best bets, recommended-links,
+    # and contacts.
+    #
+    # @param base_path [String] Base path of the page on GOV.UK.
+    # @see https://github.com/alphagov/search-api/blob/master/doc/content-api.md
+    def get_content(base_path)
+      request_url = "#{base_url}/content?link=#{base_path}"
+      get_json(request_url)
+    end
+
+    # Delete a non-content document from the search index.
+    #
+    # For example, best bets, recommended links, or contacts.
+    #
+    # @param type [String] The search-api document type.
+    # @param id [String] The search-api/elasticsearch id. Typically the same as the `link` field.
+    # @param index_name (V2 only) Name of the index to be deleted from on
+    #   GOV.UK - we only allow deletion from metasearch
+    def delete_document(*args)
+      @api.delete_document(*args)
+    end
+
+    def base_url
+      endpoint
+    end
+
+    def documents_url
+      "#{base_url}/documents"
+    end
+  end
+end

data/lib/gds_api/test_helpers/rummager.rb

@@ -1,198 +1,90 @@
 require 'json'
 require 'gds_api/test_helpers/json_client_helper'
+require 'gds_api/test_helpers/search'
 
 module GdsApi
   module TestHelpers
     module Rummager
-      RUMMAGER_ENDPOINT = Plek.current.find('search')
+      warn "GdsApi::TestHelpers::Rummager is deprecated.  Use GdsApi::TestHelpers::Search instead."
 
-      def stub_any_rummager_post(index: nil)
-        if index
-          stub_request(:post, %r{#{RUMMAGER_ENDPOINT}/#{index}/documents})
-            .to_return(status: [202, "Accepted"])
-        else
-          stub_request(:post, %r{#{RUMMAGER_ENDPOINT}/documents})
-            .to_return(status: [202, "Accepted"])
-        end
-      end
+      include GdsApi::TestHelpers::Search
 
-      def assert_rummager_posted_item(attributes, index: nil, **options)
-        if index
-          url = RUMMAGER_ENDPOINT + "/#{index}/documents"
-        else
-          url = RUMMAGER_ENDPOINT + "/documents"
-        end
+      RUMMAGER_ENDPOINT = SEARCH_ENDPOINT
 
-        assert_requested(:post, url, **options) do |req|
-          data = JSON.parse(req.body)
-          attributes.to_a.all? do |key, value|
-            data[key.to_s] == value
-          end
-        end
+      def stub_any_rummager_post(*args)
+        stub_any_search_post(*args)
       end
 
-      def stub_any_rummager_search
-        stub_request(:get, %r{#{RUMMAGER_ENDPOINT}/search.json})
+      def assert_rummager_posted_item(*args)
+        assert_search_posted_item(*args)
       end
 
-      def stub_any_rummager_search_to_return_no_results
-        stub_any_rummager_search.to_return(body: { results: [] }.to_json)
+      def stub_any_rummager_search(*args)
+        stub_any_search(*args)
       end
 
-      def assert_rummager_search(options)
-        assert_requested :get, "#{RUMMAGER_ENDPOINT}/search.json", **options
+      def stub_any_rummager_search_to_return_no_results(*args)
+        stub_any_search_to_return_no_results(*args)
       end
 
-      def stub_any_rummager_delete(index: nil)
-        if index
-          stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/#{index}/documents/.*})
-        else
-          # use rummager's default index
-          stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/documents/.*})
-        end
+      def assert_rummager_search(*args)
+        assert_search(*args)
       end
 
-      def stub_any_rummager_delete_content
-        stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/content.*})
+      def stub_any_rummager_delete(*args)
+        stub_any_search_delete(*args)
       end
 
-      def assert_rummager_deleted_item(id, index: nil, **options)
-        if id =~ %r{^/}
-          raise ArgumentError, 'Rummager id must not start with a slash'
-        end
-
-        if index
-          assert_requested(
-            :delete,
-            %r{#{RUMMAGER_ENDPOINT}/#{index}/documents/#{id}},
-            **options
-          )
-        else
-          assert_requested(
-            :delete,
-            %r{#{RUMMAGER_ENDPOINT}/documents/#{id}},
-            **options
-          )
-        end
+      def stub_any_rummager_delete_content(*args)
+        stub_any_search_delete_content(*args)
       end
 
-      def assert_rummager_deleted_content(base_path, **options)
-        assert_requested(
-          :delete,
-          %r{#{RUMMAGER_ENDPOINT}/content.*#{base_path}},
-          **options
-        )
+      def assert_rummager_deleted_item(*args)
+        assert_search_deleted_item(*args)
       end
 
-      def stub_rummager_has_services_and_info_data_for_organisation
-        stub_request_for(search_results_found)
-        run_example_query
+      def assert_rummager_deleted_content(*args)
+        assert_search_deleted_content(*args)
       end
 
-      def stub_rummager_has_no_services_and_info_data_for_organisation
-        stub_request_for(no_search_results_found)
-        run_example_query
+      def stub_rummager_has_services_and_info_data_for_organisation(*args)
+        stub_search_has_services_and_info_data_for_organisation(*args)
       end
 
-      def stub_rummager_has_specialist_sector_organisations(_sub_sector)
-        stub_request_for(sub_sector_organisations_results)
-        run_example_query
+      def stub_rummager_has_no_services_and_info_data_for_organisation(*args)
+        stub_search_has_no_services_and_info_data_for_organisation(*args)
       end
 
-      def stub_rummager_has_no_policies_for_any_type
-        stub_request(:get, %r{/search.json})
-          .to_return(body: no_search_results_found)
+      def stub_rummager_has_specialist_sector_organisations(*args)
+        stub_rummager_has_specialist_sector_organisations(*args)
       end
 
-      def stub_rummager_has_policies_for_every_type(options = {})
-        if options[:count]
-          stub_request(:get, %r{/search.json.*count=#{options[:count]}.*})
-            .to_return(body: first_n_results(new_policies_results, n: options[:count]))
-        else
-          stub_request(:get, %r{/search.json})
-            .to_return(body: new_policies_results)
-        end
+      def stub_rummager_has_no_policies_for_any_type(*args)
+        stub_search_has_no_policies_for_any_type(*args)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :rummager_has_services_and_info_data_for_organisation, :stub_rummager_has_services_and_info_data_for_organisation
-      alias_method :rummager_has_no_services_and_info_data_for_organisation, :stub_rummager_has_no_services_and_info_data_for_organisation
-      alias_method :rummager_has_specialist_sector_organisations, :stub_rummager_has_specialist_sector_organisations
-      alias_method :rummager_has_no_policies_for_any_type, :stub_rummager_has_no_policies_for_any_type
-      alias_method :rummager_has_policies_for_every_type, :stub_rummager_has_policies_for_every_type
-
-    private
-
-      def stub_request_for(result_set)
-        stub_request(:get, /example.com\/search/).to_return(body: result_set)
+      def stub_rummager_has_policies_for_every_type(*args)
+        stub_search_has_policies_for_every_type(*args)
       end
 
-      def run_example_query
-        client.search(example_query)
+      def rummager_has_services_and_info_data_for_organisation(*args)
+        stub_rummager_has_services_and_info_data_for_organisation(*args)
       end
 
-      def search_results_found
-        File.read(
-          File.expand_path(
-            "../../../test/fixtures/services_and_info_fixture.json",
-            __dir__
-          )
-        )
+      def rummager_has_no_services_and_info_data_for_organisation(*args)
+        stub_rummager_has_no_services_and_info_data_for_organisation(*args)
       end
 
-      def no_search_results_found
-        File.read(
-          File.expand_path(
-            "../../../test/fixtures/no_services_and_info_data_found_fixture.json",
-            __dir__
-          )
-        )
-      end
-
-      def sub_sector_organisations_results
-        File.read(
-          File.expand_path(
-            "../../../test/fixtures/sub_sector_organisations.json",
-            __dir__
-          )
-        )
-      end
-
-      def new_policies_results
-        File.read(
-          File.expand_path(
-            "../../../test/fixtures/new_policies_for_dwp.json",
-            __dir__
-          )
-        )
-      end
-
-      def old_policies_results
-        File.read(
-          File.expand_path(
-            "../../../test/fixtures/old_policies_for_dwp.json",
-            __dir__
-          )
-        )
-      end
-
-      def first_n_results(results, options)
-        n = options[:n]
-        results = JSON.parse(results)
-        results["results"] = results["results"][0...n]
-
-        results.to_json
+      def rummager_has_specialist_sector_organisations(*args)
+        stub_rummager_has_specialist_sector_organisations(*args)
       end
 
-      def client
-        GdsApi::Rummager.new("http://example.com")
+      def rummager_has_no_policies_for_any_type(*args)
+        stub_rummager_has_no_policies_for_any_type(*args)
       end
 
-      def example_query
-        {
-          filter_organisations: ["an-organisation-slug"],
-          facet_specialist_sectors: "1000,examples:4,example_scope:global,order:value.title"
-        }
+      def rummager_has_policies_for_every_type(*args)
+        stub_rummager_has_policies_for_every_type(*args)
       end
     end
   end

data/lib/gds_api/test_helpers/search.rb

@@ -0,0 +1,192 @@
+require 'json'
+require 'gds_api/test_helpers/json_client_helper'
+
+module GdsApi
+  module TestHelpers
+    module Search
+      SEARCH_ENDPOINT = Plek.current.find('search')
+
+      def stub_any_search_post(index: nil)
+        if index
+          stub_request(:post, %r{#{SEARCH_ENDPOINT}/#{index}/documents})
+            .to_return(status: [202, "Accepted"])
+        else
+          stub_request(:post, %r{#{SEARCH_ENDPOINT}/documents})
+            .to_return(status: [202, "Accepted"])
+        end
+      end
+
+      def assert_search_posted_item(attributes, index: nil, **options)
+        if index
+          url = SEARCH_ENDPOINT + "/#{index}/documents"
+        else
+          url = SEARCH_ENDPOINT + "/documents"
+        end
+
+        assert_requested(:post, url, **options) do |req|
+          data = JSON.parse(req.body)
+          attributes.to_a.all? do |key, value|
+            data[key.to_s] == value
+          end
+        end
+      end
+
+      def stub_any_search
+        stub_request(:get, %r{#{SEARCH_ENDPOINT}/search.json})
+      end
+
+      def stub_any_search_to_return_no_results
+        stub_any_search.to_return(body: { results: [] }.to_json)
+      end
+
+      def assert_search(options)
+        assert_requested :get, "#{SEARCH_ENDPOINT}/search.json", **options
+      end
+
+      def stub_any_search_delete(index: nil)
+        if index
+          stub_request(:delete, %r{#{SEARCH_ENDPOINT}/#{index}/documents/.*})
+        else
+          # use search-api's default index
+          stub_request(:delete, %r{#{SEARCH_ENDPOINT}/documents/.*})
+        end
+      end
+
+      def stub_any_search_delete_content
+        stub_request(:delete, %r{#{SEARCH_ENDPOINT}/content.*})
+      end
+
+      def assert_search_deleted_item(id, index: nil, **options)
+        if id =~ %r{^/}
+          raise ArgumentError, 'Search id must not start with a slash'
+        end
+
+        if index
+          assert_requested(
+            :delete,
+            %r{#{SEARCH_ENDPOINT}/#{index}/documents/#{id}},
+            **options
+          )
+        else
+          assert_requested(
+            :delete,
+            %r{#{SEARCH_ENDPOINT}/documents/#{id}},
+            **options
+          )
+        end
+      end
+
+      def assert_search_deleted_content(base_path, **options)
+        assert_requested(
+          :delete,
+          %r{#{SEARCH_ENDPOINT}/content.*#{base_path}},
+          **options
+        )
+      end
+
+      def stub_search_has_services_and_info_data_for_organisation
+        stub_request_for(search_results_found)
+        run_example_query
+      end
+
+      def stub_search_has_no_services_and_info_data_for_organisation
+        stub_request_for(no_search_results_found)
+        run_example_query
+      end
+
+      def stub_search_has_specialist_sector_organisations(_sub_sector)
+        stub_request_for(sub_sector_organisations_results)
+        run_example_query
+      end
+
+      def stub_search_has_no_policies_for_any_type
+        stub_request(:get, %r{/search.json})
+          .to_return(body: no_search_results_found)
+      end
+
+      def stub_search_has_policies_for_every_type(options = {})
+        if options[:count]
+          stub_request(:get, %r{/search.json.*count=#{options[:count]}.*})
+            .to_return(body: first_n_results(new_policies_results, n: options[:count]))
+        else
+          stub_request(:get, %r{/search.json})
+            .to_return(body: new_policies_results)
+        end
+      end
+
+    private
+
+      def stub_request_for(result_set)
+        stub_request(:get, /example.com\/search/).to_return(body: result_set)
+      end
+
+      def run_example_query
+        client.search(example_query)
+      end
+
+      def search_results_found
+        File.read(
+          File.expand_path(
+            "../../../test/fixtures/services_and_info_fixture.json",
+            __dir__
+          )
+        )
+      end
+
+      def no_search_results_found
+        File.read(
+          File.expand_path(
+            "../../../test/fixtures/no_services_and_info_data_found_fixture.json",
+            __dir__
+          )
+        )
+      end
+
+      def sub_sector_organisations_results
+        File.read(
+          File.expand_path(
+            "../../../test/fixtures/sub_sector_organisations.json",
+            __dir__
+          )
+        )
+      end
+
+      def new_policies_results
+        File.read(
+          File.expand_path(
+            "../../../test/fixtures/new_policies_for_dwp.json",
+            __dir__
+          )
+        )
+      end
+
+      def old_policies_results
+        File.read(
+          File.expand_path(
+            "../../../test/fixtures/old_policies_for_dwp.json",
+            __dir__
+          )
+        )
+      end
+
+      def first_n_results(results, options)
+        n = options[:n]
+        results = JSON.parse(results)
+        results["results"] = results["results"][0...n]
+
+        results.to_json
+      end
+
+      def client
+        GdsApi::Search.new("http://example.com")
+      end
+
+      def example_query
+        {
+          filter_organisations: ["an-organisation-slug"],
+          facet_specialist_sectors: "1000,examples:4,example_scope:global,order:value.title"
+        }
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '59.1.0'.freeze
+  VERSION = '59.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 59.1.0
+  version: 59.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -411,6 +411,7 @@ files:
 - lib/gds_api/response.rb
 - lib/gds_api/router.rb
 - lib/gds_api/rummager.rb
+- lib/gds_api/search.rb
 - lib/gds_api/support.rb
 - lib/gds_api/support_api.rb
 - lib/gds_api/test_helpers/asset_manager.rb
@@ -433,6 +434,7 @@ files:
 - lib/gds_api/test_helpers/publishing_api_v2.rb
 - lib/gds_api/test_helpers/router.rb
 - lib/gds_api/test_helpers/rummager.rb
+- lib/gds_api/test_helpers/search.rb
 - lib/gds_api/test_helpers/support.rb
 - lib/gds_api/test_helpers/support_api.rb
 - lib/gds_api/test_helpers/whitehall_admin_api.rb
@@ -465,7 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs