facebook-social_plugins 0.1.0

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "facebook-social_plugins"
+  gem.homepage = "http://github.com/kristianmandrup/facebook-social_plugins"
+  gem.license = "MIT"
+  gem.summary = %Q{Facebook HTML5 style social plugins for Rails 3}
+  gem.description = %Q{HTML5 compatible social plugin helpers for Rails 3}
+  gem.email = "kmandrup@gmail.com"
+  gem.authors = ["Kristian Mandrup"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "facebook-social_plugins #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/facebook-social_plugins.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "facebook-social_plugins"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2012-04-03"
+  s.description = "HTML5 compatible social plugin helpers for Rails 3"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "AddToTimeline.txt",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "facebook-social_plugins.gemspec",
+    "lib/facebook-social_plugins.rb",
+    "lib/facebook-social_plugins/activity_feed.rb",
+    "lib/facebook-social_plugins/add_to_timeline.rb",
+    "lib/facebook-social_plugins/button.rb",
+    "lib/facebook-social_plugins/comments.rb",
+    "lib/facebook-social_plugins/facepile.rb",
+    "lib/facebook-social_plugins/like_box.rb",
+    "lib/facebook-social_plugins/like_button.rb",
+    "lib/facebook-social_plugins/live_stream.rb",
+    "lib/facebook-social_plugins/login_button.rb",
+    "lib/facebook-social_plugins/rails/engine.rb",
+    "lib/facebook-social_plugins/recommendations_box.rb",
+    "lib/facebook-social_plugins/registration.rb",
+    "lib/facebook-social_plugins/script_helper.rb",
+    "lib/facebook-social_plugins/send_button.rb",
+    "lib/facebook-social_plugins/social_plugin.rb",
+    "lib/facebook-social_plugins/subscribe_button.rb",
+    "lib/facebook-social_plugins/ui_helper.rb",
+    "lib/facebook-social_plugins/view_helper.rb",
+    "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"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/facebook-social_plugins"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.20"
+  s.summary = "Facebook HTML5 style social plugins for Rails 3"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rails>, [">= 3"])
+      s.add_development_dependency(%q<rspec>, [">= 2"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 2.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 3"])
+      s.add_dependency(%q<rspec>, [">= 2"])
+      s.add_dependency(%q<rspec-rails>, [">= 2.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.1.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 3"])
+    s.add_dependency(%q<rspec>, [">= 2"])
+    s.add_dependency(%q<rspec-rails>, [">= 2.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.1.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/facebook-social_plugins.rb

@@ -0,0 +1,22 @@
+require 'facebook-social_plugins/button'
+
+module FacebookSocialPlugins
+	def self.plugins
+		['activity_feed', 'add_to_timeline', 'comments', 'facepile', 'like_box', 'like_button', 
+			'live_stream', 'login_button', 'recommendations_box', 'registration', 'send_button', 'subscribe_button']
+	end
+
+	def self.helpers
+		['script', 'view']
+	end
+end
+
+FacebookSocialPlugins.plugins.each do |name|
+	require "facebook-social_plugins/#{name}"
+end
+
+FacebookSocialPlugins.helpers.each do |name|
+	require "facebook-social_plugins/#{name}_helper"
+end
+
+require 'facebook-social_plugins/rails/engine'

data/lib/facebook-social_plugins/activity_feed.rb

@@ -0,0 +1,35 @@
+module FacebookSocialPlugins
+	class ActivityFeed < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-activity'
+		end
+
+		# site - the domain for which to show activity; include just the full domain name, without http:// or a path. The XFBML version defaults to the current domain.
+		# action - a comma separated list of actions to show activities for.
+		# app_id - will display all 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.
+		# recommendations - specifies whether to always show recommendations in the plugin. If recommendations is set to true, the plugin will display recommendations in the bottom half.
+		# filter - allows you to filter which URLs are shown in the plugin. The plugin will only include URLs which contain the filter string in the first two path parameters of the URL. If nothing in the first two path parameters of the URL matches the filter, the URL will not be included. For example, if the 'site' parameter is set to 'www.example.com' and the 'filter' parameter was set to '/section1/section2' then only pages which matched 'http://www.example.com/section1/section2/*' would be included in the activity feed section of this plugin. The filter parameter does not apply to any recommendations which may appear in this plugin (see above); Recommendations are based only on 'site' parameter.
+		# 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 => :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'],
+				:ref => :string, :max_age => :integer, :width => :integer
+			)
+		end
+	end
+end

data/lib/facebook-social_plugins/add_to_timeline.rb

@@ -0,0 +1,18 @@
+module FacebookSocialPlugins
+	# Also see AddToTimeline.txt of this gem for example of using OpenGraph with this feature.
+	class AddToTimeline < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-add-to-timeline'
+		end
+
+		# mode - the display mode - box (default) and button
+		# show_faces - whether to show faces
+		def attributes
+			super.merge(:show_faces => :boolean, :mode => ['box', 'button'])
+		end
+	end
+end

data/lib/facebook-social_plugins/button.rb

@@ -0,0 +1,18 @@
+require 'facebook-social_plugins/social_plugin'
+
+module FacebookSocialPlugins
+	class Button < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			super
+		end
+
+		# attributes always availabe for a button?
+		def attributes
+			super.merge(:font => ['arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'], :colorscheme => ['light', 'dark'])
+		end
+	end
+end

data/lib/facebook-social_plugins/comments.rb

@@ -0,0 +1,20 @@
+module FacebookSocialPlugins
+	class Comments < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-comments'
+		end
+
+		# href - the URL for this Comments plugin. News feed stories on Facebook will link to this URL.
+		# width - the width of the plugin in pixels. Minimum recommended width: 400px.
+		# colorscheme - the color scheme for the plugin. Options: 'light', 'dark'
+		# num_posts - the number of comments to show by default. Default: 10. Minimum: 1
+		# mobile - whether to show the mobile-optimized version. Default: auto-detect.
+		def attributes
+			super.merge(:href => :string, :num_posts => :integer, :mobile => :boolean, :width => :integer)
+		end
+	end
+end

data/lib/facebook-social_plugins/facepile.rb

@@ -0,0 +1,37 @@
+module FacebookSocialPlugins
+
+	# The Facepile plugin displays the Facebook profile pictures of users who have connected with your 
+	# page via a global or custom action, or can also be configured to display users that have 
+	# signed up for your site.
+
+	# If you want to display users who have connected to your page via an action, specify with the action parameter
+
+	# <div class="fb-facepile" data-href="http://developers.facebook.com" 
+	# 	data-action="join" data-size="large" data-max-rows="1" data-width="300" 
+	# 	data-colorscheme="dark">
+	# </div>	
+
+	# To display users who have liked your page, specify the URL of your page as the href parameter. 
+	# To display users who have signed up for your site, specify your application id as the app_id
+
+	class Facepile < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-facepile'
+		end
+
+		# event-app-id - the app id for the event
+		# action - the action to perform, fx 'og_recipebox:planning_to_make'
+		# width - the width of the plugin in pixels. Minimum recommended width: 400px.
+		# href - the referenced page
+		# 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
+			)
+		end
+	end
+end

data/lib/facebook-social_plugins/like_box.rb

@@ -0,0 +1,28 @@
+module FacebookSocialPlugins
+	class LikeBox < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-like-box'
+		end
+
+			# href - the URL of the Facebook Page for this Like Box
+			# width - the width of the plugin in pixels. Default width: 300px.
+			# height - the height of the plugin in pixels. The default height varies based on number of faces to display, and whether the stream is displayed. With the stream displayed, and 10 faces the default height is 556px. With no faces, and no stream the default height is 63px.
+			# colorscheme - the color scheme for the plugin. Options: 'light', 'dark'
+			# show_faces - specifies whether or not to display profile photos in the plugin. Default value: true.
+			# stream - specifies whether to display a stream of the latest posts from the Page's wall
+			# header - specifies whether to display the Facebook header at the top of the plugin.
+			# border_color - the border color of the plugin.
+			# force_wall - for Places, specifies whether the stream contains posts from the Place's wall or just checkins from friends. Default value: false.			
+
+		def attributes 
+			super.merge(
+				:href => :string, :height => :integer, :stream => :boolean, :header => :string,
+				:show_faces => :boolean, :force_wall => :boolean, :width => :integer
+			)
+		end
+	end
+end

data/lib/facebook-social_plugins/like_button.rb

@@ -0,0 +1,51 @@
+module FacebookSocialPlugins
+	class LikeButton < Button
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-like'
+		end
+
+			# href - the URL to like. The XFBML version defaults to the current page.
+			# send - specifies whether to include a Send button with the Like button. This only works with the XFBML version.
+			# layout - there are three options.
+			# 	standard - displays social text to the right of the button and friends' profile photos below. Minimum width: 225 pixels. Minimum increases by 40px if action is 'recommend' by and increases by 60px if send is 'true'. Default width: 450 pixels. Height: 35 pixels (without photos) or 80 pixels (with photos).
+			# 	button_count - displays the total number of likes to the right of the button. Minimum width: 90 pixels. Default width: 90 pixels. Height: 20 pixels.
+			# 	box_count - displays the total number of likes 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)
+			# width - the width of the Like button.
+			# action - the verb to display on the button. Options: 'like', 'recommend'
+			# font - the font to display in the button. Options: 'arial', 'lucida grande', 'segoe ui', 'tahoma', 'trebuchet ms', 'verdana'
+			# colorscheme - the color scheme for the like 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 Like action:
+			# fb_ref - the ref parameter
+			# 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'],
+				:show_faces => :boolean, :action => ['like', 'recommend'], :ref => :string,
+				:fb_ref => :string, :fb_source => :special, :width => :integer
+			)
+		end
+
+		def validate_fb_source value
+			raise ArgumentError, "The fb_source option must have a [stream type]_[story line] format, was #{value}" unless value =~ /\S+_\S+/
+
+			stream_type, story_line = value.split('_')
+			raise ArgumentError, "Not a valid stream type, must be one of #{stream_types}, was #{stream_type}" unless stream_types.include?(stream_type)
+			raise ArgumentError, "Not a valid story line, must be one of #{story_lines}, was #{story_line}" unless story_lines.include?(story_line)
+		end
+
+		private
+
+		def stream_types 
+			['home', 'profile', 'search', 'ticker', 'tickerdialog', 'other']
+		end
+		
+		def story_lines 
+			['oneline', 'multiline']
+		end
+	end
+end

data/lib/facebook-social_plugins/live_stream.rb

@@ -0,0 +1,21 @@
+module FacebookSocialPlugins
+	class LiveStream < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-live-stream'
+		end
+
+		# event-app-id - the app id for the event
+		# width - the width of the plugin in pixels. Minimum recommended width: 400px.
+		# height - the height of the plugin in pixels. Minimum recommended height: 200px.
+		# always-post-to-friends - whether to always post to friend, default: false
+		def attributes
+			super.merge(:'via-url' => :string, :xid => :string, :'event-app-id' => :string, 
+				:height => :integer, :'always-post-to-friends' => :boolean, :width => :integer)
+		end
+	end
+end
+

data/lib/facebook-social_plugins/login_button.rb

@@ -0,0 +1,26 @@
+module FacebookSocialPlugins
+	# <div class="fb-login-button" data-show-faces="true" data-width="200" data-max-rows="1"></div>
+	class LoginButton < SocialPlugin
+		def initialize options = {}
+			super
+		end
+
+		def plugin_class
+			'fb-login-button'
+		end
+
+		# show-faces - specifies whether to show faces underneath the Login button.
+		# width - the width of the plugin in pixels. Default width: 200px.
+		# max-rows - the maximum number of rows of profile pictures to display. Default value: 1.
+		# scope - a comma separated list of extended permissions. 
+		# 				By default the Login button prompts users for their public information. 
+		#  				If your application needs to access other parts of the user's profile that may be 
+		#					private, your application can request extended permissions. 
+		def attributes
+			super.merge(:'show-faces' => :boolean, :'max-rows' => :integer, :scope => :array, :width => :integer)
+		end
+	end
+end
+
+
+

data/lib/facebook-social_plugins/rails/engine.rb

@@ -0,0 +1,10 @@
+module FacebookSocialPlugins
+	module Rails
+		class Engine < ::Rails::Engine
+			initializer 'setup rails' do				
+				ActionView::Base.send :include, FacebookSocialPlugins::ViewHelper
+				ActionView::Base.send :include, FacebookSocialPlugins::ScriptHelper
+			end
+		end
+	end
+end