gds-api-adapters 49.7.0 → 49.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b762aee9a8820eb15af6a93d1f6a76613db0e4c2
-  data.tar.gz: 402b49ea6cb48c0210e5dfd9083dbef52d8b61ca
+  metadata.gz: 565cb9c62f97ab192f2ae1cd2e206508bd3c9d1b
+  data.tar.gz: 712159c4958e3440fe33344983e6e1d1a75a15d4
 SHA512:
-  metadata.gz: d834d43099a1e1225f96e304b3472ba4721ec4a854d494e73b8809533ecff807748da8ddb5678ccbdf2af618de8f2af278533e7603743a8c052cd457ec6bc2bd
-  data.tar.gz: f616e60ae73667a4551bd1afde5e2e7762116d908260e8040092d7a9eac261a841d686ffbd2358a2689774115f337ce3a32378173fded93214052309cf5d6671
+  metadata.gz: a2dd889e19663d642c85c98091ec65ed91f90d1d29b7c7ffbd4eb97a6bb34db6ddd71aa622920c1ec999420c210436c8ef385b98d58265365ca870f44049dd64
+  data.tar.gz: ddbf675bf7758dbaf05c3a42f33856f16e225882c85d028a82068029454aade5ae221cd806f3b6a89157202d097cb5d1c189687c1ba7a307f3b3a23b695d9e59

data/lib/gds_api/rummager.rb

@@ -8,12 +8,36 @@ module GdsApi
     #
     # @param args [Hash] A valid search query. See Rummager documentation for options.
     #
-    # @see https://github.com/alphagov/rummager/blob/master/docs/search-api.md
+    # @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 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.
@@ -30,7 +54,7 @@ module GdsApi
     # @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
+    # @see https://github.com/alphagov/rummager/blob/master/doc/documents.md
     def add_document(type, id, document)
       post_json(
         documents_url,
@@ -48,7 +72,7 @@ module GdsApi
     # 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
+    # @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)
@@ -66,7 +90,7 @@ module GdsApi
     # 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
+    # @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)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '49.7.0'.freeze
+  VERSION = '49.8.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 49.7.0
+  version: 49.8.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek