rest-core 1.0.2 → 1.0.3

data/CHANGES.md

@@ -1,5 +1,22 @@
 # CHANGES
 
+## rest-core 1.0.3 -- 2012-08-15
+
+### Enhancement
+
+* [Client] `client.head` now returns the headers instead of response body.
+  It doesn't make sense to return the response body, because there's no
+  such things in a HEAD request.
+
+### Bugs fixes
+
+* [Cache] The cache object you passed in would only need to respond to
+  `[]` and `[]=`. If the cache object accepts an `:expires_in` option,
+  then it must also respond to `store`, too.
+
+* [Oauth1Header] Fixed a long standing bug that tilde (~) shouldn't be
+  escaped. Many thanks to @brucehsu for discovering this!
+
 ## rest-core 1.0.2 -- 2012-06-05
 
 ### Enhancement

data/README.md

@@ -80,7 +80,7 @@ You can use `RestCore::Builder` to build your own dedicated client:
     require 'rest-core'
 
     YourClient = RestCore::Builder.client do
-      s = self.class # this is only for ruby 1.8!
+      s = RestCore
       use s::DefaultSite , 'https://api.github.com/users/'
       use s::JsonDecode  , true
       use s::CommonLogger, method(:puts)
@@ -122,7 +122,7 @@ cool.io. Below is an example for eventmachine:
     require 'rest-core'
 
     AsynchronousClient = RestCore::Builder.client do
-      s = self.class # this is only for ruby 1.8!
+      s = RestCore
       use s::DefaultSite , 'https://api.github.com/users/'
       use s::JsonDecode  , true
       use s::CommonLogger, method(:puts)
@@ -318,6 +318,7 @@ To be added.
 * Mariusz Pruszynski (@snicky)
 * Mr. Big Cat (@miaout17)
 * Nicolas Fouché (@nfo)
+* Szu-Kai Hsu (@brucehsu)
 
 ## LICENSE:
 

data/TODO.md

@@ -1,6 +1,5 @@
 # TODO
 
-* Auto should also pick RestClient if it's not inside a fiber
 * HTTP method in Requested log
 * middleware revisit (how to initialize?)
 * test utility
@@ -8,7 +7,6 @@
 # BUG
 
 * inheritance should work; assign builder?
-* no error handling in cool.io
 
 # FEATURE
 

data/example/auto.rb

@@ -4,7 +4,7 @@ require 'eventmachine'
 require 'cool.io'
 
 YourClient = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::DefaultSite , 'https://api.github.com/users/'
   use s::JsonDecode  , true
   use s::CommonLogger, method(:puts)

data/example/coolio.rb

@@ -2,7 +2,7 @@
 require 'rest-core'
 
 AsynchronousClient = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::DefaultSite , 'https://api.github.com/users/'
   use s::JsonDecode  , true
   use s::CommonLogger, method(:puts)

data/example/eventmachine.rb

@@ -2,7 +2,7 @@
 require 'rest-core'
 
 AsynchronousClient = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::DefaultSite , 'https://api.github.com/users/'
   use s::JsonDecode  , true
   use s::CommonLogger, method(:puts)

data/example/multi.rb

@@ -6,7 +6,7 @@ RestCore::EmHttpRequest # there might be a autoload bug?
                         # stack level too deep (SystemStackError)
 
 YourClient = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::DefaultSite , 'https://api.github.com/users/'
   use s::JsonDecode  , true
   use s::CommonLogger, method(:puts)

data/example/rest-client.rb

@@ -2,7 +2,7 @@
 require 'rest-core'
 
 YourClient = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::DefaultSite , 'https://api.github.com/users/'
   use s::JsonDecode  , true
   use s::CommonLogger, method(:puts)

data/lib/rest-core/app/em-http-request-async.rb

@@ -1,7 +1,7 @@
 
 require 'rest-core/middleware'
 
-require 'rest-client'
+require 'restclient/payload'
 require 'em-http-request'
 
 class RestCore::EmHttpRequestAsync

data/lib/rest-core/app/em-http-request-fiber.rb

@@ -1,7 +1,7 @@
 
 require 'rest-core/middleware'
 
-require 'rest-client'
+require 'restclient/payload'
 require 'em-http-request'
 require 'fiber'
 

data/lib/rest-core/client/universal.rb

@@ -1,6 +1,6 @@
 
 RestCore::Universal = RestCore::Builder.client do
-  s = self.class # this is only for ruby 1.8!
+  s = RestCore
   use s::Timeout       , 0
 
   use s::DefaultSite   , nil

data/lib/rest-core/client.rb

@@ -89,21 +89,6 @@ module RestCore::Client
         DRY           => true}.merge(opts))))
   end
 
-  # extra options:
-  #   json_decode: Bool # decode with json or not in this API request
-  #                     # default: json_decode in rest-graph instance
-  #       timeout: Int  # the timeout for this API request
-  #                     # default: timeout in rest-graph instance
-  #        secret: Bool # use secret_acccess_token or not
-  #                     # default: false
-  #         cache: Bool # use cache or not; if it's false, update cache, too
-  #                     # default: true
-  #    expires_in: Int  # control when would the cache be expired
-  #                     # default: nil
-  #         async: Bool # use eventmachine for http client or not
-  #                     # default: false, but true in aget family
-  #       headers: Hash # additional hash you want to pass
-  #                     # default: {}
   def get    path, query={}, opts={}, &cb
     request(
       {REQUEST_METHOD  => :get   ,
@@ -122,7 +107,7 @@ module RestCore::Client
     request(
       {REQUEST_METHOD  => :head  ,
        REQUEST_PATH    => path   ,
-       REQUEST_QUERY   => query  }.merge(opts), &cb)
+       REQUEST_QUERY   => query  }.merge(opts), RESPONSE_HEADERS, &cb)
   end
 
   def options path, query={}, opts={}, &cb
@@ -156,13 +141,13 @@ module RestCore::Client
        REQUEST_PAYLOAD => payload}.merge(opts), &cb)
   end
 
-  def request env, app=app
+  def request env, key=RESPONSE_BODY, app=app
     if block_given?
       request_full(env, app){ |response|
-        yield(response[RESPONSE_BODY])
+        yield(response[key])
       }
     else
-      request_full(env, app)[RESPONSE_BODY]
+      request_full(env, app)[key]
     end
   end
 
@@ -195,7 +180,7 @@ module RestCore::Client
 
 
 
-  protected
+  private
   def string_keys hash
     hash.inject({}){ |r, (k, v)|
       if v.kind_of?(Hash)

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

@@ -75,6 +75,7 @@ class RestCore::Cache
     value = response[RESPONSE_BODY]
 
     if expires_in(env).kind_of?(Fixnum) &&
+       cache(env).respond_to?(:store)   &&
        cache(env).method(:store).arity == -3
       cache(env).store(cache_key(env), value,
                        :expires_in => expires_in(env))

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

@@ -2,10 +2,12 @@
 require 'rest-core/middleware'
 require 'rest-core/util/hmac'
 
-require 'cgi'
+require 'uri'
 require 'openssl'
 
 class RestCore::Oauth1Header
+  UNRESERVED = /[^a-zA-Z0-9\-\.\_\~]/
+
   def self.members
     [:request_token_path, :access_token_path, :authorize_path,
      :consumer_key, :consumer_secret,
@@ -112,6 +114,6 @@ class RestCore::Oauth1Header
   end
 
   def escape string
-    CGI.escape(string).gsub('+', '%20')
+    URI.escape(string, UNRESERVED)
   end
 end

data/lib/rest-core/version.rb

@@ -1,4 +1,4 @@
 
 module RestCore
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/rest-core.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-core"
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   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 = "2012-06-05"
+  s.date = "2012-08-15"
   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]: https://github.com/cardinalblue/rest-core\n[rest-more]: https://github.com/cardinalblue/rest-more"
   s.email = ["dev (XD) cardinalblue.com"]
   s.files = [

data/test/test_cache.rb

@@ -66,4 +66,22 @@ describe RC::Cache do
           EM.stop }}}
     c.cache.size.should.eq 1
   end
+
+  should 'only [] and []= should be implemented' do
+    cache = Class.new do
+      def initialize    ; @h = {}            ; end
+      def []  key       ; @h[key]            ; end
+      def []= key, value; @h[key] = value * 2; end
+    end.new
+    c = RC::Builder.client do
+      use RC::Cache, cache, 0
+      run Class.new{
+        def call env
+          env.merge(RC::RESPONSE_BODY => env[RC::REQUEST_PATH])
+        end
+      }
+    end.new
+    c.get('4')
+    c.get('4').should.eq '44'
+  end
 end

data/test/test_client.rb

@@ -8,20 +8,28 @@ describe RC::Simple do
   end
 
   should 'do simple request' do
-    [:get, :post, :delete, :put,
-     :head, :patch, :options].each do |method|
-      stub_request(method, 'http://localhost/').to_return(:body => '[]')
-      RC::Simple.new.send(method, 'http://localhost/').should.eq '[]'
+    url = 'http://localhost/'
+    [:get, :post, :delete, :put, :patch, :options].each do |method|
+      stub_request(method, url).to_return(:body => '[]')
+      RC::Simple.new.send(method, url).should.eq '[]'
     end
+
+    stub_request(:head, url).to_return(:headers => {'A' => 'B'})
+    RC::Simple.new.head(url).should.eq({'A' => 'B'})
   end
 
   should 'call the callback' do
-    [:get, :post, :delete, :put,
-     :head, :patch, :options].each do |method|
-      stub_request(method, 'http://localhost/').to_return(:body => '123')
-      (client = RC::Simple.new).send(method, 'http://localhost/'){ |res|
+    url = 'http://localhost/'
+    [:get, :post, :delete, :put, :patch, :options].each do |method|
+      stub_request(method, url).to_return(:body => '123')
+      (client = RC::Simple.new).send(method, url){ |res|
         res.should.eq '123' }.should.eq client
     end
+
+    stub_request(:head, url).to_return(:headers => {'A' => 'B'})
+    (client = RC::Simple.new).head(url){ |res|
+      res.should.eq({'A' => 'B'})
+    }.should.eq client
   end
 
   should 'have correct to_i' do
@@ -31,8 +39,7 @@ describe RC::Simple do
 
   should 'use defaults' do
     client = RestCore::Builder.client do
-      s = self.class # this is only for ruby 1.8!
-      use s::Timeout, 4
+      use RC::Timeout, 4
     end
     c = client.new
     c.timeout.should.eq 4 # default goes to middleware

data/test/test_client_oauth1.rb

@@ -8,8 +8,7 @@ describe RC::ClientOauth1 do
   end
 
   client = RC::Builder.client do
-    s = self.class # this is only for ruby 1.8!
-    use s::Oauth1Header
+    use RC::Oauth1Header
   end
 
   client.send(:include, RC::ClientOauth1)

data/test/test_error_detector.rb

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

data/test/test_error_detector_http.rb

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

data/test/test_oauth1_header.rb

@@ -83,5 +83,11 @@ describe RestCore::Oauth1Header do
       @env.merge!(RC::REQUEST_PAYLOAD => {'pay' => 'load'})
       check
     end
+
+    should 'not escape ~' do
+      @base_string << '%26tilde%3D~'
+      @env.merge!(RC::REQUEST_PAYLOAD => {'tilde' => '~'})
+      check
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-core
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client