saddle 0.0.27 → 0.0.30

data/lib/saddle.rb

@@ -2,6 +2,7 @@ require 'saddle/client_attributes'
 require 'saddle/method_tree_builder'
 require 'saddle/options'
 require 'saddle/requester'
+require 'saddle/version'
 
 
 # Inherit your client implementation from Saddle::Client
@@ -16,7 +17,7 @@ module Saddle
     extend Options
 
     class << self
-      attr_accessor :additional_middlewares
+      attr_accessor :additional_middlewares, :parent_module
 
       # Once your implementation is written, this is the magic you need to
       # create a client instance.
@@ -38,12 +39,8 @@ module Saddle
         end
         # Add additional client attributes
         obj.send(:include, Saddle::ClientAttributes)
-      end
-
-      # Name of the module that contains the implementing client
-      def root_namespace
-        module_nests = self.name.split('::')
-        module_nests.length > 1 ? module_nests[-2] : module_nests.last
+        # Store the parent module in case we need it later
+        @parent_module = Module.nesting.last
       end
 
     end

data/lib/saddle/middleware/request/retry.rb

@@ -22,13 +22,16 @@ module Saddle
           begin
             @app.call(self.class.deep_copy(env))
           rescue => e
-            unless @ignored_exceptions.include?(e.class)
-              # Retry a limited number of times
-              if retries > 0
-                retries -= 1
-                sleep(backoff) if backoff > 0.0
-                backoff *= 2
-                retry
+            # Only retry for GET or if the request is marked as idempotent
+            if env[:method] == :get || env[:request][:idempotent]
+              unless @ignored_exceptions.include?(e.class)
+                # Retry a limited number of times
+                if retries > 0
+                  retries -= 1
+                  sleep(backoff) if backoff > 0.0
+                  backoff *= 2
+                  retry
+                end
               end
             end
             # Re-raise if we're out of retries or it's not handled

data/lib/saddle/middleware/request/user_agent.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+
+
+module Saddle
+  module Middleware
+    module Request
+
+      # Public: Adds a user-agent to the request
+
+      class UserAgent < Faraday::Middleware
+        def call(env)
+          # Build a user agent that looks like 'SaddleExample 0.0.1'
+          user_agent = env[:request][:saddle][:client].name
+          if env[:request][:saddle][:client].parent_module
+            if defined?(env[:request][:saddle][:client].parent_module::VERSION)
+              user_agent += " #{env[:request][:saddle][:client].parent_module::VERSION}"
+            end
+          end
+
+          env[:request_headers]['User-Agent'] = user_agent
+
+          @app.call env
+        end
+      end
+
+    end
+  end
+end

data/lib/saddle/middleware/response/default_response.rb

@@ -12,7 +12,7 @@ module Saddle
         def call(env)
           begin
             @app.call(env)
-          rescue Faraday::Error
+          rescue Faraday::Error::ClientError
             if res = env[:request][:default_response]
               return ::Faraday::Response.new(:body => res)
             else

data/lib/saddle/middleware/ruby_timeout.rb

@@ -13,7 +13,7 @@ module Saddle
     class RubyTimeout < Faraday::Middleware
 
       def call(env)
-        timeout = env[:request][:timeout] # nil or 0 means no timeout
+        timeout = env[:request][:hard_timeout] # nil or 0 means no timeout
         Timeout.timeout(timeout, Saddle::TimeoutError) do
           @app.call(env)
         end

data/lib/saddle/requester.rb

@@ -1,12 +1,16 @@
 require 'faraday'
 require 'faraday_middleware'
 
+
 require 'saddle/middleware/request/encode_json'
 require 'saddle/middleware/request/path_prefix'
 require 'saddle/middleware/request/retry'
 require 'saddle/middleware/request/url_encoded'
+require 'saddle/middleware/request/user_agent'
+
 require 'saddle/middleware/response/default_response'
 require 'saddle/middleware/response/parse_json'
+
 require 'saddle/middleware/ruby_timeout'
 
 
@@ -123,8 +127,11 @@ module Saddle
           builder.options[:num_retries] = @num_retries
         end
 
-        # Set up a user agent (named for the client's namespace)
-        builder.headers[:user_agent] = @parent_client.root_namespace
+        # Hard timeout on the entire request
+        builder.use(Saddle::Middleware::RubyTimeout)
+
+        # Set up a user agent
+        builder.use(Saddle::Middleware::Request::UserAgent)
 
         # Set up the path prefix if needed
         builder.use(Saddle::Middleware::Request::PathPrefix)
@@ -137,19 +144,16 @@ module Saddle
           builder.use(m[:klass], *m[:args])
         end
 
-        # Hard timeout on the entire request
-        builder.use(Saddle::Middleware::RubyTimeout)
-
         # Request encoding
         builder.use(Saddle::Middleware::Request::JsonEncoded)
         builder.use(Saddle::Middleware::Request::UrlEncoded)
 
-        # Automatic retries
-        builder.use(Saddle::Middleware::Request::Retry)
-
         # Handle parsing out the response if it's JSON
         builder.use(Saddle::Middleware::Response::ParseJson)
 
+        # Automatic retries
+        builder.use(Saddle::Middleware::Request::Retry)
+
         # Raise exceptions on 4xx and 5xx errors
         builder.use(Faraday::Response::RaiseError)
 

