saddle 0.0.23 → 0.0.25

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWZjMDk3MDczMTlkYjllMDk3MmQ2NDRlNWY1ODE3Yjk5NTFiNmQ0Mw==
+    Y2Y4MDY5M2RmMWE1MDEwYWZiY2IzYWI2ZWFjNTJkNzYzZGIwYWU4Ng==
   data.tar.gz: !binary |-
-    ODlkYTE3OGJhNjU3Mjc3ODUwYmVjODEyNWRhMzNlMTA0MzczOGEzZQ==
+    MTI2M2QxZjMzNzMyZjYxOTFhZDAxNDc0YWJlYTBlZDQ3ODBmOTVjZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTY1MTFiZmIxYTIyOWZhNWZhZGY5ZTA5NTE5ZDdjMWExOGNmNGU0M2Q5ODUx
-    NjFjYzM0MjFhOGVjNjkxZTYyYTkyMzc0MTY2YTEzYzBiMDVlYTAyMTBlMmEz
-    OTdlNjc0OWFmNGU4OWVhMTY5MTg0ODUzODBiM2JlNTY5M2U2MzI=
+    ZTIzNjk2ZWZjYzJjNzE4YzVhMTNkYWM1YjliNGUxZjM4MjE1ZTNhMjAxMGM3
+    ZjJiZDJjYTllZjNhMGUwMzkwYTNlMjhmODY2ODU0M2M5MDIyMTM3NTk4MjBm
+    Y2RjZTBiMzY1NmM5MWJiNzkzNGE2ODAyNjE3ODc0Y2E5MzQzMmI=
   data.tar.gz: !binary |-
-    Y2QyNTVjMjllZGY3MTlmYjI5NmQ2ZDYzODhmM2ZkYmFjYmNkN2RjYjljNjc3
-    MjdmYjc5ZDE1N2MyM2Q2ZDRkMDVhMzhiM2RmNjhkOWZiM2U5ODRlMGQ1MTM2
-    NDkyYzFlZTE1M2IyYjZlZTRhY2M1NGUxYWUwMGQ1ODk5OGZhZmE=
+    YTE3YjBhYTBlMzQxNDdiMTQ4NTM0NzY3NzE5MWU2OTg2MjJhYjk5NzQyNDZk
+    YWJkN2ZhZGI2OGIyYmE3OTRhM2E3OTQyYmU0Yzk3NWRlMzE1M2U3MjMzYjY1
+    YTAzOWI2MDQxZGUxNTY2YmZmYTUyZDE2NDkyOTQ1MDQ2OTg2NWE=

data/lib/saddle.rb

@@ -17,28 +17,36 @@ module Saddle
 
     class << self
       attr_accessor :additional_middlewares
-    end
 
