flakey 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
-# Flakey
+# Flakey [![Build Status](https://secure.travis-ci.org/dtuite/flakey.png?branch=master)](http://travis-ci.org/dtuite/flakey)
 
-TODO: Write a gem description
+Social button helpers for your Rails 3.1 projects.
 
 ## Installation
 

data/lib/flakey/configuration.rb

@@ -9,21 +9,25 @@
 
 module Flakey
   class Configuration
-    attr_accessor :default_twitter_handle, :default_tweet_hashtags,
-      :default_tweet_via, :default_tweet_related,
-      :default_tweet_button_size, :default_tweet_button_class,
-      :default_facebook_nickname, :facebook_app_id,
-      :default_stackoverflow_nickname, :default_stackoverflow_user_id,
-      :default_github_name, :plus_one_button_language
+    attr_accessor :twitter_handle, :tweet_hashtags,
+      :tweet_via, :tweet_related,
+      :tweet_button_size, :tweet_button_class,
+      :tweet_label, :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
 
     def initialize
-      self.default_twitter_handle = ''
-      self.default_tweet_hashtags = ''
-      self.default_tweet_via = ''
-      self.default_tweet_related = ''
-      self.default_tweet_button_class = "twitter-share-button"
+      self.twitter_handle = ''
+      self.tweet_hashtags = ''
+      self.tweet_via = ''
+      self.tweet_related = ''
+      self.tweet_label = 'Tweet'
 
-      self.default_facebook_nickname = ''
+      self.follow_button_show_count = 'false'
+
+      self.facebook_nickname = ''
 
     end
   end

data/lib/flakey/facebook.rb

@@ -2,7 +2,7 @@ module Flakey
   module Facebook
     def facebook_nickname(options = {})
       options[:nickname] ||
-        Flakey.configuration.default_facebook_nickname
+        Flakey.configuration.facebook_nickname
     end
 
     def facebook_url(options = {}) 

data/lib/flakey/github.rb

@@ -1,7 +1,7 @@
 module Flakey
   module Github
     def github_name(options = {})
-      options[:name] || Flakey.configuration.default_github_name
+      options[:name] || Flakey.configuration.github_name
     end
 
     def github_url(options = {})

data/lib/flakey/stackoverflow.rb

@@ -1,11 +1,11 @@
 module Flakey
   module Stackoverflow
     def stackoverflow_nickname(options = {})
-      options[:nickname] || Flakey.configuration.default_stackoverflow_nickname
+      options[:nickname] || Flakey.configuration.stackoverflow_nickname
     end
 
     def stackoverflow_profile_url(options = {})
-      user_id = Flakey.configuration.default_stackoverflow_user_id
+      user_id = Flakey.configuration.stackoverflow_user_id
       "http://stackoverflow.com/users/#{user_id}/#{stackoverflow_nickname}"
     end
   end

data/lib/flakey/twitter.rb

@@ -3,6 +3,12 @@
 
 module Flakey
   module Twitter
+    BASE_URL = "https://twitter.com"
+    SHARE_URL = BASE_URL + "/share"
+
+    # Default HTML classes for the various buttons.
+    TWEET_BUTTON_CLASS = 'twitter-tweet-button'
+    FOLLOW_BUTTON_CLASS = 'twitter-follow-button'
 
     # Get the default Twitter handle for this configuration. If a
     # handle argument is supplied, it will be returned.
@@ -15,23 +21,23 @@ module Flakey
     #
     # Returns a string.
     def twitter_handle(handle = nil)
-      handle || Flakey.configuration.default_twitter_handle
+      handle || Flakey.configuration.twitter_handle
     end
 
     # Get the Twitter profile URL for a handle. If no handle is
     # specified then this method returns the profile URL of the
     # default handle.
     #
-    #   twitter_url
+    #   twitter_profile_url
     #   # => "https://twitter.com/default
     #
-    #   twitter_url('peter')
+    #   twitter_profile_url('peter')
     #   # => "https://twitter.com/peter"
     #
     # Returns a string.
-    def twitter_url(handle = nil)
+    def twitter_profile_url(handle = nil)
       handle = handle || twitter_handle
-      "https://twitter.com/#{handle}"
+      BASE_URL + "/#{handle}"
     end
 
     # Generate a tweet button. This method needs the Twitter JavaScript
@@ -40,34 +46,30 @@ module Flakey
     # Takes a hash of options to use when generating the button.
     #
     # [+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.
-    # [+label+] The text to appear on the tweet button.
-    # [+via+] Tweet via an associated abbout. Defaults to the 
-    #         +default_tweet_via+ configuration setting.
-    # [+related+] A related Twitter handle. Defaults to the
-    #             +default_tweet_related+ configuration setting.
-    # [+class+] HTML classes to apply to the Tweet button. Defaults
-    # to the +default_tweet_button_class+ configuration setting which
-    # is <i>"twitter-share-button"</i>.
-    # [+size+] 
+    # [+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>.
     #
     # Returns a HTML string.
     def tweet_button(options = {})
       url = options[:url] || request.url
       text = options[:text]
       hashtags = options[:hashtags] ||
-        Flakey.configuration.default_tweet_hashtags
-      label = options[:label] || 'Tweet'
+        Flakey.configuration.tweet_hashtags
+      label = options[:label] ||
+        Flakey.configuration.tweet_label
       via = options[:via] ||
-        Flakey.configuration.default_tweet_via
+        Flakey.configuration.tweet_via
       related = options[:related] ||
-        Flakey.configuration.default_tweet_related
+        Flakey.configuration.tweet_related
       size = options[:size] || 
-        Flakey.configuration.default_tweet_button_size
+        Flakey.configuration.tweet_button_size
       class_list = options[:class] ||
-        Flakey.configuration.default_tweet_button_class
+        Flakey.configuration.tweet_button_class
 
       data_attr = {
         :via => via,
@@ -78,19 +80,37 @@ module Flakey
       # Twitter will take the page title if we just leave it out.
       data_attr.merge!(text: text) unless text.nil?
       data_attr.merge!(size: size) unless size.nil?
+      class_list = class_list ? 
+        class_list.concat(' ' + TWEET_BUTTON_CLASS) : TWEET_BUTTON_CLASS
 
-      link_to label, "https://twitter.com/share", 
-        :class => class_list, :data => data_attr
+      link_to label, SHARE_URL, :class => class_list, :data => data_attr
     end
 
+    # Generate a follow button. This method needs the Twitter JavaScript
+    # to be loaded on the page in order to work correctly.
+    #
+    # Takes a hash of options to use when generating the button.
+    #
+    # [+handle+] The Twitter handle of the user to follow. Defaults to the +twitter_handle+ configuration.
+    # [+size+] The button size. Can be +nil+ or +'large'+. Configure globally with +follow_button_size+.
+    # [+class_list+] HTML classes to apply to the button. Configure globally with +follow_button_class+.
+    # [+show_count+] Show the follow count. Defaults to false. Configure globally with +follow_button_show_count+.
+    #
+    # Returns a HTML string.
     def follow_button(options = {})
       handle = options[:handle] || twitter_handle
-      label = options[:label] || "Follow #{handle}"
-      size = options[:size] || 'large'
-      class_list = options[:class] || "twitter-follow-button"
-      show_count = options[:show_count] || "false"
+      label = options[:label] || "Follow @#{handle}"
+      size = options[:size] ||
+        Flakey.configuration.follow_button_size
+      class_list = options[:class] ||
+        Flakey.configuration.follow_button_class
+      show_count = options[:show_count] ||
+        Flakey.configuration.follow_button_show_count
+
+      class_list = class_list ? 
+        class_list.concat(' ' + FOLLOW_BUTTON_CLASS) : FOLLOW_BUTTON_CLASS
 
-      link_to label, "https://twitter.com/#{handle}", 
+      link_to label, twitter_profile_url(handle),
         class: class_list, data: { :"show-count" => show_count, size: size }
     end
   end

data/lib/flakey/version.rb

@@ -1,3 +1,3 @@
 module Flakey
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/flakey/twitter_spec.rb

@@ -16,4 +16,40 @@ describe Flakey::Twitter do
       subject.twitter_handle('hello').should == 'hello'
     end
   end
+
+  describe "tweet_button" do
+    before { subject.stub_chain('request.url') { '' } }
+
+    it "should append to the class list" do
+      subject.should_receive(:link_to)
+        .with("Tweet", Flakey::Twitter::SHARE_URL,
+              hash_including(class: 'hello twitter-tweet-button'))
+      subject.tweet_button(class: 'hello')
+    end
+
+    it "should work without a class argument" do
+      subject.should_receive(:link_to)
+        .with("Tweet", Flakey::Twitter::SHARE_URL,
+              hash_including(class: 'twitter-tweet-button'))
+      subject.tweet_button
+    end
+  end
+
+  describe "follow_button" do
+    before { subject.stub_chain('request.url') { '' } }
+
+    it "should append to the class list" do
+      subject.should_receive(:link_to)
+        .with("Follow @david", subject.twitter_profile_url('david'),
+              hash_including(class: 'hello twitter-follow-button'))
+      subject.follow_button(handle: 'david', class: 'hello')
+    end
+
+    it "should work without a class argument" do
+      subject.should_receive(:link_to)
+        .with("Follow @david", subject.twitter_profile_url('david'),
+              hash_including(class: 'twitter-follow-button'))
+      subject.follow_button(handle: 'david')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -6,5 +6,5 @@ require "flakey/google_plus"
 require "flakey/stackoverflow"
 
 Flakey.configure do |c|
-  c.default_twitter_handle = 'grinnick'
+  c.twitter_handle = 'grinnick'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flakey
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70265412068800 !ruby/object:Gem::Requirement
+  requirement: &70339194043700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265412068800
+  version_requirements: *70339194043700
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70265412068380 !ruby/object:Gem::Requirement
+  requirement: &70339194043140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70265412068380
+  version_requirements: *70339194043140
 description: Social helpers for Rails apps.
 email:
 - dtuite@gmail.com