saddle 0.0.53 → 0.1.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.0.54
+* Work with faraday ~> 0.9.0. With these changes, Saddle no longer works with faraday < 0.9.
+
 # 0.0.49
 * Support `extra_env` as a client option to load more into the env pre-adapter.
 

data/README.md

@@ -41,16 +41,16 @@ Saddle enables you to create beautifully stable and functionaly API clients, in
 [saddle-example](https://github.com/mLewisLogic/saddle-example)
 
 ### client construction
-0. For the sake of cleanliness, pick a namespace that everything related to your client should live in. For this example, we'll use __SaddleExample__
-1. Inherit your client class, __SaddleExample::Client__, from __Saddle::Client__
-2. Create an _endpoints_ directory at the same level as your client class file
-3. Create endpoint classes in the _endpoints_ directory that inherit from __Saddle::TraversalEndpoint__ and are under the __SaddleExample::Endpoints__ namespace module
-    1. Give these endpoints methods that call _get_ or _post_ to perform the actual request
-    2. Their module/class namespace determines how they are accessed in the client's call tree. For example, the get\_all() in __SaddleExample::Endpoints::Fish::Guppy__ would be accessed by:
+0. For the sake of cleanliness, pick a namespace that everything related to your client should live in. For this example, we'll use __SaddleExample__.
+1. Inherit your client class, __SaddleExample::Client__, from __Saddle::Client__.
+2. Create an _endpoints_ directory at the same level as your client class file.
+3. Create endpoint classes in the _endpoints_ directory that inherit from __Saddle::TraversalEndpoint__ and are under the __SaddleExample::Endpoints__ namespace module.
+    1. Give these endpoints methods that call `get` or `post` to perform the actual request
+    2. Their module/class namespace determines how they are accessed in the client's call tree. For example, the `get_all` in __SaddleExample::Endpoints::Fish::Guppy__ would be accessed by:
 
-        client.fish.guppy.get_all()
+            client.fish.guppy.get_all
 
-    3. If you need REST style endpoints like client.fish('guppy').catch() then check out __Saddle::ResourceEndpoint__ and how it's used in [saddle-example](https://github.com/mLewisLogic/saddle-example/blob/master/lib/endpoints/kitten.rb)
+    3. If you need REST style endpoints like `client.kitten.by_id('Whiskers').info` then check out __Saddle::ResourceEndpoint__ and how it's used in [saddle-example](https://github.com/mLewisLogic/saddle-example/blob/master/lib/saddle-example/endpoints/kitten.rb)
 
 4. Initialize an instance of your client. ex:
 
@@ -62,6 +62,12 @@ Saddle enables you to create beautifully stable and functionaly API clients, in
 * xml posting/parsing
 
 
+## version notes
+
+* Saddle versions 0.1.x are compatible with Faraday versions ~> 0.9.0
+* Saddle versions 0.0.x are compatible with Faraday versions ~> 0.8.7
+
+
 ## Code Status
 
 * [![Build Status](https://travis-ci.org/mLewisLogic/saddle.png?branch=master)](https://travis-ci.org/mLewisLogic/saddle)

data/lib/saddle/endpoint.rb

@@ -17,18 +17,15 @@ module Saddle
     def initialize(requester, relative_path_override=nil, parent=nil)
       @requester = requester
       @parent = parent
-      @relative_path = relative_path_override || _relative_path()
+      @relative_path = relative_path_override || _relative_path
     end
 
 
     # Generic request wrapper
     def request(method, action, params={}, options={})
       # Augment in interesting options
-      options[:saddle] ||= {}
-      options[:saddle] = {
-        :call_chain => _path_array(),
-        :action => action,
-      }
+      options[:call_chain] = _path_array
+      options[:action] = action
       @requester.send(method, _path(action), params, options)
     end
 
@@ -87,7 +84,7 @@ module Saddle
         if defined?(self.class::ABSOLUTE_PATH)
           [self.class::ABSOLUTE_PATH]
         else
-          _path_array()
+          _path_array
         end
       # Join it with the action
       paths = pre_action_paths + [action]
@@ -97,7 +94,7 @@ module Saddle
     end
 
     def _path_array
-      _endpoint_chain().map(&:relative_path).compact
+      _endpoint_chain.map(&:relative_path).compact
     end
 
     # Get the parent chain that led to this endpoint
@@ -108,7 +105,7 @@ module Saddle
         chain << node
         node = node.parent
       end
-      chain.reverse()
+      chain.reverse
     end
 
     # If the parent is not an endpoint, it is a root node

data/lib/saddle/faraday/rack_builder.rb

@@ -0,0 +1,15 @@
+module Saddle
+  # Same as the standard Faraday::RackBuilder, but also allows passing saddle options to the env.
+  class RackBuilder < ::Faraday::RackBuilder
+    def saddle_options
+      @saddle_options ||= {}
+    end
+
+    def build_env(connection, request)
+      env = super
+      env[:saddle] = saddle_options.deep_merge(request.saddle_options)
+      env
+    end
+
+  end
+end

data/lib/saddle/faraday/request.rb

@@ -0,0 +1,4 @@
+# Allow saddle options to be accessible through Faraday::Request.
+Faraday::Request.instance_eval do
+  attr_accessor :saddle_options
+end

data/lib/saddle/middleware/authentication/oauth1.rb

@@ -14,17 +14,17 @@ module Saddle
         TYPE_URLENCODED = 'application/x-www-form-urlencoded'.freeze
 
         def call(env)
-          if env[:request][:client_options][:oauth1] &&
-             env[:request][:client_options][:oauth1][:consumer_key] &&
-             env[:request][:client_options][:oauth1][:consumer_secret] &&
-             env[:request][:client_options][:oauth1][:token] &&
-             env[:request][:client_options][:oauth1][:token_secret]
+          if env[:saddle][:client_options][:oauth1] &&
+             env[:saddle][:client_options][:oauth1][:consumer_key] &&
+             env[:saddle][:client_options][:oauth1][:consumer_secret] &&
+             env[:saddle][:client_options][:oauth1][:token] &&
+             env[:saddle][:client_options][:oauth1][:token_secret]
 
             env[:request_headers]['Authorization'] ||= SimpleOAuth::Header.new(
               env[:method],
               env[:url].to_s,
               filtered_body_params(env),
-              env[:request][:client_options][:oauth1]
+              env[:saddle][:client_options][:oauth1]
             ).to_s
           end
 

data/lib/saddle/middleware/authentication/oauth2.rb

@@ -16,10 +16,10 @@ module Saddle
         end
 
         def call(env)
-          if env[:request][:client_options][@key_name.to_sym]
+          if env[:saddle][:client_options][@key_name.to_sym]
             new_query = []
             new_query << env[:url].query if env[:url].query
-            new_query << "#{@key_name}=#{CGI.escape(env[:request][:client_options][@key_name.to_sym].to_s)}"
+            new_query << "#{@key_name}=#{CGI.escape(env[:saddle][:client_options][@key_name.to_sym].to_s)}"
             env[:url].query = new_query.join('&')
           end
 

data/lib/saddle/middleware/extra_env.rb

@@ -9,8 +9,8 @@ module Saddle
 
     class ExtraEnv < Faraday::Middleware
       def call(env)
-        if env[:request][:client_options][:extra_env]
-          env.merge!(env[:request][:client_options][:extra_env])
+        if env[:saddle][:client_options][:extra_env]
+          env.merge!(env[:saddle][:client_options][:extra_env])
         end
 
         @app.call env

data/lib/saddle/middleware/logging/rails.rb

@@ -15,7 +15,7 @@ module Saddle
             @app.call(env)
           rescue => e
             if defined?(Rails.logger)
-              Rails.logger.error("#{env[:request][:saddle][:client].name} error: #{e}")
+              Rails.logger.error("#{env[:saddle][:client].name} error: #{e}")
             end
             # Re-raise the error
             raise

data/lib/saddle/middleware/logging/statsd.rb

@@ -33,16 +33,16 @@ module Saddle
 
         def call(env)
           # Try to build up a path for the STATSD logging
-          if env[:request][:statsd_path]
-            statsd_path = env[:request][:statsd_path]
-          elsif env[:request][:saddle]
+          if env[:saddle][:statsd_path]
+            statsd_path = env[:saddle][:statsd_path]
+          elsif env[:saddle][:client]
             statsd_path_components = [
               'saddle',
-              env[:request][:saddle][:client].name.underscore,
+              env[:saddle][:client].name.underscore,
             ]
-            if env[:request][:saddle][:call_chain] && env[:request][:saddle][:action]
-              statsd_path_components += env[:request][:saddle][:call_chain]
-              statsd_path_components << env[:request][:saddle][:action]
+            if env[:saddle][:call_chain] && env[:saddle][:action]
+              statsd_path_components += env[:saddle][:call_chain]
+              statsd_path_components << env[:saddle][:action]
             else
               statsd_path_components << 'raw'
               statsd_path_components << "#{env[:url].host}#{env[:url].path}"

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

@@ -20,7 +20,7 @@ module Saddle
         end
 
         def call(env)
-          if env[:request][:request_style] == :json
+          if env[:saddle][:request_style] == :json
             # Make sure we're working with a valid body that's not a String
             if env[:body] and !env[:body].respond_to?(:to_str)
               env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE

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

@@ -10,8 +10,8 @@ module Saddle
 
       class PathPrefix < Faraday::Middleware
         def call(env)
-          if env[:request][:client_options][:path_prefix]
-            env[:url].path = "/#{env[:request][:client_options][:path_prefix]}#{env[:url].path}"
+          if env[:saddle][:client_options][:path_prefix]
+            env[:url].path = "/#{env[:saddle][:client_options][:path_prefix]}#{env[:url].path}"
           end
 
           @app.call env

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

@@ -17,13 +17,13 @@ module Saddle
         end
 
         def call(env)
-          retries = env[:request][:num_retries] || 0
-          backoff = env[:request][:retry_backoff] || 0.050 # in seconds
+          retries = env[:saddle][:num_retries] || 0
+          backoff = env[:saddle][:retry_backoff] || 0.050 # in seconds
           begin
             @app.call(self.class.deep_copy(env))
           rescue => e
             # Only retry for GET or if the request is marked as idempotent
-            if env[:method] == :get || env[:request][:idempotent]
+            if env[:method] == :get || env[:saddle][:idempotent]
               unless @ignored_exceptions.include?(e.class)
                 # Retry a limited number of times
                 if retries > 0
@@ -40,7 +40,11 @@ module Saddle
         end
 
         def self.deep_copy(value)
-          if value.is_a?(Hash)
+          if value.is_a?(Struct)
+            result = value.clone
+            value.each{|k, v| result.send("#{k}=", deep_copy(v))}
+            result
+          elsif value.is_a?(Hash)
             result = value.clone
             value.each{|k, v| result[k] = deep_copy(v)}
             result

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

@@ -24,7 +24,7 @@ module Saddle
 
 
         def call(env)
-          if env[:request][:request_style] == :urlencoded
+          if env[:saddle][:request_style] == :urlencoded
             # Make sure we're working with a valid body that's not a String
             if env[:body] and !env[:body].respond_to?(:to_str)
               if has_multipart?(env[:body])

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

@@ -13,7 +13,7 @@ module Saddle
           user_agent = nil
           # Build a user agent that looks like 'SaddleExample 0.0.1'
           begin
-            user_agent = client_name = env[:request][:saddle][:client].name
+            user_agent = client_name = env[:saddle][:client].name
             parent_module = client_name.split('::')[0..-2].join('::').constantize
             if parent_module
               if defined?(parent_module::VERSION)

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

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

data/lib/saddle/middleware/ruby_timeout.rb

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

data/lib/saddle/requester.rb

@@ -2,7 +2,8 @@ require 'active_support/core_ext/hash'
 
 require 'faraday'
 require 'faraday_middleware'
-
+require 'saddle/faraday/request'
+require 'saddle/faraday/rack_builder'
 
 require 'saddle/middleware/request/encode_json'
 require 'saddle/middleware/request/path_prefix'
@@ -79,7 +80,7 @@ module Saddle
     # Make a GET request
     def get(url, params={}, options={})
       response = connection.get do |req|
-        req.options.deep_merge!(options)
+        req.saddle_options = options
         req.body = options[:body] if options.has_key?(:body)
         req.url(url, params)
       end
@@ -89,7 +90,7 @@ module Saddle
     # Make a POST request
     def post(url, data={}, options={})
       response = connection.post do |req|
-        req.options.deep_merge!(options)
+        req.saddle_options = options
         req.url(url)
         req.body = data
       end
@@ -99,7 +100,7 @@ module Saddle
     # Make a PUT request
     def put(url, data={}, options={})
       response = connection.put do |req|
-        req.options.deep_merge!(options)
+        req.saddle_options = options
         req.url(url)
         req.body = data
       end
@@ -109,7 +110,7 @@ module Saddle
     # Make a DELETE request
     def delete(url, params={}, options={})
       response = connection.delete do |req|
-        req.options.deep_merge!(options)
+        req.saddle_options = options
         req.url(url, params)
       end
       handle_response(response)
@@ -131,61 +132,59 @@ module Saddle
 
     # Build a connection instance, wrapped in the middleware that we want
     def connection
-      @connection ||= Faraday.new(base_url) do |builder|
+      @connection ||= Faraday.new(base_url, :builder_class => Saddle::RackBuilder) do |connection|
         # Include the requester level options
-        builder.options[:client_options] = @options
+        connection.builder.saddle_options[:client_options] = @options
 
         # Config options
-        builder.options[:timeout] = @timeout
-        builder.options[:request_style] = @request_style
-        builder.options[:num_retries] = @num_retries
-        builder.options[:saddle] = {
-          :client => @parent_client,
-        }
+        connection.options[:timeout] = @timeout
+        connection.builder.saddle_options[:request_style] = @request_style
+        connection.builder.saddle_options[:num_retries] = @num_retries
+        connection.builder.saddle_options[:client] = @parent_client
 
         # Support default return values upon exception
-        builder.use(Saddle::Middleware::Response::DefaultResponse)
+        connection.use(Saddle::Middleware::Response::DefaultResponse)
 
         # Hard timeout on the entire request
-        builder.use(Saddle::Middleware::RubyTimeout)
+        connection.use(Saddle::Middleware::RubyTimeout)
 
         # Set up a user agent
-        builder.use(Saddle::Middleware::Request::UserAgent)
+        connection.use(Saddle::Middleware::Request::UserAgent)
 
         # Set up the path prefix if needed
-        builder.use(Saddle::Middleware::Request::PathPrefix)
+        connection.use(Saddle::Middleware::Request::PathPrefix)
 
         # Apply additional implementation-specific middlewares
         @additional_middlewares.each do |m|
-          m[:args] ? builder.use(m[:klass], *m[:args]) : builder.use(m[:klass])
+          m[:args] ? connection.use(m[:klass], *m[:args]) : connection.use(m[:klass])
         end
 
         # Request encoding
-        builder.use(Saddle::Middleware::Request::JsonEncoded)
-        builder.use(Saddle::Middleware::Request::UrlEncoded)
+        connection.use(Saddle::Middleware::Request::JsonEncoded)
+        connection.use(Saddle::Middleware::Request::UrlEncoded)
 
         # Automatic retries
-        builder.use(Saddle::Middleware::Request::Retry)
+        connection.use(Saddle::Middleware::Request::Retry)
 
         # Raise exceptions on 4xx and 5xx errors
-        builder.use(Saddle::Middleware::Response::RaiseError)
+        connection.use(Saddle::Middleware::Response::RaiseError)
 
         # Handle parsing out the response if it's JSON
-        builder.use(Saddle::Middleware::Response::ParseJson)
+        connection.use(Saddle::Middleware::Response::ParseJson)
 
         # Set up instrumentation around the adapter for extensibility
-        builder.use(FaradayMiddleware::Instrumentation)
+        connection.use(FaradayMiddleware::Instrumentation)
 
         # Add in extra env data if needed
-        builder.use(Saddle::Middleware::ExtraEnv)
+        connection.use(Saddle::Middleware::ExtraEnv)
 
         # Set up our adapter
         if @stubs.nil?
           # Use the default adapter
-          builder.adapter(@http_adapter[:key], *@http_adapter[:args])
+          connection.adapter(@http_adapter[:key], *@http_adapter[:args])
         else
           # Use the test adapter
-          builder.adapter(:test, @stubs)
+          connection.adapter(:test, @stubs)
         end
       end
     end

data/lib/saddle/version.rb

@@ -1,3 +1,3 @@
 module Saddle
-  VERSION = '0.0.53'
+  VERSION = '0.1.0'
 end

data/saddle.gemspec

@@ -28,6 +28,6 @@ Gem::Specification.new do |s|
     s.add_dependency 'activesupport', '>= 3.0'
   end
 
-  s.add_dependency 'faraday', '~> 0.8.7'
+  s.add_dependency 'faraday', '~> 0.9.0'
   s.add_dependency 'faraday_middleware', '~> 0.9.0'
 end

data/spec/requester/get_spec.rb

@@ -26,7 +26,7 @@ describe Saddle::Client do
       end
 
       it "should request properly with params in the body" do
-        @stubs.send(:new_stub, :get, '/test', "body data") {
+        @stubs.send(:new_stub, :get, '/test', {}, "body data") {
           [
             200,
             {},

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: saddle
 version: !ruby/object:Gem::Version
-  version: 0.0.53
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Mike Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,20 +30,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -87,6 +94,8 @@ files:
 - lib/saddle/client_attributes.rb
 - lib/saddle/endpoint.rb
 - lib/saddle/errors.rb
+- lib/saddle/faraday/rack_builder.rb
+- lib/saddle/faraday/request.rb
 - lib/saddle/method_tree_builder.rb
 - lib/saddle/middleware/authentication/oauth1.rb
 - lib/saddle/middleware/authentication/oauth2.rb
@@ -123,26 +132,27 @@ files:
 homepage: https://github.com/mLewisLogic/saddle
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A full-featured, generic consumer layer for you to build API client implementations
   with.
 test_files:

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODQ4YmI4OGJiZDRjMjBhNmFkOWI1NGEzZWIyNDA0NWM3NGJjZTdlMQ==
-  data.tar.gz: !binary |-
-    NGI3MWM5MDgzZWIyYjVkM2RhYzk1YmRjMGY5YjU3MmE2N2MxNGYyMQ==
-SHA512:
-  metadata.gz: !binary |-
-    M2JkMWY0YTljNmFmOGI3MjA0NjY0MDRkZmU0ODc4MDNlYmYzMTNmNjVkMmJl
-    YmI4ZjBkMzhiOWJhMmFlYjg1MGE1YTJjZDg4MmY5Mjc0N2RmNDBkZjFjZmMy
-    ZjYxZWVjYzZiZjI1MzMwYWJmMjdiYWY3NDJmODNmMDk5ZGY0M2I=
-  data.tar.gz: !binary |-
-    M2Q3NWU4ODRkZGRkOWI5MDY2NmFkZWY3NDViNmZmYjE2NWJlMjEyYTBhY2Qx
-    ZGY3M2VmYzIwMmFkMjc2M2VlZTRhNTQwZjU1Yjg1MGRlNzMyMTQ0Mzg0NDRj
-    NGViYjZjY2EwMWIwN2VkYzgzNGU0MGI2NjJiODVkNGY5M2ZjZDU=