google_plus_helper 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google_plus_helper.gemspec
+gemspec

data/README.md

@@ -0,0 +1,133 @@
+# GooglePlusHelper
+
+GooglePlusHelper helps you generate Google Plus Social Plugins in your Rails application.  Source code is available [on Github](https://github.com/techbang/google_plus_helper)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "google_plus_helper"
+
+or from Github:
+
+    gem "google_plus_helper", :github => "techbang/google_plus_helper"
+
+And then execute:
+
+    $ bundle
+
+## Getting Started: Include the Google Plus JavaScript API
+
+It is easy to include the javascript of Google Plusone:
+
+    <%= google_plusone_javascript_include_tag %>
+
+This will yield a synchronized method (not recommended) of javascript include tag, with default language `en-US`:
+
+    <script src="https://apis.google.com/js/plusone.js" type="text/javascript">
+    //<![CDATA[
+    {"lang":"en-US"}
+    //]]>
+    </script>
+
+### Asynchrnoized loading (Recommended)
+
+For best practice, it is recommended to use the **asynchronized method**:
+
+    <%= google_plusone_javascript_include_tag(:async => true) %>
+
+which yields:
+
+    <script type="text/javascript">
+    //<![CDATA[
+    window.___gcfg = {"lang":"en-US"};
+    (function() {
+      var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
+      po.src = 'https://apis.google.com/js/plusone.js';
+      var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
+    })();
+    //]]>
+    </script>
+
+### Language
+
+To change then displaying language, specify `:lang` option:
+
+    <%= google_plusone_javascript_include_tag(:async => true, :lang => "zh-TW") %>
+
+### Explicit Loading / Rendering
+
+To load Google Plusone javascript in [explicit mode](https://developers.google.com/+/plugins/+1button/#example-explicit-load), specify `:explicit => true` option:
+
+    <%= google_plusone_javascript_include_tag(:explicit => true) %>
+
+and don't forget to invoke `gapi.plusone.go("container-id")`. See [Google Plusone JavaScript API](https://developers.google.com/+/plugins/+1button/#jsapi) for more details.
+
+## Render Social Plugins
+
+Currently GooglePlusHelper supports **+1 button** and the **share button**.
+
+Notes:
+
+* By default it renders **HTML5 version** of tags.  If you want to use XML version, see Configure GooglePlusHelper below.
+* You **have to specify the URL** to +1 or share, even though Google's Social Plugins do not need it explicitly.
+* If you want to control what to display on Google+, please specify [Open Graph tags](https://developers.facebook.com/docs/opengraphprotocol/). Currently there is no support to render [Snippet](https://developers.google.com/+/plugins/snippet/).
+
+### The +1 Button
+
+    <%= google_plusone_button("http://example.com") %>
+
+Options are the same that listed in the [+1 Tag Document](https://developers.google.com/+/plugins/+1button/#plusonetag-parameters), except for `href` option, which is overriden by the URL you specified.  For example:
+
+    <%= google_plusone_button("http://example.com", :size => :medium, :annotation => :inline) %>
+
+### Share Button
+
+    <%= google_share_button("http://example.com") %>
+
+Options are the same that listed in the [Share Tag document](https://developers.google.com/+/plugins/share/#sharetag-parameters), except for `href` option, which is overriden by the URL you specified.  For example:
+
+    <%= google_share_button("http://example.com", :align => :right, :annotation => :inline) %>
+
+## Configure GooglePlusHelper
+
+GooglePlusHelper provides some configurable options.  Put them in an initializer if you don't like the defaults:
+
+    GooglePlusHelper.config do |config|
+      config.social_plugin_version = :xml # default is :html5
+    end
+
+*Hint*: You don't need this initializer if you want to use the default values.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# License
+
+Copyright (c) 2012 Techbang.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/google_plus_helper.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/google_plus_helper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["chitsaou"]
+  gem.email         = ["chitsaou@techbang.com.tw"]
+  gem.description   = %q{Google+ Social Plugins Helpers for Rails}
+  gem.summary       = %q{Easily generate Google+ Social Plugins in Rails application}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "google_plus_helper"
+  gem.require_paths = ["lib"]
+  gem.version       = GooglePlusHelper::VERSION
+
+  gem.add_dependency("rails", ">= 3.0")
+end

data/lib/google_plus_helper.rb

@@ -0,0 +1,22 @@
+require 'google_plus_helper/settings'
+
+module GooglePlusHelper
+  class << self
+    def settings
+      _settings ||= Settings.new
+      _settings
+    end
+  end
+
+  module Rails
+    if ::Rails.version < "3.1"
+      require "google_plus_helper/railtie"
+    else
+      require "google_plus_helper/engine"
+    end
+  end
+
+  def self.config
+    yield(settings)
+  end
+end

data/lib/google_plus_helper/engine.rb

@@ -0,0 +1,9 @@
+require "google_plus_helper/helper"
+
+module GooglePlusHelper
+  class Engine < ::Rails::Engine
+    initializer "google_plus_helper.view_helpers" do
+      ActionView::Base.send :include, GooglePlusHelper
+    end
+  end
+end

data/lib/google_plus_helper/helper.rb

@@ -0,0 +1,68 @@
+# https://developers.google.com/+/
+# Currently there is no support for generating Schema.org meta tags.
+# Please use Open Graph tags.
+module GooglePlusHelper
+  # load google plusone javascript
+  def google_plusone_javascript_include_tag(*args)
+    options = {
+      :async => false,
+      :lang => "en-US",
+      :explicit => false
+    }.merge(args.extract_options!)
+
+    explicit = options.delete(:explicit)
+    options.merge!(:parsetags => "explicit") if explicit
+
+    # explicit parsing can only be applied to synchronized loading
+    async = options.delete(:async) && !explicit
+
+    params = options.to_json
+
+    if async
+      javascript_tag <<-EOJS
+        window.___gcfg = #{options.to_json};
+        (function() {
+          var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
+          po.src = 'https://apis.google.com/js/plusone.js';
+          var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
+        })();
+      EOJS
+    else
+      javascript_tag options.to_json, :src => "https://apis.google.com/js/plusone.js"
+    end
+  end
+
+  def google_social_plugin(plugin_name, options, html_options={})
+    case GooglePlusHelper.settings.social_plugin_version
+    when :html5
+      html_options.merge! :class => "g-#{plugin_name.to_s}", :data => options
+      content_tag "div", "", html_options
+    when :xml
+      html_options.merge! options
+      content_tag "g:#{plugin_name.to_s}", "", html_options
+    else
+      raise "Unknown Social Plugin Version: #{GooglePlusHelper.settings.social_plugin_version}"
+    end
+  end
+
+  # google_plusone_button generates plusone button for specific URL
+  #
+  # default arguments: (implicitly assigned according to +1 button document)
+  #   size: standard
+  #   annotation: bubble
+  def google_plusone_button(url, *args)
+    options = args.extract_options!
+    options[:href] = url
+    html_options = options.delete(:html_options) || {}
+
+    google_social_plugin(:plusone, options, html_options)
+  end
+
+  def google_share_button(url, *args)
+    options = args.extract_options!
+    options.merge! :href => url, :action => :share
+    html_options = options.delete(:html_options) || {}
+
+    google_social_plugin(:plus, options, html_options)
+  end
+end

data/lib/google_plus_helper/railtie.rb

@@ -0,0 +1,9 @@
+require "google_plus_helper/helper"
+
+module GooglePlusHelper
+  class Railtie < Rails::Railtie
+    initializer "google_plus_helper.view_helpers" do
+      ActionView::Base.send :include, GooglePlusHelper
+    end
+  end
+end

data/lib/google_plus_helper/settings.rb

@@ -0,0 +1,10 @@
+module GooglePlusHelper
+  class Settings
+    attr_accessor :social_plugin_version
+
+    def initialize
+      self.social_plugin_version = :html5
+    end
+
+  end
+end

data/lib/google_plus_helper/version.rb

@@ -0,0 +1,3 @@
+module GooglePlusHelper
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: google_plus_helper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- chitsaou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2153199480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153199480
+description: Google+ Social Plugins Helpers for Rails
+email:
+- chitsaou@techbang.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- google_plus_helper.gemspec
+- lib/google_plus_helper.rb
+- lib/google_plus_helper/engine.rb
+- lib/google_plus_helper/helper.rb
+- lib/google_plus_helper/railtie.rb
+- lib/google_plus_helper/settings.rb
+- lib/google_plus_helper/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Easily generate Google+ Social Plugins in Rails application
+test_files: []