disqus 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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.textile

@@ -0,0 +1,84 @@
+h1. Disqus Ruby Gem
+
+The Disqus Gem helps you easily integrate the "Disqus":http://disqus.com
+commenting system into your website. It works for any site programmed in Ruby,
+not just Rails.
+
+h2. Get it
+
+h3. Stable release:
+
+<code>
+  gem install disqus
+</code>
+
+h3. Bleeding edge:
+
+<code>
+  gem install norman-disqus  --source http://gems.github.com
+</code>
+
+h2. Use it:
+
+h3. Configure it:
+
+<pre>
+<code>
+  Disqus::defaults[:account] = "my_account"
+</code>
+</pre>
+
+h3. Show the comment threads on a post page:
+
+<pre>
+<code>
+  # Loads the commenting system
+  Disqus::Widget::thread
+  # Or if you're using Rails:
+  disqus_thread
+  
+  # Appends the comment count to a end of link text for a url that ends with
+  # #disqus_thread. For example:
+  # <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
+  Disqus::Widget::comment_counts
+  # Or if you're using Rails:
+  disqus_comment_counts
+</code>
+</pre>
+
+h3. Show the combo widget on a post page:
+
+<pre>
+<code>
+  Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 25)
+  # Or if you're using Rails:
+  disqus_combo(:color => "blue", :hide_mods => false, :num_items => 25)
+</code>
+</pre>
+
+h3. Show the comment count on a permalink:
+
+<pre>
+<code>
+  link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
+  ...
+  Disqus::Widget::comment_counts
+  # Or for Rails:
+  disqus_comment_counts
+</code>
+</pre>    
+
+h2. Hack it:
+
+Github repository: http://github.com/norman/disqus
+
+h2. Complain about it:
+
+"norman@randomba.org":norman@randomba.org
+
+h2. Learn more about Disqus:
+
+"http://disqus.com":http://disqus.com
+
+Copyright (c) 2008 "Norman Clarke":norman@randomba.org, released under
+the MIT license

data/README.txt

@@ -0,0 +1,65 @@
+Disqus Ruby Gem
+
+The Disqus Gem helps you easily integrate the Disqus commenting system into your website. It works for any site programmed in Ruby, not just Rails.
+
+Get it
+
+Stable release:
+
+gem install disqus
+
+Bleeding edge:
+
+gem install norman-disqus --source http://gems.github.com
+
+Use it:
+
+Configure it:
+
+
+  Disqus::defaults[:account] = "my_account" 
+
+Show the comment threads on a post page:
+
+
+  # Loads the commenting system
+  Disqus::Widget::thread
+  # Or if you're using Rails:
+  disqus_thread
+
+  # Appends the comment count to a end of link text for a url that ends with
+  # #disqus_thread. For example:
+  # <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
+  Disqus::Widget::comment_counts
+  # Or if you're using Rails:
+  disqus_comment_counts
+
+Show the combo widget on a post page:
+
+
+  Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 25)
+  # Or if you're using Rails:
+  disqus_combo(:color => "blue", :hide_mods => false, :num_items => 25)
+
+Show the comment count on a permalink:
+
+
+  link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
+  ...
+  Disqus::Widget::comment_counts
+  # Or for Rails:
+  disqus_comment_counts
+
+Hack it:
+
+Github repository: http://github.com/norman/disqus
+
+Complain about it:
+
+norman@randomba.org
+
+Learn more about Disqus:
+
+http://disqus.com
+
+Copyright© 2008 Norman Clarke, released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc "Build gem"
+task :gem do
+  sh "gem build disqus.gemspec"
+end
+
+desc "Run rcov"
+task :rcov do
+  rm_f "coverage"
+  rm_f "coverage.data"
+  if PLATFORM =~ /darwin/
+    exclude = '--exclude "gems"'
+  else
+    exclude = '--exclude "rubygems"'
+  end
+  rcov = "rcov --rails -Ilib:test --sort coverage --text-report #{exclude} --no-validator-links"
+  cmd = "#{rcov} #{Dir["test/**/*.rb"].join(" ")}"
+  sh cmd
+end
+
+desc 'Generate rdocs.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Disqus'
+  rdoc.options << '--line-numbers' << '--inline-source' << '-c UTF-8'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('README.txt')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'disqus'

data/lib/disqus.rb

@@ -0,0 +1,36 @@
+require 'disqus/widget'
+  
+
+# Disqus is a javascript embed that enhances your blog's comments and
+# integrates it with a fully moderated community forum. The Disqus gem helps
+# you quickly and easily integrate Disqus's widgets into your Ruby-based 
+# website. To use it, please first create an account on Disqus.
+module Disqus
+  
+  @defaults = {
+    :account => "",
+    :avatar_size => 48,
+    :color => "grey",
+    :default_tab => "popular",
+    :hide_avatars => false,
+    :hide_mods => true,
+    :num_items => 15,
+    :show_powered_by => true,
+    :orientation => "horizontal"
+  }
+  
+  def self.defaults
+    @defaults
+  end
+  
+  def self.enable_rails
+    return if ActionView::Base.instance_methods.include? 'disqus_thread'
+    require 'disqus/rails_view_helpers'
+    ActionView::Base.class_eval { include Disqus::RailsViewHelpers }
+  end
+
+end
+
+if defined?(Rails) and defined?(ActionView)
+  Disqus::enable_rails
+end

data/lib/disqus/rails_view_helpers.rb

@@ -0,0 +1,31 @@
+module Disqus
+
+  module RailsViewHelpers
+    
+    def disqus_thread(options = {})
+      Disqus::Widget::thread(options)
+    end
+    
+    def disqus_comment_counts(options = {})
+      Disqus::Widget::comment_counts(options)
+    end
+    
+    def disqus_top_commenters(options = {})
+      Disqus::Widget::top_commenters(options)
+    end
+    
+    def disqus_popular_threads(options = {})
+      Disqus::Widget::popular_threads(options)
+    end
+    
+    def disqus_recent_comments(options = {})
+      Disqus::Widget::recent_comments(options)
+    end
+    
+    def disqus_combo(options = {})
+      Disqus::Widget::combo(options)
+    end
+    
+  end
+
+end

data/lib/disqus/widget.rb

@@ -0,0 +1,161 @@
+module Disqus
+
+  class Widget
+  
+    class Error < StandardError ; end
+    
+    VALID_COLORS = ['blue', 'grey', 'green', 'red', 'orange']
+    VALID_NUM_ITEMS = 5..20
+    VALID_DEFAULT_TABS = ['people', 'recent', 'popular']
+    VALID_AVATAR_SIZES = [24, 32, 48, 92, 128]
+    VALID_ORIENTATIONS = ['horizontal', 'vertical']
+
+    ROOT_PATH = 'http://disqus.com/forums/%s/'
+    THREAD = ROOT_PATH + 'embed.js'
+    COMBO = ROOT_PATH + 'combination_widget.js?num_items=%d&color=%s&default_tab=%s'
+    RECENT = ROOT_PATH + 'recent_comments_widget.js?num_items=%d&avatar_size=%d'
+    POPULAR = ROOT_PATH + 'popular_threads_widget.js?num_items=%d'
+    TOP = ROOT_PATH + 'top_commenters_widget.js?num_items=%d&avatar_size=%d&orientation=%s'
+    class << self
+      
+      # Show the main Disqus thread widget. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      def thread(opts = {})
+        opts = Disqus::defaults.merge(opts)
+        opts[:view_thread_text] ||= "View the discussion thread"
+        validate_opts!(opts)
+        s = '<div id="disqus_thread"></div>'
+        s << '<script type="text/javascript" src="' + THREAD + '"></script>'
+        s << '<noscript><a href="http://%s.disqus.com/?url=ref">'
+        s << opts[:view_thread_text]
+        s << '</a></noscript>'
+        if opts[:show_powered_by]
+          s << '<a href="http://disqus.com" class="dsq-brlink">blog comments '
+          s << 'powered by <span class="logo-disqus">Disqus</span></a>'
+        end
+        s % [opts[:account], opts[:account]]
+      end
+      
+      # Loads Javascript to show the number of comments for the page. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      def comment_counts(opts = {})
+        opts = Disqus::defaults.merge(opts)        
+        validate_opts!(opts)
+        s = <<-WHIMPER
+        <script type="text/javascript">
+        //<[CDATA[
+        (function() {
+        		var links = document.getElementsByTagName('a');
+        		var query = '?';
+        		for(var i = 0; i < links.length; i++) {
+        			if(links[i].href.indexOf('#disqus_thread') >= 0) {
+        				query += 'url' + i + '=' + encodeURIComponent(links[i].href) + '&';
+        			}
+        		}
+        		document.write('<script type="text/javascript" src="#{ROOT_PATH}get_num_replies.js' + query + '"></' + 'script>');
+        	})();
+        //]]>
+        </script>
+        WHIMPER
+        s % opts[:account]
+      end
+      
+      # Show the main Disqus thread widget. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
+      # * <tt>show_powered_by:</tt> Show or hide the powered by Disqus text.
+      # * <tt>num_items:</tt>: How many items to show.
+      # * <tt>hide_mods:</tt> Don't show moderators.
+      # * <tt>hide_avatars:</tt> Don't show avatars.
+      # * <tt>avatar_size:</tt> Avatar size.
+      def top_commenters(opts = {})
+        opts = Disqus::defaults.merge(opts)
+        opts[:header] ||= '<h2 class="dsq-widget-title">Top Commenters</h2>'
+        validate_opts!(opts)        
+        s = '<div id="dsq-topcommenters" class="dsq-widget">'
+        s << opts[:header]
+        s << '<script type="text/javascript" src="'
+        s << TOP
+        s << '&hide_avatars=1' if opts[:hide_avatars]
+        s << '&hide_mods=1' if opts[:hide_mods]
+        s << '"></script>'
+        s << '</div>'
+        if opts[:show_powered_by]
+          s << '<a href="http://disqus.com">Powered by Disqus</a>'
+        end
+        s % [opts[:account], opts[:num_items], opts[:avatar_size], opts[:orientation]]
+      end
+      
+      # Show the main Disqus thread widget. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
+      # * <tt>num_items:</tt>: How many items to show.
+      # * <tt>hide_mods:</tt> Don't show moderators.
+      def popular_threads(opts = {})
+        opts = Disqus::defaults.merge(opts)
+        opts[:header] ||= '<h2 class="dsq-widget-title">Popular Threads</h2>'
+        validate_opts!(opts)
+        s = '<div id="dsq-popthreads" class="dsq-widget">'
+        s << opts[:header]
+        s << '<script type="text/javascript" src="'
+        s << POPULAR
+        s << '&hide_mods=1' if opts[:hide_mods]
+        s << '"></script>'
+        s << '</div>'
+        s << '<a href="http://disqus.com">Powered by Disqus</a>' if opts[:show_powered_by]
+        s % [opts[:account], opts[:num_items]]
+      end
+    
+      # Show the main Disqus thread widget. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      # * <tt>header:</tt> HTML snipper with header (default h2) tag and text.
+      # * <tt>num_items:</tt>: How many items to show.
+      # * <tt>hide_avatars:</tt> Don't show avatars.
+      # * <tt>avatar_size:</tt> Avatar size.
+      def recent_comments(opts = {})
+        opts = Disqus::defaults.merge(opts)
+        opts[:header] ||= '<h2 class="dsq-widget-title">Recent Comments</h2>'
+        validate_opts!(opts)
+        s = '<div id="dsq-recentcomments" class="dsq-widget">'
+        s << opts[:header]
+        s << '<script type="text/javascript" src="'
+        s << RECENT 
+        s << '&hide_avatars=1' if opts[:hide_avatars]
+        s << '"></script>'
+        s << '</div>'
+        if opts[:show_powered_by]
+          s << '<a href="http://disqus.com">Powered by Disqus</a>'
+        end
+        s % [opts[:account], opts[:num_items], opts[:avatar_size]]
+      end
+    
+      # Show the main Disqus thread widget. Options:
+      # * <tt>account:</tt> Your Discus account (required).
+      # * <tt>num_items:</tt>: How many items to show.
+      # * <tt>hide_mods:</tt> Don't show moderators.
+      def combo(opts = {})
+        opts = Disqus::defaults.merge(opts)
+        validate_opts!(opts)
+        s = '<script type="text/javascript" src="'
+        s << COMBO
+        s << '&hide_mods=1' if opts[:hide_mods]
+        s << '"></script>' 
+        s % [opts[:account], opts[:num_items], opts[:color], opts[:default_tab]]
+      end
+      
+      private
+
+      def validate_opts!(opts)
+        raise Error.new("You must specify an :account") if !opts[:account]
+        raise Error.new("Invalid color") if opts[:color] && !VALID_COLORS.include?(opts[:color])
+        raise Error.new("Invalid num_items") if opts[:num_items] && !VALID_NUM_ITEMS.include?(opts[:num_items])
+        raise Error.new("Invalid default_tab") if opts[:default_tab] && !VALID_DEFAULT_TABS.include?(opts[:default_tab])
+        raise Error.new("Invalid avatar size") if opts[:avatar_size] && !VALID_AVATAR_SIZES.include?(opts[:avatar_size])
+        raise Error.new("Invalid orientation") if opts[:orientation] && !VALID_ORIENTATIONS.include?(opts[:orientation])
+      end
+      
+    end
+  
+  end
+
+end

data/test/rails_view_helpers_test.rb

@@ -0,0 +1,37 @@
+require 'test/unit'
+require 'disqus'
+require 'disqus/rails_view_helpers'
+
+class DisqusWidgetTest < Test::Unit::TestCase
+  
+  include Disqus::RailsViewHelpers
+  
+  def setup
+    Disqus::defaults[:account] = "tests"
+  end
+
+  def test_disqus_thread
+    assert disqus_thread
+  end
+  
+  def test_disqus_comment_counts
+    assert disqus_comment_counts
+  end
+  
+  def test_disqus_top_commenters
+    assert disqus_top_commenters
+  end
+  
+  def test_disqus_popular_threads
+    assert disqus_popular_threads
+  end
+  
+  def test_disqus_recent_comments
+    assert disqus_recent_comments
+  end
+  
+  def test_disqus_combo
+    assert disqus_combo
+  end
+  
+end

data/test/widget_test.rb

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'disqus'
+
+class DisqusWidgetTest < Test::Unit::TestCase
+  
+  def setup
+    Disqus::defaults[:account] = "tests"
+  end
+
+  def test_thread
+    assert Disqus::Widget::thread
+  end
+
+  def test_comment_counts
+    assert Disqus::Widget::comment_counts
+  end
+  
+  def test_combo
+    assert Disqus::Widget::combo
+  end
+
+  def test_recent_comments
+    assert Disqus::Widget::recent_comments
+  end
+
+  def test_popular_threads
+    assert Disqus::Widget::popular_threads
+  end
+
+  def test_top_commenters
+    assert Disqus::Widget::top_commenters
+  end
+
+  def test_invalid_default_tab
+    assert_raises Disqus::Widget::Error do
+      Disqus::Widget::combo(:default_tab => "test")
+    end
+  end
+
+  def test_invalid_color
+    assert_raises Disqus::Widget::Error do
+      Disqus::Widget::combo(:color => "test")
+    end
+  end
+
+  def test_invalid_num_items
+    assert_raises Disqus::Widget::Error do
+      Disqus::Widget::combo(:num_items => 100)
+    end
+  end
+
+  def test_invalid_avatar_size
+    assert_raises Disqus::Widget::Error do
+      Disqus::Widget::top_commenters(:avatar_size => 100)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: disqus
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-27 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Integrates Disqus into your Ruby-powered site. Works with any Ruby website, not just Rails.
+email: norman@randomba.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- MIT-LICENSE
+- README.textile
+- README.txt
+- init.rb
+- lib/disqus.rb
+- lib/disqus/widget.rb
+- lib/disqus/rails_view_helpers.rb
+- Rakefile
+has_rdoc: true
+homepage: http://randomba.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+- --inline-source
+- --line-numbers
+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: disqus
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Integrates Disqus commenting system into your Ruby-powered site.
+test_files: 
+- test/widget_test.rb
+- test/rails_view_helpers_test.rb