gds-api-adapters 38.0.0 → 38.1.0

data/lib/gds_api/performance_platform/data_in.rb

@@ -6,21 +6,21 @@ module GdsApi
   module PerformancePlatform
     class DataIn < GdsApi::Base
       def submit_service_feedback_day_aggregate(slug, request_details)
-        post_json!("#{endpoint}/data/#{slug}/customer-satisfaction", request_details)
+        post_json("#{endpoint}/data/#{slug}/customer-satisfaction", request_details)
       rescue GdsApi::HTTPNotFound
         raise PerformancePlatformDatasetNotConfigured, "Dataset for slug [#{slug}] not set up"
       end
 
       def corporate_content_problem_report_count(entries)
-        post_json!("#{endpoint}/data/gov-uk-content/feedback-count", entries)
+        post_json("#{endpoint}/data/gov-uk-content/feedback-count", entries)
       end
 
       def corporate_content_urls_with_the_most_problem_reports(entries)
-        post_json!("#{endpoint}/data/gov-uk-content/top-urls", entries)
+        post_json("#{endpoint}/data/gov-uk-content/top-urls", entries)
       end
 
       def submit_problem_report_daily_totals(entries)
-        post_json!("#{endpoint}/data/govuk-info/page-contacts", entries)
+        post_json("#{endpoint}/data/govuk-info/page-contacts", entries)
       end
     end
   end

data/lib/gds_api/performance_platform/data_out.rb

@@ -41,7 +41,7 @@ module GdsApi
       #   ...
       #  }
       def service_feedback(transaction_page_slug)
-        get_json!("#{endpoint}/data/#{transaction_page_slug}/customer-satisfaction")
+        get_json("#{endpoint}/data/#{transaction_page_slug}/customer-satisfaction")
       end
     end
   end

data/lib/gds_api/publishing_api.rb

@@ -2,22 +2,21 @@ require_relative 'base'
 require_relative 'exceptions'
 
 class GdsApi::PublishingApi < GdsApi::Base
-
   def put_intent(base_path, payload)
-    put_json!(intent_url(base_path), payload)
+    put_json(intent_url(base_path), payload)
   end
 
   def destroy_intent(base_path)
-    delete_json!(intent_url(base_path))
+    delete_json(intent_url(base_path))
   rescue GdsApi::HTTPNotFound => e
     e
   end
 
   def put_path(base_path, payload)
-    put_json!(paths_url(base_path), payload)
+    put_json(paths_url(base_path), payload)
   end
 
-  private
+private
 
   def intent_url(base_path)
     "#{endpoint}/publish-intent#{base_path}"

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -12,7 +12,8 @@ module GdsApi
       def publish(options)
         logger.info("Publishing #{options.fetch(:type)} route #{options.fetch(:base_path)}, routing to #{options.fetch(:rendering_app)}")
 
-        put_content_response = publishing_api.put_content(options.fetch(:content_id), {
+        put_content_response = publishing_api.put_content(
+          options.fetch(:content_id),
           base_path: options.fetch(:base_path),
           document_type: "special_route",
           schema_name: "special_route",
@@ -26,14 +27,15 @@ module GdsApi
           ],
           publishing_app: options.fetch(:publishing_app),
           rendering_app: options.fetch(:rendering_app),
-          public_updated_at: time.now.iso8601,
-        })
+          public_updated_at: time.now.iso8601)
+
         publishing_api.patch_links(options.fetch(:content_id), links: options[:links]) if options[:links]
         publishing_api.publish(options.fetch(:content_id), 'major')
         put_content_response
       end
 
     private
+
       attr_reader :logger, :publishing_api
 
       def time

data/lib/gds_api/publishing_api_v2.rb

@@ -14,7 +14,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-v2contentcontent_id
   def put_content(content_id, payload)
-    put_json!(content_url(content_id), payload)
+    put_json(content_url(content_id), payload)
   end
 
   # Return a content item
@@ -49,7 +49,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-lookup-by-base-path
   def lookup_content_ids(base_paths:)
-    response = post_json!("#{endpoint}/lookup-by-base-path", base_paths: base_paths)
+    response = post_json("#{endpoint}/lookup-by-base-path", base_paths: base_paths)
     response.to_hash
   end
 
@@ -96,7 +96,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
 
     params = merge_optional_keys(params, options, optional_keys)
 
-    post_json!(publish_url(content_id), params)
+    post_json(publish_url(content_id), params)
   end
 
   # Unpublish a content item
