tiny_fb_graph 0.1.1

data/lib/tiny_fb_graph.rb

@@ -0,0 +1,144 @@
+require 'rest_client'
+require 'json'
+
+module TinyFB
+  API_URL = 'https://graph.facebook.com/'
+  
+  # Returns the Facebook Login URL
+  #
+  # This method handles the first step of the authorization process
+  # After Clicking on that Link, the user
+  # will authenticate and/or authorize your application
+  # on the Facebook website
+  #
+  # He will be then redirected to your site with a code ( in a query parameter )
+  # the access_token method will then use that code to request the access token
+  # 
+  # === parameters
+  # * client_id : Your Facebook Application ID
+  # * redirect_uri : The url of the page the user will be redirected to, meaning
+  #   the page of your site that will get the code query paramater and use it to ask for the access_token
+  # * scope (optional ) : a string made of comma separated extended permissions, ex: "publish_stream,offline_access"
+  #
+  # === example
+  #  TinyFB.login_url(112233445566778,"http://localhost:3000")
+  #  => "https://graph.facebook.com/oauth/authorize?client_id=112233445566778&redirect_uri=http://localhost:3000"
+  def self.login_url(client_id,redirect_uri,scope = nil )
+    url = API_URL + 'oauth/authorize'
+    url << '?client_id=' + client_id.to_s
+    url << '&redirect_uri=' + URI.escape(redirect_uri)
+    url << '&scope=' + scope if scope
+    url
+  end
+
+  # Returns the access token ( in a hash value )
+  #
+  # This method handles the second step of the authorization process
+  # With the access code generated through the first step, we ask Facebook 
+  # for the access token
+  #
+  # === options
+  # * client_id : Your Facebook Application ID
+  # * redirect_uri : The url of the page the user will be redirected to, meaning
+  #   the page of your site that will receive the access token as a query parameter
+  # * secret : Your Facebook Application Secret
+  # * code : The code supplied by the first step
+  def self.access_token(client_id,redirect_uri,secret,code)
+    url = API_URL +  'oauth/access_token'
+    url << '?client_id=' + client_id.to_s
+    url << '&redirect_uri=' + URI.escape(redirect_uri)
+    url << '&client_secret=' + secret
+    url << '&code=' + URI.escape(code)
+    response = RestClient.get url
+    params = {}
+    params_array = response.split("&")
+    params_array.each do |param|
+        p = param.split("=")
+        params[p[0]] = p[1]
+    end
+    params
+  end
+
+
+  # Returns information from the Facebook Graph
+  #
+  # The raw_node returns the raw JSON response while the
+  # node returns a Ruby Hash
+  #
+  # === parameters 
+  # * path : the path to the desired node
+  # * token : the access token
+  # * params ( optional ) : additional parameters
+  #
+  # === example
+  #  TinyFB.node 'me',"xxxxxxxx"
+  #  => A Hash ( see the Facebook Graph API Documentation )
+  def self.node(path,token,params = {}) 
+    JSON.parse raw_node(path,token,params)
+  end
+  def self.raw_node(path,token,params = {})
+    params = params.merge! :access_token => token
+    response = RestClient.get API_URL + path, :params =>  params
+
+  rescue RestClient::Exception => ex
+            res_hash = JSON.parse(ex.http_body)
+            raise FaceBookError.new(ex.http_code, "#{res_hash["error"]["type"]}: #{res_hash["error"]["message"]}")
+  end
+
+  # Posts data to the Facebook Graph
+  #
+  # === parameters
+  # * path : the path you are publishing to
+  # * token : the access token
+  # * params ( optional ) : additional parameters
+  #
+  # === example
+  #  TinyFB.post "me/feed", "xxxx" , :message => "message"
+  def self.post(path,token,params ={})
+    params = params.merge! :access_token => token
+    response = RestClient.post API_URL + path, params
+    JSON.parse response
+
+  rescue RestClient::Exception => e
+            error_hash = JSON.parse(e.http_body)
+            raise FaceBookError.new(e.http_code, "#{error_hash["error"]["type"]}: #{error_hash["error"]["message"]}")
+  end
+
+  # Posts a file to the Facebook Graph
+  #
+  # Returns the Hash converted JSON response
+  #
+  # === parameters
+  # * path : the path to the node you want to post the file to
+  # * token : the access token
+  # * params ( optional ) : additional parameters
+  #
+  # === example
+  #  TinyFB.post "me/photos", "xxxx" ,"/path/to/image.jpg"
+  def self.post_file(path,token,file_path,params = {})
+    params = params.merge! :access_token => token,:source => File.new(file_path,'rb')
+    response = RestClient.post API_URL + path, params
+    JSON.parse response
+
+  rescue RestClient::Exception => e
+            error_hash = JSON.parse(e.http_body)
+            raise FaceBookError.new(e.http_code, "#{error_hash["error"]["type"]}: #{error_hash["error"]["message"]}")
+  end
+
+
+  # Exception Class
+  # 
+  # May be raised by node, raw_node, post and post_file
+  #
+  # You have to catch this exception in your code
+  class FaceBookError < StandardError
+      attr_accessor :code,:error_msg
+      # Error that happens during a facebook call.
+      def initialize(error_code, error_msg)
+          @code = error_code
+          @error_msg = error_msg
+          super("Facebook error #{error_code}: #{error_msg}")
+      end
+  end
+end
+

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: tiny_fb_graph
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Vinh CHUC
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: "Tiny library for the Facebook Graph API. This library provides several things : methods to handle the OAuth base authentification : generating the login url, retrieving the access_token . And methods, based on the rest-client gem, that allow you to retrieve/post data/files from the Facebook Graph. These methods may raise a custom exception in the API encounters errors."
+email: vinh.chuc@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/tiny_fb_graph.rb
+has_rdoc: true
+homepage: 
+licenses: 
+- http://creativecommons.org/licenses/by-nc-sa/3.0/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tiny library for the Facebook Graph API
+test_files: []
+