facebook-social_plugins 0.1.0

data/lib/facebook-social_plugins/recommendations_box.rb

@@ -0,0 +1,41 @@
+module FacebookSocialPlugins
+	class RecommendationsBox < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-recommendations'
+		end
+
+		# site - the domain to show recommendations for. The XFBML version defaults to the current domain.
+		# action - a comma separated list of actions to show recommendations for.
+		# app_id - will display recommendations for all types of actions, custom and global, associated with this app_id.
+		# width - the width of the plugin in pixels. Default width: 300px.
+		# height - the height of the plugin in pixels. Default height: 300px.
+		# header - specifies whether to show the Facebook header.
+		# colorscheme - the color scheme for the plugin. Options: 'light', 'dark'
+		# font - the font to display in the plugin. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
+		# border_color - the border color of the plugin.
+
+		# linktarget - This specifies the context in which content links are opened. 
+		# 						 By default all links within the plugin will open a new window. 
+		# 						 If you want the content links to open in the same window, you can set this parameter 
+		#              to _top or _parent. Links to Facebook URLs will always open in a new window.
+
+		# ref - a label for tracking referrals; must be less than 50 characters and can contain 
+		#       alphanumeric characters and some punctuation (currently +/=-.:_). 
+		#       Specifying a value for the ref attribute adds the 'fb_ref' parameter to the any links back to your site 
+		#       which are clicked from within the plugin. Using different values for the ref parameter for different positions 
+		#       and configurations of this plugin within your pages allows you to track which instances are performing the best.
+
+		# max_age - a limit on recommendation and creation time of articles that are surfaced in 
+		#           the plugins, the default is 0 (we don’t take age into account). 
+		#           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, 
+				:max_age => :integer, :width => :integer)
+		end
+	end
+end

data/lib/facebook-social_plugins/registration.rb

@@ -0,0 +1,52 @@
+module FacebookSocialPlugins
+	class Registration < SocialPlugin
+		attr_reader :named_fields
+
+		# <fb:registration 
+		#   fields="name,birthday,gender,location,email" 
+		#   redirect-uri="https://developers.facebook.com/tools/echo/"
+		#   width="530">
+		# </fb:registration>		
+
+		def initialize options = {}
+			super
+			@named_fields = options[:fields]
+		end
+
+		def plugin_class
+			'fb-registration'
+		end
+
+		# client_id	Your App ID.
+		# redirect_uri	The URI that will process the signed_request. It must be prefixed by your Site URL.
+		# fields	Comma separated list of Named Fields, or JSON of Custom Fields.
+		# fb_only	Optional. (boolean) Only allow users to register by linking their Facebook profile. Use this if you do not have your own registration system. Default: false.
+		# fb_register	Optional. (boolean) Allow users to register for Facebook during the registration process. Use this if you do not have your own registration system. Default: false.
+		# width	Optional. (int) The width of the iframe in pixels. If the width is < 520 the plugin will render in a small layout.
+		# border_color	Optional. The border color of the plugin.
+		# 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']
+			)
+		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.
+
+		# Field type	Description
+		# name	Full name of the user
+		# birthday	Returned as mm/dd/yyyy
+		# email	Email address of user (if the user registers with her Facebook account, this will be a verified email address)
+		# gender	Gender of user
+		# location	Name and ID of the user's current city
+		# password	A newly created password (not their Facebook password)
+		# captcha	A test to stop automatic registration
+		# Less common fields:
+
+		# Field type	Description
+		# first_name	The first name of the user. Useful with view=not_prefilled.
+		# last_name	The last name of the user.
+	end
+end

data/lib/facebook-social_plugins/script_helper.rb

@@ -0,0 +1,48 @@
+module FacebookSocialPlugins
+	module ScriptHelper
+
+		# 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 = {}
+			%Q{
+  window.fbAsyncInit = function() {
+    FB.init({
+      appId      : '#{app_id}', // App ID
+      channelUrl : '//#{domain}/#{options[:channel] || 'assets/facebook_channel'}.html', // Channel File
+      status     : #{options[:status] || true}, // check login status
+      cookie     : #{options[:cookie] || true}, // enable cookies to allow the server to access the session
+      xfbml      : #{options[:xfbml] || true }  // parse XFBML
+    });
+
+    // Additional initialization code here
+  };
+}
+		 end			
+
+		def facebook_script locale = :en_US
+			%Q{
+(function(d){
+   var js, id = 'facebook-jssdk'; if (d.getElementById(id)) {return;}
+   js = d.createElement('script'); js.id = id; js.async = true;
+   js.src = "#{all_script locale}";
+   d.getElementsByTagName('head')[0].appendChild(js);
+ }(document));
+}
+		end
+
+		protected
+
+		# 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 
+		# supported locale code when loading the SDK. 
+		# For example, if your site is in Spanish use es_LA
+
+
+		def all_script locale = :en_US
+			"//connect.facebook.net/#{locale}/all.js"
+		end
+	end
+end

data/lib/facebook-social_plugins/send_button.rb

@@ -0,0 +1,24 @@
+module FacebookSocialPlugins
+	class SendButton < Button
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-send'
+		end
+
+		# href - the URL to send.
+		# font - the font to display in the button. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
+		# colorscheme - the color scheme for the button. Options: 'light', 'dark'
+		# ref - a label for tracking referrals; must be less than 50 characters and can contain alphanumeric characters and some punctuation (currently +/=-.:_). The ref attribute causes two parameters to be added to the referrer URL when a user clicks a link from a stream story about a Send action:
+		# fb_ref - the ref parameter
+		# fb_source - the story type ('message', 'group', 'email') in which the click occurred.
+		def attributes
+			super.merge(:href => :string, :ref => :string, :fb_ref => :string, 
+				:fb_source => ['message', 'group', 'email']
+			)
+		end
+	end
+end
+

data/lib/facebook-social_plugins/social_plugin.rb

@@ -0,0 +1,84 @@
+require 'facebook-social_plugins/ui_helper'
+
+module FacebookSocialPlugins
+	class SocialPlugin < UiHelper
+
+		attr_reader :options
+
+		def initialize options = {}
+			@options = options
+			validate!
+		end
+
+		def render
+			content_tag :div, '', render_options.merge(:class => plugin_class)
+		end
+
+		# the :special type indicates call to special type validator
+		def validate!
+			return if options.empty?
+			valid_options = {}
+			options.each do |key, value|
+				attr_key = find_att_key(key)
+				raise ArgumentError, "Unknown or unsupported attribute #{key}" unless attr_key
+				attributes[attr_key] == :special ? send("validate_#{key.to_s.underscore}", value) : valid?(value, attributes[attr_key])
+				valid_options[attr_key] = value
+			end
+			@options = valid_options
+		end
+
+		protected
+
+		def find_att_key key
+			return key if attributes[key]
+			key = key.to_s.dasherize.to_sym			
+			return key if attributes[key]
+			key = key.to_s.underscore.to_sym
+			key if attributes[key]
+		end
+
+		# :width => 200 mapped to become 'data-width' => 200
+		def render_options
+			options.inject({}) {|res, opt| res["data-#{opt.first}"] = opt.last; res}
+		end
+
+		def plugin_class
+			raise NotImplementedError, 'Must be implemented by subclass'
+		end
+
+		def attributes
+			@attributes ||= {}
+		end
+
+		def valid? value, valid_type
+			case valid_type
+			when :string
+				raise ArgumentError, "Must be a String, was #{value}" unless string?(value)
+			when :array
+				raise ArgumentError, "Must be an Array or a String, was #{value}" unless array?(value)
+			when :integer
+				raise ArgumentError, "Must be a Fixnum, was #{value}" unless integer?(value)
+			when :boolean
+				raise ArgumentError, "Must be a Boolean, was #{value}" unless boolean?(value)
+			when Array
+				raise ArgumentError, "Must be a one of #{valid_type.inspect}, was #{value}" unless valid_type.include?(value.to_s)
+			end
+		end
+
+		def string? value
+			value.is_a?(String) || value.is_a?(Symbol)
+		end
+
+		def array? value
+			value.is_a?(String) || value.is_a?(Symbol) || value.is_a?(Array)
+		end
+
+		def integer? value
+    	value.is_a?(Fixnum) && value > 0
+    end
+
+		def boolean? value
+    	value.is_a?(TrueClass) || value.is_a?(FalseClass) 
+    end
+	end
+end

data/lib/facebook-social_plugins/subscribe_button.rb

@@ -0,0 +1,27 @@
+module FacebookSocialPlugins
+	class SubscribeButton < Button
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-subscribe'
+		end
+
+		# href - profile URL of the user to subscribe to. This must be a facebook.com profile URL.
+		# layout - there are three options.
+			# standard - displays social text to the right of the button and friends' profile photos below. Minimum width: 225 pixels. Default width: 450 pixels. Height: 35 pixels (without photos) or 80 pixels (with photos).
+			# button_count - displays the total number of subscribers to the right of the button. Minimum width: 90 pixels. Default width: 90 pixels. Height: 20 pixels.
+			# box_count - displays the total number of subscribers above the button. Minimum width: 55 pixels. Default width: 55 pixels. Height: 65 pixels.
+		# show_faces - specifies whether to display profile photos below the button (standard layout only)
+		# colorscheme - the color scheme for the plugin. Options: 'light' (default) and 'dark'
+		# 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'], 
+				:show_faces => :boolean, :width => :integer)
+		end
+	end
+end
+
+

data/lib/facebook-social_plugins/ui_helper.rb

@@ -0,0 +1,10 @@
+module FacebookSocialPlugins
+	class UiHelper
+    include ActionView::Helpers::TagHelper,
+            ActionView::Helpers::UrlHelper,
+            ActionView::Helpers::CaptureHelper,
+            ActionView::Helpers::JavaScriptHelper
+    
+    attr_accessor :html, :javascript
+  end
+end

data/lib/facebook-social_plugins/view_helper.rb

@@ -0,0 +1,56 @@
+module FacebookSocialPlugins
+	module ViewHelper
+		def fb_root
+			content_tag :div, :class => "fb-root"
+		end
+
+		def fb_activity_feed options = {}
+			FacebookSocialPlugins::ActivityFeed.new(options).render
+		end
+
+		def fb_add_to_timeline options = {}
+			FacebookSocialPlugins::AddToTimeline.new(options).render
+		end
+
+		def fb_comments options = {}
+			FacebookSocialPlugins::Comments.new(options).render
+		end
+
+		def fb_facepile options = {}
+			FacebookSocialPlugins::Facepile.new(options).render
+		end
+
+		def fb_like_box options = {}
+			FacebookSocialPlugins::LikeBox.new(options).render
+		end
+
+		def fb_like_button options = {}
+			FacebookSocialPlugins::LikeButton.new(options).render
+		end
+
+		def fb_live_stream options = {}
+			FacebookSocialPlugins::LiveStream.new(options).render
+		end
+
+		def fb_login_button options = {}
+			FacebookSocialPlugins::LoginButton.new(options).render
+		end
+
+		def fb_recommendations_box options = {}
+			FacebookSocialPlugins::RecommendationsBox.new(options).render
+		end
+
+		def fb_registration options = {}
+			FacebookSocialPlugins::Registration.new(options).render
+		end
+
+		def fb_send_button options = {}
+			FacebookSocialPlugins::SendButton.new(options).render
+		end
+
+		def fb_subscribe_button options = {}
+			FacebookSocialPlugins::SubscribeButton.new(options).render
+		end
+	end
+end
+

data/spec/facebook-social_plugins/script_helper_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+
+async_script = %Q{
+  window.fbAsyncInit = function() {
+    FB.init({
+      appId      : '123', // App ID
+      channelUrl : '//www.example.com/assets/facebook_channel.html', // Channel File
+      status     : true, // check login status
+      cookie     : true, // enable cookies to allow the server to access the session
+      xfbml      : true  // parse XFBML
+    });
+
+    // Additional initialization code here
+  };
+}
+
+fb_script = %Q{
+(function(d){
+   var js, id = 'facebook-jssdk'; if (d.getElementById(id)) {return;}
+   js = d.createElement('script'); js.id = id; js.async = true;
+   js.src = "//connect.facebook.net/en_US/all.js";
+   d.getElementsByTagName('head')[0].appendChild(js);
+ }(document));
+}
+
+fb_script_es = %Q{
+(function(d){
+   var js, id = 'facebook-jssdk'; if (d.getElementById(id)) {return;}
+   js = d.createElement('script'); js.id = id; js.async = true;
+   js.src = "//connect.facebook.net/es_LA/all.js";
+   d.getElementsByTagName('head')[0].appendChild(js);
+ }(document));
+}
+
+
+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
+  end
+
+  it "should create facebook script" do
+    output = facebook_script
+    output.should == fb_script
+  end
+
+  it "should create localized facebook script" do
+    output = facebook_script :es_LA
+    output.should == fb_script_es
+  end
+end

