gds-api-adapters 79.1.2 → 80.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659e2cb6bd909708fb12456695cc971240b79685ad35181bec90a365354c8dd9
-  data.tar.gz: 6e995ea0a6b68dc218a2eb05f0eabb9a413a4dbfffcc34745795cd20fdc6802b
+  metadata.gz: d176cb409b66bc4df5c376c244660cd23fe992e70fa982b3d3403638a97855e4
+  data.tar.gz: 507564fc5d9cde9f3bcb9d20ef056a273dd1ff6f7f79a7e4631141cd46ed92bb
 SHA512:
-  metadata.gz: dde1459c2c812098ea2d830088970369ba1b9e87347b590d45a2e3be85551f8a833fb851e55c9f82079ebd749c1eda001d364ca07822005046f437b3101f61a6
-  data.tar.gz: d1a063b5239d0b4cf0e15c1fe90c1034358c5bd326942b2b778ea4b89923621f510816700af21eee0b71115f31e5dfa8997a982b29fbaeeefdb19a35b37a5f83
+  metadata.gz: 18f2478cee5688ec61a3c55b4f010b6bc1dd663929b8313b17affbc4056f78825e008a448242c30668a4acd0cd6fbbc118df4eb691bfa913f5aba76461cbe017
+  data.tar.gz: 3ecfd09796febbb411404015894024df599b2edb733a0658d730057f5c90e9a60926fa1bfd73a9c258db0a6e24282c41e9d548ba7a04b161f1d39550f827b10b

data/lib/gds_api/email_alert_api.rb

@@ -252,7 +252,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # optionally send a notification email explaining the reason
   #
   # @param [string]               slug                  Identifier for the subscription list
-  # @param [string] (optional)    govuk_request_id      An ID allowing us to trace requests across our infra. Required if you want to send an email.
+  # @param [string] (optional)    govuk_request_id      An ID allowing us to trace requests across our infra. Required if you want to send an email by running out-of-band processes via asynchronous workers.
   # @param [string] (optional)    body                  Optional email body to send to alert users they are being unsubscribed. Required if you want to send an email
   # @param [string] (optional)    sender_message_id     A UUID to prevent multiple emails for the same event. Required if you want to send an email.
   def bulk_unsubscribe(slug:, govuk_request_id: nil, body: nil, sender_message_id: nil)

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/email_alert_api.rb

@@ -413,15 +413,15 @@ module GdsApi
           .to_return(status: 202)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 202)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 202)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_not_found(slug:)
@@ -429,15 +429,15 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 404)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 404)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_conflict(slug:)
@@ -445,15 +445,15 @@ module GdsApi
           .to_return(status: 409)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 409)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 409)
       end
 
       def stub_email_alert_api_bulk_unsubscribe_bad_request(slug:)
@@ -461,15 +461,15 @@ module GdsApi
           .to_return(status: 422)
       end
 
-      def stub_email_alert_api_bulk_unsubscribe_bad_request_with_message(slug:, govuk_request_id:, body:, sender_message_id:)
+      def stub_email_alert_api_bulk_unsubscribe_bad_request_with_message(slug:, body:, sender_message_id:, govuk_request_id: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{slug}/bulk-unsubscribe")
-        .with(
+        .with({
           body: {
             body: body,
             sender_message_id: sender_message_id,
           }.to_json,
-          headers: { "Govuk-Request-Id" => govuk_request_id },
-        ).to_return(status: 422)
+        }.tap { |attr| attr[:headers] = { "Govuk-Request-Id" => govuk_request_id } if govuk_request_id })
+        .to_return(status: 422)
       end
 
       def stub_update_subscriber_list_details(slug:, params:)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "79.1.2".freeze
+  VERSION = "80.0.1".freeze
 end

metadata

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