@@ -127,7 +127,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
     params[:locale] = locale if locale
     params[:unpublished_at] = unpublished_at.utc.iso8601 if unpublished_at
 
-    post_json!(unpublish_url(content_id), params)
+    post_json(unpublish_url(content_id), params)
   end
 
   # Discard a draft
@@ -147,7 +147,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
 
     params = merge_optional_keys({}, options, optional_keys)
 
-    post_json!(discard_url(content_id), params)
+    post_json(discard_url(content_id), params)
   end
 
   # Get the link set for the given content_id.
@@ -232,7 +232,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
 
     payload = merge_optional_keys(payload, params, [:previous_version, :bulk_publishing])
 
-    patch_json!(links_url(content_id), payload)
+    patch_json(links_url(content_id), payload)
   end
 
   # Get a list of content items from the Publishing API.
@@ -263,17 +263,9 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # FIXME: Add documentation
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkables
-  def get_linkables(document_type: nil, format: nil)
+  def get_linkables(document_type: nil)
     if document_type.nil?
-      if format.nil?
-        raise ArgumentError.new("Please provide a `document_type`")
-      else
-        self.class.logger.warn(
-          "Providing `format` to the `get_linkables` method is deprecated and will be removed in a " +
-          "future release.  Please use `document_type` instead."
-        )
-        document_type = format
-      end
+      raise ArgumentError.new("Please provide a `document_type`")
     end
 
     get_json("#{endpoint}/v2/linkables?document_type=#{document_type}")

data/lib/gds_api/response.rb

@@ -1,13 +1,9 @@
 require 'json'
-require 'ostruct'
 require 'forwardable'
 require 'rack/cache'
-require_relative 'core-ext/openstruct'
 
 module GdsApi
-
-  # This wraps an HTTP response with a JSON body, and presents this as
-  # an object that has the read behaviour of both a Hash and an OpenStruct
+  # This wraps an HTTP response with a JSON body.
   #
   # Responses can be configured to use relative URLs for `web_url` properties.
   # API endpoints should return absolute URLs so that they make sense outside of the
@@ -79,6 +75,7 @@ module GdsApi
     end
 
     def present?; true; end
+
     def blank?; false; end
 
   private

data/lib/gds_api/router.rb

@@ -1,7 +1,6 @@
 require_relative 'base'
 
 class GdsApi::Router < GdsApi::Base
-
   ### Backends
 
   def get_backend(id)
@@ -9,11 +8,11 @@ class GdsApi::Router < GdsApi::Base
   end
 
   def add_backend(id, url)
-    put_json!("#{endpoint}/backends/#{CGI.escape(id)}", :backend => {:backend_url => url})
+    put_json("#{endpoint}/backends/#{CGI.escape(id)}", backend: { backend_url: url })
   end
 
   def delete_backend(id)
-    delete_json!("#{endpoint}/backends/#{CGI.escape(id)}")
+    delete_json("#{endpoint}/backends/#{CGI.escape(id)}")
   end
 
   ### Routes
@@ -26,20 +25,30 @@ class GdsApi::Router < GdsApi::Base
   end
 
   def add_route(path, type, backend_id, options = {})
-    response = put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "backend", :backend_id => backend_id})
+    response = put_json("#{endpoint}/routes", route: { incoming_path: path, route_type: type, handler: "backend", backend_id: backend_id })
     commit_routes if options[:commit]
     response
   end
 
   def add_redirect_route(path, type, destination, redirect_type = "permanent", options = {})
-    response = put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "redirect",
-              :redirect_to => destination, :redirect_type => redirect_type, :segments_mode => options[:segments_mode]})
+    response = put_json(
+      "#{endpoint}/routes",
+      route: {
+        incoming_path: path,
+        route_type: type,
+        handler: "redirect",
+        redirect_to: destination,
+        redirect_type: redirect_type,
+        segments_mode: options[:segments_mode]
+      }
+    )
+
     commit_routes if options[:commit]
     response
   end
 
   def add_gone_route(path, type, options = {})
-    response = put_json!("#{endpoint}/routes", :route => {:incoming_path => path, :route_type => type, :handler => "gone"})
+    response = put_json("#{endpoint}/routes", route: { incoming_path: path, route_type: type, handler: "gone" })
     commit_routes if options[:commit]
     response
   end
