flakey 0.1.4 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7b5137cf69f93d6138540da2b40499ee8754908
+  data.tar.gz: f4ca7aba6b994881a5d784ee53a8e8b0c7c24476
+SHA512:
+  metadata.gz: c35db990e4adccc4b7dd83bba42601d9855bafd4bc9ffd2fcab29a4305e987a2458c1d15103d02061b9079a009f013464384601a54e992560608c01cb6672ac2
+  data.tar.gz: 9ebdf8fc9ddadb16e42b5d5b381ea4c4351a1cd611462e964aded1049f9f84bc08cd9415a63aa8f954df7db195c1bb68337123a15e0bfe799b1c2edbe6b8b491

data/README.md

@@ -22,11 +22,16 @@ Or install it yourself as:
 
     # config/initializers/flakey.rb
     Flakey.configure do |config|
+      config.twitter_handle = ''
+
       # Optionally include:
-      # config.default_twitter_handle = 'dtuite'
-      # config.default_tweet_hastags = ''
-      # config.default_tweet_via = ''
-      # config.default_tweet_related = ''
+      config.twitter_user_id = nil
+      config.tweet_hashtags = ''
+      config.tweet_via = ''
+      config.tweet_related = ''
+      config.tweet_button_count_position = 'horizontal'
+
+      config.follow_button_show_count = 'false'
     end
 
     # app/assets/javascrippts/application.js
@@ -45,8 +50,10 @@ Or install it yourself as:
 
     # config/initializers/flakey.rb
     Flakey.configure do |config|
-      config.facebook_app_id = '<YOUR_APP_ID>'
-      config.default_facebook_nickname = '<A_FACEBOOK_NICKNAME>'
+      self.facebook_nickname = ''
+
+      # Optionally include:
+      config.facebook_app_id = nil
     end
 
     # app/assets/javascrippts/application.js
@@ -65,7 +72,7 @@ Or install it yourself as:
 
     # config/initializers/flakey.rb
     Flakey.configure do |config|
-      config.default_github_name = 'dtuite'
+      config.github_name = 'dtuite'
     end
 
     # app/helpers/application_helper.rb
@@ -80,8 +87,8 @@ Or install it yourself as:
 
     # config/initializers/flakey.rb
     Flakey.configure do |config|
-      config.default_stackoverflow_nickname = 'david-tuite'
-      config.default_stackoverflow_user_id = '7389247'
+      config.stackoverflow_nickname = 'david-tuite'
+      config.stackoverflow_user_id = '7389247'
     end
 
     # app/helpers/application_helper.rb
@@ -97,6 +104,7 @@ Or install it yourself as:
     # config/initializers/flakey.rb
     Flakey.configure do |config|
       config.google_plus_user_id = "9873465784"
+
       # Optionally:
       # Should be of the form of, for example, 'en-GB' or 'de'.
       # config.plus_one_button_language = 'en-GB'

data/flakey.gemspec

@@ -17,6 +17,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'activesupport'
 
+  # Pretend we're in Rails.
+  gem.add_development_dependency 'actionpack'
+
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rake'
 end

data/lib/flakey/configuration.rb

@@ -10,18 +10,19 @@
 module Flakey
   class Configuration
     attr_accessor :twitter_handle, :tweet_hashtags, :tweet_via, :tweet_related,
-      :tweet_button_size, :tweet_button_class, :tweet_label, 
+      :tweet_button_size, :tweet_button_class,
       :follow_button_size, :follow_button_class, :follow_button_show_count,
       :facebook_nickname, :facebook_app_id, :stackoverflow_nickname, 
       :stackoverflow_user_id, :github_name, :plus_one_button_language, 
-      :google_plus_user_id
+      :google_plus_user_id, :twitter_user_id, :tweet_button_count_position
 
     def initialize
+      self.twitter_user_id = nil
       self.twitter_handle = ''
       self.tweet_hashtags = ''
       self.tweet_via = ''
       self.tweet_related = ''
-      self.tweet_label = 'Tweet'
+      self.tweet_button_count_position = 'horizontal'
 
       self.follow_button_show_count = 'false'
 

data/lib/flakey/facebook.rb

@@ -1,5 +1,7 @@
 module Flakey
   module Facebook
+    SHARE_URL = 'https://www.facebook.com/sharer/sharer.php'
+
     def facebook_nickname(options = {})
       options[:nickname] ||
         Flakey.configuration.facebook_nickname
@@ -10,6 +12,20 @@ module Flakey
       "https://www.facebook.com/" + nickname
     end
 
+    # Generate a traditional tweet button. This method needs the Facebook
+    # JavaScript to be loaded on the page to work correctly.
+    #
+    # Takes a hash of options used to generate the button.
+    #
+    # [+url+] The URL to like. Default to the current request url.
+    # [+layout+] String. The layout of the button.
+    # [+width+] Integer. The width of the area taken up by the button.
+    # [+send+] Boolean. Include a Send button or not.
+    # [+font+] String. The font to use for the button text.
+    # [+class_list+] String. Must include 'fb-like' if overwriting.
+    # [+show_faces+] Boolean. Whether to show faces or not.
+    #
+    # Returns a HTML string.
     def like_button(options = {})
       url = options[:url] || request.url
       layout = options[:layout] || 'button_count'
@@ -24,5 +40,16 @@ module Flakey
         :'show-faces' => show_faces, font: font
       }
     end
+
+    # Generate a Facebook Share button.
+    # INFO: http://goo.gl/MvqIi4
+    #
+    # Returns a HTML string.
+    def share_button(options = {})
+      label = options[:label] || 'Share'
+      url = options[:url] || request.url
+
+      link_to label, "#{SHARE_URL}?u=#{url}", target: '_blank'
+    end
   end
 end

data/lib/flakey/twitter.rb

@@ -1,9 +1,11 @@
+# encoding: UTF-8
 require 'active_support/core_ext/hash/except'
-# THis class is used to generate standard Twitter buttons as documented
+# This class is used to generate standard Twitter buttons as documented
 # on the [Twitter developers site](https://twitter.com/about/resources/buttons).
 
 module Flakey
   module Twitter
+
     BASE_URL = "https://twitter.com"
     SHARE_URL = BASE_URL + "/share"
 
@@ -11,6 +13,11 @@ module Flakey
     TWEET_BUTTON_CLASS = 'twitter-share-button'
     FOLLOW_BUTTON_CLASS = 'twitter-follow-button'
 
+    # Needed to be able to pass a block down into link_to.
+    # See the custom_tweet_button method.
+    # INFO: http://stackoverflow.com/a/7562194/574190
+    attr_accessor :output_buffer
+
     # Get the default Twitter handle for this configuration. If a
     # handle argument is supplied, it will be returned.
     #
@@ -49,33 +56,34 @@ module Flakey
     # [+url+] The URL to tweet. Default to the current request url.
     # [+text+] The textual body of the Tweet. Defaults to the current page title. This is a Twitter convention.
     # [+hashtags+] A list of hashtags to include in the tweet. Can be globally configured by setting +tweet_hashtags+.
-    # [+label+] The text to appear on the tweet button. Can be configured by setting +tweet_label+.
     # [+via+] Tweet via an associated about. Defaults to the +tweet_via+ configuration setting.
     # [+related+] A related Twitter handle. Defaults to the +tweet_related+ configuration setting.
     # [+class+] HTML classes to apply to the Tweet button. Defaults to the +tweet_button_class+ configuration setting which is <i>"twitter-share-button"</i>.
     # [+size+] The size of the button. Valid options are <i>nil</i> (default) and </i>'large'</i>.
+    # [+count+] The position of the Tweet count. Valid options are <i>horizonal</i> (default), <i>vertical</i> and </i>none</i>.
     #
     # Returns a HTML string.
     def tweet_button(options = {})
       url = options[:url] || request.url
-      text = options[:text]
+      text = options[:text] || ''
       hashtags = options[:hashtags] || Flakey.configuration.tweet_hashtags
-      label = options[:label] || Flakey.configuration.tweet_label
       via = options[:via] || Flakey.configuration.tweet_via
       related = options[:related] || Flakey.configuration.tweet_related
       size = options[:size] || Flakey.configuration.tweet_button_size
       class_list = options[:class] || Flakey.configuration.tweet_button_class
+      count = options[:count] || Flakey.configuration.tweet_button_count_position
 
-      data_attr = { via: via, related: related, hashtags: hashtags }
+      data_attr = { via: via, related: related, hashtags: hashtags,
+        count: count }
       # Twitter will take the page title if we just leave it out.
-      data_attr.merge!(text: text) unless text.nil?
+      data_attr.merge!(text: sanitize(text)) unless text.nil?
       data_attr.merge!(size: size) unless size.nil?
       data_attr.merge!(url: url) unless url.nil?
 
       class_list = class_list ? 
         class_list.concat(' ' + TWEET_BUTTON_CLASS) : TWEET_BUTTON_CLASS
 
-      link_to label, SHARE_URL, :class => class_list, :data => data_attr
+      link_to "Tweet", SHARE_URL, class: class_list, data: data_attr
     end
 
     # Generate a traditional follow button. This method needs the Twitter 
@@ -109,8 +117,9 @@ module Flakey
     # Generate a link which will open a dialog for following the user with
     # whe specified user_id or screen_name.
     def follow_intent_link(text, options = {})
-      user_id_to_follow = options[:user_id] || nil
-      screen_name_to_follow = options[:screen_name] || nil
+      user_id_to_follow = options[:user_id] || Flakey.configuration.twitter_user_id
+      screen_name_to_follow = options[:screen_name] || 
+        Flakey.configuration.twitter_handle
 
       intent_url = 'https://twitter.com/intent/user?'
 
@@ -120,11 +129,43 @@ module Flakey
 
       intent_url += '&' if user_id_to_follow && screen_name_to_follow
 
-      if screen_name_to_follow
+      unless screen_name_to_follow == ''
         intent_url += "screen_name=#{screen_name_to_follow}"
       end
 
       link_to text, intent_url, options.except(:user_id, :screen_name)
     end
