gds-api-adapters 38.0.0 → 38.1.0

data/lib/gds_api/test_helpers/business_support_api.rb

@@ -13,11 +13,11 @@ module GdsApi
         setup_business_support_stubs(BUSINESS_SUPPORT_API_ENDPOINT, 'business-support-schemes')
       end
 
-      def business_support_api_has_scheme(scheme, facets={})
+      def business_support_api_has_scheme(scheme, facets = {})
         api_has_business_support(scheme, facets)
       end
 
-      def business_support_api_has_schemes(schemes, facets={})
+      def business_support_api_has_schemes(schemes, facets = {})
         schemes.each do |scheme|
           business_support_api_has_scheme(scheme, facets)
         end
@@ -25,8 +25,8 @@ module GdsApi
 
       def business_support_api_has_a_scheme(slug, scheme)
         title = scheme.delete(:title)
-        stub_request(:get, %r{\A#{BUSINESS_SUPPORT_API_ENDPOINT}/business-support-schemes/#{slug}\.json}).to_return do |request|
-          {:body => response_base.merge(:format => 'business_support', :title => title, :details => scheme).to_json}
+        stub_request(:get, %r{\A#{BUSINESS_SUPPORT_API_ENDPOINT}/business-support-schemes/#{slug}\.json}).to_return do |_request|
+          { body: response_base.merge(format: 'business_support', title: title, details: scheme).to_json }
         end
       end
     end

data/lib/gds_api/test_helpers/business_support_helper.rb

@@ -15,28 +15,29 @@ module GdsApi
           else
             results = @stubbed_business_supports
           end
-          {:body => plural_response_base.merge("results" => results, "total" => results.size).to_json}
+          { body: plural_response_base.merge("results" => results, "total" => results.size).to_json }
         end
-
       end
 
-      def api_has_business_support(business_support, facets={})
+      def api_has_business_support(business_support, facets = {})
         facets = sanitise_facets(facets)
+
         if business_support.is_a?(Symbol)
-          bs_with_facets = facets.merge(:title => business_support)
+          bs_with_facets = facets.merge(title: business_support)
         else
           bs_with_facets = facets.merge(business_support)
         end
+
         @stubbed_business_supports << bs_with_facets unless @stubbed_business_supports.include?(bs_with_facets)
       end
 
-      private
+    private
 
       def stubs_for_facets(facets)
         @stubbed_business_supports.select do |bs|
           facet_matches = 0
-          facets.each do |k,v|
-            if bs[k] and (v & bs[k]).any?
+          facets.each do |k, v|
+            if bs[k] && (v & bs[k]).any?
               facet_matches += 1
             end
           end
@@ -45,7 +46,7 @@ module GdsApi
       end
 
       def sanitise_facets(facets)
-        Hash[facets.map{ |k, v|
+        Hash[facets.map { |k, v|
           v = v.split(',') if v.is_a?(String)
           [k.to_sym, v]
         }]

data/lib/gds_api/test_helpers/common_responses.rb

@@ -3,16 +3,16 @@ module GdsApi
     module CommonResponses
       def titleize_slug(slug, options = {})
         if options[:title_case]
-          slug.gsub("-", " ").gsub(/\b./) {|m| m.upcase }
+          slug.tr("-", " ").gsub(/\b./, &:upcase)
         else
-          slug.gsub("-", " ").capitalize
+          slug.tr("-", " ").capitalize
         end
       end
 
       # expects a slug like "ministry-of-funk"
       # returns an acronym like "MOF"
       def acronymize_slug(slug)
-        initials = slug.gsub(/\b\w+/) {|m| m[0] }.gsub("-", "")
+        initials = slug.gsub(/\b\w+/) { |m| m[0] }.delete("-")
         initials.upcase
       end
 
@@ -27,15 +27,13 @@ module GdsApi
 
       def plural_response_base
         response_base.merge(
-          {
-            "description" => "Tags!",
-            "total" => 100,
-            "start_index" => 1,
-            "page_size" => 100,
-            "current_page" => 1,
-            "pages" => 1,
-            "results" => []
-          }
+          "description" => "Tags!",
+          "total" => 100,
+          "start_index" => 1,
+          "page_size" => 100,
+          "current_page" => 1,
+          "pages" => 1,
+          "results" => []
         )
       end
     end

data/lib/gds_api/test_helpers/content_api.rb

@@ -21,7 +21,7 @@ module GdsApi
         content_api_has_root_tags("section", slugs_or_sections)
       end
 
-      def content_api_has_section(slug_or_hash, parent_slug=nil)
+      def content_api_has_section(slug_or_hash, parent_slug = nil)
         content_api_has_tag("section", slug_or_hash, parent_slug)
       end
 
@@ -51,7 +51,7 @@ module GdsApi
         end
       end
 
-      def content_api_has_tag(tag_type, slug_or_hash, parent_tag_id=nil)
+      def content_api_has_tag(tag_type, slug_or_hash, parent_tag_id = nil)
         tag = tag_hash(slug_or_hash, tag_type).merge(parent: parent_tag_id)
         body = tag_result(tag)
 
@@ -83,16 +83,16 @@ module GdsApi
 
         body = plural_response_base.merge("results" => live_tags)
         stub_request(:get, "#{CONTENT_API_ENDPOINT}/tags.json")
-          .with(query: hash_including({"type" => type}))
+          .with(query: hash_including("type" => type))
           .to_return(status: 200, body: body.to_json, headers: {})
 
         body = plural_response_base.merge("results" => (live_tags + draft_tags))
         stub_request(:get, "#{CONTENT_API_ENDPOINT}/tags.json")
-          .with(query: hash_including({"type" => type, "draft" => "true"}))
+          .with(query: hash_including("type" => type, "draft" => "true"))
           .to_return(status: 200, body: body.to_json, headers: {})
       end
 
-      def content_api_does_not_have_tags(tag_type, slugs)
+      def content_api_does_not_have_tags(tag_type, _slugs)
         body = {
           "_response_info" => {
             "status" => "not found"
@@ -100,7 +100,7 @@ module GdsApi
         }
 
         stub_request(:get, "#{CONTENT_API_ENDPOINT}/tags.json")
-          .with(query: hash_including({"type" => tag_type}))
+          .with(query: hash_including("type" => tag_type))
           .to_return(status: 404, body: body.to_json, headers: {})
       end
 
@@ -110,7 +110,7 @@ module GdsApi
         )
 
         stub_request(:get, "#{CONTENT_API_ENDPOINT}/tags.json")
-          .with(query: hash_including({"type" => tag_type}))
+          .with(query: hash_including("type" => tag_type))
           .to_return(status: 200, body: body.to_json, headers: {})
       end
 
@@ -120,7 +120,7 @@ module GdsApi
         )
 
         stub_request(:get, "#{CONTENT_API_ENDPOINT}/tags.json")
-          .with(query: hash_including({"type" => tag_type, "sort" => sort_order}))
+          .with(query: hash_including("type" => tag_type, "sort" => sort_order))
           .to_return(status: 200, body: body.to_json, headers: {})
       end
 
@@ -196,7 +196,7 @@ module GdsApi
       def stub_content_api_default_artefact
         stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/[a-z0-9-]+\.json}).to_return { |request|
           slug = request.uri.path.split('/').last.chomp('.json')
-          {:body => artefact_for_slug(slug).to_json}
+          { body: artefact_for_slug(slug).to_json }
         }
       end
 
@@ -257,14 +257,14 @@ module GdsApi
           child_tag_id.split('/').inject(nil) do |parent_tag, child_tag|
             child_tag = [parent_tag, child_tag].join('/') if parent_tag
             next_level_tag = tag_for_slug(child_tag, tag_type)
-            if tag_tree
+            tag_tree = if tag_tree
               # Because tags are nested within one another, this makes
               # the current part the top, and the rest we've seen the
               # ancestors
-              tag_tree = next_level_tag.merge("parent" => tag_tree)
-            else
-              tag_tree = next_level_tag
-            end
+                         next_level_tag.merge("parent" => tag_tree)
+                       else
+                         next_level_tag
+                       end
 
             # This becomes the parent tag in the next iteration of the block
             child_tag
@@ -288,9 +288,9 @@ module GdsApi
         artefact
       end
 
-      def tag_for_slug(slug, tag_type, parent_slug=nil)
-        parent = if parent_slug
-          tag_for_slug(parent_slug, tag_type)
+      def tag_for_slug(slug, tag_type, parent_slug = nil)
+        if parent_slug
+          parent = tag_for_slug(parent_slug, tag_type)
         end
 
         tag_result(slug: slug, type: tag_type, parent: parent)
@@ -353,14 +353,14 @@ module GdsApi
 
       def content_api_has_default_business_support_schemes
         empty_results = {
-          "_response_info" => {"status" => "ok"},
+          "_response_info" => { "status" => "ok" },
           "description" => "Business Support Schemes!",
           "total" => 0, "startIndex" => 1, "pageSize" => 0, "currentPage" => 1, "pages" => 1,
           "results" => []
         }
 
         stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/business_support_schemes\.json}).
-          to_return(:body => empty_results.to_json)
+          to_return(body: empty_results.to_json)
       end
 
       def content_api_licence_hash(licence_identifier, options = {})
@@ -374,7 +374,7 @@ module GdsApi
         {
           "title" => details[:title],
           "id" => "http://example.org/#{details[:slug]}.json",
-          "web_url" =>  "http://www.test.gov.uk/#{details[:slug]}",
+          "web_url" => "http://www.test.gov.uk/#{details[:slug]}",
           "format" => "licence",
           "details" => {
             "need_ids" => [],
@@ -396,18 +396,18 @@ module GdsApi
       def setup_content_api_licences_stubs
         @stubbed_content_api_licences = []
         stub_request(:get, %r{\A#{CONTENT_API_ENDPOINT}/licences}).to_return do |request|
-          if request.uri.query_values and request.uri.query_values["ids"]
+          if request.uri.query_values && request.uri.query_values["ids"]
             ids = request.uri.query_values["ids"].split(',')
             valid_licences = @stubbed_content_api_licences.select { |l| ids.include? l[:licence_identifier] }
             {
-              :body => {
+              body: {
                 'results' => valid_licences.map { |licence|
                   content_api_licence_hash(licence[:licence_identifier], licence)
                 }
               }.to_json
             }
           else
-            {:body => {'results' => []}.to_json}
+            { body: { 'results' => [] }.to_json }
           end
         end
       end

data/lib/gds_api/test_helpers/content_api/artefact_stub.rb

@@ -16,7 +16,7 @@ module GdsApi
           @response_body = artefact_for_slug(slug)
           @response_status = 200
         end
-        
+
         def with_query_parameters(hash)
           @query_parameters = hash
           self
@@ -38,19 +38,20 @@ module GdsApi
               .with(query: hash_including(comparable_query_params))
               .to_return(status: @response_status, body: @response_body.to_json)
         end
-        
-        private
-          def url_without_query
-            "#{CONTENT_API_ENDPOINT}/#{CGI.escape(slug)}.json"
-          end
 
-          # Ensure that all keys and values are strings 
-          # because Webmock doesn't handle symbols
-          def comparable_query_params
-            @query_parameters.each_with_object({}) do |(k,v),hash| 
-              hash[k.to_s] = v.nil? ? v : v.to_s
-            end
+      private
+
+        def url_without_query
+          "#{CONTENT_API_ENDPOINT}/#{CGI.escape(slug)}.json"
+        end
+
+        # Ensure that all keys and values are strings
+        # because Webmock doesn't handle symbols
+        def comparable_query_params
+          @query_parameters.each_with_object({}) do |(k, v), hash|
+            hash[k.to_s] = v.nil? ? v : v.to_s
           end
+        end
       end
     end
   end

data/lib/gds_api/test_helpers/content_item_helpers.rb

@@ -2,12 +2,12 @@
 module GdsApi
   module TestHelpers
     module ContentItemHelpers
-
       def content_item_for_base_path(base_path)
         {
           "title" => titleize_base_path(base_path),
           "description" => "Description for #{base_path}",
-          "format" => "guide",
+          "schema_name" => "guide",
+          "document_type" => "guide",
           "need_ids" => ["100001"],
           "public_updated_at" => "2014-05-06T12:01:00+00:00",
           # base_path is added in as necessary (ie for content-store GET responses)
@@ -22,7 +22,7 @@ module GdsApi
         {
           "title" => nil,
           "description" => nil,
-          "format" => "gone",
+          "document_type" => "gone",
           "schema_name" => "gone",
           "public_updated_at" => nil,
           "base_path" => base_path,
@@ -33,7 +33,7 @@ module GdsApi
 
       def titleize_base_path(base_path, options = {})
         if options[:title_case]
-          base_path.gsub("-", " ").gsub(/\b./) {|m| m.upcase }
+          base_path.tr("-", " ").gsub(/\b./, &:upcase)
         else
           base_path.gsub(%r{[-/]}, " ").strip.capitalize
         end

data/lib/gds_api/test_helpers/content_store.rb

@@ -15,7 +15,7 @@ module GdsApi
       #             will include "public"
       #   :draft    will point to the draft content store if set to true
 
-      def content_store_endpoint(draft=false)
+      def content_store_endpoint(draft = false)
         draft ? Plek.current.find('draft-content-store') : Plek.current.find('content-store')
       end
 
@@ -79,11 +79,11 @@ module GdsApi
       end
 
       def content_store_isnt_available
-        stub_request(:any, /#{content_store_endpoint}\/.*/).to_return(:status => 503)
+        stub_request(:any, /#{content_store_endpoint}\/.*/).to_return(status: 503)
       end
 
       def content_item_for_base_path(base_path)
-        super.merge({ "base_path" => base_path })
+        super.merge("base_path" => base_path)
       end
 
       def content_store_has_incoming_links(base_path, links)

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -9,8 +9,8 @@ module GdsApi
       def email_alert_api_has_subscriber_list(attributes)
         stub_request(:get, subscriber_lists_url(attributes))
           .to_return(
-            :status => 200,
-            :body => get_subscriber_list_response(attributes).to_json,
+            status: 200,
+            body: get_subscriber_list_response(attributes).to_json,
           )
       end
 
@@ -22,15 +22,15 @@ module GdsApi
       def email_alert_api_creates_subscriber_list(attributes)
         stub_request(:post, subscriber_lists_url)
           .to_return(
-            :status => 201,
-            :body => get_subscriber_list_response(attributes).to_json,
+            status: 201,
+            body: get_subscriber_list_response(attributes).to_json,
           )
       end
 
       def email_alert_api_refuses_to_create_subscriber_list
         stub_request(:post, subscriber_lists_url)
           .to_return(
-            :status => 422,
+            status: 422,
           )
       end
 
@@ -48,8 +48,8 @@ module GdsApi
       def email_alert_api_accepts_alert
         stub_request(:post, notifications_url)
           .to_return(
-            :status => 202,
-            :body => {}.to_json,
+            status: 202,
+            body: {}.to_json,
           )
       end
 
@@ -67,14 +67,12 @@ module GdsApi
             payload = JSON.parse(request.body)
             payload.select { |k, _| attributes.key?(k) } == attributes
           end
-        else
-          matcher = nil
         end
 
         assert_requested(:post, notifications_url, times: 1, &matcher)
       end
 
-      def email_alert_api_has_notifications(notifications, start_at=nil)
+      def email_alert_api_has_notifications(notifications, start_at = nil)
         url = notifications_url
         url += "?start_at=#{start_at}" if start_at
         url_regexp = Regexp.new("^#{Regexp.escape(url)}$")

data/lib/gds_api/test_helpers/gov_uk_delivery.rb

@@ -3,7 +3,6 @@ require 'json'
 module GdsApi
   module TestHelpers
     module GovUkDelivery
-
       GOVUK_DELIVERY_ENDPOINT = Plek.current.find('govuk-delivery')
 
       def stub_gov_uk_delivery_post_request(method, params_hash)

data/lib/gds_api/test_helpers/imminence.rb

@@ -14,13 +14,13 @@ module GdsApi
 
       def imminence_has_areas_for_postcode(postcode, areas)
         results = {
-          "_response_info" => {"status" => "ok"},
+          "_response_info" => { "status" => "ok" },
           "total" => areas.size, "startIndex" => 1, "pageSize" => areas.size,
           "currentPage" => 1, "pages" => 1, "results" => areas
         }
 
         stub_request(:get, %r{\A#{IMMINENCE_API_ENDPOINT}/areas/#{postcode}\.json}).
-          to_return(:body => results.to_json)
+          to_return(body: results.to_json)
       end
 
       def imminence_has_places_for_postcode(places, slug, postcode, limit)
@@ -30,8 +30,8 @@ module GdsApi
 
       def stub_imminence_places_request(slug, query_hash, return_data, status_code = 200)
         stub_request(:get, "#{IMMINENCE_API_ENDPOINT}/places/#{slug}.json").
-        with(:query => query_hash).
-        to_return(:status => status_code, :body => return_data.to_json, :headers => {})
+        with(query: query_hash).
+        to_return(status: status_code, body: return_data.to_json, headers: {})
       end
     end
   end