gds-api-adapters 38.0.0 → 38.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23123cc90f6e6077cdf5a7de6e74d907edc342ff
-  data.tar.gz: ee93d8020f7a0fe4ed2e5423ba74b0aae2fd1ba5
+  metadata.gz: 3cb1959cc394a5171ec4c09c0b3f5b1a39dde285
+  data.tar.gz: d025956a6c6d34a8e0d68e92c6d0bb75ec5cdcc3
 SHA512:
-  metadata.gz: d3c79f7ac64677d81e32ce74c4d902f0c20df897a64d5f707cafb8e4277a65d837cd39423b00b234e521693e56e3bf99ab25279ecf35ab1986c8869314df7faf
-  data.tar.gz: 0366d6b00750732521a469f260bac9323698f7b6d14986c86267e44adbe63a7d7f726728c4c324d14c141b87e8e50f2cc3ac40bb26a1ba7eda9fe803a38b84ef
+  metadata.gz: e24a262a3fceb9f36fb7be05f6cef07d05d8ae64a2c77d70e9ca1dbec1aa6c89df9d1bc5035816c3ec7565328de683bab04cf19e555f9cfabe546c36e00f43a2
+  data.tar.gz: efcd72026df90795fb2b8b1edb1d8bdd55a7fa5d5ddf0ce3c69d545edec36ff78f26ef78681acefd9e4c249b881d69961b42b47a7dcb40126aef64e9f62f98d4

data/Rakefile

@@ -14,23 +14,23 @@ Rake::TestTask.new("test") do |t|
   t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
-task :default => :test
+task default: :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']}
+    task.pact_broker_basic_auth = { username: ENV['PACT_BROKER_USERNAME'], password: ENV['PACT_BROKER_PASSWORD'] }
   end
 end
 
-PactBroker::Client::PublicationTask.new("branch") do | task |
+PactBroker::Client::PublicationTask.new("branch") do |task|
   task.consumer_version = ENV.fetch("PACT_TARGET_BRANCH")
   configure_pact_broker_location(task)
 end
 
-PactBroker::Client::PublicationTask.new("released_version") do | task |
+PactBroker::Client::PublicationTask.new("released_version") do |task|
   require 'gds_api/version'
   task.consumer_version = GdsApi::VERSION
   configure_pact_broker_location(task)
@@ -43,7 +43,7 @@ end
 
 require "gem_publisher"
 desc "Publish gem to rubygems.org if necessary"
-task :publish_gem do |t|
+task :publish_gem do |_t|
   gem = GemPublisher.publish_if_updated("gds-api-adapters.gemspec", :rubygems)
   if gem
     puts "Published #{gem}"

data/lib/gds_api/asset_manager.rb

@@ -3,7 +3,6 @@ require_relative 'exceptions'
 
 # @api documented
 class GdsApi::AssetManager < GdsApi::Base
-
   # Creates an asset given a hash with one +file+ attribute
   #
   # Makes a +POST+ request to the asset manager api to create an asset.
@@ -45,7 +44,7 @@ class GdsApi::AssetManager < GdsApi::Base
   #    response = asset_manager.create_asset(file: params[:file])
   #    response['content_type'] #=> "image/jpeg"
   def create_asset(asset)
-    post_multipart("#{base_url}/assets", { :asset => asset })
+    post_multipart("#{base_url}/assets", asset: asset)
   end
 
   # Updates an asset given a hash with one +file+ attribute
@@ -78,7 +77,7 @@ class GdsApi::AssetManager < GdsApi::Base
   #   uuid = '594602dd-75b3-4e6f-b5d1-cacf8c4d4164'
   #   asset_manager.update_asset(uuid, file: File.new('image.jpg', 'r'))
   def update_asset(id, asset)
-    put_multipart("#{base_url}/assets/#{id}", { :asset => asset })
+    put_multipart("#{base_url}/assets/#{id}", asset: asset)
   end
 
   # Fetches an asset given the id
@@ -138,8 +137,9 @@ class GdsApi::AssetManager < GdsApi::Base
     post_json("#{base_url}/assets/#{id}/restore")
   end
 
-  private
-    def base_url
-      endpoint
-    end
+private
+
+  def base_url
+    endpoint
+  end
 end

data/lib/gds_api/base.rb

@@ -18,11 +18,12 @@ class GdsApi::Base
     GdsApi::JsonClient.new(options)
   end
 
-  def_delegators :client, :get_json, :get_json!,
-                          :post_json, :post_json!,
-                          :put_json, :put_json!,
-                          :patch_json, :patch_json!,
-                          :delete_json, :delete_json!, :delete_json_with_params!,
+  def_delegators :client, :get_json,
+                          :post_json,
+                          :put_json,
+                          :patch_json,
+                          :delete_json,
+                          :delete_json_with_params!,
                           :get_raw, :get_raw!,
                           :put_multipart,
                           :post_multipart
@@ -38,7 +39,7 @@ class GdsApi::Base
     @logger ||= NullLogger.instance
   end
 
-  def initialize(endpoint_url, options={})
+  def initialize(endpoint_url, options = {})
     options[:endpoint_url] = endpoint_url
     raise InvalidAPIURL unless endpoint_url =~ URI::regexp
     base_options = { logger: self.class.logger }
@@ -47,17 +48,18 @@ class GdsApi::Base
     self.endpoint = options[:endpoint_url]
   end
 
-  def url_for_slug(slug, options={})
+  def url_for_slug(slug, options = {})
     "#{base_url}/#{slug}.json#{query_string(options)}"
   end
 
-  def get_list!(url)
-    get_json!(url) do |r|
+  def get_list(url)
+    get_json(url) do |r|
       GdsApi::ListResponse.new(r, self)
     end
   end
 
 private
+
   attr_accessor :endpoint
 
   def query_string(params)
@@ -67,13 +69,13 @@ private
       case value
       when Array
         value.map { |v|
-          "#{CGI.escape(key.to_s+'[]')}=#{CGI.escape(v.to_s)}"
+          "#{CGI.escape(key.to_s + '[]')}=#{CGI.escape(v.to_s)}"
         }
       else
         "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
       end
     }.flatten
 
-    "?#{param_pairs.join("&")}"
+    "?#{param_pairs.join('&')}"
   end
 end

data/lib/gds_api/business_support_api.rb

@@ -3,16 +3,15 @@ require_relative 'exceptions'
 require_relative 'list_response'
 
 class GdsApi::BusinessSupportApi < GdsApi::Base
-
   def schemes(options = {})
-    get_list!(url_for_slug('business-support-schemes', options))
+    get_list(url_for_slug('business-support-schemes', options))
   end
 
   def scheme(slug)
-    get_json!(url_for_slug("business-support-schemes/#{slug}"))
+    get_json(url_for_slug("business-support-schemes/#{slug}"))
   end
 
-  private
+private
 
   def base_url
     endpoint

data/lib/gds_api/content_api.rb

@@ -3,7 +3,6 @@ require_relative 'exceptions'
 require_relative 'list_response'
 
 class GdsApi::ContentApi < GdsApi::Base
-
   def initialize(endpoint_url, options = {})
     # If the `web_urls_relative_to` option is given, the adapter will convert
     # any `web_url` values to relative URLs if they are from the same host.
@@ -26,7 +25,7 @@ class GdsApi::ContentApi < GdsApi::Base
     child_tags("section", parent_tag)
   end
 
-  def tags(tag_type, options={})
+  def tags(tag_type, options = {})
     params = [
       "type=#{CGI.escape(tag_type)}"
     ]
@@ -34,24 +33,24 @@ class GdsApi::ContentApi < GdsApi::Base
     params << "draft=true" if options[:draft]
     params << "cachebust=#{Time.now.utc.to_i}#{rand(1000)}" if options[:bust_cache]
 
-    get_list!("#{base_url}/tags.json?#{params.join('&')}")
+    get_list("#{base_url}/tags.json?#{params.join('&')}")
   end
 
   def root_tags(tag_type)
-    get_list!("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&root_sections=true")
+    get_list("#{base_url}/tags.json?type=#{CGI.escape(tag_type)}&root_sections=true")
   end
 
-  def child_tags(tag_type, parent_tag, options={})
+  def child_tags(tag_type, parent_tag, options = {})
     params = [
       "type=#{CGI.escape(tag_type)}",
       "parent_id=#{CGI.escape(parent_tag)}",
     ]
     params << "sort=#{options[:sort]}" if options.has_key?(:sort)
 
-    get_list!("#{base_url}/tags.json?#{params.join('&')}")
+    get_list("#{base_url}/tags.json?#{params.join('&')}")
   end
 
