renren2 1.0.0

data/lib/renren2/interface/blog.rb

@@ -0,0 +1,89 @@
+module Renren2
+  module Interface
+    
+    # Blog Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Blog < Base
+    
+      # 创建一篇日志
+      #
+      # @param [String] title   日志的标题
+      # @param [String] content 日志的内容
+      # @param [Hash] opts 
+      # @option opts [int] :visible     日志的隐私设置，可用值有99(所有人可见)1(仅好友可见)4(需要密码)-1(仅自己可见),错传或没传,默认为99
+      # @option opts [String] :password 用户设置的密码
+      # @note require "publish_blog" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Blog.addBlog
+      def add_blog(title, content, opts={})
+        check_scope "publish_blog"
+        post 'blog.addBlog', :body => {:title => title, :content => content}.merge(opts)
+      end
+      
+      # 获取指定用户的可见日志信息列表
+      #
+      # @param [int64] uid 用户的ID
+      # @param [Hash] opts 
+      # @option opts [int] :page  分页的页数，默认值为1
+      # @option opts [int] :count 每页显示的日志的数量, 缺省值为20
+      # @note require "read_user_blog" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Blog.gets
+      def gets(uid, opts={})
+        check_scope "read_user_blog"
+        post 'blog.gets', :body => {:uid => uid}.merge(opts)
+      end
+      
+      # 获取自己或好友一篇日志的信息
+      #
+      # @param [String] id 日志id
+      # @param [int64] uid 日志所有者的ID或公共主页的ID
+      # @param [Hash] opts 
+      # @option opts [int] :comment     返回评论内容，最大值为50，默认值0
+      # @option opts [String] :password 日志的密码（当日志有密码时
+      # @note require "read_user_blog" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Blog.get
+      def get(id, uid, opts={})
+        check_scope "read_user_blog"
+        post 'blog.get', :body => {:id => id, :uid => uid}.merge(opts)
+      end
+      
+      # 获取一篇日志的评论
+      #
+      # @param [String] id 日志id
+      # @param [int64] uid 日志所有者的ID或公共主页的ID
+      # @param [Hash] opts 
+      # @option opts [int] :page  分页的页数，默认值为1
+      # @option opts [int] :count 每页所包含的评论数,默认值为20, 最大值为50
+      # @option opts [int] :order 排序方式。1：代表逆序；0：正序。默认值为0
+      # @note require "read_user_blog,read_user_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Blog.getComments
+      def get_comments(id, uid, opts={})
+        check_scope "read_user_blog"
+        check_scope "read_user_comment"
+        post 'blog.getComments', :body => {:id => id, :uid => uid}.merge(opts)
+      end
+      
+      # 发布一个人人网日志的评论
+      #
+      # @param [String] id      日志id
+      # @param [int64] uid      日志所有者的ID或公共主页的ID
+      # @param [String] content 评论的内容
+      # @param [Hash] opts
+      # @option opts [int] :rid  用于二级回复，被回复的人的用户ID
+      # @option opts [int] :type 是否为悄悄话，1表示悄悄话，0表示公开评论
+      # @note require "publish_blog,publish_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Blog.addComment
+      def add_comment(id, uid, content, opts={})
+        check_scope "publish_blog"
+        check_scope "publish_comment"
+        post 'blog.addComment', :body => {:id => id, :uid => uid, :content => content}.merge(opts)
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/checkins.rb

