renren-api 0.3.3

data/README

@@ -0,0 +1 @@
+renren-api provides capability to request the service of Renren Social Network.

data/lib/renren-api.rb

@@ -0,0 +1,13 @@
+module RenrenAPI
+
+  VERSION = [0, 3, 3]
+
+  def self.version
+    VERSION * "."
+  end
+
+  autoload :Authentication, "renren-api/authentication"
+  autoload :SignatureCalculator, "renren-api/signature_calculator"
+  autoload :HTTPAdapter, "renren-api/http_adapter"
+
+end

data/lib/renren-api/authentication.rb

@@ -0,0 +1,41 @@
+require "rack"
+require_relative "signature_calculator"
+
+module RenrenAPI
+  class Authentication
+    def initialize(app, api_key, secret_key, &failed_handler)
+      @app = app
+      @api_key = api_key
+      @secret_key = secret_key
+      @signature_calculator = SignatureCalculator.new(@secret_key)
+      @required_keys = %w{user session_key ss expires}.collect { |e| @api_key + "_" + e } << @api_key
+      @failed_handler = block_given? ? failed_handler : proc { [401, {"Content-Type" => "text/plain"}, ["Unauthorized!"]] }
+    end
+    def call(env)
+      request = Rack::Request.new(env)
+      if %r{^/people/(?<person_id>\d+)} =~ request.path_info
+        cookies = request.cookies
+        if valid?(cookies) && cookies["#{@api_key}_user"] == person_id
+          @app.call(env)
+        else
+          @failed_handler.call(env)
+        end
+      else
+        @app.call(env)
+      end
+    end
+    private
+    def valid?(cookies)
+      @required_keys.each do |k|
+        return false unless cookies.has_key?(k)
+      end
+      return false if cookies["#{@api_key}_expires"].to_i < Time.now.to_i
+      cookies[@api_key] == @signature_calculator.calculate(filter(cookies))
+    end
+    def filter(cookies)
+      hash = {}
+      %w{user session_key ss expires}.each { |e| hash[e] = cookies["#{@api_key}_#{e}"] }
+      hash
+    end
+  end
+end

data/lib/renren-api/http_adapter.rb

@@ -0,0 +1,48 @@
+require_relative "signature_calculator"
+require "uri"
+require "zlib"
+
+module RenrenAPI
+  class HTTPAdapter
+    def initialize(http, api_key, secret_key, session_key)
+      @http, @api_key, @secret_key, @session_key = http, api_key, secret_key, session_key
+      @signature_calculator = SignatureCalculator.new(@secret_key)
+    end
+    def get_friends
+      params = {
+        :api_key => @api_key,
+        :method => "friends.getFriends",
+        :call_id => current_time_in_millisecond,
+        :v => "1.0",
+        :session_key => @session_key,
+        :format => "JSON"
+      }
+      request(params)
+    end
+    def get_info(uids, fields)
+      params = {
+        :api_key => @api_key,
+        :method => "users.getInfo",
+        :call_id => current_time_in_millisecond,
+        :v => "1.0",
+        :session_key => @session_key,
+        :fields => fields * ",",
+        :uids => uids * ",",
+        :format => "JSON"
+      }
+      request(params)
+    end
+    private
+    def current_time_in_millisecond
+      "%.3f" % Time.now.to_f
+    end
+    def request(params)
+      params[:sig] = @signature_calculator.calculate(params)
+      response = @http.post("/restserver.do", URI.encode_www_form(params), {"Accept-Encoding" => "gzip"})
+      gzip_reader = Zlib::GzipReader.new(StringIO.new(response.body))
+      result = JSON.parse(gzip_reader.read)
+      gzip_reader.close
+      result
+    end
+  end
+end

data/lib/renren-api/signature_calculator.rb

@@ -0,0 +1,12 @@
+require "digest/md5"
+
+module RenrenAPI
+  class SignatureCalculator
+    def initialize(secret_key)
+      @secret_key = secret_key
+    end
+    def calculate(hash)
+      Digest::MD5.hexdigest(hash.collect { |(k, v)| "#{k}=#{v}" }.sort * "" << @secret_key)
+    end
+  end
+end

data/spec/authentication_spec.rb

@@ -0,0 +1,163 @@
+require_relative "../lib/renren-api/authentication"
+require "rack/test"
+require "helpers"
+
+class Rack::MockResponse
+  def unauthorized?
+    @status == 401
+  end
+end
+
+describe RenrenAPI::Authentication do
+  include Rack::Test::Methods
+  include Helpers
+  def app
+    RenrenAPI::Authentication.new(lambda { |env| [200, {}, ["OK"]] }, "8802f8e9b2cf4eb993e8c8adb1e02b06", "34d3d1e26cd44c05a0c450c0a0f8147b") do |env|
+      [401, {}, ["Get out of #{env["PATH_INFO"]}!"]]
+    end
+  end
+  subject { request(path, @env); last_response }
+  before { @env = {} }
+
+  context "when path does not have prefix /people/{person-id}" do
+    let(:path) { "/" }
+    %w{GET POST PUT DELETE}.each do |m|
+      context(m) do
+        before { @env[:method] = m }
+        it { should be_ok }
+        its(:body) { should == "OK" }
+      end
+    end
+  end
+
+  context "when path has prefix /people/{person-id}" do
+    let(:path) { "/people/#{person_id}" }
+    let(:person_id) { rand(9999).to_s }
+    context "when no login information provided" do
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_unauthorized }
+          its(:body) { should == "Get out of #{path}!" }
+        end
+      end
+    end
+    context "when correct login information provided" do
+      before { @env[:cookie] = generate_cookie(secret_key, api_key, hash) }
+      let(:secret_key) { "34d3d1e26cd44c05a0c450c0a0f8147b" }
+      let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+      let(:hash) do
+        {
+          "user" => person_id,
+          "session_key" => "session_key",
+          "ss" => "session_key_secret",
+          "expires" => (Time.now.to_i + rand(9999) + 1).to_s
+        }
+      end
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_ok }
+          its(:body) { should == "OK" }
+        end
+      end
+    end
+    context "when incorrect login information provided" do
+      before { @env[:cookie] = generate_cookie("xxxx", api_key, hash) }
+      let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+      let(:hash) do
+        {
+          "user" => person_id,
+          "session_key" => "session_key",
+          "ss" => "session_key_secret",
+          "expires" => (Time.now.to_i + rand(9999) + 1).to_s
+        }
+      end
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_unauthorized }
+          its(:body) { should == "Get out of #{path}!" }
+        end
+      end
+    end
+  end
+
+end
+
+describe RenrenAPI::Authentication, "no failed handler is provided" do
+  include Rack::Test::Methods
+  include Helpers
+  def app
+    RenrenAPI::Authentication.new(lambda { |env| [200, {}, ["OK"]] }, "8802f8e9b2cf4eb993e8c8adb1e02b06", "34d3d1e26cd44c05a0c450c0a0f8147b")
+  end
+  subject { request(path, @env); last_response }
+  before { @env = {} }
+
+  context "when path does not have prefix /people/{person-id}" do
+    let(:path) { "/" }
+    %w{GET POST PUT DELETE}.each do |m|
+      context(m) do
+        before { @env[:method] = m }
+        it { should be_ok }
+        its(:body) { should == "OK" }
+      end
+    end
+  end
+
+  context "when path has prefix /people/{person-id}" do
+    let(:path) { "/people/#{person_id}" }
+    let(:person_id) { rand(9999).to_s }
+    context "when no login information provided" do
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_unauthorized }
+          its(:content_type) { should == "text/plain"}
+          its(:body) { should == "Unauthorized!" }
+        end
+      end
+    end
+    context "when correct login information provided" do
+      before { @env[:cookie] = generate_cookie(secret_key, api_key, hash) }
+      let(:secret_key) { "34d3d1e26cd44c05a0c450c0a0f8147b" }
+      let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+      let(:hash) do
+        {
+          "user" => person_id,
+          "session_key" => "session_key",
+          "ss" => "session_key_secret",
+          "expires" => (Time.now.to_i + rand(9999) + 1).to_s
+        }
+      end
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_ok }
+          its(:body) { should == "OK" }
+        end
+      end
+    end
+    context "when incorrect login information provided" do
+      before { @env[:cookie] = generate_cookie("xxxx", api_key, hash) }
+      let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+      let(:hash) do
+        {
+          "user" => person_id,
+          "session_key" => "session_key",
+          "ss" => "session_key_secret",
+          "expires" => (Time.now.to_i + rand(9999) + 1).to_s
+        }
+      end
+      %w{GET POST PUT DELETE}.each do |m|
+        context(m) do
+          before { @env[:method] = m }
+          it { should be_unauthorized }
+          its(:content_type) { should == "text/plain" }
+          its(:body) { should == "Unauthorized!" }
+        end
+      end
+    end
+  end
+
+end

data/spec/helpers.rb

@@ -0,0 +1,12 @@
+require "uuidtools"
+require "digest/md5"
+
+module Helpers
+  def generate_hash(secret_key, api_key, hash = {})
+    auth_code = Digest::MD5.hexdigest(hash.sort.collect { |e| e * "=" } * "" << secret_key)
+    Hash[hash.collect { |k, v| [api_key + "_" + k, v] }].merge!(api_key => auth_code)
+  end
+  def generate_cookie(secret_key, api_key, hash = {})
+    generate_hash(secret_key, api_key, hash).collect { |(k, v)| "#{k}=#{v}" }
+  end
+end

data/spec/http_adapter_spec.rb

@@ -0,0 +1,98 @@
+require_relative "../lib/renren-api/http_adapter"
+require_relative "../lib/renren-api/signature_calculator"
+require "json"
+require "net/http"
+require "zlib"
+require "stringio"
+
+describe RenrenAPI::HTTPAdapter, "#get_friends" do
+  subject { described_class.new(http, api_key, secret_key, session_key).get_friends }
+  let(:http) { Net::HTTP.new("api.renren.com") }
+  let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+  let(:secret_key) { "34d3d1e26cd44c05a0c450c0a0f8147b" }
+  let(:session_key) { "session_key" }
+  let(:result) do
+    [
+      {"id" => 12345, "name" => "Levin", "tinyurl" => "http://renren.com/1.jpg"},
+      {"id" => 12346, "name" => "James", "tinyurl" => "http://renren.com/2.jpg"}
+    ]
+  end
+  let!(:now) do
+    Time.now
+  end
+  let(:params) do
+    {
+      :api_key => api_key,
+      :method => "friends.getFriends",
+      :call_id => "%.3f" % now.to_f,
+      :v => "1.0",
+      :session_key => session_key,
+      :format => "JSON"
+    }
+  end
+  let(:form_params) do
+    signature_calculator = RenrenAPI::SignatureCalculator.new(secret_key)
+    signature = signature_calculator.calculate(params)
+    URI.encode_www_form(params.merge(:sig => signature))
+  end
+  before :each do
+    Time.stub(:now).and_return(now)
+    response = mock(Net::HTTPResponse)
+    gzip_writer = Zlib::GzipWriter.new(StringIO.new(buffer = ""))
+    gzip_writer << JSON.generate(result)
+    gzip_writer.close
+    response.stub(:code => '200', :message => "OK", :content_type => "application/json", :body => buffer)
+    http.should_receive(:post).with("/restserver.do", form_params, {"Accept-Encoding" => "gzip"}).once.and_return(response)
+  end
+  it { should == result }
+end
+
+describe RenrenAPI::HTTPAdapter, "#get_info" do
+  subject { described_class.new(http, api_key, secret_key, session_key).get_info(uids, fields) }
+  let(:http) { Net::HTTP.new("api.renren.com") }
+  let(:api_key) { "8802f8e9b2cf4eb993e8c8adb1e02b06" }
+  let(:secret_key) { "34d3d1e26cd44c05a0c450c0a0f8147b" }
+  let(:session_key) { "session_key" }
+  let(:result) do
+    [
+      {"uid" => 12345, "name" => "Levin", "tinyurl" => "http://renren.com/1.jpg"},
+      {"uid" => 12346, "name" => "James", "tinyurl" => "http://renren.com/2.jpg"}
+    ]
+  end
+  let!(:now) do
+    Time.now
+  end
+  let(:fields) do
+    %w{uid name tinyurl}
+  end
+  let(:uids) do
+    [12345, 12346]
+  end
+  let(:params) do
+    {
+      :api_key => api_key,
+      :method => "users.getInfo",
+      :call_id => "%.3f" % now.to_f,
+      :v => "1.0",
+      :session_key => session_key,
+      :fields => fields * ",",
+      :uids => uids * ",",
+      :format => "JSON"
+    }
+  end
+  let(:form_params) do
+    signature_calculator = RenrenAPI::SignatureCalculator.new(secret_key)
+    signature = signature_calculator.calculate(params)
+    URI.encode_www_form(params.merge(:sig => signature))
+  end
+  before :each do
+    Time.stub(:now).and_return(now)
+    response = mock(Net::HTTPResponse)
+    gzip_writer = Zlib::GzipWriter.new(StringIO.new(buffer = ""))
+    gzip_writer << JSON.generate(result)
+    gzip_writer.close
+    response.stub(:code => '200', :message => "OK", :content_type => "application/json", :body => buffer)
+    http.should_receive(:post).with("/restserver.do", form_params, {"Accept-Encoding" => "gzip"}).once.and_return(response)
+  end
+  it { should == result }
+end

data/spec/signature_calculator_spec.rb

@@ -0,0 +1,22 @@
+require_relative "../lib/renren-api/signature_calculator"
+
+describe RenrenAPI::SignatureCalculator do
+  let(:calculator) { RenrenAPI::SignatureCalculator.new(secret_key) }
+  describe "#calculate" do
+    subject { calculator.calculate(hash) }
+    context "when secret_key is 7fbf9791036749cb82e74efd62e9eb38" do
+      let(:secret_key) { "7fbf9791036749cb82e74efd62e9eb38" }
+      example_hash = {
+        "v" => "1.0",
+        "api_key" => "ec9e57913c5b42b282ab7b743559e1b0",
+        "method" => "xiaonei.users.getLoggedInUser",
+        "call_id" => 1232095295656,
+        "session_key" => "L6Xe8dXVGISZ17LJy7GzZaeYGpeGfeNdqEPLNUtCJfxPCxCRLWT83x+s/Ur94PqP-700001044"
+      }
+      context "when hash is #{example_hash.inspect}" do
+        let(:hash) { example_hash }
+        it { should == "66f332c08191b8a5dd3477d36f3af49f" }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: renren-api
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.3
+platform: ruby
+authors: 
+- Lei, Zhi-Qiang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-30 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "  renren-api provides capability to request the service of Renren Social Network.\n"
+email: zhiqiang.lei@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/renren-api/authentication.rb
+- lib/renren-api/http_adapter.rb
+- lib/renren-api/signature_calculator.rb
+- lib/renren-api.rb
+- spec/authentication_spec.rb
+- spec/helpers.rb
+- spec/http_adapter_spec.rb
+- spec/signature_calculator_spec.rb
+- README
+has_rdoc: true
+homepage: https://github.com/siegfried/renren-api
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: a library to request Renren's API
+test_files: 
+- spec/authentication_spec.rb
+- spec/http_adapter_spec.rb
+- spec/signature_calculator_spec.rb