rest-core 0.8.0 → 0.8.1

data/CHANGES.md

@@ -1,5 +1,12 @@
 # CHANGES
 
+## rest-core 0.8.1 -- 2012-02-09
+
+### Bugs fixes
+
+* [ErrorDetectorHttp] Fixed argument error upon calling `lighten` for
+  clients using this middleware. (e.g. rest-more's Twitter client)
+
 ## rest-core 0.8.0 -- 2011-11-29
 
 Changes are mostly related to OAuth.

data/README.md

@@ -159,6 +159,21 @@ and [slides][] from [rubyconf.tw/2011][rubyconf.tw] for concepts.
   could be any objects, it's handled by `RestCore::CommonLogger` or
   any other custom _middleware_.
 
+## CONTRIBUTORS:
+
+* Andrew Liu (@eggegg)
+* andy (@coopsite)
+* Barnabas Debreczeni (@keo)
+* Bruce Chu (@bruchu)
+* Ethan Czahor (@ethanz5)
+* Florent Vaucelle (@florent)
+* Jaime Cham (@jcham)
+* John Fan (@johnfan)
+* Lin Jen-Shin (@godfat)
+* Mariusz Pruszynski (@snicky)
+* Mr. Big Cat (@miaout17)
+* Nicolas Fouché (@nfo)
+
 ## LICENSE:
 
 Apache License 2.0

data/lib/rest-core/middleware/error_detector_http.rb

@@ -2,10 +2,8 @@
 require 'rest-core/middleware/error_detector'
 
 class RestCore::ErrorDetectorHttp < RestCore::ErrorDetector
-  def self.members; [:error_detector]; end
-  include RestCore::Middleware
-
-  def initialize app
-    super(app, lambda{ |env| (env[RESPONSE_STATUS] || 200) / 100 >= 4 })
+  def initialize app, detector=nil
+    super(app, detector ||
+               lambda{ |env| (env[RESPONSE_STATUS] || 200) / 100 >= 4 })
   end
 end

data/lib/rest-core/middleware/oauth1_header.rb

@@ -56,15 +56,7 @@ class RestCore::Oauth1Header
   def base_string env, oauth_params
     method   = env[REQUEST_METHOD].to_s.upcase
     base_uri = env[REQUEST_PATH]
-    # TODO: the detection should be checking if it's
-    # application/x-www-form-urlencoded or not, instead of multipart or not.
-    # but since the Content-Type is generated in app (http client),
-    # we have no idea what it would be here. so simply guessing it...
-    payload  = if multipart?(env)
-                 {}
-               else
-                 reject_blank(env[REQUEST_PAYLOAD] || {})
-               end
+    payload  = payload_params(env)
     query    = reject_blank(env[REQUEST_QUERY] || {})
     params   = reject_blank(oauth_params.merge(query.merge(payload))).
       to_a.sort.map{ |(k, v)|
@@ -77,10 +69,39 @@ class RestCore::Oauth1Header
     [OpenSSL::Random.random_bytes(32)].pack('m').tr("+/=\n", '')
   end
 
-  def multipart? env
-    !!(env[REQUEST_PAYLOAD] &&
-       env[REQUEST_PAYLOAD].find{ |k, v| v.kind_of?(IO) ||
-                                         v.respond_to?(:read) })
+  # according to OAuth 1.0a spec, only:
+  #     Content-Type: application/x-www-form-urlencoded
+  # should take payload as a part of the base_string
+  def payload_params env
+    # if we already specified Content-Type and which is not
+    # application/x-www-form-urlencoded, then we should not
+    # take payload as a part of the base_string
+    if env[REQUEST_HEADERS].kind_of?(Hash)  &&
+       env[REQUEST_HEADERS]['Content-Type'] &&
+       env[REQUEST_HEADERS]['Content-Type'] !=
+         'application/x-www-form-urlencoded'
+      {}
+
+    # if it contains any binary data,
+    # then it shouldn't be application/x-www-form-urlencoded either
+    # the Content-Type header would be handled in our HTTP client
+    elsif contain_binary?(env[REQUEST_PAYLOAD])
+      {}
+
+    # so the Content-Type header must be application/x-www-form-urlencoded
+    else
+      reject_blank(env[REQUEST_PAYLOAD] || {})
+    end
+  end
+
+  def contain_binary? payload
+    return false unless payload
+    return true  if     payload.kind_of?(IO)    ||
+                        payload.respond_to?(:read)
+    return true  if     payload.find{ |k, v|
+      # if payload is an array, then v would be nil
+      (v || k).kind_of?(IO) || (v || k).respond_to?(:read) }
+    return false
   end
 
   def reject_blank params

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

data/lib/rest-core/wrapper.rb

@@ -13,6 +13,11 @@ module RestCore::Wrapper
     end
   end
 
+  attr_writer :default_app
+  def default_app
+    @default_app ||= self.class.default_app
+  end
+
   def initialize &block
     @middles ||= []
     instance_eval(&block) if block_given?
@@ -38,7 +43,7 @@ module RestCore::Wrapper
     }.flatten
   end
 
-  def to_app init=@init || self.class.default_app
+  def to_app init=@init || default_app
     # === foldr m.new app middles
     middles.reverse.inject(init.new){ |app_, (middle, args, block)|
       begin

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [
   "Cardinal Blue",
   "Lin Jen-Shin (godfat)"]
-  s.date = "2011-11-29"
+  s.date = "2012-02-09"
   s.description = "Modular Ruby clients interface for REST APIs\n\nThere has been an explosion in the number of REST APIs available today.\nTo address the need for a way to access these APIs easily and elegantly,\nwe have developed [rest-core][], which consists of composable middleware\nthat allows you to build a REST client for any REST API. Or in the case of\ncommon APIs such as Facebook, Github, and Twitter, you can simply use the\ndedicated clients provided by [rest-more][].\n\n[rest-core]: http://github.com/cardinalblue/rest-core\n[rest-more]: http://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   ".gitmodules",
   ".travis.yml",
   "CHANGES.md",
-  "CONTRIBUTORS",
   "Gemfile",
   "LICENSE",
   "NOTE.md",
@@ -68,18 +67,20 @@ Gem::Specification.new do |s|
   "test/test_builder.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_error_detector_http.rb",
   "test/test_oauth1_header.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]
   s.homepage = "https://github.com/cardinalblue/rest-core"
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.11"
+  s.rubygems_version = "1.8.15"
   s.summary = "Modular Ruby clients interface for REST APIs"
   s.test_files = [
   "test/test_auth_basic.rb",
   "test/test_builder.rb",
   "test/test_client.rb",
   "test/test_client_oauth1.rb",
+  "test/test_error_detector_http.rb",
   "test/test_oauth1_header.rb",
   "test/test_universal.rb",
   "test/test_wrapper.rb"]

data/test/test_error_detector_http.rb

@@ -0,0 +1,12 @@
+
+require 'rest-core/test'
+
+describe RC::AuthBasic do
+  should 'lighten' do
+    RC::Builder.client do
+      s = self.class # this is only for ruby 1.8!
+      use s::ErrorDetectorHttp
+      run s::Dry
+    end.new.lighten.attributes.should.key?(:error_detector)
+  end
+end

data/test/test_oauth1_header.rb

@@ -24,32 +24,64 @@ describe RestCore::Oauth1Header do
       'MCD8BKwGdgPHvAuvgvz4EQpqDAtx89grbuNMRd7Eh98')
   end
 
-  should 'have correct base_string' do
-    @auth.base_string(@env, @oauth_params).should.eq(
-      'POST&https%3A%2F%2Fapi.twitter.com%2Foauth%2Frequest_token&' \
-      'oauth_callback%3Dhttp%253A%252F%252Flocalhost%253A3005%252F' \
-      'the_dance%252Fprocess_callback%253Fservice_provider_id%253D' \
-      '11%26oauth_consumer_key%3DGDdmIQH6jhtmLUypg82g%26oauth_nonc' \
-      'e%3DQP70eNmVz8jvdPevU3oJD2AfF7R7odC2XJcn4XlZJqk%26oauth_sig' \
-      'nature_method%3DHMAC-SHA1%26oauth_timestamp%3D1272323042%26' \
-      'oauth_version%3D1.0')
-  end
-
-  should 'not use payload in multipart request for base_string' do
-    @env = @env.merge(RestCore::REQUEST_PAYLOAD =>
-                        {'file' => File.open(__FILE__)})
-    @auth.base_string(@env, @oauth_params).should.eq(
-      'POST&https%3A%2F%2Fapi.twitter.com%2Foauth%2Frequest_token&' \
-      'oauth_callback%3Dhttp%253A%252F%252Flocalhost%253A3005%252F' \
-      'the_dance%252Fprocess_callback%253Fservice_provider_id%253D' \
-      '11%26oauth_consumer_key%3DGDdmIQH6jhtmLUypg82g%26oauth_nonc' \
-      'e%3DQP70eNmVz8jvdPevU3oJD2AfF7R7odC2XJcn4XlZJqk%26oauth_sig' \
-      'nature_method%3DHMAC-SHA1%26oauth_timestamp%3D1272323042%26' \
-      'oauth_version%3D1.0')
-  end
-
   should 'have correct signature' do
     @auth.signature(@env, @oauth_params).should.eq(
       '8wUi7m5HFQy76nowoCThusfgB+Q=')
   end
+
+  describe 'base_string' do
+    before do
+      @base_string =
+        'POST&https%3A%2F%2Fapi.twitter.com%2Foauth%2Frequest_token&' \
+        'oauth_callback%3Dhttp%253A%252F%252Flocalhost%253A3005%252F' \
+        'the_dance%252Fprocess_callback%253Fservice_provider_id%253D' \
+        '11%26oauth_consumer_key%3DGDdmIQH6jhtmLUypg82g%26oauth_nonc' \
+        'e%3DQP70eNmVz8jvdPevU3oJD2AfF7R7odC2XJcn4XlZJqk%26oauth_sig' \
+        'nature_method%3DHMAC-SHA1%26oauth_timestamp%3D1272323042%26' \
+        'oauth_version%3D1.0'
+    end
+
+    def check
+      @auth.base_string(@env, @oauth_params).should.eq @base_string
+    end
+
+    should 'have correct base_string' do
+      check
+    end
+
+    should 'not use payload in multipart request for base_string' do
+      @env.merge!(RC::REQUEST_PAYLOAD => {'file' => File.open(__FILE__)})
+      check
+    end
+
+    should 'not use payload if it contains binary' do
+      @env.merge!(RC::REQUEST_PAYLOAD => File.open(__FILE__))
+      check
+    end
+
+    should 'not use payload if it contains [binary]' do
+      @env.merge!(RC::REQUEST_PAYLOAD => [File.open(__FILE__)])
+      check
+    end
+
+    should 'not use payload if Content-Type is not x-www-form-urlencoded' do
+      @env.merge!(RC::REQUEST_PAYLOAD => {'pay' => 'load'},
+                  RC::REQUEST_HEADERS => {'Content-Type' => 'text/plain'})
+      check
+    end
+
+    should 'use payload if Content-Type is x-www-form-urlencoded' do
+      @base_string << '%26pay%3Dload'
+      @env.merge!(RC::REQUEST_PAYLOAD => {'pay' => 'load'},
+                  RC::REQUEST_HEADERS =>
+                    {'Content-Type' => 'application/x-www-form-urlencoded'})
+      check
+    end
+
+    should 'use payload if there is no binary data' do
+      @base_string << '%26pay%3Dload'
+      @env.merge!(RC::REQUEST_PAYLOAD => {'pay' => 'load'})
+      check
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000 Z
+date: 2012-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &2164286260 !ruby/object:Gem::Requirement
+  requirement: &2168550920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164286260
+  version_requirements: *2168550920
 description: ! 'Modular Ruby clients interface for REST APIs
 
 
@@ -52,7 +52,6 @@ files:
 - .gitmodules
 - .travis.yml
 - CHANGES.md
-- CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTE.md
@@ -104,6 +103,7 @@ files:
 - test/test_builder.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
+- test/test_error_detector_http.rb
 - test/test_oauth1_header.rb
 - test/test_universal.rb
 - test/test_wrapper.rb
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Modular Ruby clients interface for REST APIs
@@ -136,6 +136,7 @@ test_files:
 - test/test_builder.rb
 - test/test_client.rb
 - test/test_client_oauth1.rb
+- test/test_error_detector_http.rb
 - test/test_oauth1_header.rb
 - test/test_universal.rb
 - test/test_wrapper.rb

data/CONTRIBUTORS

@@ -1,11 +0,0 @@
-Lin Jen-Shin (godfat)
-Barnabas Debreczeni (keo)
-John Fan (johnfan)
-Jaime Cham (jcham)
-Andrew Liu (eggegg)
-Mariusz Pruszynski (snicky)
-Florent Vaucelle (florent)
-Ethan Czahor (ethanz5)
-Nicolas Fouché (nfo)
-andy (coopsite)
-Bruce Chu (bruchu)