@@ -51,12 +60,12 @@ class GdsApi::Router < GdsApi::Base
     else
       options = options_or_deprecated_type
     end
-    response = delete_json!("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}")
+    response = delete_json("#{endpoint}/routes?incoming_path=#{CGI.escape(path)}")
     commit_routes if options[:commit]
     response
   end
 
   def commit_routes
-    post_json!("#{endpoint}/routes/commit", {})
+    post_json("#{endpoint}/routes/commit", {})
   end
 end

data/lib/gds_api/rummager.rb

@@ -4,7 +4,6 @@ require 'rack/utils'
 module GdsApi
   # @api documented
   class Rummager < Base
-
     # Perform a search.
     #
     # @param args [Hash] A valid search query. See Rummager documentation for options.
@@ -12,7 +11,7 @@ module GdsApi
     # @see https://github.com/alphagov/rummager/blob/master/docs/search-api.md
     def search(args)
       request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
-      get_json!(request_url)
+      get_json(request_url)
     end
 
     # Advanced search.
@@ -21,7 +20,7 @@ module GdsApi
     def advanced_search(args)
       raise ArgumentError.new("Args cannot be blank") if args.nil? || args.empty?
       request_path = "#{base_url}/advanced_search?#{Rack::Utils.build_nested_query(args)}"
-      get_json!(request_path)
+      get_json(request_path)
     end
 
     # Add a document to the search index.
@@ -33,7 +32,7 @@ module GdsApi
     #
     # @see https://github.com/alphagov/rummager/blob/master/docs/documents.md
     def add_document(type, id, document)
