weibo2 0.1.0

data/lib/weibo2/interface/base.rb

@@ -0,0 +1,32 @@
+module Weibo2
+  module Interface
+  
+    # The Base class of API
+    class Base
+      def initialize(client)
+        @client = client
+      end
+      
+      def request(verb, path, opts={}, &block)
+        unless @client.is_authorized?
+          raise "I can't find a valid access_token. Forgot to get it or expired?"
+        end
+        
+        response = @client.token.request(verb, path, opts, &block)
+        if response.error
+          raise Error.new(response)
+        end
+        response
+      end
+      
+      def get(path, opts={}, &block)
+        request(:get, path, opts, &block)
+      end
+      
+      def post(path, opts={}, &block)
+        request(:post, path, opts, &block)
+      end
+    end
+    
+  end
+end

data/lib/weibo2/interface/comments.rb

@@ -0,0 +1,143 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Comments API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E8.AF.84.E8.AE.BA
+    class Comments < Base
+      
+      # 根据微博ID返回某条微博的评论列表
+      #
+      # @param [int64] id 需要查询的微博ID
+      # @param [Hash] opts 
+      # @option opts [int64] :since_id 若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0
+      # @option opts [int64] :max_id   若指定此参数，则返回ID小于或等于max_id的评论，默认为0
+      # @option opts [int] :count      单页返回的记录条数，默认为50 
+      # @option opts [int] :page       返回结果的页码，默认为1
+      # @option opts [int] :filter_by_author 作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/show
+      def show(id, opts={})
+        get 'comments/show.json', :params => {:id => id}.merge(opts)
+      end
+      
+      # 获取当前登录用户所发出的评论列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :since_id 若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0
+      # @option opts [int64] :max_id   若指定此参数，则返回ID小于或等于max_id的评论，默认为0
+      # @option opts [int] :count      单页返回的记录条数，默认为50 
+      # @option opts [int] :page       返回结果的页码，默认为1
+      # @option opts [int] :filter_by_source 来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/by_me
+      def by_me(opts={})
+        get 'comments/by_me.json', :params => opts
+      end
+      
+      # 获取当前登录用户所接收到的评论列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :since_id 若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0
+      # @option opts [int64] :max_id   若指定此参数，则返回ID小于或等于max_id的评论，默认为0
+      # @option opts [int] :count      单页返回的记录条数，默认为50 
+      # @option opts [int] :page       返回结果的页码，默认为1
+      # @option opts [int] :filter_by_author 作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0
+      # @option opts [int] :filter_by_source 来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/to_me
+      def to_me(opts={})
+        get 'comments/to_me.json', :params => opts
+      end
+      
+      # 获取当前登录用户的最新评论包括接收到的与发出的
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :since_id 若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0
+      # @option opts [int64] :max_id   若指定此参数，则返回ID小于或等于max_id的评论，默认为0
+      # @option opts [int] :count      单页返回的记录条数，默认为50 
+      # @option opts [int] :page       返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/comments/timeline
+      def timeline(opts={})
+        get 'comments/timeline.json', :params => opts
+      end
+      
+      # 获取最新的提到当前登录用户的评论，即@我的评论
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :since_id 若指定此参数，则返回ID比since_id大的评论（即比since_id时间晚的评论），默认为0
+      # @option opts [int64] :max_id   若指定此参数，则返回ID小于或等于max_id的评论，默认为0
+      # @option opts [int] :count      单页返回的记录条数，默认为50 
+      # @option opts [int] :page       返回结果的页码，默认为1
+      # @option opts [int] :filter_by_author 作者筛选类型，0：全部、1：我关注的人、2：陌生人，默认为0
+      # @option opts [int] :filter_by_source 来源筛选类型，0：全部、1：来自微博的评论、2：来自微群的评论，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/mentions
+      def mentions(opts={})
+        get 'comments/mentions.json', :params => opts
+      end
+      
+      # 根据评论ID批量返回评论信息
+      #
+      # @param [String] cids 需要查询的批量评论ID，用半角逗号分隔，最大50
+      #
+      # @see http://open.weibo.com/wiki/2/comments/show_batch
+      def show_batch(cids)
+        get 'comments/show_batch.json', :params => {:cids => cids}
+      end
+      
+      #
+      # write
+      #
+      
+      # 对一条微博进行评论
+      #
+      # @param [String] comment 评论内容，内容不超过140个汉字
+      # @param [int64] id       需要评论的微博ID
+      # @param [Hash] opts 
+      # @option opts [int] :comment_on 当评论转发微博时，是否评论给原微博，0：否、1：是，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/create
+      def create(comment, id)
+        post 'comments/create.json', :body => {:comment => comment, :id => id}
+      end
+      
+      # no test
+      # 删除一条评论
+      #
+      # @param [int64] cid 要删除的评论ID，只能删除登录用户自己发布的评论
+      #
+      # @see http://open.weibo.com/wiki/2/comments/destroy
+      def destroy(cid)
+        post 'comments/destroy.json', :body => {:cid => cid}
+      end
+      
+      # 根据评论ID批量删除评论
+      #
+      # @param [String] cids 需要删除的评论ID，用半角逗号隔开，最多20个
+      #
+      # @see http://open.weibo.com/wiki/2/comments/destroy_batch
+      def destroy_batch(cids)
+        post 'comments/destroy_batch.json', :body => {:cids => cids}
+      end
+      
+      # no test
+      # 回复一条评论
+      #
+      # @param [int64] cid 需要回复的评论ID
+      # @param [int64] id  需要评论的微博ID
+      # @param [String] comment 回复评论内容，内容不超过140个汉字
+      # @param [Hash] opts 
+      # @option opts [int] :without_mention 回复中是否自动加入“回复@用户名”，0：是、1：否，默认为0
+      # @option opts [int] :comment_on      当评论转发微博时，是否评论给原微博，0：否、1：是，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/comments/reply
+      def reply(cid, id, comment, opts={})
+        post 'comments/reply.json', :body => {:cid => cid, :id => id, :comment => comment}.merge(opts)
+      end
+    
+    end  
+  end
+end

