orthrus 0.0.4 → 0.0.5

data/lib/orthrus.rb

@@ -1,5 +1,6 @@
 require 'orthrus/remote_method'
 require 'orthrus/remote_options'
+require 'orthrus/logger'
 
 module Orthrus
   # Include Orthrus functionality in the given class

data/lib/orthrus/logger.rb

@@ -0,0 +1,22 @@
+module Orthrus
+  module Logger
+    # Initialize logger wether for rails or standalone
+    @logger = if defined?(Rails)
+      Rails.logger
+    else
+      require 'logger'
+      ::Logger.new(STDOUT)
+    end
+
+    # Display warn message in log
+    # @param [String] message
+    def self.warn(message)
+      @logger.warn("orthrus: #{message}")
+    end
+
+    # @param [String] message
+    def self.debug(message)
+      @logger.debug("orthrus: #{message}")
+    end
+  end
+end

data/lib/orthrus/remote_method.rb

@@ -9,9 +9,10 @@ module Orthrus
       options[:method] ||= :get
       @options    = options === RemoteOptions ? options : RemoteOptions.new(options)
       @base_uri   = options.delete(:base_uri)
-      @path       = options.delete(:path)
+      @path       = options.delete(:path) || ""
       @on_success = options[:on_success] || lambda { |response| response }
       @on_failure = options[:on_failure] || lambda { |response| response }
+      @debug      = options.delete(:debug)
     end
 
     # Perform the request, handle response and return the result
@@ -19,8 +20,9 @@ module Orthrus
     # @return [Response, Object] the Typhoeus::Response or the result of the on_complete block
     def run(args = {})
       options = @options.smart_merge(args)
-      url     = base_uri + interpolated_path(options)
+      url     = interpolate(base_uri + path, options)
       request = Typhoeus::Request.new(url, options)
+      Orthrus::Logger.debug("request to #{url}\n  with options #{options.inspect}") if @debug
       handle_response(request)
       if options[:return_request]
         request
@@ -31,21 +33,22 @@ module Orthrus
       end
     end
 
-    # Interpolate parts of the path marked through color
+    # Interpolate parts of the given url which are marked by colon
+    # @param [String] url to be interpolated
     # @param [Hash] args to perform interpolation
-    # @return [String] the interpolated path
-    # @example Interpolate a path
-    #   path = "/planet/:identifier"
-    #   interpolated_path({:identifier => "mars"}) #=> "/planet/mars"
-    def interpolated_path(args = {})
-      interpolated_path = @path || ""
+    # @return [String] the interpolated url
+    # @example Interpolate a url
+    #   interpolate("http://example.com/planet/:identifier", {:identifier => "mars"}) #=> "http://example.com/planet/mars"
+    def interpolate(url, args = {})
+      result = url
       args.each do |key, value|
-        if interpolated_path.include?(":#{key}")
-          interpolated_path.sub!(":#{key}", value.to_s)
+        if result.include?(":#{key}")
+          result.sub!(":#{key}", value.to_s)
           args.delete(key)
         end
       end
-      interpolated_path
+      Orthrus::Logger.debug("interpolation result is #{result}") if @debug
+      result
     end
 
     # Call success and failure handler on request complete

data/lib/orthrus/version.rb

@@ -1,3 +1,3 @@
 module Orthrus
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/test_remote_method.rb

@@ -3,9 +3,9 @@ require 'test_helper'
 class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_path_interpolation
-    remote_method = Orthrus::RemoteMethod.new :path => "/some/:id/with/:child"
+    remote_method = Orthrus::RemoteMethod.new
     args = { :id => 4, :child => 2, :another => 3 }
-    interpolated  = remote_method.interpolated_path(args)
+    interpolated  = remote_method.interpolate('/some/:id/with/:child', args)
     assert_equal "/some/4/with/2", interpolated
     assert_equal({ :another => 3 }, args)
   end
@@ -35,7 +35,7 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
     )
     assert_equal @mars_response.body, remote_method.run(:identifier => :mars).body
   end
-  
+
   def test_remote_method_with_empty_path
     remote_method = Orthrus::RemoteMethod.new(
       :base_uri => "http://astronomical.test/planets/mars",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: orthrus
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Johannes Opper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-15 00:00:00 +02:00
+date: 2011-10-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,7 @@ files:
 - README.markdown
 - Rakefile
 - lib/orthrus.rb
+- lib/orthrus/logger.rb
 - lib/orthrus/remote_method.rb
 - lib/orthrus/remote_options.rb
 - lib/orthrus/version.rb