Class: Koala::Facebook::OAuth

Inherits:
Object
  • Object
show all
Defined in:
lib/koala.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_id, app_secret, oauth_callback_url = nil) ⇒ OAuth

Returns a new instance of OAuth.



105
106
107
108
109
 
# File 'lib/koala.rb', line 105

def initialize(app_id, app_secret, oauth_callback_url = nil)
  @app_id = app_id
  @app_secret = app_secret
  @oauth_callback_url = oauth_callback_url 
end

Instance Attribute Details

#app_id ⇒ Object (readonly)

Returns the value of attribute app_id.



104
105
106
 
# File 'lib/koala.rb', line 104

def app_id
  @app_id
end

#app_secret ⇒ Object (readonly)

Returns the value of attribute app_secret.



104
105
106
 
# File 'lib/koala.rb', line 104

def app_secret
  @app_secret
end

#oauth_callback_url ⇒ Object (readonly)

Returns the value of attribute oauth_callback_url.



104
105
106
 
# File 'lib/koala.rb', line 104

def oauth_callback_url
  @oauth_callback_url
end

Instance Method Details

#get_access_token(code) ⇒ Object 



182
183
184
185
186
187
188
 
# File 'lib/koala.rb', line 182

def get_access_token(code)
  info = get_access_token_info(code)
  # upstream methods will throw errors if needed
  string = info["access_token"]

  overload_as_hash(string, info)          
end

#get_access_token_info(code) ⇒ Object 



176
177
178
179
180
 
# File 'lib/koala.rb', line 176

def get_access_token_info(code)
  # convenience method to get a parsed token from Facebook for a given code
  # should this require an OAuth callback URL?
  get_token_from_server(:code => code, :redirect_uri => @oauth_callback_url)
end

#get_app_access_token ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/koala.rb', line 195

def get_app_access_token
  info = get_app_access_token_info
  string = info["access_token"]

  overload_as_hash(string, info)
end

#get_app_access_token_info ⇒ Object 



190
191
192
193
 
# File 'lib/koala.rb', line 190

def get_app_access_token_info
  # convenience method to get a the application's sessionless access token 
  get_token_from_server({:type => 'client_cred'}, true)
end

#get_token_from_session_key(session) ⇒ Object 



231
232
233
234
235
 
# File 'lib/koala.rb', line 231

def get_token_from_session_key(session)
  # convenience method for a single key
  # gets the overlaoded strings automatically
  get_tokens_from_session_keys([session])[0]
end

#get_token_info_from_session_keys(sessions) ⇒ Object

from session keys



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/koala.rb', line 203

def get_token_info_from_session_keys(sessions)
  # fetch the OAuth tokens from Facebook
  response = fetch_token_string({
    :type => 'client_cred',
    :sessions => sessions.join(",")
  }, true, "exchange_sessions")
  
  # get_token_from_session_key should return an empty body if an empty string or nil is provided
  # if invalid tokens are provided, it returns an array of nulls, which is a valid result
  if response == ""
    raise APIError.new("ArgumentError", "get_token_from_session_key received an error (empty response body) for sessions #{sessions.inspect}!")
  end
  
  JSON.parse(response)
end

#get_tokens_from_session_keys(sessions) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/koala.rb', line 219

def get_tokens_from_session_keys(sessions)
  # get the original hash results
  results = get_token_info_from_session_keys(sessions)
  # now recollect them as backward-compatible strings
  # for easier use
  results.collect do |r|
    string = r["access_token"]

    overload_as_hash string, r
  end
end

#get_user_from_cookie(cookies) ⇒ Object Also known as: get_user_from_cookies 



141
142
143
144
145
146
147
148
 
# File 'lib/koala.rb', line 141

def get_user_from_cookie(cookies)
  # overload this to be backward compatible with older implementations
  # icky ruby magic, but it's _really_ cool we can do this
  info = (cookies)
  string = info["uid"]

  overload_as_hash(string, info)
end

#get_user_info_from_cookie(cookie_hash) ⇒ Object Also known as: get_user_info_from_cookies 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/koala.rb', line 111

def (cookie_hash)
  # Parses the cookie set by the official Facebook JavaScript SDK.
  # 
  # cookies should be a Hash, like the one Rails provides
  # 
  # If the user is logged in via Facebook, we return a dictionary with the
  # keys "uid" and "access_token". The former is the user's Facebook ID,
  # and the latter can be used to make authenticated requests to the Graph API.
  # If the user is not logged in, we return None.
  # 
  # Download the official Facebook JavaScript SDK at
  # http://github.com/facebook/connect-js/. Read more about Facebook
  # authentication at http://developers.facebook.com/docs/authentication/.

  if fb_cookie = cookie_hash["fbs_" + @app_id.to_s]
    # remove the opening/closing quote
    fb_cookie = fb_cookie.gsub(/\"/, "")

    # since we no longer get individual cookies, we have to separate out the components ourselves
    components = {}
    fb_cookie.split("&").map {|param| param = param.split("="); components[param[0]] = param[1]}

    # generate the signature and make sure it matches what we expect
    auth_string = components.keys.sort.collect {|a| a == "sig" ? nil : "#{a}=#{components[a]}"}.reject {|a| a.nil?}.join("")
    sig = Digest::MD5.hexdigest(auth_string + @app_secret)          
    sig == components["sig"] && (components["expires"] == "0" || Time.now.to_i < components["expires"].to_i) ? components : nil
  end
end

#url_for_access_token(code, options = {}) ⇒ Object

Raises:

  • (ArgumentError) 


165
166
167
168
169
170
171
172
173
174
 
# File 'lib/koala.rb', line 165

def url_for_access_token(code, options = {})
  # Creates the URL for the token corresponding to a given code generated by Facebook
  if options.is_a?(String) # changing the arguments
    puts "Deprecation warning: url_for_access_token now takes an options hash as the second argument; pass the callback as :callback."
    options = {:callback => options}
  end
  callback = options[:callback] || @oauth_callback_url
  raise ArgumentError, "url_for_access_token must get a callback either from the OAuth object or in the parameters!" unless callback
  "https://#{GRAPH_SERVER}/oauth/access_token?client_id=#{@app_id}&redirect_uri=#{callback}&client_secret=#{@app_secret}&code=#{code}"
end

#url_for_oauth_code(options = {}) ⇒ Object

URLs

Raises:

  • (ArgumentError) 


153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/koala.rb', line 153

def url_for_oauth_code(options = {})
  # for permissions, see http://developers.facebook.com/docs/authentication/permissions
  permissions = options[:permissions]
  scope = permissions ? "&scope=#{permissions.is_a?(Array) ? permissions.join(",") : permissions}" : ""

  callback = options[:callback] || @oauth_callback_url
  raise ArgumentError, "url_for_oauth_code must get a callback either from the OAuth object or in the options!" unless callback

  # Creates the URL for oauth authorization for a given callback and optional set of permissions
  "https://#{GRAPH_SERVER}/oauth/authorize?client_id=#{@app_id}&redirect_uri=#{callback}#{scope}"    
end