rest-more 0.7.2.1 → 0.8.0

data/CHANGES.md

@@ -1,5 +1,70 @@
 # CHANGES
 
+## rest-more 0.8.0 -- 2011-11-29
+
+### Incompatible changes
+
+* [Facebook::RailsUtil] Some methods are renamed. For example,
+  `rc_facebook_write_rg_fbs` is renamed to `rc_facebook_write_fbs`.
+  All renamed methods are considered private, so we're not listing them here.
+
+* [Facebook::RailsUtil] `rc_facebook_storage_key` is changed to:
+  `"rc_facebook_#{rc_facebook.app_id}"`, your users might need to
+  login again in order to save the access_token into the new place.
+
+### Bugs fixes
+
+* [Github] Fixed usage of Oauth2Query.
+
+* [Facebook] Now we're using POST in `authorize!` to exchange the
+  access_token with the code instead of GET. If we're using GET,
+  we would run into a risk where a user might use the code to
+  get other people's access_token via the cache. Using POST would
+  prevent this because POSTs are not cached.
+
+* [Facebook::RailsUtil] Fixed a serious bug. The bug would jump up if
+  you're using :write_session or :write_cookies or :write_handler along
+  with :auto_authorize, for example:
+  `rc_facebook_setup(:auto_authorize => true, :write_session => true)`
+  The problem is that Facebook::RailsUtil is not removing the invalid
+  access_token stored in session or cookie, and yet it is considered
+  authorized, making redirecting to Facebook and redirecting back doesn't
+  update the access_token. `rc_facebook_cleanup` is introduced to remove
+  all invalid access_tokens, which would get called once the user is
+  redirected to Facebook, fixing this bug.
+
+### Enhancement
+
+* [Facebook] Now we use `default_data` to get the default data,
+  instead of relying `Defaults` middleware.
+
+* [Facebook] Protected methods are changed to private.
+
+* [Flurry] `app_info` now accepts opts.
+* [Flurry] `event_metrics` is renamed to `event_summary`
+* [Flurry] `event_metrics` is now the API for accessing 'eventMetrics/Event'
+* [Flurry] If you didn't pass dates, now default to for 7 days.
+* [Flurry] Instead of overriding `query`, defining `default_query`
+
+* [Linkedin+Twitter] Removed `Defaults` middleware because now we're using
+  the data from `Oauth1Client` instead.
+
+* [Linkedin+Twitter] Removed `oauth_token`, `oauth_token=`,
+  `oauth_token_secret`, and `oauth_token_secret=` because we're using them
+  from `Oauth1Client` instead.
+
+* [Linkedin+Twitter] Removed `set_token` because it's handled in
+  `Oauth1Client` now.
+
+* [Twitter::RailsUtil] Now `rc_twitter_setup` accepts options like
+  `rc_facebook_setup`: `auto_authorize`, `ensure_authorized`,
+  `write_session`, `write_cookies`, `write_handler`, and `check_handler`.
+
+* [Mixi] Removed `Defaults` middleware in favor of `default_data`.
+
+* [Facebook+Github+Mixi+Twitter] Added a `me` method for accessing current
+  user information.
+
 ## rest-more 0.7.2.1 -- 2011-11-05
 
 ### Bugs fixes

data/README.md

@@ -5,7 +5,7 @@ by Cardinal Blue <http://cardinalblue.com>
 ## LINKS:
 
 * [github](https://github.com/cardinalblue/rest-more)
-* [rubygems](http://rubygems.org/gems/rest-more)
+* [rubygems](https://rubygems.org/gems/rest-more)
 * [rdoc](http://rdoc.info/projects/cardinalblue/rest-more)
 * [mailing list](http://groups.google.com/group/rest-core/topics)
 

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

@@ -125,10 +125,10 @@ class ApplicationController < ActionController::Base
   end
 
   def filter_session
-    rc_facebook_setup(:write_session => true)
+    rc_facebook_setup(:write_session => true, :auto_authorize => true)
   end
 
   def filter_cookies
-    rc_facebook_setup(:write_cookies => true)
+    rc_facebook_setup(:write_cookies => true, :auto_authorize => true)
   end
 end

data/example/rails2/test/functional/application_controller_test.rb

@@ -166,6 +166,32 @@ class ApplicationControllerTest < ActionController::TestCase
     assert_equal '["yeti"]', @response.body
   end
 
+  def test_wrong_session
+    WebMock.reset!
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":{"type":"OAuthException"}}')
+
+    session = @request.session
+    key     = @controller.send(:rc_facebook_storage_key)
+    session[key] = 'bad'
+
+    get(:session_)
+    assert_equal nil, session[key]
+  end
+
+  def test_wrong_cookies
+    WebMock.reset!
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":{"type":"OAuthException"}}')
+
+    cookies = @request.cookies
+    key     = @controller.send(:rc_facebook_storage_key)
+    session[key] = 'bad'
+
+    get(:cookies_)
+    assert_equal nil, cookies[key]
+  end
+
   def test_error
     get(:error)
   rescue => e

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

@@ -125,10 +125,10 @@ class ApplicationController < ActionController::Base
   end
 
   def filter_session
-    rc_facebook_setup(:write_session => true)
+    rc_facebook_setup(:write_session => true, :auto_authorize => true)
   end
 
   def filter_cookies
-    rc_facebook_setup(:write_cookies => true)
+    rc_facebook_setup(:write_cookies => true, :auto_authorize => true)
   end
 end

data/example/rails3/test/functional/application_controller_test.rb

@@ -166,6 +166,32 @@ class ApplicationControllerTest < ActionController::TestCase
     assert_equal '["yeti"]', @response.body
   end
 
+  def test_wrong_session
+    WebMock.reset!
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":{"type":"OAuthException"}}')
+
+    session = @request.session
+    key     = @controller.send(:rc_facebook_storage_key)
+    session[key] = 'bad'
+
+    get(:session_)
+    assert_equal nil, session[key]
+  end
+
+  def test_wrong_cookies
+    WebMock.reset!
+    stub_request(:get, 'https://graph.facebook.com/me').
+      to_return(:body => '{"error":{"type":"OAuthException"}}')
+
+    cookies = @request.cookies
+    key     = @controller.send(:rc_facebook_storage_key)
+    session[key] = 'bad'
+
+    get(:cookies_)
+    assert_equal nil, cookies[key]
+  end
+
   def test_error
     get(:error)
   rescue => e

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

@@ -1,6 +1,7 @@
 
 require 'rest-core'
 
+# http://msdn.microsoft.com/en-us/library/dd250846.aspx
 RestCore::Bing = RestCore::Builder.client(:AppId) do
   s = self.class # this is only for ruby 1.8!
   use s::Timeout       , 10
@@ -22,23 +23,7 @@ RestCore::Bing = RestCore::Builder.client(:AppId) do
   end
 end
 
-module RestCore::Bing::Client
-  def query
-    {'AppId'    => self.AppId,
-     'JsonType' => 'raw'     ,
-     'Version'  => '2.2'     }
-  end
-
-  def search_image term, query={}, opts={}
-    get('', {:Query => term, :Sources => 'Image'}.merge(query), opts)[
-      'SearchResponse']['Image']['Results'] || []
-  end
-
-  def search_image_urls term, query={}, opts={}
-    search_image(term, query, opts).map{ |i| i['MediaUrl'] }
-  end
-end
-
+# http://msdn.microsoft.com/en-us/library/dd251042.aspx
 class RestCore::Bing::Error < RestCore::Error
   include RestCore
   class MissingParameter              < Bing::Error; end
@@ -87,6 +72,23 @@ class RestCore::Bing::Error < RestCore::Error
   end
 end
 
+module RestCore::Bing::Client
+  def query
+    {'AppId'    => self.AppId,
+     'JsonType' => 'raw'     ,
+     'Version'  => '2.2'     }
+  end
+
+  def search_image term, query={}, opts={}
+    get('', {:Query => term, :Sources => 'Image'}.merge(query), opts)[
+      'SearchResponse']['Image']['Results'] || []
+  end
+
+  def search_image_urls term, query={}, opts={}
+    search_image(term, query, opts).map{ |i| i['MediaUrl'] }
+  end
+end
+
 RestCore::Bing.send(:include, RestCore::Bing::Client)
 require 'rest-core/client/bing/rails_util' if
   Object.const_defined?(:Rails)

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

@@ -2,6 +2,8 @@
 require 'rest-core'
 require 'rest-core/util/hmac'
 
+# https://developers.facebook.com/docs/reference/api
+# https://developers.facebook.com/tools/explorer
 RestCore::Facebook = RestCore::Builder.client(
   :data, :app_id, :secret, :old_site) do
 
@@ -26,8 +28,7 @@ RestCore::Facebook = RestCore::Builder.client(
     use s::JsonDecode  , true
   end
 
-  use s::Defaults      , :data     => lambda{{}},
-                         :old_site => 'https://api.facebook.com/'
+  use s::Defaults      , :old_site => 'https://api.facebook.com/'
 end
 
 class RestCore::Facebook::Error < RestCore::Error
@@ -69,6 +70,10 @@ end
 module RestCore::Facebook::Client
   include RestCore
 
+  def me query={}, opts={}
+    get('me', query, opts)
+  end
+
   def access_token
     data['access_token'] || data['oauth_token'] if data.kind_of?(Hash)
   end
@@ -179,9 +184,9 @@ module RestCore::Facebook::Client
   end
 
   def authorize! opts={}
-    query = {:client_id => app_id, :client_secret => secret}.merge(opts)
+    payload = {:client_id => app_id, :client_secret => secret}.merge(opts)
     self.data = ParseQuery.parse_query(
-                  get(url('oauth/access_token'), query,
+                  post('oauth/access_token', payload, {},
                       {:json_decode => false}.merge(opts)))
   end
 
@@ -222,7 +227,11 @@ module RestCore::Facebook::Client
          {}, {}, opts, &cb)
   end
 
-  protected
+  private
+  def default_data
+    {}
+  end
+
   def build_env env={}
     super(env.inject({}){ |r, (k, v)|
       case k.to_s

data/lib/rest-core/client/facebook/rails_util.rb

@@ -44,7 +44,7 @@ module RestCore::Facebook::RailsUtil
     # before, in that case, the fbs would be inside session,
     # as we just saved it there
 
-    rc_facebook_check_rg_fbs # check rc_facebook storage
+    rc_facebook_check_fbs # check rc_facebook storage
 
     if rc_options_get(RestCore::Facebook, :ensure_authorized) &&
        !rc_facebook.authorized?
@@ -65,6 +65,8 @@ module RestCore::Facebook::RailsUtil
     logger.warn("WARN: Facebook: #{error.inspect}")
 
     if force_redirect || rc_facebook_auto_authorize?
+      rc_facebook_cleanup
+
       @rc_facebook_authorize_url = rc_facebook.authorize_url(
         {:redirect_uri => rc_facebook_normalized_request_uri,
          :scope        =>
@@ -72,9 +74,8 @@ module RestCore::Facebook::RailsUtil
         merge(rc_options_get(RestCore::Facebook, :auto_authorize_options)))
 
       logger.debug(
-      "DEBUG: Facebook: redirect to #{@rc_facebook_authorize_url}")
+        "DEBUG: Facebook: redirect to #{@rc_facebook_authorize_url}")
 
-      cookies.delete("fbs_#{rc_facebook.app_id}")
       rc_facebook_authorize_redirect
     end
   end
@@ -132,7 +133,7 @@ module RestCore::Facebook::RailsUtil
                  " parsed: #{rc_facebook.data.inspect}")
 
     if rc_facebook.authorized?
-      rc_facebook_write_rg_fbs
+      rc_facebook_write_fbs
     else
       logger.warn(
         "WARN: Facebook: bad signed_request: #{params[:signed_request]}")
@@ -151,7 +152,7 @@ module RestCore::Facebook::RailsUtil
                  " #{rc_facebook.data.inspect}")
 
     if rc_facebook.authorized?
-      rc_facebook_write_rg_fbs
+      rc_facebook_write_fbs
     else
       logger.warn("WARN: Facebook: bad session: #{params[:session]}")
     end
@@ -182,7 +183,7 @@ module RestCore::Facebook::RailsUtil
       "#{rc_facebook_normalized_request_uri}," \
       " parsed: #{rc_facebook.data.inspect}")
 
-    rc_facebook_write_rg_fbs if rc_facebook.authorized?
+    rc_facebook_write_fbs if rc_facebook.authorized?
   end
   # ==================== end facebook check ======================
 
@@ -190,16 +191,16 @@ module RestCore::Facebook::RailsUtil
 
   # ==================== begin check ================================
   def rc_facebook_storage_key
-    "rc_facebook_fbs_#{rc_options_get(RestCore::Facebook, :app_id)}"
+    "rc_facebook_#{rc_facebook.app_id}"
   end
 
-  def rc_facebook_check_rg_fbs
-    rc_facebook_check_rg_handler # custom method to store fbs
-    rc_facebook_check_rg_session # prefered way to store fbs
-    rc_facebook_check_rg_cookies # in canvas, session might not work..
+  def rc_facebook_check_fbs
+    rc_facebook_check_handler # custom method to store fbs
+    rc_facebook_check_session # prefered way to store fbs
+    rc_facebook_check_cookies # in canvas, session might not work..
   end
 
-  def rc_facebook_check_rg_handler handler=
+  def rc_facebook_check_handler handler=
       rc_options_get(RestCore::Facebook, :check_handler)
 
     return if rc_facebook.authorized? || !handler
@@ -208,7 +209,7 @@ module RestCore::Facebook::RailsUtil
                  " #{rc_facebook.data.inspect}")
   end
 
-  def rc_facebook_check_rg_session
+  def rc_facebook_check_session
     return if rc_facebook.authorized?                             ||
               !rc_options_get(RestCore::Facebook, :write_session) ||
               !(fbs = session[rc_facebook_storage_key])
@@ -218,7 +219,7 @@ module RestCore::Facebook::RailsUtil
                  " #{rc_facebook.data.inspect}")
   end
 
-  def rc_facebook_check_rg_cookies
+  def rc_facebook_check_cookies
     return if rc_facebook.authorized?                             ||
               !rc_options_get(RestCore::Facebook, :write_cookies) ||
               !(fbs = cookies[rc_facebook_storage_key])
@@ -229,14 +230,13 @@ module RestCore::Facebook::RailsUtil
   end
   # ====================   end check ================================
   # ==================== begin write ================================
-  def rc_facebook_write_rg_fbs
-    cookies.delete("fbs_#{rc_facebook.app_id}")
-    rc_facebook_write_rg_handler
-    rc_facebook_write_rg_session
-    rc_facebook_write_rg_cookies
+  def rc_facebook_write_fbs
+    rc_facebook_write_handler
+    rc_facebook_write_session
+    rc_facebook_write_cookies
   end
 
-  def rc_facebook_write_rg_handler handler=
+  def rc_facebook_write_handler handler=
     rc_options_get(RestCore::Facebook, :write_handler)
 
     return if !handler
@@ -244,13 +244,13 @@ module RestCore::Facebook::RailsUtil
     logger.debug("DEBUG: Facebook: called write_handler: fbs => #{fbs}")
   end
 
-  def rc_facebook_write_rg_session
+  def rc_facebook_write_session
     return if !rc_options_get(RestCore::Facebook, :write_session)
     session[rc_facebook_storage_key] = fbs = rc_facebook.fbs
     logger.debug("DEBUG: Facebook: wrote session: fbs => #{fbs}")
   end
 
-  def rc_facebook_write_rg_cookies
+  def rc_facebook_write_cookies
     return if !rc_options_get(RestCore::Facebook, :write_cookies)
     cookies[rc_facebook_storage_key] = fbs = rc_facebook.fbs
     logger.debug("DEBUG: Facebook: wrote cookies: fbs => #{fbs}")
@@ -260,6 +260,13 @@ module RestCore::Facebook::RailsUtil
 
 
   # ==================== begin misc ================================
+  def rc_facebook_cleanup
+    cookies.delete("fbs_#{rc_facebook.app_id}")
+    cookies.delete("fbsr_#{rc_facebook.app_id}")
+    cookies.delete(rc_facebook_storage_key)
+    session.delete(rc_facebook_storage_key)
+  end
+
   def rc_facebook_normalized_request_uri
     uri = if rc_facebook_in_canvas?
             # rails 3 uses newer rack which has fullpath

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

@@ -3,6 +3,7 @@ require 'rest-core'
 
 require 'time' # for Time.parse
 
+# http://wiki.flurry.com
 RestCore::Flurry = RestCore::Builder.client(:apiKey, :apiAccessCode) do
   s = self.class # this is only for ruby 1.8!
   use s::Timeout       , 10
@@ -26,34 +27,47 @@ module RestCore::Flurry::Client
   #     "@createdDate"=>"2011-07-24", "@category"=>"Photography",
   #     "@version"=>"1.0", "@generatedDate"=>"9/15/11 7:08 AM",
   #     "version"=>[{"@name"=>"2.1", ...
-  def app_info query={}
-    get('appInfo/getApplication', query)
+  def app_info query={}, opts={}
+    get('appInfo/getApplication', query, opts)
   end
 
   # see: http://wiki.flurry.com/index.php?title=EventMetrics
-  # >> f.event_matrics({}, :days => 7)
-  # => {"Facebook share error"=>{"@usersLastWeek"=>"948",
-  #                              "@usersLastMonth"=>"2046",
-  #                              "@usersLastDay"=>"4",...}}
-  def event_metrics query={}, opts={}
-    get('eventMetrics/Summary', *calculate_query_and_opts(query, opts)
-      )['event'].inject({}){ |r, i|
-        r[i['@eventName']] = i.reject{ |k, _| k == '@eventName' }
-        r }
+  # >> f.event_names
+  # => ["Products", "Save To Photo Library", ...]
+  def event_names query={}, opts={}
+    event_summary(query, opts).keys
+  end
+
+  # see: http://wiki.flurry.com/index.php?title=EventMetrics
+  # >> f.event_summary({}, :days => 7)
+  # => {"Products" => {"@usersLastWeek"  => "948" ,
+  #                    "@usersLastMonth" => "2046",
+  #                    "@usersLastDay"   => "4"   , ...}}
+  def event_summary query={}, opts={}
+    array2hash(get('eventMetrics/Summary',
+                   *calculate_query_and_opts(query, opts))['event'],
+               '@eventName')
+  end
+
+  # see: http://wiki.flurry.com/index.php?title=EventMetrics
+  # >> f.event_metrics('Products', {}, :days => 7)
+  # => [["2011-11-23", {"@uniqueUsers"   => "12"     ,
+  #                     "@totalSessions" => "108392" ,
+  #                     "@totalCount"    => "30"     ,
+  #                     "@duration"      => "9754723"}],
+  #     ["2011-11-22", {...}]]
+  def event_metrics name, query={}, opts={}
+    array2hash(get('eventMetrics/Event',
+                   *calculate_query_and_opts(
+                      {'eventName' => name}.merge(query), opts))['day'],
+               '@date').sort{ |a, b| b <=> a }
   end
 
   # see: http://wiki.flurry.com/index.php?title=AppMetrics
   # >> f.metrics('ActiveUsers', {}, :weeks => 4)
   # => [["2011-09-19",  6516], ["2011-09-18", 43920], ["2011-09-17", 45412],
   #     ["2011-09-16", 40972], ["2011-09-15", 37587], ["2011-09-14", 34918],
-  #     ["2011-09-13", 35223], ["2011-09-12", 37750], ["2011-09-11", 45057],
-  #     ["2011-09-10", 44077], ["2011-09-09", 36683], ["2011-09-08", 34871],
-  #     ["2011-09-07", 35960], ["2011-09-06", 35829], ["2011-09-05", 37777],
-  #     ["2011-09-04", 40233], ["2011-09-03", 39306], ["2011-09-02", 33467],
-  #     ["2011-09-01", 31558], ["2011-08-31", 32096], ["2011-08-30", 34076],
-  #     ["2011-08-29", 34950], ["2011-08-28", 40456], ["2011-08-27", 41332],
-  #     ["2011-08-26", 37737], ["2011-08-25", 34392], ["2011-08-24", 33560],
-  #     ["2011-08-23", 34722]]
+  #     ...]
   def metrics path, query={}, opts={}
     get("appMetrics/#{path}", *calculate_query_and_opts(query, opts)
       )['day'].map{ |i| [i['@date'], i['@value'].to_i] }.reverse
@@ -80,7 +94,7 @@ module RestCore::Flurry::Client
     }.reverse
   end
 
-  def query
+  def default_query
     {'apiKey'        => apiKey       ,
      'apiAccessCode' => apiAccessCode}
   end
@@ -88,7 +102,7 @@ module RestCore::Flurry::Client
   private
   def calculate_query_and_opts query, opts
     days = opts[:days] || (opts[:weeks]  && opts[:weeks] * 7)   ||
-                          (opts[:months] && opts[:months] * 30)
+                          (opts[:months] && opts[:months] * 30) || 7
 
     startDate = query[:startDate] || (Time.now + 86400 - 86400*days).
       strftime('%Y-%m-%d')
@@ -100,6 +114,12 @@ module RestCore::Flurry::Client
                  :endDate   => endDate),
      opts.reject{ |k, _| [:days, :weeks, :months].include?(k) }]
   end
+
+  def array2hash array, key
+    array.inject({}){ |r, i|
+      r[i[key]] = i.reject{ |k, _| k == key }
+      r }
+  end
 end
 
 RestCore::Flurry.send(:include, RestCore::Flurry::Client)

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

@@ -1,13 +1,14 @@
 
 require 'rest-core'
 
+# http://developer.github.com/v3/
 RestCore::Github = RestCore::Builder.client do
   s = self.class # this is only for ruby 1.8!
   use s::Timeout       , 10
 
   use s::DefaultSite   , 'https://api.github.com/'
   use s::DefaultHeaders, {'Accept' => 'application/json'}
-  use s::Oauth2Query   , 'access_token', nil
+  use s::Oauth2Query   , nil
 
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
@@ -17,5 +18,14 @@ RestCore::Github = RestCore::Builder.client do
   end
 end
 
+module RestCore::Github::Client
+  include RestCore
+
+  def me query={}, opts={}
+    get('user', query, opts)
+  end
+end
+
+RestCore::Github.send(:include, RestCore::Github::Client)
 require 'rest-core/client/github/rails_util' if
   Object.const_defined?(:Rails)

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

@@ -1,7 +1,8 @@
 
 require 'rest-core'
 
-RestCore::Linkedin = RestCore::Builder.client(:data) do
+# http://developer.linkedin.com/documents/linkedin-api-resource-map
+RestCore::Linkedin = RestCore::Builder.client do
   s = self.class # this is only for ruby 1.8!
   use s::Timeout       , 10
 
@@ -25,33 +26,17 @@ RestCore::Linkedin = RestCore::Builder.client(:data) do
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end
-
-  use s::Defaults      , :data     => lambda{{}}
 end
 
 module RestCore::Linkedin::Client
   include RestCore
 
-  def oauth_token
-    data['oauth_token'] if data.kind_of?(Hash)
-  end
-  def oauth_token= token
-    data['oauth_token'] = token if data.kind_of?(Hash)
-  end
-  def oauth_token_secret
-    data['oauth_token_secret'] if data.kind_of?(Hash)
-  end
-  def oauth_token_secret= secret
-    data['oauth_token_secret'] = secret if data.kind_of?(Hash)
-  end
-
-  def me queries={}, opts={}
-    get('v1/people/~', queries, opts)
+  def me query={}, opts={}
+    get('v1/people/~', query, opts)
   end
 
-  private
-  def set_token query
-    self.data = query
+  def authorize_url
+    url(authorize_path, :oauth_token => oauth_token, :format => false)
   end
 end
 

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

@@ -1,4 +1,5 @@
 
+# http://developer.mixi.co.jp/connect/mixi_graph_api/
 RestCore::Mixi = RestCore::Builder.client(
   :data, :consumer_key, :consumer_secret, :redirect_uri) do
   s = self.class # this is only for ruby 1.8!
@@ -7,7 +8,7 @@ RestCore::Mixi = RestCore::Builder.client(
   use s::DefaultSite   , 'http://api.mixi-platform.com/'
   use s::DefaultHeaders, {'Accept' => 'application/json'}
 
-  use s::Oauth2Header  , nil
+  use s::Oauth2Header  , 'OAuth', nil
 
   use s::CommonLogger  , nil
   use s::Cache         , nil, 600 do
@@ -15,13 +16,15 @@ RestCore::Mixi = RestCore::Builder.client(
     use s::ErrorDetectorHttp
     use s::JsonDecode    , true
   end
-
-  use s::Defaults      , :data => lambda{{}}
 end
 
 module RestCore::Mixi::Client
   include RestCore
 
+  def me query={}, opts={}
+    get('2/people/@me/@self', query, opts)
+  end
+
   def access_token
     data['access_token'] if data.kind_of?(Hash)
   end
@@ -45,6 +48,11 @@ module RestCore::Mixi::Client
 
     self.data = post('https://secure.mixi-platform.com/2/token', pl, {}, opts)
   end
+
+  private
+  def default_data
+    {}
+  end
 end
 
 RestCore::Mixi.send(:include, RestCore::Mixi::Client)

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

@@ -1,7 +1,8 @@
 
 require 'rest-core'
 
-RestCore::Twitter = RestCore::Builder.client(:data) do
+# https://dev.twitter.com/docs
+RestCore::Twitter = RestCore::Builder.client do
   s = self.class # this is only for ruby 1.8!
   use s::Timeout       , 10
 
@@ -18,10 +19,9 @@ RestCore::Twitter = RestCore::Builder.client(:data) do
     use s::ErrorDetectorHttp
     use s::JsonDecode  , true
   end
-
-  use s::Defaults      , :data => lambda{{}}
 end
 
+# https://dev.twitter.com/docs/error-codes-responses
 class RestCore::Twitter::Error < RestCore::Error
   include RestCore
   class ServerError         < Twitter::Error; end
@@ -64,36 +64,24 @@ end
 module RestCore::Twitter::Client
   include RestCore
 
-  def oauth_token
-    data['oauth_token'] if data.kind_of?(Hash)
-  end
-  def oauth_token= token
-    data['oauth_token'] = token if data.kind_of?(Hash)
-  end
-  def oauth_token_secret
-    data['oauth_token_secret'] if data.kind_of?(Hash)
-  end
-  def oauth_token_secret= secret
-    data['oauth_token_secret'] = secret if data.kind_of?(Hash)
+  def me query={}, opts={}
+    get('1/account/verify_credentials.json', query, opts)
   end
 
-  def tweet status, media=nil, opts={}
+  def tweet status, media=nil, payload={}, query={}, opts={}
     if media
       post('https://upload.twitter.com/1/statuses/update_with_media.json',
-        {:status => status, 'media[]' => media},
-        {}, opts)
+        {:status => status, 'media[]' => media}.merge(payload),
+        query, opts)
     else
-      post('1/statuses/update.json', {:status => status}, {}, opts)
+      post('1/statuses/update.json',
+        {:status => status}.merge(payload),
+        query, opts)
     end
   end
 
-  def statuses user, queries={}, opts={}
-    get('1/statuses/user_timeline.json', {:id => user}.merge(queries), opts)
-  end
-
-  private
-  def set_token query
-    self.data = query
+  def statuses user, query={}, opts={}
+    get('1/statuses/user_timeline.json', {:id => user}.merge(query), opts)
   end
 end
 

data/lib/rest-core/client/twitter/rails_util.rb

@@ -2,12 +2,160 @@
 require 'rest-core/util/rails_util_util'
 
 module RestCore::Twitter::DefaultAttributes
-  def default_log_method; Rails.logger.method(:debug); end
-  def default_cache     ; Rails.cache                ; end
+  def default_log_method       ; Rails.logger.method(:debug); end
+  def default_cache            ; Rails.cache                ; end
+  def default_auto_authorize   ; false                      ; end
+  def default_ensure_authorized; false                      ; end
+  def default_write_session    ; false                      ; end
+  def default_write_cookies    ; false                      ; end
+  def default_write_handler    ;   nil                      ; end
+  def default_check_handler    ;   nil                      ; end
 end
 
 module RestCore::Twitter::RailsUtil
   include RestCore::RailsUtilUtil
+
+  def self.included controller
+    # skip if included already, any better way to detect this?
+    return if controller.respond_to?(:rc_twitter, true)
+    super
+    controller.rescue_from(RestCore::Twitter::Error::Unauthorized,
+                           :with => :rc_twitter_on_unauthorized)
+  end
+
+  def rc_twitter_setup options={}
+    super
+
+    rc_twitter_check_handler
+    rc_twitter_check_session
+    rc_twitter_check_cookies
+    rc_twitter_check_oauth_verifier
+
+    if rc_options_get(RestCore::Twitter, :ensure_authorized) &&
+       !rc_twitter.authorized?
+
+      rc_twitter_authorize('ensure authorized')
+      false # action halt, redirect to do authorize,
+            # eagerly, as opposed to auto_authorize
+    else
+      true  # keep going
+    end
+  end
+
+  def rc_twitter_on_unauthorized error=nil
+    rc_twitter_authorize(error, false)
+  end
+
+  def rc_twitter_authorize error=nil, force_redirect=true
+    logger.warn("WARN: Twitter: #{error.inspect}")
+
+    if force_redirect || rc_options_get(RestCore::Twitter, :auto_authorize)
+      rc_twitter_cleanup
+
+      callback = rc_twitter_normalized_request_uri
+      redirect_url = rc_twitter.authorize_url!(:oauth_callback => callback)
+      rc_twitter.oauth_callback = callback
+      rc_twitter_write_data_json
+
+      logger.debug(
+        "DEBUG: Twitter: redirect to #{redirect_url} from #{callback}")
+
+      redirect_to redirect_url
+    end
+  end
+
+  # ==================== begin check ================================
+  def rc_twitter_storage_key
+    "rc_twitter_#{rc_twitter.consumer_key}"
+  end
+
+  def rc_twitter_check_oauth_verifier
+    return if !rc_twitter.oauth_callback || !params[:oauth_verifier]
+
+    rc_twitter.authorize!(:oauth_verifier => params[:oauth_verifier])
+    rc_twitter.data.delete('oauth_callback')
+
+    logger.debug(
+      "DEBUG: Twitter: detected oauth_verifier with #{request.url}," \
+      " parsed: #{rc_twitter.data.inspect}")
+
+    rc_twitter_write_data_json if rc_twitter.authorized?
+  end
+
+  def rc_twitter_check_handler handler=
+      rc_options_get(RestCore::Twitter, :check_handler)
+
+    return if rc_twitter.authorized? || !handler
+    rc_twitter.data_json = handler.call
+    logger.debug("DEBUG: Twitter: called check_handler, parsed:" \
+                 " #{rc_twitter.data.inspect}")
+  end
+
+  def rc_twitter_check_session
+    return if rc_twitter.authorized?                             ||
+              !rc_options_get(RestCore::Twitter, :write_session) ||
+              !(data_json = session[rc_twitter_storage_key])
+
+    rc_twitter.data_json = data_json
+    logger.debug("DEBUG: Twitter: detected rc_twitter session, parsed:" \
+                 " #{rc_twitter.data.inspect}")
+  end
+
+  def rc_twitter_check_cookies
+    return if rc_twitter.authorized?                             ||
+              !rc_options_get(RestCore::Twitter, :write_cookies) ||
+              !(data_json = cookies[rc_twitter_storage_key])
+
+    rc_twitter.data_json = data_json
+    logger.debug("DEBUG: Twitter: detected rc_twitter cookies, parsed:" \
+                 " #{rc_twitter.data.inspect}")
+  end
+  # ====================   end check ================================
+  # ==================== begin write ================================
+  def rc_twitter_write_data_json
+    rc_twitter_write_handler
+    rc_twitter_write_session
+    rc_twitter_write_cookies
+  end
+
+  def rc_twitter_write_handler handler=
+    rc_options_get(RestCore::Twitter, :write_handler)
+
+    return if !handler
+    handler.call(data_json = rc_twitter.data_json)
+    logger.debug("DEBUG: Twitter: write_handler: data_json => #{data_json}")
+  end
+
+  def rc_twitter_write_session
+    return if !rc_options_get(RestCore::Twitter, :write_session)
+    session[rc_twitter_storage_key] = data_json = rc_twitter.data_json
+    logger.debug("DEBUG: Twitter: wrote session: data_json => #{data_json}")
+  end
+
+  def rc_twitter_write_cookies
+    return if !rc_options_get(RestCore::Twitter, :write_cookies)
+    cookies[rc_twitter_storage_key] = data_json = rc_twitter.data_json
+    logger.debug("DEBUG: Twitter: wrote cookies: data_json => #{data_json}")
+  end
+  # ==================== end write ================================
+
+
+
+  # ==================== begin misc ================================
+  def rc_twitter_cleanup
+    session.delete(rc_twitter_storage_key)
+    cookies.delete(rc_twitter_storage_key)
+  end
+
+  def rc_twitter_normalized_request_uri
+    URI.parse(request.url).tap{ |uri|
+      uri.query = uri.query.split('&').reject{ |q|
+                    q =~ /^(oauth_verifier|oauth_token)\=/
+                  }.join('&') if uri.query
+      uri.query = nil if uri.query.blank?
+    }.to_s
+  end
+  # ==================== end misc ================================
 end
 
 RestCore::Twitter::RailsUtil.init(Rails)

data/lib/rest-more/version.rb

@@ -1,4 +1,4 @@
 
 module RestMore
-  VERSION = '0.7.2.1'
+  VERSION = '0.8.0'
 end

data/rest-more.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name = "rest-more"
-  s.version = "0.7.2.1"
+  s.version = "0.8.0"
 
   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-05"
+  s.date = "2011-11-29"
   s.description = "Various REST clients such as Facebook and Twitter built with [rest-core][]\n\n[rest-core]: https://github.com/cardinalblue/rest-core"
   s.email = ["dev (XD) cardinalblue.com"]
   s.executables = ["rib-rest-core"]

data/test/client/facebook/test_oauth.rb

@@ -18,9 +18,11 @@ describe RC::Facebook do
   end
 
   should 'do authorizing and parse result and save it in data' do
-    stub_request(:get, 'https://graph.facebook.com/oauth/access_token?' \
-                       'client_id=29&client_secret=18&code=zzz&'        \
-                       'redirect_uri=http%3A%2F%2Fzzz.tw').
+    stub_request(:post, 'https://graph.facebook.com/oauth/access_token'). \
+      with(:body => {'client_id'     => '29' ,
+                     'client_secret' => '18' ,
+                     'redirect_uri'  => 'http://zzz.tw',
+                     'code'          => 'zzz'}).
       to_return(:body => 'access_token=baken&expires=2918')
 
     result = {'access_token' => 'baken', 'expires' => '2918'}

data/test/client/flurry/test_metrics.rb

@@ -9,74 +9,85 @@ describe RC::Flurry do
     RR.verify
   end
 
-  before do
-    startDate = '2011-08-23'
-    endDate   = '2011-09-19'
-    @flurry = RestCore::Flurry.new
-    stub(Time).now{ Time.parse(endDate, nil) }
-    stub_request(:get,
-      "http://api.flurry.com/appMetrics/ActiveUsers?" \
-      "startDate=#{startDate}&endDate=#{endDate}").
-      to_return(:body =>
-        '{"@startDate":"2011-08-23",
-          "@metric":"ActiveUsersByDay",
-          "@endDate":"2011-09-19",
-          "@version":"1.0",
-          "@generatedDate":"9/19/11 5:54 AM",
-          "day":
-            [{"@value":"34722","@date":"2011-08-23"},
-             {"@value":"33560","@date":"2011-08-24"},
-             {"@value":"34392","@date":"2011-08-25"},
-             {"@value":"37737","@date":"2011-08-26"},
-             {"@value":"41332","@date":"2011-08-27"},
-             {"@value":"40456","@date":"2011-08-28"},
-             {"@value":"34950","@date":"2011-08-29"},
-             {"@value":"34076","@date":"2011-08-30"},
-             {"@value":"32096","@date":"2011-08-31"},
-             {"@value":"31558","@date":"2011-09-01"},
-             {"@value":"33467","@date":"2011-09-02"},
-             {"@value":"39306","@date":"2011-09-03"},
-             {"@value":"40233","@date":"2011-09-04"},
-             {"@value":"37777","@date":"2011-09-05"},
-             {"@value":"35829","@date":"2011-09-06"},
-             {"@value":"35960","@date":"2011-09-07"},
-             {"@value":"34871","@date":"2011-09-08"},
-             {"@value":"36683","@date":"2011-09-09"},
-             {"@value":"44077","@date":"2011-09-10"},
-             {"@value":"45057","@date":"2011-09-11"},
-             {"@value":"37750","@date":"2011-09-12"},
-             {"@value":"35223","@date":"2011-09-13"},
-             {"@value":"34918","@date":"2011-09-14"},
-             {"@value":"37587","@date":"2011-09-15"},
-             {"@value":"40972","@date":"2011-09-16"},
-             {"@value":"45412","@date":"2011-09-17"},
-             {"@value":"43920","@date":"2011-09-18"},
-             {"@value":"6516","@date":"2011-09-19"}]}')
+  describe 'metrics' do
+    before do
+      startDate = '2011-08-23'
+      endDate   = '2011-09-19'
+      @flurry = RestCore::Flurry.new
+      stub(Time).now{ Time.parse(endDate, nil) }
+      stub_request(:get,
+        "http://api.flurry.com/appMetrics/ActiveUsers?" \
+        "startDate=#{startDate}&endDate=#{endDate}").
+        to_return(:body =>
+          '{"@startDate":"2011-08-23",
+            "@metric":"ActiveUsersByDay",
+            "@endDate":"2011-09-19",
+            "@version":"1.0",
+            "@generatedDate":"9/19/11 5:54 AM",
+            "day":
+              [{"@value":"34722","@date":"2011-08-23"},
+               {"@value":"33560","@date":"2011-08-24"},
+               {"@value":"34392","@date":"2011-08-25"},
+               {"@value":"37737","@date":"2011-08-26"},
+               {"@value":"41332","@date":"2011-08-27"},
+               {"@value":"40456","@date":"2011-08-28"},
+               {"@value":"34950","@date":"2011-08-29"},
+               {"@value":"34076","@date":"2011-08-30"},
+               {"@value":"32096","@date":"2011-08-31"},
+               {"@value":"31558","@date":"2011-09-01"},
+               {"@value":"33467","@date":"2011-09-02"},
+               {"@value":"39306","@date":"2011-09-03"},
+               {"@value":"40233","@date":"2011-09-04"},
+               {"@value":"37777","@date":"2011-09-05"},
+               {"@value":"35829","@date":"2011-09-06"},
+               {"@value":"35960","@date":"2011-09-07"},
+               {"@value":"34871","@date":"2011-09-08"},
+               {"@value":"36683","@date":"2011-09-09"},
+               {"@value":"44077","@date":"2011-09-10"},
+               {"@value":"45057","@date":"2011-09-11"},
+               {"@value":"37750","@date":"2011-09-12"},
+               {"@value":"35223","@date":"2011-09-13"},
+               {"@value":"34918","@date":"2011-09-14"},
+               {"@value":"37587","@date":"2011-09-15"},
+               {"@value":"40972","@date":"2011-09-16"},
+               {"@value":"45412","@date":"2011-09-17"},
+               {"@value":"43920","@date":"2011-09-18"},
+               {"@value":"6516","@date":"2011-09-19"}]}')
 
-    @active_users =
-      [["2011-09-19",  6516], ["2011-09-18", 43920], ["2011-09-17", 45412],
-       ["2011-09-16", 40972], ["2011-09-15", 37587], ["2011-09-14", 34918],
-       ["2011-09-13", 35223], ["2011-09-12", 37750], ["2011-09-11", 45057],
-       ["2011-09-10", 44077], ["2011-09-09", 36683], ["2011-09-08", 34871],
-       ["2011-09-07", 35960], ["2011-09-06", 35829], ["2011-09-05", 37777],
-       ["2011-09-04", 40233], ["2011-09-03", 39306], ["2011-09-02", 33467],
-       ["2011-09-01", 31558], ["2011-08-31", 32096], ["2011-08-30", 34076],
-       ["2011-08-29", 34950], ["2011-08-28", 40456], ["2011-08-27", 41332],
-       ["2011-08-26", 37737], ["2011-08-25", 34392], ["2011-08-24", 33560],
-       ["2011-08-23", 34722]]
+      @active_users =
+        [["2011-09-19",  6516], ["2011-09-18", 43920], ["2011-09-17", 45412],
+         ["2011-09-16", 40972], ["2011-09-15", 37587], ["2011-09-14", 34918],
+         ["2011-09-13", 35223], ["2011-09-12", 37750], ["2011-09-11", 45057],
+         ["2011-09-10", 44077], ["2011-09-09", 36683], ["2011-09-08", 34871],
+         ["2011-09-07", 35960], ["2011-09-06", 35829], ["2011-09-05", 37777],
+         ["2011-09-04", 40233], ["2011-09-03", 39306], ["2011-09-02", 33467],
+         ["2011-09-01", 31558], ["2011-08-31", 32096], ["2011-08-30", 34076],
+         ["2011-08-29", 34950], ["2011-08-28", 40456], ["2011-08-27", 41332],
+         ["2011-08-26", 37737], ["2011-08-25", 34392], ["2011-08-24", 33560],
+         ["2011-08-23", 34722]]
 
-    @weekly = [244548, 270227, 248513, 257149]
-  end
+      @weekly = [244548, 270227, 248513, 257149]
+    end
 
-  should 'metrics("ActiveUsers")' do
-    @flurry.metrics('ActiveUsers', {}, :weeks => 4).should.eq @active_users
-  end
+    should 'metrics("ActiveUsers")' do
+      @flurry.metrics('ActiveUsers', {}, :weeks => 4).should.eq @active_users
+    end
 
-  should 'weekly(metrics("ActiveUsers"))' do
-    @flurry.weekly(@active_users).should.eq @weekly
+    should 'weekly(metrics("ActiveUsers"))' do
+      @flurry.weekly(@active_users).should.eq @weekly
+    end
+
+    should 'sum(weekly(metrics("ActiveUsers")))' do
+      @flurry.sum(@weekly).should.eq [1020437, 775889, 505662, 257149]
+    end
   end
 
-  should 'sum(weekly(metrics("ActiveUsers")))' do
-    @flurry.sum(@weekly).should.eq [1020437, 775889, 505662, 257149]
+  should 'bring apiKey and apiAccessCode' do
+    stub_request(:get,
+      "http://api.flurry.com/?apiKey=a&apiAccessCode=b").
+      to_return(:body => '["ok"]')
+
+    f = RC::Flurry.new(:apiKey => 'a', :apiAccessCode => 'b')
+    f.get('').should.eq ['ok']
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-more
 version: !ruby/object:Gem::Version
-  version: 0.7.2.1
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-05 00:00:00.000000000 Z
+date: 2011-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-core
-  requirement: &2153326960 !ruby/object:Gem::Requirement
+  requirement: &2158239560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153326960
+  version_requirements: *2158239560
 description: ! 'Various REST clients such as Facebook and Twitter built with [rest-core][]