@@ -0,0 +1,27 @@
+module Renren2
+  module Interface
+    
+    # Checkins Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Checkins < Base
+    
+      # 签到
+      #
+      # @param [String] place_id 签到地点的ID
+      # @param [Hash] opts
+      # @option opts [String] :message   签到时发布的内容
+      # @option opts [double] :longitude 地点的经度，有效范围-180.0到+180.0，“+”表示东经
+      # @option opts [double] :latitude  地点的纬度，有效范围-90.0到+90.0，“+”表示北纬
+      # @option opts [int] :privacy      隐私设置。“0”表示所有人可见,“1”仅自己可见。默认“0”为所有人可见
+      # @note require "publish_checkin" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Checkins.checkin
+      def checkin(place_id, opts={})
+        check_scope "publish_checkin"
+        post 'checkins.checkin', :body => {:place_id => place_id}.merge(opts)
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/feed.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# test passed: 2011-11-06 14:49:26 
+module Renren2
+  module Interface
+    
+    # Feed Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Feed < Base
+    
+      # 获取当前用户的新鲜事内容
+      #
+      # @param [String] type 新鲜事的类别，多个类型以逗号分隔(http://wiki.dev.renren.com/wiki/Type%E5%88%97%E8%A1%A8)
+      # @param [Hash] opts
+      # @option opts [int] :uid   支持传入当前用户的一个好友ID,表示获取此好友的新鲜事，如果不传，默认为获取当前用户的新鲜事
+      # @option opts [int] :page  支持分页，指定页号，页号从1开始，默认值为1
+      # @option opts [int] :count 支持分页，每一页记录数，默认值为30，最大50
+      # @note require "read_user_feed" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Feed.get
+      def get(type, opts={})
+        check_scope "read_user_feed"
+        post 'feed.get', :body => {:type => type}.merge(opts)
+      end
+      
+      # 以当前会话的用户（session_key对应用户）身份发送应用的自定义新鲜事
+      #
+      # @param [String] name        新鲜事标题 注意：最多30个字符
+      # @param [String] description 新鲜事主体内容 注意：最多200个字符
+      # @param [String] url         新鲜事标题和图片指向的链接
+      # @option opts [String] :image       新鲜事图片地址
+      # @option opts [String] :caption     新鲜事副标题 注意：最多20个字符
+      # @option opts [String] :action_name 新鲜事动作模块文案。 注意：最多10个字符
+      # @option opts [String] :action_link 新鲜事动作模块链接
+      # @option opts [String] :message     用户输入的自定义内容。注意：最多200个字符
+      # @note require "publish_feed" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Feed.publishFeed
+      def publish_feed(name, description, url, opts={})
+        check_scope "publish_feed"
+        post 'feed.publishFeed', :body => {:name => name, :description => description, :url => url}.merge(opts)
+      end
+      
+    end
+  end
+end
+

data/lib/renren2/interface/friends.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+# test passed: 2011-11-06 15:22:49 
+module Renren2
+  module Interface
+    
+    # Friends Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Friends < Base
+    
+      # 判断两组用户是否互为好友关系，比较的两组用户数必须相等
+      #
+      # @param [String] uids1 第一组用户的ID，每个ID之间以逗号分隔
+      # @param [String] uids2 第二组用户的ID，每个ID之间以逗号分隔
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.areFriends
+      def are_friends(uids1, uids2)
+        post 'friends.areFriends', :body => {:uids1 => uids1, :uids2 => uids2}
+      end
+      
+      # 得到当前登录用户的好友列表，得到的只是含有好友uid的列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :page  分页，默认为1
+      # @option opts [int] :count 返回每页个数，默认为500
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.get
+      def get
+        post 'friends.get'
+      end
+      
+      # 获取两个用户的共同好友
+      #
+      # @param [int] uid1 用户1
+      # @param [int] uid2 用户2
+      # @param [Hash] opts 
+      # @option opts [String] :fields 好友属性列表（逗号分隔）。支持的值有：uid,name,sex,tinyurl,headurl,mainurl。 缺省：uid
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.getSameFriends
+      def get_same_friends(uid1, uid2, opts={})
+        post 'friends.getSameFriends', :body => {:uid1 => uid1, :uid2 => uid2}.merge(opts)
+      end
+      
+      # 得到当前登录用户的好友列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :page      分页，默认为1
+      # @option opts [int] :count     返回每页个数，默认为500
+      # @option opts [String] :fields 需要返回的字段，多个字段用逗号(,)隔开。目前支持如下字段: headurl_with_logo, tinyurl_with_logo
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.getFriends
+      def get_friends(opts={})
+        post 'friends.getFriends', :body => opts
+      end
+      
+      # 返回已经添加了一个应用的好友的用户Id列表，此接口只返回全部好友中的数据
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.getAppUsers
+      def get_app_users
+        post 'friends.getAppUsers'
+      end
+      
+      # 返回App好友的ID列表
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :fields 返回的字段列表，可以指定返回那些字段，用逗号分隔。
+      #           目前支持name（姓名）、tinyurl(小头像)、headurl（中等头像），如果不传递此参数，默认返回好友id节点
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.getAppFriends
+      def get_app_friends(opts={})
+        post 'friends.getAppFriends', :body => opts
+      end
+      
+      # 搜索用户，根据搜索条件返回搜索结果
+      #
+      # @param [String] name 搜索姓名
+      # @param [Hash] opts 
+      # @option opts [String] :condition 查询条件。
+      #           json格式如：[{"t":"base","gend":"男生","prov":"天津"},{"t":"high","year":"2000"},{"t":"univ","name":"东北大学"}]
+      #           "t"搜索条件类型，各个类型包含的条件如下：
+      #             1. "t":"base" 基本信息，"gend" 性别，"prov" 省份，"city" 城市
+      #             2. "t":"univ" 大学，   "name" 大学名称，"id" 大学的id见主站，"depa" 学院，"year" 入学年份
+      #             3. "t":"high" 高中，   "name" 高中名称，"year" 入学年份
+      #             4. "t":"sect" 中专技校，"name" 名称，   "year" 入学年份
+      #             5. "t":"juni" 初中，   "name" 初中名称，"year" 入学年份
+      #             6. "t":"elem" 小学，   "name" 小学称，  "year" 入学年份
+      #             7. "t":"birt" 生日，   "year" 年，     "month" 月， "day" 日， "astr" 星座
+      #             8. "t":"work" 公司，   "name" 公司名称
+      # @option opts [int] :page  分页显示的页码 缺省值为1
+      # @option opts [int] :count 每页显示的日志的数量, 缺省值为20
+      #
+      # @see http://wiki.dev.renren.com/wiki/Friends.search
+      def search(name, opts={})
+        post 'friends.search', :body => {:name => name}.merge(opts)
+      end
+      
+    end
+  end
+end
+

data/lib/renren2/interface/invitations.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# test passed: 2011-11-06 15:39:14 
+module Renren2
+  module Interface
+    
+    # Invitations Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Invitations < Base
+    
+      # 生成用户站外邀请用户注册的链接地址,应用可以引导用户通过QQ或者msn等渠道邀请好友加入应用
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :domain 获取邀请链接地址的域名属性，0表示人人(wwv.renren.com)，1表示开心(wwv.kaixin.com)，默认值为人人
+      #
+      # @see http://wiki.dev.renren.com/wiki/Invitations.createLink
+      def create_link(opts={})
+        post 'invitations.createLink', :body => opts
+      end
+      
+      # 根据应用新用户的id获取用户是否通过邀请安装，同时得到此次邀请的详细信息（包括邀请者、邀请时间、被邀请者等）
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :invitee_id 被邀请者的用户ID
+      # @option opts [String] :inviter_id 邀请者的ID
+      # @option opts [String] :begin_time 查询起始时间，格式为：yyyy-MM-dd HH:mm:ss
+      # @option opts [String] :end_time   查询结束时间，格式为：yyyy-MM-dd HH:mm:ss
+      # @option opts [int] :page          分页的页数，默认值为1
+      # @option opts [int] :count         分页后每页的数量，默认值为100
+      # @note 1.如果想获得某个用户被谁邀请进来的，请传入invitee_id
+      #       2.如果想获得一段时间内所有用户的邀请信息，请传入begin_time和end_time，此时请不要传入invitee_id
+      #
+      # @see http://wiki.dev.renren.com/wiki/Invitations.getInfo
+      def get_info(opts={})
+        post 'invitations.getInfo', :body => opts
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/like.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module Renren2
+  module Interface
+    
+    # Like Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Like < Base
+    
+      # 判断用户是否喜欢过url
+      #
+      # @param [String] uids uid列表的JSON，上限100，结构如下所示：[8055,8066,8077]
+      # @param [String] urls url列表的JSON，上限100，结构如下所示：[“http://www.docin.com/p-1141554.html”, “http://www.docin.com/p-35584072.html”]
+      #
+      # @see http://wiki.dev.renren.com/wiki/Like.isLiked
+      def is_liked(uids, urls)
+        post 'like.isLiked', :body => {:uids => uids, :urls => urls}
+      end
+      
+      # 获取url被喜欢的次数
+      #
+      # @param [String] urls url列表的JSON，上限100，结构如下所示：[“http://www.docin.com/p-1141554.html”, “http://www.docin.com/p-35584072.html”]
+      #
+      # @see http://wiki.dev.renren.com/wiki/Like.getCount
+      def get_count(urls)
+        post 'like.getCount', :body => {:urls => urls}
+      end
+      
+      # no test below
+      # 对某一url执行喜欢操作
+      #
+      # @param [String] url 被喜欢的url
+      # @note require "operate_like" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Like.like
+      def like(url)
+        check_scope "operate_like"
+        post 'like.like', :body => {:url => url}
+      end
+      
+      # 对某一url执行取消喜欢操作
+      #
+      # @param [String] url 被取消喜欢的url
+      # @note require "operate_like" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Like.unlike
+      def unlike(url)
+        check_scope "operate_like"
+        post 'like.unlike', :body => {:url => url}
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/notifications.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+module Renren2
+  module Interface
+    
+    # Notifications Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Notifications < Base
+    
+      # test failed: to_ids set to nil, failed..
+      # 给当前登录者的好友或也安装了同样应用的用户发通知
+      #
+      # @param [String] to_ids 用户id的列表，单个或多个，可以是逗号分隔，如 8055,8066,8077。这些用户必须是当前登录者的好友或也安装了此应用。	
+      #                        请确保一次传入的用户id数少于20个。如果要给当前用户发送通知，请指定此参数值为空串。
+      # @param [String] notification 通知的内容，可以是XNML类型的文本信息，支持的XNML有<xn:name/>和<a/>，
+      #                              请注意：使用<xn:name/>标签的时候，其uid属性值只能是真实的用户id（阿拉伯数字）。
+      #
+      # @see http://wiki.dev.renren.com/wiki/Notifications.send
+      def send(to_ids, notification)
+        post 'notifications.send', :body => {:to_ids => to_ids, :notification => notification}
+      end
+      
+      # no test
+      # 给你的用户发送Email
+      #
+      # @param [int] template_id      邮件模板的ID
+      # @param [String] recipients    收件人的UID，多个ID用逗号隔开，例如：2838234,2342312. 一次最多100个ID
+      # @param [String] template_data JSON对象，渲染邮件模板所需要的数据。例如：{"who":"234234","static_uid":"23423423"}
+      # @param [Hash] opts 
+      # @option opts [int] :uid 用户的ID
+      # @note require "email" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Notifications.sendEmail
+      # @see http://wiki.dev.renren.com/wiki/HowToSendEmail
+      def send_email(template_id, recipients, template_data, opts={})  
+        check_scope "email"
+        post 'notifications.sendEmail', :body => {:template_id => template_id, 
+                                                  :recipients => recipients, 
+                                                  :template_data => template_data}.merge(opts)
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/pages.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+# test passed: 2011-11-07 21:23:56 
+module Renren2
+  module Interface
+    
+    # Pages Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Pages < Base
+    
+      # 获取当前用户管理的Page列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :page  页码，默认值为1
+      # @option opts [int] :count 每页的容量，默认值为10
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.getManagedList
+      def get_managed_list(opts={})
+        post 'pages.getManagedList', :body => opts
+      end
+      
+      # 成为某个Page的粉丝
+      #
+      # @param [int] page_id Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.becomeFan
+      def become_fan(page_id)
+        post 'pages.becomeFan', :body => {:page_id => page_id}
+      end
+      
+      # 与某个公共主页解除粉丝关系
+      #
+      # @param [int] page_id Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.quit
+      def quit(page_id)
+        post 'pages.quit', :body => {:page_id => page_id}
+      end
+      
+      # Page管理员修改Page的状态
+      #
+      # @param [String] status 管理员更新的page状态信息，最多140个字符
+      # @param [int] page_id   Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.setStatus
+      def set_status(status, page_id)
+        post 'pages.setStatus', :body => {:status => status, :page_id => page_id}
+      end
+      
+      # 判断用户是否为Page的粉丝
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :uid     用户的ID
+      # @option opts [int] :page_id Page的ID，缺省时，值为当前应用对应的Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.isFan
+      def is_fan(opts={})
+        post 'pages.isFan', :body => opts
+      end
+      
+      # 获取公共主页的类型
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.getCategories
+      def get_categories
+        post 'pages.getCategories'
+      end
+      
+      # 获取某个Page的信息
+      #
+      # @param [int] page_id   Page的ID
+      # @param [String] fields 需要返回的字段的列表，多个字段间用逗号隔开。现在支持：status(当前状态),desc(描述),
+      #                        base_info(基本信息),albums_count(相册总数),blogs_count(日志总数), fans_count(粉丝总数),
+      #                        detail_info(详细信息), contact_info(联系信息)
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.getInfo
+      def get_info(page_id, fields)
+        post 'pages.getInfo', :body => {:page_id => page_id, :fields => fields}
+      end
+      
+      # 判断当前用户是否是某个Page的管理员
+      #
+      # @param [int] page_id Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.isAdmin
+      def is_admin(page_id)
+        post 'pages.isAdmin', :body => {:page_id => page_id}
+      end
+      
+      # 判断一个ID是否为Page
+      # 
+      # @param [int] page_id Page的ID
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.isPage
+      def is_page(page_id)
+        post 'pages.isPage', :body => {:page_id => page_id}
+      end
+      
+      # 获取Page的列表
+      # 
+      # @param [Hash] opts 
+      # @option opts [int] :uid      用户的ID。当此参数不为空时表示获取此人关注的公共主页列表
+      # @option opts [int] :page     页码，默认值为1
+      # @option opts [int] :count    每页的容量，默认值为10 
+      # @option opts [int] :category 分类的ID。缺省时表示获取所有类型的公共主页
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.getList
+      def get_list(opts={})
+        post 'pages.getList', :body => opts
+      end
+      
+      # 获取Page粉丝的列表
+      #
+      # @param [int] page_id Page的ID
+      # @param [Hash] opts 
+      # @option opts [int] :page  分页显示的页码 缺省值为1
+      # @option opts [int] :count 每页显示的粉丝的数量, 缺省值为10
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pages.getFansList
+      def get_fans_list(page_id, opts={})
+        post 'pages.getFansList', :body => {:page_id => page_id}.merge(opts)
+      end
+    
+    end
+  end
+end
+