gds-api-adapters 30.0.1 → 30.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0894ef0f3de4c61534ca85eb7dd7c82c6c422d0b
-  data.tar.gz: aac9d1fc32b38127c3421b76019c4feaf87b6268
+  metadata.gz: 8d3faeb6ebc0f0dd3bc81f25e0ce1337105f456b
+  data.tar.gz: dd3f80e588b4bffc76b292cbf032404717a5bdeb
 SHA512:
-  metadata.gz: c7b0c1cfd3bcd4ec5076ab4ddebcda7b8c825caf5d6185a9e9aa0c8068740810e22ad9f7e59bb4685b57c9a95f5c02ec43b25c0b45b17b197e233be879d42e80
-  data.tar.gz: 2f044b2df6c847766ac17be5bce711decc187c145f1ef01af7dd64e2486e721b538918ddf1e15e3aa3584ba99cd38bb2f203cb791a93502506f28f612d09dae5
+  metadata.gz: 3e0a6924f8b8462d93dfb9be1389d6b36cfdce70993bd5ba9831fb108e5e2cfcda52d04f00c7d380b95d264640e3318d275dbed8b89d83b6874e5a66d3aa47fb
+  data.tar.gz: 826ee63e166b5f6a390769aab68612f17f83509c6cb3353840ff4f690c1ffad7e1e086b21398d5544e4359b98712f1eb0de79b4746f40884d2fe1d9af8953855

data/lib/gds_api/helpers.rb

@@ -3,7 +3,6 @@ require 'gds_api/business_support_api'
 require 'gds_api/content_api'
 require 'gds_api/content_register'
 require 'gds_api/content_store'
-require 'gds_api/fact_cave'
 require 'gds_api/imminence'
 require 'gds_api/licence_application'
 require 'gds_api/need_api'
@@ -34,10 +33,6 @@ module GdsApi
       @content_store ||= GdsApi::ContentStore.new(Plek.current.find("content-store"), options)
     end
 
-    def fact_cave_api(options = {})
-      @fact_cave_api ||= GdsApi::FactCave.new(Plek.current.find("fact-cave"), options)
-    end
-
     def publisher_api(options = {})
       @api ||= GdsApi::Publisher.new(Plek.current.find("publisher"), options)
     end

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -139,6 +139,22 @@ module GdsApi
         end
       end
 
+      # Example of use:
+
+      # publishing_api_has_content(
+      #   vehicle_recalls_and_faults,   # this is a variable containing an array of content items
+      #   document_type: described_class.publishing_api_document_type,   #example of a document_type: "vehicle_recalls_and_faults_alert"
+      #   fields: fields,   #example: let(:fields) { %i[base_path content_id public_updated_at title publication_state] }
+      #   page: 1,
+      #   per_page: 50
+      #)
+      def publishing_api_has_content(items, params = {})
+        url = PUBLISHING_API_V2_ENDPOINT + "/content"
+        stub_request(:get, url).with(:query => params).to_return(status: 200, body: { results: items }.to_json, headers: {})
+      end
+
+      # This method has been refactored into publishing_api_has_content (above)
+      # publishing_api_has_content allows for flexible passing in of arguments, please use instead
       def publishing_api_has_fields_for_document(format, items, fields)
         body = Array(items).map { |item|
           item.with_indifferent_access.slice(*fields)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '30.0.1'
+  VERSION = '30.1.0'
 end

data/test/helpers_test.rb

@@ -14,7 +14,6 @@ describe GdsApi::Helpers do
     refute_nil test_with_helpers.content_api
     refute_nil test_with_helpers.content_register
     refute_nil test_with_helpers.content_store
-    refute_nil test_with_helpers.fact_cave_api
     refute_nil test_with_helpers.publisher_api
     refute_nil test_with_helpers.imminence_api
     refute_nil test_with_helpers.licence_application_api

data/test/test_helpers/publishing_api_v2_test.rb

@@ -16,4 +16,14 @@ describe GdsApi::TestHelpers::PublishingApiV2 do
       assert_equal publishing_api.lookup_content_id(base_path: "/foo"), "2878337b-bed9-4e7f-85b6-10ed2cbcd504"
     end
   end
+
+  describe "#publishing_api_has_content" do
+    it "stubs the call to get content items" do
+      publishing_api_has_content([{"content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504"}])
+
+      response = publishing_api.get_content_items({})['results']
+
+      assert_equal([{ "content_id" => "2878337b-bed9-4e7f-85b6-10ed2cbcd504" }], response)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 30.0.1
+  version: 30.1.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -280,16 +280,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: 1.24.2
 - !ruby/object:Gem::Dependency
   name: pact_broker-client
   requirement: !ruby/object:Gem::Requirement
@@ -324,7 +324,6 @@ files:
 - lib/gds_api/email_alert_api.rb
 - lib/gds_api/exceptions.rb
 - lib/gds_api/external_link_tracker.rb
-- lib/gds_api/fact_cave.rb
 - lib/gds_api/gov_uk_delivery.rb
 - lib/gds_api/govuk_headers.rb
 - lib/gds_api/helpers.rb
@@ -363,7 +362,6 @@ files:
 - lib/gds_api/test_helpers/content_register.rb
 - lib/gds_api/test_helpers/content_store.rb
 - lib/gds_api/test_helpers/email_alert_api.rb
-- lib/gds_api/test_helpers/fact_cave.rb
 - lib/gds_api/test_helpers/gov_uk_delivery.rb
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/intent_helpers.rb
@@ -393,7 +391,6 @@ files:
 - test/content_store_test.rb
 - test/email_alert_api_test.rb
 - test/external_link_tracker_test.rb
-- test/fact_cave_test.rb
 - test/fixtures/finder_api/cma-case-schema.json
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
@@ -460,54 +457,53 @@ signing_key:
 specification_version: 4
 summary: Adapters to work with GDS APIs
 test_files:
-- test/content_api_test.rb
-- test/json_client_test.rb
-- test/content_store_test.rb
-- test/publishing_api_test.rb
-- test/business_support_api_test.rb
-- test/middleware/govuk_header_sniffer_test.rb
-- test/whitehall_admin_api_test.rb
-- test/list_response_test.rb
-- test/maslow_test.rb
-- test/panopticon_registerer_test.rb
-- test/support_test.rb
-- test/asset_manager_test.rb
-- test/helpers_test.rb
-- test/licence_application_api_test.rb
-- test/test_helper.rb
-- test/publisher_api_test.rb
+- test/support_api_test.rb
 - test/mapit_test.rb
-- test/rummager_helpers_test.rb
-- test/publishing_api_v2_test.rb
+- test/publishing_api_test.rb
 - test/publishing_api_v2/lookup_test.rb
-- test/support_api_test.rb
-- test/organisations_api_test.rb
-- test/gds_api_base_test.rb
-- test/router_test.rb
+- test/whitehall_admin_api_test.rb
+- test/pp_data_in_test.rb
 - test/publishing_api/special_route_publisher_test.rb
-- test/external_link_tracker_test.rb
-- test/fact_cave_test.rb
 - test/need_api_test.rb
+- test/publisher_api_test.rb
+- test/rummager_helpers_test.rb
+- test/support_test.rb
 - test/content_register_test.rb
+- test/test_helpers/publishing_api_test.rb
+- test/test_helpers/pact_helper.rb
+- test/test_helpers/panopticon_test.rb
+- test/test_helpers/email_alert_api_test.rb
+- test/test_helpers/publishing_api_v2_test.rb
+- test/licence_application_api_test.rb
+- test/gov_uk_delivery_test.rb
+- test/maslow_test.rb
+- test/helpers_test.rb
+- test/panopticon_registerer_test.rb
 - test/panopticon_test.rb
-- test/pp_data_in_test.rb
+- test/middleware/govuk_header_sniffer_test.rb
+- test/rummager_test.rb
+- test/json_client_test.rb
+- test/email_alert_api_test.rb
+- test/content_api_test.rb
+- test/response_test.rb
+- test/organisations_api_test.rb
+- test/imminence_api_test.rb
+- test/content_store_test.rb
+- test/asset_manager_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
+- test/fixtures/world_organisations_australia.json
 - test/fixtures/no_services_and_info_data_found_fixture.json
-- test/fixtures/services_and_info_fixture.json
 - test/fixtures/old_policies_for_dwp.json
-- test/fixtures/world_organisations_australia.json
+- test/fixtures/services_and_info_fixture.json
 - test/fixtures/sub_sector_organisations.json
 - test/fixtures/finder_api/cma-case-schema.json
+- test/router_test.rb
+- test/list_response_test.rb
+- test/external_link_tracker_test.rb
+- test/gds_api_base_test.rb
 - test/worldwide_api_test.rb
-- test/test_helpers/publishing_api_test.rb
-- test/test_helpers/publishing_api_v2_test.rb
-- test/test_helpers/pact_helper.rb
-- test/test_helpers/panopticon_test.rb
-- test/test_helpers/email_alert_api_test.rb
-- test/gov_uk_delivery_test.rb
-- test/imminence_api_test.rb
-- test/email_alert_api_test.rb
-- test/response_test.rb
-- test/rummager_test.rb
+- test/test_helper.rb
+- test/publishing_api_v2_test.rb
+- test/business_support_api_test.rb
 has_rdoc: 

data/lib/gds_api/fact_cave.rb

@@ -1,12 +0,0 @@
-require 'gds_api/base'
-
-module GdsApi
-  class FactCave < Base
-
-    def fact(slug)
-      return nil if slug.nil? || slug == ""
-      get_json("#{endpoint}/facts/#{slug}")
-    end
-
-  end
-end

data/lib/gds_api/test_helpers/fact_cave.rb

@@ -1,67 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'gds_api/test_helpers/common_responses'
-
-module GdsApi
-  module TestHelpers
-    module FactCave 
-      include GdsApi::TestHelpers::CommonResponses
-
-      FACT_CAVE_ENDPOINT = Plek.current.find('fact-cave')
-
-      def fact_cave_has_a_fact(slug, value, options={})
-        response = fact_for_slug(slug, value, options)
-
-        stub_request(:get, "#{FACT_CAVE_ENDPOINT}/facts/#{slug}")
-          .to_return(:body => response.to_json, :status => 200)
-        stub_request(:get, "#{FACT_CAVE_ENDPOINT}/facts/#{slug}.json")
-          .to_return(:body => response.to_json, :status => 200)
-      end
-
-      def fact_cave_does_not_have_a_fact(slug)
-        response = {
-          "_response_info" => { "status" => "not found" }
-        }
-
-        stub_request(:get, "#{FACT_CAVE_ENDPOINT}/facts/#{slug}")
-          .to_return(:body => response.to_json, :status => 404)
-        stub_request(:get, "#{FACT_CAVE_ENDPOINT}/facts/#{slug}.json")
-          .to_return(:body => response.to_json, :status => 404)
-      end
-
-      # Creates a sample fact-cave response hash.
-      #   slug - the slug for the fact (also used to generate the title)
-      #   value - the raw value for the fact
-      #   options:
-      #     formatted_value - the formatted value to use.  If unspecified, this is generated based on the type
-      #     type - the type of the fact - one of [:currency, :date, :numeric, :text].  Defaults to :text
-      #     currency - for the :currency type, an optional currency symbol to prepend to the generated formatted_value
-      #     unit - for :numeric types, an optional unit to append to the generated formatted_value
-      def fact_for_slug(slug, value = "Sample Value", options = {})
-        formatted_value = options[:formatted_value]
-        formatted_value ||= case options[:type]
-        when :date
-          value.strftime("%e %B %Y")
-        when :numeric
-          "#{value.to_s}#{options[:unit]}"
-        when :currency
-          "#{options[:currency]}#{sprintf("%.2f", value)}"
-        when :text, nil
-          value
-        else
-          raise "Unknown fact type #{options[:type]}"
-        end
-
-        singular_response_base.merge({
-          "id" => "#{FACT_CAVE_ENDPOINT}/facts/#{slug}",
-          "details" => {
-            "description" => "",
-            "value" => value,
-            "formatted_value" => formatted_value,
-          },
-          "name" => titleize_slug(slug),
-          "updated_at" => Time.now.utc.xmlschema,
-        })
-      end
-    end
-  end
-end

data/test/fact_cave_test.rb

@@ -1,39 +0,0 @@
-require "test_helper"
-require "gds_api/fact_cave"
-
-describe GdsApi::FactCave do
-  it "should raise an exception if the service at the fact cave URI returns a 500" do
-    stub_request(:get, /example.com\/facts/).to_return(status: [500, "Internal Server Error"])
-    assert_raises(GdsApi::HTTPServerError) do
-      GdsApi::FactCave.new("http://example.com").fact("foo")
-    end
-  end
-
-  it "should return nil if the service at the fact cave URI returns a 404" do
-    stub_request(:get, /example.com\/facts/).to_return(status: [404, "Not Found"])
-    assert_nil GdsApi::FactCave.new("http://example.com").fact("bar")
-  end
-
-  it "should raise an exception if the service at the fact cave URI times out" do
-    stub_request(:get, /example.com\/facts/).to_timeout
-    assert_raises(GdsApi::TimedOutException) do
-      GdsApi::FactCave.new("http://example.com").fact("meh")
-    end
-  end
-
-  it "should return the fact deserialized from json" do
-    fact_cave_result = {"id" => "vat-rate", "title" => "VAT rate", "details" => {
-      "value" => "20%", "description" => "Value Added Tax rate" }}
-    stub_request(:get, "http://example.com/facts/vat-rate").to_return(body: fact_cave_result.to_json)
-    result = GdsApi::FactCave.new("http://example.com").fact("vat-rate")
-
-    assert_equal fact_cave_result, result.to_hash
-  end
-
-  it "should return an empty result without making request if slug is empty" do
-    result = GdsApi::FactCave.new("http://example.com").fact("")
-
-    assert_nil result
-    assert_not_requested :get, /example.com/
-  end
-end