data/lib/weibo2/interface/favorites.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Favorites API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E6.94.B6.E8.97.8F
+    class Favorites < Base
+      
+      # 获取当前登录用户的收藏列表 
+      #
+      # @param [Hash] opts
+      # @option opts [int] :count 单页返回的记录条数，默认为50
+      # @option opts [int] :page  返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/favorites
+      def favorites(opts={})
+        get 'favorites.json', :params => opts
+      end
+      
+      # 根据收藏ID获取指定的收藏信息
+      #
+      # @param [int64] id 需要查询的收藏ID
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/show
+      def show(id)
+        get 'favorites/show.json', :params => {:id => id}
+      end
+      
+      # 根据标签获取当前登录用户该标签下的收藏列表 
+      # 
+      # @param [int64] tid 需要查询的标签ID
+      # @param [Hash] opts 
+      # @option opts [int] :count 单页返回的记录条数，默认为50
+      # @option opts [int] :page  返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/by_tags
+      def by_tags(tid, opts={})
+        get 'favorites/by_tags.json', :params => {:tid => tid}.merge(opts)
+      end
+      
+      # 获取当前登录用户的收藏标签列表
+      #
+      # @param [Hash] opts
+      # @option opts [int] :count 单页返回的记录条数，默认为10
+      # @option opts [int] :page  返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/tags
+      def tags(opts={})
+        get 'favorites/tags.json', :params => opts
+      end
+      
+      #
+      # write
+      #
+      
+      #test no pass below
+      # 添加一条微博到收藏里
+      #
+      # @param [int64] id 要收藏的微博ID
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/create
+      def create(id)
+        post 'favorites/create.json', :body => {:id => id}
+      end
+      
+      # 取消收藏一条微博
+      #
+      # @param [int64] id 要取消收藏的微博ID
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/destroy
+      def destroy(id)
+        post 'favorites/destroy.json', :body => {:id => id}
+      end
+      
+      # 根据收藏ID批量取消收藏
+      #
+      # @param [String] ids 要取消收藏的收藏ID，用半角逗号分隔，最多不超过10个
+      # @see http://open.weibo.com/wiki/2/favorites/destroy_batch
+      def destroy_batch(ids)
+        post 'favorites/destroy_batch.json', :body => {:ids => ids}
+      end
+      
+      # 更新一条收藏的收藏标签
+      #
+      # @param [int64] id 需要更新的收藏ID
+      # @param [Hash] opts 
+      # @option opts [String] :tags 需要更新的标签内容，用半角逗号分隔，最多不超过2条
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/tags/update
+      def tags_update(id, opt={})
+        post 'favorites/tags/update.json', :body => {:id => id}.merge(opts)
+      end
+      
+      # 更新当前登录用户所有收藏下的指定标签
+      #
+      # @param [int64] tid  需要更新的标签ID
+      # @param [String] tag 需要更新的标签内容
+      # @see http://open.weibo.com/wiki/2/favorites/tags/update_batch
+      def tags_update_batch(tid, tag)
+        post 'favorites/tags/update_batch.json', :body => {:tid => tid, :tag => tag}
+      end
+      
+      # 删除当前登录用户所有收藏下的指定标签
+      #
+      # @param [int64] tid 需要删除的标签ID
+      #
+      # @see http://open.weibo.com/wiki/2/favorites/tags/destroy_batch
+      def tags_destroy_batch(tid)
+        post 'favorites/tags/destroy_batch.json', :body => {:tid => tid}
+      end
+    end
+  end
+end

