disqussion 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+coverage/
+.DS_Store
+.bundle/
+log/*.log
+pkg/
+doc/*
+.yardcache/*
+.yardoc/*
+spec/.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source :gemcutter
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    disqussion (0.0.1)
+      faraday (~> 0.6.1)
+      faraday_middleware (~> 0.6.3)
+      hashie (~> 1.0.0)
+      multi_json (~> 1.0.0)
+      rash (~> 0.3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    addressable (2.2.5)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.2)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    faraday (0.6.1)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (< 2, >= 1.1.0)
+    faraday_middleware (0.6.3)
+      faraday (~> 0.6.0)
+    hashie (1.0.0)
+    json (1.5.1)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    maruku (0.6.0)
+      syntax (>= 1.0.0)
+    multi_json (1.0.1)
+    multipart-post (1.1.0)
+    nokogiri (1.4.4)
+    rack (1.2.2)
+    rake (0.8.7)
+    rash (0.3.0)
+      hashie (~> 1.0.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.4)
+    syntax (1.0.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.5)
+  disqussion!
+  json (~> 1.5)
+  maruku (~> 0.6)
+  nokogiri (~> 1.4)
+  rake (~> 0.8)
+  rspec (~> 2.5)
+  ruby-debug19
+  simplecov (~> 0.4)
+  webmock (~> 1.6)
+  yard (~> 0.6)

data/HISTORY.mkd

@@ -0,0 +1,5 @@
+HISTORY
+=======
+0.0.1 - May 10, 2011
+----------------------
+* First release

data/LICENSE.mkd

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jérémy Van de Wyngaert
+
+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.mkd

@@ -0,0 +1,139 @@
+The Disqussion Ruby Gem
+====================
+A Ruby wrapper for the Disqus API
+
+IMPORTANT: This gem is non-usable for production, beta version expected on May 9th 2011
+
+Installation
+------------
+``` sh
+gem install disqussion
+```
+
+Documentation
+-------------
+<http://rdoc.info/gems/disqussion>
+
+Does your project or organization use this gem?
+-----------------------------------------------
+Add it to the [apps](http://github.com/jeremyvdw/disqussion/wiki/apps) wiki!
+
+Continuous Integration
+----------------------
+[![Build Status](http://travis-ci.org/jeremyvdw/disqussion.png)](http://travis-ci.org/jeremyvdw/disqussion)
+
+What's in 0.1?
+------------------
+
+The error classes are consistent with [Disqus's documented response codes](http://disqus.com/api/docs/errors/).
+Error details from Disqus API are encapsulated in HTTP response.
+
+<table>
+  <thead>
+    <tr>
+      <th>Response Code</th>
+      <th>Error</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><tt>400</tt></td>
+      <td><tt>Disqussion::BadRequest</tt></td>
+    </tr>
+    <tr>
+      <td><tt>401</tt></td>
+      <td><tt>Disqussion::Unauthorized</tt></td>
+    </tr>
+    <tr>
+      <td><tt>403</tt></td>
+      <td><tt>Disqussion::Forbidden</tt></td>
+    </tr>
+    <tr>
+      <td><tt>404</tt></td>
+      <td><tt>Disqussion::NotFound</tt></td>
+    </tr>
+    <tr>
+      <td><tt>500</tt></td>
+      <td><tt>Disqussion::InternalServerError</tt></td>
+    </tr>
+  </tbody>
+</table>
+
+Here are a few reasons use (and improve) this gem:
+
+* Full Ruby 1.9 compatibility: All code and specs now work in the latest version of Ruby
+* Support for HTTP proxies
+* Support for multiple HTTP adapters: NetHttp (default), em-net-http (async), Typhoeus, Patron, or ActionDispatch
+* SSL: On by default for increased [speed](http://gist.github.com/652330) and security
+
+Help! I'm getting: "Did not recognize your engine specification. Please specify either a symbol or a class. (RuntimeError)"
+---------------------------------------------------------------------------------------------------------------------------
+
+If you're using the JSON request format (i.e., the default), you'll need to
+explicitly require a JSON library. We recommend [yajl-ruby](http://github.com/brianmario/yajl-ruby).
+
+Usage Examples
+--------------
+``` ruby
+require "rubygems"
+require "disqussion"
+
+# Certain methods require authentication. To get your Disqus credentials,
+# register an app at http://disqus.com/api/applications/
+Disqussion.configure do |config|
+  config.api_key = YOUR_API_KEY
+  config.api_secret = YOUR_API_SECRET
+end
+
+# Get an application's usage details
+puts Disqussion::Client.applications.listUsage("the88")
+```
+
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/jeremyvdw/disqussion/issues)
+* by reviewing patches
+
+All contributors will be added to the [HISTORY](https://github.com/jeremyvdw/disqussion/blob/master/HISTORY.mkd)
+file and will receive the respect and gratitude of the community.
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](http://github.com/jeremyvdw/disqussion/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issuse by voting it up. When submitting a
+bug report, please include a [Gist](http://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. Ideally, a bug report should include a pull request with failing specs.
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Add specs for your feature or bug fix.
+7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+8. Commit and push your changes.
+9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+Thanks
+------
+This gem is based on the work by John Nunemaker, Wynn Netherland, Erik Michaels-Ober and Steve Richert on the [Twitter gem](http://github.com/jnunemaker/twitter)
+
+Copyright
+---------
+Copyright (c) 2011 Jérémy Van de Wyngaert.
+See [LICENSE](https://github.com/jeremyvdw/disqussion/blob/master/LICENSE.mkd) for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['HISTORY.mkd', 'LICENSE.mkd', 'lib/**/*.rb']
+    task.options = [
+      '--protected',
+      '--output-dir', 'doc/yard',
+      '--tag', 'format:Supported formats',
+      '--tag', 'authenticated:Requires Authentication',
+      '--tag', 'rate_limited:Rate Limited',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/disqussion.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/disqussion/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "disqussion"
+  s.version     = Disqussion::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jérémy Van de Wyngaert"]
+  s.email       = ['jeremyvdw@gmail.com']
+  s.homepage    = 'https://github.com/jeremyvdw/disqussion'
+  s.summary     = %q{Disqus API v3 wrapper}
+  s.description = %q{Disqus API v3 wrapper}
+
+  s.rubyforge_project = "disqussion"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('json', '~> 1.5')
+  s.add_development_dependency('nokogiri', '~> 1.4')
+  s.add_development_dependency('maruku', '~> 0.6')
+  s.add_development_dependency('rake', '~> 0.8')
+  s.add_development_dependency('rspec', '~> 2.5')
+  s.add_development_dependency('simplecov', '~> 0.4')
+  s.add_development_dependency('webmock', '~> 1.6')
+  s.add_development_dependency('yard', '~> 0.6')
+  s.add_development_dependency('ZenTest', '~> 4.5')
+  s.add_development_dependency('ruby-debug19')
+  
+  s.add_runtime_dependency('hashie', '~> 1.0.0')
+  s.add_runtime_dependency('faraday', '~> 0.6.1')
+  s.add_runtime_dependency('faraday_middleware', '~> 0.6.3')
+  s.add_runtime_dependency('multi_json', '~> 1.0.0')
+  s.add_runtime_dependency('rash', '~> 0.3.0')
+end

data/lib/disqussion/api.rb

@@ -0,0 +1,21 @@
+require 'disqussion/connection'
+require 'disqussion/request'
+
+module Disqussion
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Disqussion.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+  end
+end

data/lib/disqussion/client/applications.rb

@@ -0,0 +1,20 @@
+module Disqussion
+  class Applications < Client
+    # Returns the API usage per day for this application.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: true
+    # @limited: false
+    # @return [Hashie::Rash] API usage per day for this application.
+    # @param application [Integer] Defaults to null
+    # @param days [Integer] Defaults to 30, Maximum length of 30
+    # @example Returns the API usage per day for this application.
+    #   Disqussion::Client.applications.listUsage
+    # @see http://disqus.com/api/3.0/applications/listUsage.json
+    def listUsage(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      get('applications/listUsage', options)
+    end
+  end
+end

data/lib/disqussion/client/blacklists.rb

@@ -0,0 +1,4 @@
+module Disqussion
+  class Blacklists < Client
+  end
+end

data/lib/disqussion/client/categories.rb

@@ -0,0 +1,4 @@
+module Disqussion
+  class Categories < Client
+  end
+end

data/lib/disqussion/client/exports.rb

@@ -0,0 +1,4 @@
+module Disqussion
+  class Exports < Client
+  end
+end

data/lib/disqussion/client/forums.rb

@@ -0,0 +1,122 @@
+module Disqussion
+  class Forums < Client
+    # Creates a new forum.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: true
+    # @limited: false
+    # @param website [String] Disqus website name.
+    # @param name [String] Forum name.
+    # @param short_name [String] Forum short name (aka forum id).
+    # @return [Hashie::Rash] New forum infos
+    # @example Creates a new forum 'myforum'
+    #   Disqussion::Client.forums.create("the88", "My Forum", "myforum")
+    # @see: http://disqus.com/api/3.0/forums/create.json
+    def create(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      if args.size == 3
+        options.merge!(:website => args[0], :name => args[1], :short_name => args[2])
+        response = get('forums/create', options)
+      else
+        puts "#{Kernel.caller.first}: forums.create expects 3 arguments: website, name, short_name"
+      end
+    end
+    
+    # Returns forum details.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param forum [String] Forum ID (aka short name).
+    # @return [Hashie::Rash] Details on the requested forum.
+    # @example Return extended information for forum 'myforum'
+    #   Disqussion::Client.forums.details("myforum")
+    # @see: http://disqus.com/api/3.0/forums/details.json
+    def details(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:forum] = args.first
+      response = get('forums/details', options)
+    end
+    
+    # Returns a list of categories within a forum.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param forum [String] Forum ID (aka short name).
+    # @return [Hashie::Rash] Details on the requested list of categories.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Datetime, Timestamp] :since. Unix timestamp (or ISO datetime standard). Defaults to null
+    # @option options [Integer] :cursor. Defaults to null
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100
+    # @option options [String] :order. Defaults to "asc". Choices: asc, desc
+    # @example Return extended information for forum 'myforum'
+    #   Disqussion::Client.forums.listCategories("myforum", {:cursor => 10, :limit => 10, :order => 'asc'})
+    # @see: http://disqus.com/api/3.0/forums/details.json
+    def listCategories(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:forum] = args.first
+      response = get('forums/listCategories', options)
+    end
+    
+    # NOTE: to be implemented
+    # Returns a list of users active within a forum ordered by most likes received.
+    # @see: http://disqus.com/api/3.0/forums/listMostLikedUsers.json
+    def listMostLikedUsers(*args)
+    end
+    
+    # Returns a list of posts within a forum.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp, rss
+    # @authenticated: false
+    # @limited: false
+    # @param forum [String] Forum ID (aka short name).
+    # @return [Hashie::Rash] Details on the list of posts.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Datetime, Timestamp] :since. Defaults to null. Unix timestamp (or ISO datetime standard).
+    # @option options [Integer, String] :related. Allows multiple. Defaults to []. You may specify relations to include with your response. Choices: thread.
+    # @option options [Integer] :cursor. Defaults to null
+    # @option options [Integer] :limit. Defaults to 25. Maximum number of posts to return. Maximum length of 100
+    # @option options [Integer] :query. Defaults to null. 
+    # @option options [String, Array] :include allows multiple. Defaults to ["approved"]. Choices: unapproved, approved, spam, deleted, flagged
+    # @option options [String] :order. Defaults to "desc". Choices: asc, desc
+    # @example Return list of (all) posts for forum 'myforum', including related threads
+    #   Disqussion::Client.forums.listPosts("myforum", {:related => ["thread"], :include => ["spam", "deleted", "flagged"]})
+    # @see: http://disqus.com/api/3.0/forums/listPosts.json
+    def listPosts(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:forum] = args.first
+      response = get('forums/listPosts', options)
+    end
+    
+    # Returns a list of threads within a forum.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp, rss
+    # @authenticated: false
+    # @limited: false
+    # @param forum [String] Forum ID (aka short name).
+    # @return [Hashie::Rash] Details on the list of posts.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer, String, Array] :thread. Allows multiple. Defaults to null. Looks up a thread by ID. You may pass use the 'ident' or 'link' query types instead of an ID by including 'forum'
+    # @option options [Datetime, Timestamp] :since. Unix timestamp (or ISO datetime standard). Defaults to null
+    # @option options [Integer, String] :related. Allows multiple. Defaults to []. You may specify relations to include with your response. Choices: forum, author.
+    # @option options [Integer] :cursor. Defaults to null
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100
+    # @option options [String, Array] :include allows multiple. Defaults to ["open", "close"]. Choices: open, closed, killed.
+    # @option options [String] :order. Defaults to "desc". Choices: asc, desc
+    # @example Return list of (all) threads for forum 'myforum', including closed ones and related forums.
+    #   Disqussion::Client.forums.listThreads("myforum", {:related => ["forum"], :include => ["close"]})
+    # @see: http://disqus.com/api/3.0/forums/listThreads.json
+    def listThreads(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:forum] = args.first
+      response = get('forums/listThreads', options)
+    end
+    
+  end
+end

data/lib/disqussion/client/imports.rb

@@ -0,0 +1,4 @@
+module Disqussion
+  class Imports < Client
+  end
+end