-    # Once your implementation is written, this is the magic you need to
-    # create a client instance.
-    def self.create(opt={})
-      self.build_tree(
-        Saddle::Requester.new(
-          default_options.merge(opt)
+      # Once your implementation is written, this is the magic you need to
+      # create a client instance.
+      def create(opt={})
+        self.build_tree(
+          Saddle::Requester.new(
+            self,
+            default_options.merge(opt)
+          )
         )
-      )
-    end
+      end
 
-    def self.inherited(obj)
-      # Clone the parent's additional_middlewares
-      obj.additional_middlewares = if defined?(obj.superclass.additional_middlewares)
-        (obj.superclass.additional_middlewares || []).clone
-      else
-        []
+      def inherited(obj)
+        # Clone the parent's additional_middlewares
+        obj.additional_middlewares = if defined?(obj.superclass.additional_middlewares)
+          (obj.superclass.additional_middlewares || []).clone
+        else
+          []
+        end
+        # Add additional client attributes
+        obj.send(:include, Saddle::ClientAttributes)
       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
+      end
+
+    end
 
   end
 

data/lib/saddle/endpoint.rb

@@ -69,8 +69,8 @@ module Saddle
 
     def _request(method, action, params={}, options={})
       # Augment in interesting options
+      options[:saddle] ||= {}
       options[:saddle] = {
-        :client_name => _client_name(),
         :call_chain => _path_array(),
         :action => action,
       }
@@ -100,20 +100,6 @@ module Saddle
       chain.reverse()
     end
 
-    # Traverse back until we find the original client
-    def _client
-      node = self
-      while node.is_a?(BaseEndpoint)
-        node = node.parent
-      end
-      node
-    end
-
-    # Underscore name of the client
-    def _client_name
-      ActiveSupport::Inflector.underscore(self._client.name.split('::')[-2])
-    end
-
     # If the parent is not an endpoint, it is a root node
     def _is_root?
       !@parent.is_a?(BaseEndpoint)

data/lib/saddle/method_tree_builder.rb

@@ -40,11 +40,11 @@ module Saddle
           root_node_class = self.implementation_module::RootEndpoint
         else
           # 'root_endpoint.rb' doesn't exist, so create a dummy endpoint
-          root_node_class = Saddle::BaseEndpoint
+          root_node_class = Saddle::TraversalEndpoint
         end
       else
         # we don't even have an implementation root, so create a dummy endpoint
-        root_node_class = Saddle::BaseEndpoint
+        root_node_class = Saddle::TraversalEndpoint
       end
       root_node_class.new(requester, nil, self)
     end
@@ -59,7 +59,7 @@ module Saddle
           # A module means that it's a branch
           # Build the branch out with a base endpoint
           branch_node = current_node._build_and_attach_node(
-            Saddle::BaseEndpoint,
+            Saddle::TraversalEndpoint,
             ActiveSupport::Inflector.underscore(const_symbol)
           )
           # Build out the branch's endpoints on the new branch node

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

@@ -34,17 +34,21 @@ module Saddle
           if env[:request][:statsd_path]
             statsd_path = env[:request][:statsd_path]
           elsif env[:request][:saddle]
-            statsd_path = (
-              ['saddle'] +
-              [env[:request][:saddle][:client_name]] +
-              env[:request][:saddle][:call_chain] +
-              [env[:request][:saddle][:action]]
-            ).join('.')
-          else
-            statsd_path = "saddle.raw.#{env[:host].to_s}.#{env[:path].to_s}"
+            statsd_path_components = [
+              'saddle',
+              ActiveSupport::Inflector.underscore(env[:request][:saddle][:client].name),
+            ]
+            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]
+            else
+              statsd_path_components << 'raw'
+              statsd_path_components << "#{env[:url].host}#{env[:url].path}"
+            end
+            statsd_path = statsd_path_components.join('.')
           end
 
-          # If we have a path, wrap the ensuing app call in STATSD timing
+          # If we have a path, wrap the call
           if statsd_path
             self.statsd.time(statsd_path) do
               @app.call(env)

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

@@ -0,0 +1,23 @@
+require 'faraday'
+
+
+
+module Saddle
+  module Middleware
+    module Request
+
+      # Public: Adds a prefix to the relative url path if present
+
+      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}"
+          end
+
+          @app.call env
+        end
+      end
+
+    end
+  end
+end

data/lib/saddle/options.rb

@@ -26,12 +26,12 @@ module Saddle
 
     # The default port for this client
     def port
-      80
+      nil
     end
 
     # A string prefix to prepend to paths as they are build (ie, 'v1')
     def path_prefix
-      ''
+      nil
     end
 
     # Should this client use SSL by default?
@@ -55,6 +55,14 @@ module Saddle
       30
     end
 
+    # If you want to set up an ActiveSupport::Notification, give your client
+    #  an instrumentation key to monitor.
+    def instrumentation_key
+      nil
+    end
+
+
+
     # Use this to add additional middleware to the request stack
     # ex:
     # add_middleware({

data/lib/saddle/requester.rb

@@ -2,6 +2,7 @@ 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/response/default_response'
@@ -21,7 +22,7 @@ module Saddle
 
     # Available options
     ## host - host to connect to (default: localhost)
-    ## port - port to connect on (default: 80)
+    ## port - port to connect on
     ## use_ssl - true if we should use https (default: false)
     ## request_style - :json or :urlencoded (default: :json)
     ## num_retries - number of times to retry each request (default: 3)
@@ -29,15 +30,15 @@ module Saddle
     ## additional_middleware - an Array of more middlewares to apply to the top of the stack
     ##                       - each middleware consists of hash of klass, and optionally args (an array)
     ## stubs - test stubs for specs
-    def initialize(opt={})
+    def initialize(parent_client, opt={})
+      # We may want properties about the parent client in middlewares
+      @parent_client = parent_client
       # Store the options for later use
       @options = opt
       @host = opt[:host] || 'localhost'
       raise ':host must be a string' unless @host.is_a?(String)
-      @port = opt[:port] || 80
-      raise ':port must be an integer' unless @port.is_a?(Fixnum)
-      @path_prefix = opt[:path_prefix] || ''
-      raise ':path_prefix must be a string' unless @path_prefix.is_a?(String)
+      @port = opt[:port]
+      raise ':port must be nil or an integer' unless (@port.nil? || @port.is_a?(Fixnum))
       @use_ssl = opt[:use_ssl] || false
       raise ':use_ssl must be true or false' unless (@use_ssl.is_a?(TrueClass) || @use_ssl.is_a?(FalseClass))
       @request_style = opt[:request_style] || :json
@@ -101,7 +102,7 @@ module Saddle
 
     # Construct a base url using this requester's settings
     def base_url
-      "http#{'s' if @use_ssl}://#{@host}:#{@port}/#{@path_prefix}"
+      "http#{'s' if @use_ssl}://#{@host}#{":#{@port}" if @port}"
     end
 
     # Build a connection instance, wrapped in the middleware that we want
@@ -110,6 +111,11 @@ module Saddle
         # Include the requester level options
         builder.options[:client_options] = @options
 
+        # Include a saddle hash
+        builder.options[:saddle] = {
+          :client => @parent_client,
+        }
+
         # Config options
         unless @timeout.nil?
           builder.options[:timeout] = @timeout
@@ -117,6 +123,12 @@ 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
+
+        # Set up the path prefix if needed
+        builder.use(Saddle::Middleware::Request::PathPrefix)
+
         # Support default return values upon exception
         builder.use(Saddle::Middleware::Response::DefaultResponse)
 
@@ -141,6 +153,9 @@ module Saddle
         # Raise exceptions on 4xx and 5xx errors
         builder.use(Faraday::Response::RaiseError)
 
+        # Set up instrumentation around the adapter for extensibility
+        builder.use(FaradayMiddleware::Instrumentation)
+
         # Set up our adapter
         if @stubs.nil?
           # Use the default adapter

data/lib/saddle/version.rb

@@ -1,3 +1,3 @@
 module Saddle
-  VERSION = '0.0.23'
+  VERSION = '0.0.25'
 end

data/spec/middleware/airbrake_spec.rb

@@ -0,0 +1,32 @@
+require 'saddle'
+require 'saddle/middleware/logging/airbrake'
+
+
+
+describe Saddle::Middleware::Logging::AirbrakeLogger do
+
+  context "test Airbrake middleware" do
+
+    it "with a request" do
+      class AirbrakeClient < Saddle::Client
+        add_middleware({
+          :klass => Saddle::Middleware::Logging::AirbrakeLogger,
+        })
+      end
+
+      client = AirbrakeClient.create(
+        :stubs => Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/test') {
+            [
+              200,
+              {},
+              'Party on!',
+            ]
+          }
+        end
+      )
+      client.requester.get('/test').should == 'Party on!'
+    end
+
+  end
+end

data/spec/middleware/instrumentation_spec.rb

@@ -0,0 +1,29 @@
+require 'saddle'
+
+
+
+describe 'FaradayMiddleware::Instrumentation' do
+
+  context "test integration of instrumentation middleware" do
+
+    it "with a request" do
+      client = Saddle::Client.create(
+        :stubs => Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/test') {
+            [
+              200,
+              {},
+              'Party on!',
+            ]
+          }
+        end
+      )
+
+
+
+
+      client.requester.get('/test').should == 'Party on!'
+    end
+
+  end
+end

data/spec/{requester → middleware}/retry_spec.rb

@@ -1,5 +1,7 @@
 require 'saddle'
 
+
+
 describe Saddle::Client do
 
   context "retry requests" do

data/spec/middleware/statsd_spec.rb

@@ -0,0 +1,33 @@
+require 'saddle'
+require 'saddle/middleware/logging/statsd'
+
+
+
+describe Saddle::Middleware::Logging::StatsdLogger do
+
+  context "test Statsd middleware" do
+
+    it "with a request" do
+      class StatsdClient < Saddle::Client
+        add_middleware({
+          :klass => Saddle::Middleware::Logging::StatsdLogger,
+          :args => ['127.0.0.1'],
+        })
+      end
+
+      client = StatsdClient.create(
+        :stubs => Faraday::Adapter::Test::Stubs.new do |stub|
+          stub.get('/test') {
+            [
+              200,
+              {},
+              'Party on!',
+            ]
+          }
+        end
+      )
+      client.requester.get('/test').should == 'Party on!'
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saddle
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.25
 platform: ruby
 authors:
 - Mike Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -72,6 +72,7 @@ files:
 - lib/saddle/middleware/logging/airbrake.rb
 - lib/saddle/middleware/logging/statsd.rb
 - lib/saddle/middleware/request/encode_json.rb
+- lib/saddle/middleware/request/path_prefix.rb
 - lib/saddle/middleware/request/retry.rb
 - lib/saddle/middleware/request/url_encoded.rb
 - lib/saddle/middleware/response/default_response.rb
@@ -81,11 +82,13 @@ files:
 - lib/saddle/requester.rb
 - lib/saddle/version.rb
 - saddle.gemspec
-- spec/middleware_spec.rb
+- spec/middleware/airbrake_spec.rb
+- spec/middleware/instrumentation_spec.rb
+- spec/middleware/retry_spec.rb
+- spec/middleware/statsd_spec.rb
 - spec/multiple_spec.rb
 - spec/requester/get_spec.rb
 - spec/requester/post_spec.rb
-- spec/requester/retry_spec.rb
 homepage: https://github.com/mLewisLogic/saddle
 licenses:
 - MIT
@@ -112,8 +115,10 @@ specification_version: 4
 summary: A full-featured, generic consumer layer for you to build API client implementations
   with.
 test_files:
-- spec/middleware_spec.rb
+- spec/middleware/airbrake_spec.rb
+- spec/middleware/instrumentation_spec.rb
+- spec/middleware/retry_spec.rb
+- spec/middleware/statsd_spec.rb
 - spec/multiple_spec.rb
 - spec/requester/get_spec.rb
 - spec/requester/post_spec.rb
-- spec/requester/retry_spec.rb

data/spec/middleware_spec.rb

@@ -1,48 +0,0 @@
-require 'saddle'
-require 'saddle/middleware/logging/airbrake'
-require 'saddle/middleware/logging/statsd'
-
-describe Saddle::Client do
-
-  context "Test middlewares" do
-
-    before :each do
-      @stubs = Faraday::Adapter::Test::Stubs.new do |stub|
-        stub.get('/test') {
-          [
-            200,
-            {},
-            'Party on!',
-          ]
-        }
-      end
-
-      @default_client = Saddle::Client.create(:stubs => @stubs)
-    end
-
-
-    it "test logging/airbrake" do
-      class AirbrakeClient < Saddle::Client
-        add_middleware({
-          :klass => Saddle::Middleware::Logging::AirbrakeLogger,
-        })
-      end
-
-      client = AirbrakeClient.create(:stubs => @stubs)
-      client.requester.get('/test').should == 'Party on!'
-    end
-
-    it "test logging/statsd" do
-      class StatsdClient < Saddle::Client
-        add_middleware({
-          :klass => Saddle::Middleware::Logging::StatsdLogger,
-          :args => ['127.0.0.1'],
-        })
-      end
-
-      client = StatsdClient.create(:stubs => @stubs)
-      client.requester.get('/test').should == 'Party on!'
-    end
-
-  end
-end