rest-more 1.0.2 → 2.0.0

data/.gitignore

@@ -1,7 +1,2 @@
 pkg
-rdoc
 *.rbc
-.bundle
-.yardoc
-Gemfile.lock
-task

data/.travis.yml

@@ -2,12 +2,10 @@ before_install: 'git submodule update --init'
 script: 'ruby -r bundler/setup -S rake test:travis'
 
 env:
-  - 'RESTMORE=rest-more'
-  - 'RESTMORE=rails2'
-  - 'RESTMORE=rails3'
+  - 'RESTMORE=rest-more RBXOPT=-X19'
+  - 'RESTMORE=rails3 RBXOPT=-X19'
 
 rvm:
-  - 1.9.2
   - 1.9.3
-  - rbx-19mode
-  - jruby-19mode
+  - rbx-head
+  - jruby-head

data/CHANGES.md

@@ -1,5 +1,21 @@
 # CHANGES
 
+## rest-more 2.0.0 -- 2012-10-31
+
+* Adopted to rest-core 2.0.0, a whole new generation.
+* We no longer test against Ruby 1.9.2- and Rails 2-
+
+### Incompatible changes
+
+* Bing (no longer useable) and Mixi (anyone?) clients are removed.
+* Option for `:json_decode` is renamed to `:json_response` in rest-core.
+
+### Enhancement
+
+* [Facebook::RailsUtil] Now we cache `@rc_facebook_normalized_request_uri`
+  to avoid paring broken URI from Facebook. Facebook is returning some
+  URI which are not properly escaped.
+
 ## rest-more 1.0.2 -- 2012-07-13
 
 * [Facebook::RailsUtil] Change the redirect log level from WARN to INFO.

data/Gemfile

@@ -1,12 +1,14 @@
 
 source 'http://rubygems.org'
 
+gemspec
+
 # this is for travis-ci
 gem 'rest-core', :path => 'rest-core' if
   File.exist?("#{File.dirname(File.expand_path(__FILE__))}/rest-core/Gemfile")
+
 gem 'rest-client'
 gem 'em-http-request'
-gem 'rest-more', :path => '.'
 
 gem 'rake'
 gem 'bacon'
@@ -15,17 +17,18 @@ gem 'webmock'
 
 gem 'json'
 gem 'json_pure'
+gem 'multi_json'
 
 gem 'rack'
 gem 'ruby-hmac'
 
 platforms(:ruby) do
   gem 'yajl-ruby'
+  gem 'psych' if ENV['RESTMORE'] == 'rails3' # why?
 end
 
 platforms(:jruby) do
   gem 'jruby-openssl'
 end
 
-gem 'rails', '2.3.14' if ENV['RESTMORE'] == 'rails2'
-gem 'rails', '3.2.1'  if ENV['RESTMORE'] == 'rails3'
+gem 'rails', '3.2.8' if ENV['RESTMORE'] == 'rails3'

data/README.md

@@ -6,8 +6,6 @@ Lin Jen-Shin ([godfat][]) had given a talk about rest-core on
 [RubyConf Taiwan 2011][talk]. The slide is in English, but the
 talk is in Mandarin.
 