-  def tag(tag, tag_type=nil)
+  def tag(tag, tag_type = nil)
     if tag_type.nil?
       raise "Requests for tags without a tag_type are no longer supported. You probably want a tag_type of 'section'. See https://github.com/alphagov/govuk_content_api/blob/f4c0102a1ae4970be6a440707b89798442f768b9/govuk_content_api.rb#L241-L250"
     end
@@ -64,16 +63,16 @@ class GdsApi::ContentApi < GdsApi::Base
     get_list("#{base_url}/for_need/#{CGI.escape(need_id.to_s)}.json")
   end
 
-  def artefact(slug, params={})
+  def artefact(slug, params = {})
     get_json(artefact_url(slug, params))
   end
 
-  def artefact!(slug, params={})
-    get_json!(artefact_url(slug, params))
+  def artefact!(slug, params = {})
+    get_json(artefact_url(slug, params))
   end
 
   def artefacts
-    get_list!("#{base_url}/artefacts.json")
+    get_list("#{base_url}/artefacts.json")
   end
 
   def local_authority(snac_code)
@@ -81,11 +80,11 @@ class GdsApi::ContentApi < GdsApi::Base
   end
 
   def local_authorities_by_name(name)
-    get_json!("#{base_url}/local_authorities.json?name=#{CGI.escape(name)}")
+    get_json("#{base_url}/local_authorities.json?name=#{CGI.escape(name)}")
   end
 
   def local_authorities_by_snac_code(snac_code)
-    get_json!("#{base_url}/local_authorities.json?snac_code=#{CGI.escape(snac_code)}")
+    get_json("#{base_url}/local_authorities.json?snac_code=#{CGI.escape(snac_code)}")
   end
 
   def licences_for_ids(ids)
@@ -95,18 +94,12 @@ class GdsApi::ContentApi < GdsApi::Base
 
   def business_support_schemes(facets)
     url = "#{base_url}/business_support_schemes.json"
-    query = facets.map { |k,v| "#{k}=#{v}" }
+    query = facets.map { |k, v| "#{k}=#{v}" }
     if query.any?
-      url += "?#{query.join("&")}"
+      url += "?#{query.join('&')}"
     end
 
-    get_json!(url)
-  end
-
-  def get_list!(url)
-    get_json!(url) { |r|
-      GdsApi::ListResponse.new(r, self, web_urls_relative_to: @web_urls_relative_to)
-    }
+    get_json(url)
   end
 
   def get_list(url)
@@ -122,32 +115,26 @@ class GdsApi::ContentApi < GdsApi::Base
     super(url, &create_response)
   end
 
-  def get_json!(url, &create_response)
-    create_response = create_response || Proc.new { |r|
-      GdsApi::Response.new(r, web_urls_relative_to: @web_urls_relative_to)
-    }
-    super(url, &create_response)
+private
+
+  def base_url
+    endpoint
   end
 
-  private
-    def base_url
-      endpoint
-    end
+  def key_for_tag_type(tag_type)
+    tag_type.nil? ? "tag" : CGI.escape(tag_type)
+  end
 
-    def key_for_tag_type(tag_type)
-      tag_type.nil? ? "tag" : CGI.escape(tag_type)
+  def artefact_url(slug, params)
+    url = "#{base_url}/#{CGI.escape(slug)}.json"
+    query = params.map { |k, v| "#{k}=#{v}" }
+    if query.any?
+      url += "?#{query.join('&')}"
     end
 
-    def artefact_url(slug, params)
-      url = "#{base_url}/#{CGI.escape(slug)}.json"
-      query = params.map { |k,v| "#{k}=#{v}" }
-      if query.any?
-        url += "?#{query.join("&")}"
-      end
-
-      if params[:edition] && ! options.include?(:bearer_token)
-        raise GdsApi::NoBearerToken
-      end
-      url
+    if params[:edition] && ! options.include?(:bearer_token)
+      raise GdsApi::NoBearerToken
     end
+    url
+  end
 end

data/lib/gds_api/content_store.rb

@@ -2,7 +2,6 @@ require_relative 'base'
 require_relative 'exceptions'
 
 class GdsApi::ContentStore < GdsApi::Base
-
   class ItemNotFound < GdsApi::HTTPNotFound
     def self.build_from(http_error)
       new(http_error.code, http_error.message, http_error.error_details)
