gds-api-adapters 35.0.1 → 36.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e333779f06ac4e6cd7cdc357ecd49415ff7504ff
-  data.tar.gz: 6f5769410683e7342de9505201bf22a1c02732bf
+  metadata.gz: 0ad34f7d7d009484cc99f916e4963eb89830733a
+  data.tar.gz: 19d1e39bfef4736154f26c6f225362e1ca88b42b
 SHA512:
-  metadata.gz: 4e75bf5a23893d51a70361a55f1d2b805658678b569f5e4d2f8bd2cdef3b339f5142d3962ee612dac18841cf592685b5969ed7ad2c27b0dade2800fe1fd9c2df
-  data.tar.gz: db78f0b50042f099c4fc43a2cd71c0286b69bccea372e7add1727cb55da56aa29a59183e9401c8496d6ba4990f51a46eb315891bb63459dada26260969a20f6f
+  metadata.gz: b56ad19c715ffeef14cd546a7dae1b0716e02d81c3704a7c8672d5d59c46c1e4b09680ff6cf68c46a2161f266db47716e1daf4966ea85ff0fe5dce7d302460f3
+  data.tar.gz: 4a9f7b802aa84a1a9e582a473f7d61774be034106c6083dce94914ac8061d60963c8c07dcb029fe276548647544021bdcd6d66b27a9208befdc8598ddad12ef1

data/lib/gds_api/publishing_api_v2.rb

@@ -156,9 +156,27 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     post_json!(discard_url(content_id), params)
   end
 
-  # FIXME: Add documentation
+  # Get the link set for the given content_id.
+  #
+  # Given a Content ID, it fetchs the existing link set and their version.
+  #
+  # @param content_id [String]
+  #
+  # @return [GdsApi::Response] A response containing `links` and `version`.
+  #
+  # @example
+  #
+  #   publishing_api.get_links("a-content-id")
+  #   # => {
+  #     "content_id" => "a-content-id",
+  #     "links" => [
+  #       "organisation" => "organisation-content-id",
+  #       "document_collection" => "document-collection-content-id"
+  #     ],
+  #     "version" => 17
+  #   }
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkscontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkscontent_id
   def get_links(content_id)
     get_json(links_url(content_id))
   end

data/lib/gds_api/rummager.rb

@@ -6,20 +6,9 @@ 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
-    def unified_search(args)
-      request_url = "#{base_url}/unified_search.json?#{Rack::Utils.build_nested_query(args)}"
-      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
+    # @see https://github.com/alphagov/rummager/blob/master/docs/search-api.md
     def search(args)
       request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
       get_json!(request_url)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '35.0.1'
+  VERSION = '36.0.0'
 end

data/test/rummager_test.rb

@@ -4,7 +4,6 @@ require "gds_api/rummager"
 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
 
@@ -65,74 +64,6 @@ describe GdsApi::Rummager do
     assert_requested :get, /order\[public_timestamp\]=desc/
   end
 
-  # tests for unified search
-
-  it "#unified_search should raise an exception if the service at the search URI returns a 500" do
-    stub_request(:get, /example.com\/unified_search.json/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::HTTPServerError) do
-      GdsApi::Rummager.new("http://example.com").unified_search(q: "query")
-    end
-  end
-
-  it "#unified_search should raise an exception if the service at the search URI returns a 404" do
-    stub_request(:get, /example.com\/unified_search/).to_return(status: [404, "Not Found"])
-    assert_raises(GdsApi::HTTPNotFound) do
-      GdsApi::Rummager.new("http://example.com").unified_search(q: "query")
-    end
-  end
-
-  it "#unified_search should raise an exception if the service at the unified search URI returns a 400" do
-    stub_request(:get, /example.com\/unified_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").unified_search(q: "query", filter_coffee: "tea")
-    end
-  end
-
-  it "#unified_search should raise an exception if the service at the unified search URI returns a 422" do
-    stub_request(:get, /example.com\/unified_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").unified_search(q: "query", filter_coffee: "tea")
-    end
-  end
-
-  it "#unified_search should raise an exception if the service at the search URI times out" do
-    stub_request(:get, /example.com\/unified_search/).to_timeout
-    assert_raises(GdsApi::TimedOutException) do
-      GdsApi::Rummager.new("http://example.com").unified_search(q: "query")
-    end
-  end
-
-  it "#unified_search should return the search deserialized from json" do
-    search_results = [{"title" => "document-title"}]
-    stub_request(:get, /example.com\/unified_search/).to_return(body: search_results.to_json)
-    results = GdsApi::Rummager.new("http://example.com").unified_search(q: "query")
-    assert_equal search_results, results.to_hash
-  end
-
-  it "#unified_search should request the search results in JSON format" do
-    GdsApi::Rummager.new("http://example.com").unified_search(q: "query")
-
-    assert_requested :get, /.*/, headers: {"Accept" => "application/json"}
-  end
-
-  it "#unified_search should issue a request for all the params supplied" do
-    GdsApi::Rummager.new("http://example.com").unified_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
-
   # tests for search
 
   it "#search should raise an exception if the service at the search URI returns a 500" do
@@ -149,7 +80,7 @@ describe GdsApi::Rummager do
     end
   end
 
-  it "#search should raise an exception if the service at the unified search URI returns a 400" do
+  it "#search should raise an exception if the service at the 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"),
@@ -159,7 +90,7 @@ describe GdsApi::Rummager do
     end
   end
 
-  it "#search should raise an exception if the service at the unified search URI returns a 422" do
+  it "#search should raise an exception if the service at the 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"),

metadata

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