weibo2 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Acenqiu
+
+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,96 @@
+= Weibo2
+
+A Ruby wrapper for Sina weibo 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 sina defined.Note that all of the privilege APIs haven't been tested yet, since I don't get the authorization to use it.
+
+== Installation
+
+  gem install weibo2
+  
+== Usage Examples
+
+Config your api_key, api_secret and redrect_uri somewhere like development.rb.
+
+  Weibo2::Config.api_key = "1234567890"
+  Weibo2::Config.api_secret = "somethinglooksstrageandhardtoremember"
+  Weibo2::Config.redirect_uri = "http://www.example.com/callback"
+
+Ok, now you are ready to enjoy it. Sina Weibo has provided several ways to get your access token, and you can easily get it using Weibo2.
+
+1.The Authorization Code strategy with response_type set to code
+  
+  # get authorize_url
+  client = Weibo2::Client.new
+  client.auth_code.authorize_url
+  # => "https://api.weibo.com/oauth2/authorize?response_type=code&client_id=1234567890&redirect_uri=http%3A%2F%2Fwww.example.com%2fcallback"
+
+  # get token using authorization_code
+  # Weibo2::Client.from_code is a shortcut for client.auth_code.get_token("authorization_code_value")
+  client = Weibo2::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 = Weibo::Client.new
+  client.auth_code.authorize_url(:response_type => "token")
+  # => "https://api.weibo.com/oauth2/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=86400
+  client = Weibo2::Client.from_hash(:access_token => "6874dd3766b35536abcb76a9e3a57867", :expires_in => 86400)
+  
+3.The Resource Owner Password Credentials strategy
+  
+  # get token with user's password
+  client = Weibo::Client.new
+  client.password.get_token('username', 'password')
+  
+4.Signed Request strategy
+
+Follow this link to read more about this strategy.{站内应用开发指南}[http://open.weibo.com/wiki/%E7%AB%99%E5%86%85%E5%BA%94%E7%94%A8%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97]
+
+  
+  # get token using signed_request
+  client = Weibo2::Client.from_signed_request("signed_request-posted-by-weibo")
+  
+  # you can see what the signed_request exactly is by
+  client.signed_request.unsigned_request
+  # => {"user"=>{"country"=>"cn", "locale"=>""}, "algorithm"=>"HMAC-SHA256", "issued_at"=>1320298983, "expires"=>1320385383, "oauth_token"=>"0ca59d99f92436d65ae23115604a3185", "user_id"=>1234567890}
+
+5.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.account.get_uid
+  # => #<OAuth2::Response:: ...>
+  
+  response.parsed
+  # => {"uid"=>1234567890}
+
+
+== API
+
+You can find them in /lib/weibo2/interface/.Note that all methods follow the patten of
+
+  {resource}.{the_rest_path_joined_by_underline}(required_params, opts={})
+   
+So {/statuses/hot/comments_weekly}[http://open.weibo.com/wiki/2/statuses/hot/comments_weekly] will turn to
+
+  statuses.hot_comments_weekly(opts={})
+   
+And {/friendships/friends/in_common}[http://open.weibo.com/wiki/2/friendships/friends/in_common] will turn to 
+  
+  friendships.friends_in_common(uid, 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    = 'Weibo2'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/tasks/weibo2_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :weibo2 do
+#   # Task goes here
+# end

data/lib/weibo2.rb

@@ -0,0 +1,17 @@
+require 'weibo2/client'
+require 'weibo2/config'
+require 'weibo2/error'
+require 'weibo2/strategy/auth_code.rb'
+require 'weibo2/strategy/signed_request.rb'
+require 'weibo2/interface/base'
+require 'weibo2/interface/account'
+require 'weibo2/interface/comments'
+require 'weibo2/interface/favorites'
+require 'weibo2/interface/friendships'
+require 'weibo2/interface/register'
+require 'weibo2/interface/search'
+require 'weibo2/interface/statuses'
+require 'weibo2/interface/suggestions'
+require 'weibo2/interface/tags'
+require 'weibo2/interface/trends'
+require 'weibo2/interface/users'

data/lib/weibo2/client.rb

@@ -0,0 +1,186 @@
+require 'oauth2'
+
+module Weibo2
+
+  # The Weibo2::Client class
+  class Client < OAuth2::Client
+  
+    attr_reader :redirect_uri
+    attr_accessor :token
+    
+    # Initializes a new Client from a signed_request
+    #
+    # @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 signed_request
+    #
+    # @param [String] signed_request param posted by Sina
+    # @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_signed_request(signed_request, opts={}, &block)
+      client = self.new(opts, &block)
+      client.signed_request.get_token(signed_request)
+      
+      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 = Weibo2::Config.api_key
+      secret = Weibo2::Config.api_secret
+      @redirect_uri = Weibo2::Config.redirect_uri
+      
+      options = {:site          => "https://api.weibo.com/2/",
+                 :authorize_url => "/oauth2/authorize",
+                 :token_url     => "/oauth2/access_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 => "access_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["expires"] || hash[:expires],
+              :header_format => "OAuth2 %s",
+              :param_name => "access_token"}
+      
+      @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
+   
+    #
+    # Strategies
+    #
+    
+    # The Authorization Code strategy
+    #
+    # @see http://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-4.1
+    def auth_code
+      @auth_code ||= Weibo2::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
+    
+    # The Signed Request Strategy
+    #
+    # @see http://open.weibo.com/wiki/%E7%AB%99%E5%86%85%E5%BA%94%E7%94%A8%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97
+    def signed_request
+      @signed_request ||= Weibo2::Strategy::SignedRequest.new(self)
+    end
+    
+    #
+    # APIs
+    #
+    
+    def account
+      @account ||= Weibo2::Interface::Account.new(self)
+    end
+    
+    def comments
+      @comments ||= Weibo2::Interface::Comments.new(self)
+    end
+    
+    def favorites
+      @favorites ||= Weibo2::Interface::Favorites.new(self)
+    end
+    
+    def friendships
+      @friendships ||= Weibo2::Interface::Friendships.new(self)
+    end
+    
+    def register
+      @register ||= Weibo2::Interface::Register.new(self)
+    end
+    
+    def search
+      @search ||= Weibo2::Interface::Search.new(self)
+    end
+    
+    def statuses
+      @statuses ||= Weibo2::Interface::Statuses.new(self)
+    end
+    
+    def suggestions
+      @suggestions ||= Weibo2::Interface::Suggestions.new(self)
+    end
+    
+    def tags
+      @tags ||= Weibo2::Interface::Tags.new(self)
+    end
+    
+    def trends
+      @trends ||= Weibo2::Interface::Trends.new(self)
+    end
+    
+    def users
+      @users ||= Weibo2::Interface::Users.new(self)
+    end
+  end
+end

data/lib/weibo2/config.rb

@@ -0,0 +1,28 @@
+module Weibo2
+  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/weibo2/error.rb

@@ -0,0 +1,13 @@
+module Weibo2
+  class Error < OAuth2::Error
+  
+    def initialize(response)
+      response.error = self
+      @response = response
+      if response.parsed.is_a?(Hash)
+        @code = response.parsed['error_code']
+        @description = response.parsed['error']
+      end
+    end
+  end
+end

data/lib/weibo2/interface/account.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+module Weibo2
+  module Interface
+  
+    # Account API
+    #
+    # @see http://open.weibo.com/wiki/API%E6%96%87%E6%A1%A3_V2#.E8.B4.A6.E5.8F.B7
+    class Account < Base
+      
+      # 获取用户基本信息 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要获取基本信息的用户UID，默认为当前登录用户
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/basic
+      def profile_basic(opts={})
+        get 'account/profile/basic.json', :params => opts
+      end
+      
+      # 获取用户的教育信息 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要获取教育信息的用户UID，默认为当前登录用户
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/education
+      def profile_education(opts={})
+        get 'account/profile/education.json', :params => opts
+      end
+      
+      # 批量获取用户的教育信息 [Privilege]
+      #
+      # @param [String] uids 需要获取教育信息的用户UID，用半角逗号分隔，最多不超过20
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/education_batch
+      def profile_education_batch(uids)
+        get 'account/profile/education_batch.json', :params => {:uids => uids}
+      end
+      
+      # 获取用户的职业信息 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [int64] :uid 需要获取教育信息的用户UID，默认为当前登录用户
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/career
+      def profile_career(opts={})
+        get 'account/profile/career.json', :params => opts
+      end
+      
+      # 批量获取用户的职业信息 [Privilege]
+      #
+      # @param [String] uids 需要获取教育信息的用户UID，用半角逗号分隔，最多不超过20
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/career_batch
+      def profile_career_batch(uids)
+        get 'account/profile/career_batch.json', :params => uids
+      end
+      
+      # 获取当前登录用户的隐私设置
+      #
+      # @see http://open.weibo.com/wiki/2/account/get_privacy
+      def get_privacy
+        get 'account/get_privacy.json'
+      end
+      
+      # 获取所有的学校列表
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :province 省份范围，省份ID
+      # @option opts [int] :city     城市范围，城市ID
+      # @option opts [int] :area     区域范围，区ID
+      # @option opts [int] :type     学校类型，1：大学、2：高中、3：中专技校、4：初中、5：小学，默认为1
+      # @option opts [String] :capital 学校首字母，默认为A
+      # @option opts [String] :keyword 学校名称关键字
+      # @option opts [int] :count    返回的记录条数，默认为10
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/school_list
+      def profile_school_list(opts={})
+        get 'account/profile/school_list.json', :params => opts
+      end
+      
+      # 获取当前登录用户的API访问频率限制情况
+      #
+      # @see http://open.weibo.com/wiki/2/account/rate_limit_status
+      def rate_limit_status
+        get 'account/rate_limit_status.json'
+      end
+      
+      # OAuth授权之后，获取授权用户的UID
+      #
+      # @see http://open.weibo.com/wiki/2/account/get_uid
+      def get_uid
+        get 'account/get_uid.json'
+      end
+      
+      #
+      # write
+      #
+      
+      # 更新用户的基本信息 [Privilege]
+      #
+      # @param [String] screen_name 用户昵称，不可为空
+      # @param [int] province       省份代码ID，不可为空
+      # @param [int] city           城市代码ID，不可为空
+      # @param [String] gender      用户性别，m：男、f：女，不可为空
+      # @param [Hash] opts 
+      # @option opts [String] :real_name      用户真实姓名
+      # @option opts [int] :real_name_visible 真实姓名可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [date] :birthday         用户生日，格式：yyyy-mm-dd
+      # @option opts [int] :birthday_visible  生日可见范围，0：保密、1：只显示月日、2：只显示星座、3：所有人可见
+      # @option opts [String] :qq             用户QQ号码
+      # @option opts [int] :qq_visible        用户QQ可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [String] :msn            用户MSN
+      # @option opts [int] :msn_visible       用户MSN可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [String] :url            用户博客地址
+      # @option opts [int] :url_visible       用户博客地址可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [int] :credentials_type  证件类型，1：身份证、2：学生证、3：军官证、4：护照
+      # @option opts [String] :credentials_num 证件号码
+      # @option opts [String] :email          用户常用邮箱地址
+      # @option opts [int] :email_visible     用户常用邮箱地址可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [String] :lang           语言版本，zh_cn：简体中文、zh_tw：繁体中文
+      # @option opts [String] :description    用户描述，最长不超过70个汉字
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/basic_update
+      def profile_basic_update(screen_name, province, city, gender, opts={})
+        body = {:screen_name => screen_name, :province => province, :city => city, :gender => gender}.merge(opts)
+        post 'account/profile/basic_update.json', :body => body
+      end
+      
+      # 更新当前登录用户的教育信息 [Privilege]
+      #
+      # @param [int] type      学校类型，1：大学、2：高中、3：中专技校、4：初中、5：小学，默认为1
+      # @param [int] school_id 学校代码
+      # @param [Hash] opts 
+      # @option opts [String] :id 需要修改的教育信息ID，不传则为新建，传则为更新
+      # @option opts [int] :year  入学年份，最小为1900，最大不超过当前年份
+      # @option opts [String] :department 院系或者班别
+      # @option opts [int] :visible 开放等级，0：仅自己可见、1：关注的人可见、2：所有人可见
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/edu_update
+      def profile_edu_update(type, school_id, opts={})
+        post 'account/profile/edu_update.json', :body => {:type => type, :school_id => school_id}.merge(opts)
+      end
+      
+      # 根据学校ID删除用户的教育信息 [Privilege]
+      #
+      # @param [int64] id 教育信息里的学校ID
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/edu_destroy
+      def profile_edu_destroy(id)
+        post 'account/profile/edu_destroy.json', :body => {:id => id}
+      end
+      
+      # 更新当前登录用户的职业信息 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [String] :id 需要更新的职业信息ID
+      # @option opts [int] :start 进入公司年份，最小为1900，最大为当年年份
+      # @option opts [int] :end   离开公司年份，至今填0
+      # @option opts [String] :department 工作部门
+      # @option opts [int] :visible  可见范围，0：自己可见、1：关注人可见、2：所有人可见
+      # @option opts [int] :province 省份代码ID，不可为空值
+      # @option opts [int] :city     城市代码ID，不可为空值
+      # @option opts [String] :company 公司名称，不可为空值
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/car_update
+      def profile_car_update(opts)
+        post 'account/profile/car_update.json', :body => opts
+      end
+      
+      # 根据公司ID删除用户的职业信息 [Privilege]
+      #
+      # @param [int64] id 职业信息里的公司ID
+      #
+      # @see http://open.weibo.com/wiki/2/account/profile/car_destroy
+      def profile_car_destroy(id)
+        post 'account/profile/car_destroy.json', :body => {:id => id}
+      end
+      
+      # no test
+      # 更新当前登录用户的头像 [Privilege]
+      #
+      # @param [binary] image 头像图片，仅支持JPEG、GIF、PNG格式，图片大小小于5M.必须使用multipart/form-data方式提交
+      #
+      # @see http://open.weibo.com/wiki/2/account/avatar/upload
+      def avatar_upload(image)
+        post 'account/avatar/upload.json', :body => {:image => image}
+      end
+      
+      # 更新当前登录用户的隐私设置 [Privilege]
+      #
+      # @param [Hash] opts 
+      # @option opts [int] :comment  是否可以评论我的微博，0：所有人、1：关注的人，默认为0
+      # @option opts [int] :geo      是否开启地理信息，0：不开启、1：开启，默认为1
+      # @option opts [int] :message  是否可以给我发私信，0：所有人、1：关注的人，默认为0
+      # @option opts [int] :realname 是否可以通过真名搜索到我，0：不可以、1：可以，默认为0
+      # @option opts [int] :badge    勋章是否可见，0：不可见、1：可见，默认为1
+      # @option opts [int] :mobile   是否可以通过手机号码搜索到我，0：不可以、1：可以，默认为0
+      #
+      # @see http://open.weibo.com/wiki/2/account/update_privacy
+      def update_privacy(opts={})
+        post 'account/update_privacy.json', :body => opts
+      end
+    end
+  end
+end