gds-api-adapters 4.7.0 → 4.8.0

data/lib/gds_api/rummager.rb

@@ -1,3 +1,5 @@
+require 'rack/utils'
+
 module GdsApi
   class Rummager
     class SearchUriNotSpecified < RuntimeError; end
@@ -22,11 +24,25 @@ module GdsApi
       search_response(:autocomplete, query, format_filter).body
     end
 
+    def advanced_search(args)
+      return [] if args.nil? || args.empty?
+      JSON.parse(advanced_search_response(args).body)
+    end
+
     private
 
+    def advanced_search_response(args)
+      request_path = "/advanced_search?#{Rack::Utils.build_nested_query(args)}"
+      get_response(request_path)
+    end
+
     def search_response(type, query, format_filter = nil)
       request_path = "/#{type}?q=#{CGI.escape(query)}"
       request_path << "&format_filter=#{CGI.escape(format_filter)}" if format_filter
+      get_response(request_path)
+    end
+
+    def get_response(request_path)
       uri = URI("#{search_uri}#{request_path}")
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true if uri.scheme == 'https'

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '4.7.0'
+  VERSION = '4.8.0'
 end

data/test/rummager_test.rb

@@ -5,6 +5,7 @@ describe GdsApi::Rummager do
   before(:each) do
     stub_request(:get, /example.com\/search/).to_return(body: "[]")
     stub_request(:get, /example.com\/autocomplete/).to_return(body: "[]")
+    stub_request(:get, /example.com\/advanced_search/).to_return(body: "[]")
   end
 
   it "should raise an exception if the search service uri is not set" do
@@ -101,7 +102,7 @@ describe GdsApi::Rummager do
   it "should escape characters that would otherwise be invalid in a URI" do
     GdsApi::Rummager.new("http://example.com").search "search term with spaces"
 
-    # FYI: the actual request is "?q=search+term+with+spaces", but Webmock appears to be re-escaping.
+    #the actual request is "?q=search+term+with+spaces", but Webmock appears to be re-escaping.
     assert_requested :get, /\?q=search%20term%20with%20spaces/
   end
 
@@ -112,4 +113,65 @@ describe GdsApi::Rummager do
 
     assert_equal search_results_json, results
   end
+
+  # tests for #advanced_search
+
+  it "#advanced_search should raise an exception if the service at the search URI returns a 500" do
+    stub_request(:get, /example.com\/advanced_search/).to_return(status: [500, "Internal Server Error"])
+    assert_raises(GdsApi::Rummager::SearchServiceError) do
+      GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
+    end
+  end
+
+  it "#advanced_search should raise an exception if the service at the search URI returns a 404" do
+    stub_request(:get, /example.com\/advanced_search/).to_return(status: [404, "Not Found"])
+    assert_raises(GdsApi::Rummager::SearchServiceError) do
+      GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
+    end
+  end
+
+  it "#advanced_search should raise an exception if the service at the search URI times out" do
+    stub_request(:get, /example.com\/advanced_search/).to_timeout
+    assert_raises(GdsApi::Rummager::SearchTimeout) do
+      GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
+    end
+  end
+
+  it "#advanced_search should return the search deserialized from json" do
+    search_results = [{"title" => "document-title"}]
+    stub_request(:get, /example.com\/advanced_search/).to_return(body: search_results.to_json)
+    results = GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
+
+    assert_equal search_results, results
+  end
+
+  it "#advanced_search should return an empty set of results without making request if arguments are empty" do
+    results = GdsApi::Rummager.new("http://example.com").advanced_search({})
+
+    assert_equal [], results
+    assert_not_requested :get, /example.com/
+  end
+
+  it "#advanced_search should return an empty set of results without making request if arguments is nil" do
+    results = GdsApi::Rummager.new("http://example.com").advanced_search(nil)
+
+    assert_equal [], results
+    assert_not_requested :get, /example.com/
+  end
+
+  it "#advanced_search should request the search results in JSON format" do
+    GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query"})
+
+    assert_requested :get, /.*/, headers: {"Accept" => "application/json"}
+  end
+
+  it "#advanced_search should issue a request for all the params supplied" do
+    GdsApi::Rummager.new("http://example.com").advanced_search({keywords: "query & stuff", topics: ["1","2"], order: {public_timestamp: "desc"}})
+
+    #the actual request is "?keywords=query+%26+stuff&topic[0]=1&topic[1]=2&order[public_timestamp]=desc", but Webmock appears to be re-escaping.
+    assert_requested :get, /keywords=query%20%26%20stuff/
+    assert_requested :get, /topics%5B0%5D=1&topics%5B1%5D=2/
+    assert_requested :get, /order%5Bpublic_timestamp%5D=desc/
+  end
+
 end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors: 
 - James Stewart
@@ -239,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2908169980141436257
+      hash: 1465373721783648305
       segments: 
       - 0
       version: "0"
@@ -248,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2908169980141436257
+      hash: 1465373721783648305
       segments: 
       - 0
       version: "0"