-      post_json!(
+      post_json(
         documents_url,
         document.merge(
           _type: type,
@@ -52,7 +51,7 @@ module GdsApi
     # @see https://github.com/alphagov/rummager/blob/master/docs/content-api.md
     def delete_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
-      delete_json!(request_url)
+      delete_json(request_url)
     end
 
     # @private
@@ -70,7 +69,7 @@ module GdsApi
     # @see https://github.com/alphagov/rummager/blob/master/docs/content-api.md
     def get_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
-      get_json!(request_url)
+      get_json(request_url)
     end
 
     # @private
@@ -85,7 +84,7 @@ module GdsApi
     # @param type [String] The rummager/elasticsearch document type.
     # @param id [String] The rummager/elasticsearch id. Typically the same as the `link` field.
     def delete_document(type, id)
-      delete_json!(
+      delete_json(
         "#{documents_url}/#{id}",
         _type: type,
       )

data/lib/gds_api/support.rb

@@ -2,30 +2,31 @@ require_relative 'base'
 
 class GdsApi::Support < GdsApi::Base
   def create_foi_request(request_details)
-    post_json!("#{base_url}/foi_requests", { :foi_request => request_details })
+    post_json("#{base_url}/foi_requests", foi_request: request_details)
   end
 
   def create_problem_report(request_details)
-    post_json!("#{base_url}/anonymous_feedback/problem_reports", { :problem_report => request_details })
+    post_json("#{base_url}/anonymous_feedback/problem_reports", problem_report: request_details)
   end
 
   def create_named_contact(request_details)
-    post_json!("#{base_url}/named_contacts", { :named_contact => request_details })
+    post_json("#{base_url}/named_contacts", named_contact: request_details)
   end
 
   def create_anonymous_long_form_contact(request_details)
-    post_json!("#{base_url}/anonymous_feedback/long_form_contacts", { :long_form_contact => request_details })
+    post_json("#{base_url}/anonymous_feedback/long_form_contacts", long_form_contact: request_details)
   end
 
   def create_service_feedback(request_details)
-    post_json!("#{base_url}/anonymous_feedback/service_feedback", { :service_feedback => request_details })
+    post_json("#{base_url}/anonymous_feedback/service_feedback", service_feedback: request_details)
   end
 
   def feedback_url(slug)
     "#{base_url}/anonymous_feedback?path=#{slug}"
   end
 
-  private
+private
+
   def base_url
     endpoint
   end

data/lib/gds_api/support_api.rb

@@ -3,23 +3,23 @@ require_relative 'base'
 # @api documented
 class GdsApi::SupportApi < GdsApi::Base
   def create_problem_report(request_details)
-    post_json!("#{endpoint}/anonymous-feedback/problem-reports", { :problem_report => request_details })
+    post_json("#{endpoint}/anonymous-feedback/problem-reports", problem_report: request_details)
   end
 
   def create_service_feedback(request_details)
-    post_json!("#{endpoint}/anonymous-feedback/service-feedback", { :service_feedback => request_details })
+    post_json("#{endpoint}/anonymous-feedback/service-feedback", service_feedback: request_details)
   end
 
   def create_anonymous_long_form_contact(request_details)
-    post_json!("#{endpoint}/anonymous-feedback/long-form-contacts", { :long_form_contact => request_details })
+    post_json("#{endpoint}/anonymous-feedback/long-form-contacts", long_form_contact: request_details)
   end
 
   def create_feedback_export_request(request_details)
-    post_json!("#{endpoint}/anonymous-feedback/export-requests", export_request: request_details)
+    post_json("#{endpoint}/anonymous-feedback/export-requests", export_request: request_details)
   end
 
   def create_global_export_request(request_details)
-    post_json!("#{endpoint}/anonymous-feedback/global-export-requests", global_export_request: request_details)
+    post_json("#{endpoint}/anonymous-feedback/global-export-requests", global_export_request: request_details)
   end
 
   # Create a Page Improvement
@@ -39,34 +39,34 @@ class GdsApi::SupportApi < GdsApi::Base
   #     path: 'http://gov.uk/service-manual/agile'
   # )
   def create_page_improvement(params)
-    post_json!("#{endpoint}/page-improvements", params)
+    post_json("#{endpoint}/page-improvements", params)
   end
 
   def problem_report_daily_totals_for(date)
     date_string = date.strftime("%Y-%m-%d")
-    get_json!("#{endpoint}/anonymous-feedback/problem-reports/#{date_string}/totals")
+    get_json("#{endpoint}/anonymous-feedback/problem-reports/#{date_string}/totals")
   end
 
   def anonymous_feedback(options = {})
     uri = "#{endpoint}/anonymous-feedback" + query_string(options)
-    get_json!(uri)
+    get_json(uri)
   end
 
   def organisation_summary(organisation_slug, options = {})
     uri = "#{endpoint}/anonymous-feedback/organisations/#{organisation_slug}" + query_string(options)
-    get_json!(uri)
+    get_json(uri)
   end
 
   def organisations_list
-    get_json!("#{endpoint}/organisations")
+    get_json("#{endpoint}/organisations")
   end
 
   def organisation(organisation_slug)
-    get_json!("#{endpoint}/organisations/#{organisation_slug}")
+    get_json("#{endpoint}/organisations/#{organisation_slug}")
   end
 
   def feedback_export_request(id)
-    get_json!("#{endpoint}/anonymous-feedback/export-requests/#{id}")
+    get_json("#{endpoint}/anonymous-feedback/export-requests/#{id}")
   end
 
   # Fetch a list of problem reports.
@@ -112,7 +112,7 @@ class GdsApi::SupportApi < GdsApi::Base
   #  }
   def problem_reports(options = {})
     uri = "#{endpoint}/anonymous-feedback/problem-reports" + query_string(options)
-    get_json!(uri)
+    get_json(uri)
   end
 
   # Update multiple problem reports as reviewed for spam.
@@ -137,6 +137,6 @@ class GdsApi::SupportApi < GdsApi::Base
   #
   # #=> { "success" =>  false} (status: 400)
   def mark_reviewed_for_spam(request_details)
-    put_json!("#{endpoint}/anonymous-feedback/problem-reports/mark-reviewed-for-spam", { reviewed_problem_report_ids: request_details })
+    put_json("#{endpoint}/anonymous-feedback/problem-reports/mark-reviewed-for-spam", reviewed_problem_report_ids: request_details)
   end
 end

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -1,16 +1,13 @@
 module GdsApi
   module TestHelpers
     module AssetManager
-
       ASSET_MANAGER_ENDPOINT = Plek.current.find('asset-manager')
 
       def asset_manager_has_an_asset(id, atts)
-        response = atts.merge({
-          "_response_info" => { "status" => "ok" }
-        })
+        response = atts.merge("_response_info" => { "status" => "ok" })
 
         stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/assets/#{id}")
-          .to_return(:body => response.to_json, :status => 200)
+          .to_return(body: response.to_json, status: 200)
       end
 
       def asset_manager_does_not_have_an_asset(id)
@@ -19,7 +16,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/assets/#{id}")
-          .to_return(:body => response.to_json, :status => 404)
+          .to_return(body: response.to_json, status: 404)
       end
 
       def asset_manager_receives_an_asset(response_url)