gds-api-adapters 29.5.0 → 29.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06d4bf9f7af61e5fb2907ce142588d086fb91dc3
-  data.tar.gz: f72878999ef140fa17ed686f27f8b08a8db9b725
+  metadata.gz: 9740e0fbf18097b3bda609a31d95238d536d5f19
+  data.tar.gz: f32388c9c90841aca6e94ac516cbddf429e2a92a
 SHA512:
-  metadata.gz: bd4045e258186c9d7143874174a47be6f07ba0d05f6499abf2f0070a39af11527f3aca76c48848855e0a7e4e514f3ac1ad4668424e37ee10328c8da518047d06
-  data.tar.gz: a5c7d1daeec6dab5feeb76a2d4bf38872577467a063d511f1ba50bd6e75edfe0c71f869a4dbcb0e16d1b72e057f5fc81dc4d2af633268e3a8cf6e5761e69b576
+  metadata.gz: 1dc950579af1a75714fa5b17133a64720b070bbe88867f23eb1b62de5bf447979c7c5042aa478b69bb5b657f2b752e3d1f0131dda67c1c35604cedd709a83ef3
+  data.tar.gz: e1fc3c89d8bb44abb11b5b6f4bbd06e288983abf93cb416dc00b73ae39f456bf1ae82d57f8cc8a5be0fdf47fd20e69412a3a6a9d3e318f4f63e209be87311538

data/README.md

@@ -94,6 +94,14 @@ At time of writing, these are:
 
 * [WebMock](https://github.com/bblimke/webmock)
 
+### Documentation
+
+See [RubyDoc](http://www.rubydoc.info/gems/gds-api-adapters) for some limited documentation.
+
+To run a Yard server locally to preview documentation, run:
+
+    $ bundle exec yard server --reload
+
 ## Licence
 
 Released under the MIT Licence, a copy of which can be found in the file

data/lib/gds_api/publishing_api_v2.rb

@@ -33,6 +33,39 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     get_json!(content_url(content_id, params))
   end
 
+  # Find the content_ids for a list of base_paths.
+  #
+  # @param base_paths [Array]
+  # @return [Hash] a hash, keyed by `base_path` with `content_id` as value
+  # @example
+  #
+  #   publishing_api.lookup_content_ids(base_paths: ['/foo', '/bar'])
+  #   # => { "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db", "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca" }
+  #
+  def lookup_content_ids(base_paths:)
+    response = post_json!("#{endpoint}/lookup-by-base-path", base_paths: base_paths)
+    response.to_hash
+  end
+
+  # Find the content_id for a base_path.
+  #
+  # Convenience method if you only need to look up one content_id for a
+  # base_path. For multiple base_paths, use {GdsApi::PublishingApiV2#lookup_content_ids}.
+  #
+  # @param base_path [String]
+  #
+  # @return [UUID] the `content_id` for the `base_path`
+  #
+  # @example
+  #
+  #   publishing_api.lookup_content_id(base_path: '/foo')
+  #   # => "51ac4247-fd92-470a-a207-6b852a97f2db"
+  #
+  def lookup_content_id(base_path:)
+    lookups = lookup_content_ids(base_paths: [base_path])
+    lookups[base_path]
+  end
+
   def publish(content_id, update_type, options = {})
     params = {
       update_type: update_type

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -175,7 +175,24 @@ module GdsApi
         stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "link set").to_json, headers: {})
       end
 
+      # Stub calls to the lookups endpoint
+      #
+      # @param lookup_hash [Hash] Hash with base_path as key, content_id as value.
+      #
+      # @example
+      #
+      #   publishing_api_has_lookups({
+      #     "/foo" => "51ac4247-fd92-470a-a207-6b852a97f2db",
+      #     "/bar" => "261bd281-f16c-48d5-82d2-9544019ad9ca"
+      #   })
+      #
+      def publishing_api_has_lookups(lookup_hash)
+        url = Plek.current.find('publishing-api') + '/lookup-by-base-path'
+        stub_request(:post, url).to_return(body: lookup_hash.to_json)
+      end
+
     private
+
       def stub_publishing_api_put(*args)
         stub_publishing_api_postlike_call(:put, *args)
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '29.5.0'
+  VERSION = '29.6.0'
 end

data/test/publishing_api_v2/lookup_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'gds_api/publishing_api_v2'
+require 'json'
+
+describe GdsApi::PublishingApiV2 do
+  include PactTest
+
+  before do
+    @api_client = GdsApi::PublishingApiV2.new('http://localhost:3093')
+  end
+
+  describe "#lookup_content_id" do
+    it "returns the content_id for a base_path" do
+      publishing_api
+        .given("there are live content items with base_paths /foo and /bar")
+        .upon_receiving("a /lookup-by-base-path-request")
+        .with(
+          method: :post,
+          path: "/lookup-by-base-path",
+          body: {
+            base_paths: ["/foo"]
+          },
+          headers: {
+            "Content-Type" => "application/json",
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: {
+            "/foo" => "08f86d00-e95f-492f-af1d-470c5ba4752e"
+          }
+        )
+
+      content_id = @api_client.lookup_content_id(base_path: "/foo")
+
+      assert_equal "08f86d00-e95f-492f-af1d-470c5ba4752e", content_id
+    end
+  end
+
+  describe "#lookup_content_ids" do
+    it "returns the content_id for a base_path" do
+      reponse_hash = {
+        "/foo" => "08f86d00-e95f-492f-af1d-470c5ba4752e",
+        "/bar" => "ca6c58a6-fb9d-479d-b3e6-74908781cb18",
+      }
+
+      publishing_api
+        .given("there are live content items with base_paths /foo and /bar")
+        .upon_receiving("a request for multiple base_paths")
+        .with(
+          method: :post,
+          path: "/lookup-by-base-path",
+          body: {
+            base_paths: ["/foo", "/bar"]
+          },
+          headers: {
+            "Content-Type" => "application/json",
+          },
+        )
+        .will_respond_with(
+          status: 200,
+          body: reponse_hash,
+        )
+
+      content_id = @api_client.lookup_content_ids(base_paths: ["/foo", "/bar"])
+
+      assert_equal(reponse_hash, content_id)
+    end
+  end
+end

data/test/test_helpers/publishing_api_v2_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+require 'gds_api/publishing_api_v2'
+require 'gds_api/test_helpers/publishing_api_v2'
+
+describe GdsApi::TestHelpers::PublishingApiV2 do
+  include GdsApi::TestHelpers::PublishingApiV2
+  let(:publishing_api) { GdsApi::PublishingApiV2.new(Plek.current.find("publishing-api")) }
+
+  describe "#publishing_api_has_lookups" do
+    it "stubs the lookup for content items" do
+      lookup_hash = { "/foo" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }
+
+      publishing_api_has_lookups(lookup_hash)
+
+      assert_equal publishing_api.lookup_content_ids(base_paths: ["/foo"]), lookup_hash
+      assert_equal publishing_api.lookup_content_id(base_path: "/foo"), "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 29.5.0
+  version: 29.6.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-09 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -221,19 +221,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.2.2
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 0.8.7.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -420,6 +420,7 @@ files:
 - test/publisher_api_test.rb
 - test/publishing_api/special_route_publisher_test.rb
 - test/publishing_api_test.rb
+- test/publishing_api_v2/lookup_test.rb
 - test/publishing_api_v2_test.rb
 - test/response_test.rb
 - test/router_test.rb
@@ -432,6 +433,7 @@ files:
 - test/test_helpers/pact_helper.rb
 - test/test_helpers/panopticon_test.rb
 - test/test_helpers/publishing_api_test.rb
+- test/test_helpers/publishing_api_v2_test.rb
 - test/whitehall_admin_api_test.rb
 - test/worldwide_api_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
@@ -458,51 +460,54 @@ signing_key:
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files:
-- test/support_api_test.rb
-- test/mapit_test.rb
+- test/content_api_test.rb
+- test/json_client_test.rb
+- test/content_store_test.rb
 - test/publishing_api_test.rb
+- test/business_support_api_test.rb
+- test/middleware/govuk_header_sniffer_test.rb
 - test/whitehall_admin_api_test.rb
-- test/pp_data_in_test.rb
-- test/publishing_api/special_route_publisher_test.rb
-- test/need_api_test.rb
+- test/list_response_test.rb
+- test/maslow_test.rb
+- test/panopticon_registerer_test.rb
+- test/support_test.rb
+- test/asset_manager_test.rb
+- test/helpers_test.rb
+- test/licence_application_api_test.rb
+- test/test_helper.rb
 - test/publisher_api_test.rb
+- test/mapit_test.rb
 - test/rummager_helpers_test.rb
-- test/support_test.rb
-- test/content_register_test.rb
+- test/publishing_api_v2_test.rb
+- test/publishing_api_v2/lookup_test.rb
+- test/support_api_test.rb
+- test/organisations_api_test.rb
+- test/gds_api_base_test.rb
+- test/router_test.rb
+- test/publishing_api/special_route_publisher_test.rb
+- test/external_link_tracker_test.rb
 - test/fact_cave_test.rb
-- test/test_helpers/publishing_api_test.rb
-- test/test_helpers/pact_helper.rb
-- test/test_helpers/panopticon_test.rb
-- test/test_helpers/email_alert_api_test.rb
-- test/licence_application_api_test.rb
-- test/gov_uk_delivery_test.rb
-- test/maslow_test.rb
-- test/helpers_test.rb
-- test/panopticon_registerer_test.rb
+- test/need_api_test.rb
+- test/content_register_test.rb
 - test/panopticon_test.rb
-- test/middleware/govuk_header_sniffer_test.rb
-- test/rummager_test.rb
-- test/json_client_test.rb
-- test/email_alert_api_test.rb
-- test/content_api_test.rb
-- test/response_test.rb
-- test/organisations_api_test.rb
-- test/imminence_api_test.rb
-- test/content_store_test.rb
-- test/asset_manager_test.rb
+- test/pp_data_in_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
-- test/fixtures/world_organisations_australia.json
 - test/fixtures/no_services_and_info_data_found_fixture.json
-- test/fixtures/old_policies_for_dwp.json
 - test/fixtures/services_and_info_fixture.json
+- test/fixtures/old_policies_for_dwp.json
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/sub_sector_organisations.json
 - test/fixtures/finder_api/cma-case-schema.json
-- test/router_test.rb
-- test/list_response_test.rb
-- test/external_link_tracker_test.rb
-- test/gds_api_base_test.rb
 - test/worldwide_api_test.rb
-- test/test_helper.rb
-- test/publishing_api_v2_test.rb
-- test/business_support_api_test.rb
+- test/test_helpers/publishing_api_test.rb
+- test/test_helpers/publishing_api_v2_test.rb
+- test/test_helpers/pact_helper.rb
+- test/test_helpers/panopticon_test.rb
+- test/test_helpers/email_alert_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/imminence_api_test.rb
+- test/email_alert_api_test.rb
+- test/response_test.rb
+- test/rummager_test.rb
+has_rdoc: