renren2 1.0.0

data/lib/renren2/interface/pay.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Renren2
+  module Interface
+    
+    # Pay Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Pay < Base
+    
+      # 查询某个用户在一个应用中一次消费是否完成
+      #
+      # @param [int64] order_id 用户消费校内豆订单号
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pay.isCompleted
+      def is_completed(order_id)
+        post 'pay.isCompleted', :body => {:order_id => order_id}
+      end
+      
+      # 预存入用户在应用中消费产生的订单数据，消费数额等信息
+      #
+      # @param [int64] order_id     用户消费校内豆订单号，参数必须保证唯一，每一次不能传递相同的参数
+      # @option opts [int] :amount  校内豆消费数额, 取值范围为[0,1000]
+      # @option opts [String] :desc 用户使用校内豆购买的虚拟物品的名称
+      # @param [Hash] opts 
+      # @option opts [int] :type 0代表WEB支付订单，1代表WAP支付订单，默认值为0
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pay.regOrder
+      def reg_order(order_id, amount, desc, opts={})
+        post 'pay.regOrder', :body => {:order_id => order_id, :amount => amount, :desc => desc}.merge(opts)
+      end
+      
+      # 根据订单号查询订单，支持批量查询
+      #
+      # @param [String] order_numbers 订单号，多个订单用逗号隔开
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pay.queryOrders
+      def query_orders(order_numbers)
+        post 'pay.queryOrders', :body => {:order_numbers => order_numbers}      
+      end
+      
+      # 查询某个用户在一个应用中一次消费是否完成
+      #
+      # @param [int64] order_id 用户消费校内豆订单号
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pay4Test.isCompleted
+      def test_is_completed(order_id)
+        post 'pay4Test.isCompleted', :body => {:order_id => order_id}
+      end
+      
+      # 预存入用户在应用中消费产生的订单数据，消费数额等信息
+      #
+      # @param [int64] order_id     用户消费校内豆订单号，参数必须保证唯一，每一次不能传递相同的参数
+      # @option opts [int] :amount  校内豆消费数额, 取值范围为[0,1000]
+      # @option opts [String] :desc 用户使用校内豆购买的虚拟物品的名称
+      # @param [Hash] opts 
+      # @option opts [int] :type 0代表WEB支付订单，1代表WAP支付订单，默认值为0
+      #
+      # @see http://wiki.dev.renren.com/wiki/Pay4Test.regOrder
+      def test_reg_order(order_id, amount, desc, opts={})
+        post 'pay4Test.regOrder', :body => {:order_id => order_id, :amount => amount, :desc => desc}.merge(opts)
+      end
+      
+    end
+  end
+end
+

data/lib/renren2/interface/photos.rb

