gds-api-adapters 0.0.24 → 0.0.26

data/lib/gds_api/exceptions.rb

@@ -1,4 +1,7 @@
 module GdsApi
   class EndpointNotFound < StandardError
   end
+
+  class TimedOutException < Exception
+  end
 end

data/lib/gds_api/json_client.rb

@@ -5,18 +5,18 @@ require_relative 'version'
 module GdsApi
   class JsonClient
     attr_accessor :logger, :options
-    
+
     def initialize(options = {})
       @logger = options[:logger] || GdsApi::Base.logger
       @options = options
     end
-    
+
     REQUEST_HEADERS = {
-      'Accept' => 'application/json', 
-      'Content-Type' => 'application/json',
-      'User-Agent' => "GDS Api Client v. #{GdsApi::VERSION}"
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'User-Agent' => "GDS Api Client v. #{GdsApi::VERSION}"
     }
-    DEFAULT_TIMEOUT_IN_SECONDS = 0.5
+    DEFAULT_TIMEOUT_IN_SECONDS = 2
 
     def get_json(url)
       do_request(Net::HTTP::Get, url)
@@ -29,9 +29,8 @@ module GdsApi
     def put_json(url, params)
       do_request(Net::HTTP::Put, url, params)
     end
-  
-  private
-  
+
+    private
     def do_request(method_class, url, params = nil)
       loggable = {request_uri: url, start_time: Time.now.to_f}
       start_logging = loggable.merge(action: 'start')
@@ -41,7 +40,7 @@ module GdsApi
       path = url.path
       path = path + "?" + url.query if url.query
 
-      response = Net::HTTP.start(url.host, url.port, nil, nil, nil, nil, {use_ssl: url.port == 443, verify_mode: (OpenSSL::SSL::VERIFY_NONE if url.port == 443) }) do |http|
+      response = Net::HTTP.start(url.host, url.port, nil, nil, nil, nil, {use_ssl: url.port == 443, verify_mode: (OpenSSL::SSL::VERIFY_NONE if url.port == 443)}) do |http|
         http.read_timeout = options[:timeout] || DEFAULT_TIMEOUT_IN_SECONDS
         request = method_class.new(path, REQUEST_HEADERS)
         request.basic_auth(@options[:basic_auth][:user], @options[:basic_auth][:password]) if @options[:basic_auth]
@@ -67,7 +66,7 @@ module GdsApi
       raise GdsApi::EndpointNotFound.new("Could not connect to #{url}")
     rescue Timeout::Error, Errno::ECONNRESET => e
       logger.error loggable.merge(status: 'failed', end_time: Time.now.to_f).to_json
-      nil
+      raise GdsApi::TimedOutException.new
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '0.0.24'
+  VERSION = '0.0.26'
 end

data/test/json_client_test.rb

@@ -1,35 +1,25 @@
 require_relative 'test_helper'
 require 'gds_api/base'
 require 'gds_api/json_client'
-require 'rack'
 require 'base64'
 
-StubRackApp = lambda do |env|
-  sleep(30)
-  body = '{"some":"value"}'
-  [200, {"Content-Type" => "text/plain", "Content-Length" => body.length.to_s}, [body]]
-end
-
 class JsonClientTest < MiniTest::Spec
   def setup
     @client = GdsApi::JsonClient.new
   end
 
-  def options; {}; end
-  def pending_test_long_requests_timeout
+  def options;
+    {}
+  end
+
+  def test_long_get_requests_timeout
     url = "http://www.example.com/timeout.json"
-    stub_request(:get, url).to_rack(StubRackApp)
-    assert_raises GdsApi::TimedOut do
+    stub_request(:get, url).to_timeout
+    assert_raises GdsApi::TimedOutException do
       @client.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)
-    assert_nil @client.get_json(url)
-  end
-
   def test_get_should_raise_endpoint_not_found_if_connection_refused
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_raise(Errno::ECONNREFUSED)
@@ -46,15 +36,17 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
-  def test_post_returns_nil_on_timeout
+  def test_post_requests_timeout
     url = "http://some.endpoint/some.json"
-    stub_request(:post, url).to_raise(Timeout::Error)
-    assert_nil @client.post_json(url, {})
+    stub_request(:post, url).to_timeout
+    assert_raises GdsApi::TimedOutException do
+      @client.post_json(url, {})
+    end
   end
 
   def test_should_fetch_and_parse_json_into_response
     url = "http://some.endpoint/some.json"
-    stub_request(:get, url).to_return(:body => "{}",:status => 200)
+    stub_request(:get, url).to_return(:body => "{}", :status => 200)
     assert_equal GdsApi::Response, @client.get_json(url).class
   end
 
@@ -63,30 +55,30 @@ class JsonClientTest < MiniTest::Spec
     stub_request(:get, url).to_return(:body => "{}", :status => 404)
     assert_nil @client.get_json(url)
   end
-    
+
   def empty_response
     net_http_response = stub(:body => '{}')
     GdsApi::Response.new(net_http_response)
   end
-  
+
   def test_put_json_does_put_with_json_encoded_packet
     url = "http://some.endpoint/some.json"
-    payload = {a:1}
+    payload = {a: 1}
     stub_request(:put, url).with(body: payload.to_json).to_return(:body => "{}", :status => 200)
     assert_equal({}, @client.put_json(url, payload).to_hash)
   end
-  
+
   def test_can_convert_response_to_ostruct
     url = "http://some.endpoint/some.json"
-    payload = {a:1}
+    payload = {a: 1}
     stub_request(:put, url).with(body: payload.to_json).to_return(:body => '{"a":1}', :status => 200)
     response = @client.put_json(url, payload)
-    assert_equal(OpenStruct.new(a:1), response.to_ostruct)
+    assert_equal(OpenStruct.new(a: 1), response.to_ostruct)
   end
-  
+
   def test_can_access_attributes_of_response_directly
     url = "http://some.endpoint/some.json"
-    payload = {a:1}
+    payload = {a: 1}
     stub_request(:put, url).with(body: payload.to_json).to_return(:body => '{"a":{"b":2}}', :status => 200)
     response = @client.put_json(url, payload)
     assert_equal 2, response.a.b
@@ -95,8 +87,7 @@ class JsonClientTest < MiniTest::Spec
   def test_client_can_use_basic_auth
     client = GdsApi::JsonClient.new(basic_auth: {user: 'user', password: 'password'})
 
-    stub_request(:put, "http://user:password@some.endpoint/some.json")
-      .to_return(:body => '{"a":1}', :status => 200)
+    stub_request(:put, "http://user:password@some.endpoint/some.json").to_return(:body => '{"a":1}', :status => 200)
     response = client.put_json("http://some.endpoint/some.json", {})
     assert_equal 1, response.a
   end

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.24
+  version: 0.0.26
 platform: ruby
 authors: 
 - James Stewart
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4557442821976738426
+      hash: -3364287350249021531
       segments: 
       - 0
       version: "0"
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4557442821976738426
+      hash: -3364287350249021531
       segments: 
       - 0
       version: "0"