gds-api-adapters 79.1.1 → 80.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56aec1e3622b0974b51878653be4dfc833cc7e4bb8668c788e19ba38666dbffe
-  data.tar.gz: defee880c91c2c1ed568c5320a051ad938f6e1bb5a0d9a9e2f9ac705bc3c616a
+  metadata.gz: 1f6921e5174a36bd20b7d8f6a446d4764778acac96e707108ed4fd581d8261e8
+  data.tar.gz: 00b4f87f11ee027458c97f21216c43ba42ad371faedbc1ce4e3cb5d886b32126
 SHA512:
-  metadata.gz: 2aa101d336e0151c5517bb15e7126489fd44cfbd9da7683f34a74865bf5f62ba051075feb990c22ed3cd34022ac5d5e120bb9924d3f116fc32ab1498bbda6db2
-  data.tar.gz: 5d50b8fb50c41d00b1e99a500dffb3969a43d33d6df7bf7d6693a383ca1226e35b91b5d5072880a9b57cd41727225233d520110876efabbcd8f119ebf83e67df
+  metadata.gz: 62c4ee4274480082f184e019de3307961b94b2e14840a5e7a9ddf82c1521bc35e66586414bf6a5465e1e06c0c3213194945c84ad48ea0801f8f5e430bb8b2280
+  data.tar.gz: 26baf319e1e5a0072692b570330bb0bb44fbf17d9f2fb43765f39ae9307ecb7c0ca25da823d30e960f5100362d645d47fce8e3717a4667f3533e4dd9615b3748

data/lib/gds_api/locations_api.rb

@@ -8,7 +8,7 @@ class GdsApi::LocationsApi < GdsApi::Base
   #
   # @return [Array] All local custodian codes for a specific postcode
   def local_custodian_code_for_postcode(postcode)
-    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+    response = get_json("#{endpoint}/v1/locations?postcode=#{postcode}")
 
     return [] if response["results"].nil?
 
@@ -21,7 +21,7 @@ class GdsApi::LocationsApi < GdsApi::Base
   #
   # @return [Hash] The average coordinates (two fields, "latitude" and "longitude") for a specific postcode
   def coordinates_for_postcode(postcode)
-    response = get_json("#{endpoint}/locations?postcode=#{postcode}.json")
+    response = get_json("#{endpoint}/v1/locations?postcode=#{postcode}")
 
     { "latitude" => response["average_latitude"], "longitude" => response["average_longitude"] } unless response["results"].nil?
   end

data/lib/gds_api/publishing_api.rb

@@ -4,8 +4,8 @@ require_relative "exceptions"
 # 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/model.md
+# @see https://github.com/alphagov/publishing-api/blob/main/docs/publishing-application-examples.md
+# @see https://github.com/alphagov/publishing-api/blob/main/docs/model.md
 # @api documented
 class GdsApi::PublishingApi < GdsApi::Base
   class NoLiveVersion < GdsApi::BaseError; end
@@ -15,7 +15,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @param content_id [UUID]
   # @param payload [Hash] A valid content item
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-v2contentcontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#put-v2contentcontent_id
   def put_content(content_id, payload)
     put_json(content_url(content_id), payload)
   end
@@ -31,7 +31,7 @@ class GdsApi::PublishingApi < 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/api.md#get-v2contentcontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_id
   def get_content(content_id, params = {})
     get_json(content_url(content_id, params))
   end
@@ -46,7 +46,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @return [GdsApi::Response] a content item
   #
   # @raise [NoLiveVersion] when the content item is not found
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2contentcontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2contentcontent_id
   def get_live_content(content_id, locale = "en")
     content_item = get_content(content_id, locale: locale)
 
@@ -71,7 +71,7 @@ class GdsApi::PublishingApi < 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/api.md#post-lookup-by-base-path
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-lookup-by-base-path
   def lookup_content_ids(base_paths:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
     options = { base_paths: base_paths }
     options[:exclude_document_types] = exclude_document_types if exclude_document_types
@@ -98,7 +98,7 @@ class GdsApi::PublishingApi < 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/api.md#post-lookup-by-base-path
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-lookup-by-base-path
   def lookup_content_id(base_path:, exclude_document_types: nil, exclude_unpublishing_types: nil, with_drafts: false)
     lookups = lookup_content_ids(
       base_paths: [base_path],
@@ -119,7 +119,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @param options [Hash]
   # @option options [String] locale The language, defaults to 'en' in publishing-api.
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idpublish
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-v2contentcontent_idpublish
   def publish(content_id, update_type = nil, options = {})
     params = {
       update_type: update_type,
@@ -150,23 +150,6 @@ class GdsApi::PublishingApi < GdsApi::Base
     post_json(republish_url(content_id), params)
   end
 
-  # Import content into the publishing API
-  #
-  # The publishing-api will delete any content which has the content
-  # id provided, and then import the data given.
-  #
-  # @param content_id [UUID]
-  # @param content_items [Array]
-  #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idimport
-  def import(content_id, locale, content_items)
-    params = {
-      history: content_items,
-    }
-
-    post_json("#{endpoint}/v2/content/#{content_id}/import?locale=#{locale}", params)
-  end
-
   # Unpublish a content item
   #
   # The publishing API will "unpublish" a live item, to remove it from the public
@@ -182,7 +165,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @param unpublished_at [Time] (optional) The time the content was withdrawn. Ignored for types other than withdrawn
   # @param redirects [Array] (optional) Required if no alternative_path is given. An array of redirect values, ie: { path:, type:, destination: }
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idunpublish
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-v2contentcontent_idunpublish
   def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, locale: nil, unpublished_at: nil, redirects: nil)
     params = {
       type: type,
@@ -208,7 +191,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @option options [String] locale The language, defaults to 'en' in publishing-api.
   # @option options [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/api.md#post-v2contentcontent_iddiscard-draft
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#post-v2contentcontent_iddiscard-draft
   def discard_draft(content_id, options = {})
     optional_keys = %i[locale previous_version]
 
@@ -237,7 +220,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     "version" => 17
   #   }
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkscontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2linkscontent_id
   def get_links(content_id)
     get_json(links_url(content_id))
   end
@@ -288,7 +271,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     }
   #   }
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2expanded-linkscontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2expanded-linkscontent_id
   def get_expanded_links(content_id, locale: nil, with_drafts: true, generate: false)
     params = {}
     params[:with_drafts] = "false" unless with_drafts
@@ -318,7 +301,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     bulk_publishing: true
   #   )
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#patch-v2linkscontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#patch-v2linkscontent_id
   def patch_links(content_id, params)
     payload = {
       links: params.fetch(:links),
@@ -348,7 +331,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     order: '-public_updated_at'
   #   )
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2content
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2content
   def get_content_items(params)
     query = query_string(params)
     get_json("#{endpoint}/v2/content#{query}")
@@ -361,7 +344,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #
   # @return [Enumerator] an enumerator of content items
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2content
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2content
   def get_content_items_enum(params)
     Enumerator.new do |yielder|
       (1..Float::INFINITY).each do |index|
@@ -378,7 +361,7 @@ class GdsApi::PublishingApi < GdsApi::Base
 
   # FIXME: Add documentation
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkables
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2linkables
   def get_linkables(document_type: nil)
     if document_type.nil?
       raise ArgumentError, "Please provide a `document_type`"
@@ -389,7 +372,7 @@ class GdsApi::PublishingApi < GdsApi::Base
 
   # FIXME: Add documentation
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkedcontent_id
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2linkedcontent_id
   def get_linked_items(content_id, params = {})
     query = query_string(params)
     validate_content_id(content_id)
@@ -403,7 +386,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #
   # @return [GdsApi::Response] a paginated list of editions
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2editions
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2editions
   def get_editions(params = {})
     get_json(get_editions_url(params))
   end
@@ -415,7 +398,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #
   # @return [Enumerator] an enumerator of editions responses
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2editions
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#get-v2editions
   def get_paged_editions(params = {})
     Enumerator.new do |yielder|
       next_link = get_editions_url(params)
@@ -488,7 +471,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #   }
   # )
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-publish-intentbase_path
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#put-publish-intentbase_path
   def put_intent(base_path, payload)
     put_json(intent_url(base_path), payload)
   end
@@ -497,7 +480,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #
   # @param base_path [String]
   #
-  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#delete-publish-intentbase_path
+  # @see https://github.com/alphagov/publishing-api/blob/main/docs/api.md#delete-publish-intentbase_path
   def destroy_intent(base_path)
     delete_json(intent_url(base_path))
   rescue GdsApi::HTTPNotFound => e

data/lib/gds_api/test_helpers/locations_api.rb

@@ -20,17 +20,17 @@ module GdsApi
           "results" => results,
         }
 
-        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/v1/locations?postcode=#{postcode}")
           .to_return(body: response.to_json, status: 200)
       end
 
       def stub_locations_api_has_no_location(postcode)
-        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/v1/locations?postcode=#{postcode}")
           .to_return(body: { "results" => nil }.to_json, status: 200)
       end
 
       def stub_locations_api_does_not_have_a_bad_postcode(postcode)
-        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/locations?postcode=#{postcode}.json")
+        stub_request(:get, "#{LOCATIONS_API_ENDPOINT}/v1/locations?postcode=#{postcode}")
          .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
       end
     end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "79.1.1".freeze
+  VERSION = "80.0.0".freeze
 end

data/lib/gds_api.rb

@@ -116,6 +116,13 @@ module GdsApi
     GdsApi::LocalLinksManager.new(Plek.find("local-links-manager"), options)
   end
 
+  # Creates a GdsApi::LocationsApi adapter
+  #
+  # @return [GdsApi::LocationsApi]
+  def self.locations_api(options = {})
+    GdsApi::LocationsApi.new(Plek.find("locations-api"), options)
+  end
+
   # Creates a GdsApi::Mapit adapter
   #
   # @return [GdsApi::Mapit]
@@ -202,11 +209,4 @@ module GdsApi
   def self.worldwide(options = {})
     GdsApi::Worldwide.new(Plek.new.website_root, options)
   end
-
-  # Creates a GdsApi::LocationsApi adapter
-  #
-  # @return [GdsApi::LocationsApi]
-  def self.locations_api(options = {})
-    GdsApi::LocationsApi.new(Plek.find("locations-api"), options)
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 79.1.1
+  version: 80.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable