gds-api-adapters 21.0.0 → 22.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bcaacb3f37eb313895187dd726c2dce6e09170c
-  data.tar.gz: 02f222992af858d36f5ef0f1787e379e77ca88f5
+  metadata.gz: 30afe3107beb650860db70e91c9d42835c570de2
+  data.tar.gz: d3b8c1636e24c02501718a1f6f1c319cd43c818c
 SHA512:
-  metadata.gz: 1b6ac58a27bc20babe9dc54e00f64298ee2b86ad617955e989a511666ff968317848617ea9ae02ab732fe0b8f5288173e996228f6d31ce64829c7348fd387233
-  data.tar.gz: 2a5109ede1a0b00e64f11db81e61c94210783c57090c0692422837160f5318820d81c7a15e55345ccbf5e39890846bf101cc548833df472d6a55b31135408129
+  metadata.gz: 085750359ca93887f245ffe02241413cfd2d5532c4eee64265fc8605ddc04b50df7994b9f3a869b43b36eb1d1359f1da1c308deef366f1284db75fcc95970ee5
+  data.tar.gz: 7b34634b10f4ba9c74c3bbe271d411681d831af8fa2405f78036f7856ade1c893af9ab8b7fdab2587f3b9388630fcc8df24dd6107021df67a486b027d70c3007

data/lib/gds_api/content_store.rb

@@ -3,12 +3,20 @@ 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)
+    end
+  end
+
   def content_item(base_path)
     get_json(content_item_url(base_path))
   end
 
   def content_item!(base_path)
     get_json!(content_item_url(base_path))
+  rescue GdsApi::HTTPNotFound => e
+    raise ItemNotFound.build_from(e)
   end
 
   private

data/lib/gds_api/helpers.rb

@@ -67,10 +67,6 @@ module GdsApi
       @worldwide_api ||= GdsApi::Worldwide.new(Plek.current.find("whitehall-admin"), options)
     end
 
-    def finder_api(options = {})
-      @finder_api ||= FinderApi.new(Plek.current.find("finder-api"), options)
-    end
-
     def email_alert_api(options = {})
       @email_alert_api ||= EmailAlertApi.new(Plek.current.find("email-alert-api"), options)
     end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '21.0.0'
+  VERSION = '22.0.0'
 end

data/test/content_store_test.rb

@@ -10,12 +10,35 @@ describe GdsApi::ContentStore do
     @api = GdsApi::ContentStore.new(@base_api_url)
   end
 
-  describe "item" do
+  describe "content_item" do
     it "should return the item" do
       base_path = "/test-from-content-store"
       content_store_has_item(base_path)
       response = @api.content_item(base_path)
       assert_equal base_path, response["base_path"]
     end
+
+    it "should return nil if the item doesn't exist" do
+      content_store_does_not_have_item("/non-existent")
+      assert_nil @api.content_item("/non-existent")
+    end
+  end
+
+  describe "content_item!" do
+    it "should return the item" do
+      base_path = "/test-from-content-store"
+      content_store_has_item(base_path)
+      response = @api.content_item!(base_path)
+      assert_equal base_path, response["base_path"]
+    end
+
+    it "should raise if the item doesn't exist" do
+      content_store_does_not_have_item("/non-existent")
+      e = assert_raises GdsApi::ContentStore::ItemNotFound do
+        @api.content_item!("/non-existent")
+      end
+      assert_equal 404, e.code
+      assert_equal "url: #{@base_api_url}/content/non-existent", e.message.strip
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 21.0.0
+  version: 22.0.0
 platform: ruby
 authors:
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -283,8 +283,6 @@ files:
 - lib/gds_api/exceptions.rb
 - lib/gds_api/external_link_tracker.rb
 - lib/gds_api/fact_cave.rb
-- lib/gds_api/finder_api.rb
-- lib/gds_api/finder_schema.rb
 - lib/gds_api/gov_uk_delivery.rb
 - lib/gds_api/govuk_headers.rb
 - lib/gds_api/helpers.rb
@@ -322,7 +320,6 @@ files:
 - 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/finder_api.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
@@ -352,8 +349,6 @@ files:
 - test/email_alert_api_test.rb
 - test/external_link_tracker_test.rb
 - test/fact_cave_test.rb
-- test/finder_api_test.rb
-- test/finder_schema_test.rb
 - test/fixtures/finder_api/cma-case-schema.json
 - test/fixtures/hello.txt
 - test/fixtures/new_policies_for_dwp.json
@@ -417,7 +412,6 @@ test_files:
 - test/publishing_api_test.rb
 - test/whitehall_admin_api_test.rb
 - test/pp_data_in_test.rb
-- test/finder_schema_test.rb
 - test/need_api_test.rb
 - test/publisher_api_test.rb
 - test/rummager_helpers_test.rb
@@ -425,7 +419,6 @@ test_files:
 - test/content_register_test.rb
 - test/fact_cave_test.rb
 - test/test_helpers/panopticon_test.rb
-- test/finder_api_test.rb
 - test/licence_application_api_test.rb
 - test/gov_uk_delivery_test.rb
 - test/maslow_test.rb

data/lib/gds_api/finder_api.rb

@@ -1,30 +0,0 @@
-require_relative 'base'
-require_relative 'finder_schema'
-
-module GdsApi
-  class FinderApi < Base
-    def initialize(url, options = {})
-      @schema_factory = options.fetch(:schema_factory) { FinderSchema.method(:new) }
-      super
-    end
-
-    def get_documents(finder_slug, options = {})
-      get_json(documents_url(finder_slug, options))
-    end
-
-    def get_schema(finder_slug, options = {})
-      @schema_factory.call(
-        get_json(finder_url(finder_slug, 'schema', options)).to_hash
-      )
-    end
-
-  private
-    def documents_url(finder_slug, options = {})
-      finder_url(finder_slug, 'documents', options)
-    end
-
-    def finder_url(finder_slug, action, options = {})
-      "#{endpoint}/finders/#{CGI.escape(finder_slug)}/#{action}.json#{query_string(options)}"
-    end
-  end
-end

data/lib/gds_api/finder_schema.rb

@@ -1,70 +0,0 @@
-class GdsApi::FinderSchema
-  NotFoundError = Class.new(RuntimeError)
-
-  def initialize(schema_hash)
-    @schema_hash = schema_hash
-  end
-
-  def user_friendly_values(document_attributes)
-    document_attributes.each_with_object({}) do |(k, v), values|
-      values.store(
-        k.to_s,
-        {
-          label: user_friendly_facet_label(k.to_s),
-          values: user_friendly_facet_value(k.to_s, v),
-        }
-      )
-    end
-  end
-
-  attr_reader :schema_hash
-  private :schema_hash
-
-  private
-
-  def slug
-    schema_hash.fetch("slug")
-  end
-
-  def user_friendly_facet_label(facet_key)
-    find_facet(facet_key.to_s).fetch("name")
-  end
-
-  def user_friendly_facet_value(facet_key, value)
-    Array(value).map { |value|
-      {
-        label: find_schema_allowed_value_label(facet_key, value),
-        slug: value,
-      }
-    }
-  end
-
-  def find_schema_allowed_value_label(facet_key, value)
-    value_label_pair = allowed_values_for(facet_key)
-      .find { |schema_value|
-        schema_value.fetch("value") == value
-      }
-
-    if value_label_pair.nil?
-      raise_value_not_found_error(facet_key, value)
-    else
-      value_label_pair.fetch("label")
-    end
-  end
-
-  def allowed_values_for(facet_key)
-    find_facet(facet_key).fetch("allowed_values")
-  end
-
-  def find_facet(facet_key)
-    facets.find { |facet| facet.fetch("key") == facet_key }
-  end
-
-  def facets
-    schema_hash.fetch("facets")
-  end
-
-  def raise_value_not_found_error(facet_key, value)
-    raise NotFoundError.new("#{facet_key} value '#{value}' not found in #{slug} schema")
-  end
-end

data/lib/gds_api/test_helpers/finder_api.rb

@@ -1,24 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-
-module GdsApi
-  module TestHelpers
-    module FinderApi
-      FINDER_API_ENDPOINT = Plek.current.find('finder-api')
-
-      def finder_api_has_schema(finder_slug, schema_fixture = FinderApi.schema_fixture)
-        stub_request(:get, "#{FINDER_API_ENDPOINT}/finders/#{finder_slug}/schema.json")
-          .with(:headers => {'Content-Type'=>'application/json'})
-          .to_return(:status => 200, :body => schema_fixture)
-      end
-
-      def self.schema_fixture
-        File.read(
-          File.expand_path(
-            "../../../../test/fixtures/finder_api/cma-case-schema.json",
-            __FILE__
-          )
-        )
-      end
-    end
-  end
-end

data/test/finder_api_test.rb

