fb_util 0.0.7.1 → 0.9

data/lib/fb_util/fb_util_error.rb

@@ -0,0 +1,17 @@
+class FBUtilError < Exception
+  attr_accessor :error_code, :body, :object
+
+  def initialize(error_code, body)
+    @error_code = error_code
+    @body = body
+    begin
+      @object = JSON.parse(body)
+    rescue JSON::ParserError
+      @object = {"error" => {"message" => "Response was not valid json. See the body for more information."}}
+    end
+  end
+
+  def to_s
+    "Response code: #{error_code} => #{body}"
+  end
+end

data/lib/fb_util.rb

@@ -1,4 +1,5 @@
 require 'mechanize'
+require 'fb_util/fb_util_error'
 
 class FBUtil
   @graph_url = nil
@@ -16,7 +17,7 @@ class FBUtil
     end
   end
 
-  # Get the basic account information from facebook  
+  # Get the basic account information from facebook
   def get_account_info
     @account_info ||= get_request('/me')
   end
@@ -52,33 +53,33 @@ class FBUtil
     end
   end
 
-  # Set an already existing image to be the users cover image  
+  # Set an already existing image to be the users cover image
   # picture_id: the facebook id of the image to use as the users cover image. This currently doesn't allow for an offset, but this will be available in the next version.
   def set_as_cover_image(picture_id)
     post_request('/me', {cover: picture_id, no_feed_story: 'true'})
   end
 
-  # Post a clickable link to a users feed (works for youtube videos as well)  
-  # link: the link (beginning with http:// or https://) that will be displayed in the users feed  
-  # message: the message to be posted with the link on the feed page  
+  # Post a clickable link to a users feed (works for youtube videos as well)
+  # link: the link (beginning with http:// or https://) that will be displayed in the users feed
+  # message: the message to be posted with the link on the feed page
   def post_link(link, message)
     post_request('/me/feed', {link: link, message: message})
   end
 
   # Post a reply to a status that is already existing on facebook
-  # status_id: the facebook id of the status to reply to  
-  # message: the message to use in the reply  
+  # status_id: the facebook id of the status to reply to
+  # message: the message to use in the reply
   def reply_to_status(status_id, message)
     post_request('/' + status_id + '/comments', {message: message})
   end
 
-  # Delete a status  
-  # status_id: the facebook id of the status to delete  
+  # Delete a status
+  # status_id: the facebook id of the status to delete
   def delete_status(status_id)
     delete_request('/' + status_id)
   end
 
-  # Get statuses from facebook page/account  
+  # Get statuses from facebook page/account
   def get_statuses
     @statuses ||= get_request('/me/statuses')
     # I have no idea why sometimes it uses the data index and sometimes it doesn't....
@@ -89,7 +90,7 @@ class FBUtil
     end
   end
 
-  # Get the insights of a page (**this doesn't work for profiles**)  
+  # Get the insights of a page (**this doesn't work for profiles**)
   def get_insights
     @insights ||= get_request('/me/insights')
     begin
@@ -175,6 +176,65 @@ class FBUtil
 
   # These are the methods that don't need to be called with an instanciated class because they don't need an access token
   class << self
+    # This method will generate the appropriate redirect for dialog oauth calls
+    # app_id: your app id from the facebook developer application
+    # redirect_uri: the uri that you want facebook to redirect to after the user authorizes your app (you can pass get variables in this if you need to pass variables back to your application i.e. http://example.com/auth?client_id=1)
+    # scope: comma seperate list of permissions your application is requesting (https://developers.facebook.com/docs/authentication/permissions/)
+    def generate_oauth_redirect(app_id, redirect_uri, scope)
+      return "https://www.facebook.com/dialog/oauth?client_id=" + app_id.to_s + "&redirect_uri=" + CGI.escape(redirect_uri.to_s) + '&scope=' + scope.to_s
+    end
+
+    # This method will get a long term access token. If you are getting the access_token for a facebook profile this will be valid for 60 days. If you are getting the access_token for a facebook page it be permanent.
+    # app_id: your app id assigned from facebook
+    # app_secret: your app secret assigned from facebook
+    # redirect_uri: A valid redirect uri is required to get access_tokens. You will not be redirected to this uri
+    # code: the code sent back from facebook after the user has authorized your application (generate_oauth_redirect will redirect back to your requested uri with the code needed)
+    def get_long_access_token(app_id, app_secret, redirect_uri, code)
+      begin
+        agent = Mechanize.new
+        short_access_page = agent.get("https://graph.facebook.com/oauth/access_token?client_id=#{app_id}&client_secret=#{app_secret}&redirect_uri=#{redirect_uri}&code=" + code)
+        short_access_token = short_access_page.body.split('&')[0].split('=')[1]
+        # This is where we convert the short access token into a long access token
+        long_token_page = agent.get("https://graph.facebook.com/oauth/access_token?client_id=#{app_id}&client_secret=#{app_secret}&grant_type=fb_exchange_token&fb_exchange_token=#{short_access_token}")
+        return {'access_token' => long_token_page.body.split('=')[1]}
+      rescue Mechanize::ResponseCodeError => e
+        raise FBUtilError.new(e.response_code, e.page.body)
+      end
+    end
+
+    # If you already have a short term access token this method will exchange that for a long term access token. 60 days for user accounts and indefinitely for profile pages
+    # short_access_token: the access token already assigned to the account. It must be a valid, non-expired access token
+    # app_id: your app id assigned from facebook
+    # app_secret: your app secret assigned from facebook
+    def get_long_from_short_access_token(short_access_token, app_id, app_secret)
+      begin
+        agent = Mechanize.new
+        long_token_page = agent.get("https://graph.facebook.com/oauth/access_token?client_id=#{app_id}&client_secret=#{app_secret}&grant_type=fb_exchange_token&fb_exchange_token=#{short_access_token}")
+        return {'access_token' => long_token_page.body.split('=')[1]}
+      rescue Mechanize::ResponseCodeError => e
+        raise FBUtilError.new(e.response_code, e.page.body)
+      end
+    end
+
+    # This method will get a short term access token for your application. Generally (1 - 2 hours)
+    # app_id: your app id assigned from facebook
+    # app_secret: your app secret assigned from facebook
+    # redirect_uri: A valid redirect uri is required to get access_tokens. You will not be redirected to this uri
+    # code: the code sent back from facebook after the user has authorized your application (generate_oauth_redirect will redirect back to your requested uri with the code needed)
+    def get_short_access_token(app_id, app_secret, redirect_uri, code)
+      begin
+        agent = Mechanize.new
+        short_access_page = agent.get("https://graph.facebook.com/oauth/access_token?client_id=#{app_id}&client_secret=#{app_secret}&redirect_uri=#{redirect_uri}&code=" + code)
+        if short_access_page.body.include?('expires')
+          return {'access_token' => short_access_page.body.split('&')[0].split('=')[1], 'expires' => short_access_page.body.split('&')[1].split('=')[1]}
+        else
+          return {'access_token' => short_access_page.body.split('=')[1]}
+        end
+      rescue Mechanize::ResponseCodeError => e
+        raise FBUtilError.new(e.response_code, e.page.body)
+      end
+    end
+
     # This method will parse out a signed request using all the necessary validation required to find out if a facebook request is completely valid
     # signed_request: the signed request passed in by facebook
     # application_secret: the application secret assigned to your application form facebook
@@ -189,9 +249,9 @@ class FBUtil
       elsif json['issued_at'] < Time.now.to_i - max_age
         raise 'Signed request too old.'
       elsif base64_url_decode(encoded_signature) != OpenSSL::HMAC.hexdigest('sha256', application_secret, encoded_json).split.pack('H*')
-        raise 'Invalid signature.' 
+        raise 'Invalid signature.'
       end
-      
+
       return json
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fb_util
 version: !ruby/object:Gem::Version
-  version: 0.0.7.1
+  version: '0.9'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-18 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -28,13 +28,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.3'
 description: A quick utility class to work with the facebook graph api and misc facebook
-  functions
+  functions, will be version 1 as soon as I figure out tests for this.
 email: brennon@fritzandandre.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/fb_util.rb
+- lib/fb_util/fb_util_error.rb
 homepage: https://github.com/jbrennon/fb_util
 licenses: []
 post_install_message: