facebook_share 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,61 @@
 # Facebook Share
 
-This gem will add an easy-to-use Facebook Share button feature to your Rails project.
+This gem will add an easy-to-use Facebook Share button feature to your Rails project. This gem does not take care of authentication or authorization. It's only purpose is to bind Facebook Share button to anything you want.
 
-## How To Install
+Any public method will return just JavaScript code and nothing else.
 
-This gem relies on jQuery, be sure to have it installed in your project. This gem does not depend on jquery-rails gem, because some projects use jQuery without it.
+## How to install
+
+This gem relies on jQuery, be sure to have it installed in your project. It does not depend on jquery-rails gem, because some projects use jQuery without it.
 
     gem install facebook_share
 
-then add 
+## Code changes
+
+If you don't have a Facebook Application for your project yet, [create one](http://www.facebook.com/developers/createapp.php).
+
+Then add this to your ApplicationHelper
+
+    module ApplicationHelper
+      include FacebookShare
+
+      FacebookShare.default_facebook_share_options = {
+        :app_id => "YOUR_APP_ID",
+        :status => false,
+        :cookie => false,
+        :xfbml => false,
+
+        :selector => '.fb_share',
+        :locale => "en_US"
+      }
+    end
+
+You can ommit *app_id* parameter, if you already have a Facebook Application initialized in your project.
+
+Be sure you have <div id="fb-root"></div> in your application layout before you load the Facebook Connect JS
+
+Default facebook Share options can be changed with the above code snippet
+
+* *appid* - your Facebook application ID that will connect your site to Facebook
+* *status*. *cookie* and *xfbml* - as described at [FB.init JS SDK](http://developers.facebook.com/docs/reference/javascript/fb.init/)
+* *locale* - Facebook locale code representations, ie. en_US, de_DE, pl_PL, etc. The full list of Facebook supported languages is available in http://www.facebook.com/translations/FacebookLocales.xml or at [Facebook Developer Wiki](http://fbdevwiki.com/wiki/Locales)
+* *selector* - a selector to target Facebook share binding, ".fb_share" by default
+* any other parameter will be passed to Facebook's **[FB.ui](http://developers.facebook.com/docs/reference/javascript/fb.ui/)** function, so you can use whichever parameters you need, except for *method*, which defaults always to *publish.stream*
+
+## Usage
+
+The simplest usage (given you specified your project's Facebook Application ID) is as follows:
 
-    include FacebookShare
+    <%= link_to 'Share on Facebook', '#', :class => "fb_share"  %>
+    <%= facebook_share_once %>
 
-at the top of your ApplicationHelper
+That will produce a link "Share on Facebook" with a class of "fb_share" and a corresponding JavaScript script tags initializing Facebook app and sharing method bind to click on that link. By default gem passes ".fb_share" selector to jQuery.
 
-## Examples
+## Todo
 
-### 
+* add tests
 
-## Note on Patches/Pull Requests
+## Note on patches/pull requests
 
 * Fork the project.
 * Create a feature branch
@@ -29,7 +66,7 @@ at the top of your ApplicationHelper
 
 ## Copyright
 
-Copyright (c) 2011 Mike Połtyn.
+Copyright (c) 2011 Mike Połtyn. Originally build as part of work at [Railslove](http://railslove.com).
 
 ## License
 

data/lib/facebook_share.rb

@@ -1,49 +1,78 @@
 module FacebookShare
+  INIT_PARAMS = %w(status cookie xfbml)
+  REMOVE_PARAMS = %w(app_id selector status cookie xfbml locale)
 
-  def facebook_share_once(app_id, params = {})
-    facebook_script_tags app_id, facebook_share('.fb_share', params)
+  class << self
+    attr_accessor :default_facebook_share_options
   end
 
-  def facebook_share(selector, params = {})
-    available_params = {
+  def default_facebook_share_options
+    {
+      :app_id => "0",
+      :selector => ".fb_share",
+      :link => request.url,
+      :locale => "en_US",
       :display => "popup"
-    }.merge(params)
+    }.merge(FacebookShare.default_facebook_share_options || {})
+  end
+
+  def facebook_share_once(options = {})
+    facebook_script_tags options, facebook_share( options )
+  end
 
+  def facebook_share(options = {})
+    options = default_facebook_share_options.merge(options)
     script = <<-JS
-$("#{selector}").unbind("click.facebook_share").bind("click.facebook_share",function () {
-    FB.ui(
-    {
-      method: \'stream.publish\'
-      #{build_params(available_params)}
-    });
-    return false;
-  });
+$("#{options[:selector]}").unbind("click.facebook_share").bind("click.facebook_share",function () {
+  FB.ui({method: \'stream.publish\'#{build_params(options)}});
+  return false;
+});
 JS
     script
   end
 
-  def facebook_script_tags(app_id, initial_script = "")
+  def facebook_script_tags(options = {}, initial_script = "")
+    options = default_facebook_share_options.merge(options)
     script = <<-JS
-<script type="text/javascript" src="https://connect.facebook.net/de_DE/all.js"></script>
+#{facebook_connect_js_tag(options)}
 <script type="text/javascript">
 /* <![CDATA[ */
-FB.init({appId:"#{app_id}", xfbml : true});
+#{facebook_init_script(options)}
 #{initial_script}
 /* ]]> */
 </script>
 JS
-    script
+    html_safe_string(script)
+  end
+
+  def facebook_connect_js_tag(options = {})
+    options = default_facebook_share_options.merge(options)
+    html_safe_string("<script type=\"text/javascript\" src=\"https://connect.facebook.net/#{default_facebook_share_options.merge(options)[:locale]}/all.js\"></script>")
   end
 
-  private
-    def build_params(available_params)
-      script = ""
-      available_params.each do |key, value|
-        if value
-          value_sanitized = value.gsub(/"/, '\"')
-          script << ", #{key}: \"#{value_sanitized}\""
-        end
+  def facebook_init_script(options = {})
+    options = default_facebook_share_options.merge(options)
+    params = build_params options, true
+    html_safe_string("FB.init({appId:\"#{options[:app_id]}\"#{params}});")
+  end
+
+  def build_params(options, for_init = false)
+    script = ""
+    options.each do |key, value|
+      # if it's for init script, include only status, cookie and xfbml
+      # if it's for stream.publish, include all except for initial
+      param_check = ( for_init ) ? FacebookShare::INIT_PARAMS.include?(key.to_s) : !(FacebookShare::REMOVE_PARAMS.include?(key.to_s))
+
+      if value && param_check
+        value_sanitized = value.gsub(/"/, '\"')
+        script << ", #{key}: \"#{value_sanitized}\""
       end
-      script
     end
+    script
+  end
+
+  def html_safe_string(str)
+    @use_html_safe ||= "".respond_to?(:html_safe)
+    @use_html_safe ? str.html_safe : str
+  end
 end

data/lib/facebook_share/version.rb

@@ -1,3 +1,3 @@
 module FacebookShare
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: facebook_share
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Mike Po\xC5\x82tyn"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-10 00:00:00 +01:00
+date: 2011-02-16 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency