ideaoforder-acts_as_disqusable 0.4.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+package
+coverage
+test/config.yml
+docs
+pkg

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/Manifest.txt

@@ -0,0 +1,38 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+config/website.yml
+disqus.gemspec
+init.rb
+lib/disqus.rb
+lib/disqus/api.rb
+lib/disqus/author.rb
+lib/disqus/forum.rb
+lib/disqus/post.rb
+lib/disqus/thread.rb
+lib/disqus/version.rb
+lib/disqus/view_helpers.rb
+lib/disqus/widget.rb
+tasks/rcov.rake
+test/api_test.rb
+test/config.yml.sample
+test/forum_test.rb
+test/merb_test.rb
+test/post_test.rb
+test/rails_test.rb
+test/responses/bad_api_key.json
+test/responses/create_post.json
+test/responses/get_forum_api_key.json
+test/responses/get_forum_list.json
+test/responses/get_num_posts.json
+test/responses/get_thread_by_url.json
+test/responses/get_thread_list.json
+test/responses/get_thread_posts.json
+test/responses/thread_by_identifier.json
+test/responses/update_thread.json
+test/test_helper.rb
+test/thread_test.rb
+test/view_helpers_test.rb
+test/widget_test.rb

data/README.rdoc

@@ -0,0 +1,149 @@
+== Acts-As-Disqusable Ruby Gem
+
+The Acts-As-Disqusable Gem helps you easily integrate the {Disqus}[http://disqus.com]
+commenting system into your website. It should work for any site programmed in Ruby.
+
+It's a fork of Norman Clarke's Disqus Gem and incorporates Thomas Reynolds's DisqusParty changes (namely, 
+switching to HTTParty and using Jeweler for gem creation, as well as ditching the view helpers). 
+
+Disqus API support is "beta." Right now we're using API version 1.1.
+
+=== What is Disqus?
+
+From the Disqus website:
+
+"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."
+
+=== Get it
+
+  gem install ideaoforder-acts_as_disqusable
+
+=== Use it:
+
+# easy!
+class YOUR_MODEL
+	acts_as_disqusable
+end
+
+# For multiple forums
+class YOUR_MODEL
+	acts_as_disqusable, :forum_id => X, :forum_shortname => X, :forum_api_key => X
+end
+
+# with nonstandard DB fields
+class YOUR_MODEL
+	# title, slug, and thread_id default to title, slug, and thread_id...surprise!
+	acts_as_disqusable, :title_column => 'name', 
+											:slug_column => 'permalink', 
+											:thread_id => 'your_mom',
+											:prefix => false # this defaults to the associated controller
+											# so Post would create a link like: '/posts/slug/
+											# you can set this to false for just: '/slug'
+											# or to a different path: '/blog/slug'
+end
+
+OPTIONAL:
+	You should create a :thread_id field in the database for each model
+	that is disqusable. This will result in fewer requests to Disqus.
+	Everything but YOUR_MODEL.comment_count() should work without it.
+
+==== Configure it:
+
+===== Example - This goes in config/disqus.yml:
+	- :api_key: YOUR_API_KEY
+	- :account: YOUR_ACCOUNT_NAME
+	- :developer: true or false
+	
+	If you're only connecting 1 forum to your site:
+	
+	- :forum_api_key: YOUR_FORUM_API_KEY
+	- :forum_id: YOUR_FORUM_ID
+	- :forum_shortname: YOUR_FORUM_SHORTNAME
+	
+	Otherwise, the forum info goes in the model that's disqusable.
+	You could use a different forum for each model.
+	It would be better to use the new category feature, however.
+	Sadly, I haven't had time to program that yet.
+
+===== Options
+
+  :api_key => "" # your api key
+  :account => "", # your disqus account
+  :developer => false, # allows for threads to work on localhost if set to true
+  :container_id => 'disqus_thread', # desired thread container
+  :avatar_size => 48, # squared pixel size of avatars
+  :num_items => 5, # number of comments to display / this is just the default
+	:forum_api_key => "" # your forum api key
+	:forum_id => "" # your forum id
+	:forum_shortname => "" # your forum shortname
+
+==== To get your forum info, in the console:
+
+f = Disqus::Forum.all
+
+# find your forum, let's say it's the first
+
+f.first.id
+f.first.key
+f.first.shortname
+
+==== So:
+
+	Let's say Post are disqusable.
+	
+	Then 
+	
+		Post.comments(:limit => 5, :exclude => 'spam') # class level
+		
+	Will grab the 5 most recent non-spam comments. The default
+	limit and exclude are 5 and 'spam'.
+	
+		@post.comments
+		
+	Will grab the comments for a post.
+	
+		@post.comment_count
+		
+  Will grab the number of comments for a given post.
+	
+		@post.comment_form
+		
+	Will create a comment form appropriate to the @post. This still uses the
+	older javascript form.
+
+==== There are lots of other options for Threads/Forums etc.
+
+
+==== Work with the Disqus API:
+
+See the Disqus::Api class for more info on the Disqus API. You can also read
+the {Disqus developer info here}[http://disqus.com/docs/api/].
+
+=== Hack it:
+
+Github repository: 
+  
+  http://github.com/ideaoforder/acts_as_disqusable/
+
+=== Learn more about Disqus:
+
+{http://disqus.com}[http://disqus.com]
+
+=== Thanks to the following contributors:
+* {Thomas Reynolds}[http://github.com/tdreyno] - DisqusParty Gem
+* {Norman Clarke}[http://github.com/norman] - Disqus Gem
+* {Matt Van Horn}[http://github.com/mattvanhorn] - Disqus API
+
+=== Legal Stuff
+
+The Disqus Ruby gem was not created by, nor is officially supported by
+Disqus.com or Big Head Labs, Inc. Use it at your own risk and your own
+responsibility under the terms of the MIT License.
+
+Copyright (c) 2008 {Mark Dickson}[mailto:mark@sitesteaders.com], released under
+the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "acts_as_disqusable"
+    gemspec.summary = "Uses the Disqus API to make model(s) comment-on-able"
+    gemspec.description = "Uses the Disqus API to make model(s) comment-on-able"
+    gemspec.email = "mark@sitesteaders.com"
+    gemspec.homepage = "http://github.com/ideaoforder/disqus"
+    gemspec.authors = ["Mark Dickson", "Thomas Reynolds", "Norman Clarke", "Matthew Van Horn"]
+    gemspec.add_dependency('httparty', '>= 0.4.4')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/acts_as_disqusable.gemspec

@@ -0,0 +1,80 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_disqusable}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Dickson", "Thomas Reynolds", "Norman Clarke", "Matthew Van Horn"]
+  s.date = %q{2009-08-05}
+  s.description = %q{Uses the Disqus API to make model(s) comment-on-able}
+  s.email = %q{mark@sitesteaders.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "Manifest.txt",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_disqusable.gemspec",
+     "lib/acts_as_disqusable.rb",
+     "lib/acts_as_disqusable/author.rb",
+     "lib/acts_as_disqusable/forum.rb",
+     "lib/acts_as_disqusable/post.rb",
+     "lib/acts_as_disqusable/thread.rb",
+     "lib/disqus.rb",
+     "tasks/rcov.rake",
+     "test/api_test.rb",
+     "test/config.yml.sample",
+     "test/forum_test.rb",
+     "test/merb_test.rb",
+     "test/post_test.rb",
+     "test/rails_test.rb",
+     "test/responses/bad_api_key.json",
+     "test/responses/create_post.json",
+     "test/responses/get_forum_api_key.json",
+     "test/responses/get_forum_list.json",
+     "test/responses/get_num_posts.json",
+     "test/responses/get_thread_by_url.json",
+     "test/responses/get_thread_list.json",
+     "test/responses/get_thread_posts.json",
+     "test/responses/thread_by_identifier.json",
+     "test/responses/update_thread.json",
+     "test/test_helper.rb",
+     "test/thread_test.rb",
+     "test/view_helpers_test.rb",
+     "test/widget_test.rb"
+  ]
+  s.homepage = %q{http://github.com/ideaoforder/disqus}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Uses the Disqus API to make model(s) comment-on-able}
+  s.test_files = [
+    "test/merb_test.rb",
+     "test/view_helpers_test.rb",
+     "test/widget_test.rb",
+     "test/api_test.rb",
+     "test/post_test.rb",
+     "test/thread_test.rb",
+     "test/rails_test.rb",
+     "test/forum_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.4"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.4"])
+  end
+end

data/lib/acts_as_disqusable.rb

@@ -0,0 +1,155 @@
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    module Disqusable #:nodoc:
+      require 'disqus'
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      module ClassMethods
+        # Macro that adds theme for object
+        def acts_as_disqusable(options = {})
+          @@configuration = YAML::load(File.open("#{RAILS_ROOT}/config/disqus.yml"))
+          @@configuration.update(options) if options.is_a?(Hash)
+          include ActiveRecord::Acts::Disqusable::InstanceMethods
+          
+          after_create :create_thread
+
+          def thread_column
+            @@configuration[:thread_column] || 'thread_id'
+          end          
+          
+          def title_column
+            @@configuration[:title_column] || 'title'
+          end
+          
+          def slug_column
+            @@configuration[:slug_column] || 'slug'
+          end
+          
+          def prefix
+            if @@configuration[:prefix].nil?
+              return self.to_s.downcase + '-'
+            elsif @@configuration[:prefix]
+              return @@configuration[:prefix] + '-'
+            else
+              return ''
+            end
+          end
+
+          def forum_id
+            @@configuration[:forum_id].to_s || nil
+          end
+          
+          def forum_api_key
+            @@configuration[:forum_api_key] || nil
+          end
+          
+          def forum_shortname
+            @@configuration[:forum_shortname] || nil
+          end
+          
+          def threads
+            Disqus::Forum.find(self.forum_id).threads
+          end        
+          
+          def find_thread_by_url(url)
+            Disqus::Forum.get_thread_by_url(url, self.forum_api_key)
+          end
+          
+          def comment_count(ids={})
+            if self.column_names.include? self.thread_column
+              if !ids.is_a? Hash
+                c = "id IN (" + ids.join(',')+ ")"
+              else
+                c = nil
+              end
+              thread_ids = Post.all(:conditions => c, :select => :thread_id).collect(&:thread_id).compact.join(',')
+              if thread_ids.length > 0
+                Disqus::Forum.posts_count(thread_ids, self.forum_api_key)
+              else 
+                Hash.new
+              end
+            else
+              'This operation is not supported without a thread_column.'
+            end
+          end
+          
+          # limit — Number of entries that should be included in the response. Default is 25.
+          # start — Starting point for the query. Default is 0.
+          # filter — Type of entries that should be returned (new, spam or killed).
+          # exclude — Type of entries that should be excluded from the response (new, spam or killed).
+          def comments(opts={})
+            Disqus::Forum.posts(self.forum_api_key, opts)
+          end
+          
+          def comment_permalink(comment, opts={})
+            title = comment.thread['title']
+            if comment.thread['url']
+              permalink = comment.thread['url']
+            else
+              url = comment.thread['identifier'].first.sub(self.prefix, '')
+              path = opts[:path] || self.to_s.pluralize.downcase
+              permalink = "/#{path}/#{url}"
+            end
+            return "<a href=\"#{permalink}\" class=\"#{opts[:class]}\" title=\"#{opts[:title]}\">#{title}</a>"
+          end
+        end
+      end
+
+      module InstanceMethods
+        def thread_identifier
+          self.class.prefix + self.send(self.class.slug_column)
+        end
+        
+        def thread
+          Disqus::Thread.find_or_create(self.send(self.class.title_column), self.thread_identifier)
+        end     
+        
+        # limit — Number of entries that should be included in the response. Default is 25.
+        # start — Starting point for the query. Default is 0.
+        # filter — Type of entries that should be returned (new, spam or killed).
+        # exclude — Type of entries that should be excluded from the response (new, spam or killed).
+        def comments(opts={})
+          if self.respond_to? self.class.thread_column and self.send(self.class.thread_column)
+            Disqus::Thread.posts(self.send(self.class.thread_column), opts)
+          else # two separate calls
+            Disqus::Thread.find_or_create(title, slug).posts(opts)
+          end
+        end
+        
+        def comment_count
+          if self.respond_to? self.class.thread_column and self.send(self.class.thread_column)
+            Disqus::Forum.posts_count(self.send(self.class.thread_column), self.class.forum_api_key)
+          else # two separate calls
+            Disqus::Thread.find_or_create(title, slug).posts_count
+          end
+        end
+
+        def comment_form
+          forum_shortname = self.class.forum_shortname
+          thread_indentifier = self.thread_identifier
+          url = 'http://disqus.com/api/reply.js?' +
+            "forum_shortname=#{forum_shortname}&" +
+            "thread_identifier=#{thread_identifier}"
+          s = '<div id="dsq-reply">'
+          s << '<script type="text/javascript" src="%s"></script>' % url
+          s << '</div>'
+          return s
+        end
+        
+        private        
+          def create_thread
+            t = Disqus::Thread.find_or_create(self.send(self.class.title_column), self.thread_identifier)
+            if self.respond_to? self.class.thread_column
+              self.write_attribute(self.class.thread_column, t.id)
+              self.save
+            end
+          end 
+      end      
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecord::Acts::Disqusable)