@@ -10,7 +9,7 @@ class GdsApi::ContentStore < GdsApi::Base
   end
 
   def content_item(base_path)
-    get_json!(content_item_url(base_path))
+    get_json(content_item_url(base_path))
   rescue GdsApi::HTTPNotFound => e
     raise ItemNotFound.build_from(e)
   end
@@ -19,7 +18,7 @@ class GdsApi::ContentStore < GdsApi::Base
     raise "`ContentStore#content_item!` is deprecated. Use `ContentStore#content_item` instead"
   end
 
-  private
+private
 
   def content_item_url(base_path)
     "#{endpoint}/content#{base_path}"

data/lib/gds_api/email_alert_api.rb

@@ -6,7 +6,6 @@ require_relative 'exceptions'
 # @see https://github.com/alphagov/email-alert-api
 # @api documented
 class GdsApi::EmailAlertApi < GdsApi::Base
-
   # Get or Post subscriber list
   #
   # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
@@ -34,7 +33,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @param publication [Hash] Valid publication attributes
   def send_alert(publication)
-    post_json!("#{endpoint}/notifications", publication)
+    post_json("#{endpoint}/notifications", publication)
   end
 
   # Get notifications
@@ -42,10 +41,10 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @option start_at [String] Optional GovDelivery bulletin id to page back through notifications
   #
   # @return [Hash] notifications
-  def notifications(start_at=nil)
+  def notifications(start_at = nil)
     url = "#{endpoint}/notifications"
     url += "?start_at=#{start_at}" if start_at
-    get_json!(url)
+    get_json(url)
   end
 
   # Get notification
@@ -54,18 +53,18 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @return [Hash] notification
   def notification(id)
-    get_json!("#{endpoint}/notifications/#{id}")
+    get_json("#{endpoint}/notifications/#{id}")
   end
 
 private
 
   def search_subscriber_list(params)
     query_string = nested_query_string(params)
-    get_json!("#{endpoint}/subscriber-lists?" + query_string)
+    get_json("#{endpoint}/subscriber-lists?" + query_string)
   end
 
   def create_subscriber_list(attributes)
-    post_json!("#{endpoint}/subscriber-lists", attributes)
+    post_json("#{endpoint}/subscriber-lists", attributes)
   end
 
   def nested_query_string(params)

data/lib/gds_api/exceptions.rb

@@ -46,13 +46,16 @@ module GdsApi
   class HTTPUnprocessableEntity < HTTPClientError
   end
 
+  class InvalidUrl < BaseError; end
+
   class NoBearerToken < BaseError; end
 
   module ExceptionHandling
-    def ignoring(exception_or_exceptions, &block)
+    def ignoring(exception_or_exceptions)
       yield
     rescue *exception_or_exceptions
       # Discard the exception
+      nil
     end
 
     def ignoring_missing(&block)

data/lib/gds_api/gov_uk_delivery.rb

@@ -3,36 +3,37 @@ require_relative 'exceptions'
 require 'json'
 
 class GdsApi::GovUkDelivery < GdsApi::Base
-
-  def initialize(endpoint_url, options={})
-    super(endpoint_url, options.merge({timeout: 10}))
+  def initialize(endpoint_url, options = {})
+    super(endpoint_url, options.merge(timeout: 10))
   end
 
   def subscribe(email, feed_urls)
-    data = {email: email, feed_urls: feed_urls}
+    data = { email: email, feed_urls: feed_urls }
     url = "#{base_url}/subscriptions"
     post_url(url, data)
   end
 
-  def topic(feed_url, title, description=nil)
-    data = {feed_url: feed_url, title: title, description: description}
+  def topic(feed_url, title, description = nil)
+    data = { feed_url: feed_url, title: title, description: description }
     url = "#{base_url}/lists"
     post_url(url, data)
   end
 
   def signup_url(feed_url)
-    if response = get_json("#{base_url}/list-url?feed_url=#{CGI.escape(feed_url)}")
+    response = get_json("#{base_url}/list-url?feed_url=#{CGI.escape(feed_url)}")
+    if response
       response['list_url']
     end
   end
 
   def notify(feed_urls, subject, body)
-    data = {feed_urls: feed_urls, subject: subject, body: body}
+    data = { feed_urls: feed_urls, subject: subject, body: body }
     url = "#{base_url}/notifications"
     post_url(url, data)
   end
 
 private
+
   def base_url
     endpoint
   end