hyperion_http 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3bd10bd7cea98830da2b676efba1a80adba83c9
-  data.tar.gz: 16385d656757d9c325a2a388f89c0d1e688ed920
+  metadata.gz: e7eaba5a3e46d889e7b8dbe19627464e09adfc22
+  data.tar.gz: 320017b31fd4e3e86e578605c9ac35bfacd951bb
 SHA512:
-  metadata.gz: e4dc321c4b89ffb9029e88e7f3393cd79162cbb07f9500c969b603cb70ea7514e4947444070292b3c686c44a766aeee83b2c8c06cb4786ce0ea67ad5f55cfa3c
-  data.tar.gz: 8766676236d1a9eb42768df79d4c45c5d9a0eada6aec79092dcc7501eac49ce4cb84e4aa7291df4762590de5871dac3f1dccc5564c650ce4dc4506e41eb02858
+  metadata.gz: 26b8db547297df97177e84431ea8f803f534b3183b5fabee16aa8bbd254118027cb8099048ab80b1c293ce95e6b938b01006c440c3aa5449879a65a5c26e2061
+  data.tar.gz: 308161f9274acdcd1432fc41eaf82012da25a63f185f44651d57868814c4aac2b85cf82d3952e92c21a2d997d07f2eb00c46a46110c00e10c491f6382aefb451

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/hyperion_http.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'hyperion_http'
-  spec.version       = '0.5.0'
+  spec.version       = '0.6.0'
   spec.authors       = ['Indigo BioAutomation, Inc.']
   spec.email         = ['pwinton@indigobio.com']
   spec.summary       = 'Ruby REST client'

data/lib/hyperion/hyperion.rb

@@ -15,12 +15,13 @@ class Hyperion
   # @param body [String] the body to send with POST or PUT
   # @param additional_headers [Hash] headers to send in addition to the ones
   #   already determined by the route. Example: +{'User-Agent' => 'Mozilla/5.0'}+
+  # @param timeout [Integer] The limit of the entire request in seconds
   # @yield [result] yields the result if a block is provided
   # @yieldparam [HyperionResult]
   # @return [HyperionResult, Object] If a block is provided, returns the block's
   #   return value; otherwise, returns the result.
-  def self.request(route, body=nil, additional_headers={}, &block)
-    self.new(route).request(body, additional_headers, &block)
+  def self.request(route, body: nil, additional_headers: {}, timeout: 0, &block)
+    self.new(route).request(body, additional_headers, timeout, &block)
   end
 
   # @private
@@ -29,13 +30,14 @@ class Hyperion
   end
 
   # @private
-  def request(body=nil, additional_headers={}, &dispatch)
+  def request(body, additional_headers, timeout, &dispatch)
     uri = transform_uri(route.uri).to_s
     with_request_logging(route, uri, route_headers(route)) do
       typho_result = Typho.request(uri,
                                    method: route.method,
                                    headers: build_headers(additional_headers),
-                                   body: write(body, route.payload_descriptor))
+                                   body: write(body, route.payload_descriptor),
+                                   timeout: timeout)
       hyperion_result_for(typho_result, dispatch)
     end
   end

data/lib/hyperion/requestor.rb

@@ -12,6 +12,9 @@ class Hyperion
     #   HyperionResult and returns the final value to return from `request`
     # @option opts [Proc] :render A transformer, usually a proc returned by
     #   `as` or `as_many`. Only called on HTTP 200.
+    # @option opts [Integer] :timeout The limit of the entire request in seconds.
+    #   The default is 0 which means there will be no timeout during transfer;
+    #   there still may be a timeout during connection.
     # @yield [rendered] Yields to allow an additional transformation.
     #   Only called on HTTP 200.
     def request(route, opts={}, &project)
@@ -21,10 +24,11 @@ class Hyperion
       body = opts[:body]
       headers = opts[:headers] || {}
       additional_handler_hash = opts[:also_handle] || {}
+      timeout = opts[:timeout] || 0
       render = opts[:render] || Proc.identity
       project = project || Proc.identity
 
-      Hyperion.request(route, body, headers) do |result|
+      Hyperion.request(route, body: body, additional_headers: headers, timeout: timeout) do |result|
         all_handlers = [hash_handler(additional_handler_hash),
                         handler_from_including_class,
                         built_in_handler(project, render)]

data/spec/lib/hyperion/requestor_spec.rb

@@ -19,16 +19,24 @@ describe Hyperion::Requestor do
   include Hyperion::Requestor
 
   def arrange(method, response)
-    @route = RestRoute.new(method, 'http://indigo.com/things',
-                           ResponseDescriptor.new('thing', 1, :json),
-                           PayloadDescriptor.new(:json))
-
+    create_route(method)
     fake_route(@route) do |request|
       @request = request
       response
     end
   end
 
+  def arrange_timeout(method)
+    create_route(method)
+    fake_route(@route) { sleep 2 }
+  end
+
+  def create_route(method)
+    @route = RestRoute.new(method, 'http://indigo.com/things',
+                           ResponseDescriptor.new('thing', 1, :json),
+                           PayloadDescriptor.new(:json))
+  end
+
   def assert_result(expected_result)
     expect(@result).to eql expected_result
   end
@@ -42,7 +50,7 @@ describe Hyperion::Requestor do
   it 'makes requests with additional headers' do 
     headers = {'X-my-header' => 'value'}
     arrange(:get, {'a' => 'b'})
-    expect(Hyperion).to receive(:request).with(@route, nil, headers)
+    expect(Hyperion).to receive(:request).with(@route, body: nil, additional_headers: headers, timeout: 0)
     @result = request(@route, headers: headers)
   end
 
@@ -53,6 +61,13 @@ describe Hyperion::Requestor do
     expect(@request.body).to eql({'the' => 'body'})
   end
 
+  it 'makes requests with a timeout' do
+    arrange_timeout(:get)
+    error = 'oops: time out'
+    handlers = {HyperionStatus::TIMED_OUT => proc { raise error }}
+    expect { request(@route, timeout: 1, also_handle: handlers) }.to raise_error error
+  end
+
   it 'renders the response with the render proc' do
     arrange(:get, {'x' => 1, 'y' => 2})
     @result = request(@route, render: OpenStruct.method(:new))

data/spec/lib/hyperion/test_spec.rb

@@ -31,7 +31,7 @@ describe Hyperion do
       result = Hyperion.request(get_user_route)
       expect_success(result, {'name' => 'freddy'})
 
-      result = Hyperion.request(post_greeting_route, write({'name' => 'freddy'}, :json))
+      result = Hyperion.request(post_greeting_route, body: write({'name' => 'freddy'}, :json))
       expect_success(result, {'greeting' => 'hello, freddy'})
     end
     it 'returns 404 if a requested route is not stubbed' do
@@ -96,7 +96,7 @@ describe Hyperion do
 
     result = Hyperion.request(RestRoute.new(:post, 'http://somesite.org/users/0',
                                             user_response_params, PayloadDescriptor.new(:json)),
-                              write({'name' => 'annie'}, :json))
+                              body: write({'name' => 'annie'}, :json))
     expect(result.body).to eql({'updated' => {'name' => 'annie'}})
   end
 

data/spec/lib/hyperion_spec.rb

@@ -23,10 +23,10 @@ describe Hyperion do
       )
 
       expect(Hyperion::Typho).to receive(:request).
-                                   with(uri, {method: method, headers: expected_headers, body: 'Ventura'}).
+                                   with(uri, {method: method, headers: expected_headers, body: 'Ventura', timeout: 1}).
                                    and_return(make_typho_response(200, write({'foo' => 'bar'}, :json)))
 
-      result = Hyperion.request(route, body, additional_headers)
+      result = Hyperion.request(route, body: body, additional_headers: additional_headers, timeout: 1)
       expect(result).to be_a HyperionResult
       expect(result.status).to eql HyperionStatus::SUCCESS
       expect(result.code).to eql 200
@@ -53,16 +53,16 @@ describe Hyperion do
       end
       it 'serializes the payload' do
         expect(Hyperion::Typho).to receive(:request).
-                                     with(uri, {method: method, headers: expected_headers, body: '{"c":"d"}'}).
+                                     with(uri, {method: method, headers: expected_headers, body: '{"c":"d"}', timeout: 0}).
                                      and_return(make_typho_response(200, write({}, :json)))
-        Hyperion.request(route, {'c' => 'd'})
+        Hyperion.request(route, body: {'c' => 'd'})
       end
       it 'deserializes 400-level errors to ClientErrorResponse' do
         client_error = ClientErrorResponse.new('oops', [], ClientErrorCode::MISSING)
         allow(Hyperion::Typho).to receive(:request).
-                                    with(uri, {method: method, headers: expected_headers, body: '{"c":"d"}'}).
+                                    with(uri, {method: method, headers: expected_headers, body: '{"c":"d"}', timeout: 0}).
                                     and_return(make_typho_response(400, write(client_error.as_json, :json)))
-        result = Hyperion.request(route, {'c' => 'd'})
+        result = Hyperion.request(route, body: {'c' => 'd'})
         expect(result.body).to be_a ClientErrorResponse
         expect(result.body.message).to eql 'oops'
         expect(result.body.code).to eql ClientErrorCode::MISSING

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperion_http
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Indigo BioAutomation, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGES.md
 - Gemfile