gds-api-adapters 30.2.0 → 30.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caa6bb00e5f2ebd0cf88d785836ca4a034271d60
-  data.tar.gz: 89afbd1e27b272902ef2007022743cda48b8cf25
+  metadata.gz: 969acb8ae599f5c52ed298ddd20c282defb88372
+  data.tar.gz: 195b6054704e7dd2d48aa363e984e04633914c36
 SHA512:
-  metadata.gz: ddb41be6da100058a5f31a3680c6c9fc1773cb26415fa29c40015757ea2dc886d902ce7297e3e8f25eaedd3da95631a95c6804ad2c9ee91d90c1a9ec4c6bee43
-  data.tar.gz: 034d0c128336323787a1246633797370f787f5b20a1d2efbe4bd5f5299062a5066a8680b773390bcd175b2d9e6fefc18ede604a58467dbffaa17c066d7f3e164
+  metadata.gz: e6850acb92b32f599b93073fff01b73deb2fb857a8d5578dfcc9e5d35c96c4c4fceadbf999295b00c166c21fe6daccbe0031807826b2425677698efe6e3b772e
+  data.tar.gz: 1d16735000c6ab008c52ab4a69f8485b54c25eace4c38b0298f04e6e1982cad0a825e313f74d13d073e8a427e0dbd944aa766fb15e1f5ad837b0d170fac6b4a9

data/README.md

@@ -1,15 +1,20 @@
-A set of API adapters to work with the GDS APIs, extracted from the frontend
-app.
+# GDS API Adapters
+
+A set of API adapters to work with the GDS APIs.
 
 Example usage:
 
-    publisher_api = GdsApi::Publisher.new("environment")
-    ostruct_publication = publisher_api.publication_for_slug('my-published-item')
+```ruby
+require 'gds_api/rummager'
+rummager = GdsApi::Rummager.new(Plek.new.find('rummager'))
+results = rummager.unified_search(q: "taxes")
+```
 
-    panopticon_api = GdsApi::Panopticon.new("environment")
-    ostruct_metadata = panopticon_api.artefact_for_slug('my-published-item')
+Example adapters for frequently used applications:
 
-Very much still a work in progress.
+- [Publishing API](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/PublishingApiV2), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/publishing_api_v2.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/PublishingApiV2))
+- [Content Store](lib/gds_api/content_store.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/ContentStore), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/content_store.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/ContentStore))
+- [Rummager](lib/gds_api/publishing_api_v2.rb) ([docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/Rummager), [test helper code](https://github.com/alphagov/gds-api-adapters/blob/master/lib/gds_api/test_helpers/rummager.rb), [test helper docs](http://www.rubydoc.info/gems/gds-api-adapters/GdsApi/TestHelpers/Rummager))
 
 ## Logging
 

data/lib/gds_api/helpers.rb

@@ -1,7 +1,6 @@
 require 'gds_api/asset_manager'
 require 'gds_api/business_support_api'
 require 'gds_api/content_api'
-require 'gds_api/content_register'
 require 'gds_api/content_store'
 require 'gds_api/imminence'
 require 'gds_api/licence_application'
@@ -25,10 +24,6 @@ module GdsApi
       @content_api ||= GdsApi::ContentApi.new(Plek.current.find("contentapi"), options)
     end
 
-    def content_register(options = {})
-      @content_register ||= GdsApi::ContentRegister.new(Plek.current.find("content-register"), options)
-    end
-
     def content_store(options = {})
       @content_store ||= GdsApi::ContentStore.new(Plek.current.find("content-store"), options)
     end

data/lib/gds_api/publishing_api_v2.rb

@@ -1,6 +1,17 @@
 require_relative 'base'
 
+# Adapter for the Publishing API.
+#
+# @see https://github.com/alphagov/publishing-api
+# @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-application-examples.md
+# @see https://github.com/alphagov/publishing-api/blob/master/doc/object-model-explanation.md
 class GdsApi::PublishingApiV2 < GdsApi::Base
+  # Put a content item
+  #
+  # @param content_id [UUID]
+  # @param payload [Hash] A valid content item
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#put-v2contentcontent_id
   def put_content(content_id, payload)
     put_json!(content_url(content_id), payload)
   end
@@ -14,6 +25,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # @option params [String] locale The language, defaults to 'en' in publishing-api.
   #
   # @return [GdsApi::Response] a content item
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2contentcontent_id
   def get_content(content_id, params = {})
     get_json(content_url(content_id, params))
   end
@@ -29,6 +41,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # @return [GdsApi::Response] a content item
   #
   # @raise [HTTPNotFound] when the content item is not found
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2contentcontent_id
   def get_content!(content_id, params = {})
     get_json!(content_url(content_id, params))
   end
@@ -42,6 +55,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #   publishing_api.lookup_content_ids(base_paths: ['/foo', '/bar'])
   #   # => { "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db", "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca" }
   #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-lookup-by-base-path
   def lookup_content_ids(base_paths:)
     response = post_json!("#{endpoint}/lookup-by-base-path", base_paths: base_paths)
     response.to_hash
@@ -61,11 +75,23 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #   publishing_api.lookup_content_id(base_path: '/foo')
   #   # => "51ac4247-fd92-470a-a207-6b852a97f2db"
   #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-lookup-by-base-path
   def lookup_content_id(base_path:)
     lookups = lookup_content_ids(base_paths: [base_path])
     lookups[base_path]
   end
 
+  # Publish a content item
+  #
+  # The publishing-api will "publish" a draft item, so that it will be visible
+  # on the public site.
+  #
+  # @param content_id [UUID]
+  # @param update_type [String] Either 'major', 'minor' or 'republish'
+  # @param params [Hash]
+  # @option params [String] locale The language, defaults to 'en' in publishing-api.
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-v2contentcontent_idpublish
   def publish(content_id, update_type, options = {})
     params = {
       update_type: update_type
@@ -81,6 +107,15 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     post_json!(publish_url(content_id), params)
   end
 
+  # Discard a draft
+  #
+  # Deletes the draft content item.
+  #
+  # @param params [Hash]
+  # @option params [String] locale The language, defaults to 'en' in publishing-api.
+  # @option params [Integer] previous_version used to ensure the request is discarding the latest lock version of the draft
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#post-v2contentcontent_iddiscard-draft
   def discard_draft(content_id, options = {})
     optional_keys = [
       :locale,
@@ -92,10 +127,28 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     post_json!(discard_url(content_id), params)
   end
 
+  # FIXME: Add documentation
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkscontent_id
   def get_links(content_id)
     get_json(links_url(content_id))
   end
 
+  # Patch the links of a content item
+  #
+  # @param content_id [UUID]
+  # @param payload [Hash] A "links hash"
+  # @example
+  #
+  #   publishing_api.patch_links(
+  #     '86963c13-1f57-4005-b119-e7cf3cb92ecf',
+  #     {
+  #       topics: ['d6e1527d-d0c0-40d5-9603-b9f3e6866b8a'],
+  #       mainstream_browse_pages: ['d6e1527d-d0c0-40d5-9603-b9f3e6866b8a'],
+  #     }
+  #   )
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#patch-v2linkscontent_id
   def patch_links(content_id, payload)
     params = {
       links: payload.fetch(:links)
@@ -106,11 +159,17 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     patch_json!(links_url(content_id), params)
   end
 
+  # FIXME: Add documentation
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2content
   def get_content_items(params)
     query = query_string(params)
     get_json("#{endpoint}/v2/content#{query}")
   end
 
+  # FIXME: Add documentation
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkables
   def get_linkables(document_type: nil, format: nil)
     if document_type.nil?
       if format.nil?
@@ -127,6 +186,9 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     get_json("#{endpoint}/v2/linkables?document_type=#{document_type}")
   end
 
+  # FIXME: Add documentation
+  #
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/publishing-api-syntactic-usage.md#get-v2linkedcontent_id
   def get_linked_items(content_id, params = {})
     query = query_string(params)
     validate_content_id(content_id)

data/lib/gds_api/rummager.rb

@@ -4,17 +4,32 @@ require 'rack/utils'
 module GdsApi
   class Rummager < Base
 
+    # Unified search
+    #
+    # 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 unified_search(args)
       request_url = "#{base_url}/unified_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.
     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)}"
       get_json!(request_path)
     end
 
+    # Add a document
+    #
+    # Adds a document to the index
+    #
+    # @see https://github.com/alphagov/rummager/blob/master/docs/documents.md
     def add_document(type, id, document)
       post_json!(
         documents_url,
@@ -39,7 +54,7 @@ module GdsApi
     # Retrieves a content-document from the index. Content documents are pages
     # on GOV.UK returned by search index.
     #
-    # @param base_path Base path of the page on GOV.UK.
+    # @param base_path [String] Base path of the page on GOV.UK.
     # @see https://github.com/alphagov/rummager/blob/master/docs/content-api.md
     def get_content!(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
@@ -51,7 +66,8 @@ module GdsApi
     # Delete any document from the search index. Unlike `delete_content!` this
     # needs a type, but can be used to delete non-content documents from the
     # index.
-    # @deprecated
+    #
+    # @deprecated Use `delete_content!`
     def delete_document(type, id)
       delete_json!(
         "#{documents_url}/#{id}",

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '30.2.0'
+  VERSION = '30.2.1'
 end

data/test/helpers_test.rb

@@ -12,7 +12,6 @@ describe GdsApi::Helpers do
     refute_nil test_with_helpers.asset_manager_api
     refute_nil test_with_helpers.business_support_api
     refute_nil test_with_helpers.content_api
-    refute_nil test_with_helpers.content_register
     refute_nil test_with_helpers.content_store
     refute_nil test_with_helpers.publisher_api
     refute_nil test_with_helpers.imminence_api

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 30.2.0
+  version: 30.2.1
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -136,34 +136,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: pact
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pact-consumer-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -290,18 +262,60 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.24.2
+- !ruby/object:Gem::Dependency
+  name: pact
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: pact-mock_service
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: pact-consumer-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: pact_broker-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
 description: A set of adapters providing easy access to the GDS GOV.UK APIs
@@ -318,7 +332,6 @@ files:
 - lib/gds_api/base.rb
 - lib/gds_api/business_support_api.rb
 - lib/gds_api/content_api.rb
-- lib/gds_api/content_register.rb
 - lib/gds_api/content_store.rb
 - lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/email_alert_api.rb
@@ -359,7 +372,6 @@ files:
 - lib/gds_api/test_helpers/content_api.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/content_item_helpers.rb
-- lib/gds_api/test_helpers/content_register.rb
 - lib/gds_api/test_helpers/content_store.rb
 - lib/gds_api/test_helpers/email_alert_api.rb
 - lib/gds_api/test_helpers/gov_uk_delivery.rb
@@ -387,7 +399,6 @@ files:
 - test/asset_manager_test.rb
 - test/business_support_api_test.rb
 - test/content_api_test.rb
-- test/content_register_test.rb
 - test/content_store_test.rb
 - test/email_alert_api_test.rb
 - test/external_link_tracker_test.rb
@@ -469,7 +480,6 @@ test_files:
 - test/publisher_api_test.rb
 - test/rummager_helpers_test.rb
 - test/support_test.rb
-- test/content_register_test.rb
 - test/test_helpers/publishing_api_test.rb
 - test/test_helpers/pact_helper.rb
 - test/test_helpers/panopticon_test.rb

data/lib/gds_api/content_register.rb

@@ -1,23 +0,0 @@
-require_relative 'base'
-require_relative 'exceptions'
-
-class GdsApi::ContentRegister < GdsApi::Base
-
-  def put_entry(content_id, entry)
-    put_json!(entry_url(content_id), entry)
-  end
-
-  def entries(format)
-    get_json!(entries_url(format))
-  end
-
-private
-
-  def entries_url(format)
-    "#{endpoint}/entries?format=#{format}"
-  end
-
-  def entry_url(content_id)
-    "#{endpoint}/entry/#{content_id}"
-  end
-end

data/lib/gds_api/test_helpers/content_register.rb

@@ -1,38 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'json'
-
-module GdsApi
-  module TestHelpers
-    module ContentRegister
-      CONTENT_REGISTER_ENDPOINT = Plek.find('content-register')
-
-      def stub_content_register_put_entry(content_id, entry)
-        response_body = entry.merge(content_id: content_id).to_json
-
-        stub_request(:put, content_register_entry_url_for(content_id)).
-          with(body: entry).
-          to_return(status: 201, body: response_body)
-      end
-
-      def stub_content_register_entries(format, entries)
-        stub_request(:get, content_register_entries_url(format)).
-          to_return(body: entries.to_json, status: 200)
-      end
-
-      def content_register_isnt_available
-        stub_request(:any, /#{CONTENT_REGISTER_ENDPOINT}\/.*/).
-          to_return(status: 503)
-      end
-
-    private
-
-      def content_register_entry_url_for(content_id)
-        CONTENT_REGISTER_ENDPOINT + "/entry/" + content_id
-      end
-
-      def content_register_entries_url(format)
-        CONTENT_REGISTER_ENDPOINT + "/entries?format=#{format}"
-      end
-    end
-  end
-end

data/test/content_register_test.rb

@@ -1,27 +0,0 @@
-require 'test_helper'
-require 'gds_api/content_register'
-require 'gds_api/test_helpers/content_register'
-
-describe GdsApi::ContentRegister do
-  include GdsApi::TestHelpers::ContentRegister
-
-  before do
-    @api_adapter = GdsApi::ContentRegister.new(Plek.find("content-register"))
-  end
-
-  describe "#put_entry method" do
-    it "creates an entry in the content register" do
-      content_id = SecureRandom.uuid
-      entry = {
-        "format" => 'organisation',
-        "title" => 'Organisation',
-        "base_path" => "/government/organisations/organisation"
-      }
-
-      stub_content_register_put_entry(content_id, entry)
-
-      response = @api_adapter.put_entry(content_id, entry)
-      assert_equal 201, response.code
-    end
-  end
-end