weibo2 0.1.0

data/lib/weibo2/interface/register.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Register API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E6.B3.A8.E5.86.8C
+    class Register < Base
+    
+      # 验证昵称是否可用，并给予建议昵称
+      #
+      # @param [String] nickname 需要验证的昵称。4-20个字符，支持中英文、数字、"_"或减号
+      # @see http://open.weibo.com/wiki/2/register/verify_nickname
+      def verify_nickname(nickname)
+        get 'register/verify_nickname.json', :params => {:nickname => nickname}
+      end
+      
+    end
+  end
+end

data/lib/weibo2/interface/search.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Search API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E6.90.9C.E7.B4.A2
+    class Search < Base
+      
+      # 搜索用户时的联想搜索建议 
+      #
+      # @param [String] q 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/users
+      def suggestions_users(q, opts={})
+        get 'search/suggestions/users.json', :params => {:q => q}.merge(opts)
+      end
+      
+      # 搜索微博时的联想搜索建议
+      #
+      # @param [String] q 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/statuses
+      def suggestions_statuses(q, opts={})
+        get 'search/suggestions/statuses.json', :params => {:q => q}.merge(opts)
+      end
+      
+      # 搜索学校时的联想搜索建议
+      #
+      # @param [String] q 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10
+      # @option opts [int] :type  学校类型，0：全部、1：大学、2：高中、3：中专技校、4：初中、5：小学，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/schools
+      def suggestions_schools(q, opts={})
+        get 'search/suggestions/schools.json', :params => {:q => q}.merge(opts)
+      end
+      
+      # 搜索公司时的联想搜索建议
+      #
+      # @param [String] q 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/companies
+      def suggestions_companies(q, opts={})
+        get 'search/suggestions/companies.json', :params => {:q => q}.merge(opts)
+      end
+      
+      # 搜索应用时的联想搜索建议
+      #
+      # @param [String] q 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/apps
+      def suggestions_apps(q, opts={})
+        get 'search/suggestions/apps.json', :params => {:q => q}.merge(opts)
+      end
+      
+      # @用户时的联想建议
+      #
+      # @param [String] q 搜索的关键字
+      # @param [int] type 联想类型，0：关注、1：粉丝
+      # @param [Hash] opts
+      # @option opts [int] :count 返回的记录条数，默认为10，粉丝最多1000，关注最多2000
+      # @option opts [int] :range 联想范围，0：只联想关注人、1：只联想关注人的备注、2：全部，默认为2
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/at_users
+      def suggestions_at_users(q, type, opts={})
+        get 'search/suggestions/at_users.json', :params => {:q => q, :type => type}.merge(opts)
+      end
+      
+      #TODO:test no pass
+      # 综合联想，包含用户、微群、应用等的联想建议
+      #
+      # @param [String] query 搜索的关键字
+      # @param [Hash] opts
+      # @option opts [int] :sort_user  用户排序，0：按专注人最多，默认为0
+      # @option opts [int] :sort_app   应用排序，0：按用户数最多，默认为0
+      # @option opts [int] :sort_grp   微群排序，0：按成员数最多，默认为0
+      # @option opts [int] :user_count 返回的用户记录条数，默认为4
+      # @option opts [int] :app_count  返回的应用记录条数，默认为1
+      # @option opts [int] :grp_count  返回的微群记录条数，默认为1
+      #
+      # @see http://open.weibo.com/wiki/2/search/suggestions/integrate
+      def suggestions_integrate(q, opts={})
+        get 'search/suggestions/integrate.json', :params => {:query => q}.merge(opts)
+      end
+      
+      # 搜索与指定的一个或多个条件相匹配的微博 [Privilege]
+      #
+      # @param [Hash] opts
+      # @option opts [String] :q          搜索的关键字
+      # @option opts [int] :filter_ori    过滤器，是否为原创，0：全部、1：原创、2：转发，默认为0
+      # @option opts [int] :filter_pic    过滤器。是否包含图片，0：全部、1：包含、2：不包含，默认为0
+      # @option opts [int64] :fuid        搜索的微博作者的用户UID
+      # @option opts [int] :province      搜索的省份范围，省份ID
+      # @option opts [int] :city          搜索的城市范围，城市ID
+      # @option opts [int64] :starttime   开始时间，Unix时间戳
+      # @option opts [int64] :endtime     结束时间，Unix时间戳
+      # @option opts [int] :count         单页返回的记录条数，默认为10
+      # @option opts [int] :page          返回结果的页码，默认为1
+      # @option opts [boolean] :needcount 返回结果中是否包含返回记录数，true：返回、false：不返回，默认为false
+      # @option opts [int] :base_app      是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/search/statuses
+      def statuses(opts={})
+        get 'search/statuses.json', :params => opts
+      end
+      
+      # 获取指定地点周边的微博列表 [Privilege]
+      #
+      # @param [float] longitude 经度。有效范围：-180.0到+180.0，+表示东经
+      # @param [float] latitude  纬度。有效范围：-90.0到+90.0，+表示北纬
+      # @param [Hash] opts
+      # @option opts [int] :range 搜索范围，单位米，默认500米，最大11132米
+      # @option opts [int] :time  返回结果所在的时间段，单位为分钟，指从现在开始之前的时间段
+      # @option opts [int] :sort_type 排序方式。默认为0，按时间排序；为1时按与中心点距离进行排序
+      # @option opts [int] :page  返回结果页码。默认为1
+      # @option opts [int] :count 每页结果数。默认10，最大50
+      # @option opts [int] :base_app 是否根据当前应用返回数据。默认0：全部应用；1：仅限当前应用
+      #
+      # @see http://open.weibo.com/wiki/2/search/geo/statuses
+      def geo_statuses(longitude, latitude, opts={})
+        get 'search/geo/statuses.json', :params => {:longitude => longitude, :latitude => latitude}.merge(opts)
+      end
+      
+      # 通过关键词搜索用户 [Privilege]
+      #
+      # @param [Hash] opts
+      # @option opts [String] :q        搜索的关键字
+      # @option opts [int] :snick       搜索范围是否包含昵称，0：不包含、1：包含
+      # @option opts [int] :sdomain     搜索范围是否包含个性域名，0：不包含、1：包含
+      # @option opts [int] :sintro      搜索范围是否包含简介，0：不包含、1：包含
+      # @option opts [int] :stag        搜索范围是否包含标签，0：不包含、1：包含
+      # @option opts [int] :province    搜索的省份范围，省份ID
+      # @option opts [int] :city        搜索的城市范围，城市ID
+      # @option opts [String] :gender   搜索的性别范围，m：男、f：女
+      # @option opts [String] :comorsch 搜索的公司学校名称
+      # @option opts [int] :sort        排序方式，1：按更新时间、2：按粉丝数，默认为1
+      # @option opts [int] :count       单页返回的记录条数，默认为10
+      # @option opts [int] :page        返回结果的页码，默认为1
+      # @option opts [int] :base_app    是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/search/users
+      def users(opts={})
+        get 'search/users.json', :params => opts
+      end
+      
+    end
+  end
+end

data/lib/weibo2/interface/statuses.rb

@@ -0,0 +1,300 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Statuses API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E5.BE.AE.E5.8D.9A
+    class Statuses < Base
+    
+      # 返回最新的公共微博
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :count    单页返回的记录条数，默认为50
+      # @option opts [int] :page     返回结果的页码，默认为1
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/public_timeline
+      def public_timeline(opts={})
+        get 'statuses/public_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] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      # @option opts [int] :feature  过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/friends_timeline
+      def friends_timeline(opts={})
+        get 'statuses/friends_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] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      # @option opts [int] :feature  过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/home_timeline
+      def home_timeline(opts={})
+        get 'statuses/home_timeline.json', :params => opts
+      end
+      
+      # 获取某个用户最新发表的微博列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid      需要查询的用户ID
+      # @option opts [String] :screen_name 需要查询的用户昵称
+      # @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] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      # @option opts [int] :feature  过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0
+      # @option opts [int] :trim_user 返回值中user信息开关，0：返回完整的user信息、1：user字段仅返回user_id，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/user_timeline
+      def user_timeline(opts={})
+        get 'statuses/user_timeline.json', :params => opts
+      end
+      
+      # 批量获取指定的一批用户的微博列表 [Privilege]
+      #
+      # @option opts [String] :uids 需要查询的用户ID，用半角逗号分隔，一次最多20个
+      # @option opts [String] :screen_name 需要查询的用户昵称，用半角逗号分隔，一次最多20个
+      # @option opts [int] :count    单页返回的记录条数，默认为20
+      # @option opts [int] :page     返回结果的页码，默认为1
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      # @option opts [int] :feature  过滤类型ID，0：全部、1：原创、2：图片、3：视频、4：音乐，默认为0
+      # @see http://open.weibo.com/wiki/2/statuses/timeline_batch
+      def timeline_batch(opts={})
+        get 'statuses/timeline_batch.json', :params => opts
+      end
+      
+      # 获取指定微博的转发微博列表
+      #
+      # @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/statuses/repost_timeline
+      def repost_timeline(id, opts={})
+        get 'statuses/repost_timeline.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
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/repost_by_me
+      def repost_by_me(opts={})
+        get 'statuses/repost_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
+      # @option opts [int] :filter_by_type   原创筛选类型，0：全部微博、1：原创的微博，默认为0 
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/mentions
+      def mentions(opts={})  
+        get 'statuses/mentions.json', :params => opts
+      end
+    
+      # 根据微博ID获取单条微博内容
+      #
+      # @param [int] id 需要获取的微博ID
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/show
+      def show(id)
+        get 'statuses/show.json', :params => {:id => id}
+      end
+      
+      # 根据微博ID批量获取微博信息 [Privilege]
+      #
+      # @param [String] ids 需要查询的微博ID，用半角逗号分隔，最多不超过50个
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/show_batch
+      def show_batch(ids)
+        get 'statuses/show_batch.json', :params => {:ids => ids}
+      end
+       
+      # 通过微博（评论、私信）ID获取其MID
+      #
+      # @param [int64] id 需要查询的微博（评论、私信）ID，批量模式下，用半角逗号分隔，最多不超过20个
+      # @param [int] type 获取类型，1：微博、2：评论、3：私信，默认为1
+      # @param [Hash] opts
+      # @option opts [int] :is_batch 是否使用批量模式，0：否、1：是，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/querymid
+      def querymid(id, type=1, opts={})
+        get 'statuses/querymid.json', :params => {:id => id, :type => type}.merge(opts)
+      end
+      
+      # test failed
+      # 通过微博（评论、私信）MID获取其ID
+      #
+      # @param [String] mid 需要查询的微博（评论、私信）MID，批量模式下，用半角逗号分隔，最多不超过20个
+      # @param [int] type   获取类型，1：微博、2：评论、3：私信，默认为1
+      # @param [Hash] opts 
+      # @option opts [int] :is_batch 是否使用批量模式，0：否、1：是，默认为0
+      # @option opts [int] :inbox    仅对私信有效，当MID类型为私信时用此参数，0：发件箱、1：收件箱，默认为0
+      # @option opts [int] :isBase62 MID是否是base62编码，0：否、1：是，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/queryid 
+      def queryid(mid, type=1, opts={})
+        get 'statuses/queryid.json', :params => {:mid => mid, :type => type}.merge(opts)
+      end
+      
+      # 按天返回热门微博转发榜的微博列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :count    返回的记录条数，最大不超过50，默认为20
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/hot/repost_daily
+      def hot_repost_daily(opts={})
+        get 'statuses/hot/repost_daily.json', :params => opts
+      end
+      
+      # 按周返回热门微博转发榜的微博列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :count    返回的记录条数，最大不超过50，默认为20
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/hot/repost_weekly
+      def hot_repost_weekly(opts={})
+        get 'statuses/hot/repost_weekly.json', :params => opts
+      end  
+      
+      # 按天返回热门微博评论榜的微博列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :count    返回的记录条数，最大不超过50，默认为20
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/hot/comments_daily
+      def hot_comments_daily(opts={})
+        get 'statuses/hot/comments_daily.json', :params => opts
+      end
+      
+      # 按周返回热门微博评论榜的微博列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :count    返回的记录条数，最大不超过50，默认为20
+      # @option opts [int] :base_app 是否只获取当前应用的数据。0为否（所有数据），1为是（仅当前应用），默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/hot/comments_weekly
+      def hot_comments_weekly(opts={})
+        get 'statuses/hot/comments_weekly.json', :params => opts
+      end
+      
+      
+      #
+      # write
+      #
+      
+      # 转发一条微博
+      #
+      # @param [int64] id 要转发的微博ID
+      # @param [Hash] opts 
+      # @option opts [String] :status  添加的转发文本，必须做URLencode，内容不超过140个汉字，不填则默认为“转发微博”
+      # @option opts [int] :is_comment 是否在转发的同时发表评论，0：否、1：评论给当前微博、2：评论给原微博、3：都评论，默认为0 
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/repost
+      def repost(id, opts={})
+        post 'statuses/repost.json', :body => {:id => id}.merge(opts)
+      end
+      
+      # 根据微博ID删除指定微博
+      #
+      # @param [int64] id 需要删除的微博ID
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/destroy
+      def destroy(id)
+        post 'statuses/destroy.json', :body => {:id => id}
+      end
+      
+      # no tested
+      # 发布一条新微博
+      #
+      # @param [String] status 要发布的微博文本内容，内容不超过140个汉字
+      # @param [Hash] opts 
+      # @option opts [float] :lat  纬度，有效范围：-90.0到+90.0，+表示北纬，默认为0.0
+      # @option opts [float] :long 经度，有效范围：-180.0到+180.0，+表示东经，默认为0.0
+      # @option opts [String] :annotations 元数据，主要是为了方便第三方应用记录一些适合于自己使用的信息，每条微博
+      #               可以包含一个或者多个元数据，必须以json字串的形式提交，字串长度不超过512个字符，具体内容可以自定
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/update
+      def update(status, opts={})
+        post 'statuses/update.json', :body => {:status => status}.merge(opts)
+      end
+      
+      # no tested
+      # 上传图片并发布一条新微博
+      #
+      # @param [String] status 要发布的微博文本内容，内容不超过140个汉字
+      # @param [binary] pic    要上传的图片，仅支持JPEG、GIF、PNG格式，图片大小小于5M 
+      # @param [Hash] opts 
+      # @option opts [float] :lat  纬度，有效范围：-90.0到+90.0，+表示北纬，默认为0.0
+      # @option opts [float] :long 经度，有效范围：-180.0到+180.0，+表示东经，默认为0.0
+      # @option opts [String] :annotations 元数据，主要是为了方便第三方应用记录一些适合于自己使用的信息，每条微博
+      #               可以包含一个或者多个元数据，必须以json字串的形式提交，字串长度不超过512个字符，具体内容可以自定
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/upload
+      def upload(status, pic, opts={})
+        post 'statuses/upload.json', :body => {:status => status, :pic => pic}.merge(opts)
+      end
+      
+      # 指定一个图片URL地址抓取后上传并同时发布一条新微博 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :status 要发布的微博文本内容，内容不超过140个汉字
+      # @option opts [String] :url 图片的URL地址，必须以http开头
+      # @option opts [float] :lat  纬度，有效范围：-90.0到+90.0，+表示北纬，默认为0.0
+      # @option opts [float] :long 经度，有效范围：-180.0到+180.0，+表示东经，默认为0.0
+      # @option opts [String] :annotations 元数据，主要是为了方便第三方应用记录一些适合于自己使用的信息，每条微博
+      #               可以包含一个或者多个元数据，必须以json字串的形式提交，字串长度不超过512个字符，具体内容可以自定
+      #
+      # @see http://open.weibo.com/wiki/2/statuses/upload_url_text
+      def upload_url_text(opts={})
+        post 'statuses/upload_url_text.json', :body => opts
+      end
+      
+      # 获取微博官方表情的详细信息
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :type     表情类别，face：普通表情、ani：魔法表情、cartoon：动漫表情，默认为face
+      # @option opts [String] :language 语言类别，cnname：简体、twname：繁体，默认为cnname
+      #
+      # @see http://open.weibo.com/wiki/2/emotions
+      def emotions(opts={})
+        get 'emotions.json', :params => opts
+      end
+    end
+  end
+end