fgraph 0.1.5 → 0.2.0

data/History

@@ -1,3 +1,8 @@
+v0.2.0 - May 26, 2010
+  * Rails plugin support
+  * Add FGraph::Collection response object
+  * Allow Hash object as id input
+  
 v0.1.5 - May 25, 2010
   * Fix FGraph::Client not passing default :access_token options properly
   

data/README.rdoc

@@ -9,7 +9,26 @@ Facebook Graph Ruby API implementation with Ruby magic (http://graph.facebook.co
 == Installation
 
   sudo gem install fgraph
+    
+== Rails Plugin Installation
+
+Gem Plugin installation:
+
+  sudo gem install fgraph
 
+  # Edit [RAILS_ROOT]/config/environment.rb
+  config.gem 'fgraph', :version => ">=0.2.0"
+  
+  # Edit [RAILS_ROOT]/Rakefile
+  require 'tasks/fgraph'
+  
+  # Create fgraph.yml config in [RAILS_ROOT]/config
+  rake fgraph:setup
+  
+Normal Plugin Installation:
+
+  script/plugin install http://github.com/jugend/fgraph.git
+  
 === Facebook Graph Cheat Sheet
 
   sudo gem install cheat
@@ -29,6 +48,10 @@ Facebook Graph Ruby API implementation with Ruby magic (http://graph.facebook.co
   # Page photos
   FGraph.object('/cocacola/photos')
   FGraph.object_photos('cocacola')
+  
+  # Passing object hash as id
+  friend = { 'name' => 'Mark Zuckerberg', 'id' => '4'}
+  friend_details = FGraph.object(friend)
 
   # Current user: https://graph.facebook.com/me?access_token=...
   FGraph.me(:access_token => '...')
@@ -40,11 +63,27 @@ Facebook Graph Ruby API implementation with Ruby magic (http://graph.facebook.co
 === Multiple objects query
 
   # Multiple users select: https://graph.facebook.com?ids=arjun,vernal
-  FGraph.objects('arjun', 'vernel')
+  FGraph.objects('arjun', 'herryanto')
 
   # Filter fields: https://graph.facebook.com?ids=arjun,vernal&fields=id,name,picture
-  FGraph.objects('arjun', 'vernel', :fields => 'id,name,picture')
+  FGraph.objects('arjun', 'herryanto', :fields => 'id,name,picture')
+  
+  # Passing hash objects
+  FGraph.objects([{:name => 'Arjun Banker', :id => 'arjun'}, {:name => 'Herryanto Siatono', :id => 'herryanto'}])
 
+=== Collection Response
+  
+  friends = FGraph.me_friends(:limit => 5, :access_token => '...')
+  friends.each do |friend|
+    puts friend['name']
+    puts friend['id']
+  end
+  
+  # Other convenient methods
+  friends.next?
+  friends.next_url
+  friends.next_options
+  
 === OAuth
 
 OAuth authorization URL:
@@ -115,13 +154,51 @@ OAuth Application Access Token, required to access application anlytics data:
   fg_client = FGraph::Client.new(:access_token => '...')
   fg_client.me
   fg.client.publish_feed('herryanto', :message => 'Cool!')
-  
+
 === Pagination Options
 
 * <tt>limit</tt> - max no of records
 * <tt>offset</tt> - offset
 * <tt>until</tt> - since (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
 
+=== Rails Helper
+
+Sample codes:
+
+  <%= fgraph_javascript_init_tag %>
+  <script type="text/javascript">
+    FB.Event.subscribe('auth.sessionChange', function(response) {
+      if (response.session) {
+        // A user has logged in, and a new cookie has been saved
+      } else {
+        // The user has logged out, and the cookie has been cleared
+      }
+    });
+  </script>
+  
+  <!-- Facebook Login Button -->
+  <fb:login-button autologoutlink="true" perms="email,publish_stream"></fb:login-button>
+  
+  <% if fgraph_logged_in? %>
+    <br>Hello <%= fgraph_current_user['name'] %>,
+    <br><%= fgraph_image_tag(fgraph_current_user, 'large') %>
+  <% end %>
+
+For Asynchronous load, use <tt>window.afterFbAsyncInit</tt>:
+
+  <%= fgraph_javascript_init_tag :async => true %>
+  <script type="text/javascript">
+    window.afterFbAsyncInit = function() {
+      FB.Event.subscribe('auth.sessionChange', function(response) {
+        if (response.session) {
+          // A user has logged in, and a new cookie has been saved
+        } else {
+          // The user has logged out, and the cookie has been cleared
+        }
+      });
+    }
+  </script>
+  
 == License
 
 (The MIT License)

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.email = "herryanto@gmail.com"
     gem.homepage = "http://github.com/jugend/fgraph"
     gem.authors = ["Herryanto Siatono"]
-    gem.files = FileList["[A-Z]*", "{examples,lib,test}/**/*"]
+    gem.files = FileList["[A-Z]*", "{examples,lib,test,rails,tasks,templates}/**/*"]
     
     gem.add_dependency("httparty", "~> 0.5.0")
     # gem.add_dependency("hashie", "~> 0.2.0")

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
-:patch: 5
+:patch: 0
 :major: 0
 :build: 
-:minor: 1
+:minor: 2

data/lib/fgraph/rails/fgraph_helper.rb

@@ -1,10 +1,13 @@
 module FGraph
   module Rails
 	  module FGraphHelper
+	    
+	    # Access FGraph.config initialized with values set in <tt>[RAILS_ROOT]/config/fgraph.yml</tt>.
 	    def fgraph_config
   		  FGraph.config || {}
   		end
-		
+
+		  # Return Facebook session, default to retrieve session from cookies
   		def fgraph_session(app_id = fgraph_config['app_id'], 
   		  app_secret = fgraph_config['app_secret'])
   			
@@ -12,6 +15,7 @@ module FGraph
   			@fgraph_session = fgraph_session_cookies(app_id, app_secret)
   		end
 		
+		  # Return Facebook_session cookies
   		def fgraph_session_cookies(app_id = fgraph_config['app_id'], 
   			app_secret = fgraph_config['app_secret'])
 			
@@ -60,10 +64,11 @@ module FGraph
   		  @fgraph_current_user = fgraph_client.me 
   		end
   		
+  		# Return FGraph::Client.instance initialized with settings set in <tt>fgraph.yml</tt>.
+  		# Initialized with <tt>:access_token</tt> as well if Facebook session exists.
   		def fgraph_client
   		  return @fgraph_client if @fgraph_client
-  		  session = fgraph_session || {}
-			
+  		  
   		  @fgraph_client = FGraph::Client.new(
   			 :client_id => fgraph_config['app_id'],
   			 :client_secret => fgraph_config['app_secret'],

data/lib/fgraph/rails/fgraph_tag_helper.rb

@@ -0,0 +1,90 @@
+module FGraph
+  module Rails
+    module FGraphTagHelper
+      def fgraph_javascript_include_tag
+        %{<script src="http://connect.facebook.net/en_US/all.js"></script>}
+      end
+      
+      # Inititalize XFBML Javascript include and initialization script.
+      #
+      # ==== Options
+      # * <tt>app_id</tt> - overrride Fgraph.config['app_id'] value.
+      # * <tt>async</tt> - asynchronous javascript include & initialization.
+      #   for other Facebook JS initialization codes please wrap under:
+      #
+      #   window.afterFbAsyncInit = function() {
+      #       ....
+      #   }
+      #
+      def fgraph_javascript_init_tag(options={})
+        options = { :app_id => FGraph.config['app_id'] }.merge(options || {})
+        
+        if options[:async]
+          %{
+            <div id="fb-root"></div>
+            <script>
+              window.fbAsyncInit = function() {
+                FB.init({appId: '#{options[:app_id]}', status: true, cookie: true,
+                         xfbml: true});
+                         
+                if (window.afterFbAsyncInit) {
+                  window.afterFbAsyncInit();
+                }
+              };
+              (function() {
+                var e = document.createElement('script'); e.async = true;
+                e.src = document.location.protocol +
+                  '//connect.facebook.net/en_US/all.js';
+                document.getElementById('fb-root').appendChild(e);
+              }());
+            </script>
+          }
+        else
+          tag = fgraph_javascript_include_tag
+          tag << %{
+            <div id="fb-root"></div>
+            <script>
+              FB.init({appId: '#{options[:app_id]}', status: true, cookie: true, xfbml: true});
+            </script>
+          }
+        end
+      end
+
+      # Return Facebook object picture url: http://graph.facebook.com/[id]/picture
+      #
+      # ==== Type Options
+      # * <tt>square</tt> - 50x50 (default)
+      # * <tt>small</tt> - 50 pixels wide, variable height
+      # * <tt>normal</tt> - 100 pixels wide, variable height
+      # * <tt>large</tt> - 200 pixels wide, variable height
+      #
+      def fgraph_picture_url(id, type=nil)
+        id = FGraph.get_id(id)
+        url = "http://graph.facebook.com/#{id}/picture"
+        url += "?type=#{type}" if type
+        url
+      end
+      
+      def fgraph_image_tag(id, type=nil, options={})
+        default_options = fgraph_image_options(type)
+        default_options[:alt] = id['name'] if id.is_a?(Hash)
+        image_tag(fgraph_picture_url(id, type), default_options.merge(options || {}))
+      end
+      
+      def fgraph_image_options(type)
+        case type
+          when 'square'
+            {:width => 50, :height => 50}
+          when 'small'
+            {:width => 50}
+          when 'normal'
+            {:width => 100}
+          when 'large'
+            {:width => 200}
+          else
+            {:width => 50, :height => 50}
+        end
+      end
+    end 
+  end
+end

data/lib/fgraph.rb

@@ -8,14 +8,6 @@ module FGraph
   base_uri 'https://graph.facebook.com'
   format :json
   
-  def self.config
-    @@config
-  end
-  
-  def self.config=(config)
-    @@config = config
-  end
-  
   # Facebook Error
   class FacebookError < StandardError
     attr_reader :data
@@ -31,299 +23,377 @@ module FGraph
   class OAuthError < FacebookError; end
   class OAuthAccessTokenError < OAuthError; end
   
-  # Single object query.
-  # 
-  #   # Users: https://graph.facebook.com/btaylor  (Bret Taylor)
-  #   FGraph.object('btaylor')
-  #
-  #   # Pages: https://graph.facebook.com/cocacola (Coca-Cola page)
-  #   FGraph.object('cocacola')
-  #
-  #   # Fields selection with metadata
-  #   FGraph.object('btaylor', :fields => 'id,name,picture', :metadata => 1)
+  # Collection objects for Graph response with array data.
   #
-  #   # Page photos
-  #   FGraph.object('/cocacola/photos')
-  #   FGraph.object_photos('cocacola')
-  #
-  def self.object(id, options={})
-    perform_get("/#{id}", options)
+  class Collection < Array 
+    attr_reader :next_url, :previous_url, :next_options, :previous_options
+    
+    # Initialize Facebook response object with 'data' array value.
+    def initialize(response)
+      return super unless response
+      
+      super(response['data'])
+      paging = response['paging'] || {}
+      self.next_url = paging['next']
+      self.previous_url = paging['previous']
+    end
+    
+    def next_url=(url)
+      @next_url = url
+      @next_options = self.url_options(url)
+    end
+    
+    def previous_url=(url)
+      @previous_url = url
+      @previous_options = self.url_options(url)
+    end
+    
+    def first?
+      @previous_url.blank? and not @next_url.blank?
+    end
+    
+    def next?
+      not @next_url.blank?
+    end
+    
+    def previous?
+      not @previous_url.blank?
+    end
+    
+    def url_options(url)
+      return unless url
+      
+      uri = URI.parse(url)
+      options = {}
+      uri.query.split('&').each do |param_set|
+         param_set = param_set.split('=')
+         options[param_set[0]] = CGI.unescape(param_set[1])
+      end
+      options
+    end
   end
   
-  # call-seq:
-  #   FGraph.objects(id, id)

-  #   FGraph.objects(id, id, options_hash)
-  #
-  # Multiple objects query.
-  # 
-  #   # Multiple users select: https://graph.facebook.com?ids=arjun,vernal
-  #   FGraph.objects('arjun', 'vernel')
-  #
-  #   # Filter fields: https://graph.facebook.com?ids=arjun,vernal&fields=id,name,picture
-  #   FGraph.objects('arjun', 'vernel', :fields => 'id,name,picture')
-  #
-  def self.objects(*args)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    options = options.merge(:ids => args.join(','))
-    perform_get("/", options)
-  end
+  class << self
+    attr_accessor :config
+    
+    # Single object query.
+    # 
+    #   # Users: https://graph.facebook.com/btaylor  (Bret Taylor)
+    #   FGraph.object('btaylor')
+    #
+    #   # Pages: https://graph.facebook.com/cocacola (Coca-Cola page)
+    #   FGraph.object('cocacola')
+    #
+    #   # Fields selection with metadata
+    #   FGraph.object('btaylor', :fields => 'id,name,picture', :metadata => 1)
+    #
+    #   # Page photos
+    #   FGraph.object('/cocacola/photos')
+    #   photos = FGraph.object_photos('cocacola')
+    #   
+    #   # Support id from object hash
+    #   friend = { 'name' => 'Mark Zuckerberg', 'id' => '4'}
+    #   friend_details = FGraph.object(friend)
+    def object(id, options={})
+      id = self.get_id(id)
+      perform_get("/#{id}", options)
+    end
   
-  # call-seq:
-  #   FGraph.me(category)

-  #   FGraph.me(category, options_hash)
-  # 
-  # Returns current user object details.
-  # 
-  # <tt>category</tt> - <tt>friends|home|feed|likes|movies|books|notes|photos|videos|events|groups</tt>
-  #
-  #   # Current user: https://graph.facebook.com/me?access_token=...
-  #   FGraph.me(:access_token => '...')
-  # 
-  #   # Current user's friends: https://graph.facebook.com/me/friends?access_token=...
-  #   FGraph.me('friends', :access_token => '...')
-  #   FGraph.me_friends(:access_token => '...')
-  #
-  def self.me(*args)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    category = args.shift
+    # call-seq:
+    #   FGraph.objects(id, id)

+    #   FGraph.objects(id, id, options_hash)
+    #
+    # Multiple objects query.
+    # 
+    #   # Multiple users select: https://graph.facebook.com?ids=arjun,vernal
+    #   FGraph.objects('arjun', 'vernel')
+    #
+    #   # Filter fields: https://graph.facebook.com?ids=arjun,vernal&fields=id,name,picture
+    #   FGraph.objects('arjun', 'vernel', :fields => 'id,name,picture')
+    #
+    def objects(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
     
-    path = "me"
-    path += "/#{category}" unless category.blank?
-    self.object(path, options)
-  end
+      # If first input before option is an array
+      if args.count == 1 and args.first.is_a?(Array)
+        args = args.first.map do |arg|
+          self.get_id(arg)
+        end
+      end
+    
+      options = options.merge(:ids => args.join(','))
+      perform_get("/", options)
+    end
   
-  # Request authorization from Facebok to fetch private data in the profile or permission to publish on a
-  # user's behalf. Returns Oauth Authorization URL, redirect to this URL to allow user to authorize your
-  # application from Facebook.
-  #
-  # <tt>client_id</tt> - Application ID
-  # <tt>redirect_uri</tt> - Needs to begin with your app's Connect URL. For instance, if your Connect URL 
-  # is http://www.example.com then your redirect URI could be http://www.example.com/oauth_redirect.
-  # <tt>scope (optional)</tt> -
-  #
-  # ==== Options
-  # * <tt>scope</tt> -  Extended permission required to fetch private data or request permision to 
-  # publish to Facebook on a user's behalf.
-  # * <tt>display</tt> - Other display type for authentication/authorization form, i.e. popup, touch.
-  #
-  #   # https://graph.facebook.com/oauth/authorize?
-  #   #   client_id=...&
-  #   #   redirect_uri=http://www.example.com/oauth_redirect&
-  #   #   scope=publish_stream
-  #
-  #   FGraph.oauth_authorize_url('[client id]', 'http://www.example.com/oauth_redirect', :scope => 
-  #     'publish_stream')
-  #
-  def self.oauth_authorize_url(client_id, redirect_uri, options={})
-    self.format_url('/oauth/authorize', {
-      :client_id => client_id,
-      :redirect_uri => redirect_uri
-    }.merge(options))
-  end
+    # call-seq:
+    #   FGraph.me(category)

+    #   FGraph.me(category, options_hash)
+    # 
+    # Returns current user object details.
+    # 
+    # <tt>category</tt> - <tt>friends|home|feed|likes|movies|books|notes|photos|videos|events|groups</tt>
+    #
+    #   # Current user: https://graph.facebook.com/me?access_token=...
+    #   FGraph.me(:access_token => '...')
+    # 
+    #   # Current user's friends: https://graph.facebook.com/me/friends?access_token=...
+    #   FGraph.me('friends', :access_token => '...')
+    #   FGraph.me_friends(:access_token => '...')
+    #
+    def me(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      category = args.shift
+    
+      path = "me"
+      path += "/#{category}" unless category.blank?
+      self.object(path, options)
+    end
   
-  # Return OAuth access_token. There are two types of access token, user access token and application 
-  # access token.
-  #
-  # User access_token requires <tt>code</tt> and and <tt>redirect_uri</tt> options. <tt>code</tt> is
-  # the autorization code appended as query string to redirect URI when accessing oauth authorization URL.
-  #
-  #   # https://graph.facebook.com/oauth/access_token?
-  #   #   client_id=...&
-  #   #   client_secret=...&
-  #   #   redirect_uri=http://www.example.com/oauth_redirect&
-  #   #   code=...
-  #   FGraph.oauth_access_token('[client id]', '[client secret]', 
-  #      :redirect_uri => ''http://www.example.com/oauth_redirect', 
-  #      :code => '[authorization code]')
-  #
-  # Application access token requires <tt>:type => 'client_cred'</td> option. Used to access application
-  # insights data.
-  #
-  #   # https://graph.facebook.com/oauth/access_token?
-  #   #   client_id=...&
-  #   #   client_secret=...&
-  #   #   type=client_cred
-  #   FGraph.oauth_access_token('[client id]', '[client secret]', :type => 'client_cred')
-  #
-  def self.oauth_access_token(client_id, client_secret, options={})
-    url = self.format_url('/oauth/access_token', {
-      :client_id => client_id,
-      :client_secret => client_secret
-    }.merge(options || {}))
+    # Request authorization from Facebok to fetch private data in the profile or permission to publish on a
+    # user's behalf. Returns Oauth Authorization URL, redirect to this URL to allow user to authorize your
+    # application from Facebook.
+    #
+    # <tt>client_id</tt> - Application ID
+    # <tt>redirect_uri</tt> - Needs to begin with your app's Connect URL. For instance, if your Connect URL 
+    # is http://www.example.com then your redirect URI could be http://www.example.com/oauth_redirect.
+    # <tt>scope (optional)</tt> -
+    #
+    # ==== Options
+    # * <tt>scope</tt> -  Extended permission required to fetch private data or request permision to 
+    # publish to Facebook on a user's behalf.
+    # * <tt>display</tt> - Other display type for authentication/authorization form, i.e. popup, touch.
+    #
+    #   # https://graph.facebook.com/oauth/authorize?
+    #   #   client_id=...&
+    #   #   redirect_uri=http://www.example.com/oauth_redirect&
+    #   #   scope=publish_stream
+    #
+    #   FGraph.oauth_authorize_url('[client id]', 'http://www.example.com/oauth_redirect', :scope => 
+    #     'publish_stream')
+    #
+    def oauth_authorize_url(client_id, redirect_uri, options={})
+      self.format_url('/oauth/authorize', {
+        :client_id => client_id,
+        :redirect_uri => redirect_uri
+      }.merge(options))
+    end
+  
+    # Return OAuth access_token. There are two types of access token, user access token and application 
+    # access token.
+    #
+    # User access_token requires <tt>code</tt> and and <tt>redirect_uri</tt> options. <tt>code</tt> is
+    # the autorization code appended as query string to redirect URI when accessing oauth authorization URL.
+    #
+    #   # https://graph.facebook.com/oauth/access_token?
+    #   #   client_id=...&
+    #   #   client_secret=...&
+    #   #   redirect_uri=http://www.example.com/oauth_redirect&
+    #   #   code=...
+    #   FGraph.oauth_access_token('[client id]', '[client secret]', 
+    #      :redirect_uri => ''http://www.example.com/oauth_redirect', 
+    #      :code => '[authorization code]')
+    #
+    # Application access token requires <tt>:type => 'client_cred'</td> option. Used to access application
+    # insights data.
+    #
+    #   # https://graph.facebook.com/oauth/access_token?
+    #   #   client_id=...&
+    #   #   client_secret=...&
+    #   #   type=client_cred
+    #   FGraph.oauth_access_token('[client id]', '[client secret]', :type => 'client_cred')
+    #
+    def oauth_access_token(client_id, client_secret, options={})
+      url = self.format_url('/oauth/access_token', {
+        :client_id => client_id,
+        :client_secret => client_secret
+      }.merge(options || {}))
     
-    response = self.perform_get(url)
-    response_hash = {}
-    response.split('&').each do |value|
-      value_pair = value.split('=')
-      response_hash[value_pair[0]] = value_pair[1]
+      response = self.perform_get(url)
+      response_hash = {}
+      response.split('&').each do |value|
+        value_pair = value.split('=')
+        response_hash[value_pair[0]] = value_pair[1]
+      end
+      response_hash
     end
-    response_hash
-  end
   
-  # Shortcut to retrieve application access token.
-  def self.oauth_app_access_token(client_id, client_secret)
-    self.oauth_access_token(client_id, client_secret, :type => 'client_cred')
-  end
+    # Shortcut to retrieve application access token.
+    def oauth_app_access_token(client_id, client_secret)
+      self.oauth_access_token(client_id, client_secret, :type => 'client_cred')
+    end
   
-  # Publish to Facebook, you would need to be authorized and provide access token.
-  #
-  #   # Post to user's feed.
-  #   #   curl -F 'access_token=...' \
-  #   #     -F 'message=Hello, Arjun. I like this new API.' \
-  #   #     https://graph.facebook.com/arjun/feed
-  #   FGraph.publish('arjun/feed', :message => 'Hello, Arjun. I like this new API.', 
-  #     :access_token => '...')
-  #   FGraph.publish_feed('arjun', :message => '...', :access_token => '...')
-  #   FGraph.publish_feed('me', ':message => '...', :access_token => '...')
-  #
-  # ==== Options
-  #
-  #   Method                Description                             Options
-  #   -------------------------------------------------------------------------------------
-  #   /PROFILE_ID/feed      write to the given profile's feed/wall  :message, :picture, 
-  #                                                                 :link, :name, description
-  #   /POST_ID/comments     comment on the given post               :message
-  #   /POST_ID/likes        like the given post                     none
-  #   /PROFILE_ID/notes     write a note on the given profile       :message, :subject
-  #   /PROFILE_ID/links     write a link on the given profile       :link, :message
-  #   /EVENT_ID/attending   attend the given event                  none
-  #   /EVENT_ID/maybe       maybe attend the given event            none
-  #   /EVENT_ID/declined    decline the given event                 none
-  # 
-  def self.publish(id, options={})
-    self.perform_post("/#{id}", options)
-  end
+    # Publish to Facebook, you would need to be authorized and provide access token.
+    #
+    #   # Post to user's feed.
+    #   #   curl -F 'access_token=...' \
+    #   #     -F 'message=Hello, Arjun. I like this new API.' \
+    #   #     https://graph.facebook.com/arjun/feed
+    #   FGraph.publish('arjun/feed', :message => 'Hello, Arjun. I like this new API.', 
+    #     :access_token => '...')
+    #   FGraph.publish_feed('arjun', :message => '...', :access_token => '...')
+    #   FGraph.publish_feed('me', ':message => '...', :access_token => '...')
+    #
+    # ==== Options
+    #
+    #   Method                Description                             Options
+    #   -------------------------------------------------------------------------------------
+    #   /PROFILE_ID/feed      write to the given profile's feed/wall  :message, :picture, 
+    #                                                                 :link, :name, description
+    #   /POST_ID/comments     comment on the given post               :message
+    #   /POST_ID/likes        like the given post                     none
+    #   /PROFILE_ID/notes     write a note on the given profile       :message, :subject
+    #   /PROFILE_ID/links     write a link on the given profile       :link, :message
+    #   /EVENT_ID/attending   attend the given event                  none
+    #   /EVENT_ID/maybe       maybe attend the given event            none
+    #   /EVENT_ID/declined    decline the given event                 none
+    # 
+    def publish(id, options={})
+      id = self.get_id(id)
+      self.perform_post("/#{id}", options)
+    end
   
-  # Delete objects in the graph.
-  #
-  #   # DELETE https://graph.facebook.com/ID?access_token=... HTTP/1.1
-  #   
-  #   FGraph.remove('[ID]')
-  #   FGraph.remove('[ID]/likes')
-  #   FGraph.remove_likes('[ID]')
-  #
-  def self.remove(id, options={})
-    self.perform_delete("/#{id}", options)
-  end
+    # Delete objects in the graph.
+    #
+    #   # DELETE https://graph.facebook.com/ID?access_token=... HTTP/1.1
+    #   
+    #   FGraph.remove('[ID]')
+    #   FGraph.remove('[ID]/likes')
+    #   FGraph.remove_likes('[ID]')
+    #
+    def remove(id, options={})
+      id = self.get_id(id)
+      self.perform_delete("/#{id}", options)
+    end
   
-  # Search over all public objects in the social graph.
-  # 
-  #   # https://graph.facebook.com/search?q=watermelon&type=post
-  #   FGraph.search('watermelon', :type => 'post')
-  #   FGraph.search_post('watermelon')
-  #
-  # ==== Options
-  # * <tt>type</tt> - <tt>album|event|group|link|note|page|photo|post|status|user|video</tt>
-  # * <tt>limit</tt> - max no of records
-  # * <tt>offset</tt> - offset
-  # * <tt>until</tt> - since (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
-  def self.search(query, options={})
-    self.perform_get("/search", {
-      :q => query
-    }.merge(options|| {}))
-  end
+    # Search over all public objects in the social graph.
+    # 
+    #   # https://graph.facebook.com/search?q=watermelon&type=post
+    #   FGraph.search('watermelon', :type => 'post')
+    #   FGraph.search_post('watermelon')
+    #
+    # ==== Options
+    # * <tt>type</tt> - <tt>album|event|group|link|note|page|photo|post|status|user|video</tt>
+    # * <tt>limit</tt> - max no of records
+    # * <tt>offset</tt> - offset
+    # * <tt>until</tt> - since (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
+    def search(query, options={})
+      self.perform_get("/search", {
+        :q => query
+      }.merge(options|| {}))
+    end
   
-  # Download insights data for your application.
-  #
-  #   # https://graph.facebook.com/[client_id]/insights?access_token=...
-  #   FGraph.insights('[client_id]', '[app_access_token]')
-  #
-  #   # https://graph.facebook.com/[client_id]/insights/application_api_call/day?access_token=...
-  #   FGraph.insights('[client_id]', '[app_access_token]', :metric_path => 'application_api_call/day')
-  # 
-  # ==== Options
-  # * <tt>metric_path</tt> - e.g. application_api_calls/day
-  # * <tt>since</tt> - since (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
-  # * <tt>until</tt> - until (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
-  def self.insights(client_id, app_access_token, options={})
-    metric_path = options.delete(:metric_path)
+    # Download insights data for your application.
+    #
+    #   # https://graph.facebook.com/[client_id]/insights?access_token=...
+    #   FGraph.insights('[client_id]', '[app_access_token]')
+    #
+    #   # https://graph.facebook.com/[client_id]/insights/application_api_call/day?access_token=...
+    #   FGraph.insights('[client_id]', '[app_access_token]', :metric_path => 'application_api_call/day')
+    # 
+    # ==== Options
+    # * <tt>metric_path</tt> - e.g. application_api_calls/day
+    # * <tt>since</tt> - since (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
+    # * <tt>until</tt> - until (a unix timestamp or any date accepted by strtotime, e.g. yesterday)
+    def insights(client_id, app_access_token, options={})
+      metric_path = options.delete(:metric_path)
     
-    path = "/#{client_id}/insights"
-    path += "/#{metric_path}" if metric_path
+      path = "/#{client_id}/insights"
+      path += "/#{metric_path}" if metric_path
       
-    self.perform_get(path, {
-      :access_token => app_access_token
-    }.merge(options || {}))
-  end
+      self.perform_get(path, {
+        :access_token => app_access_token
+      }.merge(options || {}))
+    end
   
-  def self.perform_get(uri, options = {})
-    handle_response(get(uri, {:query => options}))
-  end
+    def perform_get(uri, options = {})
+      handle_response(get(uri, {:query => options}))
+    end
   
-  def self.perform_post(uri, options = {})
-    handle_response(post(uri, {:body => options}))
-  end
+    def perform_post(uri, options = {})
+      handle_response(post(uri, {:body => options}))
+    end
   
-  def self.perform_delete(uri, options = {})
-    handle_response(delete(uri, {:body => options}))
-  end
+    def perform_delete(uri, options = {})
+      handle_response(delete(uri, {:body => options}))
+    end
   
-  def self.handle_response(response)
-    # Check for error
-    return response unless response['error']
-    
-    case response['error']['type']
-      when 'QueryParseException'
-        raise QueryParseError, response['error']
-      when 'GraphMethodException'
-        raise GraphMethodError, response['error']
-      when 'OAuthException'
-        raise OAuthError, response['error']
-      when 'OAuthAccessTokenException'
-        raise OAuthAccessTokenError, response['error']
+    def handle_response(response)
+      unless response['error']
+        return FGraph::Collection.new(response) if response['data']
+        response
       else
-        raise FacebookError, response['error']
+        case response['error']['type']
+          when 'QueryParseException'
+            raise QueryParseError, response['error']
+          when 'GraphMethodException'
+            raise GraphMethodError, response['error']
+          when 'OAuthException'
+            raise OAuthError, response['error']
+          when 'OAuthAccessTokenException'
+            raise OAuthAccessTokenError, response['error']
+          else
+            raise FacebookError, response['error']
+        end
+      end
     end
-  end
   
-  def self.format_url(path, options={})
-    url = self.base_uri.dup
-    url << path
-    unless options.blank?
-      url << "?"
+    def format_url(path, options={})
+      url = self.base_uri.dup
+      url << path
+      unless options.blank?
+        url << "?"
       
-      option_count = 0
+        option_count = 0
       
-      stringified_options = {}
-      options.each do |key, value|
-        stringified_options[key.to_s] = value
-      end
-      options = stringified_options
+        stringified_options = {}
+        options.each do |key, value|
+          stringified_options[key.to_s] = value
+        end
+        options = stringified_options
       
-      options.each do |option|
-        next if option[1].blank?
-        url << "&" if option_count > 0
-        url << "#{option[0]}=#{CGI.escape(option[1].to_s)}"
-        option_count += 1
+        options.each do |option|
+          next if option[1].blank?
+          url << "&" if option_count > 0
+          url << "#{option[0]}=#{CGI.escape(option[1].to_s)}"
+          option_count += 1
+        end
       end
+      url
     end
-    url
-  end
   
-  def self.method_missing(name, *args, &block)
-    names = name.to_s.split('_')
-    super unless names.length > 1
+    def method_missing(name, *args, &block)
+      names = name.to_s.split('_')
+      super unless names.length > 1
     
-    case names.shift
-      when 'object'
-        # object_photos
-        self.object("#{args[0]}/#{names[0]}", args[1])
-      when 'me'
-        # me_photos
-        self.me(names[0], args[0])
-      when 'publish'
-        # publish_feed(id)
-        self.publish("#{args[0]}/#{names[0]}", args[1])
-      when 'remove'
-        # remove_feed(id)
-        self.remove("#{args[0]}/#{names[0]}", args[1])
-      when 'search'
-        # search_user(query)
-        options = args[1] || {}
-        options[:type] = names[0]
-        self.search(args[0], options)
-      else
-        super
+      case names.shift
+        when 'object'
+          # object_photos
+          self.object("#{args[0]}/#{names[0]}", args[1])
+        when 'me'
+          # me_photos
+          self.me(names[0], args[0])
+        when 'publish'
+          # publish_feed(id)
+          self.publish("#{args[0]}/#{names[0]}", args[1])
+        when 'remove'
+          # remove_feed(id)
+          self.remove("#{args[0]}/#{names[0]}", args[1])
+        when 'search'
+          # search_user(query)
+          options = args[1] || {}
+          options[:type] = names[0]
+          self.search(args[0], options)
+        else
+          super
+      end
+    end
+  
+    # Return ID['id'] if ID is a hash object
+    #
+    def get_id(id)
+      return unless id
+      id = id['id'] if id.is_a?(Hash)
+      id
     end
   end
 end

data/lib/tasks/fgraph.rake

@@ -0,0 +1,15 @@
+require 'fileutils'
+
+namespace :fgraph do
+  desc "Create fgraph.yml configuration file in Rails config folder"
+  task :setup => :environment do
+    fgraph_config = File.join(RAILS_ROOT, "config", "fgraph.yml")
+    unless File.exist?(fgraph_config)
+      fgraph_config_template = File.join(RAILS_ROOT, "vendor", "plugins", "fgraph", "templates", "fgraph.yml")
+      FileUtils.cp fgraph_config_teirmplate, fgraph_config
+      puts "#{RAILS_ROOT}/config/fgraph.yml created, please update your app_id and app_secret."
+    else
+      puts "#{RAILS_ROOT}/config/fgraph.yml already exists."
+    end
+  end
+end

data/lib/tasks/fgraph.rb

@@ -0,0 +1 @@
+load 'tasks/fgraph.rake'

data/rails/init.rb

@@ -0,0 +1,15 @@
+require 'fgraph'
+require 'fgraph/rails/fgraph_helper'
+require 'fgraph/rails/fgraph_tag_helper'
+
+FGRAPH_CONFIG = "#{RAILS_ROOT}/config/fgraph.yml"
+
+# Load configuration file
+if File.exists?(FGRAPH_CONFIG)
+  fgraph_config = YAML.load(ERB.new(File.read(FGRAPH_CONFIG)).result)
+  FGraph.config = fgraph_config[RAILS_ENV]
+end
+
+ActionController::Base.send :include, FGraph::Rails::FGraphHelper
+ActionView::Base.send :include, FGraph::Rails::FGraphHelper
+ActionView::Base.send :include,  FGraph::Rails::FGraphTagHelper

data/rails/install.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'fileutil'
+
+fgraph_config = File.join(RAILS_ROOT, "config", "fgraph.yml")
+unless File.exist?(fgraph_config)
+  fgraph_config_template = File.join(RAILS_ROOT, "vendor", "plugins", "fgraph", "templates", "fgraph.yml")
+  FileUtils.cp fgraph_config_template, fgraph_config
+  puts "#{RAILS_ROOT}/config/fgraph.yml created, please update your app_id and app_secret."
+end

data/templates/fgraph.yml

@@ -0,0 +1,16 @@
+# FGraph Facebook Configuration File
+# 
+# Register your application to get your app_id and app_secret:
+# http://developers.facebook.com/setup/
+#
+development:
+  app_id:
+  app_secret:
+  
+test:
+  app_id:
+  app_secret:
+
+production:
+  app_id:
+  app_secret:

data/test/fgraph_test.rb

@@ -8,6 +8,20 @@ class FGraphTest < Test::Unit::TestCase
   FACEBOOK_OAUTH_ACCESS_TOKEN = "115187085478818|rDIv_5zgjCSM_fWBv5Z-lQr5gFk."
   FACEBOOK_OAUTH_APP_ACCESS_TOKEN = "112167085478818|rDIv_5zgjCSM_fWBv5Z-lQr5gFk."
   
+  context "FGraph.get_id" do
+    should "return 'id' if input 'id' is not a Hash" do
+      test_id = '123'
+      id = FGraph.get_id(test_id)
+      id.should == test_id
+    end
+    
+    should "return 'id' value from hash object if input 'id' is a Hash" do
+      test_id = { 'name' => 'Anthony', 'id' => '123' }
+      id = FGraph.get_id(test_id)
+      id.should == test_id['id']
+    end
+  end
+  
   context "FGraph.object" do
     should "return object hash" do
       stub_get('/cocacola', 'object_cocacola.json')
@@ -28,13 +42,29 @@ class FGraphTest < Test::Unit::TestCase
       FGraph.expects(:perform_get).with('/cocacola', options)
       FGraph.object('cocacola', options)
     end
+    
+    should "call FGraph.get_id" do
+      stub_get('/cocacola', 'object_cocacola.json')
+      FGraph.expects(:get_id).with('cocacola')
+      FGraph.expects(:perform_get)
+      object = FGraph.object('cocacola')
+    end
   end
   
   context "FGraph.objects" do
     should "call perform_get with ids and query options" do
       options = {:fields => 'id,name'}
-      FGraph.expects(:perform_get).with('/', options.merge(:ids => 'herry,john'))
-      FGraph.objects('herry', 'john', options)
+      FGraph.expects(:perform_get).with('/', options.merge(:ids => '1,2'))
+      FGraph.objects('1', '2', options)
+    end
+    
+    should "collect id values if input is an array of hash values" do
+      test_ids = [
+        { 'name' => 'Herry', 'id' => '1'},
+        { 'name' => 'John', 'id' => '2'}
+      ]
+      FGraph.expects(:perform_get).with('/', :ids => '1,2')
+      FGraph.objects(test_ids)
     end
   end
   
@@ -204,6 +234,28 @@ class FGraphTest < Test::Unit::TestCase
   end
   
   context "FGraph.handle_response" do
+    should "return response object if there's no error" do
+      fb_response = {'name' => 'test'}
+      response = FGraph.handle_response(fb_response)
+      response.should == fb_response
+    end
+    
+    should "convert to FGraph::Collection object if response contain 'data' value" do
+      fb_response = {
+        "data" => [
+          { "name" =>"Belle Clara", "id" => "100000133774483" },
+          { "name" =>"Rosemary Schapira", "id" => "100000237306697" }
+        ],
+        "paging" => {
+          "next" => "https://graph.facebook.com/756314021/friends?offset=4&limit=2&access_token=101507589896698"
+        }
+      }
+      
+      collection = FGraph.handle_response(fb_response)
+      collection.class.should == FGraph::Collection
+      collection.count.should == fb_response['data'].count
+    end
+    
     should "raise QueryParseError" do
       lambda do
         object = FGraph.handle_response(response_error('QueryParseException'))
@@ -229,6 +281,29 @@ class FGraphTest < Test::Unit::TestCase
     end
   end
   
+  context "FGraph::Collection" do
+    should "should convert response object to Collection" do
+      response = {
+        "data" => [
+          {"name"=>"Belle Clara", "id"=>"100000133774483"},
+          {"name"=>"Rosemary Schapira", "id"=>"100000237306697"}
+        ],
+        "paging"=> {
+          "previous"=> "https://graph.facebook.com/756314021/friends?offset=0&limit=2&access_token=101507589896698",
+          "next"=> "https://graph.facebook.com/756314021/friends?offset=4&limit=2&access_token=101507589896698"
+        }
+      }
+      
+      collection = FGraph::Collection.new(response)
+      collection.count.should == response['data'].count
+      collection.first.should == response['data'].first
+      collection.next_url.should == response['paging']['next']
+      collection.previous_url.should == response['paging']['previous']
+      collection.previous_options.should == {'offset' => '0', 'limit' => '2', 'access_token' => '101507589896698'}
+      collection.next_options.should == {'offset' => '4', 'limit' => '2', 'access_token' => '101507589896698'}
+    end
+  end
+  
   def response_error(type, msg=nil)
     {'error' => { 'type' => type, 'message' => msg}}
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 5
-  version: 0.1.5
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Herryanto Siatono
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-25 00:00:00 +08:00
+date: 2010-05-26 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,6 +107,11 @@ files:
 - lib/fgraph/client.rb
 - lib/fgraph/rails/fgraph_helper.rb
 - lib/fgraph/rails/fgraph_tag_helper.rb
+- lib/tasks/fgraph.rake
+- lib/tasks/fgraph.rb
+- rails/init.rb
+- rails/install.rb
+- templates/fgraph.yml
 - test/fgraph/client_test.rb
 - test/fgraph_test.rb
 - test/fixtures/access_token.txt