@@ -1,123 +0,0 @@
-require 'test_helper'
-require 'gds_api/finder_api'
-
-describe GdsApi::FinderApi do
-  let(:base_api_url) { "http://finder-api" }
-  let(:api) {
-    GdsApi::FinderApi.new(
-      base_api_url,
-      schema_factory: schema_factory,
-    )
-  }
-
-  let(:schema) { Object.new }
-  let(:schema_factory) {
-    ->(schema_as_a_hash) { schema }
-  }
-
-  describe "get_documents" do
-    it "should return all documents" do
-      documents_hash = {
-        'documents' => [
-          {
-            'title' => 'A document',
-            'date' => '2014-01-24 00:00:00 +0000',
-            'case_type' => 'market-investigations'
-          },
-          {
-            'title' => 'Blah blah',
-            'date' => '2014-01-25 00:00:00 +0000',
-            'case_type' => 'merger-inquiries'
-          }
-        ]
-      }
-
-      req = WebMock.stub_request(:get, "#{base_api_url}/finders/some-finder-slug/documents.json").
-        to_return(:body => documents_hash.to_json,
-                  :headers => {"Content-type" => "application/json"})
-
-      response = api.get_documents("some-finder-slug")
-      assert_equal 200, response.code
-      assert_equal documents_hash, response.to_hash
-
-      assert_requested(req)
-    end
-
-    it "should forward query parameters" do
-      documents_hash = {
-        'documents' => [
-          {
-            'title' => 'A document',
-            'date' => '2014-01-24 00:00:00 +0000',
-            'case_type' => 'market-investigations'
-          }
-        ]
-      }
-
-      req = WebMock.stub_request(:get, "#{base_api_url}/finders/some-finder-slug/documents.json").
-        with(query: {case_type: 'market-investigations'}).
-        to_return(:body => documents_hash.to_json,
-                  :headers => {"Content-type" => "application/json"})
-
-      response = api.get_documents("some-finder-slug", case_type: 'market-investigations')
-      assert_equal 200, response.code
-      assert_equal documents_hash, response.to_hash
-
-      assert_requested(req)
-    end
-  end
-
-  describe "get_schema" do
-    let(:schema_factory) {
-      Minitest::Mock.new
-        .expect(:call, schema, [schema_hash])
-    }
-
-    let(:schema_hash) {
-      {'it is' => 'a schema'}
-    }
-
-    let(:schema_json) {
-      schema_hash.to_json
-    }
-
-    let(:schema_url) {
-      "#{base_api_url}/finders/cma-cases/schema.json"
-    }
-
-
-    before do
-      @req = WebMock.stub_request(:get, schema_url).
-        to_return(:body => schema_json,
-                  :headers => {"Content-type" => "application/json"})
-    end
-
-    it "requests the finder's schema" do
-      api.get_schema("cma-cases")
-
-      assert_requested(@req)
-    end
-
-    it "constructs and returns a schema object" do
-      returned_schema = api.get_schema("cma-cases")
-
-      assert_equal schema, returned_schema
-      schema_factory.verify
-    end
-
-    it "should forward query parameters" do
-      req = WebMock.stub_request(:get, "#{base_api_url}/finders/some-finder-slug/schema.json").
-        with(query: {locale: 'fr-FR'}).
-        to_return(:body => schema_json,
-                  :headers => {"Content-type" => "application/json"})
-
-      response = api.get_schema("some-finder-slug", locale: 'fr-FR')
-
-      assert_requested(req)
-    end
-
-    it "defaults the schema factory if not provided" do
-      GdsApi::FinderApi.new(base_api_url).get_schema("cma-cases")
-    end
-  end
-end

data/test/finder_schema_test.rb

@@ -1,119 +0,0 @@
-require "test_helper"
-require "gds_api/finder_schema"
-
-describe GdsApi::FinderSchema do
-
-  let(:schema) { GdsApi::FinderSchema.new(schema_hash) }
-
-  let(:schema_hash) {
-    {
-      "slug" => "cma-cases",
-      "name" => "Competition and Markets Authority cases",
-      "document_noun" => "case",
-      "facets" => [
-        {
-          "key" => "case_type",
-          "name" => "Case type",
-          "type" => "single-select",
-          "include_blank" => "All case types",
-          "allowed_values" => [
-            {
-              "label" => "CA98 and civil cartels",
-              "value" => "ca98-and-civil-cartels",
-            },
-          ],
-        },
-        {
-          "key" => "market_sector",
-          "name" => "Market sector",
-          "type" => "single-select",
-          "include_blank" => false,
-          "allowed_values" => [
-            {
-              "label" => "Aerospace",
-              "value" => "aerospace",
-            },
-          ],
-        },
-      ],
-    }
-  }
-
-  describe "#user_friendly_values" do
-    let(:document_attrs) {
-      {
-        case_type: "ca98-and-civil-cartels",
-        market_sector: "aerospace",
-      }
-    }
-
-    let(:formatted_attrs) {
-      {
-        "case_type" => {
-          :label => "Case type",
-          :values => [
-            {
-              :label => "CA98 and civil cartels",
-              :slug => "ca98-and-civil-cartels"
-            }
-          ]
-        }, 
-        "market_sector" => {
-          :label => "Market sector",
-          :values => [
-            {
-              :label => "Aerospace",
-              :slug=>"aerospace"
-            }
-          ]
-        }
-      }
-    }
-
-    it "formats the given keys and values" do
-      schema.user_friendly_values(document_attrs).must_equal(formatted_attrs)
-    end
-
-    describe "when a value is not found" do
-      let(:document_attrs) {
-        {
-          market_sector: "does-not-exist"
-        }
-      }
-
-      it "raises an error" do
-        ->(){
-          schema.user_friendly_values(document_attrs)
-        }.must_raise(
-          GdsApi::FinderSchema::NotFoundError,
-          "market sector 'does-not-exist' not found in cma-cases schema")
-      end
-    end
-
-    describe "when a value is an array of values" do
-      let(:document_attrs) {
-        {
-          market_sector: ["aerospace"],
-        }
-      }
-
-      let(:formatted_attrs) {
-        {
-          "market_sector" => {
-            :label => "Market sector",
-            :values => [
-              {
-                :label => "Aerospace",
-                :slug=>"aerospace"
-              }
-            ]
-          }
-        }
-      }
-
-      it "formats the given keys and values" do
-        schema.user_friendly_values(document_attrs).must_equal(formatted_attrs)
-      end
-    end
-  end
-end