facebook-social_plugins 0.1.1 → 0.1.2

data/README.rdoc

@@ -92,6 +92,17 @@ The JavaScript SDK is available in all locales that are supported by Facebook. T
    }(document));
 </script>
 
+=== Configuration scripts*
+
+* fb_async_init_script(app_id, domain)
+* fb_channel_script(locale = :en_US)
+
+=== Login and Logout
+
+* fb_logout_and_reload(options = {:ready => false, :selector => '#fb_logout_and_reload'})
+* fb_login_and_reload(options = {:ready => false, :selector => '#fb_login_and_reload'})
+* fb_logout_and_redirect_to(path, options = {:ready => false})
+
 == Open Graph Meta helper
 
 Convenience method to generate all header/meta tags for Facebook Open Graph
@@ -114,6 +125,9 @@ Open graph <meta> tag helpers
 * fb_analytics(app_id) # Facebook analytics meta tag
 * fb_activity(namespace, action) # Open Graph action to perform
 
+* fb_logout(script) # setup FB event handler to trigger on FB logout
+* fb_logout_and_redirect_to(path) # setup FB event handler to trigger on FB logout and redirect
+
 == Social plugins
 
 Currently the following Social plugins are included in this gem
@@ -147,7 +161,15 @@ View methods exposed:
 * fb_send_button (options = {})
 * fb_subscribe_button (options = {})
 
-Note: You don't have to worry about dashed or underscored properties. Conversions will be handled automatically. The Facebook Social plugins API is (sadly) not very consistent when it comes to attribute names. 
+Note: You don't have to worry about dashed or underscored properties. Conversions will be handled automatically. The Facebook Social plugins API is (sadly) not very consistent when it comes to attribute names.
+
+Extras:
+
+* fb_logout_button(options = {}) # renders logout button (english only)
+
+Logout button options: 
+html: (html options for anchor tag)
+size: 'small' or 'large' (size of logout button img)
 
 === Facebook root
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/facebook-social_plugins.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "facebook-social_plugins"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
@@ -52,7 +52,9 @@ Gem::Specification.new do |s|
     "spec/facebook-social_plugins/script_helper_spec.rb",
     "spec/facebook-social_plugins/view_helper_spec.rb",
     "spec/spec_helper.rb",
-    "vendor/assets/html/facebook_channel.html"
+    "vendor/assets/html/facebook_channel.html",
+    "vendor/assets/images/fb_logout_large.gif",
+    "vendor/assets/images/fb_logout_small.gif"
   ]
   s.homepage = "http://github.com/kristianmandrup/facebook-social_plugins"
   s.licenses = ["MIT"]

data/lib/facebook-social_plugins.rb

@@ -5,7 +5,7 @@ require 'facebook-social_plugins/open_graph/meta_helper'
 
 module FacebookSocialPlugins
 	def self.plugins
-		['activity_feed', 'add_to_timeline', 'comments', 'facepile', 'like_box', 'like_button', 
+		['activity_feed', 'add_to_timeline', 'comments', 'facepile', 'like_box', 'like_button',
 			'live_stream', 'login_button', 'recommendations_box', 'registration', 'send_button', 'subscribe_button']
 	end
 
@@ -22,4 +22,4 @@ FacebookSocialPlugins.helpers.each do |name|
 	require "facebook-social_plugins/#{name}_helper"
 end
 
-require 'facebook-social_plugins/rails/engine'
+require 'facebook-social_plugins/rails/engine' if defined?(::Rails::Engine)

data/lib/facebook-social_plugins/activity_feed.rb

@@ -26,8 +26,8 @@ module FacebookSocialPlugins
 		def attributes
 			super.merge(
 				:site => :string, :action => :array, :app_id => :string, :width => :integer, :height => :integer,
-				:header => :boolean, :colorscheme => ['light', 'dark'], :font => ['arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'],
-				:border_color => :string, :recommendations => :boolean, :filter => :string, :linktarget => ['_top', '_parent'],
+				:header => :boolean, :colorscheme => colorschemes, :font => fonts,
+				:border_color => :string, :recommendations => :boolean, :filter => :string, :linktarget => linktargets,
 				:ref => :string, :max_age => :integer, :width => :integer
 			)
 		end

data/lib/facebook-social_plugins/analytics.rb

@@ -11,4 +11,3 @@ module FacebookSocialPlugins
 		end
 	end
 end
-

data/lib/facebook-social_plugins/button.rb

@@ -12,7 +12,7 @@ module FacebookSocialPlugins
 
 		# attributes always availabe for a button?
 		def attributes
-			super.merge(:font => ['arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'], :colorscheme => ['light', 'dark'])
+			super.merge(:font => fonts, :colorscheme => colorschemes)
 		end
 	end
 end

data/lib/facebook-social_plugins/facepile.rb

@@ -30,7 +30,7 @@ module FacebookSocialPlugins
 		# max_rows - max rows to display, 1-10 normally
 		def attributes
 			super.merge(:'event-app-id' => :string, :action => :string, :href => :string, 
-				:max_rows => :integer, :size => ['small', 'large'], :width => :integer
+				:max_rows => :integer, :size => sizes, :width => :integer
 			)
 		end
 	end

data/lib/facebook-social_plugins/like_button.rb

@@ -24,7 +24,7 @@ module FacebookSocialPlugins
 			# fb_source - the stream type ('home', 'profile', 'search', 'ticker', 'tickerdialog' or 'other') in which the click occurred and the story type ('oneline' or 'multiline'), concatenated with an underscore.		
 		def attributes
 			super.merge(
-				:href => :string, :send => :boolean, :layout => ['standard', 'button_count', 'box_count'],
+				:href => :string, :send => :boolean, :layout => layouts,
 				:show_faces => :boolean, :action => ['like', 'recommend'], :ref => :string,
 				:fb_ref => :string, :fb_source => :special, :width => :integer
 			)

data/lib/facebook-social_plugins/recommendations_box.rb

@@ -34,7 +34,7 @@ module FacebookSocialPlugins
 		#           Otherwise the valid values are 1-180, which specifies the number of days.		
 		def attributes
 			super.merge(:site => :string, :action => :string, :app_id => :string, :height => :integer, 
-				:header => :string, :linktarget => ['_top', '_parent'], :ref => :string, 
+				:header => :string, :linktarget => linktargets, :ref => :string, 
 				:max_age => :integer, :width => :integer)
 		end
 	end

data/lib/facebook-social_plugins/registration.rb

@@ -27,10 +27,14 @@ module FacebookSocialPlugins
 		# target	Optional. The target of the form submission: _top (default), _parent, or _self.
 		def attributes
 			super.merge(:client_id => :string, :redirect_uri => :string, :fields => :string, 
-				:fb_only => :boolean, :fb_register => :boolean, :border_color => :string, :target => ['_top', '_parent', '_self']
+				:fb_only => :boolean, :fb_register => :boolean, :border_color => :string, :target => targets
 			)
 		end
 
+		def targets
+			['_top', '_parent', '_self']
+		end
+
 		# Named Fields
 
 		# Specify these in the order you want them to appear in the form. The name field must always be the first field.

data/lib/facebook-social_plugins/script_helper.rb

@@ -1,11 +1,39 @@
 module FacebookSocialPlugins
 	module ScriptHelper
 
+		# can be used inside a js.erb file or similar
+		def fb_login_and_reload options = {:ready => false, :selector => '#fb_login_and_reload'}
+			selector = options[:selector] || '#fb_login_and_reload'
+			script = %Q{$('#{selector}').click(function() { 
+		FB.Connect.requireSession(function() { reload(); }); return false;
+  }
+}				
+			options[:ready] ? wrap_ready(script) : script
+		end
+
+		def fb_logout_and_reload options = {:ready => false, :selector => '#fb_logout_and_reload'}
+			selector = options[:selector] || '#fb_logout_and_reload'
+			script = %Q{$('#{selector}').click(function() { 
+		FB.Connect.logout(function() { reload(); }); return false;
+  }
+}				
+			options[:ready] ? wrap_ready(script) : script
+		end
+
+		def fb_logout_and_redirect_to path, options = {:ready => false}
+			script = %Q{FB.Event.subscribe("auth.logout", function() { 
+	window.location = '#{path}' 
+	}); 
+}
+			options[:ready] ? wrap_ready(script) : script
+		end
+
+
 		# app_id - facebook app id, a number/string, fx '753632322'
 		# domain - fx www.example.com
 		# options - status, cookie, xfbml (true|false)
 		# - :channel => 'channel.html'
-		def async_init_script app_id, domain, options = {}
+		def fb_async_init_script app_id, domain, options = {}
 			%Q{
   window.fbAsyncInit = function() {
     FB.init({
@@ -21,7 +49,7 @@ module FacebookSocialPlugins
 }
 		 end			
 
-		def facebook_script locale = :en_US
+		def fb_channel_script locale = :en_US
 			%Q{
 (function(d){
    var js, id = 'facebook-jssdk'; if (d.getElementById(id)) {return;}
@@ -34,6 +62,13 @@ module FacebookSocialPlugins
 
 		protected
 
+		def wrap_ready script
+			%Q{$(function() {
+		#{script}
+	}
+}
+		end
+
 		# The JavaScript SDK is available in all locales that are supported by Facebook. 
 		# This list of supported locales is available as an XML file. 
 		# To change the locale of the SDK to match the locale of your site, change en_US to a 

data/lib/facebook-social_plugins/social_plugin.rb

@@ -29,6 +29,26 @@ module FacebookSocialPlugins
 
 		protected
 
+		def layouts
+			['standard', 'button_count', 'box_count']
+		end
+
+		def sizes
+			['small', 'large']
+		end
+
+		def fonts
+			['arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana']
+		end
+
+		def colorschemes
+			['light', 'dark']
+		end
+
+		def linktargets
+			['_top', '_parent']
+		end
+
 		def find_att_key key
 			return key if attributes[key]
 			key = key.to_s.dasherize.to_sym			
@@ -47,7 +67,7 @@ module FacebookSocialPlugins
 		end
 
 		def attributes
-			@attributes ||= {}
+			@attributes ||= {:id => :string, :style => :string}
 		end
 
 		def valid? value, valid_type

data/lib/facebook-social_plugins/subscribe_button.rb

@@ -18,7 +18,7 @@ module FacebookSocialPlugins
 		# font - the font to display in the plugin. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
 		# width - the width of the plugin.		
 		def attributes
-			super.merge(:href => :string, :layout => ['standard', 'button_count', 'box_count'], 
+			super.merge(:href => :string, :layout => layouts, 
 				:show_faces => :boolean, :width => :integer)
 		end
 	end

data/lib/facebook-social_plugins/view_helper.rb

@@ -44,6 +44,16 @@ module FacebookSocialPlugins
 			FacebookSocialPlugins::LoginButton.new(options).render
 		end
 
+		def fb_logout_button options = {}
+			content_tag :a, '', {:id => 'fb_logout_and_reload', :href => '#'}.merge(options[:html] || {}) do
+				content_tag(:img, '', :id => 'fb_logout_image', :src => "/assets/fb_logout_#{options[:size] || :small}.gif", :alt => "Facebook Logout").html_safe
+			end
+		end
+
+		def fb_logout &block
+			content_tag :script, %Q{FB.Event.subscribe("auth.logout", function() { #{yield} });}
+		end
+
 		def fb_recommendations_box options = {}
 			FacebookSocialPlugins::RecommendationsBox.new(options).render
 		end

data/spec/facebook-social_plugins/script_helper_spec.rb

@@ -38,18 +38,43 @@ describe FacebookSocialPlugins::ScriptHelper do
   include ControllerTestHelpers,
           FacebookSocialPlugins::ScriptHelper
 
-  it "should create async init script" do
-    output = async_init_script '123', 'www.example.com'
-    output.should == async_script
+  describe '#async_init_script' do
+    it "should create async init script" do
+      output = fb_async_init_script '123', 'www.example.com'
+      output.should == async_script
+    end
   end
 
-  it "should create facebook script" do
-    output = facebook_script
-    output.should == fb_script
+  describe '#facebook_script' do
+    it "should create facebook script" do
+      output = fb_channel_script
+      output.should == fb_script
+    end
+
+    it "should create localized facebook script" do
+      output = fb_channel_script :es_LA
+      output.should == fb_script_es
+    end
+  end
+
+  describe '#fb_login_and_reload' do
+    it 'should work' do
+      output = fb_login_and_reload :ready => true, :selector => '#fb_login'
+      output.should == "$(function() {\n\t\t$('#fb_login').click(function() { \n\t\tFB.Connect.requireSession(function() { reload(); }); return false;\n  }\n\n\t}\n"
+    end
+  end
+
+  describe '#fb_logout_and_reload' do
+    it 'should work' do
+      output = fb_logout_and_reload(:ready => true)
+      output.should == "$(function() {\n\t\t$('#fb_logout_and_reload').click(function() { \n\t\tFB.Connect.logout(function() { reload(); }); return false;\n  }\n\n\t}\n"
+    end
   end
 
-  it "should create localized facebook script" do
-    output = facebook_script :es_LA
-    output.should == fb_script_es
+  describe '#fb_logout_and_redirect_to' do
+    it 'should work' do
+      output = fb_logout_and_redirect_to('facebook/logout', :ready => true)
+      output.should == "$(function() {\n\t\tFB.Event.subscribe(\"auth.logout\", function() { \n\twindow.location = 'facebook/logout' \n\t}); \n\n\t}\n"
+    end
   end
 end

data/spec/facebook-social_plugins/view_helper_spec.rb

@@ -17,6 +17,13 @@ describe FacebookSocialPlugins::ViewHelper do
     end
   end
 
+  describe 'Logout button' do
+    it "should create :logout button (anchor with image" do
+      output = fb_logout_button :size => :large
+      output.should == "<a href=\"#\" id=\"fb_logout_and_reload\"><img alt=\"Facebook Logout\" id=\"fb_logout_image\" src=\"/assets/fb_logout_large.gif\"></img></a>"
+    end
+  end
+
   describe 'Facebook Root placeholder' do
     it "should create :root div" do
       output = fb_root

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: facebook-social_plugins
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -183,6 +183,8 @@ files:
 - spec/facebook-social_plugins/view_helper_spec.rb
 - spec/spec_helper.rb
 - vendor/assets/html/facebook_channel.html
+- vendor/assets/images/fb_logout_large.gif
+- vendor/assets/images/fb_logout_small.gif
 homepage: http://github.com/kristianmandrup/facebook-social_plugins
 licenses:
 - MIT
@@ -198,7 +200,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3268721776078467836
+      hash: 2399279571937946151
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: