Class: OauthToken
Direct Known Subclasses
FacebookToken, FoursquareToken, GetSatisfactionToken, GoogleToken, LinkedInToken, MyspaceToken, NetflixToken, OhlohToken, TwitterToken, VimeoToken, YahooToken
Class Method Summary
collapse
Instance Method Summary
collapse
Methods inherited from AccessToken
client, config, #consumer, service_name, #service_name, #settings, settings
Class Method Details
.authorize_url(callback_url, &block) ⇒ Object
this is a cleaner method so we can access the authorize_url from oauth 1 or 2
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 122
def authorize_url(callback_url, &block)
if oauth_version == 1.0
request = get_request_token(callback_url)
yield request if block_given?
return request.authorize_url
else
options = {:redirect_uri => callback_url}
unless consumer.nil? || consumer.options.empty? || consumer.options[:scope].nil?
options[:scope] = consumer.options[:scope]
else
options[:scope] = self.config[:scope] unless self.config[:scope].blank?
end
return consumer.web_server.authorize_url(options)
end
end
|
.consumer ⇒ Object
69
70
71
72
73
74
75
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 69
def consumer
if oauth_version == 1.0
OAuth::Consumer.new(credentials[:key], credentials[:secret], config.merge(credentials[:options] || {}))
else
OAuth2::Client.new(credentials[:key], credentials[:secret], config.merge(credentials[:options] || {}))
end
end
|
.find_by_key_or_token(key, token, options = {}) ⇒ Object
if we’re lucky we can find it by the token.
78
79
80
81
82
83
84
85
86
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 78
def find_by_key_or_token(key, token, options = {})
result = self.find_by_key(key, options) unless key.nil?
unless result
if !token.blank? && self.respond_to?(:find_by_token)
result = self.find_by_token(token, options)
end
end
result
end
|
.get_access_token(oauth_verifier) ⇒ Object
150
151
152
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 150
def get_access_token(oauth_verifier)
request_token.get_access_token(:oauth_verifier => oauth_verifier)
end
|
.get_request_token(callback_url) ⇒ Object
if you pass a hash as the second parameter to consumer.get_request_token, ruby oauth will think this is a form and all sorts of bad things happen
145
146
147
148
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 145
def get_request_token(callback_url)
options = {:scope => config[:scope]} if config[:scope]
consumer.get_request_token({:oauth_callback => callback_url}, options)
end
|
.get_token_and_secret(options = {}) ⇒ Object
this is a wrapper around oauth 1 and 2. it looks obscure, but from the api point of view you won’t have to worry about it’s implementation. in oauth 1.0, key = oauth_token, secret = oauth_secret in oauth 2.0, key = code, secret = access_token
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 93
def get_token_and_secret(options = {})
oauth_verifier = options[:oauth_verifier]
redirect_uri = options[:redirect_uri]
token = options[:token]
secret = options[:secret]
if oauth_version == 1.0
access = request_token(token, secret).get_access_token(:oauth_verifier => oauth_verifier)
result = {:token => access.token, :secret => access.secret, :key => nil}
if self.oauth_key
if oauth_key.is_a?(Proc)
result[:key] = oauth_key.call(access)
else
result[:key] = access.params[self.oauth_key] || access.params[self.oauth_key.to_s] end
else
puts "Access Token: #{access.inspect}"
raise "please set an oauth key for #{service_name.to_s}"
end
else
access = consumer.web_server.get_access_token(secret, :redirect_uri => redirect_uri)
result = {:token => access.token, :secret => secret, :key => nil}
end
result
end
|
.key(value = nil, &block) ⇒ Object
unique key that we will use from the AccessToken response to identify the user by. in Twitter, its “user_id”. Twitter has “screen_name”, but that’s more subject to change than user_id. Pick whatever is least likely to change
56
57
58
59
60
61
62
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 56
def key(value = nil, &block)
if block_given?
@oauth_key = block
else
@oauth_key = value.is_a?(Symbol) ? value : value.to_sym
end
end
|
.oauth_key ⇒ Object
64
65
66
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 64
def oauth_key
@oauth_key
end
|
.oauth_version ⇒ Object
48
49
50
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 48
def oauth_version
@oauth_version ||= 1.0
end
|
.request_token(token, secret) ⇒ Object
139
140
141
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 139
def request_token(token, secret)
OAuth::RequestToken.new(consumer, token, secret)
end
|
.version(value) ⇒ Object
oauth version, 1.0 or 2.0
44
45
46
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 44
def version(value)
@oauth_version = value
end
|
Instance Method Details
#client ⇒ Object
3
4
5
6
7
8
9
10
11
12
13
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 3
def client
unless @client
if oauth_version == 1.0
@client = OAuth::AccessToken.new(self.consumer, self.token, self.secret)
else
@client = OAuth2::AccessToken.new(self.consumer, self.token)
end
end
@client
end
|
#get(path, options = {}) ⇒ Object
19
20
21
22
23
24
25
26
27
28
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 19
def get(path, options = {})
config_options = self.class.send(:credentials)[:options]
unless config_options.nil?
api_version = config_options[:api_version]
user_agent = config_options[:user_agent]
end
path.insert(0, "/#{api_version}") unless api_version.nil?
options.reverse_merge!("User-Agent" => user_agent) unless user_agent.nil?
client.get(path, options)
end
|
#oauth_version ⇒ Object
15
16
17
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 15
def oauth_version
self.class.oauth_version
end
|
#post(path, body = '', headers = {}) ⇒ Object
30
31
32
33
34
35
36
37
38
39
|
# File 'lib/authlogic_connect/oauth/tokens/oauth_token.rb', line 30
def post(path, body='', ={})
config_options = self.class.send(:credentials)[:options]
unless config_options.nil?
api_version = config_options[:api_version]
user_agent = config_options[:user_agent]
end
path.insert(0, "/#{api_version}") unless api_version.nil?
.reverse_merge!("User-Agent" => user_agent) unless user_agent.nil?
client.post(path, body, )
end
|