@@ -0,0 +1,178 @@
+module Renren2
+  module Interface
+    
+    # Photos Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Photos < Base
+    
+      # 以人人用户的身份创建相册
+      #
+      # @param [String] name 相册的名字
+      # @param [Hash] opts 
+      # @option opts [String] :location    相册的地点 
+      # @option opts [String] :description 相册的描述
+      # @option opts [String] :visible     相册的隐私设置. owner（自己）、friends（好友）、 networks（网络）、everyone(所有人)。
+      #                                    99(所有人),1(好友), 3(同网络人), -1(仅自己可见)
+      # @option opts [String] :password    相册的密码，支持字母，数字，符号，限16个字符
+      # @note require "create_album" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.createAlbum
+      def create_album(name, opts={})
+        check_scope "create_album"
+        post 'photos.createAlbum', :body => {:name => name}.merge(opts)
+      end
+      
+      # 获取用户的相册列表信息。当取第一页时，会返回头像相册和快速上传相册
+      #
+      # @param [int] uid 相册所有者的用户ID
+      # @param [Hash] opts 
+      # @option opts [int] :page    分页的页数，默认值为1
+      # @option opts [int] :count   分页后每页的个数，默认值为10
+      # @option opts [String] :aids 多个相册的ID，以逗号分隔，最多支持10个数据
+      # @note require "read_user_album" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.getAlbums
+      def get_albums(uid, opts={})
+        check_scope "read_user_album"
+        post 'photos.getAlbums', :body => {:uid => uid}.merge(opts)
+      end
+      
+      # 上传照片到用户的相册，同时返回这张照片的信息
+      #
+      # @param [binary] upload 文件的数据
+      # @param [Hash] opts 
+      # @option opts [String] :caption  照片的描述信息
+      # @option opts [int] :aid         相册的ID，如果指定此参数，将会传到指定相册，默认传到手机相册 
+      # @option opts [String] :place_id 上传照片所在地点的ID
+      # @note require "photo_upload" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.upload
+      def upload(upload, opts={})
+        check_scope "photo_upload"
+        post 'photos.upload', :body => {:upload => upload}.merge(opts)
+      end
+      
+      # 获取可见照片的相关信息
+      #
+      # @param [int] uid 照片所有者的用户ID或公共主页的ID
+      # @param [Hash] opts 
+      # @option opts [int64] :aid       相册的id。aid和pids至少传递一个
+      # @option opts [String] :password 加密相册的密码
+      # @option opts [int] :page        页码，默认值为1
+      # @option opts [int] :count       每页的容量，默认值为10，必须大于0，小于200
+      # @option opts [String] :pids     照片id串，以分","割，最多20个
+      # @note require "read_user_photo" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.get
+      def get(uid, opts={})
+        check_scope "read_user_photo"
+        post 'photos.get', :body => {:uid => uid}.merge(opts)
+      end
+      
+      # 对可见照片或者相册进行评论
+      #
+      # @param [int] uid        照片或相册所有者的用户ID
+      # @param [String] content 评论的内容，最多140字
+      # @param [Hash] opts 
+      # @option opts [int64] :aid  相册的id。aid和pid至少传递一个
+      # @option opts [String] :pid 照片id。aid和pid至少传递一个
+      # @option opts [int64] :rid  评论的用户id，如果想对评论中的评论进行二级回复需要传递此参数
+      # @option opts [int] :type   评论的类型，是否为悄悄话，1表示悄悄话，0表示非悄悄话，默认为0
+      # @note require "read_user_photo，publish_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.addComment
+      def add_comment(uid, content, opts={})
+        check_scope "read_user_photo"
+        check_scope "publish_comment"
+        post 'photos.addComment', :body => {:uid => uid, :content => content}.merge(opts)
+      end
+      
+      # 获取可见照片的相关评论内容
+      #
+      # @param [int] uid 照片或相册所有者的用户ID
+      # @param [Hash] opts 
+      # @option opts [int64] :aid  相册的id。aid和pid至少传递一个
+      # @option opts [String] :pid 照片id。aid和pid至少传递一个
+      # @option opts [int] :page   支持分页，缺省值为1（第一页）
+      # @option opts [int] :count  每页的数量，缺省值为10
+      # @note require "read_user_photo，read_user_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.getComments
+      def get_comments(uid, opts={})
+        check_scope "read_user_photo"
+        check_scope "read_user_comment"
+        post 'photos.getComments', :body => {:uid => uid}.merge(opts)
+      end
+      
+      # 圈出照片中的好友或人
+      #
+      # @param [int] photo_id     照片的ID
+      # @param [int] owner_id     照片所有者的ID
+      # @param [int] photo_width  照片的宽度，以像素为单位。由于photos.get没有下发照片的宽和高，需要开发者自行计算图片的宽和高
+      # @param [int] photo_height 照片的高度，以像素为单位
+      # @param [int] top          圈人框距照片上端的距离，以像素为单位
+      # @param [int] left         圈人框距照片左端的距离，以像素为单位
+      # @param [int] frame_width  圈人框的宽度，以像素为单位
+      # @param [int] frame_height 圈人框的高度，以像素为单位
+      # @param [Hash] opts 
+      # @option opts [int] :tagged_user_id      被圈用户的ID，该ID对应用户必须与session_key对应用户为好友关系
+      # @option opts [String] :tagged_user_name 被圈用户的名字，若被圈的人没有人人用户ID时，可以传递user_name参数
+      # @note require "send_request" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.tag
+      def tag(photo_id, owner_id, photo_width, photo_height, top, left, frame_width, frame_height, opts={})
+        check_scope "send_request"
+        post 'photos.tag', :body => {:photo_id => photo_id,
+                                     :owner_id => owner_id,
+                                     :photo_width => photo_width,
+                                     :photo_height => photo_height,
+                                     :top => top,
+                                     :left => left,
+                                     :frame_width => frame_width,
+                                     :frame_height => frame_height}.merge(opts)
+      end
+      
+      # 获取照片中圈出的好友或人
+      #
+      # @param [int] photo_id 照片的ID
+      # @param [int] owner_id 照片所有者的ID
+      # @param [Hash] opts 
+      # @option opts [int] :page  页码。默认值为1
+      # @option opts [int] :count 每页个数。默认为100，必须大于0，小于200
+      # @note require "read_user_photo" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.getTags
+      def get_tags(photo_id, owner_id, opts={})
+        check_scope "read_user_photo"
+        post 'photos.getTags', :body => {:photo_id => photo_id, :owner_id => owner_id}.merge(opts)
+      end
+      
+      # 接受圈人请求
+      #
+      # @param [int] tag_id         圈人（Tag）的ID
+      # @param [int] photo_owner_id 圈人（Tag）所在照片所有者的ID
+      # @note require "deal_request" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.acceptTag
+      def accept_tag(tag_id, photo_owner_id)
+        check_scope "deal_request"
+        post 'photos.acceptTag', :body => {:tag_id => tag_id, :photo_owner_id => photo_owner_id}
+      end
+      
+      # 拒绝接受圈人请求
+      #
+      # @param [int] tag_id         圈人（Tag）的ID
+      # @param [int] photo_owner_id 圈人（Tag）所在照片所有者的ID
+      # @note require "deal_request" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Photos.refuseTag
+      def refuse_tag(tag_id, photo_owner_id)
+        check_scope "deal_request"
+        post 'photos.refuseTag', :body => {:tag_id => tag_id, :photo_owner_id => photo_owner_id}
+      end
+      
+    end
+  end
+end
+

data/lib/renren2/interface/places.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+# test passed: 2011-11-06 16:51:21 
+module Renren2
+  module Interface
+    
+    # Places Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Places < Base
+    
+      # 允许用户添加一个地点
+      #
+      # @param [String] poi_id    用户任意传递的字符串，要求可以唯一标示一个POI（Point Of Interest），用于服务端去重，
+      #                           如果传递之前传递过的poi_id，将不会创建地点，而是将上次用该poi_id创建的地点信息进行替换，
+      #                           并返回上次创建地点的place_id
+      # @param [String] name      地点的名称
+      # @param [String] address   地点的地址
+      # @param [String] longitude 地点的经度，有效范围-180.0到+180.0，“+”表示东经
+      # @param [String] latitude  地点的纬度，有效范围-90.0到+90.0，“+”表示北纬
+      # @param [Hash] opts 
+      # @option opts [String] :zip         地点的邮政编码
+      # @option opts [String] :phone       地点的联系电话，若有多个，以“，”（半角）分隔
+      # @option opts [String] :country     地点所在的国家 
+      # @option opts [String] :province    地点所在的省份 
+      # @option opts [String] :city        地点所在的城市
+      # @option opts [String] :district    地点所在的区 
+      # @option opts [String] :crossstreet 地点所在的街道或交叉路口,若是交叉路口,以“&”分隔
+      #
+      # @see http://http://wiki.dev.renren.com/wiki/Places.create
+      def create(poi_id, name, address, longitude, latitude, opts={})
+        post 'places.create', :body => {:poi_id => poi_id,
+                                        :name => name,
+                                        :address => address,
+                                        :longitude => longitude,
+                                        :latitude => latitude}.merge(opts)
+      end
+    end
+  end
+end
+

data/lib/renren2/interface/requests.rb

@@ -0,0 +1,25 @@
+module Renren2
+  module Interface
+    
+    # Requests Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Requests < Base
+    
+      # 获取当前用户的圈人请求列表，在调用之前，应用必须获取到用户的授权
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :page  支持分页，指定页号，页号从1开始，默认值为1
+      # @option opts [int] :count 支持分页，每一页记录数，默认值为20
+      # @note require "read_user_request" scope
+      #
+      # @see http://http://wiki.dev.renren.com/wiki/Requests.getTagRequests
+      def get_tag_requests(opts={})
+        check_scope "read_user_request"
+        post 'requests.getTagRequests', :body => opts
+      end
+    
+    end
+  end
+end
+

data/lib/renren2/interface/share.rb

@@ -0,0 +1,58 @@
+# encoding: utf-8
+module Renren2
+  module Interface
+    
+    # Share Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Share < Base
+    
+      # 发布分享，例如分享视频、音乐、链接、日志、相册、照片等
+      #
+      # @param [int] type 分享的类型：日志为1、照片为2、链接为6、相册为8、视频为10、音频为11、分享为20
+      # @param [Hash] opts 
+      # @option opts [int] :ugc_id  分享人人网站内内容的ID。如日志、照片、相册、分享的ID
+      # @option opts [int] :user_id 分享人人网站内内容所有者的ID。如日志、照片、相册、分享所有者的用户ID
+      # @option opts [String] :url  分享人人网站外内容的URL
+      # @option opts [String] :comment 分享内容时，用户的评论内容
+      # @note require "publish_share" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Share.share
+      def share(type, opts={})
+        check_scope "publish_share"
+        post 'share.share', :body => {:type => type}.merge(opts)
+      end
+      
+      # 获取某个分享的评论
+      #
+      # @param [int] user_id  分享所有者的ID
+      # @param [int] share_id 所要取得评论的分享的ID
+      # @note require "read_user_share、read_user_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Share.getComments
+      def get_comments(user_id, share_id)
+        check_scope "read_user_share"
+        check_scope "read_user_comment"
+        post 'share.getComments', :body => {:user_id => user_id, :share_id => share_id}
+      end
+      
+      # 对某个分享进行评论
+      #
+      # @param [int] share_id   被回复分享的ID
+      # @param [int] user_id    被回复分享所有者的用户ID
+      # @param [String] content 回复的内容 
+      # @param [Hash] opts 
+      # @option opts [int] :to_user_id 被回复用户的ID
+      # @note require "publish_comment、publish_share" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Share.addComment
+      def add_comment(share_id, user_id, content, opts={})
+        check_scope "publish_comment"
+        check_scope "publish_share"
+        post 'share.addComment', :body => {:share_id => share_id, :user_id => user_id, :content => content}.merge(opts)
+      end
+    
+    end
+  end
+end
+

data/lib/renren2/interface/status.rb

@@ -0,0 +1,108 @@
+module Renren2
+  module Interface
+    
+    # Status API
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Status < Base
+      
+      # 返回指定用户的状态列表，不包含回复内容。如果不指定用户，则获取当前用户的状态信息
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :uid   状态信息所属用户id，不指定则判断为当前用户
+      # @option opts [int] :page  支持分页，指定页号，页号从1开始。缺省返回第一页数据
+      # @option opts [int] :count 支持分页，指定每页记录数，缺省为每页10条记录。最大不能超过1000
+      # @note require "read_user_status" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.gets
+      def gets(opts={})
+        check_scope "read_user_status"
+        post 'status.gets', :body => opts
+      end
+      
+      # 用户更新状态
+      #
+      # @param [String] status 用户更新的状态信息，最多140个字符
+      # @param [Hash] opts 
+      # @option opts [String] :place_id 发状态时所在地点的ID
+      # @note require "status_update" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.set
+      def set(status, opts={})
+        check_scope "status_update"
+        post 'status.set', :body => {:status => status}.merge(opts)
+      end
+      
+      # 返回用户某条状态，不包含回复内容
+      #
+      # @param [int64] status_id 状态的id,如果未指定状态id则返回当前用户最新的状态
+      # @param [Hash] opts 
+      # @option opts [int64] :owner_id 状态信息所属用户id，不指定则为当前用户
+      # @note require "read_user_status" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.get
+      def get(status_id, opts={})
+        check_scope "read_user_status"
+        post 'status.get', :body => {:status_id => status_id}.merge(opts)
+      end
+      
+      # 获取一条状态中的所有最新回复内容
+      #
+      # @param [int64] status_id 状态的id
+      # @param [int] owner_id    状态所有者的id
+      # @param [Hash] opts 
+      # @option opts [int] :page  支持分页，指定页号，页号从1开始。缺省返回第一页数据
+      # @option opts [int] :count 支持分页，指定每页记录数，缺省为每页10条记录
+      # @option opts [int] :order 获取留言的排序规则，0表示升序(最旧到新)，1表示降序(最新到旧)，默认为0
+      # @note require "read_user_status" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.getComment
+      def get_comment(status_id, owner_id, opts={})
+        check_scope "read_user_status"
+        post 'status.getComment', :body => {:status_id => status_id, :owner_id => owner_id}.merge(opts)
+      end
+      
+      # no test
+      # 对一条状态增加一条回复
+      #
+      # @param [int] owner_id    状态所有者的id
+      # @param [String] content  回复的内容 
+      # @param [int64] status_id 状态的id
+      # @param [Hash] opts 
+      # @option opts [int64] :rid 被回复的用户的ID，如果是直接回复某条状态，此参数不用传
+      # @note require "read_user_status,publish_comment" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.addComment
+      def add_comment(owner_id, content, status_id, opts={})
+        check_scope "read_user_status"
+        check_scope "publish_comment"
+        post 'status.addComment', :body => {:owner_id => owner_id, :content => content, :status_id => status_id}.merge(opts)
+      end
+      
+      # 获取状态中的表情图片和表情符号对应列表
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :type 获取列表的类型，type为all返回全部数据，type为recent返回网页同步数据，默认网页同步数据
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.getEmoticons
+      def get_emoticons(opts={})
+        post 'status.getEmoticons', :body => opts
+      end
+      
+      # 用户转发状态的操作，支持同时评论给转发人
+      #
+      # @param [String] status     用户更新的状态信息，与转发前的内容加在一起最多140个字符
+      # @param [int64] forward_id  被转发的状态id
+      # @param [int] forward_owner 被转发的状态所有者的id
+      # @note require "status_update" scope
+      #
+      # @see http://wiki.dev.renren.com/wiki/Status.forward
+      def forward(status, forward_id, forward_owner)
+        check_scope "status_update"
+        post 'status.forward', :body => {:status => status, :forward_id => forward_id, :forward_owner => forward_owner}
+      end
+      
+    end
+    
+  end
+end