tweet-button 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeremy McAnally
+
+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.rdoc

@@ -0,0 +1,66 @@
+= tweet-button
+
+Jeremy McAnally - Intridea
+
+A gem/plugin to generate those nifty new Twitter buttons.
+
+== Usage
+
+First, include +TweetButton+ into your application helper.  After that, using it is as simple as adding a single method call to your views:
+
+    <%= tweet_button %>
+    
+Bam.  Done.  You'll have a sweet lookin' Tweet button all up in your view.
+
+Of course, you can customize it.  The method takes a few options (any default can be overridden universally; read on...):
+
+* +:url+ - The URL to share; the default is the current URL.
+* +:text+ - The text that will appear in the tweet; the default is "Check this out!"
+* +:via+ - The attribution.  Defaults to "tweetbutton", but you should change that.
+* +:lang+ - Set the language for the tweet (no default).
+* +:related+ - Related Twitter accounts (no default).
+* +:count+ - The tweet count box position (values can be "none", "horizontal", or "vertical"; default is "vertical").
+
+So, if you wanted to tweet about Hacker News, attribute it to Peter Cooper, and add some custom text, all from a tweet button with a horizontal counter, you'd do this:
+
+    <%= tweet_button(:via => "peterc", :url => "http://news.ycombinator.com", :text => "AWESOME.")
+    
+Simple enough, eh?  Also, this method call will include the Twitter JavaScript into the page (it only does it once, even if you have multiple buttons on the page).  To put this wherever you'd like (i.e., your header), then use the +twitter_widgets_js_tag+ method.  If you call this method, it will place the tag wherever you call it from (and only place it there; subsequent calls do nothing).
+
+The gem also supports the custom Twitter share links.  To generate one, use the +custom_tweet_button+ (aliased to +custom_tweet_link+ also) method:
+
+    <%= custom_tweet_button %>
+    
+This will generate a link that will link to the share page with the same default options as the standard Tweet Button generator.  You can customize your custom link with text as the first argument, the same options as +tweet_button+ (with the exception of the +count+ parameter, which will be ignored) as the second, and HTML options as a third argument.  For example:
+
+    <%= custom_tweet_button('Tweet it!', {:via => "myself"}, {:class => "tweet-sharey-thing"})
+
+== Setting universal defaults
+
+You can set a new default for any option by setting +default_tweet_button_options+ in your application helper.  For example:
+
+    module ApplicationHelper
+      include TweetButton
+      
+      TweetButton.default_tweet_button_options = {:via => "myself"}
+    end
+
+Only the options you specify will be overridden; so if you only specify a new default +:via+ (which you should definitely do), then the other defaults will stay intact.
+
+== TODO
+
+Probably add the iframe capability.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeremy McAnally. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tweet-button"
+    gem.summary = %Q{Generate new Twitter 'Tweet buttons'}
+    gem.description = %Q{Generate Tweet buttons for your Rails apps}
+    gem.email = "jeremymcanally@gmail.com"
+    gem.homepage = "http://github.com/jm/tweet-button"
+    gem.authors = ["Jeremy McAnally"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tweet-button #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/tweet-button.rb

@@ -0,0 +1,55 @@
+module TweetButton
+  TWITTER_SHARE_URL = "http://twitter.com/share"
+  
+  def tweet_button(options = {})
+    # Merge user specified overrides into defaults, then convert those to data-* attrs
+    params = options_to_data_params(default_tweet_button_options.merge(options))
+    
+    html = ''.html_safe
+    
+    unless @widgetized
+      html << tweet_widgets_js_tag
+    end
+    
+    html << link_to("Tweet", TWITTER_SHARE_URL, params)
+  end
+  
+  class <<self
+    attr_accessor :default_tweet_button_options
+  end
+  
+  def default_tweet_button_options
+    {
+      :url => request.url, 
+      :via => "tweetbutton", 
+      :text => "", 
+      :related => "", 
+      :count => "vertical", 
+      :lang => "en"
+    }.merge(TweetButton.default_tweet_button_options || {})
+  end
+  
+  def tweet_widgets_js_tag
+    @widgetized = true
+    '<script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>'.html_safe
+  end
+  
+  def custom_tweet_button(text = 'Tweet', options = {}, html_options = {})
+    # This line is really long.  And it makes me sad.
+    link_to(text, "#{TWITTER_SHARE_URL}?#{options_to_query_string(default_tweet_button_options.merge(options))}", html_options)
+  end
+  
+  def options_to_data_params(opts)
+    params = {}
+    opts.each {|k, v| params["data-#{k}"] = v}
+    
+    # Make sure the CSS class is there
+    params['class'] = 'twitter-share-button'
+    params
+  end
+  
+  # I'm pretty sure this is in the stdlib or Rails somewhere.  Too lazy to figure it out now.
+  def options_to_query_string(opts)
+    opts.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v)}"}.join("&")
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tweet-button'
+
+class Test::Unit::TestCase
+end

data/test/test_tweet-button.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestTweetButton < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: tweet-button
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy McAnally
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-12 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Generate Tweet buttons for your Rails apps
+email: jeremymcanally@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tweet-button.rb
+- test/helper.rb
+- test/test_tweet-button.rb
+has_rdoc: true
+homepage: http://github.com/jm/tweet-button
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Generate new Twitter 'Tweet buttons'
+test_files: 
+- test/helper.rb
+- test/test_tweet-button.rb