denglu 0.0.1 → 0.0.2

data/lib/denglu/base.rb

@@ -5,6 +5,16 @@ module Denglu
   class Base
     attr_reader :app_id, :app_key
 
+    # Initialization
+    #
+    # Example:
+    #   >> denglu = Denglu::Base.new
+    #   => #<#Denglu::Base...>
+    #
+    # Arguments:
+    #   app_id: (String)
+    #   app_key: (String)
+    #
     def initialize(app_id=nil, app_key=nil)
       @app_id = app_id || Config.app_id
       @app_key = app_key || Config.app_key

data/lib/denglu/comment.rb

@@ -4,6 +4,19 @@ module Denglu
 
   class Comment < Base
 
+    # Get comment list
+    # This will contains comments' relations in response.
+    #
+    # Example:
+    #   >> comment = Denglu::Comment.new
+    #   => #<#Denglu::Comment...>
+    #   >> comments = comment.list
+    #   => [{...}, {...}]
+    #
+    # Arguments:
+    #   comment_id: (Integer)  The offset marker of response, default to 0 mains from the begining
+    #   max: (Integer)  The max records of response, default to 50
+    #
     def list(comment_id=0, max=50)
       req_method = :GET
       req_uri = '/api/v4/get_comment_list'
@@ -17,6 +30,18 @@ module Denglu
       normalize_comments JSON.parse(response)
     end
 
+    # Get latest comments
+    # NOTE: This contains no relations of comments!
+    #
+    # Example:
+    #   >> comment = Denglu::Comment.new
+    #   => #<#Denglu::Comment...>
+    #   >> comments = comment.latest
+    #   => [{...}, {...}]
+    #
+    # Arguments:
+    #   max: (Integer)  The max records of response, default to 20
+    #
     def latest(max=20)
       req_method = :GET
       req_uri = '/api/v4/latest_comment'
@@ -29,6 +54,19 @@ module Denglu
       JSON.parse(response)
     end
 
+    # Get comment count
+    # If resource is nil it will return all posts comment count in an array, otherwise just return a hash object.
+    #
+    # Example:
+    #   >> comment = Denglu::Comment.new
+    #   => #<#Denglu::Comment...>
+    #   >> comments = comment.total
+    #   => [{"id"=>..., "count"=>..., "url"=>...},
+    #   =>  {...}]
+    #
+    # Arguments:
+    #   resource: (Mixed)  Integer for resource id or string for uri.
+    #
     def total(resource=nil)
       req_method = :GET
       req_uri = '/api/v4/get_comment_count'
@@ -42,9 +80,15 @@ module Denglu
 
       response = request_api(req_method, req_uri, req_options)
 
-      JSON.parse response
+      response = JSON.parse(response)
+      unless resource.nil?
+        response = response[0]
+      end
+
+      response
     end
 
+    # NOTE: NO IMPL!
     def stat(from_ts=nil)
       req_method = :GET
       req_uri = '/api/v4/get_change_comment_ids'

data/lib/denglu/config.rb

@@ -16,14 +16,17 @@ module Denglu
         @app_key ||= ''
       end
 
+      # Denglu api host, default to http://open.denglu.cc
       def host
         @host ||= 'http://open.denglu.cc'
       end
 
+      # Denglu api version, no used now
       def version
         @version ||= '1.0'
       end
 
+      # Denglu api rquest sign method, only support md5
       def sign_type
         @sign_type ||= :md5
       end

data/lib/denglu/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Denglu
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/denglu/comment_spec.rb

@@ -7,28 +7,48 @@ module Denglu
       @comment = Comment.new
     end
 
-    context '.list' do
+    context ".list" do
       it "should works" do
         result = @comment.list
-
         result.should be_instance_of(Array)
+        result.to_json.should include('parentID')
       end
     end
 
-    context '.latest' do
+    context ".latest" do
       it "should works" do
         result = @comment.latest
-
         result.should be_instance_of(Array)
+        result.to_json.should_not include('parentID')
       end
     end
 
-    context '.total' do
+    context ".total" do
       it "should works" do
         result = @comment.total
 
         result.should be_instance_of(Array)
       end
+
+      context "with argument" do
+        before :each do
+          @resource = @comment.total[0]
+        end
+
+        it "should return a hash object when supply resource id" do
+          resource_id = @resource['id'].to_i
+
+          result = @comment.total(resource_id)
+          result.should be_instance_of(Hash)
+        end
+
+        it "should return a hash object when supply resource url" do
+          resource_url = @resource['url']
+
+          result = @comment.total(resource_url)
+          result.should be_instance_of(Hash)
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: denglu
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -71,7 +71,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.md
 - README.md
 - Rakefile
 - denglu.gemspec
@@ -109,3 +108,4 @@ signing_key:
 specification_version: 3
 summary: Denglu open API wrapper of ruby language
 test_files: []
+has_rdoc: