gds-api-adapters 7.1.0 → 7.2.0

data/lib/gds_api/fact_cave.rb

@@ -0,0 +1,12 @@
+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/helpers.rb

@@ -5,6 +5,7 @@ require 'gds_api/content_api'
 require 'gds_api/licence_application'
 require 'gds_api/asset_manager'
 require 'gds_api/worldwide'
+require 'gds_api/fact_cave'
 
 module GdsApi
   module Helpers
@@ -16,6 +17,10 @@ module GdsApi
       @content_api ||= GdsApi::ContentApi.new(Plek.current.find("contentapi"), 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/fact_cave.rb

@@ -0,0 +1,44 @@
+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, extra_attrs={})
+        response = fact_for_slug(slug, value).merge(extra_attrs)
+
+        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
+
+      def fact_for_slug(slug, value = "Sample Value")
+        singular_response_base.merge({
+          "id" => "#{FACT_CAVE_ENDPOINT}/facts/#{slug}",
+          "details" => {
+            "description" => "",
+            "value" => value,
+          },
+          "name" => titleize_slug(slug),
+          "updated_at" => Time.now.utc.xmlschema,
+        })
+      end
+    end
+  end
+end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.1.0'
+  VERSION = '7.2.0'
 end

data/test/fact_cave_test.rb

@@ -0,0 +1,39 @@
+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::HTTPErrorResponse) 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

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 7.1.0
+  version: 7.2.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-03 00:00:00 Z
+date: 2013-06-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -200,6 +200,7 @@ files:
 - lib/gds_api/mapit.rb
 - lib/gds_api/exceptions.rb
 - lib/gds_api/list_response.rb
+- lib/gds_api/fact_cave.rb
 - lib/gds_api/json_client.rb
 - lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/response.rb
@@ -210,6 +211,7 @@ files:
 - lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/test_helpers/content_api.rb
 - lib/gds_api/test_helpers/mapit.rb
+- lib/gds_api/test_helpers/fact_cave.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
 - lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/asset_manager.rb
@@ -234,6 +236,7 @@ files:
 - test/test_helper.rb
 - test/list_response_test.rb
 - test/worldwide_api_test.rb
+- test/fact_cave_test.rb
 - test/fixtures/world_organisations_australia.json
 - test/fixtures/hello.txt
 - test/response_test.rb
@@ -254,7 +257,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1472364090859651365
+      hash: 2886790745514714453
       segments: 
       - 0
       version: "0"
@@ -263,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1472364090859651365
+      hash: 2886790745514714453
       segments: 
       - 0
       version: "0"
@@ -286,6 +289,7 @@ test_files:
 - test/test_helper.rb
 - test/list_response_test.rb
 - test/worldwide_api_test.rb
+- test/fact_cave_test.rb
 - test/fixtures/world_organisations_australia.json
 - test/fixtures/hello.txt
 - test/response_test.rb