This repository has been archived by the owner. It is now read-only.
Permalink
Browse files

Misc cleanups and de-WTF-ification. Migrated away from newgem.

  • Loading branch information...
norman committed Mar 30, 2010
1 parent 8726125 commit 2888576d9d41c43e25e834960513393c056d390a
View
@@ -1,6 +1,5 @@
.DS_Store
package
coverage
-test/config.yml
docs
pkg
View
@@ -0,0 +1,21 @@
+# Changelog
+
+## 1.0.3 (2010-03-30)
+
+* Updates for API version 1.1 (Fabio Akita)
+* Misc cleanups (Fabio Akita, Stéphane Busso, Norman Clarke)
+
+## (1.0.2 2009-10-05)
+
+* The Disqus::API.post method now returns the response body rather than the response object (Nat Budin)
+* Disqus::API.create_post now complies with DISQUS's API requirements (Nat Budin)
+
+## (1.0.1 2009-01-19)
+
+* Improve docs (Quin Hoxie)
+* Add developer and container_id options for comment threads. (Quin Hoxie)
+
+## 1.0.0 2009-01-05
+
+* Support for Disqus API added (Matthew Van Horn)
+* Reorganized gem to use newgem
View
@@ -1,15 +0,0 @@
-== 1.0.2 2009-10-05
- 2 bug fixes:
- * The Disqus::API.post method now returns the response body rather than the response object (Nat Budin)
- * Disqus::API.create_post now complies with DISQUS's API requirements (Nat Budin)
-
-== 1.0.1 2009-01-19
- 2 minor enhancements:
- * Improve docs (Quin Hoxie)
- * Add developer and container_id options for comment threads. (Quin Hoxie)
-
-== 1.0.0 2009-01-05
-* 1 major enhancement:
- * Support for Disqus API added (Matthew Van Horn)
-* 1 minor enhancement:
- * Reorganized gem to use newgem
View
18 LICENSE
@@ -0,0 +1,18 @@
+Copyright (c) 2008-2010 Norman Clarke
+
+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.
View
@@ -1,20 +0,0 @@
-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.
View
@@ -1,37 +0,0 @@
-History.txt
-MIT-LICENSE
-Manifest.txt
-README.rdoc
-Rakefile
-config/website.yml
-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
View
@@ -0,0 +1,96 @@
+# Disqus
+
+The Disqus Gem helps you easily integrate the [Disqus](http://disqus.com)
+commenting system into your Ruby-based website. It includes a Ruby wrapper for
+[Disqus's REST API](http://wiki.disqus.net/API), and views helpers to generate
+their Javasript widgets.
+
+## 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."
+
+
+### Getting it
+
+ gem install disqus
+
+### Using it
+
+#### Configure it
+
+ Disqus::defaults[:account] = "my_disqus_account"
+ # Optional, only if you're using the API
+ Disqus::defaults[:api_key] = "my_disqus_api_key"
+
+
+#### Options
+
+ :api_key => "" # your api key
+ :account => "", # your disqus account
+ :developer => false, # allows threads to work on localhost
+ :container_id => 'disqus_thread', # desired thread container
+ :avatar_size => 48, # squared pixel size of avatars
+ :color => "grey", # theme color
+ :default_tab => "popular", # default widget tab
+ :hide_avatars => false, # hide or show avatars
+ :hide_mods => true, # hide or show moderation
+ :num_items => 15, # number of comments to display
+ :show_powered_by => true, # show or hide powered by line
+ :orientation => "horizontal" # comment orientation
+
+#### Show the comment threads widget on a post page
+
+ # Loads the commenting system
+ disqus_thread
+
+ # 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>
+ disqus_comment_counts
+
+#### Show the combo widget on a post page
+
+ disqus_combo(:color => "blue", :hide_mods => false, :num_items => 20)
+
+#### Show the comment count on a permalink
+
+ link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
+ ...
+ disqus_comment_counts
+
+#### 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/norman/disqus](http://github.com/norman/disqus)
+
+### Learn more about Disqus:
+
+[http://disqus.com](http://disqus.com)
+
+### Thanks to the following contributors:
+
+* {Matt Van Horn}[http://github.com/mattvanhorn] - Disqus API
+* {Quin Hoxie}[http://github.com/qhoxie] - Merb support
+
+### 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-2010 Norman Clarke. Released under the MIT license
View
@@ -1,143 +0,0 @@
-== 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,
-and has view helpers for Rails and Merb.
-
-Support for the Disqus Javascript widgets is stable. Disqus API support is
-"beta."
-
-=== 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 disqus
-
-==== Bleeding Edge
-
- gem install norman-disqus --source http://gems.github.com
-
-=== Use it:
-
-==== Configure it:
-
-===== Generic example:
-
- Disqus::defaults[:account] = "my_disqus_account"
- # Optional, only if you're using the API
- Disqus::defaults[:api_key] = "my_disqus_api_key"
-
-===== Rails example:
-
- # in config/development.rb (or production.rb, test.rb, etc.)
- config.after_initialize do
- Disqus::defaults[:account] = "my_disqus_account"
- # Optional, only if you're using the API
- Disqus::defaults[:api_key] = "my_disqus_api_key"
- end
-
-Note that here the "after initialize" is necessary, otherwise your settings
-won't be set properly.
-
-===== Merb example:
-
- # in config/init.rb
- Merb::BootLoader.after_app_loads do
- Disqus::defaults[:account] = "my_disqus_account"
- # Optional, only if you're using the API
- Disqus::defaults[:api_key] = "my_disqus_api_key"
- end
-
-Note that here the "after_app_loads" is necessary, otherwise your settings
-won't be set properly.
-
-===== Options
-
- :api_key => "" # your api key
- :account => "", # your disqus account
- :developer => false, # allows for threads to work on localhost
- :container_id => 'disqus_thread', # desired thread container
- :avatar_size => 48, # squared pixel size of avatars
- :color => "grey", # theme color
- :default_tab => "popular", # default widget tab
- :hide_avatars => false, # hide or show avatars
- :hide_mods => true, # hide or show moderation
- :num_items => 15, # number of comments to display
- :show_powered_by => true, # show or hide powered by line
- :orientation => "horizontal" # comment orientation
-
-==== Show the comment threads widget on a post page:
-
- # Loads the commenting system
- disqus_thread
-
- # Or if you're not using Rails/Merb:
- Disqus::Widget::thread
-
- # 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>
- disqus_comment_counts
-
- # Or if you're not using Rails/Merb:
- Disqus::Widget::comment_counts
-
-==== Show the combo widget on a post page:
-
- disqus_combo(:color => "blue", :hide_mods => false, :num_items => 20)
-
- # Or for non-Rails/Merb:
- Disqus::Widget::combo(:color => "blue", :hide_mods => false, :num_items => 20)
-
-==== Show the comment count on a permalink:
-
- link_to("Permalink", post_path(@post, :anchor => "disqus_thread"))
- ...
- disqus_comment_counts
-
- # Or for non-Rails/Merb:
- Disqus::Widget::comment_counts
-
-==== 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/norman/disqus
-
-=== Submit bug reports:
-
-Please use our {Lighthouse}[http://randomba.lighthouseapp.com/projects/16065-disqus/].
-
-=== Learn more about Disqus:
-
-{http://disqus.com}[http://disqus.com]
-
-=== Thanks to the following contributors:
-
-* {Matt Van Horn}[http://github.com/mattvanhorn] - Disqus API
-* {Quin Hoxie}[http://github.com/qhoxie] - Merb support
-
-=== 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 {Norman Clarke}[mailto:norman@randomba.org], released under
-the MIT license
Oops, something went wrong.

0 comments on commit 2888576

Please sign in to comment.