rest-more 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: f6c1734aa90af4216bde1eb8b94091ccdc5fae97
-  data.tar.gz: 40483e18c8ae3c9c638335732066b5f4318836a7
-!binary "U0hBNTEy":
-  metadata.gz: bb36d1c9cc01564aa5225f81593ef18395689b72de1aec9c95f797c5df77cf1bade26e4455cfb0d232efedc90c8238b6df96c330c28107bcef22f5805660aeb3
-  data.tar.gz: e96d8a2ec4501e0d56b3a6f9bd125a7c46ae5bd6aa40e7cb5c894b7b5b363d2c454d2214666b84f2b86fd0a00d193c77da1f886f31c8fa4ba77c732ae3d4e488
+SHA1:
+  metadata.gz: 114edfb70e3422213e0ce427a3485d50286fc3ef
+  data.tar.gz: 696bac783f1f2d55260ace0410bd1df717ca5ea5
+SHA512:
+  metadata.gz: a5209ab15d420ef791699570c7c27ddb156ce6f989d81d523f52ce452e40f4c1abadfff844ef5e35eef91e48a68aeb869a23f2bcc52323bb5fe8f53c6869fecc
+  data.tar.gz: 319216fafc3c9fc4205d9edcc70a4a31f0f6776b6a67cfdd79d9b845a3953eedc13f1657d9853e60d498027ee8d3caf6b9670571f30314e310828451e1cd7a58

data/.gitignore

@@ -1,3 +1,2 @@
-pkg
-*.rbc
+/pkg/
 Gemfile.lock

data/.gitmodules

@@ -3,4 +3,4 @@
 	url = git://github.com/godfat/gemgem.git
 [submodule "rest-core"]
 	path = rest-core
-	url = git://github.com/cardinalblue/rest-core.git
+	url = git://github.com/godfat/rest-core.git

data/.travis.yml

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

data/CHANGES.md

@@ -188,4 +188,4 @@ of being raised.
   error. From now on it would simply ignore it and wipe out the data.
 * [`Flurry`] Some minor updates.
 
-[rest-core]: https://github.com/cardinalblue/rest-core
+[rest-core]: https://github.com/godfat/rest-core

data/Gemfile

@@ -1,5 +1,5 @@
 
-source 'http://rubygems.org'
+source 'https://rubygems.org/'
 
 gemspec
 
@@ -7,12 +7,9 @@ gemspec
 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 'rake'
 gem 'bacon'
-gem 'rr'
+gem 'muack'
 gem 'webmock'
 
 gem 'json'
@@ -20,15 +17,24 @@ gem 'json_pure'
 gem 'multi_json'
 
 gem 'rack'
-gem 'ruby-hmac'
 
-platforms(:ruby) do
+platforms :ruby do
   gem 'yajl-ruby'
-  gem 'psych' if ENV['RESTMORE'] == 'rails3' # why?
 end
 
-platforms(:jruby) do
+platforms :rbx do
+  gem 'rubysl-weakref'    # used in rest-core
+  gem 'rubysl-singleton'  # used in rake
+  gem 'rubysl-rexml'      # used in crack used in webmock
+  gem 'rubysl-bigdecimal' # used in crack used in webmock
+  gem 'rubysl-test-unit'  # used in activesupport
+  gem 'rubysl-enumerator' # used in activesupport
+  gem 'rubysl-benchmark'  # used in activesupport
+  gem 'racc'              # used in journey used in actionpack
+end
+
+platforms :jruby do
   gem 'jruby-openssl'
 end
 
-gem 'rails', '3.2.11' if ENV['RESTMORE'] == 'rails3'
+gem 'rails', '3.2.16' if ENV['RESTMORE'] == 'rails3'

data/README.md

@@ -1,6 +1,6 @@
 # rest-more [![Build Status](https://secure.travis-ci.org/godfat/rest-more.png?branch=master)](http://travis-ci.org/godfat/rest-more)
 
-by Cardinal Blue <http://cardinalblue.com>
+by Lin Jen-Shin ([godfat](http://godfat.org))
 
 Lin Jen-Shin ([godfat][]) had given a talk about rest-core on
 [RubyConf Taiwan 2011][talk]. The slide is in English, but the
@@ -11,45 +11,58 @@ talk is in Mandarin.
 
 ## LINKS:
 
-* [github](https://github.com/cardinalblue/rest-more)
+* [github](https://github.com/godfat/rest-more)
 * [rubygems](https://rubygems.org/gems/rest-more)
-* [rdoc](http://rdoc.info/projects/cardinalblue/rest-more)
+* [rdoc](http://rdoc.info/projects/godfat/rest-more)
 * [mailing list](http://groups.google.com/group/rest-core/topics)
 
 ## DESCRIPTION:
 
-Various REST clients such as Facebook and Twitter built with [rest-core][]
+Various REST clients such as Facebook and Twitter built with [rest-core][].
 
-[rest-core]: https://github.com/cardinalblue/rest-core
+[rest-core]: https://github.com/godfat/rest-core
 
 ## FEATURES:
 
 Out-of-box REST clients built with rest-core for:
 
-* Dropbox
-* Facebook
-* Github
-* Linkedin
-* Twitter
+* [RC::Dropbox][]
+* [RC::Facebook][] (most completed)
+* [RC::Firebase][]
+* [RC::Github][]
+* [RC::Instagram][]
+* [RC::Linkedin][]
+* [RC::Twitter][]
 
-Rails utilities are also included.
+[RC::Dropbox]: lib/rest-core/client/dropbox.rb
+[RC::Facebook]: lib/rest-core/client/facebook.rb
+[RC::Firebase]: lib/rest-core/client/firebase.rb
+[RC::Github]: lib/rest-core/client/github.rb
+[RC::Instagram]: lib/rest-core/client/instagram.rb
+[RC::Linkedin]: lib/rest-core/client/linkedin.rb
+[RC::Twitter]: lib/rest-core/client/twitter.rb
+
+Rails utilities are also included for some clients.
 
 ## REQUIREMENTS:
 
 ### Mandatory:
 
-* MRI (official CRuby) 1.9.3, Rubinius 1.9 and JRuby 1.9
-* gem rest-core
-* gem rest-client
+* Tested with MRI (official CRuby), Rubinius and JRuby.
+* gem [rest-core][]
+* gem [httpclient][]
+* gem [mime-types][]
+* gem [timers][]
+
+[httpclient]: https://github.com/nahi/httpclient
+[mime-types]: https://github.com/halostatue/mime-types
+[timers]: https://github.com/celluloid/timers
 
 ### Optional:
 
-* gem [em-http-request][] (if using eventmachine)
 * 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
-
 ## INSTALLATION:
 
 ``` shell
@@ -59,45 +72,203 @@ 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',
+gem 'rest-more', :git => 'git://github.com/godfat/rest-more.git',
                  :submodules => true
 ```
 
 ## SYNOPSIS:
 
-The simplest usage:
+### Dropbox example:
+
+Check out their
+[API documentation](https://www.dropbox.com/developers/reference/api)
+for a complete reference, and [RC::Dropbox][] for built-in APIs.
+
+``` ruby
+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](https://developers.facebook.com/docs/graph-api/reference/v2.0/)
+for a complete reference, and [RC::Facebook][] for built-in APIs.
+[RC::Facebook::RailsUtil][] for Facebook is also available.
+
+[RC::Facebook::RailsUtil]: lib/rest-core/client/facebook/rails_util.rb
+
+``` ruby
+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')]
+```
+
+### Firebase example:
+
+Check out their
+[REST API documentation](https://www.firebase.com/docs/rest-api.html)
+for a complete reference, and [RC::Firebase][] for built-in APIs.
 
 ``` ruby
 require 'rest-more'
 
-RC::Twitter.new.statuses('_cardinalblue') # get user tweets
-RC::Github.new.get('users/cardinalblue')  # get user info
+f = RC::Firebase.new :site => 'https://example.firebaseio.com/',
+                     :secret => 'secret',
+                     :d => {:auth_data => 'something'},
+                     :log_method => method(:puts)
+
+# Listen on test.json
+es = f.event_source('test')
+es.onopen{ |sock| p sock }
+es.onmessage{ |event| p event }
+es.onerror{ |error| p error }
+es.start
+
+# Update test.json
+p f.put('test', :some => 'data')
+p f.post('test', :some => 'other')
+p f.get('test')
+p f.delete('test')
+
+# Stop listening on test.json
+es.close
+```
+
+### Github example:
+
+Check out their
+[API documentation](https://developer.github.com/v3/)
+for a complete reference, and [RC::Github][] for built-in APIs.
+
+``` ruby
+require 'rest-more'
 
-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
+g = RC::Github.new :access_token => 'if you have the token',
+                   :log_method => method(:puts)
 
-RC::Facebook.new.get('4') # get user info
+p [g.me, g.get('users/godfat')]
 ```
 
+### Instagram example:
+
+Check out their
+[Developer documentation](http://instagram.com/developer/)
+for a complete reference, and [RC::Instagram][] for built-in APIs.
+
+``` ruby
+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](http://developer.linkedin.com/documents/linkedin-api-resource-map)
+for a complete reference, and [RC::Linkedin][] for built-in APIs.
+
+``` ruby
+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](https://dev.twitter.com/docs/api/1.1)
+for a complete reference, and [RC::Twitter][] for built-in APIs.
+
+``` ruby
+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][rubyconf.tw] for concepts.
 
-[example/simple.rb]: https://github.com/cardinalblue/rest-more/blob/master/example/simple.rb
+[example/simple.rb]: https://github.com/godfat/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
 
 ## Concurrent HTTP Requests:
 
-Inherited from rest-core, you can do concurrent requests quite easily.
+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'
 facebook = RC::Facebook.new(:log_method => method(:puts))
-puts "rest-client with threads doing concurrent requests"
+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
@@ -110,9 +281,9 @@ 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'){ |r|
+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"
@@ -121,20 +292,14 @@ puts "DONE"
 Runnable example is at: [example/multi.rb][]. For a detailed demonstration,
 see: [Advanced Concurrent HTTP Requests -- Embrace the Future][future]
 
-[example/multi.rb]: https://github.com/cardinalblue/rest-more/blob/master/example/multi.rb
-[future]: https://github.com/cardinalblue/rest-core#advanced-concurrent-http-requests----embrace-the-future
+[example/multi.rb]: https://github.com/godfat/rest-more/blob/master/example/multi.rb
+[future]: https://github.com/godfat/rest-core#advanced-concurrent-http-requests----embrace-the-future
 
 ## Rails Utilities
 
 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 [Rainbows configuration][] first.
-
-[Rainbows configuration]: https://github.com/cardinalblue/rest-more/blob/master/example/rainbows.rb
+[Facebook tutorial]: doc/facebook.md
 
 ## A simple interactive shell with [rib][]:
 
@@ -146,7 +311,7 @@ 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 'cardinalblue'
+    rest-core>> get 'godfat'
 
 Which is using `RestCore::Universal` for accessing arbitrary websites.
 
@@ -163,7 +328,7 @@ Which is using `RestCore::Universal` for accessing arbitrary websites.
 
 ## CHANGES:
 
-* [CHANGES](https://github.com/cardinalblue/rest-more/blob/master/CHANGES.md)
+* [CHANGES](CHANGES.md)
 
 ## CONTRIBUTORS:
 
@@ -177,7 +342,7 @@ Which is using `RestCore::Universal` for accessing arbitrary websites.
 
 Apache License 2.0
 
-Copyright (c) 2011-2012, Cardinal Blue
+Copyright (c) 2011-2014, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.