renren2 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,81 @@
+= Renren2
+
+A Ruby wrapper for Renren API(OAuth2).It is based on {OAuth2 gem}[https://github.com/intridea/oauth2], thanks for his hard-working.I have wrapped most of the APIs Renren defined.
+
+== Installation
+
+  gem install renren2
+  
+== Usage Examples
+
+Config your api_key, api_secret and redrect_uri somewhere like development.rb.
+
+  Renren2::Config.api_key = "1234567890"
+  Renren2::Config.api_secret = "somethinglooksstrageandhardtoremember"
+  Renren2::Config.redirect_uri = "http://www.example.com/callback"
+
+Ok, now you are ready to enjoy it. Renren has provided several ways to get your access token, and you can easily get it using Renren2.
+
+1.The Authorization Code strategy with response_type set to code
+  
+  # get authorize_url
+  client = Renren2::Client.new
+  client.auth_code.authorize_url
+  # => "https://graph.renren.com/oauth/authorize?response_type=code&client_id=1234567890&redirect_uri=http%3A%2F%2Fwww.example.com%2fcallback"
+
+  # get token using authorization_code
+  # Renren2::Client.from_code is a shortcut for client.auth_code.get_token("authorization_code_value")
+  client = Renren2::Client.from_code("authorization_code_value")
+  
+2.The Authorization Code strategy with response_type set to token
+  
+  # get authorize_url with response_type set to token
+  client = Renren::Client.new
+  client.auth_code.authorize_url(:response_type => "token")
+  # => "https://graph.renren.com/oauth/authorize?response_type=token&client_id=1234567890&redirect_uri=http%3A%2F%2Fwww.example.com%2fcallback"
+  
+  # get token from callback hash like this /callback#access_token=6874dd3766b35536abcb76a9e3a57867&expires_in=2594445&scope=photo_upload+send_invitation
+  # note that the access_token is different with renren defined, just for demonstration.
+  client = Renren2::Client.from_hash(:access_token => "6874dd3766b35536abcb76a9e3a57867", :expires_in => 86400)
+  
+3.The Resource Owner Password Credentials strategy
+  
+  # get token with user's password
+  client = Renren::Client.new
+  client.password.get_token('username', 'password')
+  
+4.Refresh your token
+
+Note that you could refresh your token only when you can get the refresh_token.
+
+  
+  client.refresh!
+  
+You can check if you are authorized by
+
+  client.is_authorized?
+  # => true
+  
+If you are authorized, then you can do whatever you want now.
+
+  response = client.users.get_logged_in_user
+  # => #<OAuth2::Response:: ...>
+  
+  response.parsed
+  # => {"uid"=>1234567890}
+
+
+== API
+
+You can find them in /lib/renren2/interface/.Note that all methods follow the patten of
+
+  {resource}.{the_rest_path_joined_by_underline}(required_params, opts={})
+   
+So {friends.getSameFriends}[http://wiki.dev.renren.com/wiki/Friends.getSameFriends] will turn to
+
+  friends.get_same_friends(uid1, uid2, opts={})
+  
+  
+== Copyright
+
+Copyright (c) 2011 Acenqiu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Renren2'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/renren2.rb

@@ -0,0 +1,20 @@
+require 'renren2/client'
+require 'renren2/config'
+require 'renren2/strategy/auth_code.rb'
+require 'renren2/interface/base'
+require 'renren2/interface/admin'
+require 'renren2/interface/blog'
+require 'renren2/interface/checkins'
+require 'renren2/interface/feed'
+require 'renren2/interface/friends'
+require 'renren2/interface/invitations'
+require 'renren2/interface/like'
+require 'renren2/interface/notifications'
+require 'renren2/interface/pages'
+require 'renren2/interface/pay'
+require 'renren2/interface/photos'
+require 'renren2/interface/places'
+require 'renren2/interface/requests'
+require 'renren2/interface/share'
+require 'renren2/interface/status'
+require 'renren2/interface/users'

data/lib/renren2/client.rb

@@ -0,0 +1,220 @@
+require 'oauth2'
+
+module Renren2
+
+  # The Renren2::Client class
+  class Client < OAuth2::Client
+  
+    attr_reader :redirect_uri
+    attr_accessor :token
+    
+    # Initializes a new Client from a authentication_code
+    #
+    # @param [String] code The Authorization Code value
+    # @param [Hash] opts the options to create the client with
+    # @option opts [Hash] :connection_opts ({}) Hash of connection options to pass to initialize Faraday with
+    # @option opts [FixNum] :max_redirects (5) maximum number of redirects to follow
+    # @yield [builder] The Faraday connection builder
+    def self.from_code(code, opts={}, &block)
+      client = self.new(opts, &block)
+      client.auth_code.get_token(code)
+      
+      client
+    end
+    
+    # Initializes a new Client from a hash
+    #
+    # @param [Hash] a Hash contains access_token and expires
+    # @param [Hash] opts the options to create the client with
+    # @option opts [Hash] :connection_opts ({}) Hash of connection options to pass to initialize Faraday with
+    # @option opts [FixNum] :max_redirects (5) maximum number of redirects to follow
+    # @yield [builder] The Faraday connection builder
+    def self.from_hash(hash, opts={}, &block)
+      client = self.new(opts, &block)
+      client.get_token_from_hash(hash)
+      
+      client
+    end
+
+    # Initializes a new Client
+    #
+    # @param [Hash] opts the options to create the client with
+    # @option opts [Hash] :connection_opts ({}) Hash of connection options to pass to initialize Faraday with
+    # @option opts [FixNum] :max_redirects (5) maximum number of redirects to follow
+    # @yield [builder] The Faraday connection builder 
+    def initialize(opts={}, &block)
+      id = Renren2::Config.api_key
+      secret = Renren2::Config.api_secret
+      @redirect_uri = Renren2::Config.redirect_uri
+      
+      options = {:site          => "https://graph.renren.com",
+                 :authorize_url => "/oauth/authorize",
+                 :token_url     => "/oauth/token",
+                 :raise_errors  => false,
+                 :ssl           => {:verify => false}}.merge(opts)
+          
+      super(id, secret, options, &block)
+    end
+    
+    # Whether or not the client is authorized
+    #
+    # @return [Boolean]
+    def is_authorized?
+      !!token && !token.expired?
+    end
+
+    # Initializes an AccessToken by making a request to the token endpoint
+    #
+    # @param [Hash] params a Hash of params for the token endpoint
+    # @param [Hash] access token options, to pass to the AccessToken object
+    # @return [AccessToken] the initalized AccessToken
+    def get_token(params, access_token_opts={})
+      params = params.merge(:parse => :json)
+      access_token_opts = access_token_opts.merge({:header_format => "OAuth2 %s", :param_name => "oauth_token"})
+      
+      @token = super(params, access_token_opts)
+    end
+    
+    # Initializes an AccessToken from a hash
+    #
+    # @param [Hash] hash a Hash contains access_token and expires
+    # @return [AccessToken] the initalized AccessToken
+    def get_token_from_hash(hash)
+      access_token = hash.delete('access_token') || hash.delete(:access_token) || hash.delete('oauth_token') || hash.delete(:oauth_token)
+      opts = {:expires_at => hash.delete("expires") || hash.delete(:expires),
+              :header_format => "OAuth2 %s",
+              :param_name => "oauth_token"}.merge(hash)
+      
+      @token = OAuth2::AccessToken.new(self, access_token, opts)
+    end
+    
+    # Refreshes the current Access Token
+    #
+    # @return [AccessToken] a new AccessToken
+    # @note options should be carried over to the new AccessToken
+    def refresh!(params={})
+      @token = token.refresh!(params)
+    end
+    
+    #
+    # Some info
+    #
+    
+    def user
+      token.params["user"] if token
+    end
+    
+    def user_id
+      user["id"] if user
+    end
+    
+    def scope
+      token.params["scope"] if token
+    end
+    
+    def include_scope?(scope_name)
+      return true
+      if token && token.params["scope"]
+        token.params["scope"].split.include? scope_name
+      else
+        false
+      end
+    end
+    
+    def hash_for_save
+      if token
+        token.params.merge({"expires_in" => token.expires_in,
+                            "expires_at" => token.expires_at,
+                            "refresh_token" => token.refresh_token,
+                            "access_token" => token.token})
+      end
+    end
+   
+    #
+    # Strategies
+    #
+    
+    # The Authorization Code strategy
+    #
+    # @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.1
+    def auth_code
+      @auth_code ||= Renren2::Strategy::AuthCode.new(self)
+    end
+    
+    # The Resource Owner Password Credentials strategy
+    #
+    # @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.3
+    def password
+      super
+    end
+    
+    #
+    # APIs
+    #
+    
+    def admin
+      @admin ||= Renren2::Interface::Admin.new(self)
+    end
+    
+    def blog
+      @blog ||= Renren2::Interface::Blog.new(self)
+    end
+    
+    def checkins
+      @checkins ||= Renren2::Interface::Checkins.new(self)
+    end
+    
+    def feed
+      @feed ||= Renren2::Interface::Feed.new(self)
+    end
+    
+    def friends
+      @friends ||= Renren2::Interface::Friends.new(self)
+    end
+    
+    def invitations
+      @invitations ||= Renren2::Interface::Invitations.new(self)
+    end
+    
+    def like
+      @like ||= Renren2::Interface::Like.new(self)
+    end
+    
+    def notifications
+      @notifications ||= Renren2::Interface::Notifications.new(self)
+    end
+    
+    def pages
+      @pages ||= Renren2::Interface::Pages.new(self)
+    end
+    
+    def pay
+      @pay ||= Renren2::Interface::Pay.new(self)
+    end
+    
+    def photos
+      @photos ||= Renren2::Interface::Photos.new(self)
+    end
+    
+    def places
+      @places ||= Renren2::Interface::Places.new(self)
+    end
+    
+    def requests
+      @requests ||= Renren2::Interface::Requests.new(self)
+    end
+    
+    def share
+      @share ||= Renren2::Interface::Share.new(self)
+    end
+    
+    def status
+      @status ||= Renren2::Interface::Status.new(self)
+    end
+    
+    
+    def users
+      @users ||= Renren2::Interface::Users.new(self)
+    end
+  end
+end

data/lib/renren2/config.rb

@@ -0,0 +1,28 @@
+module Renren2
+  module Config
+
+    def self.api_key=(val)
+      @@api_key = val
+    end
+    
+    def self.api_key
+      @@api_key
+    end
+    
+    def self.api_secret=(val)
+      @@api_secret = val
+    end
+    
+    def self.api_secret
+      @@api_secret
+    end
+    
+    def self.redirect_uri=(val)
+      @@redirect_uri = val
+    end
+    
+    def self.redirect_uri
+      @@redirect_uri
+    end
+  end
+end

data/lib/renren2/interface/admin.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+# test passed: 2011-11-06 14:50:22 
+module Renren2
+  module Interface
+    
+    # Admin Interface
+    #
+    # @see http://wiki.dev.renren.com/wiki/API
+    class Admin < Base
+    
+      # 得到一个应用当天可以发送的通知和邀请的配额
+      #
+      # @see http://wiki.dev.renren.com/wiki/Admin.getAllocation
+      def get_allocation
+        post 'admin.getAllocation'
+      end
+      
+      # 对给定的文本进行过滤，返回过滤后的文本，如果不合法，则给出错误信息
+      #
+      # @param [String] text 需检查的文本内容
+      # @param [Hash] opts 
+      # @option opts [int] :type 过滤的文本类型，１代表纯文本，2代表包含脚本或标签的文本。缺省值为1
+      #
+      # @see http://wiki.dev.renren.com/wiki/Admin.textFilter
+      def text_filter(text, opts={})
+        post 'admin.textFilter', :body => {:text => text}.merge(opts)
+      end
+    
+    end
+  end
+end
+

data/lib/renren2/interface/base.rb

@@ -0,0 +1,54 @@
+module Renren2
+  module Interface
+  
+    # The Base class of API
+    class Base
+      def initialize(client)
+        @client = client
+      end
+      
+      def check_scope(scope_name)
+        unless @client.include_scope? scope_name
+          raise "You haven't got the scope " + scope_name
+        end
+      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
+        
+        # Note that it is a hack here. Renren hasn't started using http://graph.renren.com as its api server, so
+        # we still use http://api.renren.com/restserver.do as a temporary solution. And the :path param will act 
+        # as the :method params in querystring.
+        params = {:access_token => @client.token.token,
+                  :method       => path,
+                  :v            => "1.0",
+                  :format       => "JSON"}.merge(opts.delete(:body) || {})
+                                          .merge(opts.delete(:params) || {})
+        opts.merge!(:params => params.merge(:sig => compute_sig(params)), :parse => :json)
+        
+        # use the old server
+        path = "http://api.renren.com/restserver.do"
+        
+        @client.token.request(verb, path, opts, &block)
+      end
+      
+      def get(path, opts={}, &block)
+        request(:get, path, opts, &block)
+      end
+      
+      def post(path, opts={}, &block)
+        request(:post, path, opts, &block)
+      end
+      
+      private
+      
+        def compute_sig(params={})
+          str = params.collect {|k,v| "#{k}=#{v}"}.sort.join("") + @client.secret
+          Digest::MD5.hexdigest(str)
+        end
+    end
+    
+  end
+end