+
+    def custom_tweet_button(options = {}, &block)
+      defaults = {
+        label: 'Tweet',
+        url: request.url,
+        related: Flakey.configuration.tweet_related,
+        hashtags: Flakey.configuration.tweet_hashtags,
+        via: Flakey.configuration.tweet_via,
+        class: 'custom-tweet-button',
+        target: '_blank'
+      }
+      settings = defaults.merge(options)
+      url = "#{SHARE_URL}?url=#{CGI.escape settings[:url]}"
+
+      label = settings[:label]
+      # Delete these so we can pass the settings directly into link_to
+      settings.delete(:label)
+      settings.delete(:url)
+
+      %w[text hashtags related via].each do |url_key|
+        if settings.has_key?(url_key.to_sym) && settings[url_key.to_sym] != ''
+          url += "&#{url_key}=#{CGI.escape settings[url_key.to_sym]}"
+          settings.delete(url_key.to_sym)
+        end
+      end
+
+      if block_given?
+        link_to(url, settings, &block)
+      else
+        link_to label, url, settings
+      end
+    end
   end
 end

data/lib/flakey/version.rb

@@ -1,3 +1,3 @@
 module Flakey
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/spec/flakey/twitter_spec.rb

@@ -1,6 +1,9 @@
+# encoding: UTF-8
 require "spec_helper"
+require 'action_view'
 
 class DummyHelper
+  include ::ActionView::Helpers::UrlHelper
   include Flakey::Twitter
 end
 
@@ -52,4 +55,36 @@ describe Flakey::Twitter do
       subject.follow_button(handle: 'david')
     end
   end
+
+  describe 'custom_tweet_button' do
+    before { subject.stub_chain('request.url') { 'http://example.com/hello' } }
+    let(:default_url) { "#{Flakey::Twitter::SHARE_URL}?url=http%3A%2F%2Fexample.com%2Fhello" }
+
+    it 'should include the default url and label' do
+      subject.should_receive(:link_to)
+        .with('Tweet', default_url, hash_including(target: '_blank'))
+      subject.custom_tweet_button
+    end
+
+    it 'should allow specifying the text' do
+      expected_url = "#{default_url}&text=Hello+there"
+      subject.should_receive(:link_to)
+        .with('Tweet', expected_url, anything)
+      subject.custom_tweet_button(text: "Hello there")
+    end
+
+    it 'should allow specifying the via' do
+      Flakey.configuration.stub(tweet_via: 'hello')
+      subject.custom_tweet_button.should =~ /via=hello/
+    end
+
+    it 'should not include blank via' do
+      Flakey.configuration.stub(tweet_via: '')
+      subject.custom_tweet_button.should_not =~ /&via=/
+    end
+
+    it 'should set a class' do
+      subject.custom_tweet_button.should =~ /class="custom-twee/
+    end
+  end
 end

data/vendor/assets/javascripts/flakey/facebook.js.erb

@@ -3,7 +3,11 @@
     var js, fjs = d.getElementsByTagName(s)[0];
     if (d.getElementById(id)) return;
     js = d.createElement(s); js.id = id;
-    js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1&appId=<%= Flakey.configuration.facebook_app_id %>";
+    <% if Flakey.configuration.facebook_app_id %>
+      js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1&appId=<%= Flakey.configuration.facebook_app_id %>";
+    <% else %>
+      js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1";
+    <% end %>
     fjs.parentNode.insertBefore(js, fjs);
   }(document, 'script', 'facebook-jssdk'));
 <% end %>

data/vendor/assets/javascripts/flakey/popup.js

@@ -0,0 +1,28 @@
+// Used to make Facebook Share dialogs and Custom Tweet dialogs open in a
+// dialog rather than taking the user to a new tab.
+
+if (typeof jQuery === "undefined") {
+  throw "Flakey popup requires jQuery";
+};
+
+(function($) {
+  // Function for opening popups.
+  var openPopup = function(url, name, options){
+    options || (options = {});
+
+    var width  = options.width || 575;
+    var height = options.height || 400;
+    var left   = ($(window).width() - width) / 2;
+    var top    = ($(window).height() - height) / 2;
+    var opts   = "status=1,width=" + width + ',height=' + height + ',top=' + top + ',left=' + left;
+      
+    window.open(url, 'twitter', opts)
+  };
+
+  $(function(){
+    $('.custom-tweet-button').on('click', function(e){
+      e.preventDefault();
+      openPopup($(e.target).attr('href'), 'twitter');
+    });
+  });
+})(jQuery);

metadata

@@ -1,62 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: flakey
 version: !ruby/object:Gem::Version
-  version: 0.1.4
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - David Tuite
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-05 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Social helpers for Rails apps.
@@ -86,36 +93,30 @@ files:
 - spec/spec_helper.rb
 - vendor/assets/javascripts/flakey/facebook.js.erb
 - vendor/assets/javascripts/flakey/google_plus.js.erb
+- vendor/assets/javascripts/flakey/popup.js
 - vendor/assets/javascripts/flakey/twitter.js.erb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1451939396660981137
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1451939396660981137
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Makes a bunch of helper methods available for including in your Rails views.
 test_files:
 - spec/flakey/twitter_spec.rb