gds-api-adapters 63.6.0 → 67.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c63bd76ee4646694f763c71980fcce76ae359bfd12ad2de8437679eb0f389422
-  data.tar.gz: 5729acfdc3d52d7fd1c7e053a7740bc09424006088e6ce0631fed2144479e267
+  metadata.gz: b9e99044909467134a19c5e0f273908fd94afbe72a40f50a5d81dfd4bf467d28
+  data.tar.gz: 0535e351b0d6899aa363f61bcd8c0ab9b3137389b4279bf9ff195250773c087d
 SHA512:
-  metadata.gz: 7676cf189a66b0b699c08ae50605a4f481da8b775201876e641167b49d7a6fc33a2139c97f4b7d0801af335e3c32929afc7bb8c6cc562cd2999c889f7603f5c3
-  data.tar.gz: 2c9f91be586e98a61e91dccf0c8bb66a9db31d1bbac59eccabf13e7fc8689f169126907d15a50ad483cb5605934240438ce5e2fbd97243511718be2278e7c359
+  metadata.gz: 796c442ffe778c4377f476db1fdae0d52592c776687aa4d52bc4e3e7f3f3a33fe7cd9e48e40af52e532943fe5b0549cf335ae516d7d4dd149e767f26b7142b7c
+  data.tar.gz: 3b37865fca30c9e7ff47bd9e8f64fe4579065b48a325eb59cad29a4722170873049c16373f4708c9601e015269875de3ec88612d2a84d64943337e6494aea9fa

data/README.md

@@ -5,7 +5,6 @@ A set of API adapters to work with the GDS APIs.
 Example usage:
 
 ```ruby
-require 'gds_api/publishing_api'
 GdsApi.publishing_api.get_content("f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a")
 ```
 

data/Rakefile

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require "rdoc/task"
 require "rake/testtask"
 
@@ -13,7 +11,8 @@ Rake::TestTask.new("test") do |t|
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end
-task default: :test
+
+task default: %i[lint test]
 
 require "pact_broker/client/tasks"
 
@@ -31,5 +30,5 @@ end
 
 desc "Run the linter against changed files"
 task :lint do
-  sh "bundle exec rubocop --format clang lib test"
+  sh "bundle exec rubocop --format clang"
 end

data/lib/gds_api.rb

@@ -1,4 +1,6 @@
+require "addressable"
 require "plek"
+require "time"
 require "gds_api/asset_manager"
 require "gds_api/calendars"
 require "gds_api/content_store"
@@ -11,7 +13,6 @@ require "gds_api/mapit"
 require "gds_api/maslow"
 require "gds_api/organisations"
 require "gds_api/publishing_api"
-require "gds_api/publishing_api_v2"
 require "gds_api/router"
 require "gds_api/search"
 require "gds_api/support"
@@ -139,19 +140,6 @@ module GdsApi
     )
   end
 
-  # Creates a GdsApi::PublishingApiV2 adapter
-  #
-  # This will set a bearer token if a PUBLISHING_API_BEARER_TOKEN environment
-  # variable is set
-  #
-  # @return [GdsApi::PublishingApiV2]
-  def self.publishing_api_v2(options = {})
-    GdsApi::PublishingApiV2.new(
-      Plek.find("publishing-api"),
-      { bearer_token: ENV["PUBLISHING_API_BEARER_TOKEN"] }.merge(options),
-    )
-  end
-
   # Creates a GdsApi::Router adapter for communicating with Router API
   #
   # This will set a bearer token if a ROUTER_API_BEARER_TOKEN environment

data/lib/gds_api/asset_manager.rb

@@ -136,7 +136,7 @@ class GdsApi::AssetManager < GdsApi::Base
   #
   # @raise [HTTPErrorResponse] if the request returns an error
   def whitehall_asset(legacy_url_path)
-    get_json("#{base_url}/whitehall_assets/#{Addressable::URI.encode(legacy_url_path)}")
+    get_json("#{base_url}/whitehall_assets/#{uri_encode(legacy_url_path)}")
   end
 
   # Updates an asset given a hash with one +file+ attribute

data/lib/gds_api/base.rb

@@ -24,7 +24,8 @@ class GdsApi::Base
                  :put_json,
                  :patch_json,
                  :delete_json,
-                 :get_raw, :get_raw!,
+                 :get_raw,
+                 :get_raw!,
                  :put_multipart,
                  :post_multipart
 