-You can also read some other topics at [doc](https://github.com/cardinalblue/rest-core/blob/master/doc/ToC.md).
-
 [godfat]: https://github.com/godfat
 [talk]: http://rubyconf.tw/2011/#6
 
@@ -28,12 +26,10 @@ Various REST clients such as Facebook and Twitter built with [rest-core][]
 
 Out-of-box REST clients built with rest-core for:
 
-* Bing
 * Dropbox
 * Facebook
 * Github
 * Linkedin
-* Mixi
 * Twitter
 
 Rails utilities are also included.
@@ -42,30 +38,29 @@ Rails utilities are also included.
 
 ### Mandatory:
 
-* MRI (official CRuby) 1.8.7, 1.9.2, 1.9.3, Rubinius 1.8/1.9 and JRuby 1.8/1.9
+* MRI (official CRuby) 1.9.3, Rubinius 1.9 and JRuby 1.9
+* gem rest-core
 * gem rest-client
 
 ### Optional:
 
-* Fibers only work on Ruby 1.9+
 * gem [em-http-request][] (if using eventmachine)
-* gem [cool.io-http][] (if using cool.io)
-* gem json or yajl-ruby (if using `JsonDecode` middleware)
+* gem json or yajl-ruby, or multi_json (if `JsonResponse` or
+  `JsonRequest` middlewares are used)
 
 [em-http-request]: https://github.com/igrigorik/em-http-request
-[cool.io-http]: https://github.com/godfat/cool.io-http
 
 ## INSTALLATION:
 
 ``` shell
-    gem install rest-more
+gem install rest-more
 ```
 
 Or if you want development version, put this in Gemfile:
 
 ``` ruby
-    gem 'rest-more', :git => 'git://github.com/cardinalblue/rest-more.git',
-                     :submodules => true
+gem 'rest-more', :git => 'git://github.com/cardinalblue/rest-more.git',
+                 :submodules => true
 ```
 
 ## SYNOPSIS:
@@ -73,152 +68,71 @@ Or if you want development version, put this in Gemfile:
 The simplest usage:
 
 ``` ruby
-    require 'rest-more'
+require 'rest-more'
 
-    RestCore::Twitter.new.statuses('_cardinalblue') # get user tweets
-    RestCore::Github.new.get('users/cardinalblue')  # get user info
+RC::Twitter.new.statuses('_cardinalblue') # get user tweets
+RC::Github.new.get('users/cardinalblue')  # get user info
 
-    linkedin = RestCore::Linkedin.new(:consumer_key    => '...',
-                                      :consumer_secret => '...')
-    linkedin.authorize_url!   # copy and paste the URL in browser to authorize
-    linkedin.authorize!('..') # paste your code from browser
-    linkedin.me               # get current user info
+linkedin = RC::Linkedin.new(:consumer_key    => '...',
+                            :consumer_secret => '...')
+linkedin.authorize_url!   # copy and paste the URL in browser to authorize
+linkedin.authorize!('..') # paste your code from browser
+linkedin.me               # get current user info
 
-    RestCore::Facebook.new.get('4') # get user info
+RC::Facebook.new.get('4') # get user info
 ```
 
-Runnable example is here: [example/simple.rb][]. Please see [slides][] from
+Runnable example is at: [example/simple.rb][]. Please see [slides][] from
 [rubyconf.tw/2011][rubyconf.tw] for concepts.
 
 [example/simple.rb]: https://github.com/cardinalblue/rest-more/blob/master/example/simple.rb
 [slides]: http://www.godfat.org/slide/2011-08-27-rest-core.html
 [rubyconf.tw]: http://rubyconf.tw/2011/#6
 
-## Asynchronous HTTP Requests:
-
-I/O bound operations shouldn't be blocking the CPU! If you have a reactor,
-i.e. event loop, you should take the advantage of that to make HTTP requests
-not block the whole process/thread. For now, we support eventmachine and
-cool.io. By default, all clients are using `RestClient`, which is a
-synchronous HTTP client, thus blocking. It's very easy to use, but not
-very scalable (not concurrent-efficient). You can change the default app
-(i.e. HTTP clients) to an asynchronous one:
-
-``` ruby
-    require 'rest-more'
-    RestCore::Builder.default_app = RestCore::EmHttpRequest
-```
-
-or an auto-picking one, which would try to infer the correct HTTP client
-depending on the context. Either em-http-request, cool.io-http, or even
-rest-client if none of reactors is available.
-
-``` ruby
-    require 'rest-more'
-    RestCore::Builder.default_app = RestCore::Auto
-```
-
-You can also setup the `default_app` for a specific client, so that it won't
-change all the `default_app` for all the clients, like this:
+## Concurrent HTTP Requests:
 
-``` ruby
-    require 'rest-more'
-    RestCore::Facebook.builder.default_app = RestCore::Auto
-```
-
-If you're passing a block, the block is called after the response is
-available. That is the block is the callback for the request.
-
-``` ruby
-    require 'rest-more'
-    require 'eventmachine'
-    RestCore::Builder.default_app = RestCore::EmHttpRequest
-    EM.run{
-      RestCore::Facebook.new.get('4'){ |response|
-        p response
-        EM.stop
-      }
-      puts "It's not blocking..."
-    }
-```
-
-Otherwise, if you don't pass a block as the callback, EmHttpRequest (i.e.
-the HTTP client for eventmachine) would call `Fiber.yield` to yield to the
-original fiber, making asynchronous HTTP requests look like synchronous.
-If you don't understand what does this mean, you can take a look at
-[em-synchrony][]. It's basically the same idea.
+Inherited from rest-core, you can do concurrent requests quite easily.
+Here's a very quick example of getting Facebook users' names for UID 4 and 5:
 
 ``` ruby
-    require 'rest-more'
-    require 'eventmachine'
-
-    RestCore::Builder.default_app = RestCore::EmHttpRequest
-
-    EM.run{
-      Fiber.new{
-        p RestCore::Facebook.new.get('4')
-        EM.stop
-      }.resume
-      puts "It's not blocking..."
-    }
+require 'rest-more'
+facebook = RC::Facebook.new(:log_method => method(:puts))
+puts "rest-client with threads doing concurrent requests"
+a = [facebook.get('4'), facebook.get('5')]
+puts "It's not blocking... but doing concurrent requests underneath"
+p a.map{ |r| r['name'] } # here we want the values, so it blocks here
+puts "DONE"
 ```
 
-[em-synchrony]: https://github.com/igrigorik/em-synchrony
-
-Runnable example is here: [example/facebook.rb][].
-You can also make multi-requests synchronously like this:
+If you prefer callback based solution, this would also work:
 
 ``` ruby
-    require 'rest-more'
-    require 'eventmachine'
-
-    RestCore::Builder.default_app = RestCore::Auto
-    facebook = RestCore::Facebook.new(:log_method => method(:puts))
-
-    EM.run{
-      Fiber.new{
-        fiber = Fiber.current
-        result = {}
-        facebook.get('4'){ |response|
-          result[0] = response
-          fiber.resume(result) if result.size == 2
-        }
-        puts "It's not blocking..."
-        facebook.get('4'){ |response|
-          result[1] = response
-          fiber.resume(result) if result.size == 2
-        }
-        p Fiber.yield
-        EM.stop
-      }.resume
-      puts "It's not blocking..."
-    }
+require 'rest-more'
+facebook = RC::Facebook.new(:log_method => method(:puts))
+puts "callback also works"
+facebook.get('6'){ |r|
+  p r['name']
+}
+puts "It's not blocking... but doing concurrent requests underneath"
+facebook.wait # we block here to wait for the request done
+puts "DONE"
 ```
 
-Runnable example is here: [example/multi.rb][]. All `RestCore::EmHttpRequest`
-above is interchangeable with `RestCore::Auto` because `RestCore::Auto` would
-pick the right HTTP client when running inside the eventmachine's event loop.
+Runnable example is at: [example/multi.rb][]. For a detailed demonstration,
+see: [Advanced Concurrent HTTP Requests -- Embrace the Future][future]
 
-[example/facebook.rb]: https://github.com/cardinalblue/rest-more/blob/master/example/facebook.rb
 [example/multi.rb]: https://github.com/cardinalblue/rest-more/blob/master/example/multi.rb
-
-## Supported HTTP clients:
-
-* `RestCore::RestClient` (gem rest-client)
-* `RestCore::EmHttpRequest` (gem em-http-request)
-* `RestCore::Coolio` (gem cool.io)
-* `RestCore::Auto` (which would pick one of the above depending on the
-  context)
+[future]: https://github.com/cardinalblue/rest-core#advanced-concurrent-http-requests----embrace-the-future
 
 ## Rails Utilities
 
-To be added. But you can take a look at the [Facebook tutorial][] first.
+To be added. But you can take a look at [Facebook tutorial][] first.
 
 [Facebook tutorial]: https://github.com/cardinalblue/rest-more/blob/master/doc/tutorial/facebook.md
 
 ## EventMachine inside Rainbows!
 
-To be added. But you can take a look at the [Rainbows configuration][] first.
+To be added. But you can take a look at [Rainbows configuration][] first.
 
 [Rainbows configuration]: https://github.com/cardinalblue/rest-more/blob/master/example/rainbows.rb
 
@@ -231,7 +145,7 @@ You need to install [rib][] in order to try this interactive shell:
 Then you can try this by running `rib rest-core`:
 
     rest-core>> self.site = 'https://api.github.com/users/'
-    rest-core>> self.json_decode = true
+    rest-core>> self.json_response = true
     rest-core>> get 'cardinalblue'
 
 Which is using `RestCore::Universal` for accessing arbitrary websites.

data/Rakefile

@@ -19,7 +19,7 @@ task 'gem:spec' do
     s.version  = RestMore::VERSION
     s.homepage = 'https://github.com/cardinalblue/rest-more'
 
-    %w[rest-core].each{ |g| s.add_runtime_dependency(g, '>=1.0.0') }
+    %w[rest-core].each{ |g| s.add_runtime_dependency(g, '>=2.0.0') }
 
     s.authors  = ['Cardinal Blue', 'Lin Jen-Shin (godfat)']
     s.email    = ['dev (XD) cardinalblue.com']
@@ -50,7 +50,7 @@ end
 
 desc 'Run example tests'
 task 'test:example' do
-  Gemgem.test_rails('rails3', 'rails2')
+  Gemgem.test_rails('rails3')
 end
 
 desc 'Run all tests'
@@ -66,7 +66,6 @@ end
 task 'test:travis' do
   case ENV['RESTMORE']
   when 'rails3'; Gemgem.test_rails('rails3')
-  when 'rails2'; Gemgem.test_rails('rails2')
   else         ; Rake::Task['test'].invoke
   end
 end

data/example/multi.rb

@@ -1,28 +1,17 @@
 
 require 'rest-more'
-require 'eventmachine'
-RestCore::EmHttpRequest # there might be a autoload bug?
-                        # omitting this line would cause
-                        # stack level too deep (SystemStackError)
 
-RestCore::Builder.default_app = RestCore::Auto
-facebook = RestCore::Facebook.new(:log_method => method(:puts))
+facebook = RC::Facebook.new(:log_method => method(:puts))
+puts "rest-client with threads doing concurrent requests"
+a = [facebook.get('4'), facebook.get('5')]
+puts "It's not blocking... but doing concurrent requests underneath"
+p a.map{ |r| r['name'] } # here we want the values, so it blocks here
+puts "DONE"
 
-EM.run{
-  Fiber.new{
-    fiber = Fiber.current
-    result = {}
-    facebook.get('4'){ |response|
-      result[0] = response
-      fiber.resume(result) if result.size == 2
-    }
-    puts "It's not blocking..."
-    facebook.get('4'){ |response|
-      result[1] = response
-      fiber.resume(result) if result.size == 2
-    }
-    p Fiber.yield
-    EM.stop
-  }.resume
-  puts "It's not blocking..."
+puts "callback also works"
+facebook.get('6'){ |r|
+  p r['name']
 }
+puts "It's not blocking... but doing concurrent requests underneath"
+facebook.wait # we block here to wait for the request done
+puts "DONE"

data/example/rails3/Gemfile

@@ -1,7 +1,7 @@
 
 source 'http://rubygems.org'
 
-gem 'rails', '3.2.6'
+gem 'rails', '3.2.8'
 
 gem 'rest-client' # for rest-core
 gem 'rest-core', :path => '../../rest-core'
@@ -14,6 +14,7 @@ end
 
 platforms(:ruby) do
   gem 'yajl-ruby'
+  gem 'psych' # why?
 end
 
 platforms(:jruby) do

data/example/rails3/app/controllers/application_controller.rb

@@ -28,7 +28,7 @@ class ApplicationController < ActionController::Base
   alias_method :cookies_     , :index
 
   def no_auto
-    rc_facebook.get('me')
+    rc_facebook.get('me').tap{}
   rescue RestCore::Facebook::Error
     render :text => 'XD'
   end
@@ -39,9 +39,14 @@ class ApplicationController < ActionController::Base
 
   def cache
     url = rc_facebook.url('cache')
-    rc_facebook.get('cache')
-    rc_facebook.get('cache')
-    render :text => Rails.cache.read(Digest::MD5.hexdigest(url))
+    rc_facebook.get('cache').tap{}
+    rc_facebook.get('cache').tap{}
+    key = RC::Cache.new(nil, nil, nil).cache_key(
+      rc_facebook.dry.call(
+        RC::REQUEST_METHOD => :get,
+        RC::REQUEST_PATH   => rc_facebook.url('cache'),
+        &RC::Middleware.id))
+    render :text => Rails.cache.read(key)
   end
 
   def error