data/lib/saddle/version.rb

@@ -1,3 +1,3 @@
 module Saddle
-  VERSION = '0.0.27'
+  VERSION = '0.0.30'
 end

data/spec/middleware/request/retry_spec.rb

@@ -1,3 +1,4 @@
+require 'faraday'
 require 'saddle'
 
 
@@ -12,43 +13,94 @@ describe Saddle::Client do
         @default_client = Saddle::Client.create(:stubs => @stubs)
       end
 
-      it "should retry properly with no params" do
-        @stubs.get('/test') {
-          [
-            500,
-            {},
-            'Failure',
-          ]
-        }
-        @stubs.get('/test') {
-          [
-            200,
-            {},
-            'Party!',
-          ]
-        }
-        @default_client.requester.get('/test').should == 'Party!'
+      context "for a GET request" do
+        it "with no params should properly retry" do
+          url = '/test'
+          @stubs.get(url) {
+            [
+              500,
+              {},
+              'Failure',
+            ]
+          }
+          @stubs.get(url) {
+            [
+              200,
+              {},
+              'Party!',
+            ]
+          }
+          @default_client.requester.get(url).should == 'Party!'
+        end
+
+        it "with params should properly retry" do
+          url = '/test?a=1'
+          @stubs.get(url) {
+            [
+              500,
+              {},
+              'Failure',
+            ]
+          }
+          @stubs.get(url) {
+            [
+              200,
+              {},
+              'Party!',
+            ]
+          }
+          @default_client.requester.get(url).should == 'Party!'
+        end
       end
 
-      it "should retry properly when posting params urlencoded" do
-        @stubs.post('/test', '{"a":"b","c":"d"}') {
-          [
-            500,
-            {},
-            'Failure',
-          ]
-        }
-        @stubs.post('/test', '{"a":"b","c":"d"}') {
-          [
-            200,
-            {},
-            'Party!',
-          ]
-        }
-        @default_client.requester.post(
-          '/test',
-          {'a' => 'b', 'c' => 'd'}
-        ).should == 'Party!'
+
+
+      context "for a POST request" do
+        it "should not retry" do
+          url = '/test'
+          @stubs.post(url) {
+            [
+              500,
+              {},
+              'Failure',
+            ]
+          }
+          @stubs.post(url) {
+            [
+              200,
+              {},
+              'Party!',
+            ]
+          }
+          expect {
+            @default_client.requester.post(url)
+          }.to raise_error(Faraday::Error::ClientError)
+        end
+
+        it "should retry if it is marked as idempotent" do
+          url = '/test'
+          params = {'a' => 1, 'b' => 2}
+          params_json = params.to_json
+          @stubs.post(url, params_json) {
+            [
+              500,
+              {},
+              'Failure',
+            ]
+          }
+          @stubs.post(url, params_json) {
+            [
+              200,
+              {},
+              'Party!',
+            ]
+          }
+          @default_client.requester.post(
+            url,
+            params,
+            {:idempotent => true}
+          ).should == 'Party!'
+        end
       end
 
     end

data/spec/middleware/response/default_response_spec.rb

@@ -0,0 +1,44 @@
+require 'saddle'
+
+
+
+describe Saddle::Client do
+
+  context "Default response requests" do
+
+      before :each do
+        @stubs = Faraday::Adapter::Test::Stubs.new
+        @default_client = Saddle::Client.create(:stubs => @stubs)
+      end
+
+      it "should return as normal upon success" do
+        @stubs.get('/test') {
+          [
+            200,
+            {},
+            'Party!',
+          ]
+        }
+        @default_client.requester.get(
+          '/test',
+          {},
+          {:default_response => 'Not a party.'}
+        ).should == 'Party!'
+      end
+
+      it "should return the default response upon failure" do
+        @stubs.get('/test') {
+          [
+            500,
+            {},
+            'Failure',
+          ]
+        }
+        @default_client.requester.get(
+          '/test',
+          {},
+          {:default_response => 'Not a party.'}
+        ).should == 'Not a party.'
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saddle
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.30
   prerelease: 
 platform: ruby
 authors:
@@ -83,6 +83,7 @@ files:
 - lib/saddle/middleware/request/path_prefix.rb
 - lib/saddle/middleware/request/retry.rb
 - lib/saddle/middleware/request/url_encoded.rb
+- lib/saddle/middleware/request/user_agent.rb
 - lib/saddle/middleware/response/default_response.rb
 - lib/saddle/middleware/response/parse_json.rb
 - lib/saddle/middleware/ruby_timeout.rb
@@ -95,6 +96,7 @@ files:
 - spec/middleware/logging/rails_spec.rb
 - spec/middleware/logging/statsd_spec.rb
 - spec/middleware/request/retry_spec.rb
+- spec/middleware/response/default_response_spec.rb
 - spec/multiple_spec.rb
 - spec/requester/get_spec.rb
 - spec/requester/post_spec.rb
@@ -130,6 +132,7 @@ test_files:
 - spec/middleware/logging/rails_spec.rb
 - spec/middleware/logging/statsd_spec.rb
 - spec/middleware/request/retry_spec.rb
+- spec/middleware/response/default_response_spec.rb
 - spec/multiple_spec.rb
 - spec/requester/get_spec.rb
 - spec/requester/post_spec.rb