orthrus 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
+.rvmrc
 *.gem
 .bundle
 Gemfile.lock

data/lib/orthrus.rb

@@ -1,4 +1,5 @@
 require 'orthrus/remote_method'
+require 'orthrus/remote_options'
 
 module Orthrus
   # Include Orthrus functionality in the given class
@@ -8,30 +9,32 @@ module Orthrus
   end
 
   module ClassMethods
+    # Getter for remote options
+    # @return [RemoteOptions] the remote options for this class
+    def remote_options
+      @remote_options ||= RemoteOptions.new
+    end
 
     # Define default settings for the remote connection.
     # @attribute remote_defaults
     # @param [Hash] options to be set as default
     # @return [Hash] the current remote default settings
     def remote_defaults(options)
-      @remote_defaults ||= {}
-      @remote_defaults.merge!(options) if options
-      @remote_defaults
+      remote_options.smart_merge!(options)
     end
 
     # If we get subclassed, make sure that child inherits the remote defaults
     # of the parent class.
     def inherited(child)
-      child.__send__(:remote_defaults, @remote_defaults)
+      child.__send__(:remote_defaults, remote_options)
     end
 
     # Declare a remote method and create a class method as wrapper
     # @param [Symbol] name of the remote method
     # @param [Hash] options for the remote method
     def define_remote_method(name, options = {})
-      remote_options = (@remote_defaults || {}).merge(options)
       @remote_methods ||= {}
-      @remote_methods[name] = RemoteMethod.new(remote_options)
+      @remote_methods[name] = RemoteMethod.new(remote_options.smart_merge(options))
 
       class_eval <<-SRC
         def self.#{name.to_s}(args = {})

data/lib/orthrus/remote_method.rb

@@ -7,11 +7,11 @@ module Orthrus
     # @param [Hash] options for the request
     def initialize(options = {})
       options[:method] ||= :get
-      @options     = options
-      @base_uri    = options.delete(:base_uri)
-      @path        = options.delete(:path)
-      @on_success  = options[:on_success] || lambda { |response| response }
-      @on_failure  = options[:on_failure] || lambda { |response| response }
+      @options    = options === RemoteOptions ? options : RemoteOptions.new(options)
+      @base_uri   = options.delete(:base_uri)
+      @path       = options.delete(:path)
+      @on_success = options[:on_success] || lambda { |response| response }
+      @on_failure = options[:on_failure] || lambda { |response| response }
     end
 
     # Perform the request, handle response and return the result
@@ -19,7 +19,7 @@ module Orthrus
     # @return [Response, Object] the Typhoeus::Response or the result of the on_complete block
     def run(args = {})
       url     = base_uri + interpolated_path(args)
-      request = Typhoeus::Request.new(url, @options.merge(args))
+      request = Typhoeus::Request.new(url, @options.smart_merge(args))
       handle_response(request)
       Typhoeus::Hydra.hydra.queue request
       Typhoeus::Hydra.hydra.run

data/lib/orthrus/remote_options.rb

@@ -0,0 +1,24 @@
+module Orthrus
+  class RemoteOptions < Hash
+    # @param [Hash] options to be set as remote options
+    def initialize(options = {})
+      replace(options)
+    end
+
+    # Merge the given hash and its subhashes.
+    # @param [Hash] other_hash to merge against
+    # @return [nil, RemoteOptions] the merged options
+    def smart_merge(hash)
+      return self if hash.nil?
+      merge(hash) do |key, o, n|
+        o.is_a?(Hash) && n.is_a?(Hash) ? o.merge(n) : n
+      end
+    end
+
+    # Perform smart merge and replace the current content
+    # @params (@see #deep_merge)
+    def smart_merge!(other_hash)
+      replace(smart_merge(other_hash))
+    end
+  end
+end

data/lib/orthrus/version.rb

@@ -1,3 +1,3 @@
 module Orthrus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_class_methods.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class TestClassMethods < Test::Unit::TestCase
+
+  def test_setting_remote_defaults
+    assert_not_nil defaults = Astronomy.instance_variable_get(:@remote_options)
+    assert_equal "http://astronomical.test", defaults[:base_uri]
+    assert_equal "Basic authentication", defaults[:headers][:authentication]
+    assert_equal "json", defaults[:params][:format]
+  end
+
+  def test_overwritting_remote_defaults_in_subclass
+    assert_not_nil defaults = Biology.instance_variable_get(:@remote_options)
+    assert_equal "http://biological.test", defaults[:base_uri]
+    assert_equal "Basic authentication", defaults[:headers][:authentication]
+    assert_equal "json", defaults[:params][:format]
+    assert_equal false, defaults[:params][:boring]
+  end
+
+  def test_define_remote_method
+    assert Astronomy.respond_to? :find
+  end
+end

data/test/test_helper.rb

@@ -5,4 +5,31 @@ require 'orthrus'
 require 'json'
 
 class Test::Unit::TestCase
+  class Astronomy
+    include Orthrus
+    remote_defaults :headers  => { :authentication => "Basic authentication" },
+                    :base_uri => "http://astronomical.test",
+                    :params   => { :format => "json" }
+
+    define_remote_method :find,
+                         :path   => "/planets/:identifier",
+                         :params => { :include_details => true }
+  end
+
+  class Biology < Astronomy
+    remote_defaults :base_uri => "http://biological.test",
+                    :params   => { :boring => false }
+  end
+
+  def setup
+    hydra           = Typhoeus::Hydra.hydra
+    @index_response = Typhoeus::Response.new(:code => 200, :body => '{ "planets" : ["mars", "earth", "venus"] }', :time => 0.3)
+    @mars_response  = Typhoeus::Response.new(:code => 200, :body => '{ "mars" : { "density" : "3.9335 g/cm3" , "temperature" : "210K" } }', :time => 0.3)
+    @error_response = Typhoeus::Response.new(:code => 404, :body => '{ "eris" : "is no planet but a TNO" }', :time => 0.3)
+    @put_response   = Typhoeus::Response.new(:code => 403, :body => 'Creating planets is not your business!', :time => 0.3)
+    hydra.stub(:get, "http://astronomical.test/planets").and_return(@index_response)
+    hydra.stub(:get, "http://astronomical.test/planets/mars").and_return(@mars_response)
+    hydra.stub(:get, "http://astronomical.test/planets/eris").and_return(@error_response)
+    hydra.stub(:put, "http://astronomical.test/planets").and_return(@put_response)
+  end
 end

data/test/test_remote_method.rb

@@ -1,17 +1,6 @@
 require 'test_helper'
 
 class TestDefineRemoteMethod < Test::Unit::TestCase
-  def setup
-    hydra           = Typhoeus::Hydra.hydra
-    @index_response = Typhoeus::Response.new(:code => 200, :body => '{ "planets" : ["mars", "earth", "venus"] }', :time => 0.3)
-    @show_response  = Typhoeus::Response.new(:code => 200, :body => '{ "mars" : { "density" : "3.9335 g/cm3" , "temperature" : "210K" } }', :time => 0.3)
-    @error_response = Typhoeus::Response.new(:code => 404, :body => '{ "eris" : "is no planet but a TNO" }', :time => 0.3)
-    @put_response   = Typhoeus::Response.new(:code => 403, :body => 'Creating planets is not your business!', :time => 0.3)
-    hydra.stub(:get, "http://astronomical.joe/planets").and_return(@index_response)
-    hydra.stub(:get, "http://astronomical.joe/planets/mars").and_return(@show_response)
-    hydra.stub(:get, "http://astronomical.joe/planets/eris").and_return(@error_response)
-    hydra.stub(:put, "http://astronomical.joe/planets").and_return(@put_response)
-  end
 
   def test_path_interpolation
     remote_method = Orthrus::RemoteMethod.new :path => "/some/:id/with/:child"
@@ -23,7 +12,7 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_simple_remote_method_get
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri => "http://astronomical.joe",
+      :base_uri => "http://astronomical.test",
       :path     => "/planets",
       :method   => :get
     )
@@ -32,7 +21,7 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_simple_remote_method_with_get_as_default
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri => "http://astronomical.joe",
+      :base_uri => "http://astronomical.test",
       :path     => "/planets"
     )
     assert_equal @index_response.body, remote_method.run.body
@@ -40,16 +29,16 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_remote_method_with_interpolation
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri => "http://astronomical.joe",
+      :base_uri => "http://astronomical.test",
       :path     => "/planets/:identifier",
       :method   => :get
     )
-    assert_equal @show_response.body, remote_method.run(:identifier => :mars).body
+    assert_equal @mars_response.body, remote_method.run(:identifier => :mars).body
   end
 
   def test_remote_method_with_success_handler
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri => "http://astronomical.joe",
+      :base_uri => "http://astronomical.test",
       :path     => "/planets/:identifier",
       :on_success => lambda { |response| JSON.parse(response.body) },
       :method   => :get
@@ -61,7 +50,7 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_remote_method_with_failure_handler
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri   => "http://astronomical.joe",
+      :base_uri   => "http://astronomical.test",
       :path       => "/planets/:identifier",
       :on_failure => lambda { |response| JSON.parse(response.body) },
       :method     => :get
@@ -72,11 +61,11 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_remote_method_put
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri   => "http://astronomical.joe",
+      :base_uri   => "http://astronomical.test",
       :path       => "/planets",
       :method     => :put
     )
-    response = remote_method.run(:body => '{ :planet => :naboo }')
+    response = remote_method.run(:body => '{"planet":"naboo"}')
     assert_equal "Creating planets is not your business!", response.body
   end
 end

data/test/test_remote_options.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class TestRemoteOptions < Test::Unit::TestCase
+  def test_remote_options_init
+    remote_options = Orthrus::RemoteOptions.new(:base_uri => "http://astronomical.joe", :params => {:format => :json})
+    assert_kind_of Hash, remote_options
+    assert_equal "http://astronomical.joe", remote_options[:base_uri]
+    assert_equal :json, remote_options[:params][:format]
+  end
+
+  def test_remote_options_merge
+    remote_options = Orthrus::RemoteOptions.new(:params => {:format => :json})
+    remote_options = remote_options.smart_merge(:params => {:planet => :juno})
+    assert_equal :json, remote_options[:params][:format]
+    assert_equal :juno, remote_options[:params][:planet]
+  end
+
+  def test_remote_options_merge_on_self
+    remote_options = Orthrus::RemoteOptions.new(:params => {:format => :json})
+    remote_options.smart_merge!(:params => {:planet => :juno})
+    assert_equal :json, remote_options[:params][:format]
+    assert_equal :juno, remote_options[:params][:planet]
+  end
+
+  def test_remote_options_merge_with_nil
+    remote_options = Orthrus::RemoteOptions.new(:params => {:format => :xml})
+    remote_options.smart_merge!(nil)
+    assert_equal :xml, remote_options[:params][:format]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: orthrus
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Johannes Opper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +02:00
+date: 2011-06-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,19 +74,19 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- .rvmrc
 - Gemfile
 - LICENSE
 - README.markdown
 - Rakefile
 - lib/orthrus.rb
 - lib/orthrus/remote_method.rb
+- lib/orthrus/remote_options.rb
 - lib/orthrus/version.rb
 - orthrus.gemspec
-- test/test_define_remote_method.rb
+- test/test_class_methods.rb
 - test/test_helper.rb
-- test/test_remote_defaults.rb
 - test/test_remote_method.rb
+- test/test_remote_options.rb
 has_rdoc: true
 homepage: http://github.com/xijo/orthrus
 licenses: []
@@ -122,7 +122,7 @@ signing_key:
 specification_version: 3
 summary: Remote method handling for Typhoeus
 test_files: 
-- test/test_define_remote_method.rb
+- test/test_class_methods.rb
 - test/test_helper.rb
-- test/test_remote_defaults.rb
 - test/test_remote_method.rb
+- test/test_remote_options.rb

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.8.7@orthrus

data/test/test_define_remote_method.rb

@@ -1,24 +0,0 @@
-require 'test_helper'
-
-class TestDefineRemoteMethod < Test::Unit::TestCase
-  class A
-    include Orthrus
-    define_remote_method :method_on_a,
-                         :path => 'entities',
-                         :base_uri => "http://fancydomain.com"
-  end
-
-  class B
-    include Orthrus
-    remote_defaults :base_uri => "http://superfancy.com"
-    define_remote_method :method_on_b, :path => "entities/index"
-  end
-
-  def test_define_remote_method_without_defaults
-    assert A.respond_to? :method_on_a
-  end
-
-  def test_define_remote_method_with_remote_defaults
-    assert B.respond_to? :method_on_b
-  end
-end

data/test/test_remote_defaults.rb

@@ -1,26 +0,0 @@
-require 'test_helper'
-
-class TestRemoteDefaults < Test::Unit::TestCase
-  class A
-    include Orthrus
-    remote_defaults :headers => { :authentication => "Basic someting" },
-                    :base_uri => "http://fancydomain.com"
-  end
-
-  class B < A
-    remote_defaults :base_uri => "http://superfancy.com"
-  end
-
-  def test_setting_remote_defaults
-    assert_not_nil defaults = A.instance_variable_get(:@remote_defaults)
-    assert_equal "http://fancydomain.com", defaults[:base_uri]
-    assert_equal "Basic someting", defaults[:headers][:authentication]
-  end
-
-  def test_overwritting_remote_defaults_in_subclass
-    assert_not_nil defaults = B.instance_variable_get(:@remote_defaults)
-    assert_equal "http://superfancy.com", defaults[:base_uri]
-    assert_equal "Basic someting", defaults[:headers][:authentication]
-  end
-
-end