Parent

Files

Twitter::OAuth

Attributes

ctoken[R]
csecret[R]
consumer_options[R]
api_endpoint[R]
signing_endpoint[R]

Public Class Methods

new(ctoken, csecret, options={}) click to toggle source

Options

  :sign_in => true to just sign in with twitter instead of doing oauth authorization
              (http://apiwiki.twitter.com/Sign-in-with-Twitter)
    # File lib/twitter/oauth.rb, line 12
12:     def initialize(ctoken, csecret, options={})
13:       @ctoken, @csecret, @consumer_options = ctoken, csecret, {}
14:       @api_endpoint = options[:api_endpoint] || 'http://api.twitter.com'
15:       @signing_endpoint = options[:signing_endpoint] || 'http://api.twitter.com'
16:       if options[:sign_in]
17:         @consumer_options[:authorize_path] =  '/oauth/authenticate'
18:       end
19:     end

Public Instance Methods

access_token() click to toggle source
    # File lib/twitter/oauth.rb, line 49
49:     def access_token
50:       @access_token ||= ::OAuth::AccessToken.new(signing_consumer, @atoken, @asecret)
51:     end
authorize_from_access(atoken, asecret) click to toggle source
    # File lib/twitter/oauth.rb, line 53
53:     def authorize_from_access(atoken, asecret)
54:       @atoken, @asecret = atoken, asecret
55:     end
authorize_from_request(rtoken, rsecret, verifier_or_pin) click to toggle source

For web apps use params[:oauth_verifier], for desktop apps, use the verifier is the pin that twitter gives users.

    # File lib/twitter/oauth.rb, line 43
43:     def authorize_from_request(rtoken, rsecret, verifier_or_pin)
44:       request_token = ::OAuth::RequestToken.new(signing_consumer, rtoken, rsecret)
45:       access_token = request_token.get_access_token(:oauth_verifier => verifier_or_pin)
46:       @atoken, @asecret = access_token.token, access_token.secret
47:     end
consumer() click to toggle source
    # File lib/twitter/oauth.rb, line 21
21:     def consumer
22:       @consumer ||= ::OAuth::Consumer.new(@ctoken, @csecret, {:site => api_endpoint}.merge(consumer_options))
23:     end
request_token(options={}) click to toggle source

Note: If using oauth with a web app, be sure to provide :oauth_callback. Options:

  :oauth_callback => String, url that twitter should redirect to
    # File lib/twitter/oauth.rb, line 37
37:     def request_token(options={})
38:       @request_token ||= signing_consumer.get_request_token(options)
39:     end
set_callback_url(url) click to toggle source
    # File lib/twitter/oauth.rb, line 29
29:     def set_callback_url(url)
30:       clear_request_token
31:       request_token(:oauth_callback => url)
32:     end
signing_consumer() click to toggle source
    # File lib/twitter/oauth.rb, line 25
25:     def signing_consumer
26:       @signing_consumer ||= ::OAuth::Consumer.new(@ctoken, @csecret, {:site => signing_endpoint, :request_endpoint => api_endpoint }.merge(consumer_options))
27:     end

Private Instance Methods

clear_request_token() click to toggle source
    # File lib/twitter/oauth.rb, line 59
59:     def clear_request_token
60:       @request_token = nil
61:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.