disqussion 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    disqussion (0.0.2)
+    disqussion (0.0.4)
       faraday (~> 0.6.1)
       faraday_middleware (~> 0.6.3)
       hashie (~> 1.0.0)
@@ -12,7 +12,7 @@ GEM
   remote: http://rubygems.org/
   specs:
     ZenTest (4.5.0)
-    addressable (2.2.5)
+    addressable (2.2.6)
     archive-tar-minitar (0.5.2)
     columnize (0.3.2)
     crack (0.1.8)
@@ -36,14 +36,14 @@ GEM
     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)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.0)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
     ruby-debug-base19 (0.11.25)
       columnize (>= 0.3.1)
       linecache19 (>= 0.5.11)
@@ -56,12 +56,12 @@ GEM
       archive-tar-minitar (>= 0.5.2)
     simplecov (0.4.2)
       simplecov-html (~> 0.4.4)
-    simplecov-html (0.4.4)
+    simplecov-html (0.4.5)
     syntax (1.0.0)
-    webmock (1.6.2)
-      addressable (>= 2.2.2)
+    webmock (1.6.4)
+      addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
-    yard (0.6.8)
+    yard (0.7.1)
 
 PLATFORMS
   ruby

data/HISTORY.mkd

@@ -1,6 +1,10 @@
 HISTORY
 =======
 
+0.0.4 - May 19, 2011
+----------------------
+* Added following features: Categories, Exports, Imports, Reports
+
 0.0.3 - May 18, 2011
 ----------------------
 * Added following missing features: Users#listActiveForums, Users#listForums, Users#listPosts, Users#unfollow, Forums#listMostLikedUsers, Forums#listUsers

data/README.mkd

@@ -2,8 +2,6 @@ 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
@@ -22,12 +20,14 @@ Continuous Integration
 ----------------------
 [![Build Status](http://travis-ci.org/jeremyvdw/disqussion.png)](http://travis-ci.org/jeremyvdw/disqussion)
 
-What's in 0.0.3?
+What's in 0.0.4?
 ----------------
 
-Disqussion currently covers *only* stable Disqus API for: applications, forums, posts, reactions, threads and users features.
+Disqussion currently covers *only* stable Disqus API features for: applications, categories, exports, forums, imports, posts, reactions, reports, threads and users.
+
+Missing following features: blacklists and whitelists.
 
-The error classes are consistent with [Disqus's documented response codes](http://disqus.com/api/docs/errors/).
+The error classes are consistent with [Disqus documented response codes](http://disqus.com/api/docs/errors/).
 Error details from Disqus API are encapsulated in HTTP response.
 
 <table>

data/lib/disqussion/client/categories.rb

@@ -1,4 +1,115 @@
 module Disqussion
   class Categories < Client
+    # Creates a new category.
+    # @accessibility: public key, secret key
+    # @methods: POST
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param forum [String] Looks up a forum by ID (aka short name)
+    # @param title [String] Maximum length of 50
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :default. Defaults to false.
+    # @return [Hashie::Rash] New category infos 
+    # @example Creates a new category "My category" in forum "the88"
+    #   Disqussion::Client.categories.create("the88", "My category")
+    # @see: http://disqus.com/api/3.0/categories/create.json
+    def create(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      if args.size == 2
+        options.merge!(:forum => args[0], :title => args[1])
+        response = post('categories/create', options)
+      else
+        puts "#{Kernel.caller.first}: categories.create expects 2 arguments: forum, title"
+      end
+    end
+    
+    # Returns category details.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param category [Integer] Looks up a category by ID.
+    # @return [Hashie::Rash] Details on the requested category.
+    # @example 
+    #   Disqussion::Client.categories.details(19122)
+    # @see: http://disqus.com/api/3.0/categories/details.json
+    def details(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:category] = args.first
+      response = get('categories/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
+    # @return [Hashie::Rash] Details on the requested list of categories.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Array, String] :forum allow multiple. Defaults to null. Looks up a forum by ID (aka short name)
+    # @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 list of categories within forum 'myforum'
+    #   Disqussion::Client.categories.list("myforum", {:cursor => 10, :limit => 10, :order => 'asc'})
+    # @see: http://disqus.com/api/3.0/categories/list.json
+    def list(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      response = get('categories/list', options)
+    end
+    
+    # Returns a list of posts within a category.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp, rss
+    # @authenticated: false
+    # @limited: false
+    # @param forum [Integer] Category ID.
+    # @return [Hashie::Rash] Details on the requested list of posts.
+    # @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, String] :related. Allows multiple. Defaults to []. You may specify relations to include with your response. Choices: forum, thread.
+    # @option options [Integer] :cursor. Defaults to null.
+    # @option options [Integer] :limit. Defaults to 25. 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 "asc". Choices: asc, desc.
+    # @example Return list of posts within category 827231
+    #   Disqussion::Client.categories.listPosts(827231, {:cursor => 10, :limit => 10, :order => 'asc'})
+    # @see: http://disqus.com/api/3.0/categories/listPosts.json
+    def listPosts(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:category] = args.first
+      response = get('categories/listPosts', options)
+    end
+    
+    # Returns a list of threads within a category sorted by the date created.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp, rss
+    # @authenticated: false
+    # @limited: false
+    # @param forum [Integer] Category ID.
+    # @return [Hashie::Rash] Details on the requested list of threads.
+    # @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, String] :related. Allows multiple. Defaults to []. You may specify relations to include with your response. Choices: forum, thread.
+    # @option options [Integer] :cursor. Defaults to null.
+    # @option options [Integer] :limit. Defaults to 25. 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 "asc". Choices: asc, desc.
+    # @example Return list of threads within category 827231
+    #   Disqussion::Client.categories.listThreads(827231, {:cursor => 10, :limit => 10, :order => 'asc'})
+    # @see: http://disqus.com/api/3.0/categories/listThreads.json
+    def listThreads(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:category] = args.first
+      response = get('categories/listThreads', options)
+    end
   end
-end
+end

data/lib/disqussion/client/exports.rb

@@ -1,4 +1,26 @@
 module Disqussion
   class Exports < Client
+    # Export a forum
+    # @accessibility: public key, secret key
+    # @methods: POST
+    # @format: json, jsonp
+    # @authenticated: true
+    # @limited: false
+    # @param forum [String] Forum short name (aka forum id).
+    # @return [Hashie::Rash] Export infos
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :format. Defaults to "xml". Choices: xml, xml-old
+    # @example Export forum "the88"
+    #   Disqussion::Client.exports.exportForum("the88")
+    # @see: http://disqus.com/api/3.0/exports/exportForum.json
+    def exportForum(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      if args.size == 1
+        options.merge!(:forum => args[0])
+        response = post('exports/exportForum', options)
+      else
+        puts "#{Kernel.caller.first}: exports.exportForum expects an arguments: forum"
+      end
+    end
   end
 end

data/lib/disqussion/client/forums.rb

@@ -53,9 +53,9 @@ module Disqussion
     # @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
+    # @example Return list of categories within forum 'myforum'
+    #   Disqussion::Client.categories.list("myforum", {:cursor => 10, :limit => 10, :order => 'asc'})
+    # @see: http://disqus.com/api/3.0/forums/listCategories.json
     def listCategories(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       options[:forum] = args.first

data/lib/disqussion/client/imports.rb

@@ -1,4 +1,39 @@
 module Disqussion
   class Imports < Client
+    # 
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: true
+    # @limited: false
+    # @param group [Integer] group ID
+    # @return [Hashie::Rash] Details on the requested import.
+    # @example 
+    #   Disqussion::Client.imports.details(987)
+    # @see: http://disqus.com/api/3.0/imports/details.json
+    def details(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:group] = args.first
+      response = get('imports/details', options)
+    end
+    
+    # Returns list of previous imports.
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: true
+    # @limited: false
+    # @param forum [String] Allows multiple. Looks up a forum by ID (aka short name).
+    # @return [Hashie::Rash] Details on the requested category.
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :cursor. Defaults to null.
+    # @example 
+    #   Disqussion::Client.imports.list("the88")
+    # @see: http://disqus.com/api/3.0/imports/list.json
+    def list(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:forum] = args.first
+      response = get('imports/list', options)
+    end
   end
-end
+end

data/lib/disqussion/client/reports.rb

@@ -1,4 +1,79 @@
 module Disqussion
   class Reports < Client
+    # Returns report on domains
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100.
+    # @option options [Integer] :page. Defaults to 0. Maximum length of 10.
+    # @option options [Array, String] :forum. Allow multiple. Defaults to null. Looks up a forum by ID (aka short name).
+    # @return [Hashie::Rash] Returns report
+    # @example Return report on comments by domains usage
+    #   Disqussion::Client.reports.domains
+    # @see: http://disqus.com/api/3.0/reports/domains.json
+    def domains(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      response = get('reports/domains', options)
+    end
+    
+    # Returns report on ips
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100.
+    # @option options [Integer] :page. Defaults to 0. Maximum length of 10.
+    # @option options [Array, String] :forum. Allow multiple. Defaults to null. Looks up a forum by ID (aka short name).
+    # @return [Hashie::Rash] Returns report
+    # @example Return report on comments by IPs usage
+    #   Disqussion::Client.reports.ips
+    # @see: http://disqus.com/api/3.0/reports/ips.json
+    def ips(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      response = get('reports/ips', options)
+    end
+    
+    # Returns report on threads
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100.
+    # @option options [Integer] :page. Defaults to 0. Maximum length of 10.
+    # @option options [Array, String] :forum. Allow multiple. Defaults to null. Looks up a forum by ID (aka short name).
+    # @return [Hashie::Rash] Returns report
+    # @example Return report on comments by threads
+    #   Disqussion::Client.reports.threads
+    # @see: http://disqus.com/api/3.0/reports/threads.json
+    def threads(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      response = get('reports/threads', options)
+    end
+    
+    # Returns report on users
+    # @accessibility: public key, secret key
+    # @methods: GET
+    # @format: json, jsonp
+    # @authenticated: false
+    # @limited: false
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit. Defaults to 25. Maximum length of 100.
+    # @option options [Integer] :page. Defaults to 0. Maximum length of 10.
+    # @option options [Array, String] :forum. Allow multiple. Defaults to null. Looks up a forum by ID (aka short name).
+    # @return [Hashie::Rash] Returns report
+    # @example Return report on comments by users
+    #   Disqussion::Client.reports.users
+    # @see: http://disqus.com/api/3.0/reports/users.json
+    def users(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      response = get('reports/users', options)
+    end
   end
 end

data/lib/disqussion/version.rb

@@ -1,3 +1,3 @@
 module Disqussion
-  VERSION = '0.0.3'.freeze unless defined?(::Disqussion::VERSION)
+  VERSION = '0.0.4'.freeze unless defined?(::Disqussion::VERSION)
 end