gds-api-adapters 33.2.2 → 34.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09728e5e73d9ba143473d323123098d6fcb48035
-  data.tar.gz: 548f93cdb9e13682e054ab7f1580855f03529660
+  metadata.gz: c31508a987b6157626ddc9dd154b5458db554ea2
+  data.tar.gz: 43b17d83043656ccdd24b88fcb6d07c74d9c19cf
 SHA512:
-  metadata.gz: bc35f6e20c4772f0e3e38fb25eeed2da4a307b8f3724ed177ec3437602ff8333df182044e0ef9e112cbf43dc927eb0c751a5e5087d909b7b71c8205cda357543
-  data.tar.gz: ac5f1ef28b8068f0c9d0ebd9dfcad328b455f8918ff67d79d9d61b77b6406b3a2f728186043230da39e7619fc05abdcde20f13191aa7028b7261e9a76ff552ef
+  metadata.gz: 68f4709932906aca95ba97ea7343bbc9896953be06c57871e7ab9e93c3ce45f4b3f73bb093a14844d6cd37e44c0030457cbf1d1013b978f26eb0467b19febc66
+  data.tar.gz: 634deb28aee00f3ca3050ab8cea2b41eabd31bead3207ecd9ba98a8306dea9edd1dc7a260de634a511932f1b099600f3ce7d7bfc3718230a42077f72ceda032e

data/lib/gds_api/rummager.rb

@@ -4,9 +4,7 @@ require 'rack/utils'
 module GdsApi
   class Rummager < Base
 
-    # Unified search
-    #
-    # Perform a search
+    # Perform a search.
     #
     # @param query [Hash] A valid search query. See Rummager documentation for options.
     #
@@ -16,7 +14,7 @@ module GdsApi
       get_json!(request_url)
     end
 
-    # Advanced search
+    # Advanced search.
     #
     # @deprecated Only in use by Whitehall. Use the `unified_search` method.
     def advanced_search(args)
@@ -25,9 +23,12 @@ module GdsApi
       get_json!(request_path)
     end
 
-    # Add a document
+    # Add a document to the search index.
     #
-    # Adds a document to the 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.
+    # @return [GdsApi::Response] A status code of 202 indicates the document has been successfully queued.
     #
     # @see https://github.com/alphagov/rummager/blob/master/docs/documents.md
     def add_document(type, id, document)
@@ -40,9 +41,11 @@ module GdsApi
       )
     end
 
-    # Deletes a content-document from the index. Content documents are pages
-    # on GOV.UK returned by search index. They don't include best bets and other
-    # "meta" documents that are stored in Rummager.
+    # 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/docs/content-api.md
@@ -51,8 +54,11 @@ module GdsApi
       delete_json!(request_url)
     end
 
-    # Retrieves a content-document from the index. Content documents are pages
-    # on GOV.UK returned by search index.
+    # 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/docs/content-api.md
@@ -61,13 +67,12 @@ module GdsApi
       get_json!(request_url)
     end
 
-    # delete_document(type, id) (DEPRECATED)
+    # Delete a non-content document from the search index.
     #
-    # Delete any document from the search index. Unlike `delete_content!` this
-    # needs a type, but can be used to delete non-content documents from the
-    # index.
+    # For example, best bets, recommended links, or contacts.
     #
-    # @deprecated Use `delete_content!`
+    # @param type [String] The rummager/elasticsearch document type.
+    # @param id [String] The rummager/elasticsearch id. Typically the same as the `link` field.
     def delete_document(type, id)
       delete_json!(
         "#{documents_url}/#{id}",

data/lib/gds_api/test_helpers/rummager.rb

@@ -6,18 +6,31 @@ module GdsApi
     module Rummager
       RUMMAGER_ENDPOINT = Plek.current.find('rummager')
 
-      def stub_any_rummager_post
-        stub_request(:post, %r{#{RUMMAGER_ENDPOINT}/documents})
+      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
 
       def stub_any_rummager_post_with_queueing_enabled
+        warn "stub_any_rummager_post_with_queueing_enabled is deprecated: use stub_any_rummager_post instead"
+
         stub_request(:post, %r{#{RUMMAGER_ENDPOINT}/documents}) \
           .to_return(status: [202, "Accepted"])
       end
 
-      def assert_rummager_posted_item(attributes)
-        url = RUMMAGER_ENDPOINT + "/documents"
-        assert_requested(:post, url) do |req|
+      def assert_rummager_posted_item(attributes, index: nil, **options)
+        if index
+          url = RUMMAGER_ENDPOINT + "/#{index}/documents"
+        else
+          url = RUMMAGER_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
@@ -25,28 +38,44 @@ module GdsApi
         end
       end
 
-      # @deprecated Rummager.delete_docment is deprecated, so is this stub!  Use `stub_any_rummager_delete_content`
-      def stub_any_rummager_delete
-        warn "stub_any_rummager_delete is deprecated, instead use: stub_any_rummager_delete_content"
-        stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/documents/.*})
+      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
       end
 
       def stub_any_rummager_delete_content
         stub_request(:delete, %r{#{RUMMAGER_ENDPOINT}/content.*})
       end
 
-      # @deprecated Rummager.delete_docment is deprecated, so is this stub!  Use `assert_rummager_deleted_content`
-      def assert_rummager_deleted_item(id)
-        warn "assert_rummager_deleted_item stub is deprecated, instead use: assert_rummager_deleted_content"
-
+      def assert_rummager_deleted_item(id, index: nil, **options)
         if id =~ %r{^/}
           raise ArgumentError, 'Rummager id must not start with a slash'
         end
-        assert_requested(:delete, %r{#{RUMMAGER_ENDPOINT}/documents/#{id}})
+        if index
+          assert_requested(
+            :delete,
+            %r{#{RUMMAGER_ENDPOINT}/#{index}/documents/#{id}},
+            **options
+          )
+        else
+          assert_requested(
+            :delete,
+            %r{#{RUMMAGER_ENDPOINT}/documents/#{id}},
+            **options
+          )
+        end
       end
 
-      def assert_rummager_deleted_content(base_path)
-        assert_requested(:delete, %r{#{RUMMAGER_ENDPOINT}/content.*#{base_path}})
+      def assert_rummager_deleted_content(base_path, **options)
+        assert_requested(
+          :delete,
+          %r{#{RUMMAGER_ENDPOINT}/content.*#{base_path}},
+          **options
+        )
       end
 
       def rummager_has_services_and_info_data_for_organisation

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '33.2.2'
+  VERSION = '34.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 33.2.2
+  version: 34.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek