rest-more

by Lin Jen-Shin (godfat)

Lin Jen-Shin (godfat) had given a talk about rest-core on RubyConf Taiwan 2011. The slide is in English, but the talk is in Mandarin.

DESCRIPTION:

Various REST clients such as Facebook and Twitter built with rest-core.

FEATURES:

Out-of-box REST clients built with rest-core for:

RC::Dropbox (via OAuth 1.0a)
RC::Facebook (via OAuth 2, most completed)
RC::Github (via OAuth 2)
RC::Instagram (via OAuth 2)
RC::Linkedin (via OAuth 1.0a)
RC::StackExchange (via OAuth 2)
RC::Twitter (via OAuth 1.0a)

Rails utilities are also included for some clients.

Other clients in other gems:

Firebase: rest-firebase
TopCoder: topcoder
YahooBuy: rest-more-yahoo_buy

REQUIREMENTS:

Mandatory:

Tested with MRI (official CRuby), Rubinius and JRuby.
gem rest-core
gem httpclient
gem mime-types
gem timers

Optional:

gem json or yajl-ruby, or multi_json (if JsonResponse or JsonRequest middlewares are used)

INSTALLATION:

gem install rest-more

Or if you want development version, put this in Gemfile:

gem 'rest-more', :git => 'git://github.com/godfat/rest-more.git',
                 :submodules => true

SYNOPSIS:

Dropbox example:

Check out their API documentation for a complete reference, and RC::Dropbox for built-in APIs.

require 'rest-more'

d = RC::Dropbox.new :root => 'sandbox',
                    :consumer_key => 'key',
                    :consumer_secret => 'secret',
                    :log_method => method(:puts)

# Redirect the user to:
d.authorize_url!

# After the user authorized, then we can do this to obtain the access token:
d.authorize!

# Then we could call the API:
p [d.me, d.ls]

Facebook example:

Check out their Graph API documentation for a complete reference, and RC::Facebook for built-in APIs. RC::Facebook::RailsUtil for Facebook is also available.

require 'rest-more'

f = RC::Facebook.new :app_id => '123',
                     :secret => 'secret',
                     :access_token => 'if you have the token',
                     :log_method => method(:puts)

redirect_uri = 'http://example.com'
scope = 'public_profile,email'

# Redirect the user to:
f.authorize_url(:redirect_uri => redirect_uri, :scope => scope)

# After the user authorized, then we can do this to obtain the access token:
f.authorize!(:redirect_uri => redirect_uri, :code => 'code')

# Then we could call the API:
p [f.me, f.get('me/posts')]

Github example:

Check out their API documentation for a complete reference, and RC::Github for built-in APIs.

require 'rest-more'

g = RC::Github.new :access_token => 'if you have the token',
                   :log_method => method(:puts)

p [g.me, g.get('users/godfat')]
p g.all('users/godfat/repos').size # get all repositories across all pages

Instagram example:

Check out their Developer documentation for a complete reference, and RC::Instagram for built-in APIs.

require 'rest-more'

i = RC::Instagram.new :client_id => 'id',
                      :client_secret => 'secret',
                      :log_method => method(:puts)

redirect_uri = 'http://example.com'

# Redirect the user to:
i.authorize_url(:redirect_uri => redirect_uri)

# After the user authorized, then we can do this to obtain the access token:
i.authorize!(:redirect_uri => redirect_uri, :code => 'code')

# Then we could call the API:
p i.me

Linkedin example:

Check out their API documentation for a complete reference, and RC::Linkedin for built-in APIs.

require 'rest-more'

l = RC::Linkedin.new :consumer_key => 'key',
                     :consumer_secret => 'secret',
                     :log_method => method(:puts)

# Redirect the user to:
l.authorize_url!

# After the user authorized, then we can do this to obtain the access token:
l.authorize!(:oauth_verifier => 'oauth_verifier')

# Then we could call the API:
p l.me

Twitter example:

Check out their REST API documentation for a complete reference, and RC::Twitter for built-in APIs.

require 'rest-more'

t = RC::Twitter.new :consumer_key => 'key',
                    :consumer_secret => 'secret',
                    :log_method => method(:puts)

# Redirect the user to:
t.authorize_url!

# After the user authorized, then we can do this to obtain the access token:
t.authorize!(:oauth_token => 'oauth_token',
             :oauth_verifier => 'oauth_verifier')

# Then we could call the API:
p [t.me, t.statuses('godfat')]
p t.tweet('Aloha!', File.open('screen.png')) # Image is optional

Example codes:

Runnable example is at: example/simple.rb. Please see slides from rubyconf.tw/2011 for concepts.

Concurrent HTTP Requests:

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:

require 'rest-more'
facebook = RC::Facebook.new(:log_method => method(:puts))
puts "httpclient 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"

If you prefer callback based solution, this would also work:

require 'rest-more'
facebook = RC::Facebook.new(:log_method => method(:puts))
puts "callback also works"
facebook.get('6') do |r|
  p r['name']
end
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 at: example/multi.rb. For a detailed demonstration, see: Advanced Concurrent HTTP Requests -- Embrace the Future

Rails Utilities

To be added. But you can take a look at Facebook tutorial first.

A simple interactive shell with rib:

You need to install rib in order to try this interactive shell:

gem install rib

Then you can try this by running rib rest-core:

rest-core>> self.site = 'https://api.github.com/users/'
rest-core>> self.json_response = true
rest-core>> get 'godfat'

Which is using RestCore::Universal for accessing arbitrary websites.

rest-more users:

Powered sites:

CHANGES:

CHANGES

CONTRIBUTORS:

ayaya (@ayamomiji)
Fumin (@fumin)
khoa nguyen (@khoan)
Lin Jen-Shin (@godfat)
Yun-Yan Chi (@jaiyalas)

LICENSE:

Apache License 2.0

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.