gds-api-adapters 50.7.0 → 50.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faf3854827267da31728562ff26f512b43f272bc
-  data.tar.gz: df50983626ae794d8f1717906fb7c4ab7e1509ce
+  metadata.gz: d32b7a11e6c88bfa89fe4586abcb1eb802385a3c
+  data.tar.gz: 9387022778924d8df0ef6379912aa88d059a0c0d
 SHA512:
-  metadata.gz: 61f47409afa2b78987c88c9b839938d4cee19b2c04dd16c2041cb141a1e688bbba97b27d83c5d0857cefcc4327ffcb4350dfe48a92f258644469074a209b27c7
-  data.tar.gz: 71b7c2d2dc38a69ba2a7e222943acb9a345efc9ec28c1114719518a76139d5233745b26c2345b0aeb44a6d6c3a002a312c2bdc94a096b487771c2c1843fb96a9
+  metadata.gz: 02f43b8750d1bc646dc608f16eac7e9176691d2d5b7536b2a6c807f63e82bc4db22c65c01882b2d75b5592fe40ca139adceca12921279600e7aab9a2723fd7c1
+  data.tar.gz: 39f75553dd24fce6da6c17fecf314ffe911556337fea3542e242fa6b8fe9b2edd40dcd250f35dc3480eecded8829646e5ec7bb9b550b17769ec68597960a55a8

data/lib/gds_api/rummager.rb

@@ -4,6 +4,62 @@ require 'rack/utils'
 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}",
+          _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.
@@ -52,17 +108,13 @@ module GdsApi
     # @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(type, id, document)
-      post_json(
-        documents_url,
-        document.merge(
-          _type: type,
-          _id: id,
-        )
-      )
+    def add_document(*args)
+      @api.add_document(*args)
     end
 
     # Delete a content-document from the index by base path.
@@ -107,15 +159,12 @@ module GdsApi
     #
     # @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}",
-        _type: type,
-      )
+    # @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
 
-  private
-
     def base_url
       endpoint
     end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '50.7.0'.freeze
+  VERSION = '50.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 50.7.0
+  version: 50.8.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek