gds-api-adapters 63.5.1 → 63.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5930ba264b390c501d2bff817dc92bbb5dc575a73aeb4e039639d5dcba8b2834
-  data.tar.gz: 3bd8edada18541fb876dd506d2ba0f230ce3e3d6ec361f6530091ab8519642a5
+  metadata.gz: c63bd76ee4646694f763c71980fcce76ae359bfd12ad2de8437679eb0f389422
+  data.tar.gz: 5729acfdc3d52d7fd1c7e053a7740bc09424006088e6ce0631fed2144479e267
 SHA512:
-  metadata.gz: 54863fb58b2392934961c7db3cff706d5616d98f57eb2a8234e4f54d4f93fb13df2dbd5fb977a80563b4d9c380ea666c07f76cbb77c6e0adaefdf3a5c60896e9
-  data.tar.gz: ee8c87a4a58cd019d8965e3b779bb569145870e1276619215a4d99ab0ef3f780b35a48ed5c5b49eda9de39cf81fd1b3074162ee0977fb7e142351d6375494c60
+  metadata.gz: 7676cf189a66b0b699c08ae50605a4f481da8b775201876e641167b49d7a6fc33a2139c97f4b7d0801af335e3c32929afc7bb8c6cc562cd2999c889f7603f5c3
+  data.tar.gz: 2c9f91be586e98a61e91dccf0c8bb66a9db31d1bbac59eccabf13e7fc8689f169126907d15a50ad483cb5605934240438ce5e2fbd97243511718be2278e7c359

data/README.md

@@ -5,9 +5,8 @@ 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")
+require 'gds_api/publishing_api'
+GdsApi.publishing_api.get_content("f3bbdec2-0e62-4520-a7fd-6ffd5d36e03a")
 ```
 
 Example adapters for frequently used applications:
@@ -39,12 +38,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 +83,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,7 @@
 # -*- encoding: utf-8 -*-
 
 require "rdoc/task"
-require 'rake/testtask'
+require "rake/testtask"
 
 RDoc::Task.new do |rd|
   rd.rdoc_files.include("lib/**/*.rb")
@@ -15,12 +15,12 @@ Rake::TestTask.new("test") do |t|
 end
 task default: :test
 
-require 'pact_broker/client/tasks'
+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
 

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

@@ -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,7 +105,7 @@ 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

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -266,11 +266,11 @@ module GdsApi
       # @param attributes_or_matcher [Object]
       # @param times [Integer]
       def assert_publishing_api(verb, url, attributes_or_matcher = nil, times = 1)
-        if attributes_or_matcher.is_a?(Hash)
-          matcher = request_json_matches(attributes_or_matcher)
-        else
-          matcher = attributes_or_matcher
-        end
+        matcher = if attributes_or_matcher.is_a?(Hash)
+                    request_json_matches(attributes_or_matcher)
+                  else
+                    attributes_or_matcher
+                  end
 
         if matcher
           assert_requested(verb, url, times: times, &matcher)
@@ -684,11 +684,11 @@ module GdsApi
       end
 
       def assert_publishing_api_put(url, attributes_or_matcher = {}, times = 1)
-        if attributes_or_matcher.is_a?(Hash)
-          matcher = attributes_or_matcher.empty? ? nil : request_json_matching(attributes_or_matcher)
-        else
-          matcher = attributes_or_matcher
-        end
+        matcher = if attributes_or_matcher.is_a?(Hash)
+                    attributes_or_matcher.empty? ? nil : request_json_matching(attributes_or_matcher)
+                  else
+                    attributes_or_matcher
+                  end
 
         if matcher
           assert_requested(:put, url, times: times, &matcher)

data/lib/gds_api/test_helpers/search.rb

@@ -17,11 +17,11 @@ module GdsApi
       end
 
       def assert_search_posted_item(attributes, index: nil, **options)
-        if index
-          url = SEARCH_ENDPOINT + "/#{index}/documents"
-        else
-          url = SEARCH_ENDPOINT + "/documents"
-        end
+        url = if index
+                SEARCH_ENDPOINT + "/#{index}/documents"
+              else
+                SEARCH_ENDPOINT + "/documents"
+              end
 
         assert_requested(:post, url, **options) do |req|
           data = JSON.parse(req.body)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "63.5.1".freeze
+  VERSION = "63.6.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 63.5.1
+  version: 63.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -457,7 +457,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="