gds-api-adapters 67.0.0 → 67.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ee9f533f626d99fe8f62ae41b6445e2f75729c333b096c52b90c49555e1d69
-  data.tar.gz: b1413571e9e8bf09d19497c88790549c947c66258fd25bd11884a6ade859acdf
+  metadata.gz: 4f4e9476c570389a75e06b65715133d92402d748e4b15fd0b30782a7eca32847
+  data.tar.gz: e1e5d3284178b1f22f29dc63d1cf0fde389c82224f56146d6db40304fa211ca0
 SHA512:
-  metadata.gz: b05108e31ccb65d3c2e4735792de423580f2cdbb2ea8d8d0c6de92955b24084559f7e25b6aaed2cbca34b17734d37f2f9df98a5f8d676bcf8e072dc3880aef2b
-  data.tar.gz: 37ff704afc41d4b516ee043358099d9aadc4097ab0d6f70f47a3c38ed922e29d22c0f3b82a1bcac612c53af8c9649a72066709ddf8134ffe1279125f4e81d62f
+  metadata.gz: 392d0964f21b56895aab0fb54a0a566b4c7186f69dbbefa85a31001a255d6cd3a296e982c72df36cc538f93c7beda156430945b86c626a66a50aa35cef29f7b3
+  data.tar.gz: 9a41486139d341afcd11559b40407c6bf58836e4aad2f15dce2380297da40e9edb2ef29176410708d067ed692672c54de5cee1b4e455176d4b455682398f30eb

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"

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

@@ -80,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

@@ -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/publishing_api/special_route_publisher.rb

@@ -12,6 +12,9 @@ module GdsApi
       def publish(options)
         logger.info("Publishing #{options.fetch(:type)} route #{options.fetch(:base_path)}, routing to #{options.fetch(:rendering_app)}")
 
+        update_type = options.fetch(:update_type, "major")
+        locale = options.fetch(:locale, "en")
+
         put_content_response = publishing_api.put_content(
           options.fetch(:content_id),
           base_path: options.fetch(:base_path),
@@ -19,7 +22,7 @@ module GdsApi
           schema_name: options.fetch(:schema_name, "special_route"),
           title: options.fetch(:title),
           description: options.fetch(:description, ""),
-          locale: "en",
+          locale: locale,
           details: {},
           routes: [
             {
@@ -30,11 +33,11 @@ module GdsApi
           publishing_app: options.fetch(:publishing_app),
           rendering_app: options.fetch(:rendering_app),
           public_updated_at: time.now.iso8601,
-          update_type: options.fetch(:update_type, "major"),
+          update_type: update_type,
         )
 
         publishing_api.patch_links(options.fetch(:content_id), links: options[:links]) if options[:links]
-        publishing_api.publish(options.fetch(:content_id))
+        publishing_api.publish(options.fetch(:content_id), update_type, locale: locale)
         put_content_response
       end
 

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

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -98,9 +98,9 @@ module GdsApi
         subscriptions.each do |id, params|
           latest_id, latest_params = get_latest_matching(params, subscriptions)
           stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}")
-            .to_return(status: 200, body: get_subscription_response(id, params).to_json)
+            .to_return(status: 200, body: get_subscription_response(id, **params).to_json)
           stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}/latest")
-            .to_return(status: 200, body: get_subscription_response(latest_id, latest_params).to_json)
+            .to_return(status: 200, body: get_subscription_response(latest_id, **latest_params).to_json)
         end
       end
 
@@ -218,24 +218,37 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      def stub_email_alert_api_creates_a_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
+      def stub_email_alert_api_creates_a_subscription(subscriber_list_id, address, frequency, returned_subscription_id, skip_confirmation_email: false)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
-          ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
+            body: {
+              subscriber_list_id: subscriber_list_id,
+              address: address,
+              frequency: frequency,
+              skip_confirmation_email: skip_confirmation_email,
+            }.to_json,
+          ).to_return(status: 201, body: { id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_creates_an_existing_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
-          ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
+            body: hash_including(
+              subscriber_list_id: subscriber_list_id,
+              address: address,
+              frequency: frequency,
+            ),
+          ).to_return(status: 200, body: { id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
+            body: hash_including(
+              subscriber_list_id: subscriber_list_id,
+              address: address,
+              frequency: frequency,
+            ),
           ).to_return(status: 422)
       end
 
@@ -324,7 +337,7 @@ module GdsApi
             "id" => id,
             "frequency" => frequency,
             "source" => "user_signed_up",
-            "ended_at" => ended ? Time.now.to_datetime.rfc3339 : nil,
+            "ended_at" => ended ? Time.now.iso8601 : nil,
             "ended_reason" => ended ? "unsubscribed" : nil,
             "subscriber" => {
               "id" => subscriber_id,

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -394,9 +394,11 @@ module GdsApi
       # Stub GET /v2/content/:content_id to return a 404 response
       #
       # @param content_id [UUID]
-      def stub_publishing_api_does_not_have_item(content_id)
+      def stub_publishing_api_does_not_have_item(content_id, params = {})
         url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
-        stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "content item").to_json, headers: {})
+        stub_request(:get, url)
+          .with(query: hash_including(params))
+          .to_return(status: 404, body: resource_not_found(content_id, "content item").to_json, headers: {})
       end
 
       # Stub a request to links endpoint

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "67.0.0".freeze
+  VERSION = "67.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 67.0.0
+  version: 67.2.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.0
-- !ruby/object:Gem::Dependency
-  name: rack-cache
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: pact
   requirement: !ruby/object:Gem::Requirement
@@ -179,47 +165,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.20'
 - !ruby/object:Gem::Dependency
-  name: pact-consumer-minitest
+  name: pact_broker-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: pact-mock_service
+  name: pact-consumer-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: pact_broker-client
+  name: pact-mock_service
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -461,7 +447,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs