gds-api-adapters 63.4.0 → 67.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d2ac699458ff698449cf7f1b853386a53cfc5f7c6cfa27b035619f4519a317
-  data.tar.gz: b0602b61f003e2783b1c1316c94b211b33f141286d5f198c0536f2ba05d77156
+  metadata.gz: 98cbc4b338641aff5589875074e2fb2d6ef4227a004f04855cfffbf9c0eb5348
+  data.tar.gz: 5934de7d813457a5cf01c026ff91bed99445492a43df9c9704abc123db140c7d
 SHA512:
-  metadata.gz: a82622969113834480c212952fddb7dc006092be6e59a328426f3a2bc3425ca49887d7652088c65e3e8722bc3a60137e337382f0f2a8cecfb08aa814aed788d8
-  data.tar.gz: b6aa5456c1c18ee1facaff816f5bac337f057cf441688bd20cfb0d33fd4d326706a57b4c0feae4e8304e2a436feb693c67a12b0afaf54f98cc823030e6bb92e9
+  metadata.gz: 00bab1a4b50de5937794758bbdca11c093d3d58c147fed73cb1c3ad89c0c1a9c8d4e2cac2691a31540d9d5c1f92de9a413c25b339a1430dbc367e7f5649afe08
+  data.tar.gz: 14a690b77a277f543b800d48da87cac0c78e6edaf2ced0e04a5f9244104707b3f3cf34e77f9cba0cd39e3fca0c53a2672659a17b00611d575d28c43bd25d236b

data/README.md

@@ -5,9 +5,7 @@ A set of API adapters to work with the GDS APIs.
 Example usage:
 
 ```ruby
-require 'gds_api/search'
-search = GdsApi::Search.new(Plek.new.find('search))
-results = search.search(q: "taxes")
+GdsApi.publishing_api.get_content("f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a")
 ```
 
 Example adapters for frequently used applications:
@@ -39,12 +37,11 @@ GdsApi::Base.logger = Logger.new("/path/to/file.log")
 ## Setting the timeout
 
 By default the JsonClient timeout is set to 4 seconds. If this is exceeded a
-`GdsApi::TimedOutException` will be raised. Individual clients may decide to
-override this timeout. Alternatively, you can override this in the application
+`GdsApi::TimedOutException` will be raised. You can override this by doing:
 that uses the adapter with:
 
 ```ruby
-Services.publishing_api.client.options[:timeout] = number_of_seconds
+adapter = GdsApi.publishing_api(timeout: <number_of_seconds>)
 ```
 
 In most cases, there is an upper-limit of 30 seconds imposed by the app server
@@ -85,23 +82,6 @@ There are also test helpers for stubbing various requests in other apps.
 
 See [all the test helpers in lib/gds_api/test_helpers](/lib/gds_api/test_helpers).
 
-### Dependencies
-
-Some of the helpers come with additional dependencies that you'll need to
-have installed and configured in your consuming app/lib.
-
-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/Rakefile

@@ -1,7 +1,5 @@
-# -*- encoding: utf-8 -*-
-
 require "rdoc/task"
-require 'rake/testtask'
+require "rake/testtask"
 
 RDoc::Task.new do |rd|
   rd.rdoc_files.include("lib/**/*.rb")
@@ -13,14 +11,15 @@ Rake::TestTask.new("test") do |t|
   t.test_files = FileList["test/**/*_test.rb"]
   t.warning = false
 end
-task default: :test
 
-require 'pact_broker/client/tasks'
+task default: %i[lint test]
+
+require "pact_broker/client/tasks"
 
 def configure_pact_broker_location(task)
   task.pact_broker_base_url = ENV.fetch("PACT_BROKER_BASE_URL")
-  if ENV['PACT_BROKER_USERNAME']
-    task.pact_broker_basic_auth = { username: ENV['PACT_BROKER_USERNAME'], password: ENV['PACT_BROKER_PASSWORD'] }
+  if ENV["PACT_BROKER_USERNAME"]
+    task.pact_broker_basic_auth = { username: ENV["PACT_BROKER_USERNAME"], password: ENV["PACT_BROKER_PASSWORD"] }
   end
 end
 
@@ -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
@@ -197,6 +185,6 @@ module GdsApi
   #
   # @return [GdsApi::Worldwide]
   def self.worldwide(options = {})
-    GdsApi::Worldwide.new(Plek.find("whitehall-frontend"), options)
+    GdsApi::Worldwide.new(Plek.new.website_root, options)
   end
 end

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,7 +110,7 @@ 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
@@ -141,7 +141,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 +158,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 +177,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 +188,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 +202,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 +215,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

data/lib/gds_api/exceptions.rb

@@ -22,11 +22,10 @@ module GdsApi
   class HTTPErrorResponse < BaseError
     attr_accessor :code, :error_details
 
-    def initialize(code, message = nil, error_details = nil, request_body = nil)
+    def initialize(code, message = nil, error_details = nil)
       super(message)
       @code = code
       @error_details = error_details
-      @request_body = request_body
     end
   end
 
@@ -53,8 +52,8 @@ module GdsApi
   class HTTPGatewayTimeout < HTTPIntermittentServerError; end
 
   module ExceptionHandling
-    def build_specific_http_error(error, url, details = nil, request_body = nil)
-      message = "URL: #{url}\nResponse body:\n#{error.http_body}\n\nRequest body:\n#{request_body}"
+    def build_specific_http_error(error, url, details = nil)
+      message = "URL: #{url}\nResponse body:\n#{error.http_body}"
       code = error.http_code
       error_class_for_code(code).new(code, message, details)
     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
@@ -83,7 +83,7 @@ module GdsApi
     def do_raw_request(method, url, params = nil)
       do_request(method, url, params)
     rescue RestClient::Exception => e
-      raise build_specific_http_error(e, url, nil, params)
+      raise build_specific_http_error(e, url, nil)
     end
 
     # method: the symbolic name of the method to use, e.g. :get, :post
@@ -105,11 +105,11 @@ module GdsApi
                         rescue JSON::ParserError
                           nil
                         end
-        raise build_specific_http_error(e, url, error_details, params)
+        raise build_specific_http_error(e, url, error_details)
       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