gds-api-adapters 1.1.0 → 1.3.0

data/lib/gds_api/panopticon/registerer.rb

@@ -12,6 +12,7 @@ module GdsApi
         @kind = options[:kind] || 'custom-application'
         @panopticon = options[:panopticon]
         @platform = options[:platform] || Plek.current.environment
+        @timeout = options[:timeout] || 10
       end
 
       def record_to_artefact(record)
@@ -59,7 +60,7 @@ module GdsApi
 
       def panopticon
         options = {
-          timeout: 5
+          timeout: @timeout
         }
         @panopticon ||= GdsApi::Panopticon.new(@platform, options.merge(panopticon_api_credentials))
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/test/panopticon_registerer_test.rb

@@ -0,0 +1,55 @@
+require_relative 'test_helper'
+require 'gds_api/panopticon'
+
+describe GdsApi::Panopticon::Registerer do
+
+
+  describe "creating an instance of the panopticon client" do
+    describe "setting the platform" do
+      it "should create an instance using the current Plek environment as the platform by default" do
+        Plek.stubs(:current).returns(stub(environment: "Something"))
+
+        GdsApi::Panopticon.expects(:new).with("Something", anything()).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({})
+        assert_equal :panopticon_instance, r.send(:panopticon)
+      end
+
+      it "should allow overriding the platform" do
+        Plek.stubs(:current).returns(stub(environment: "Something"))
+
+        GdsApi::Panopticon.expects(:new).with("Something_else", anything()).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({platform: "Something_else"})
+        assert_equal :panopticon_instance, r.send(:panopticon)
+      end
+    end
+
+    describe "setting other options" do
+      it "should create an instance with a default timeout of 10 seconds" do
+        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 10}).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({})
+        assert_equal :panopticon_instance, r.send(:panopticon)
+      end
+
+      it "should allow overriding the timeout" do
+        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 15}).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({timeout: 15})
+        assert_equal :panopticon_instance, r.send(:panopticon)
+      end
+
+      it "shoule merge in the api credentials" do
+        GdsApi::Panopticon::Registerer.any_instance.stubs(:panopticon_api_credentials).returns({foo: "Bar", baz: "kablooie"})
+        GdsApi::Panopticon.expects(:new).with(anything(), {timeout: 10, foo: "Bar", baz: "kablooie"}).returns(:panopticon_instance)
+        r = GdsApi::Panopticon::Registerer.new({})
+        assert_equal :panopticon_instance, r.send(:panopticon)
+      end
+    end
+
+    it "should memoize the panopticon instance" do
+      GdsApi::Panopticon.expects(:new).once.returns(:panopticon_instance)
+      r = GdsApi::Panopticon::Registerer.new({})
+
+      assert_equal :panopticon_instance, r.send(:panopticon)
+      assert_equal :panopticon_instance, r.send(:panopticon)
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-23 00:00:00 Z
+date: 2012-08-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -46,8 +46,19 @@ dependencies:
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: rdoc
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "3.12"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -55,10 +66,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: webmock
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -66,10 +77,10 @@ dependencies:
         version: "1.8"
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -77,10 +88,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: minitest
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -88,10 +99,10 @@ dependencies:
         version: 2.10.0
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -99,10 +110,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: simplecov
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -110,10 +121,10 @@ dependencies:
         version: 0.5.4
   type: :development
   prerelease: false
-  version_requirements: *id009
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: simplecov-rcov
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -121,10 +132,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id010
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: gem_publisher
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -132,7 +143,7 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *id011
+  version_requirements: *id012
 description: A set of adapters providing easy access to the GDS gov.uk APIs
 email: 
 - jystewart@gmail.com
@@ -143,38 +154,39 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/gds_api/version.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/panopticon/registerer.rb
-- lib/gds_api/typhoeus_client.rb
-- lib/gds_api/imminence.rb
-- lib/gds_api/contactotron.rb
-- lib/gds_api/test_helpers/publisher.rb
-- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/licence_application.rb
 - lib/gds_api/test_helpers/contactotron.rb
-- lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/licence_application.rb
-- lib/gds_api/base.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/response.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/core-ext/openstruct.rb
-- lib/gds_api/oauth2_client.rb
+- lib/gds_api/test_helpers/publisher.rb
+- lib/gds_api/test_helpers/panopticon.rb
+- lib/gds_api/test_helpers/imminence.rb
 - lib/gds_api/part_methods.rb
 - lib/gds_api/needotron.rb
+- lib/gds_api/typhoeus_client.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/contactotron.rb
+- lib/gds_api/oauth2_client.rb
+- lib/gds_api/response.rb
+- lib/gds_api/panopticon/registerer.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/exceptions.rb
+- lib/gds_api/version.rb
 - lib/gds_api/helpers.rb
+- lib/gds_api/base.rb
+- lib/gds_api/panopticon.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/imminence.rb
 - README.md
 - Rakefile
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/imminence_api_test.rb
-- test/json_client_test.rb
-- test/gds_api_base_test.rb
+- test/contactotron_api_test.rb
 - test/licence_application_api_test.rb
+- test/json_client_test.rb
+- test/publisher_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/panopticon_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -188,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4250669656012288164
+      hash: -3021938998109675237
       segments: 
       - 0
       version: "0"
@@ -197,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4250669656012288164
+      hash: -3021938998109675237
       segments: 
       - 0
       version: "0"
@@ -209,11 +221,12 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/imminence_api_test.rb
-- test/json_client_test.rb
-- test/gds_api_base_test.rb
+- test/contactotron_api_test.rb
 - test/licence_application_api_test.rb
+- test/json_client_test.rb
+- test/publisher_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/panopticon_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb