mmangino-facebooker 1.0.15 → 1.0.16

data/lib/facebooker/rails/helpers.rb

@@ -1,3 +1,4 @@
+require 'action_pack'
 module Facebooker
   module Rails
     
@@ -15,7 +16,11 @@ module Facebooker
       # cancel_button is true or false
       def fb_dialog( id, cancel_button, &block )
         content = capture(&block)
-        concat( content_tag("fb:dialog", content, {:id => id, :cancel_button => cancel_button}), block.binding )
+        if ignore_binding?
+          concat( content_tag("fb:dialog", content, {:id => id, :cancel_button => cancel_button}) )
+        else
+          concat( content_tag("fb:dialog", content, {:id => id, :cancel_button => cancel_button}), block.binding )
+        end
       end
       
       def fb_dialog_title( title )
@@ -23,8 +28,12 @@ module Facebooker
       end
       
       def fb_dialog_content( &block )
-        content = capture(&block)  
-        concat( content_tag("fb:dialog-content", content), block.binding )      
+        content = capture(&block)
+        if ignore_binding?
+          concat( content_tag("fb:dialog-content", content) )
+        else
+          concat( content_tag("fb:dialog-content", content), block.binding )
+        end
       end
       
       def fb_dialog_button( type, value, options={} )
@@ -52,27 +61,32 @@ module Facebooker
       #  <% end %>
       def fb_request_form(type,message_param,url,options={},&block)
         content = capture(&block)
-        message = @template.instance_variable_get("@content_for_#{message_param}") 
-        concat(content_tag("fb:request-form", content + token_tag,
-                  {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>message}.merge(options)),
-              block.binding)
+        message = @template.instance_variable_get("@content_for_#{message_param}")
+        if ignore_binding?
+          concat(content_tag("fb:request-form", content + token_tag,
+                    {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>message}.merge(options)))
+        else
+          concat(content_tag("fb:request-form", content + token_tag,
+                    {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>message}.merge(options)),
+                block.binding)
+        end
       end
 
-			# Create a submit button for an <fb:request-form>
-			# If the request is for an individual user you can optionally
-			# Provide the user and a label for the request button.
-			# For example
-			#   <% content_for("invite_user") do %>
-			#     This gets sent in the invite. <%= fb_req_choice("Come join us!",new_invite_path) %>
-			#   <% end %>
-			#   <% fb_request_form("Invite","invite_user",create_invite_path) do %>
-			#     Invite <%= fb_name(@facebook_user.friends.first.id)%> to the party <br />
-			#     <%= fb_request_form_submit(@facebook_user.friends.first.id,"Invite %n") %>
-			#   <% end %>
-			# <em>See:</em> http://wiki.developers.facebook.com/index.php/Fb:request-form-submit for options
-			def fb_request_form_submit(options={})
-			   tag("fb:request-form-submit",stringify_vals(options))
-			end                                              
+      # Create a submit button for an <fb:request-form>
+      # If the request is for an individual user you can optionally
+      # Provide the user and a label for the request button.
+      # For example
+      #   <% content_for("invite_user") do %>
+      #     This gets sent in the invite. <%= fb_req_choice("Come join us!",new_invite_path) %>
+      #   <% end %>
+      #   <% fb_request_form("Invite","invite_user",create_invite_path) do %>
+      #     Invite <%= fb_name(@facebook_user.friends.first.id)%> to the party <br />
+      #     <%= fb_request_form_submit(:uid => @facebook_user.friends.first.id, :label => "Invite %n") %>
+      #   <% end %>
+      # <em>See:</em> http://wiki.developers.facebook.com/index.php/Fb:request-form-submit for options
+      def fb_request_form_submit(options={})
+         tag("fb:request-form-submit",stringify_vals(options))
+      end                                              
 
 
       # Create an fb:request-form with an fb_multi_friend_selector inside
@@ -86,11 +100,18 @@ module Facebooker
       #  <% end %>
       def fb_multi_friend_request(type,friend_selector_message,url,&block)
         content = capture(&block)
-        concat(content_tag("fb:request-form",
-                            fb_multi_friend_selector(friend_selector_message) + token_tag,
-                            {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>content}
-                            ),
-              block.binding)
+        if ignore_binding?
+          concat(content_tag("fb:request-form",
+                              fb_multi_friend_selector(friend_selector_message) + token_tag,
+                              {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>content}
+                              ))
+        else
+          concat(content_tag("fb:request-form",
+                              fb_multi_friend_selector(friend_selector_message) + token_tag,
+                              {:action=>url,:method=>"post",:invite=>true,:type=>type,:content=>content}
+                              ),
+                block.binding)
+        end
       end
       
       # Render an <fb:friend-selector> element
@@ -130,45 +151,45 @@ module Facebooker
       def fb_req_choice(label,url)
         tag "fb:req-choice",:label=>label,:url=>url
       end
-     
-     # Create a facebook form using <fb:editor>
-     #
-     # It yields a form builder that will convert the standard rails form helpers 
-     # into the facebook specific version. 
-     #
-     # Example:
-     #  <% facebook_form_for(:poke,@poke,:url => create_poke_path) do |f| %>
-     #    <%= f.text_field :message, :label=>"message" %>
-     #    <%= f.buttons "Save Poke" %>
-     #  <% end %>
-     #
-     #  will generate
-     #
-     #  <fb:editor action="/pokes/create">
-     #    <fb:editor-text name="poke[message]" id="poke_message" value="" label="message" />
-     #    <fb:editor-buttonset>
-     #     <fb:editor-button label="Save Poke"
-     #    </fb:editor-buttonset>
-     #  </fb:editor>
+
+      # Create a facebook form using <fb:editor>
+      #
+      # It yields a form builder that will convert the standard rails form helpers 
+      # into the facebook specific version. 
+      #
+      # Example:
+      #  <% facebook_form_for(:poke,@poke,:url => create_poke_path) do |f| %>
+      #    <%= f.text_field :message, :label=>"message" %>
+      #    <%= f.buttons "Save Poke" %>
+      #  <% end %>
+      #
+      #  will generate
+      #
+      #  <fb:editor action="/pokes/create">
+      #    <fb:editor-text name="poke[message]" id="poke_message" value="" label="message" />
+      #    <fb:editor-buttonset>
+      #     <fb:editor-button label="Save Poke"
+      #    </fb:editor-buttonset>
+      #  </fb:editor>
      def facebook_form_for( record_or_name_or_array,*args, &proc)
 
        raise ArgumentError, "Missing block" unless block_given?
        options = args.last.is_a?(Hash) ? args.pop : {}
 
-       case record_or_name_or_array
-       when String, Symbol
-         object_name = record_or_name_or_array
-       when Array
-         object = record_or_name_or_array.last
-         object_name = ActionController::RecordIdentifier.singular_class_name(object)
-         apply_form_for_options!(record_or_name_or_array, options)
-         args.unshift object
-       else
-         object = record_or_name_or_array
-         object_name = ActionController::RecordIdentifier.singular_class_name(object)
-         apply_form_for_options!([object], options)
-         args.unshift object
-       end
+        case record_or_name_or_array
+        when String, Symbol
+          object_name = record_or_name_or_array
+        when Array
+          object = record_or_name_or_array.last
+          object_name = ActionController::RecordIdentifier.singular_class_name(object)
+          apply_form_for_options!(record_or_name_or_array, options)
+          args.unshift object
+        else
+          object = record_or_name_or_array
+          object_name = ActionController::RecordIdentifier.singular_class_name(object)
+          apply_form_for_options!([object], options)
+          args.unshift object
+        end
         method = (options[:html]||{})[:method]
         options[:builder] ||= Facebooker::Rails::FacebookFormBuilder
         editor_options={}
@@ -180,12 +201,20 @@ module Facebooker
         width=options.delete(:labelwidth)
         editor_options[:labelwidth]=width unless width.blank?
 
-        concat(tag("fb:editor",editor_options,true) , proc.binding)
-        concat(tag(:input,{:type=>"hidden",:name=>:_method, :value=>method},false), proc.binding) unless method.blank?
-        concat(token_tag, proc.binding)
-        fields_for( object_name,*(args << options), &proc)
-        concat("</fb:editor>",proc.binding)
-      end
+        if ignore_binding?
+          concat(tag("fb:editor",editor_options,true))
+          concat(tag(:input,{:type=>"hidden",:name=>:_method, :value=>method},false)) unless method.blank?
+          concat(token_tag)
+          fields_for( object_name,*(args << options), &proc)
+          concat("</fb:editor>")
+        else
+          concat(tag("fb:editor",editor_options,true) , proc.binding)
+          concat(tag(:input,{:type=>"hidden",:name=>:_method, :value=>method},false), proc.binding) unless method.blank?
+          concat(token_tag, proc.binding)
+          fields_for( object_name,*(args << options), &proc)
+          concat("</fb:editor>",proc.binding)
+        end
+    end
       
       # Render an fb:name tag for the given user
       # This renders the name of the user specified.  You can use this tag as both subject and object of 
@@ -284,17 +313,21 @@ module Facebooker
       VALID_FB_SHARED_PHOTO_SIZES = [:thumb, :small, :normal, :square]
       VALID_FB_PHOTO_SIZES = VALID_FB_SHARED_PHOTO_SIZES      
       VALID_FB_PROFILE_PIC_SIZES = VALID_FB_SHARED_PHOTO_SIZES
-      VALID_PERMISSIONS=[:email, :offline_access, :status_update, :photo_upload, :create_listing, :create_event, :rsvp_event, :sms]
+      VALID_PERMISSIONS=[:email, :offline_access, :status_update, :photo_upload, :create_listing, :create_event, :rsvp_event, :sms, :video_upload]
       
       # Render an fb:tabs tag containing some number of fb:tab_item tags.
       # Example:
-      # <% fb_tabs do %>  
-	 		 #  	   <%= fb_tab_item("Home", "home") %>  
-	 		 # 			 <%= fb_tab_item("Office", "office") %>  
-	 		 # <% end %>        
+      # <% fb_tabs do %>
+      #   <%= fb_tab_item("Home", "home") %>
+      #   <%= fb_tab_item("Office", "office") %>
+      # <% end %>        
       def fb_tabs(&block)
-        content = capture(&block)  	
-        concat(content_tag("fb:tabs", content), block.binding)
+        content = capture(&block)
+        if ignore_binding?
+          concat(content_tag("fb:tabs", content))
+        else
+          concat(content_tag("fb:tabs", content), block.binding)
+        end
       end
       
       # Render an fb:tab_item tag. 
@@ -304,7 +337,7 @@ module Facebooker
       def fb_tab_item(title, url, options={})
         options= options.dup
         options.assert_valid_keys(FB_TAB_ITEM_VALID_OPTION_KEYS)
-        options.merge!(:title => title, :href => url)  	
+        options.merge!(:title => title, :href => url)    
         validate_fb_tab_item_align_value(options)
         tag("fb:tab-item", stringify_vals(options))
       end
@@ -313,13 +346,13 @@ module Facebooker
 
       def validate_fb_tab_item_align_value(options)
         if options.has_key?(:align) && !VALID_FB_TAB_ITEM_ALIGN_VALUES.include?(options[:align].to_sym)
-          raise(ArgumentError, "Unkown value for align: #{options[:align]}")
+          raise(ArgumentError, "Unknown value for align: #{options[:align]}")
         end
       end
       
       def validate_fb_photo_align_value(options)
         if options.has_key?(:align) && !VALID_FB_PHOTO_ALIGN_VALUES.include?(options[:align].to_sym)
-          raise(ArgumentError, "Unkown value for align: #{options[:align]}")
+          raise(ArgumentError, "Unknown value for align: #{options[:align]}")
         end
       end
       
@@ -336,8 +369,12 @@ module Facebooker
       #     <%= fb_wall_post(@otheruser,"This is another message") %>
       #   <% end %>
       def fb_wall(&proc)
-        content = capture(&proc)  	
-        concat(content_tag("fb:wall",content,{}),proc.binding)
+        content = capture(&proc)
+        if ignore_binding?
+          concat(content_tag("fb:wall",content,{}))
+        else
+          concat(content_tag("fb:wall",content,{}),proc.binding)
+        end
       end
       
       # Render an <fb:wallpost> tag
@@ -396,8 +433,12 @@ module Facebooker
       #   <% end %>
       def fb_dashboard(&proc)
         if block_given?
-          content = capture(&proc)  	
-          concat(content_tag("fb:dashboard",content,{}),proc.binding)
+          content = capture(&proc)
+          if ignore_binding?
+            concat(content_tag("fb:dashboard",content,{}))
+          else
+            concat(content_tag("fb:dashboard",content,{}),proc.binding)
+          end
         else
           content_tag("fb:dashboard",content,{})
         end
@@ -406,13 +447,21 @@ module Facebooker
       # Content for the wide profile box goes in this tag
       def fb_wide(&proc)
         content = capture(&proc)
-        concat(content_tag("fb:wide", content, {}), proc.binding)
+        if ignore_binding?
+          concat(content_tag("fb:wide", content, {}))
+        else
+          concat(content_tag("fb:wide", content, {}), proc.binding)
+        end
       end
 
       # Content for the narrow profile box goes in this tag
       def fb_narrow(&proc)
         content = capture(&proc)
-        concat(content_tag("fb:narrow", content, {}), proc.binding)
+        if ignore_binding?
+          concat(content_tag("fb:narrow", content, {}))
+        else
+          concat(content_tag("fb:narrow", content, {}), proc.binding)
+        end
       end
 
       # Renders an action using the <fb:action> tag
@@ -428,27 +477,27 @@ module Facebooker
 
       # Render a <fb:create-button> tag
       # For use inside <fb:dashboard>
-			def fb_create_button(name, url)
-			 	"<fb:create-button href=\"#{url_for(url)}\">#{name}</fb:create-button>"
-			end
-			
-			# Create a comment area
-			# All the data for this content area is stored on the facebook servers.
-			# <em>See:</em> http://wiki.developers.facebook.com/index.php/Fb:comments for full details 
-			def fb_comments(xid,canpost=true,candelete=false,numposts=5,options={})
-			  options = options.dup
+      def fb_create_button(name, url)
+         "<fb:create-button href=\"#{url_for(url)}\">#{name}</fb:create-button>"
+      end
+      
+      # Create a comment area
+      # All the data for this content area is stored on the facebook servers.
+      # <em>See:</em> http://wiki.developers.facebook.com/index.php/Fb:comments for full details 
+      def fb_comments(xid,canpost=true,candelete=false,numposts=5,options={})
+        options = options.dup
                           title = (title = options.delete(:title)) ? fb_title(title) : nil 
-			  content_tag "fb:comments",title,stringify_vals(options.merge(:xid=>xid,:canpost=>canpost.to_s,:candelete=>candelete.to_s,:numposts=>numposts))
-			end
-			
-			# Adds a title to the title bar
-			#
-			# Facebook | App Name | This is the canvas page window title
-			#
+        content_tag "fb:comments",title,stringify_vals(options.merge(:xid=>xid,:canpost=>canpost.to_s,:candelete=>candelete.to_s,:numposts=>numposts))
+      end
+      
+      # Adds a title to the title bar
+      #
+      # Facebook | App Name | This is the canvas page window title
+      #
       # +title+: This is the canvas page window 
-			def fb_title(title)
-			 "<fb:title>#{title}</fb:title>"
-			end
+      def fb_title(title)
+       "<fb:title>#{title}</fb:title>"
+      end
       
       # Create a Google Analytics tag
       # 
@@ -463,16 +512,20 @@ module Facebooker
       # Use fb_if_user_has_added_app to determine wether the user has added the app.
       # Example: 
       # <% fb_if_is_app_user(@facebook_user) do %>
-      # 			  Thanks for accepting our terms of service!
-      # 			<% fb_else do %>
-      # 			  Hey you haven't agreed to our terms.  <%= link_to("Please accept our terms of service.", :action => "terms_of_service") %>
-      # 			<% end %>
+      #         Thanks for accepting our terms of service!
+      #       <% fb_else do %>
+      #         Hey you haven't agreed to our terms.  <%= link_to("Please accept our terms of service.", :action => "terms_of_service") %>
+      #       <% end %>
       #<% end %>       
       def fb_if_is_app_user(user=nil,options={},&proc)
         content = capture(&proc) 
         options = options.dup
         options.merge!(:uid=>cast_to_facebook_id(user)) if user
-        concat(content_tag("fb:if-is-app-user",content,stringify_vals(options)),proc.binding)
+        if ignore_binding?
+          concat(content_tag("fb:if-is-app-user",content,stringify_vals(options)))
+        else
+          concat(content_tag("fb:if-is-app-user",content,stringify_vals(options)),proc.binding)
+        end
       end
 
       # Render if-user-has-added-app tag
@@ -480,15 +533,19 @@ module Facebooker
       #
       # Example: 
       # <% fb_if_user_has_added_app(@facebook_user) do %>
-      # 			  Hey you are an app user!
-      # 			<% fb_else do %>
-      # 			  Hey you aren't an app user.  <%= link_to("Add App and see the other side.", :action => "added_app") %>
-      # 			<% end %>
+      #         Hey you are an app user!
+      #       <% fb_else do %>
+      #         Hey you aren't an app user.  <%= link_to("Add App and see the other side.", :action => "added_app") %>
+      #       <% end %>
       #<% end %>       
       def fb_if_user_has_added_app(user,options={},&proc)
         content = capture(&proc) 
         options = options.dup
-        concat(content_tag("fb:if-user-has-added-app",content,stringify_vals(options.merge(:uid=>cast_to_facebook_id(user)))),proc.binding)
+        if ignore_binding?
+          concat(content_tag("fb:if-user-has-added-app", content, stringify_vals(options.merge(:uid=>cast_to_facebook_id(user)))))
+        else
+          concat(content_tag("fb:if-user-has-added-app", content, stringify_vals(options.merge(:uid=>cast_to_facebook_id(user)))),proc.binding)
+        end
       end
       
       # Render fb:if-is-user tag
@@ -496,24 +553,32 @@ module Facebooker
       # user can be a single user or an Array of users
       # Example:
       # <% fb_if_is_user(@check_user) do %>
-      # 			     <%= fb_name(@facebook_user) %> are one of the users. <%= link_to("Check the other side", :action => "friend") %>
-      # 			<% fb_else do %>
-      # 			  <%= fb_name(@facebook_user) %>  are not one of the users  <%= fb_name(@check_user) %>
-      # 			    <%= link_to("Check the other side", :action => "you") %>
-      # 			<% end %>
+      #            <%= fb_name(@facebook_user) %> are one of the users. <%= link_to("Check the other side", :action => "friend") %>
+      #       <% fb_else do %>
+      #         <%= fb_name(@facebook_user) %>  are not one of the users  <%= fb_name(@check_user) %>
+      #           <%= link_to("Check the other side", :action => "you") %>
+      #       <% end %>
       # <% end %>             
       def fb_if_is_user(user,&proc)
         content = capture(&proc) 
         user = [user] unless user.is_a? Array
         user_list=user.map{|u| cast_to_facebook_id(u)}.join(",")
-        concat(content_tag("fb:if-is-user",content,{:uid=>user_list}),proc.binding)
+        if ignore_binding?
+          concat(content_tag("fb:if-is-user",content,{:uid=>user_list}))
+        else
+          concat(content_tag("fb:if-is-user",content,{:uid=>user_list}),proc.binding)
+        end
       end
       
       # Render fb:else tag
       # Must be used within if block such as fb_if_is_user or fb_if_is_app_user . See example in fb_if_is_app_user
       def fb_else(&proc)
-        content = capture(&proc) 
-        concat(content_tag("fb:else",content),proc.binding)
+        content = capture(&proc)
+        if ignore_binding?
+          concat(content_tag("fb:else",content))
+        else
+          concat(content_tag("fb:else",content),proc.binding)
+        end
       end
       
       #
@@ -559,6 +624,7 @@ module Facebooker
       #   * offline_access
       #   * status_update
       #   * photo_upload
+      #   * video_upload
       #   * create_listing
       #   * create_event
       #   * rsvp_event
@@ -610,6 +676,17 @@ module Facebooker
         concat(content_tag("fb:container",inner,options),&proc.binding)
       end
       
+      # Renders an fb:time element
+      # 
+      # Example:
+      # <%= fb_time(Time.now, :tz => 'America/New York', :preposition => true) %>
+      #
+      # See http://wiki.developers.facebook.com/index.php/Fb:time for 
+      # more details
+      def fb_time(time, options={})
+        tag "fb:time",stringify_vals({:t => time.to_i}.merge(options))
+      end
+      
       protected
       
       def cast_to_facebook_id(object)
@@ -618,13 +695,13 @@ module Facebooker
       
       def validate_fb_profile_pic_size(options)
         if options.has_key?(:size) && !VALID_FB_PROFILE_PIC_SIZES.include?(options[:size].to_sym)
-          raise(ArgumentError, "Unkown value for size: #{options[:size]}")
+          raise(ArgumentError, "Unknown value for size: #{options[:size]}")
         end
       end
 
       def validate_fb_photo_size(options)
         if options.has_key?(:size) && !VALID_FB_PHOTO_SIZES.include?(options[:size].to_sym)
-          raise(ArgumentError, "Unkown value for size: #{options[:size]}")
+          raise(ArgumentError, "Unknown value for size: #{options[:size]}")
         end
       end
       
@@ -652,6 +729,10 @@ module Facebooker
           tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token)
         end
       end
+
+      def ignore_binding?
+        ActionPack::VERSION::MAJOR >= 2 && ActionPack::VERSION::MINOR >= 2
+      end
     end
   end
 end