orthrus 0.0.2 → 0.0.3

data/CHANGELOG.markdown

@@ -0,0 +1,13 @@
+0.0.3
+-----
+* Typhoeus::Hydra compatibility added
+
+0.0.2
+-----
+* Improved default option handling
+
+0.0.1
+-----
+* Extracted remote method defining out of Typhoeus
+* Reestablished compatibility with currenct Typhoeus request interface
+* Added test to cover whole functionaliy

data/README.markdown

@@ -21,7 +21,10 @@ easy interface to work with.
 
 ## Usage
 
-*Simple: OpenLibrary Example*
+In general, Orthrus will accept all options that Typhoeus does. Here are some
+examples how to use it:
+
+### Simple Example: OpenLibrary
 
     require 'rubygems'
     require 'typhoeus'
@@ -29,15 +32,15 @@ easy interface to work with.
 
     class OpenLibrary
       include Orthrus
-      remote_defaults :base_uri => "http://openlibrary.org/api"
+      remote_defaults :base_uri => "http://openlibrary.org/api", :format => "json"
 
       define_remote_method :book, :path => '/books'
     end
 
-    book = OpenLibrary.book(:params => {:bibkeys => "ISBN:0451526538", :format => "json"})
+    book = OpenLibrary.book(:params => {:bibkeys => "ISBN:0451526538"})
     puts book.inspect # Typhoeus::Response
 
-*Advanced: Twitter Example with JSON handling and path interpolation*
+### Advanced: Twitter Example with JSON handling and path interpolation
 
     require 'rubygems'
     require 'typhoeus'
@@ -48,7 +51,8 @@ easy interface to work with.
       include Orthrus
       remote_defaults :on_success => lambda { |response| JSON.parse(response.body) },
                       :on_failure => lambda { |response| puts "error code: #{response.code}"; {} },
-                      :base_uri   => "http://api.twitter.com"
+                      :base_uri   => "http://api.twitter.com",
+                      :version    => 1
 
       define_remote_method :search, :path   => "/:version/search.json"
       define_remote_method :trends, :path   => "/:version/trends/:time_frame.json"
@@ -57,19 +61,45 @@ easy interface to work with.
     end
 
     # Get all tweets mentioning pluto
-    tweets = Twitter.search(:version => 1, :params => {:q => "pluto"})
+    tweets = Twitter.search(:params => {:q => "pluto"})
 
     # Get all current trends
-    trends = Twitter.trends(:version => 1, :time_frame => :current)
+    trends = Twitter.trends(:time_frame => :current)
 
     # Submit a tweet. Authentication skipped in example.
-    Twitter.tweet(:version => 1, :params => {:status => "I #love #planets! :)"})
+    Twitter.tweet(:params => {:status => "I #love #planets! :)"})
+
+
+### Hydra
+
+To use Typhoeus' hydra to perform multiple request parallel, you can set the `return_request` option
+in `remote_defaults`, `define_remote_method` or even on per request basis to `true`.
+Orthrus will return the crafted Typhoeus::Request, including the success and error handling.
+
+    require 'rubygems'
+    require 'typhoeus'
+    require 'orthrus'
+
+    class WeatherInformation
+      include Orthrus
+      remote_defaults :base_uri       => "http://wackyweather.test",
+                      :return_request => true
+
+      define_remote_method :city, :path => "/city/:name"
+    end
+
+    hydra = Typhoeus::Hydra.new
+    hydra.queue new_york = WeatherInformation.city(:name => "new_york")
+    hydra.queue berlin   = WeatherInformation.city(:name => "berlin")
+    hydra.run
+
+    puts berlin.handled_response
+
+For more information about the hydra feature, visit: http://github.com/dbalatero/typhoeus
 
 ## TODO
 
  - no cache handling yet.
- - make requests hydra-compatible
- - set default parameters
 
 ## Author
 

data/lib/orthrus/remote_method.rb

@@ -18,12 +18,17 @@ module Orthrus
     # @param [Hash] args for interpolation and request options
     # @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.smart_merge(args))
+      options = @options.smart_merge(args)
+      url     = base_uri + interpolated_path(options)
+      request = Typhoeus::Request.new(url, options)
       handle_response(request)
-      Typhoeus::Hydra.hydra.queue request
-      Typhoeus::Hydra.hydra.run
-      request.handled_response
+      if options[:return_request]
+        request
+      else
+        Typhoeus::Hydra.hydra.queue request
+        Typhoeus::Hydra.hydra.run
+        request.handled_response
+      end
     end
 
     # Interpolate parts of the path marked through color

data/lib/orthrus/version.rb

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

data/test/test_remote_method.rb

@@ -38,10 +38,10 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
 
   def test_remote_method_with_success_handler
     remote_method = Orthrus::RemoteMethod.new(
-      :base_uri => "http://astronomical.test",
-      :path     => "/planets/:identifier",
+      :base_uri   => "http://astronomical.test",
+      :path       => "/planets/:identifier",
       :on_success => lambda { |response| JSON.parse(response.body) },
-      :method   => :get
+      :method     => :get
     )
     response = remote_method.run(:identifier => :mars)
     assert_equal '3.9335 g/cm3', response['mars']['density']
@@ -68,4 +68,13 @@ class TestDefineRemoteMethod < Test::Unit::TestCase
     response = remote_method.run(:body => '{"planet":"naboo"}')
     assert_equal "Creating planets is not your business!", response.body
   end
+
+  def test_remote_method_returns_request
+    remote_method = Orthrus::RemoteMethod.new(
+      :base_uri       => "http://astronomical.test",
+      :path           => "/planets",
+      :return_request => true
+    )
+    assert_instance_of Typhoeus::Request, remote_method.run
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: orthrus
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Johannes Opper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-18 00:00:00 +02:00
+date: 2011-06-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- CHANGELOG.markdown
 - Gemfile
 - LICENSE
 - README.markdown