Class: Koala::Facebook::OAuth
- Inherits:
-
Object
- Object
- Koala::Facebook::OAuth
- Defined in:
- lib/koala.rb
Instance Attribute Summary collapse
-
#app_id ⇒ Object
readonly
Returns the value of attribute app_id.
-
#app_secret ⇒ Object
readonly
Returns the value of attribute app_secret.
-
#oauth_callback_url ⇒ Object
readonly
Returns the value of attribute oauth_callback_url.
Instance Method Summary collapse
- #get_access_token(code) ⇒ Object
- #get_app_access_token ⇒ Object
- #get_user_from_cookie(cookie_hash) ⇒ Object (also: #get_user_from_cookies)
-
#initialize(app_id, app_secret, oauth_callback_url = nil) ⇒ OAuth
constructor
A new instance of OAuth.
- #url_for_access_token(code, options = {}) ⇒ Object
- #url_for_oauth_code(options = {}) ⇒ Object
Constructor Details
#initialize(app_id, app_secret, oauth_callback_url = nil) ⇒ OAuth
Returns a new instance of OAuth.
100 101 102 103 104 |
# File 'lib/koala.rb', line 100 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.
99 100 101 |
# File 'lib/koala.rb', line 99 def app_id @app_id end |
#app_secret ⇒ Object (readonly)
Returns the value of attribute app_secret.
99 100 101 |
# File 'lib/koala.rb', line 99 def app_secret @app_secret end |
#oauth_callback_url ⇒ Object (readonly)
Returns the value of attribute oauth_callback_url.
99 100 101 |
# File 'lib/koala.rb', line 99 def oauth_callback_url @oauth_callback_url end |
Instance Method Details
#get_access_token(code) ⇒ Object
160 161 162 163 164 |
# File 'lib/koala.rb', line 160 def get_access_token(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
166 167 168 169 |
# File 'lib/koala.rb', line 166 def get_app_access_token # convenience method to get a the application's sessionless access token get_token_from_server({:type => 'client_cred'}, true) end |
#get_user_from_cookie(cookie_hash) ⇒ Object Also known as:
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/koala.rb', line 106 def () # Parses the cookie set by the official Facebook JavaScript SDK. # # cookies should be a dictionary-like object mapping cookie names to # cookie values. # # 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 = ["fbs_" + @app_id.to_s] # remove the opening/closing quote = .gsub(/\"/, "") # since we no longer get individual cookies, we have to separate out the components ourselves components = {} .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
149 150 151 152 153 154 155 156 157 158 |
# File 'lib/koala.rb', line 149 def url_for_access_token(code, = {}) # Creates the URL for the token corresponding to a given code generated by Facebook if .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." = {:callback => } end callback = [: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
137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/koala.rb', line 137 def url_for_oauth_code( = {}) # for permissions, see http://developers.facebook.com/docs/authentication/permissions = [:permissions] scope = ? "&scope=#{.is_a?(Array) ? .join(",") : }" : "" callback = [: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 |