httpray 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94354672b454e3ffb1f53a0d0704157c4a3208c2
-  data.tar.gz: 755940a03eedb6095bf8b8c7c2a5174b85d3125e
+  metadata.gz: 85f7ee216d286ddb7923f073086321aaad64ed36
+  data.tar.gz: c8a0b734b3565a1bf8a9391ce0bee417c1e015c5
 SHA512:
-  metadata.gz: 18e91441b0908e96d8f45c2d76fce167c855dd5b4526976b811e7918c2932a52d98eba43e497d2816fb06cfeede05cfdab531e18c9858b2a5459840753967127
-  data.tar.gz: c94caa608c92993d0856aada6f22fafbf9498950d2816b3219a32de4502cf6c4080eaa364210c0133877d20d0e8bd0113fb7c0422bf2624a80fcfc355375f1bf
+  metadata.gz: d1f1f90d6d72dceeba9ed80b7ba01247e0043ee5933737d0f9cc17aa9f24f15393ebdd882be7c13d2afee162256eb319b0f4f562e16486b9c659ff524c276082
+  data.tar.gz: b84071e158ce7b043b56b77573159cd954a43983f9dfc94b56385b7acd9780303e8bca198e4c13ff281dca047dd7a6af7f1d69f834755b089dc9d4675d2b2ef7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    HTTPray (1.0.0)
+    httpray (1.1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,8 +11,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  HTTPray!
-  bundler (>= 1.2)
+  httpray!
 
 BUNDLED WITH
    1.13.6

data/README.md

@@ -43,7 +43,13 @@ socket.close
 # use a persistent connection to keep the party rolling
 # will automatically reconnect if connection is lost
 uri = URI.parse("https://your.diety/pray")
-ark = HTTPray::Connection.new(uri.host, uri.port, 1, OpenSSL::SSL::SSLContext.new)
+ark = HTTPray::Connection.new(
+  uri.host,
+  uri.port,
+  1, #timeout
+  OpenSSL::SSL::SSLContext.new, #ssl context
+  1, #retries on error
+  10) #seconds to wait after all retries failed before trying again on a subsequent request
 ark.request("POST", uri, 
   {"Content-Type" => "application/prayer"},
   "Why did it have to be snakes?")
@@ -58,7 +64,7 @@ ark.request("POST", uri,
 
 HTTPray has minimal convenience and sanitization features because I didn't need them. All that it does is fill in the Host, User-Agent, Accept, and Content-Length headers for you. The body must be a string, so convert it yourself first. The URI can be a `URI` or a `String` that will go through `URI.parse`. You're welcome.
 
-If you're using `Connection` with TLS you need to provide an `OpenSSL::SSL::SSLContext` when creating the connection. `HTTPray.request!` is more forgiving and if you don't give it one it will create it for you if needed.
+If you're using `Connection` with TLS you need to provide an `OpenSSL::SSL::SSLContext` when creating the connection. `HTTPray.request!` is more forgiving and if you don't give it one it will create it for you if needed. `Connection` also has some fancy retry and circuit breaker logic so you can assume your request always writes even if it doesn't without major performance impacts.
 
 Timeout support does not extend to the response since you just get back a `Socket`. You're own your own for how you want to handle that.
 

data/lib/httpray.rb

@@ -6,6 +6,7 @@ require_relative 'httpray/version'
 
 module HTTPray
   class Timeout < StandardError; end
+  class CircuitBreakerError < StandardError; end
 
   DEFAULT_HEADERS = {
     "User-Agent" => "HTTPray #{VERSION}",
@@ -14,12 +15,14 @@ module HTTPray
   }.freeze
 
   class Connection
-    def initialize(host, port, timeout = 1, ssl_context = nil, retry_count = 1)
+    def initialize(host, port, timeout = 1, ssl_context = nil, retry_count = 1, retry_circuit_breaker_interval = 10)
       @host = host
       @port = port
       @timeout = timeout
       @ssl_context = ssl_context
       @retry_count = retry_count
+      @retry_circuit_breaker_interval = retry_circuit_breaker_interval
+      @next_retry_time = Time.now - @retry_circuit_breaker_interval
       @socket = connect
     end
 
@@ -29,12 +32,13 @@ module HTTPray
       @socket
     end
 
+    def reconnect
+      @socket = connect unless @socket && !socket.closed?
+    end
+
     def request!(method, uri, headers = {}, body = nil)
       tries ||= 0
-      begin
-        IO.select([@socket], [@socket], [@socket], @timeout) if @socket
-      rescue; end
-      @socket = connect unless @socket && !@socket.closed?
+      reconnect
       socket = @socket
       uri = URI.parse(uri) unless URI === uri
 
@@ -48,11 +52,19 @@ module HTTPray
       socket.write_nonblock "\r\n"
       socket.write_nonblock body if body
       socket
-    rescue
-      @socket.close
-      if tries < @retry_count
-        tries += 1
-        retry
+    rescue => error
+      @socket.close unless @socket.closed?
+      now = Time.now
+      if now > @next_retry_time
+        if tries < @retry_count 
+          tries += 1
+          retry
+        else
+          @next_retry_time = now + @retry_circuit_breaker_interval
+          raise error
+        end
+      else
+        raise HTTPray::CircuitBreakerError
       end
     end
 

data/lib/httpray/version.rb

@@ -1,3 +1,3 @@
 module HTTPray
-  VERSION = "1.1.1".freeze
+  VERSION = "1.1.2".freeze
 end

data/test/httpray_test.rb

@@ -106,4 +106,19 @@ class HTTPrayTest < MiniTest::Test
       ark.request("GET", uri, {"Connection" => ""})
     end
   end
+  def test_retries_stopped_by_circuit_breaker
+    uri = URI.parse("http://httpbin.org/deny")
+    ark = HTTPray::Connection.new(uri.host, uri.port, 1, nil, 0, 2)
+    # force retries to expire
+    ark.socket.stub(:write_nonblock, lambda { |*args| raise "Broken pipe" }) do
+      assert_raises RuntimeError do; ark.request("GET", uri, {"Connection" => ""}); end
+    end
+    ark.stub(:reconnect, ark.socket) do #prevent reconnect of closed socket from previous error
+      ark.socket.stub(:write_nonblock, lambda { |*args| raise "Broken pipe" }) do
+        assert_raises HTTPray::CircuitBreakerError do; ark.request("GET", uri, {"Connection" => ""}); end
+      end
+    end
+    sleep(2)
+    ark.request("GET", uri, {"Connection" => ""})
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: httpray
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - G Gordon Worley III