gds-api-adapters 34.0.0 → 34.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c31508a987b6157626ddc9dd154b5458db554ea2
-  data.tar.gz: 43b17d83043656ccdd24b88fcb6d07c74d9c19cf
+  metadata.gz: 43d2b87fd0e5761a6e0f58ba5cf043625d32ba1f
+  data.tar.gz: 2806a9f5c8d029e6f1de2dd040f6b2f437b68333
 SHA512:
-  metadata.gz: 68f4709932906aca95ba97ea7343bbc9896953be06c57871e7ab9e93c3ce45f4b3f73bb093a14844d6cd37e44c0030457cbf1d1013b978f26eb0467b19febc66
-  data.tar.gz: 634deb28aee00f3ca3050ab8cea2b41eabd31bead3207ecd9ba98a8306dea9edd1dc7a260de634a511932f1b099600f3ce7d7bfc3718230a42077f72ceda032e
+  metadata.gz: 0a44f33186db19f7f1c30b11d1e9fb6bd1cf9bbd31dbe3209150c8b67650c6b681df303bec317775fb127b4b3690a6686a9b90748ebcdc91d65e3518d4dfcd37
+  data.tar.gz: 6289d4f548c633be92764965903deb86955921c971e29f9dc45e87f755090cf9978b2ec7ad9eecf1ca50a200ba18dde19940489259e576962a8f20291fc6574f

data/README.md

@@ -7,7 +7,7 @@ Example usage:
 ```ruby
 require 'gds_api/rummager'
 rummager = GdsApi::Rummager.new(Plek.new.find('rummager'))
-results = rummager.unified_search(q: "taxes")
+results = rummager.search(q: "taxes")
 ```
 
 Example adapters for frequently used applications:

data/lib/gds_api/rummager.rb

@@ -6,6 +6,7 @@ module GdsApi
 
     # Perform a search.
     #
+    # @deprecated Alias for `#search`.
     # @param query [Hash] A valid search query. See Rummager documentation for options.
     #
     # @see https://github.com/alphagov/rummager/blob/master/docs/unified-search-api.md
@@ -14,9 +15,19 @@ module GdsApi
       get_json!(request_url)
     end
 
+    # Perform a search.
+    #
+    # @param query [Hash] A valid search query. See Rummager documentation for options.
+    #
+    # @see https://github.com/alphagov/rummager/blob/master/docs/unified-search-api.md
+    def search(args)
+      request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
+      get_json!(request_url)
+    end
+
     # Advanced search.
     #
-    # @deprecated Only in use by Whitehall. Use the `unified_search` method.
+    # @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)}"

data/lib/gds_api/test_helpers/rummager.rb

@@ -94,27 +94,27 @@ module GdsApi
       end
 
       def rummager_has_no_policies_for_any_type
-        stub_request(:get, %r{/unified_search.json})
+        stub_request(:get, %r{/search.json})
           .to_return(body: no_search_results_found)
       end
 
       def rummager_has_policies_for_every_type(options = {})
         if count = options[:count]
-          stub_request(:get, %r{/unified_search.json.*count=#{count}.*})
+          stub_request(:get, %r{/search.json.*count=#{count}.*})
             .to_return(body: first_n_results(new_policies_results, n: count))
         else
-          stub_request(:get, %r{/unified_search.json})
+          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\/unified_search/).to_return(body: result_set)
+        stub_request(:get, /example.com\/search/).to_return(body: result_set)
       end
 
       def run_example_query
-        client.unified_search(example_query)
+        client.search(example_query)
       end
 
       def search_results_found

data/lib/gds_api/version.rb

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

data/test/publishing_api_v2_test.rb

@@ -26,8 +26,12 @@ describe GdsApi::PublishingApiV2 do
   end
 
   before do
+    @bearer_token = "example-bearer-token"
     @base_api_url = Plek.current.find("publishing-api")
-    @api_client = GdsApi::PublishingApiV2.new('http://localhost:3093')
+    @api_client = GdsApi::PublishingApiV2.new(
+      "http://localhost:3093",
+      bearer_token: @bearer_token,
+    )
 
     @content_id = "bed722e6-db68-43e5-9079-063f623335a7"
   end
@@ -44,9 +48,9 @@ describe GdsApi::PublishingApiV2 do
             method: :put,
             path: "/v2/content/#{@content_id}",
             body: @content_item,
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -70,9 +74,9 @@ describe GdsApi::PublishingApiV2 do
             method: :put,
             path: "/v2/content/#{@content_id}",
             body: @content_item,
-            headers: {
-              "Content-Type" => "application/json",
-            }
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 422,
@@ -110,9 +114,9 @@ describe GdsApi::PublishingApiV2 do
             method: :put,
             path: "/v2/content/#{@content_id}",
             body: @content_item,
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 422,
@@ -152,9 +156,9 @@ describe GdsApi::PublishingApiV2 do
               method: :put,
               path: "/v2/content/#{@content_id}",
               body: @content_item,
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -178,9 +182,9 @@ describe GdsApi::PublishingApiV2 do
               method: :put,
               path: "/v2/content/#{@content_id}",
               body: @content_item,
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 409,
@@ -221,6 +225,9 @@ describe GdsApi::PublishingApiV2 do
           .with(
             method: :get,
             path: "/v2/content/#{@content_id}",
+            headers: GdsApi::JsonClient.default_request_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -259,6 +266,9 @@ describe GdsApi::PublishingApiV2 do
             method: :get,
             path: "/v2/content/#{@content_id}",
             query: "locale=fr",
+            headers: GdsApi::JsonClient.default_request_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -298,6 +308,9 @@ describe GdsApi::PublishingApiV2 do
               method: :get,
               path: "/v2/content/#{@content_id}",
               query: "version=1",
+              headers: GdsApi::JsonClient.default_request_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -337,6 +350,9 @@ describe GdsApi::PublishingApiV2 do
               method: :get,
               path: "/v2/content/#{@content_id}",
               query: "version=2",
+              headers: GdsApi::JsonClient.default_request_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -375,6 +391,9 @@ describe GdsApi::PublishingApiV2 do
             .with(
               method: :get,
               path: "/v2/content/#{@content_id}",
+              headers: GdsApi::JsonClient.default_request_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -412,6 +431,9 @@ describe GdsApi::PublishingApiV2 do
           .with(
             method: :get,
             path: "/v2/content/#{@content_id}",
+            headers: GdsApi::JsonClient.default_request_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 404,
@@ -445,9 +467,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               update_type: "major",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200
@@ -471,9 +493,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               update_type: "major",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 404
@@ -500,9 +522,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               "update_type" => ""
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 422,
@@ -539,9 +561,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               update_type: "major",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 400,
@@ -575,9 +597,9 @@ describe GdsApi::PublishingApiV2 do
               update_type: "major",
               locale: "fr",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -603,9 +625,9 @@ describe GdsApi::PublishingApiV2 do
                 update_type: "minor",
                 previous_version: 3,
               },
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -630,9 +652,9 @@ describe GdsApi::PublishingApiV2 do
                 update_type: "minor",
                 previous_version: 2,
               },
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 409,
@@ -674,9 +696,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               type: "gone",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200
@@ -700,9 +722,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               type: "gone",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 404
@@ -729,9 +751,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               type: "not-a-valid-type",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 422,
@@ -766,9 +788,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               type: "gone",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200
@@ -794,9 +816,9 @@ describe GdsApi::PublishingApiV2 do
                 type: "gone",
                 previous_version: 3,
               },
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 200,
@@ -821,9 +843,9 @@ describe GdsApi::PublishingApiV2 do
                 type: "gone",
                 previous_version: 2,
               },
-              headers: {
-                "Content-Type" => "application/json",
-              },
+              headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+                "Authorization" => "Bearer #{@bearer_token}"
+              ),
             )
             .will_respond_with(
               status: 409,
@@ -1121,7 +1143,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/linkables",
           query: "document_type=topic",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1148,7 +1172,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=title&fields%5B%5D=base_path",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1192,7 +1218,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1234,7 +1262,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale&locale=fr",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1276,7 +1306,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=locale&locale=all",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1323,7 +1355,9 @@ describe GdsApi::PublishingApiV2 do
           method: :get,
           path: "/v2/content",
           query: "content_format=topic&fields%5B%5D=content_id&fields%5B%5D=details",
-          headers: {},
+          headers: GdsApi::JsonClient.default_request_headers.merge(
+            "Authorization" => "Bearer #{@bearer_token}"
+          ),
         )
         .will_respond_with(
           status: 200,
@@ -1368,9 +1402,9 @@ describe GdsApi::PublishingApiV2 do
             method: :post,
             path: "/v2/content/#{@content_id}/discard-draft",
             body: {},
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -1394,9 +1428,9 @@ describe GdsApi::PublishingApiV2 do
             body: {
               locale: "fr",
             },
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,
@@ -1418,9 +1452,9 @@ describe GdsApi::PublishingApiV2 do
             method: :post,
             path: "/v2/content/#{@content_id}/discard-draft",
             body: {},
-            headers: {
-              "Content-Type" => "application/json",
-            },
+            headers: GdsApi::JsonClient.default_request_with_json_body_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 404,
@@ -1446,6 +1480,9 @@ describe GdsApi::PublishingApiV2 do
             method: :get,
             path: "/v2/linked/#{@content_id}",
             query: "fields%5B%5D=content_id&fields%5B%5D=base_path&link_type=topic",
+            headers: GdsApi::JsonClient.default_request_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 404,
@@ -1497,7 +1534,9 @@ describe GdsApi::PublishingApiV2 do
             method: :get,
             path: "/v2/linked/" + @linked_content_item['content_id'],
             query: "fields%5B%5D=content_id&fields%5B%5D=base_path&link_type=topic",
-            headers: {},
+            headers: GdsApi::JsonClient.default_request_headers.merge(
+              "Authorization" => "Bearer #{@bearer_token}"
+            ),
           )
           .will_respond_with(
             status: 200,

data/test/rummager_test.rb

@@ -5,6 +5,7 @@ describe GdsApi::Rummager do
   before(:each) do
     stub_request(:get, /example.com\/advanced_search/).to_return(body: "[]")
     stub_request(:get, /example.com\/unified_search/).to_return(body: "[]")
+    stub_request(:get, /example.com\/search/).to_return(body: "[]")
   end
 
   # tests for #advanced_search
@@ -132,6 +133,74 @@ describe GdsApi::Rummager do
     assert_requested :get, /order=-public_timestamp/
   end
 
+  # tests for search
+
+  it "#search should raise an exception if the service at the search URI returns a 500" do
+    stub_request(:get, /example.com\/search.json/).to_return(status: [500, "Internal Server Error"])
+    assert_raises(GdsApi::HTTPServerError) do
+      GdsApi::Rummager.new("http://example.com").search(q: "query")
+    end
+  end
+
+  it "#search should raise an exception if the service at the search URI returns a 404" do
+    stub_request(:get, /example.com\/search/).to_return(status: [404, "Not Found"])
+    assert_raises(GdsApi::HTTPNotFound) do
+      GdsApi::Rummager.new("http://example.com").search(q: "query")
+    end
+  end
+
+  it "#search should raise an exception if the service at the unified search URI returns a 400" do
+    stub_request(:get, /example.com\/search/).to_return(
+      status: [400, "Bad Request"],
+      body: %q("error":"Filtering by \"coffee\" is not allowed"),
+    )
+    assert_raises(GdsApi::HTTPClientError) do
+      GdsApi::Rummager.new("http://example.com").search(q: "query", filter_coffee: "tea")
+    end
+  end
+
+  it "#search should raise an exception if the service at the unified search URI returns a 422" do
+    stub_request(:get, /example.com\/search/).to_return(
+      status: [422, "Bad Request"],
+      body: %q("error":"Filtering by \"coffee\" is not allowed"),
+    )
+    assert_raises(GdsApi::HTTPClientError) do
+      GdsApi::Rummager.new("http://example.com").search(q: "query", filter_coffee: "tea")
+    end
+  end
+
+  it "#search should raise an exception if the service at the search URI times out" do
+    stub_request(:get, /example.com\/search/).to_timeout
+    assert_raises(GdsApi::TimedOutException) do
+      GdsApi::Rummager.new("http://example.com").search(q: "query")
+    end
+  end
+
+  it "#search should return the search deserialized from json" do
+    search_results = [{"title" => "document-title"}]
+    stub_request(:get, /example.com\/search/).to_return(body: search_results.to_json)
+    results = GdsApi::Rummager.new("http://example.com").search(q: "query")
+    assert_equal search_results, results.to_hash
+  end
+
+  it "#search should request the search results in JSON format" do
+    GdsApi::Rummager.new("http://example.com").search(q: "query")
+
+    assert_requested :get, /.*/, headers: {"Accept" => "application/json"}
+  end
+
+  it "#search should issue a request for all the params supplied" do
+    GdsApi::Rummager.new("http://example.com").search(
+      q: "query & stuff",
+      filter_topics: ["1", "2"],
+      order: "-public_timestamp",
+    )
+
+    assert_requested :get, /q=query%20%26%20stuff/
+    assert_requested :get, /filter_topics\[\]=1&filter_topics\[\]=2/
+    assert_requested :get, /order=-public_timestamp/
+  end
+
   it "#delete_content removes a document" do
     request = stub_request(:delete, "http://example.com/content?link=/foo/bar")
 

metadata

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