@@ -69,9 +70,9 @@ private
     param_pairs = params.sort.map { |key, value|
       case value
       when Array
-        value.map { |v|
+        value.map do |v|
           "#{CGI.escape(key.to_s + '[]')}=#{CGI.escape(v.to_s)}"
-        }
+        end
       else
         "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
       end
@@ -79,4 +80,8 @@ private
 
     "?#{param_pairs.join('&')}"
   end
+
+  def uri_encode(param)
+    Addressable::URI.encode(param.to_s)
+  end
 end

data/lib/gds_api/email_alert_api.rb

@@ -101,7 +101,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @return [nil]
   def unsubscribe(uuid)
-    post_json("#{endpoint}/unsubscribe/#{uuid}")
+    post_json("#{endpoint}/unsubscribe/#{uri_encode(uuid)}")
   end
 
   # Unsubscribe subscriber from everything
@@ -110,18 +110,19 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @return [nil]
   def unsubscribe_subscriber(id)
-    delete_json("#{endpoint}/subscribers/#{id}")
+    delete_json("#{endpoint}/subscribers/#{uri_encode(id)}")
   end
 
   # Subscribe
   #
   # @return [Hash] subscription_id
-  def subscribe(subscriber_list_id:, address:, frequency: "immediately")
+  def subscribe(subscriber_list_id:, address:, frequency: "immediately", skip_confirmation_email: false)
     post_json(
       "#{endpoint}/subscriptions",
       subscriber_list_id: subscriber_list_id,
       address: address,
       frequency: frequency,
+      skip_confirmation_email: skip_confirmation_email,
     )
   end
 
@@ -141,7 +142,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #  subscriber_count
   # }
   def get_subscriber_list(slug:)
-    get_json("#{endpoint}/subscriber-lists/#{slug}")
+    get_json("#{endpoint}/subscriber-lists/#{uri_encode(slug)}")
   end
 
   # Get a Subscription
@@ -158,7 +159,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #  source
   # }
   def get_subscription(id)
-    get_json("#{endpoint}/subscriptions/#{id}")
+    get_json("#{endpoint}/subscriptions/#{uri_encode(id)}")
   end
 
   # Get the latest Subscription that has the same subscriber_list
@@ -177,7 +178,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #  source
   # }
   def get_latest_matching_subscription(id)
-    get_json("#{endpoint}/subscriptions/#{id}/latest")
+    get_json("#{endpoint}/subscriptions/#{uri_encode(id)}/latest")
   end
 
   # Get Subscriptions for a Subscriber
@@ -188,9 +189,9 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @return [Hash] subscriber, subscriptions
   def get_subscriptions(id:, order: nil)
     if order
-      get_json("#{endpoint}/subscribers/#{id}/subscriptions?order=#{order}")
+      get_json("#{endpoint}/subscribers/#{uri_encode(id)}/subscriptions?order=#{uri_encode(order)}")
     else
-      get_json("#{endpoint}/subscribers/#{id}/subscriptions")
+      get_json("#{endpoint}/subscribers/#{uri_encode(id)}/subscriptions")
     end
   end
 
@@ -202,7 +203,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @return [Hash] subscriber
   def change_subscriber(id:, new_address:)
     patch_json(
-      "#{endpoint}/subscribers/#{id}",
+      "#{endpoint}/subscribers/#{uri_encode(id)}",
       new_address: new_address,
     )
   end
@@ -215,7 +216,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @return [Hash] subscription
   def change_subscription(id:, frequency:)
     patch_json(
-      "#{endpoint}/subscriptions/#{id}",
+      "#{endpoint}/subscriptions/#{uri_encode(id)}",
       frequency: frequency,
     )
   end
@@ -224,16 +225,14 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @param [string]       address       Address to send verification email to
   # @param [string]       destination   Path on GOV.UK that subscriber will be emailed
-  # @param [string, nil]  redirect      Path on GOV.UK to be encoded into the token for redirecting
   #
   # @return [Hash]  subscriber
   #
-  def send_subscriber_verification_email(address:, destination:, redirect: nil)
+  def send_subscriber_verification_email(address:, destination:)
     post_json(
       "#{endpoint}/subscribers/auth-token",
       address: address,
       destination: destination,
-      redirect: redirect,
     )
   end
 

data/lib/gds_api/imminence.rb

@@ -20,8 +20,8 @@ class GdsApi::Imminence < GdsApi::Base
   end
 
   def self.parse_place_hash(place_hash)
-    location = self.extract_location_hash(place_hash["location"])
-    address = self.extract_address_hash(place_hash)
+    location = extract_location_hash(place_hash["location"])
+    address = extract_address_hash(place_hash)
 
     place_hash.merge(location).merge(address)
   end
@@ -31,7 +31,7 @@ class GdsApi::Imminence < GdsApi::Base
   end
 
   def areas_for_postcode(postcode)
-    url = "#{@endpoint}/areas/#{ERB::Util.url_encode(postcode)}.json"
+    url = "#{@endpoint}/areas/#{uri_encode(postcode)}.json"
     get_json(url)
   end
 

data/lib/gds_api/json_client.rb

@@ -29,7 +29,7 @@ module GdsApi
     end
 
     def self.default_request_with_json_body_headers
-      self.default_request_headers.merge(self.json_body_headers)
+      default_request_headers.merge(json_body_headers)
     end
 
     def self.json_body_headers
@@ -109,7 +109,7 @@ module GdsApi
       end
 
       # If no custom response is given, just instantiate Response
-      create_response ||= Proc.new { |r| Response.new(r) }
+      create_response ||= proc { |r| Response.new(r) }
       create_response.call(response)
     end
 
@@ -177,10 +177,10 @@ module GdsApi
       ::RestClient::Request.execute(method_params)
     rescue Errno::ECONNREFUSED => e
       logger.error loggable.merge(status: "refused", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
-      raise GdsApi::EndpointNotFound.new("Could not connect to #{url}")
+      raise GdsApi::EndpointNotFound, "Could not connect to #{url}"
     rescue RestClient::Exceptions::Timeout => e
       logger.error loggable.merge(status: "timeout", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
-      raise GdsApi::TimedOutException.new
+      raise GdsApi::TimedOutException
     rescue URI::InvalidURIError => e
       logger.error loggable.merge(status: "invalid_uri", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::InvalidUrl
@@ -192,10 +192,10 @@ module GdsApi
       raise
     rescue Errno::ECONNRESET => e
       logger.error loggable.merge(status: "connection_reset", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
-      raise GdsApi::TimedOutException.new
+      raise GdsApi::TimedOutException
     rescue SocketError => e
       logger.error loggable.merge(status: "socket_error", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
-      raise GdsApi::SocketErrorException.new
+      raise GdsApi::SocketErrorException
     end
   end
 end

data/lib/gds_api/list_response.rb

@@ -25,7 +25,7 @@ module GdsApi
     end
 
     def has_next_page?
-      ! page_link("next").nil?
+      !page_link("next").nil?
     end
 
     def next_page
@@ -39,7 +39,7 @@ module GdsApi
     end
 
     def has_previous_page?
-      ! page_link("previous").nil?
+      !page_link("previous").nil?
     end
 
     def previous_page
@@ -70,12 +70,12 @@ module GdsApi
     # point. Note that the responses are stored so subsequent pages will not be
     # loaded multiple times.
     def with_subsequent_pages
-      Enumerator.new { |yielder|
-        self.each do |i| yielder << i end
+      Enumerator.new do |yielder|
+        each { |i| yielder << i }
         if has_next_page?
-          next_page.with_subsequent_pages.each do |i| yielder << i end
+          next_page.with_subsequent_pages.each { |i| yielder << i }
         end
-      }
+      end
     end
 
   private

data/lib/gds_api/performance_platform/data_out.rb

@@ -70,40 +70,40 @@ module GdsApi
 
       def search_terms(slug)
         options = {
-            slug: slug,
-            transaction: "search-terms",
-            group_by: "searchKeyword",
-            collect: "searchUniques:sum",
+          slug: slug,
+          transaction: "search-terms",
+          group_by: "searchKeyword",
+          collect: "searchUniques:sum",
         }
         statistics(options)
       end
 
       def searches(slug, is_multipart)
         options = {
-            slug: slug,
-            transaction: "search-terms",
-            group_by: "pagePath",
-            collect: "searchUniques:sum",
+          slug: slug,
+          transaction: "search-terms",
+          group_by: "pagePath",
+          collect: "searchUniques:sum",
         }
         statistics(options, is_multipart)
       end
 
       def page_views(slug, is_multipart)
         options = {
-            slug: slug,
-            transaction: "page-statistics",
-            group_by: "pagePath",
-            collect: "uniquePageviews:sum",
+          slug: slug,
+          transaction: "page-statistics",
+          group_by: "pagePath",
+          collect: "uniquePageviews:sum",
         }
         statistics(options, is_multipart)
       end
 
       def problem_reports(slug, is_multipart)
         options = {
-            slug: slug,
-            transaction: "page-contacts",
-            group_by: "pagePath",
-            collect: "total:sum",
+          slug: slug,
+          transaction: "page-contacts",
+          group_by: "pagePath",
+          collect: "total:sum",
         }
         statistics(options, is_multipart)
       end
@@ -114,11 +114,11 @@ module GdsApi
       # Backdrop can be found here: https://github.com/alphagov/backdrop
       def statistics(options, is_multipart = false)
         params = {
-            group_by: options[:group_by],
-            collect: options[:collect],
-            duration: 42,
-            period: "day",
-            end_at: Date.today.to_time.getutc.iso8601,
+          group_by: options[:group_by],
+          collect: options[:collect],
+          duration: 42,
+          period: "day",
+          end_at: Date.today.to_time.getutc.iso8601,
         }
 
         filter_param = is_multipart ? :filter_by_prefix : :filter_by

data/lib/gds_api/publishing_api.rb

@@ -381,7 +381,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkables
   def get_linkables(document_type: nil)
     if document_type.nil?
-      raise ArgumentError.new("Please provide a `document_type`")
+      raise ArgumentError, "Please provide a `document_type`"
     end
 
     get_json("#{endpoint}/v2/linkables?document_type=#{document_type}")
@@ -486,7 +486,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     publishing_app: 'content-publisher',
   #     rendering_app: 'government-frontend',
   #   }
-  #)
+  # )
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-publish-intentbase_path
   def put_intent(base_path, payload)

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -19,7 +19,7 @@ module GdsApi
           schema_name: options.fetch(:schema_name, "special_route"),
           title: options.fetch(:title),
           description: options.fetch(:description, ""),
-          locale: "en",
+          locale: options.fetch(:locale, "en"),
           details: {},
           routes: [
             {

data/lib/gds_api/response.rb

@@ -1,6 +1,5 @@
 require "json"
 require "forwardable"
-require "rack/cache"
 
 module GdsApi
   # This wraps an HTTP response with a JSON body.
@@ -21,6 +20,77 @@ module GdsApi
     extend Forwardable
     include Enumerable
 
+    class CacheControl < Hash
+      PATTERN = /([-a-z]+)(?:\s*=\s*([^,\s]+))?,?+/i.freeze
+
+      def initialize(value = nil)
+        parse(value)
+      end
+
+      def public?
+        self["public"]
+      end
+
+      def private?
+        self["private"]
+      end
+
+      def no_cache?
+        self["no-cache"]
+      end
+
+      def no_store?
+        self["no-store"]
+      end
+
+      def must_revalidate?
+        self["must-revalidate"]
+      end
+
+      def proxy_revalidate?
+        self["proxy-revalidate"]
+      end
+
+      def max_age
+        self["max-age"].to_i if key?("max-age")
+      end
+
+      def reverse_max_age
+        self["r-maxage"].to_i if key?("r-maxage")
+      end
+      alias_method :r_maxage, :reverse_max_age
+
+      def shared_max_age
+        self["s-maxage"].to_i if key?("r-maxage")
+      end
+      alias_method :s_maxage, :shared_max_age
+
+      def to_s
+        directives = []
+        values = []
+
+        each do |key, value|
+          if value == true
+            directives << key
+          elsif value
+            values << "#{key}=#{value}"
+          end
+        end
+
+        (directives.sort + values.sort).join(", ")
+      end
+
+    private
+
+      def parse(header)
+        return if header.nil? || header.empty?
+
+        header.scan(PATTERN).each do |name, value|
+          self[name.downcase] = value || true
+        end
+      end
+    end
+
     def_delegators :to_hash, :[], :"<=>", :each, :dig
 
     def initialize(http_response, options = {})
@@ -63,7 +133,7 @@ module GdsApi
     end
 
     def cache_control
-      @cache_control ||= Rack::Cache::CacheControl.new(headers[:cache_control])
+      @cache_control ||= CacheControl.new(headers[:cache_control])
     end
 
     def to_hash
@@ -74,9 +144,13 @@ module GdsApi
       @parsed_content ||= transform_parsed(JSON.parse(@http_response.body))
     end
 
-    def present?; true; end
+    def present?
+      true
+    end
 
-    def blank?; false; end
+    def blank?
+      false
+    end
 
   private
 
@@ -85,7 +159,7 @@ module GdsApi
 
       case value
       when Hash
-        Hash[value.map { |k, v|
+        Hash[value.map do |k, v|
           # NOTE: Don't bother transforming if the value is nil
           if k == "web_url" && v
             # Use relative URLs to route when the web_url value is on the
@@ -98,7 +172,7 @@ module GdsApi
           else
             [k, transform_parsed(v)]
           end
-        }]
+        end]
       when Array
         value.map { |v| transform_parsed(v) }
       else