sinew 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e40f156ce6a8c625a93dd1cf0f9d60db825977cb352bf736f27b24afbc6bd182
-  data.tar.gz: f4392ccdc53b3cc5d8a07a26fe0aef3525c0e43c3b570ab96465a208ab8c1969
+  metadata.gz: 7e7426a91f427a3c97969eb501ce0bd55a658ece54af0dfea994f8faffd479f7
+  data.tar.gz: baeb12b6af0fa2c5c11390de16ed1837458f52b4b00393dce8f9e66d4eb898a3
 SHA512:
-  metadata.gz: aa8dbb122c0ef5665822d08bb62293798873529107609718399307a0a7f31682283f7a0576b9628a4e29475031b999ebd70e07b49ab212b4b5e4002470f568dc
-  data.tar.gz: 9693d9fcd356e0c9e7732c186e18c228a4953117f07b57617e298a0e728e8bf8c31334de56d1ee99b43f8003fb7de0cbf219656d20f58ad68e345dc876cef229
+  metadata.gz: 1698acfc26dbab92c390cde0956a72011f22f8f9bb4c5ebb194d131ae0a8dfe6c58e2224d36e840167210c2bf472efd18fd8e0cc92b1c9640df590f1faf71473
+  data.tar.gz: e9a2688616dd866792cd286a1ebff094fe32ad9d8552ce77e7465648022fd65db83149ee558f88140f907d7a2da422c41312e8a32f73f0d1930f865862eab90f

data/lib/sinew/dsl.rb

@@ -10,7 +10,7 @@ module Sinew
     # this is used to break out of --limit
     class LimitError < StandardError; end
 
-    attr_reader :sinew, :raw, :uri, :elapsed
+    attr_reader :sinew, :uri, :raw, :code, :elapsed
 
     def initialize(sinew)
       @sinew = sinew
@@ -59,7 +59,7 @@ module Sinew
 
       # fetch and make response available to callers
       response = sinew.http(method, url, options)
-      @uri, @raw = response.uri, response.body
+      @uri, @raw, @code = response.uri, response.body, response.code
 
       # don't confuse the user
       nil

data/lib/sinew/main.rb

@@ -75,8 +75,8 @@ module Sinew
         begin
           @request_count += 1
           response = request.perform
-        rescue Timeout::Error
-          response = Response.from_timeout(request)
+        rescue HTTParty::RedirectionTooDeep, OpenSSL::SSL::SSLError, SocketError, SystemCallError, Timeout::Error => e
+          response = Response.from_error(request, e)
         end
         break if !response.error_500?
       end

data/lib/sinew/request.rb

@@ -73,16 +73,26 @@ module Sinew
         body&.dup
       end
 
-      # build key, as a hash for before_generate_cache_key
+      # Build key, as a hash for before_generate_cache_key. Note that :scheme is
+      # just a placeholder in case someone wants to add it for real, so that
+      # it'll appear in the correct order. We remove the placerholder after we
+      # call the proc.
       key = {
         method: method.dup,
+        scheme: 'placeholder',
         path: uri.path,
         query: uri.query,
         body: body_key,
       }
-      key = sinew.runtime_options.before_generate_cache_key.call(key)
 
-      # strip method for gets
+      args = [ key ]
+      if sinew.runtime_options.before_generate_cache_key.arity == 2
+        args << uri
+      end
+      key = sinew.runtime_options.before_generate_cache_key.call(*args)
+
+      # strip defaults
+      key.delete(:scheme) if key[:scheme] == 'placeholder'
       key.delete(:method) if key[:method] == 'get'
 
       # pull out the values, join and pathify

data/lib/sinew/response.rb

@@ -46,11 +46,11 @@ module Sinew
       end
     end
 
-    def self.from_timeout(request)
+    def self.from_error(request, error)
       Response.new.tap do |response|
         response.request = request
         response.uri = request.uri
-        response.body = 'timeout'
+        response.body = error.to_s
         response.code = 999
         response.headers = {}
       end

data/lib/sinew/version.rb

@@ -1,4 +1,4 @@
 module Sinew
   # Gem version
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.0.4'.freeze
 end

data/test/test_cache.rb

@@ -64,6 +64,6 @@ class TestCache < MiniTest::Test
       end
     end
     assert_requested :get, 'http://httpbin.org/delay/1', times: 1
-    assert_equal 'timeout', sinew.dsl.raw
+    assert_equal 'execution expired', sinew.dsl.raw
   end
 end

data/test/test_helper.rb

@@ -2,6 +2,9 @@ require 'minitest/autorun'
 require 'minitest/pride'
 require 'webmock/minitest' unless ENV['SINEW_TEST_NETWORK']
 
+# to run one test, do this:
+# TEST=test/unit/query_test.rb TESTOPTS="--name=test_parse" rake
+
 # a hint to sinew, so that it'll do things like set rate limit to zero
 ENV['SINEW_TEST'] = '1'
 

data/test/test_requests.rb

@@ -8,6 +8,7 @@ class TestRequests < MiniTest::Test
 
   def test_basic_methods
     sinew.dsl.get('http://httpbin.org/get', a: 1, b: 2)
+    assert_equal(200, sinew.dsl.code)
     assert_equal({ a: '1', b: '2' }, sinew.dsl.json[:args])
 
     sinew.dsl.post('http://httpbin.org/post', a: 1, b: 2)
@@ -38,13 +39,29 @@ class TestRequests < MiniTest::Test
     # 500
     assert_output(/failed with 500/) do
       sinew.dsl.get('http://httpbin.org/status/500')
+      assert_equal 500, sinew.dsl.code
       assert_equal '500', sinew.dsl.raw
     end
 
     # timeout
     assert_output(/failed with 999/) do
       sinew.dsl.get('http://httpbin.org/delay/1')
-      assert_equal 'timeout', sinew.dsl.raw
+      assert_equal 999, sinew.dsl.code
+    end
+
+    # uncommon errors
+    errors = [
+      Errno::ECONNREFUSED,
+      HTTParty::RedirectionTooDeep.new(nil),
+      OpenSSL::SSL::SSLError.new,
+      SocketError.new,
+    ]
+    errors.each_with_index do |error, index|
+      stub_request(:get, %r{http://[^/]+/error#{index}}).to_return { raise error }
+      assert_output(/failed with 999/) do
+        sinew.dsl.get("http://httpbin.org/error#{index}")
+        assert_equal 999, sinew.dsl.code
+      end
     end
   end
 
@@ -104,9 +121,15 @@ class TestRequests < MiniTest::Test
   end
 
   def test_before_generate_cache_key
+    # arity 1
     sinew.runtime_options.before_generate_cache_key = method(:redact_cache_key)
     req = Sinew::Request.new(sinew, 'get', 'http://host', query: { secret: 'xyz' })
     assert_equal 'host/secret=redacted', req.cache_key
+
+    # arity 2
+    sinew.runtime_options.before_generate_cache_key = method(:add_scheme)
+    req = Sinew::Request.new(sinew, 'get', 'https://host/gub')
+    assert_equal 'host/https,gub', req.cache_key
   end
 
   def test_urls
@@ -132,4 +155,10 @@ class TestRequests < MiniTest::Test
     key
   end
   protected :redact_cache_key
+
+  def add_scheme(key, uri)
+    key[:scheme] = uri.scheme
+    key
+  end
+  protected :add_scheme
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinew
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Adam Doppelt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print