data/lib/weibo2/interface/friendships.rb

@@ -0,0 +1,193 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+    
+    # Friendships API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E5.85.B3.E7.B3.BB
+    class Friendships < Base
+    
+      # 获取用户的关注列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid  需要查询的用户UID
+      # @option opts [String] :screen_name 需要查询的用户昵称
+      # @option opts [int] :count  单页返回的记录条数，默认为50，最大不超过200
+      # @option opts [int] :cursor 返回结果的游标，下一页用返回值里的next_cursor，上一页用previous_cursor，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends
+      def friends(opts={})
+        get 'friendships/friends.json', :params => opts
+      end
+      
+      # 获取两个用户之间的共同关注人列表
+      #
+      # @param [int64] uid 需要获取共同关注关系的用户UID
+      # @param [Hash] opts 
+      # @option opts [int64] :suid 需要获取共同关注关系的用户UID，默认为当前登录用户
+      # @option opts [int] :count  单页返回的记录条数，默认为50
+      # @option opts [int] :page   返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends/in_common
+      def friends_in_common(uid, opts={})
+        get 'friendships/friends/in_common.json', :params => {:uid => uid}.merge(opts)
+      end
+      
+      # 获取用户的双向关注列表，即互粉列表
+      #
+      # @param [int64] uid 需要获取双向关注列表的用户UID
+      # @param [Hash] opts 
+      # @option opts [int] :count 单页返回的记录条数，默认为50
+      # @option opts [int] :page  返回结果的页码，默认为1
+      # @option opts [int] :sort  排序类型，0：按关注时间最近排序，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends/bilateral
+      def friends_bilateral(uid, opts={})
+        get 'friendships/friends/bilateral.json', :params => {:uid => uid}.merge(opts)
+      end
+      
+      # 获取用户双向关注的用户ID列表，即互粉UID列表
+      #
+      # @param [int64] uid 需要获取双向关注列表的用户UID
+      # @param [Hash] opts 
+      # @option opts [int] :count 单页返回的记录条数，默认为50，最大不超过2000
+      # @option opts [int] :page  返回结果的页码，默认为1
+      # @option opts [int] :sort  排序类型，0：按关注时间最近排序，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends/bilateral/ids
+      def friends_bilateral_ids(uid, opts={})
+        get 'friendships/friends/bilateral/ids.json', :params => {:uid => uid}.merge(opts)
+      end    
+      
+      # 获取用户关注的用户UID列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要查询的用户UID
+      # @option opts [String] :screen_name 需要查询的用户昵称
+      # @option opts [int] :count  单页返回的记录条数，默认为500，最大不超过5000
+      # @option opts [int] :cursor 返回结果的游标，下一页用返回值里的next_cursor，上一页用previous_cursor，默认为0 
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends/ids
+      def friends_ids(opts={})
+        get 'friendships/friends/ids.json', :params => opts
+      end
+      
+      # 批量获取当前登录用户的关注人的备注信息 [Privilege]
+      #
+      # @param [String] uids 需要获取备注的用户UID，用半角逗号分隔，最多不超过50个
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends/remark_batch
+      def friends_remark_batch(uids)
+        get 'friendships/friends/remark_batch.json', :params => {:uids => uids}
+      end
+      
+      # 获取用户的粉丝列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要查询的用户UID
+      # @option opts [String] :screen_name 需要查询的用户昵称
+      # @option opts [int] :count  单页返回的记录条数，默认为50，最大不超过200
+      # @option opts [int] :cursor 返回结果的游标，下一页用返回值里的next_cursor，上一页用previous_cursor，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/followers
+      def followers(opts={})
+        get 'friendships/followers.json', :params => opts
+      end
+      
+      # 获取用户粉丝的用户UID列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要查询的用户UID
+      # @option opts [String] :screen_name 需要查询的用户昵称
+      # @option opts [int] :count  单页返回的记录条数，默认为500，最大不超过5000
+      # @option opts [int] :cursor 返回结果的游标，下一页用返回值里的next_cursor，上一页用previous_cursor，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/followers/ids
+      def followers_ids(opts={})
+        get 'friendships/followers/ids.json', :params => opts
+      end
+      
+      # 获取用户的活跃粉丝列表
+      # @param [int64] uid 需要查询的用户UID
+      # @param [Hash] opts 
+      # @option opts [int] :count 返回的记录条数，默认为20，最大不超过200
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/followers/active
+      def followers_active(uid, opts={})
+        get 'friendships/followers/active.json', :params => {:uid => uid}.merge(opts)
+      end
+      
+      # 获取当前登录用户的关注人中又关注了指定用户的用户列表
+      #
+      # @param [int64] uid 指定的关注目标用户UID
+      # @param [Hash] opts 
+      # @option opts [int] :count 单页返回的记录条数，默认为50
+      # @option opts [int] :page  返回结果的页码，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/friends_chain/followers
+      def friends_chain_followers(uid, opts={})
+        get 'friendships/friends_chain/followers.json', :params => {:uid => uid}.merge(opts)
+      end
+      
+      # 获取两个用户之间的详细关注关系情况
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :source_id 源用户的UID
+      # @option opts [String] :source_screen_name 源用户的微博昵称
+      # @option opts [int64] :target_id 目标用户的UID
+      # @option opts [String] :target_screen_name 目标用户的微博昵称
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/show
+      def show(opts={})
+        get 'friendships/show.json', :params => opts
+      end
+      
+      #
+      # write
+      #
+      
+      # no test below
+      # 关注一个用户
+      # 
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要关注的用户ID
+      # @option opts [String] :screen_name 需要关注的用户昵称
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/create
+      def create(opts={})
+        post 'friendships/create.json', :body => opts
+      end
+      
+      # 根据用户UID批量关注用户 [Privilege]
+      #
+      # @param [String] uids 要关注的用户UID，用半角逗号分隔，最多不超过20个
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/create_batch
+      def create_batch(uids)
+        post 'friendships/create_batch.json', :body => {:uids => uids}
+      end
+
+      # 取消关注一个用户
+      # 
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要取消关注的用户ID
+      # @option opts [String] :screen_name 需要取消关注的用户昵称
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/destroy
+      def destroy(opts={})
+        post 'friendships/destroy.json', :body => opts
+      end
+  
+      # 更新当前登录用户所关注的某个好友的备注信息 [Privilege]
+      #
+      # @param [int64] uid     需要修改备注信息的用户UID
+      # @param [String] remark 备注信息
+      #
+      # @see http://open.weibo.com/wiki/2/friendships/remark/update
+      def remark_update(uid, remark)
+        post 'friendships/remark/update.json', :body => {:uid => uid, :remark => remark}
+      end
+            
+    end
+  end
+end