jaap3-addthis 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jaap Roes
+
+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,91 @@
+= Addthis
+
+Addthis.com provides widgets that make sharing, bookmarking and emailing pages,
+and subscribing to feeds easy for your visitors. It supports a broad range of
+social network sites and web applications.
+
+This plugin makes it easy to add plain or customized Addthis.com widgets to
+your Rails application.
+
+= Installation
+
+As a Gem in environment.rb:
+
+  config.gem 'jaap3-addthis', :lib => 'addthis',
+    :source => 'http://gems.github.com'
+
+As a plugin:
+
+  script/plugin install git://github.com/jaap3/addthis.git
+
+= Quick Start
+
+The most basic use is simply providing no arguments:
+
+  addthis_bookmark_button
+  addthis_email_button
+
+The code generated by Addthis will then try to figure out the url and title by
+itself. This is not possible for addthis_feed_button.
+
+You can set a custom url, this is required for addthis_feed_button:
+
+  addthis_bookmark_button("http://www.example.com/")
+  addthis_email_button("http://www.example.com/")
+  addthis_feed_button("http://www.example.com/")
+
+Setting a title is possible when adding a bookmark or email button:
+
+  addthis_bookmark_button("http://www.example.com/", "Example website")
+  addthis_email_button("http://www.example.com/", "Example website")
+
+To only set a custom title you can use to options hash:
+
+  addthis_bookmark_button(:title => "Example title")
+  addthis_email_button(:title => "Example title")
+
+The options hash can be used to customize the widget to a great extend. Each of
+the shown examples can take the options hash as an optional extra argument.
+
+= Usage
+
+If you wish to track analytics for your button, you must create an account at
+http://addthis.com/. Joining is free!
+
+After signing up create a new ruby file in config/initializers called
+addthis.rb. You can use this file to configure your publisher name (your
+Addthis.com username) like so:
+
+  Jaap3::Addthis::CONFIG[:publisher] = "YOUR_USERNAME_HERE"
+
+You can then use this initializer to further override any other settings you
+might like.
+
+The default settings are stored in the following constants. You can look in
+the source to see what they are.
+
+  Jaap3::Addthis::CONFIG
+  Jaap3::Addthis::DEFAULT_OPTIONS
+  Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS
+  Jaap3::Addthis::FEED_BUTTON_DEFAULTS
+  Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS
+
+Besides overriding the default settings using the initializer, each helper
+method takes an options hash that can be used to override any setting for
+a specific button.
+
+So calling
+
+  addthis_bookmark_button(:publisher => "example", :secure => true)
+
+Will output a button usable on https pages with the publisher variable set
+to "example" regardless of any configuration changes.
+
+= Contributing
+
+If you would like to contribute to the Addthis plugin, just fork the code
+and send me a pull request after you are done fiddling.
+
+== Copyright
+
+Copyright (c) 2009 Jaap Roes. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "addthis"
+    gem.summary = %Q{TODO}
+    gem.email = "jaap@u-e-h.net"
+    gem.homepage = "http://github.com/jaap3/addthis"
+    gem.authors = ["Jaap Roes"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "addthis #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 0

data/lib/addthis.rb

@@ -0,0 +1,83 @@
+module Jaap3
+  module Addthis
+    CONFIG = {
+      :publisher => ""
+    }
+    DEFAULT_OPTIONS = {
+      :script_src => "http://s7.addthis.com/js/200/addthis_widget.js",
+      :secure => false
+    }
+    BOOKMARK_BUTTON_DEFAULTS = {
+      :title => "",
+      :alt => "Bookmark and Share"
+    }
+    FEED_BUTTON_DEFAULTS = {
+      :title => "Subscribe using any feed reader!",
+      :alt => "Subscribe"
+    }
+    EMAIL_BUTTON_DEFAULTS = {
+      :title => "",
+      :alt => "Email"
+    }
+
+    module Helper
+      def addthis_bookmark_button(*args)
+        url, options = extract_addthis_url_and_options(args)
+        options = BOOKMARK_BUTTON_DEFAULTS.merge(options)
+        s = %Q{<a href="http://www.addthis.com/bookmark.php?v=20" onmouseover="}
+        s << %Q{return addthis_open(this, '', '#{url}', '#{options[:page_title]}')"}
+        s << %Q{ title="#{options[:title]}"}
+        s << %Q{ onmouseout="addthis_close()" onclick="return addthis_sendto()">}
+        s << %Q{<img src="http://s7.addthis.com/static/btn/lg-share-en.gif"}
+        s << %Q{ width="125" height="16" alt="#{options[:alt]}" style="border:0"/></a>}
+        addthis_tag(s, options)
+      end
+      alias addthis_share_button addthis_bookmark_button
+
+      def addthis_feed_button(url, *args)
+        options = FEED_BUTTON_DEFAULTS.merge(extract_addthis_options(args))
+        s = %Q{<a href="http://www.addthis.com/feed.php?pub=#{options[:publisher]}&h1=#{url}&t1="}
+        s << %Q{ onclick="return addthis_open(this, 'feed', '#{url}')"}
+        s << %Q{ title="#{options[:title]}" target="_blank">}
+        s << %Q{<img src="http://s7.addthis.com/static/btn/lg-feed-en.gif"}
+        s << %Q{width="125" height="16" alt="#{options[:alt]}" style="border:0"/></a>}
+        addthis_tag(s, options)
+      end
+
+      def addthis_email_button(*args)
+        url, options = extract_addthis_url_and_options(args)
+        options = EMAIL_BUTTON_DEFAULTS.merge(options)
+        s = %Q{<a href="http://www.addthis.com/bookmark.php"}
+        s << %Q{ style="text-decoration:none;" title="#{options[:title]}"}
+        s << %Q{ onclick="return addthis_open(this, 'email', '#{url}', '#{options[:page_title]}');">}
+        s << %Q{<img src="http://s7.addthis.com/button1-email.gif" width="54" height="16" border="0" alt="#{options[:alt]}" /></a>}
+        addthis_tag(s, options)
+      end
+
+      protected
+      def addthis_tag(str, options = {})
+        s = [%Q{<!-- AddThis Button BEGIN -->}]
+        s << %Q{<script type="text/javascript">var addthis_pub="#{options[:publisher]}";</script>}
+        s << str
+        s << %Q{<script type="text/javascript" src="#{options[:script_src]}"></script>}
+        s << %Q{<!-- AddThis Button END -->}
+        s = s * "\n"
+        options[:secure] ? s.gsub(/http:\/\/s[57]\.addthis\.com/, "https://secure.addthis.com") : s
+      end
+
+      def extract_addthis_url_and_options(args, options = {:page_title => "[TITLE]"})
+        url = args[0].is_a?(String) ? args.shift : "[URL]"
+        return url, options = extract_addthis_options(args, options)
+      end
+
+      def extract_addthis_options(args, options = {})
+        page_title = args[0].is_a?(String) ? args.shift : options[:page_title]
+        options = args[0].is_a?(Hash) ? args.shift : options
+        options[:page_title] = page_title
+        options = CONFIG.merge(DEFAULT_OPTIONS).merge(options)
+        options.symbolize_keys! if options.respond_to?(:symbolize_keys!)
+        return options
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'addthis'
+
+ActionView::Base.send :include, Jaap3::AddthisHelper::ClassMethods

data/test/addthis_test.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+include Jaap3::Addthis::Helper
+
+class AddthisTest < Test::Unit::TestCase
+
+  should "provide addthis_bookmark_button" do
+    assert respond_to?(:addthis_bookmark_button)
+  end
+
+  should "alias addthis_bookmark_button as addthis_share_button" do
+    assert respond_to?(:addthis_share_button)
+  end
+
+  should "provide addthis_feed_button" do
+    assert respond_to?(:addthis_feed_button)
+  end
+
+  should "provide addthis_email_button" do
+    assert respond_to?(:addthis_email_button)
+  end
+  
+  [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+    context "the output of #{m}" do
+      setup do
+        @output = method(m).call("http://example.com")
+        @output_lines = @output.split("\n")
+      end
+
+      should_set_script_src_to Jaap3::Addthis::DEFAULT_OPTIONS[:script_src]
+
+      should "start with an html comment" do
+        assert_equal "<!-- AddThis Button BEGIN -->", @output_lines.first
+      end
+
+      should "end with an html comment" do
+        assert_equal "<!-- AddThis Button END -->", @output_lines.last
+      end
+    end
+  end
+
+  context "a bookmark/share button" do
+    setup { @output = addthis_bookmark_button }
+
+    should_set_alt_to Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:alt]
+    should_set_title_to Jaap3::Addthis::BOOKMARK_BUTTON_DEFAULTS[:title]
+    should_set_href_to "http://www.addthis.com/bookmark.php?v=20"
+
+    should "set url to [URL]" do
+      assert_match "'[URL]'", @output
+    end
+
+    should "set title to [TITLE]" do
+      assert_match "'[TITLE]'", @output
+    end
+  end
+
+  context "a feed button" do
+    setup { @output = addthis_feed_button("http://example.com") }
+
+    should_set_alt_to Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:alt]
+    should_set_title_to Jaap3::Addthis::FEED_BUTTON_DEFAULTS[:title]
+    should_set_href_to "http://www.addthis.com/feed.php?pub=&h1=http://example.com&t1="
+
+    should "set url to example.com" do
+      assert_match "'http://example.com')", @output
+    end
+  end
+
+  context "an email button" do
+    setup { @output = addthis_email_button }
+
+    should_set_alt_to Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:alt]
+    should_set_title_to Jaap3::Addthis::EMAIL_BUTTON_DEFAULTS[:title]
+    should_set_href_to "http://www.addthis.com/bookmark.php"
+  end
+
+  context "with publisher configured" do
+    setup { Jaap3::Addthis::CONFIG[:publisher] = "test_publisher" }
+
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup { @output = method(m).call("http://example.com") }
+
+        should "set addthis_pub to test_publisher" do
+          assert_match 'var addthis_pub="test_publisher";', @output
+        end
+      end
+    end
+
+    context "a feed button" do
+      setup { @output = addthis_feed_button("http://example.com") }
+
+      should_set_href_to "http://www.addthis.com/feed.php?pub=test_publisher&h1=http://example.com&t1="
+    end
+  end
+
+  context "with altered script_src" do
+    setup { Jaap3::Addthis::DEFAULT_OPTIONS[:script_src] = "http://example.com/example.js" }
+
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "the output of #{m}" do
+        setup do
+          @output = method(m).call("http://example.com")
+          @output_lines = @output.split("\n")
+        end
+
+        should_set_script_src_to "http://example.com/example.js"
+      end
+    end
+
+    context "in turn overwritten by options hash" do
+      [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+        context "the output of #{m}" do
+          setup do
+            @output = method(m).call("http://example.com", :script_src => "http://www.example.com/example.js")
+            @output_lines = @output.split("\n")
+          end
+
+          should_set_script_src_to "http://www.example.com/example.js"
+        end
+      end
+    end
+  end
+
+  context "when setting secure to true" do
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "by using the options hash the output of #{m}" do
+        setup do
+          @output = method(m).call("http://example.com", :secure => true)
+          @output_lines = @output.split("\n")
+        end
+
+        should_set_script_src_to "https://secure.addthis.com/js/200/addthis_widget.js"
+      end
+    end
+
+    [:addthis_bookmark_button, :addthis_feed_button, :addthis_email_button].each do |m|
+      context "by altering the defaults the output of #{m}" do
+        setup do
+          Jaap3::Addthis::DEFAULT_OPTIONS[:secure] = true
+          @output = method(m).call("http://example.com")
+          @output_lines = @output.split("\n")
+        end
+
+        should_set_script_src_to "https://secure.addthis.com/js/200/addthis_widget.js"
+      end
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'addthis'
+
+class Test::Unit::TestCase
+
+  class << self
+    %w(alt href src title).each do |attribute|
+      define_method(:"should_set_#{attribute}_to") do |expected|
+        should "set #{attribute} to '#{expected}'" do
+          assert_equal %Q{#{attribute}="#{expected}"}, @output[/#{attribute}="[^"]*"/]
+        end
+      end
+    end
+
+    def should_set_script_src_to(expected)
+      context "" do
+        setup do
+          @output = @output[/<script.+src=[^>]+>/]
+        end
+
+        should_set_src_to expected
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: jaap3-addthis
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jaap Roes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jaap@u-e-h.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/addthis.rb
+- rails/init.rb
+- test/addthis_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jaap3/addthis
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/test_helper.rb
+- test/addthis_test.rb