data/spec/facebook-social_plugins/view_helper_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe FacebookSocialPlugins::ViewHelper do
+  include ControllerTestHelpers,
+          FacebookSocialPlugins::ViewHelper
+
+  describe 'Social plugin' do
+    it "should not create plugin if unknown attribute is encountered" do
+      lambda { fb_activity_feed :my_site => 'www.example.com' }.should raise_error
+    end
+  end
+
+  describe 'Activity Feed' do
+    it "should create :activity div" do
+      output = fb_activity_feed :site => 'www.example.com'
+      output.should == "<div class=\"fb-activity\" data-site=\"www.example.com\"></div>"
+    end
+  end
+
+  describe 'Add To Timeline' do
+    it "should create :add-to-timeline div" do
+      output = fb_add_to_timeline :mode => 'box'
+      output.should == "<div class=\"fb-add-to-timeline\" data-mode=\"box\"></div>"
+    end
+  end
+
+  describe 'Comments' do
+    it "should create :comments div" do
+      output = fb_comments :href => 'http://www.example.com'
+      output.should == "<div class=\"fb-comments\" data-href=\"http://www.example.com\"></div>"
+    end
+  end
+
+  describe 'Facepile' do
+    it "should create :facepile div" do
+      output = fb_facepile :event_app_id => '276334346'
+      output.should == "<div class=\"fb-facepile\" data-event-app-id=\"276334346\"></div>"
+    end
+  end
+
+  describe 'Like Box' do
+    it "should create :like-box div" do
+      output = fb_like_box :href => 'http://www.example.com'
+      output.should == "<div class=\"fb-like-box\" data-href=\"http://www.example.com\"></div>" 
+    end
+  end
+
+  describe 'Like Button' do
+    it "should create :like-button div" do
+      output = fb_like_button :href => 'http://www.example.com'
+      output.should == "<div class=\"fb-like\" data-href=\"http://www.example.com\"></div>" 
+    end
+  end
+
+  describe 'Live Stream' do
+    it "should create :live-stream div" do
+      output = fb_live_stream :'via-url' => 'http://www.example.com'
+      output.should == "<div class=\"fb-live-stream\" data-via-url=\"http://www.example.com\"></div>" 
+    end
+
+    it "should create :live-stream div even if non-dashed attribute" do
+      output = fb_live_stream :via_url => 'http://www.example.com'
+      output.should == "<div class=\"fb-live-stream\" data-via-url=\"http://www.example.com\"></div>" 
+    end
+  end
+
+  describe 'Login Button' do
+    it "should create :login-button div" do
+      output = fb_login_button :show_faces => true
+      output.should == "<div class=\"fb-login-button\" data-show-faces=\"true\"></div>"
+    end
+  end  
+
+  describe 'Recommendations Box' do
+    it "should NOT create :recommendations div when invalid kind of linktarget" do
+      lambda { fb_recommendations_box :linktarget => '_other' }.should raise_error      
+    end
+
+    it "should create :recommendations div when valid kind of linktarget" do
+      output = fb_recommendations_box :linktarget => '_parent'
+      output.should == "<div class=\"fb-recommendations\" data-linktarget=\"_parent\"></div>"
+    end
+  end
+
+  describe 'Registration' do
+    it "should create :registration div" do
+      output = fb_registration :target => '_self'
+      output.should == "<div class=\"fb-registration\" data-target=\"_self\"></div>"
+    end
+  end    
+
+  describe 'Send Button' do
+    it "should NOT create :send-button div if invalid font" do
+      lambda { fb_send_button :colorscheme => 'light', :font => 'unknown' }.should raise_error      
+    end
+
+    it "should NOT create :send-button div if invalid colorscheme" do
+      lambda { fb_send_button :colorscheme => 'brown', :font => 'arial' }.should raise_error      
+    end
+
+    it "should create :send-button div" do
+      output = fb_send_button :colorscheme => 'light', :font => 'arial'
+      output.should == "<div class=\"fb-send\" data-colorscheme=\"light\" data-font=\"arial\"></div>" 
+    end
+  end    
+
+  describe 'Subscribe Button' do
+    it "should create :subscribe-button div" do
+      output = fb_subscribe_button :width => 200
+      output.should == "<div class=\"fb-subscribe\" data-width=\"200\"></div>" 
+    end
+  end    
+end