ridley 0.7.0 → 0.8.0

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 

data/lib/ridley/connection.rb

@@ -1,4 +1,5 @@
 require 'open-uri'
+require 'retryable'
 require 'tempfile'
 
 module Ridley
@@ -17,6 +18,12 @@ module Ridley
     attr_reader :organization
     attr_reader :client_key
     attr_reader :client_name
+    # @return [Integer]
+    #   how many retries to attempt on HTTP requests
+    attr_reader :retries
+    # @return [Float]
+    #   time to wait between retries
+    attr_reader :retry_interval
 
     # @param [String] server_url
     # @param [String] client_name
@@ -26,6 +33,10 @@ module Ridley
     #   URI query unencoded key/value pairs
     # @option options [Hash] :headers
     #   unencoded HTTP header key/value pairs
+    # @option options [Integer] :retries (5)
+    #   retry requests on 5XX failures
+    # @option options [Float] :retry_interval (0.5)
+    #   how often we should pause between retries
     # @option options [Hash] :request
     #   request options
     # @option options [Hash] :ssl
@@ -33,14 +44,25 @@ module Ridley
     # @option options [URI, String, Hash] :proxy
     #   URI, String, or Hash of HTTP proxy options
     def initialize(server_url, client_name, client_key, options = {})
-      @client_name  = client_name
-      @client_key   = client_key
+      options         = options.reverse_merge(retries: 5, retry_interval: 0.5)
+      @client_name    = client_name
+      @client_key     = client_key
+      @retries        = options[:retries]
+      @retry_interval = options[:retry_interval]
 
       options = options.reverse_merge(
         builder: Faraday::Builder.new { |b|
-          b.request :chef_auth, client_name, client_key
-          b.response :chef_response
           b.response :json
+          b.request :retry,
+            max: @retries,
+            interval: @retry_interval,
+            exceptions: [
+              Ridley::Errors::HTTP5XXError,
+              Errno::ETIMEDOUT,
+              Faraday::Error::TimeoutError
+            ]
+          b.response :chef_response
+          b.request :chef_auth, client_name, client_key
 
           b.adapter :net_http_persistent
         }
@@ -117,8 +139,10 @@ module Ridley
       local = Tempfile.new('ridley-stream')
       local.binmode
 
-      open(target, 'rb', headers) do |remote|
-        local.write(remote.read)
+      retryable(tries: retries, on: OpenURI::HTTPError, sleep: retry_interval) do
+        open(target, 'rb', headers) do |remote|
+          local.write(remote.read)
+        end
       end
 
       local.flush

data/lib/ridley/errors.rb

@@ -87,18 +87,21 @@ module Ridley
       end
     end
 
-    class HTTPBadRequest < HTTPError; register_error(400); end
-    class HTTPUnauthorized < HTTPError; register_error(401); end
-    class HTTPForbidden < HTTPError; register_error(403); end
-    class HTTPNotFound < HTTPError; register_error(404); end
-    class HTTPMethodNotAllowed < HTTPError; register_error(405); end
-    class HTTPRequestTimeout < HTTPError; register_error(408); end
-    class HTTPConflict < HTTPError; register_error(409); end
+    class HTTP4XXError < HTTPError; end
+    class HTTP5XXError < HTTPError; end
+
+    class HTTPBadRequest < HTTP4XXError; register_error(400); end
+    class HTTPUnauthorized < HTTP4XXError; register_error(401); end
+    class HTTPForbidden < HTTP4XXError; register_error(403); end
+    class HTTPNotFound < HTTP4XXError; register_error(404); end
+    class HTTPMethodNotAllowed < HTTP4XXError; register_error(405); end
+    class HTTPRequestTimeout < HTTP4XXError; register_error(408); end
+    class HTTPConflict < HTTP4XXError; register_error(409); end
     
-    class HTTPInternalServerError < HTTPError; register_error(500); end
-    class HTTPNotImplemented < HTTPError; register_error(501); end
-    class HTTPBadGateway < HTTPError; register_error(502); end
-    class HTTPServiceUnavailable < HTTPError; register_error(503); end
-    class HTTPGatewayTimeout < HTTPError; register_error(504); end
+    class HTTPInternalServerError < HTTP5XXError; register_error(500); end
+    class HTTPNotImplemented < HTTP5XXError; register_error(501); end
+    class HTTPBadGateway < HTTP5XXError; register_error(502); end
+    class HTTPServiceUnavailable < HTTP5XXError; register_error(503); end
+    class HTTPGatewayTimeout < HTTP5XXError; register_error(504); end
   end
 end

data/lib/ridley/middleware.rb

@@ -6,14 +6,18 @@ module Ridley
     require 'ridley/middleware/parse_json'
     require 'ridley/middleware/chef_response'
     require 'ridley/middleware/chef_auth'
+    require 'ridley/middleware/retry'
 
     Faraday.register_middleware :request,
-      chef_auth: -> { ChefAuth }
+      chef_auth: -> { Ridley::Middleware::ChefAuth }
+
+    Faraday.register_middleware :request,
+      retry: -> { Ridley::Middleware::Retry }
 
     Faraday.register_middleware :response,
-      json: -> { ParseJson }
+      json: -> { Ridley::Middleware::ParseJson }
 
     Faraday.register_middleware :response,
-      chef_response: -> { ChefResponse }
+      chef_response: -> { Ridley::Middleware::ChefResponse }
   end
 end

data/lib/ridley/middleware/retry.rb

@@ -0,0 +1,60 @@
+module Ridley
+  # @author Jamie Winsor <jamie@vialstudios.com>
+  #
+  # Catches exceptions and retries each request a limited number of times.
+  #
+  # @example
+  #
+  #   Faraday.new do |conn|
+  #     conn.request :retry, max: 2, interval: 0.05, exceptions: [CustomException, Faraday::Timeout::Error]
+  #     conn.adapter ...
+  #   end
+  #
+  # @note Borrowed and modified from: {https://github.com/lostisland/faraday/blob/master/lib/faraday/request/retry.rb}
+  #   use the Faraday official middleware after the release of 0.9.x
+  class Middleware::Retry < Faraday::Middleware
+    # @option options [Integer] :max
+    #   maximum number of retries
+    # @option options [Float] :interval
+    #   pause in seconds between retries
+    # @option options [Array] :exceptions
+    #   the list of exceptions to handle
+    def initialize(app, options = {})
+      super(app)
+      @options  = options.slice(:max, :interval, :exceptions)
+      @errmatch = build_exception_matcher(@options[:exceptions])
+    end
+
+    def call(env)
+      retries = @options[:max]
+      begin
+        @app.call(env)
+      rescue @errmatch
+        if retries > 0
+          retries -= 1
+          sleep @options[:interval] if @options[:interval] > 0
+          retry
+        end
+        raise
+      end
+    end
+
+    # construct an exception matcher object.
+    #
+    # An exception matcher for the rescue clause can usually be any object that
+    # responds to `===`, but for Ruby 1.8 it has to be a Class or Module.
+    def build_exception_matcher(exceptions)
+      matcher = Module.new
+      (class << matcher; self; end).class_eval do
+        define_method(:===) do |error|
+          exceptions.any? do |ex|
+            if ex.is_a? Module then error.is_a? ex
+            else error.class.to_s == ex.to_s
+            end
+          end
+        end
+      end
+      matcher
+    end
+  end
+end

data/lib/ridley/version.rb

@@ -1,3 +1,3 @@
 module Ridley
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/ridley.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'net-ssh'
   s.add_runtime_dependency 'erubis'
   s.add_runtime_dependency 'net-http-persistent', '>= 2.8'
+  s.add_runtime_dependency 'retryable'
 end

data/spec/unit/ridley/chef/digester_spec.rb

@@ -0,0 +1,22 @@
+# Borrowed and modified from: {https://github.com/opscode/chef/blob/11.4.0/spec/unit/digester_spec.rb}
+
+require 'spec_helper'
+
+describe Ridley::Chef::Digester do
+  before(:each) do
+    @cache = described_class.instance
+  end
+
+  describe "when computing checksums of cookbook files and templates" do
+    it "proxies the class method checksum_for_file to the instance" do
+      @cache.should_receive(:checksum_for_file).with("a_file_or_a_fail")
+      described_class.checksum_for_file("a_file_or_a_fail")
+    end
+
+    it "generates a checksum from a non-file IO object" do
+      io = StringIO.new("riseofthemachines\nriseofthechefs\n")
+      expected_md5 = '0e157ac1e2dd73191b76067fb6b4bceb'
+      @cache.generate_md5_checksum(io).should == expected_md5
+    end
+  end
+end

data/spec/unit/ridley/connection_spec.rb

@@ -9,6 +9,33 @@ describe Ridley::Connection do
     described_class.new(server_url, client_name, client_key)
   end
 
+  describe "configurable retries" do
+    before(:each) do
+      stub_request(:get, "https://api.opscode.com/organizations/vialstudios").to_return(status: 500, body: "")
+    end
+
+    it "attempts five (5) retries by default" do
+      expect {
+        subject.get('organizations/vialstudios')
+      }.to raise_error
+      a_request(:get, "https://api.opscode.com/organizations/vialstudios").should have_been_made.times(6)
+    end
+
+    context "given a configured count of two (2) retries" do
+      subject do
+        described_class.new(server_url, client_name, client_key, retries: 2)
+      end
+
+      it "attempts two (2) retries" do
+        expect {
+          subject.get('organizations/vialstudios')
+        }.to raise_error
+
+        a_request(:get, "https://api.opscode.com/organizations/vialstudios").should have_been_made.times(3)
+      end
+    end
+  end
+
   describe "#api_type" do
     it "returns :foss if the organization is not set" do
       subject.stub(:organization).and_return(nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ridley
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -251,6 +251,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A reliable Chef API client with a clean syntax
 email:
 - jamie@vialstudios.com
@@ -285,6 +301,7 @@ files:
 - lib/ridley/middleware/chef_auth.rb
 - lib/ridley/middleware/chef_response.rb
 - lib/ridley/middleware/parse_json.rb
+- lib/ridley/middleware/retry.rb
 - lib/ridley/mixin.rb
 - lib/ridley/mixin/checksum.rb
 - lib/ridley/mixin/shell_out.rb
@@ -340,6 +357,7 @@ files:
 - spec/unit/ridley/bootstrapper/context_spec.rb
 - spec/unit/ridley/bootstrapper_spec.rb
 - spec/unit/ridley/chef/cookbook_spec.rb
+- spec/unit/ridley/chef/digester_spec.rb
 - spec/unit/ridley/client_spec.rb
 - spec/unit/ridley/connection_spec.rb
 - spec/unit/ridley/errors_spec.rb
@@ -382,7 +400,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 109610229622215450
+      hash: -1703790355388058426
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -423,6 +441,7 @@ test_files:
 - spec/unit/ridley/bootstrapper/context_spec.rb
 - spec/unit/ridley/bootstrapper_spec.rb
 - spec/unit/ridley/chef/cookbook_spec.rb
+- spec/unit/ridley/chef/digester_spec.rb
 - spec/unit/ridley/client_spec.rb
 - spec/unit/ridley/connection_spec.rb
 - spec/unit/ridley/errors_spec.rb