mwilden-disqus 1.0.3

data/lib/disqus/post.rb

@@ -0,0 +1,51 @@
+module Disqus
+
+  class Post
+    attr_reader :id, :forum, :thread, :created_at, :message, :parent_post, :shown, :is_anonymous, :author
+    
+    def initialize(id, forum, thread, created_at, message, parent_post, shown, is_anonymous, author)
+         @id, @forum, @thread, @created_at, @message, @parent_post, @shown, @is_anonymous, @author = id.to_i, forum, thread, Time.parse(created_at.to_s), message, parent_post, shown, is_anonymous, author
+    end
+    
+    # Returns an array of Post objects representing all posts belonging to the
+    # given thread. The array is sorted by the "created_at" date descending.
+    def self.list(thread)
+      response = Disqus::Api::get_thread_posts(:thread_id =>thread.id, :forum_api_key => thread.forum.key)
+      if response["succeeded"]
+        posts = response["message"].map do |post|
+          author = nil
+          if post["is_anonymous"] 
+            author = AnonymousAuthor.new(
+              post["anonymous_author"]["name"],
+              post["anonymous_author"]["url"],
+              post["anonymous_author"]["email_hash"]
+            )
+          else
+            author = Author.new(
+              post["author"]["id"].to_i,
+              post["author"]["username"],
+              post["author"]["display_name"],
+              post["author"]["url"],
+              post["author"]["email_hash"],
+              post["author"]["has_avatar"]
+            )
+          end
+          Post.new( 
+            post["id"],
+            thread.forum,
+            thread,
+            post["created_at"],
+            post["message"],
+            post["parent_post"],
+            post["shown"],
+            post["is_anonymous"],
+            author
+          )
+        end
+        posts.sort!{|a,b| a.created_at <=> b.created_at}
+      end
+    end
+  end
+end
+
+

data/lib/disqus/thread.rb

@@ -0,0 +1,73 @@
+module Disqus
+
+  class Thread
+    attr_reader :id, :forum, :slug, :title, :created_at, :allow_comments, :url, :identifier, :forum
+    
+    def initialize(id, forum, slug, title, created_at, allow_comments, url, identifier)
+      @id, @forum, @slug, @title, @created_at, @allow_comments, @url, @identifier = id.to_i, forum, slug, title, Time.parse(created_at.to_s), allow_comments, url, identifier
+      @posts = []
+    end
+
+    # Threads are equal if all their attributes are equal.
+    def ==(other_thread)
+      id             == other_thread.id             &&
+      forum          == other_thread.forum          &&
+      slug           == other_thread.slug           &&
+      title          == other_thread.title          &&
+      created_at     == other_thread.created_at     &&
+      allow_comments == other_thread.allow_comments &&
+      url            == other_thread.url            &&
+      identifier     == other_thread.identifier
+    end
+    
+    # Returns an array of Thread objects representing the threads belonging to the given Forum.
+    def self.list(forum, opts = {})
+      response = Disqus::Api::get_thread_list(opts.merge(:forum_id =>forum.id, :forum_api_key => forum.key))
+      if response["succeeded"]
+        list = response["message"].map do |thread| 
+          Thread.new(
+            thread["id"],
+            forum,
+            thread["slug"],
+            thread["title"],
+            thread["created_at"],
+            thread["allow_comments"],
+            thread["url"],
+            thread["identifier"]
+          )
+        end
+      end
+    end
+
+    # Returns an array of posts belonging to this thread.
+    def posts(force_update = false)
+      if (@posts.nil? or @posts.empty? or force_update)
+        @posts = Disqus::Post.list(self)
+      end
+      @posts
+    end
+    
+    # Sets the provided values on the thread object.
+    #
+    # Options:
+    #
+    # * :thread_id
+    # * :title
+    # * :slug
+    # * :url
+    # * :allow_comments
+    def update(opts = {})
+      result = Disqus::Api::update_thread(opts.merge(
+        :forum_api_key  => forum.key,
+        :thread_id      => id,
+        :title          => title,
+        :slug           => slug,
+        :url            => url,
+        :allow_comments => allow_comments)
+      )
+      return result["succeeded"]
+    end
+    
+  end
+
+end

data/lib/disqus/version.rb

@@ -0,0 +1,8 @@
+module Disqus
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    TINY = 3
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/disqus/view_helpers.rb

@@ -0,0 +1,9 @@
+# Shortcuts to access the widgets as simple functions as opposed to using
+# their full qualified names.
+%w[combo comment_counts popular_threads recent_comments thread top_commenters].each do |method|
+  eval(<<-EOM)
+    def disqus_#{method}(options = {})
+      Disqus::Widget.#{method}(options)
+    end
+  EOM
+end

data/lib/disqus/widget.rb

@@ -0,0 +1,185 @@
+module Disqus
+
+  # Disqus Widget generator.
+  #
+  # All of the methods accept various options, and "account" is required for
+  # all of them. You can avoid having to pass in the account each time by
+  # setting it in the defaults like this:
+  #
+  #  Disqus::defaults[:account] = "my_account"
+  class Widget
+  
+    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 = ''
+        if opts[:developer]
+          s << '<script type="text/javascript">var disqus_developer = 1;</script>'
+        end
+        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.
+      #
+      # The Javascript sets the inner html to the comment count for any links
+      # on the page that have the anchor "disqus_thread". For example, "View
+      # Comments" below would be replaced by "1 comment" or "23 comments" etc.
+      #
+      #   <a href="http://my.website/article-permalink#disqus_thread">View Comments</a>
+      #   <a href="http://my.website/different-permalink#disqus_thread">View Comments</a>
+      # 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 top commenters 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 popular threads Disqus 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 recent comments Disqus 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 Disqus combo widget. This is a three-tabbed box with links
+      # popular threads, top posters, and recent threads.
+      # 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.
+      # * <tt>:default_tab:</tt> Should be 'people', 'recent', or 'popular'.
+      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 ArgumentError.new("You must specify an :account") if !opts[:account]
+        raise ArgumentError.new("Invalid color") if opts[:color] && !VALID_COLORS.include?(opts[:color])
+        raise ArgumentError.new("Invalid num_items") if opts[:num_items] && !VALID_NUM_ITEMS.include?(opts[:num_items])
+        raise ArgumentError.new("Invalid default_tab") if opts[:default_tab] && !VALID_DEFAULT_TABS.include?(opts[:default_tab])
+        raise ArgumentError.new("Invalid avatar size") if opts[:avatar_size] && !VALID_AVATAR_SIZES.include?(opts[:avatar_size])
+        raise ArgumentError.new("Invalid orientation") if opts[:orientation] && !VALID_ORIENTATIONS.include?(opts[:orientation])
+      end
+      
+    end
+  
+  end
+
+end

data/lib/disqus.rb

@@ -0,0 +1,52 @@
+%w[api author forum post thread version view_helpers widget].each do |file|
+  require File.join(File.dirname(__FILE__), "disqus", file)
+end
+
+# == From the {Disqus Website}[http://disqus.com]:
+
+# "Disqus, pronounced "discuss", is a service and tool for web comments and
+# discussions. The Disqus comment system can be plugged into any website, blog,
+# or application. Disqus makes commenting easier and more interactive, while
+# connecting websites and commenters across a thriving discussion community."
+# 
+# "Disqus is a free service to the general public with absolutely no inline
+# advertisements."
+
+# The Disqus gem helps you quickly and easily integrate Disqus's Javascript
+# widgets into your Ruby-based website. Adding Disqus to your site literally
+# takes only a few minutes. The Disqus gem also provides a complete
+# implementation of the Disqus API for more complex applications.
+
+# To use this code, please first create an account on Disqus[http://disqus.com].
+module Disqus
+  
+  @defaults = {
+    :api_key         => "",
+    :account         => "",
+    :developer       => false,
+    :container_id    => 'disqus_thread',
+    :avatar_size     => 48,
+    :color           => "grey",
+    :default_tab     => "popular",
+    :hide_avatars    => false,
+    :hide_mods       => true,
+    :num_items       => 15,
+    :show_powered_by => true,
+    :orientation     => "horizontal"
+  }
+  
+  # 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
+
+end

data/test/api_test.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ApiTest < Test::Unit::TestCase
+  
+  def setup
+    Disqus.defaults[:api_key] = DISQUS_TEST["api_key"]
+  end
+  
+  def test_create_post
+    mock_post_response('create_post.json')
+    the_post = Disqus::Api::create_post()
+    assert_equal "This is a mock post", the_post["message"]["message"]
+  end
+  
+  def test_get_forum_list
+    mock_get_response('get_forum_list.json')
+    forum_list = Disqus::Api::get_forum_list
+    assert_equal "Disqus Test", forum_list["message"][0]["name"]
+  end
+  
+  def test_get_forum_api_key
+    mock_get_response('get_forum_api_key.json')
+    forum_api_key = Disqus::Api::get_forum_api_key(:forum_id => 1234, :user_api_key=>"FAKE_KEY")
+    assert_equal "FAKE_FORUM_API_KEY", forum_api_key["message"]
+  end
+  
+  def test_get_thread_list
+    mock_get_response('get_thread_list.json')
+    thread_list = Disqus::Api::get_thread_list(:forum_api_key=>"FAKE_KEY")
+    assert_equal "this_is_the_thread_identifier", thread_list["message"].first["identifier"]
+  end
+  
+  def test_get_num_posts
+    mock_get_response('get_num_posts.json')
+    nums = Disqus::Api::get_num_posts(:thread_ids => [123,456], :forum_api_key=>"FAKE_KEY")
+    assert_equal [10,12], nums["message"][nums["message"].keys.first]
+  end
+  
+  def test_get_thread_by_url
+    mock_get_response('get_thread_by_url.json')
+    thread = Disqus::Api::get_thread_by_url(:url => "FAKE_URL", :forum_api_key=>"FAKE_KEY")
+    assert_equal "test_thread", thread["message"]["slug"]
+  end
+  
+  def test_get_thread_posts
+    mock_get_response('get_thread_posts.json')
+    thread_posts = Disqus::Api::get_thread_posts(:thread_id =>1234, :forum_api_key => "FAKE_KEY")
+    assert_equal "This is a mock post", thread_posts["message"].first["message"]
+  end
+  
+  def test_thread_by_identifier
+    mock_post_response('thread_by_identifier.json')
+    thread = Disqus::Api::thread_by_identifier(:identifier =>'foo_bar', :title => "Foo Bar", :forum_api_key => "FAKE_KEY")
+    assert_equal "Test thread", thread["message"]["thread"]["title"]
+  end
+  
+  def test_update_thread
+    mock_post_response('update_thread.json')
+    result = Disqus::Api::thread_by_identifier(:thread_id =>123, :title => "Foo Bar", :forum_api_key => "FAKE_KEY")
+    assert result["succeeded"]
+  end
+  
+  def test_comment_form
+    c = Disqus::Api::comment_form("myforum", "mythread")
+    assert_match(/myforum/, c)
+    assert_match(/mythread/, c)
+  end
+  
+  private
+  
+  def mock_get_response(file)
+    Disqus::Api.expects(:get).returns(File.read(File.dirname(__FILE__) + "/responses/#{file}"))  
+  end
+  
+  def mock_post_response(file)
+    Disqus::Api.expects(:post).returns(File.read(File.dirname(__FILE__) + "/responses/#{file}"))  
+  end
+
+end