gds-api-adapters 10.5.0 → 10.6.0

data/lib/gds_api/finder_api.rb

@@ -1,13 +1,21 @@
 require_relative 'base'
+require_relative 'finder_schema'
 
 module GdsApi
   class FinderApi < Base
+    def initialize(url, options, &block)
+      @schema_factory = options.fetch(:schema_factory) { Schema.method(:new) }
+      super(url, options, &block)
+    end
+
     def get_documents(finder_slug, options = {})
       get_json(documents_url(finder_slug, options))
     end
 
     def get_schema(finder_slug, options = {})
-      get_json(finder_url(finder_slug, 'schema', options))
+      @schema_factory.call(
+        get_json(finder_url(finder_slug, 'schema', options)).to_hash
+      )
     end
 
   private

data/lib/gds_api/finder_schema.rb

@@ -0,0 +1,58 @@
+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(
+        user_friendly_facet_label(k.to_s),
+        find_schema_allowed_value_entry(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 find_schema_allowed_value_entry(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/helpers.rb

@@ -8,6 +8,7 @@ require 'gds_api/need_api'
 require 'gds_api/panopticon'
 require 'gds_api/publisher'
 require 'gds_api/worldwide'
+require 'gds_api/finder_api'
 
 module GdsApi
   module Helpers
@@ -55,6 +56,10 @@ 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 self.included(klass)
       if klass.respond_to?(:helper_method)
         klass.helper_method :publisher_api, :panopticon_api, :imminence_api, :content_api, :licence_application_api

data/lib/gds_api/test_helpers/finder_api.rb

@@ -0,0 +1,24 @@
+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/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '10.5.0'
+  VERSION = '10.6.0'
 end

data/test/finder_api_test.rb

@@ -4,9 +4,14 @@ require 'gds_api/finder_api'
 describe GdsApi::FinderApi do
   before do
     @base_api_url = Plek.current.find('finder-api')
-    @api = GdsApi::FinderApi.new(@base_api_url)
+    @api = GdsApi::FinderApi.new(@base_api_url, schema_factory: schema_factory)
   end
 
+  let(:schema) { Object.new }
+  let(:schema_factory) {
+    ->(schema_as_a_hash) { schema }
+  }
+
   describe "get_documents" do
     it "should return all documents" do
       documents_hash = {
@@ -60,6 +65,11 @@ describe GdsApi::FinderApi do
   end
 
   describe "get_schema" do
+    let(:schema_factory) {
+      Minitest::Mock.new
+        .expect(:call, schema, [schema_hash])
+    }
+
     let(:schema_hash) {
       {'it is' => 'a schema'}
     }
@@ -69,21 +79,32 @@ describe GdsApi::FinderApi do
     }
 
     let(:schema_url) {
-      "#{@base_api_url}/finders/some-finder-slug/schema.json"
+      "#{@base_api_url}/finders/cma-cases/schema.json"
     }
 
-    it "should return the finder's schema" do
+    it "requests the finder's schema" do
       req = WebMock.stub_request(:get, schema_url).
         to_return(:body => schema_json,
                   :headers => {"Content-type" => "application/json"})
 
-      response = @api.get_schema("some-finder-slug")
-      assert_equal 200, response.code
-      assert_equal schema_hash, response.to_hash
+      response = @api.get_schema("cma-cases")
 
       assert_requested(req)
     end
 
+    it "constructs and returns a schema object" do
+      WebMock.stub_request(:get, schema_url)
+        .to_return(
+          :body => schema_json,
+          :headers => {"Content-type" => "application/json"},
+        )
+
+      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'}).
@@ -91,8 +112,6 @@ describe GdsApi::FinderApi do
                   :headers => {"Content-type" => "application/json"})
 
       response = @api.get_schema("some-finder-slug", locale: 'fr-FR')
-      assert_equal 200, response.code
-      assert_equal schema_hash, response.to_hash
 
       assert_requested(req)
     end

data/test/finder_schema_test.rb

@@ -0,0 +1,77 @@
+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" => "CA98 and civil cartels",
+        "Market sector" => "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
+  end
+end

data/test/fixtures/finder_api/cma-case-schema.json

@@ -0,0 +1,103 @@
+{
+  "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"},
+          {"label": "Consumer enforcement", "value": "consumer-enforcement"},
+          {"label": "Criminal cartels", "value": "criminal-cartels"},
+          {"label": "Markets", "value": "markets"},
+          {"label": "Mergers", "value": "mergers"},
+          {"label": "Regulatory references and appeals", "value": "regulatory-references-and-appeals"},
+          {"label": "Reviews of orders and undertakings", "value": "review-of-orders-and-undertakings"}
+        ]
+    },
+
+    {
+      "key": "case_state",
+      "name": "Case state",
+      "type": "single-select",
+      "include_blank": false,
+      "allowed_values": [
+        {"label": "Open", "value": "open"},
+        {"label": "Closed", "value": "closed"}
+      ]
+    },
+
+    {
+      "key": "market_sector",
+      "name": "Market sector",
+      "type": "single-select",
+      "include_blank": false,
+      "allowed_values": [
+        {"label": "Aerospace", "value": "aerospace"},
+        {"label": "Agriculture, environment and natural resources", "value": "agriculture-environment-and-natural-resources"},
+        {"label": "Building and construction", "value": "building-and-construction"},
+        {"label": "Chemicals", "value": "chemicals"},
+        {"label": "Clothing, footwear and fashion", "value": "clothing-footwear-and-fashion"},
+        {"label": "Communications", "value": "communications"},
+        {"label": "Defence", "value": "defence"},
+        {"label": "Distribution and Service Industries", "value": "distribution-and-service-industries"},
+        {"label": "Electronics Industry", "value": "electronics-industry"},
+        {"label": "Energy", "value": "energy"},
+        {"label": "Engineering", "value": "engineering"},
+        {"label": "Financial services", "value": "financial-services"},
+        {"label": "Fire, police, and security", "value": "fire-police-and-security"},
+        {"label": "Food manufacturing", "value": "food-manufacturing"},
+        {"label": "Giftware, jewellery and tableware", "value": "giftware-jewellery-and-tableware"},
+        {"label": "Healthcare and medical equipment", "value": "healthcare-and-medical-equipment"},
+        {"label": "Household goods, furniture and furnishings", "value": "household-goods-furniture-and-furnishings"},
+        {"label": "Mineral extraction, mining and quarrying", "value": "mineral-extraction-mining-and-quarrying"},
+        {"label": "Motor Industry", "value": "motor-industry"},
+        {"label": "Oil and Gas refining and Petrochemicals", "value": "oil-and-gas-refining-and-petrochemicals"},
+        {"label": "Paper printing and packaging", "value": "paper-printing-and-packaging"},
+        {"label": "Pharmaceuticals", "value": "pharmaceuticals"},
+        {"label": "Public markets", "value": "public-markets"},
+        {"label": "Recreation and Leisure", "value": "recreation-and-leisure"},
+        {"label": "Retail and wholesale", "value": "retail-and-wholesale"},
+        {"label": "Telecommunications", "value": "telecommunications"},
+        {"label": "Textiles", "value": "textiles"},
+        {"label": "Transport", "value": "transport"},
+        {"label": "Utilities", "value": "utilities"}
+      ]
+    },
+
+    {
+      "key": "outcome_type",
+      "name": "Outcome",
+      "type": "single-select",
+      "include_blank": false,
+      "allowed_values": [
+        {"label": "CA98 - administrative priorities", "value": "ca98-administrative-priorities"},
+        {"label": "CA98 - commitment", "value": "ca98-commitment"},
+        {"label": "CA98 - infringement Chapter I", "value": "ca98-infringement-chapter-i"},
+        {"label": "CA98 - infringement Chapter II", "value": "ca98-infringement-chapter-ii"},
+        {"label": "CA98 - no grounds for action/non-infringement", "value": "ca98-no-grounds-for-action-non-infringement"},
+        {"label": "Consumer enforcement - court order", "value": "consumer-enforcement-court-order"},
+        {"label": "Consumer enforcement - no action", "value": "consumer-enforcement-no-action"},
+        {"label": "Consumer enforcement - undertakings", "value": "consumer-enforcement-undertakings"},
+        {"label": "Criminal cartels - verdict", "value": "criminal-cartels-verdict"},
+        {"label": "Markets - phase 1 no enforcement action", "value": "markets-phase-1-no-enforcement-action"},
+        {"label": "Markets - phase 1 referral", "value": "markets-phase-1-referral"},
+        {"label": "Markets - phase 1 undertakings in lieu of reference", "value": "markets-phase-1-undertakings-in-lieu-of-reference"},
+        {"label": "Markets - phase 2 adverse effect on competition leading to remedies", "value": "markets-phase-2-adverse-effect-on-competition-leading-to-remedies"},
+        {"label": "Markets - phase 2 clearance - no adverse effect on competition", "value": "markets-phase-2-clearance-no-adverse-effect-on-competition"},
+        {"label": "Markets - phase 2 decision to dispense with procedural obligations", "value": "markets-phase-2-decision-to-dispense-with-procedural-obligations"},
+        {"label": "Mergers - phase 1 clearance with undertakings in lieu", "value": "mergers-phase-1-clearance-with-undertakings-in-lieu"},
+        {"label": "Mergers - phase 1 clearance", "value": "mergers-phase-1-clearance"},
+        {"label": "Mergers - phase 1 found not to qualify", "value": "mergers-phase-1-found-not-to-qualify"},
+        {"label": "Mergers - phase 1 referral", "value": "mergers-phase-1-referral"},
+        {"label": "Mergers - phase 2 clearance with remedies", "value": "mergers-phase-2-clearance-with-remedies"},
+        {"label": "Mergers - phase 2 clearance", "value": "mergers-phase-2-clearance"},
+        {"label": "Mergers - phase 2 prohibition", "value": "mergers-phase-2-prohibition"},
+        {"label": "Regulatory references and appeals - final determination", "value": "regulatory-references-and-appeals-final-determination"}
+      ]
+    }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 10.5.0
+  version: 10.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -282,6 +282,7 @@ files:
 - lib/gds_api/finder_api.rb
 - lib/gds_api/railtie.rb
 - lib/gds_api/exceptions.rb
+- lib/gds_api/finder_schema.rb
 - lib/gds_api/performance_platform/data_in.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/base.rb
@@ -291,6 +292,7 @@ files:
 - lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/test_helpers/support.rb
 - lib/gds_api/test_helpers/need_api.rb
+- lib/gds_api/test_helpers/finder_api.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/performance_platform/data_in.rb
 - lib/gds_api/test_helpers/licence_application.rb
@@ -333,6 +335,7 @@ files:
 - test/support_api_test.rb
 - test/mapit_test.rb
 - test/pp_data_in_test.rb
+- test/finder_schema_test.rb
 - test/need_api_test.rb
 - test/publisher_api_test.rb
 - test/fact_cave_test.rb
@@ -351,6 +354,7 @@ files:
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/world_organisations_australia.json
+- test/fixtures/finder_api/cma-case-schema.json
 - test/router_test.rb
 - test/list_response_test.rb
 - test/external_link_tracker_test.rb
@@ -372,7 +376,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3888185947824795971
+      hash: 1564566442515579197
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -381,7 +385,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3888185947824795971
+      hash: 1564566442515579197
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -392,6 +396,7 @@ test_files:
 - test/support_api_test.rb
 - test/mapit_test.rb
 - test/pp_data_in_test.rb
+- test/finder_schema_test.rb
 - test/need_api_test.rb
 - test/publisher_api_test.rb
 - test/fact_cave_test.rb
@@ -410,6 +415,7 @@ test_files:
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt
 - test/fixtures/world_organisations_australia.json
+- test/fixtures/finder_api/cma-case-schema.json
 - test/router_test.rb
 - test/list_response_test.rb
 - test/external_link_tracker_test.rb