gds-api-adapters 0.0.12 → 0.0.13

data/README.md

@@ -1,4 +1,5 @@
-A set of API adapters to work with the GDS APIs, extracted from the frontend app.
+A set of API adapters to work with the GDS APIs, extracted from the frontend
+app.
 
 Example usage:
 
@@ -12,38 +13,47 @@ Very much still a work in progress.
 
 ## Logging
 
-Each HTTP request is logged as JSON. Example:
+Each HTTP request can be logged as JSON. Example:
 
     {
       "request_uri":"http://contactotron.platform/contacts/1",
-      "start_time":"2011-12-10 21:18:33 +0000",
+      "start_time":1324035128.9056342,
       "status":"success",
-      "end_time":"2011-12-10 21:18:33 +0000"
+      "end_time":1324035129.2017104
     }
 
-By default it is logged to STDOUT using the ruby logger. To override that set GdsApi::Base.logger
+
+By default we log to a NullLogger since we don't want to pollute your test
+results or logs. To log output you'll want to set `GdsApi::Base.logger` to
+something that actually logs:
 
     GdsApi::Base.logger = Logger.new("/path/to/file.log")
 
 ## Test Helpers
 
-There are also test helpers for stubbing various requests in other apps. Example usage of 
-the panopticon helper:
+There are also test helpers for stubbing various requests in other apps.
+Example usage of the panopticon helper:
 
 In test_helper.rb:
 
     require 'gds_api/test_helpers/panopticon'
-    
+
     class ActiveSupport::TestCase
       include GdsApi::TestHelpers::Panopticon
     end
 
 In the test:
-  
-    panopticon_has_metadata('id' => 12345, 'need_id' => need.id, 'slug' => 'my_slug')
+
+    panopticon_has_metadata('id' => 12345, 'need_id' => need.id,
+      'slug' => 'my_slug')
 
 This presumes you have webmock installed and enabled.
 
 ## To Do
 
 * Make timeout handling work
+
+## Licence
+
+Released under the MIT Licence, a copy of which can be found in the file
+`LICENCE`.

data/lib/gds_api/base.rb

@@ -5,6 +5,8 @@ require 'null_logger'
 class GdsApi::Base
   include GdsApi::JsonUtils
 
+  attr_reader :options
+  
   class << self
     attr_writer :logger
   end
@@ -13,12 +15,20 @@ class GdsApi::Base
     @logger ||= NullLogger.instance
   end
 
-  def initialize(platform, endpoint_url=nil)
-    adapter_name = self.class.to_s.split("::").last.downcase
-
-    self.endpoint = endpoint_url || endpoint_for_platform(adapter_name, platform)
+  def initialize(platform, options_or_endpoint_url=nil, maybe_options=nil)
+    if options_or_endpoint_url.is_a?(String)
+      @options = maybe_options || {}
+      @options[:endpoint_url] = options_or_endpoint_url
+    else
+      @options = options_or_endpoint_url || {}
+    end
+    self.endpoint = options[:endpoint_url] || endpoint_for_platform(adapter_name, platform)
   end
 
+  def adapter_name
+    self.class.to_s.split("::").last.downcase
+  end
+    
   def url_for_slug(slug, options={})
     base = "#{base_url}/#{slug}.json#{query_string(options)}"
   end

data/lib/gds_api/contactotron.rb

@@ -5,9 +5,6 @@ require_relative 'base'
 # and convert it to an ostruct.
 class GdsApi::Contactotron < GdsApi::Base
 
-  def initialize
-  end
-
   def contact_for_uri(uri)
     to_ostruct get_json(uri)
   end

data/lib/gds_api/json_utils.rb

@@ -11,7 +11,7 @@ module GdsApi::JsonUtils
     'Content-Type' => 'application/json',
     'User-Agent' => "GDS Api Client v. #{GdsApi::VERSION}"
   }
-  TIMEOUT_IN_SECONDS = 0.5
+  DEFAULT_TIMEOUT_IN_SECONDS = 0.5
 
   def do_request(url, &block)
     loggable = {request_uri: url, start_time: Time.now.to_f}
@@ -22,7 +22,7 @@ module GdsApi::JsonUtils
     logger.debug "I will request #{request}"
 
     response = Net::HTTP.start(url.host, url.port) do |http|
-      http.read_timeout = TIMEOUT_IN_SECONDS
+      http.read_timeout = options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS
       yield http, request
     end
 
@@ -30,14 +30,19 @@ module GdsApi::JsonUtils
       logger.info loggable.merge(status: 'success', end_time: Time.now).to_json
       JSON.parse(response.body)
     else
-      loggable.merge!(status: '404', end_time: Time.now.to_f)
+      body = begin
+        JSON.parse(response.body)
+      rescue
+        response.body
+      end
+      loggable.merge!(status: response.code, end_time: Time.now.to_f, body: body)
       logger.warn loggable.to_json
       nil
     end
   rescue Errno::ECONNREFUSED
     logger.error loggable.merge(status: 'refused', end_time: Time.now.to_f).to_json
     raise GdsApi::EndpointNotFound.new("Could not connect to #{url}")
-  rescue Timeout::Error, Errno::ECONNRESET
+  rescue Timeout::Error, Errno::ECONNRESET => e
     logger.error loggable.merge(status: 'failed', end_time: Time.now.to_f).to_json
     nil
   end
@@ -59,6 +64,12 @@ module GdsApi::JsonUtils
     end
   end
 
+  def put_json(url, params)
+    do_request(url) do |http, path|
+      http.put(path, params.to_json, REQUEST_HEADERS)
+    end
+  end
+  
   def to_ostruct(object)
     case object
     when Hash

data/lib/gds_api/panopticon.rb

@@ -13,6 +13,14 @@ class GdsApi::Panopticon < GdsApi::Base
     end
   end
 
+  def create_artefact(artefact)
+    post_json(base_url + ".json", artefact)
+  end
+  
+  def update_artefact(id_or_slug, artefact)
+    put_json("#{base_url}/#{id_or_slug}.json", artefact)
+  end
+  
 private
   def base_url
     "#{endpoint}/artefacts"

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

data/test/contactotron_api_test.rb

@@ -6,7 +6,7 @@ class ContactotronApiTest < MiniTest::Unit::TestCase
   include GdsApi::TestHelpers::Contactotron
   
   def api
-    GdsApi::Contactotron.new
+    GdsApi::Contactotron.new "test"
   end
 
   def test_should_fetch_and_parse_JSON_into_ostruct

data/test/gds_api_base_test.rb

@@ -54,5 +54,15 @@ class GdsApiBaseTest < MiniTest::Unit::TestCase
     u = URI.parse(url)
     assert_match /^concreteapi\.test/, u.host
   end
-
+  
+  def test_should_treat_second_positional_arg_as_endpoint_url_if_string
+    api = ConcreteApi.new("test", "endpoint")
+    assert_equal "endpoint", api.options[:endpoint_url]
+  end
+  
+  def test_should_accept_options_as_second_arg
+    api = ConcreteApi.new("test", {endpoint_url: "endpoint", foo: "bar"})
+    assert_equal "endpoint", api.options[:endpoint_url]
+    assert_equal "bar", api.options[:foo]
+  end
 end

data/test/json_utils_test.rb

@@ -1,6 +1,25 @@
+require_relative 'test_helper'
+require 'gds_api/json_utils'
+require 'rack'
+
+StubRackApp = lambda do |env|
+  sleep(30)
+  body = '{"some":"value"}'
+  [200, {"Content-Type" => "text/plain", "Content-Length" => body.length.to_s}, [body]]
+end
+
 class JsonUtilsTest < MiniTest::Unit::TestCase
   include GdsApi::JsonUtils
 
+  def options; {}; end
+  def pending_test_long_requests_timeout
+    url = "http://www.example.com/timeout.json"
+    stub_request(:get, url).to_rack(StubRackApp)
+    assert_raises GdsApi::TimedOut do
+      get_json(url)
+    end
+  end
+
   def test_get_returns_nil_on_timeout
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_raise(Timeout::Error)
@@ -40,5 +59,11 @@ class JsonUtilsTest < MiniTest::Unit::TestCase
     stub_request(:get, url).to_return(:body => "{}", :status => 404)
     assert_nil get_json(url)
   end
-
+    
+  def test_put_json_does_put_with_json_encoded_packet
+    url = "http://some.endpoint/some.json"
+    payload = {a:1}
+    stub_request(:put, url).with(body: payload.to_json).to_return(:body => "{}", :status => 200)
+    assert_equal({}, put_json(url, payload))
+  end
 end

data/test/panopticon_api_test.rb

@@ -65,4 +65,22 @@ class PanopticonApiTest < MiniTest::Unit::TestCase
     assert_equal 'Department for Environment, Food and Rural Affairs (Defra)', artefact.contact.name
     assert_equal 'helpline@defra.gsi.gov.uk', artefact.contact.email_address
   end
+  
+  def test_can_create_a_new_artefact
+    url = "#{PANOPTICON_ENDPOINT}/artefacts.json"
+    stub_request(:post, url)
+      .with(body: basic_artefact.to_json)
+      .to_return(body: basic_artefact.merge(id: 1).to_json)
+    
+    api.create_artefact(basic_artefact)
+  end
+  
+  def test_can_update_existing_artefact
+    url = "#{PANOPTICON_ENDPOINT}/artefacts/1.json"
+    stub_request(:put, url)
+      .with(body: basic_artefact.to_json)
+      .to_return(status: 200, body: '{}')
+    
+    api.update_artefact(1, basic_artefact)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-16 00:00:00.000000000Z
+date: 2011-12-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
-  requirement: &70352751469560 !ruby/object:Gem::Requirement
+  requirement: &70165614975140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70352751469560
+  version_requirements: *70165614975140
 - !ruby/object:Gem::Dependency
   name: null_logger
-  requirement: &70352751468900 !ruby/object:Gem::Requirement
+  requirement: &70165614974680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70352751468900
+  version_requirements: *70165614974680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70352751468040 !ruby/object:Gem::Requirement
+  requirement: &70165614974160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70352751468040
+  version_requirements: *70165614974160
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70352751467360 !ruby/object:Gem::Requirement
+  requirement: &70165614973620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *70352751467360
+  version_requirements: *70165614973620
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70352751466220 !ruby/object:Gem::Requirement
+  requirement: &70165614973220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70352751466220
+  version_requirements: *70165614973220
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70352751465500 !ruby/object:Gem::Requirement
+  requirement: &70165614972680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -76,10 +76,10 @@ dependencies:
         version: 0.4.2
   type: :development
   prerelease: false
-  version_requirements: *70352751465500
+  version_requirements: *70165614972680
 - !ruby/object:Gem::Dependency
   name: simplecov-rcov
-  requirement: &70352751464720 !ruby/object:Gem::Requirement
+  requirement: &70165614972260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70352751464720
+  version_requirements: *70165614972260
 description: A set of adapters providing easy access to the GDS gov.uk APIs
 email:
 - jystewart@gmail.com