share_buttons 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f864646f16ecd65bceb81bea0a350d1ebb505740
+  data.tar.gz: 0ef06fa8322ab5eac269bb89cb8e6225101ee3dd
+SHA512:
+  metadata.gz: b14f4d2f4da73a1f41416a8f24cd9b3fd77fc250a6cc2b2ebebe41e78ed6c365f346dce81e456ac173d85d48408691365af49595f1a07b523f899672a57524b6
+  data.tar.gz: 0021d96cc21f75f98cee086db1214dc4cd3cf5b96116de2bd7e806f25cb1da45000167229a04818d1336bb7f5ca68908a7deabcb4e4b063e7aaa13763c61d971

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Valentin Ballestrino
+
+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/README.md

@@ -0,0 +1,73 @@
+# Share Buttons
+
+Small sharing buttons helpers lib.
+
+**Note :** Templates markup is written with
+[Twitter Bootstrap v3](http://getbootstrap.com/) in mind and the javascript for
+the `link_share_button` helper uses Bootsrap's `collapse` plugin.
+You can override the plugin's view markup for every helper and delete the
+`[data-link-button]` attribute for the `link_share_button` helper to avoid
+the associated javascript to run.
+
+## Installation
+
+Add to your Gemfile and `bundle install` :
+
+```ruby
+gem 'share_buttons', github: 'glyph-fr/share_buttons'
+```
+
+Use the included generator to generate the initializer file and the customizable views :
+
+```bash
+rails generate share_buttons:install
+```
+
+At last, include the javascript file in your `application.js` with :
+
+```javascript
+//= require share_buttons
+```
+
+## Configuration
+
+For Facebook sharing, you need to add you Facebook APP_ID to the generated
+initializer configuration file in `config/initializers/share_buttons.rb` :
+
+```ruby
+ShareButtons.configure do |config|
+  # Configure your facebook App ID for sharing
+  config.facebook.app_id = ENV['FACEBOOK_KEY']
+end
+```
+
+## Usage
+
+In your views, use any of the included helpers :
+
+```erb
+<%= facebook_share_button(resource_path(resource), title: resource.title) %>
+<%= twitter_share_button(resource_path(resource), title: resource.title) %>
+<%= google_plus_share_button(resource_path(resource), title: resource.title) %>
+<%= pinterest_share_button(resource_path(resource), title: resource.title, image_url: resource.image.url) %>
+<%= email_share_button(resource_path(resource), title: resource.title) %>
+<%= link_share_button(resource_path(resource), title: resource.title) %>
+```
+
+And customize the generated views to your needs in `app/views/share_buttons/_<provider>.html.haml`
+
+### Facebook
+
+Facebook's `redirect_uri` parameter will be set to `request.original_url` by
+default but you can pass a custom URL as follow
+
+```erb
+<%= facebook_share_button(resource_path(resource), title: resource.title, redirect_uri: a_custom_url) %>
+```
+
+Useful if you want to handle when user cancelled dialog (e.g. close popup) or
+successfully shared on his wall (e.g. track sharing hits)
+
+## Licence
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ShareButtons'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/share_buttons.coffee

@@ -0,0 +1,39 @@
+#= require zeroclipboard
+#= require_self
+#= require share_buttons/popup
+#= require share_buttons/copy
+
+@ShareButtons =
+  _plugins: {}
+
+  # Custom page ready handler allowing to automatically handle apps with or
+  # without Turbolinks
+  onPageReady: (callback) ->
+    $(document).ready(-> callback() unless window.Turbolinks)
+    $(document).on('page:change', callback);
+
+  register: (type, plugin) ->
+    ShareButtons._plugins[type] = plugin
+
+  initializePlugins: ($container) ->
+    for type, plugin of ShareButtons._plugins
+      $container.find("[data-share='#{ type }']").each (i, el) ->
+        $button = $(el)
+        # Avoid double initialization
+        return if $button.data('share-button')
+        # Initialize plugin and cache it
+        button = new plugin($button)
+        $button.data('share-button', button)
+
+# Expose jQuery plugin to initialize share buttons inside a given container
+#
+# Usage:  $('body').ShareButtons()
+#
+$.fn.shareButtons = ->
+  @each (i, el) -> ShareButtons.initializePlugins($(el))
+
+# Auto initialize plugins on page ready
+#
+ShareButtons.onPageReady ->
+  $('body').shareButtons()
+

data/app/assets/javascripts/share_buttons/copy.coffee

@@ -0,0 +1,28 @@
+class ShareButtons.CopyButton
+  constructor: (@$button) ->
+    @clipboard = new ZeroClipboard(@$button[0])
+    @clipboard.on('load', => @_initializeClipboardHandlers())
+    @$modal = $(@$button.data('target'))
+    @$button.on('click', => @_buttonClicked())
+
+  _initializeClipboardHandlers: ->
+    @clipboard.on('complete', => @_linkCopied())
+
+  _buttonClicked: ->
+    if @$modal.hasClass('in') then @_openModal() else @_closeModal()
+
+  _closeModal: ->
+      @$modal.modal('hide')
+
+  _openModal: ->
+      @$modal.modal('show')
+
+  _linkCopied: ->
+    @$modal.find('.copy-alert-text').hide(0)
+
+    @$modal.one 'shown.bs.modal', =>
+      @$modal.find('.copied-alert-text').collapse('show')
+
+    @_openModal()
+
+ShareButtons.register('copy', ShareButtons.CopyButton)

data/app/assets/javascripts/share_buttons/popup.coffee

@@ -0,0 +1,12 @@
+class ShareButtons.PopupButton
+  constructor: (@$el) ->
+    @$el.on('click', (e) => @_buttonClicked(e))
+
+  _buttonClicked: (e) ->
+    e.preventDefault()
+    window.open(@$el.attr('href'), 'share-popup', @_popupOptions())
+
+  _popupOptions: ->
+    'menubar=no, scrollbars=no, top=0, left=0, width=700, height=300'
+
+ShareButtons.register('popup', ShareButtons.PopupButton)

data/app/assets/stylesheets/share_buttons/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/share_buttons/application_controller.rb

@@ -0,0 +1,4 @@
+module ShareButtons
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/share_buttons/view_helper.rb

@@ -0,0 +1,28 @@
+module ShareButtons
+  module ViewHelper
+    ShareButtons::HELPER_NAMES.each do |medium|
+      define_method(:"#{ medium }_share_button") do |*args|
+        url, options = extract_url_and_options(*args)
+
+        handler_class = ShareButtons.const_get(medium.camelize)
+        button = handler_class.new(request, url, options)
+
+        render partial: "share_buttons/#{ medium }", locals: { button: button }
+      end
+    end
+
+    private
+
+    def extract_url_and_options url = nil, options = nil
+      unless options
+        if url.kind_of?(Hash)
+          options = url
+          url = nil
+        else
+          options = {}
+        end
+      end
+      [url, options]
+    end
+  end
+end

data/app/views/layouts/share_buttons/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ShareButtons</title>
+  <%= stylesheet_link_tag    "share_buttons/application", media: "all" %>
+  <%= javascript_include_tag "share_buttons/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/share_buttons/_email.html.haml

@@ -0,0 +1,3 @@
+= mail_to nil, body: button.url, subject: button.title, class: 'btn btn-default', data: { share: 'email' } do
+  %i.fa.fa-envelope
+  = button.label

data/app/views/share_buttons/_facebook.html.haml

@@ -0,0 +1,3 @@
+= link_to button.href, class: 'btn btn-default', data: { share: 'popup' } do
+  %i.fa.fa-facebook
+  = button.label

data/app/views/share_buttons/_google_plus.html.haml

@@ -0,0 +1,3 @@
+= link_to button.href, class: 'btn btn-default', data: { share: 'popup' } do
+  %i.fa.fa-google-plus
+  = button.label

data/app/views/share_buttons/_link.html.haml

@@ -0,0 +1,18 @@
+%button.btn.btn-default{ type: 'button', data: { share: 'copy', target: "##{ button.dom_id }", :"clipboard-text" => button.url, :title => button.label } }
+  %i.fa.fa-link
+  = button.label
+
+.link-button-alert.collapse{ id: button.dom_id }
+  = text_area_tag :share_link, button.url, readonly: 'readonly', class: 'form-control'
+  %p.help-text.copy-alert-text.collapse.in
+    Sélectionnez l'adresse URL ci-dessus et copiez là
+  %p.help-text.copied-alert-text.collapse
+    Le lien ci-dessus a bien été copié dans votre presse-papier !
+    = link_to "##{ button.dom_id }", data: { toggle: 'collapse' } do
+      %u
+        ×
+        Masquer
+
+  .clearfix
+
+

data/app/views/share_buttons/_pinterest.html.haml

@@ -0,0 +1,3 @@
+= link_to button.href, class: 'btn btn-default', data: { share: 'popup', :'pin-do' => 'buttonBookmark' } do
+  %i.fa.fa-pinterest
+  = button.label

data/app/views/share_buttons/_twitter.html.haml

@@ -0,0 +1,3 @@
+= link_to button.href, class: 'btn btn-default', data: { share: 'popup' } do
+  %i.fa.fa-twitter
+  = button.label

data/config/routes.rb

@@ -0,0 +1,2 @@
+ShareButtons::Engine.routes.draw do
+end

data/lib/generators/share_buttons/install/install_generator.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module ShareButtons
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc "Share Buttons install generator"
+
+    def welcome
+      say "Installing Share Buttons ..."
+    end
+
+    def copy_initializer_file
+      say "Installing default initializer template"
+      copy_file "initializer.rb", "config/initializers/share_buttons.rb"
+    end
+
+    def copy_views
+      folder = %w(app views share_buttons)
+
+      source = File.join('..', '..', '..', '..', '..', *folder)
+      source_dir = File.expand_path(source, __FILE__)
+      dest_dir = Rails.root.join(*folder)
+
+      print "Copying share buttons views to #{ dest_dir } ... "
+      FileUtils.cp_r(source_dir, dest_dir)
+      puts 'done !'
+    end
+  end
+end

data/lib/generators/share_buttons/install/templates/initializer.rb

@@ -0,0 +1,4 @@
+ShareButtons.configure do |config|
+  # Configure your facebook App ID for sharing
+  # config.facebook.app_id = ENV['FACEBOOK_APP_ID']
+end

data/lib/share_buttons.rb

@@ -0,0 +1,32 @@
+require 'zeroclipboard-rails'
+require "share_buttons/engine"
+require 'active_support/dependencies/autoload'
+
+module ShareButtons
+  extend ActiveSupport::Autoload
+
+  autoload :Base, 'share_buttons/base'
+  autoload :Facebook, 'share_buttons/facebook'
+  autoload :Twitter, 'share_buttons/twitter'
+  autoload :GooglePlus, 'share_buttons/google_plus'
+  autoload :Email, 'share_buttons/email'
+  autoload :Link, 'share_buttons/link'
+  autoload :Pinterest, 'share_buttons/pinterest'
+
+  HELPER_NAMES = %w(facebook twitter google_plus pinterest email link)
+
+  def self.configure(&block)
+    configuration = ShareButtons::Configuration.new
+    block_given? ? yield(configuration) : configuration
+  end
+
+  class Configuration
+    # Allow users to configure each provider class attributes by accessing
+    # `config.provider_name.attribute`
+    HELPER_NAMES.each do |helper|
+      define_method(helper) do
+        ShareButtons.const_get(helper.camelize)
+      end
+    end
+  end
+end

data/lib/share_buttons/base.rb

@@ -0,0 +1,38 @@
+module ShareButtons
+  class Base
+    attr_accessor :request, :url, :options
+
+    def initialize(request, url, options)
+      @request = request
+      @url = url || request.original_url
+      @options = options
+    end
+
+    def href
+      [share_url, url_options.to_param].join('?')
+    end
+
+    def label
+      options.fetch(:label, "Partager sur #{ medium_name }")
+    end
+
+    def medium_name
+      self.class.name.demodulize.underscore.humanize
+    end
+
+    private
+
+    def share_url
+      raise 'Implement #share_url in subsclass'
+    end
+
+    def url_options
+      {}
+    end
+
+    # More explicit shortcut to access class attributes
+    def config
+      self.class
+    end
+  end
+end

data/lib/share_buttons/email.rb

@@ -0,0 +1,12 @@
+module ShareButtons
+  class Email < ShareButtons::Base
+    def label
+      options.fetch(:label, 'Partager par e-mail')
+    end
+
+    def title
+      options[:title]
+    end
+
+  end
+end

data/lib/share_buttons/engine.rb

@@ -0,0 +1,11 @@
+module ShareButtons
+  class Engine < ::Rails::Engine
+    isolate_namespace ShareButtons
+
+    initializer 'include ShareButtons helpers in views' do |app|
+      ActiveSupport.on_load(:action_view) do
+        include(ShareButtons::ViewHelper)
+      end
+    end
+  end
+end

data/lib/share_buttons/facebook.rb

@@ -0,0 +1,23 @@
+module ShareButtons
+  class Facebook < ShareButtons::Base
+    cattr_accessor :app_id
+
+    private
+
+    def share_url
+      "https://www.facebook.com/dialog/share"
+    end
+
+    def url_options
+      {
+        display: 'popup', redirect_uri: redirect_uri,
+        app_id: config.app_id, href: url
+      }
+    end
+
+    def redirect_uri
+      options[:redirect_uri] || request.original_url
+    end
+
+  end
+end

data/lib/share_buttons/google_plus.rb

@@ -0,0 +1,13 @@
+module ShareButtons
+  class GooglePlus < ShareButtons::Base
+    private
+
+    def share_url
+      'https://plus.google.com/share'
+    end
+
+    def url_options
+      { url: url }
+    end
+  end
+end

data/lib/share_buttons/link.rb

@@ -0,0 +1,17 @@
+module ShareButtons
+  class Link < ShareButtons::Base
+    def label
+      'Copier le lien'
+    end
+
+    def dom_id
+      @dom_id ||= "share-buttons-link-#{ seed }"
+    end
+
+    private
+
+    def seed
+      (Time.now.to_f * 10**5).to_i.to_s
+    end
+  end
+end

data/lib/share_buttons/pinterest.rb

@@ -0,0 +1,13 @@
+module ShareButtons
+  class Pinterest < ShareButtons::Base
+    private
+
+    def share_url
+      "https://www.pinterest.com/pin/create/button"
+    end
+
+    def url_options
+      { media: options[:image_url], url: url }
+    end
+  end
+end

data/lib/share_buttons/twitter.rb

@@ -0,0 +1,17 @@
+module ShareButtons
+  class Twitter < ShareButtons::Base
+    private
+
+    def share_url
+      'https://twitter.com/home'
+    end
+
+    def url_options
+      { status: status }
+    end
+
+    def status
+      url
+    end
+  end
+end

data/lib/share_buttons/version.rb

@@ -0,0 +1,3 @@
+module ShareButtons
+  VERSION = "1.0.0"
+end

data/lib/tasks/share_buttons_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :share_buttons do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: share_buttons
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: zeroclipboard-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.13
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple social share buttons helpers for Rails.
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/share_buttons.coffee
+- app/assets/javascripts/share_buttons/copy.coffee
+- app/assets/javascripts/share_buttons/popup.coffee
+- app/assets/stylesheets/share_buttons/application.css
+- app/controllers/share_buttons/application_controller.rb
+- app/helpers/share_buttons/view_helper.rb
+- app/views/layouts/share_buttons/application.html.erb
+- app/views/share_buttons/_email.html.haml
+- app/views/share_buttons/_facebook.html.haml
+- app/views/share_buttons/_google_plus.html.haml
+- app/views/share_buttons/_link.html.haml
+- app/views/share_buttons/_pinterest.html.haml
+- app/views/share_buttons/_twitter.html.haml
+- config/routes.rb
+- lib/generators/share_buttons/install/install_generator.rb
+- lib/generators/share_buttons/install/templates/initializer.rb
+- lib/share_buttons.rb
+- lib/share_buttons/base.rb
+- lib/share_buttons/email.rb
+- lib/share_buttons/engine.rb
+- lib/share_buttons/facebook.rb
+- lib/share_buttons/google_plus.rb
+- lib/share_buttons/link.rb
+- lib/share_buttons/pinterest.rb
+- lib/share_buttons/twitter.rb
+- lib/share_buttons/version.rb
+- lib/tasks/share_buttons_tasks.rake
+homepage: http://www.glyph.fr
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Simple social share buttons helpers for Rails.
+test_files: []