qq_17up 3.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 zires
+
+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.md

@@ -0,0 +1,143 @@
+open_qq
+=======
+
+腾讯开放平台ruby版SDK(v3版本)
+
+## 安装
+
+```ruby
+gem install open_qq
+```
+
+## 使用
+
+使用非常简单，传入应用的`appid`, `appkey`和环境地址`env`
+
+```ruby
+require 'rubygems'
+require 'open_qq'
+
+OpenQq.setup(:appid => '123', :appkey => '456', :env => 'https://graph.qq.com')
+
+# 或者https
+OpenQq.setup(:appid => '123', :appkey => '456', :env => 'https://graph.qq.com')
+
+# get请求
+user_info = OpenQq.get('/user/get_info', :openid => '111',:openkey => '222')
+
+# 或者post请求
+user_info = OpenQq.post('/user/get_info',:openid => '111',:openkey => '222')
+
+user_info.ret # => 0
+user_info.nickname # => 'foo'
+```
+
+如果你只想原样返回未加工的数据，使用`raw => true`
+
+```ruby
+user_info = OpenQq.post('/user/get_info', {:openid => '111', :openkey => '222'}, :raw => true)
+puts user_info
+# => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }'
+```
+
+如果你不想使用全局的配置
+
+```ruby
+options   = {:appid => 'newappid', :appkey => 'newappkey', :env => 'https://graph.qq.com'}
+
+user_info = OpenQq.call('/user/get_info', options) do |request|
+
+  request.get {:openid => '111',:openkey => '222'}
+
+  #或者
+  request.post {:openid => '111',:openkey => '222'}
+
+end
+
+user_info.nickname
+# => 'foo'
+```
+
+回调协议签名验证
+
+```ruby
+params = {openid: 'test001', appid: '33758', sig: 'VvKwcaMqUNpKhx0XfCvOqPRiAnU%3D'}
+OpenQq.verify_callback_sig(:get, '/cgi-bin/temp.py', params)
+# => true or false
+
+#指定特定的appkey
+OpenQq.verify_callback_sig(:get, '/cgi-bin/temp.py', params, 'xxxxxx')
+
+# 在rails中使用
+class OpenQqController < ApplicationController
+  include OpenQq::Rails::ActionController
+
+  def index
+    if verify_callback_sig
+      ...do something
+    end
+  end
+end
+
+```
+
+## 在rails中使用
+
+首先在Gemfile中添加
+```
+gem 'open_qq'
+```
+
+执行`bundle install`
+
+在config目录下生成配置文件config/open_qq.yml
+```
+rails g open_qq:install
+```
+
+在配置文件中填入appid, appkey和env的值，启动服务后全局都可以使用，例如：
+
+```ruby
+class OpenQqController < ApplicationController
+
+  # 假设这里是应用的入口
+  def index
+    user_info = OpenQq.post('/user/get_info', params.slice!(:action, :controller))
+    if user_info.ret == 0
+      # do something
+    end
+  end
+
+end
+
+```
+
+## 注意和说明
+
+* 当传入的format为xml时，不会对返回的结果做处理，直接字符串返回
+* 当传入的format不为xml时，会使用`JSON#parse`转换成hash，并且使用[OpenStruct](http://www.ruby-doc.org/stdlib-1.8.7/libdoc/ostruct/rdoc/OpenStruct.html, 'OpenStruct')封装
+* 当ret返回`2001`时，是由本api抛出
+* 关于*signature verification failed*，先仔细对照[文档](http://wiki.open.qq.com/wiki/%E8%85%BE%E8%AE%AF%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E7%AC%AC%E4%B8%89%E6%96%B9%E5%BA%94%E7%94%A8%E7%AD%BE%E5%90%8D%E5%8F%82%E6%95%B0sig%E7%9A%84%E8%AF%B4%E6%98%8E#.E4.B8.BA.E4.BB.80.E4.B9.88.E6.80.BB.E6.98.AF.E8.BF.94.E5.9B.9E.E2.80.9C-5.EF.BC.9Asignature_verification_failed.E2.80.9D.EF.BC.9F)
+
+```
+可以通过联调工具看下签名是否一致
+
+opts = {:openid => '1111',:openkey => '2222',:pf => 'pengyou'}
+sig = OpenQq.wrap(:post, '/v3/user/get_info', opts)['sig']
+
+puts sig # 与联调结果比对
+
+```
+
+* 如果不想使用open_qq.yml，只要在使用前全局配置好`OpenQq`即可
+* 测试基本覆盖，可以下载下来执行`rake`
+* bug反馈[Issue](https://github.com/zires/open_qq/issues)
+
+## Changelog
+
+* 2012/09/11
+增加对https的支持
+支持支付回调协议签名验证
+
+
+## This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task :default => :test

data/lib/generators/open_qq/install_generator.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module OpenQq
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      # Create open_qq.yml under config/initializers/
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a ThemePark initializer file."
+      def copy_initializer
+        template "open_qq.yml", "config/open_qq.yml"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/open_qq.yml

@@ -0,0 +1,16 @@
+# open_qq configruation.
+# see http://open.qq.com/
+development:
+  appid:
+  appkey:
+  env: http://119.147.19.43
+
+test:
+  appid:
+  appkey:
+  env: http://119.147.19.43
+
+production:
+  appid:
+  appkey:
+  env: http://openapi.tencentyun.com

data/lib/open_qq/error.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+module OpenQq
+  # behavior response to body method
+  class Error
+    
+    def initialize(ret, msg, format = 'json')
+      @ret, @msg, @format = ret, msg, format.to_s
+    end
+
+    def body
+      if @format == 'xml'
+        %Q(<?xml version="1.0" encoding="UTF-8"?><data><ret>#{@ret}</ret><msg>#{@msg}</msg></data>)
+      else
+        {:ret => @ret, :msg => @msg}.to_json
+      end
+    end
+
+  end
+end

data/lib/open_qq/gateway.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+require 'open_qq/signature'
+require 'open_qq/error'
+require 'ostruct'
+require 'net/https'
+
+module OpenQq
+  class Gateway
+
+    OPEN_HTTP_TRANSLATE_ERROR = 2001
+
+    attr_accessor :appid, :appkey, :env
+
+    # @param [String] appid
+    # @param [String] appkey
+    # @param [String] env 调用的环境地址
+    #
+    # @example
+    #   OpenQq::Gateway.new('1111', '2222', 'http://119.147.19.43')
+    #   OpenQq::Gateway.new('1111', '2222', 'https://openapi.tencentyun.com')
+    def initialize(appid, appkey, env)
+      @appid   = appid
+      @appkey  = appkey
+      self.env = env
+    end
+
+    # override
+    def env=(env)
+      @env  = env
+      uri   = URI.parse(env)
+      @http = Net::HTTP.new(uri.host, uri.port)
+      # HTTPS
+      if uri.scheme == "https"
+        @http.use_ssl     = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    # @param [String] url which api you want to call
+    # @param [Hash] params extra params attach to the url
+    # @param [options] options
+    # 
+    # @example
+    #   gateway   = OpenQq::Gateway.new('1111', '2222', 'http://119.147.19.43')
+    #   user_info = gateway.get('/v3/user/get_info', {:openid => '11'} )
+    #   user_info.nickname # => foo
+    #
+    # @example available option
+    #   :raw => true will raw the output
+    #   user_info = gateway.get('/v3/user/get_info', {:openid => '11'}, {:raw => true} )
+    #   user_info.nickname # => '{"nickname":"foo"}'
+    #
+    # @return (see #call)
+    def get(url, params = {}, options = {})
+      parsed_params = Gateway.parsed_params( wrap(:get, url, params) )
+      get_request = Net::HTTP::Get.new("#{url}?#{parsed_params}")
+      self.call( get_request, options.merge(:format => params[:format]) )
+    end
+
+    # @param (see #get)
+    #
+    # @return (see #call)
+    def post(url, params = {}, options = {})
+      post_request = Net::HTTP::Post.new(url)
+      post_request.body = Gateway.parsed_params( wrap(:post, url, params) )
+      post_request.content_type = 'application/x-www-form-urlencoded'
+      self.call( post_request, options.merge(:format => params[:format]) )
+    end
+
+    # wrap `http_method`, `url`, `params` together
+    def wrap(http_method, url, params)
+      params = params.merge(:appid => @appid)
+      params[:sig] = Gateway.signature( "#{@appkey}&", Gateway.make_source(http_method.to_s.upcase, url, params) )
+      params
+    end
+
+    class << self
+      include Signature
+    end
+
+    protected
+
+    # Call the request and format the output
+    # @param [Net::HTTP::Request] request be called
+    # @param [Hash] options some option used to format output
+    #
+    # @return [String, Object] unformatted string result or parsed OpenStruct instance
+    def call(request, options)
+      response = begin
+        @http.request(request)
+      rescue Exception => e
+        Error.new(OPEN_HTTP_TRANSLATE_ERROR, "#{e.message}\n#{e.backtrace.inspect}", options[:format])
+      end
+      
+      return response.body if options[:raw] || options[:format] == 'xml'
+
+      OpenStruct.new( JSON.parse(response.body) )
+    end
+
+  end
+end

data/lib/open_qq/rails/action_controller.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+module OpenQq
+  module Rails
+    module ActionController
+      extend ActiveSupport::Concern
+
+      private
+      # @example
+      #   class OpenQqController < ApplicationController
+      #     include OpenQq::Rails::ActionController
+      #
+      #     def index
+      #       if verify_callback_sig
+      #          ...do something
+      #       end
+      #     end
+      #   end
+      # @return [Boolean]
+      def verify_callback_sig(key = nil)
+        logger.debug "Appkey: #{key ||= OpenQq.appkey} method: #{request.method} url: #{request.fullpath.split("?")[0]}"
+        logger.debug "params: #{params.slice!(:action, :controller).inspect}"
+        OpenQq.verify_callback_sig(request.method, request.fullpath.split("?")[0], params.slice!(:action, :controller), key)
+      end
+
+    end
+  end
+end

data/lib/open_qq/railtie.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+module OpenQq
+  class Railtie < ::Rails::Railtie
+    
+    generators do
+      require "generators/open_qq/install_generator"
+    end
+
+    initializer "open_qq.setup" do
+      config_file = Rails.root.join("config", "open_qq.yml")
+      if config_file.file?
+        begin
+          options = YAML.load_file(config_file)[Rails.env]
+          OpenQq.setup(options)
+        rescue Exception => e
+          puts "There is a configuration error with the current open_qq.yml"
+          puts e.message
+        end
+      end
+    end
+
+    initializer "load open_qq controller method" do
+      ActiveSupport.on_load(:action_controller) do
+        require 'open_qq/rails/action_controller'
+      end
+    end
+
+  end
+end

data/lib/open_qq/request.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+require 'open_qq/gateway'
+
+module OpenQq
+  class Request < Gateway
+
+    attr_accessor :url, :options
+
+    def initialize(options)
+      options  = options.dup
+      appid    = options.delete(:appid)
+      appkey   = options.delete(:appkey)
+      env      = options.delete(:env)
+      @url     = options.delete(:url)
+      @options = options || {}
+      super(appid, appkey, env)
+    end
+
+    # @see Gateway#get
+    def get(params = {}, options = nil)
+      options ||= @options
+      super(@url, params, options)
+    end
+    
+    # @see Gateway#get
+    def post(params = {}, options = nil)
+      options ||= @options
+      super(@url, params, options)
+    end
+
+  end
+end

data/lib/open_qq/signature.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+require 'base64'
+require 'openssl'
+require 'uri'
+
+module OpenQq
+  module Signature
+    
+    def signature(key, source)
+      Base64.encode64( OpenSSL::HMAC.digest('sha1', key, source) ).rstrip
+    end
+
+    def url_escape(url)
+      URI.escape(url, /[^\.\-_\da-zA-Z]/)
+    end
+
+    def parsed_params(params)
+      params.map{|k,v| "#{url_escape(k.to_s)}=#{url_escape(v.to_s)}"}.join('&')
+    end
+
+    def make_source(http_method, url, params)
+      escape_opt = url_escape( params.sort_by{|k,v| k.to_s}.map{|kv| "#{kv.first}=#{kv.last}" }.join('&') )
+      "#{http_method}&#{url_escape(url)}&#{escape_opt}"
+    end
+
+    def make_callback_source(http_method, url, params)
+      escape_opt = params.sort_by{|k,v| k.to_s}.map do |kv|
+        value = URI.escape(kv.last, /[^0-9a-zA-Z!*()]/)
+        "#{kv.first}=#{value}"
+      end.join('&')
+      "#{http_method}&#{url_escape(url)}&#{url_escape(escape_opt)}"
+    end
+
+    def verify_sig(sig, key, http_method, url, params)
+      sig == url_escape( signature(key, make_callback_source(http_method, url, params)) )
+    end
+
+  end
+end

data/lib/open_qq/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+module OpenQq
+  # 3.0表示OpenAPI版本, 小数点第二位表示SDK版本
+  VERSION = "3.0.3"
+end

data/lib/open_qq.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+#
+# --
+# @author zires
+#
+require 'rubygems' if RUBY_VERSION < '1.9'
+require 'json'
+require 'open_qq/request'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module OpenQq
+  class << self
+
+    def setup(options = {})
+      options    = options.with_indifferent_access
+      @gateway ||= OpenQq::Gateway.new(options[:appid], options[:appkey], options[:env])
+      yield @gateway if block_given?
+    end
+
+    # @see Gateway#get
+    delegate :appid, :appkey, :env, :get, :post, :wrap, :to => :@gateway
+
+    # @example
+    #   OpenQq.call('/v3/user/get_info', { :appid => 123 }) do |request|
+    #     request.get({:openid => '111'})
+    #   end
+    def call(url, options)
+      request = OpenQq::Request.new(options.with_indifferent_access)
+      if block_given?
+        yield request
+      else
+        request
+      end
+    end
+
+    alias start call
+
+    # @example
+    #   params = {openid: 'test001', appid: '33758', sig: 'VvKwcaMqUNpKhx0XfCvOqPRiAnU%3D'}
+    #   OpenQq.verify_callback_sig(:get, '/cgi-bin/temp.py', params)
+    #   #diffenert key
+    #   OpenQq.verify_callback_sig(:get, '/cgi-bin/temp.py', params, 'xxxxxx')
+    #
+    # @return [Boolean]
+    def verify_callback_sig(http_method, url, params, key = nil)
+      key  ||= appkey
+      params = params.dup
+      sig    = params.delete('sig') || params.delete(:sig)
+      Gateway.verify_sig(sig, "#{key}&", http_method.to_s.upcase, url, params)
+    end
+    
+  end
+end
+
+require 'open_qq/railtie' if defined?(Rails)

data/test/benchmark.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'benchmark'
+require 'ostruct'
+require 'json'
+
+n = 500000
+@os = { :ret => 0, 
+       :is_lost => 0,
+       :nickname => 'Peter',
+       :gender => 'boy',
+       :country => 'country',
+       :province => 'province',
+       :city => 'city', 
+       :figureurl => 'http://imgcache.qq.com/qzone_v4/client/userinfo_icon/1236153759.gif',
+       :is_yellow_vip => 1,
+       :is_yellow_year_vip => 1,
+       :yellow_vip_level => 7
+    }
+
+@os_obj = OpenStruct.new(@os)
+
+Benchmark.bm do |x|
+
+  x.report { for i in 1..n; @os_obj.nickname; end }
+  x.report { for i in 1..n; @os['nickname']; end }
+
+end
+
+@os_json = @os.to_json
+
+m = 10
+
+Benchmark.bm do |x|
+
+  x.report { for i in 1..m; JSON.parse(@os_json); end }
+  x.report { for i in 1..m; OpenStruct.new( JSON.parse(@os_json) ); end }
+
+end

data/test/open_qq/error_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class OpenQq::ErrorTest < MiniTest::Unit::TestCase
+
+  def test_symbol_format
+    error = OpenQq::Error.new(100, 'error!', :json)
+    assert_equal '{"ret":100,"msg":"error!"}', error.body
+  end
+
+  def test_json_format
+    error = OpenQq::Error.new(100, 'error!', 'json')
+    assert_equal '{"ret":100,"msg":"error!"}', error.body
+  end
+
+  def test_xml_format
+    error = OpenQq::Error.new(100, 'error!', 'xml')
+    assert_equal '<?xml version="1.0" encoding="UTF-8"?><data><ret>100</ret><msg>error!</msg></data>', error.body
+  end
+
+  def test_no_format
+    error = OpenQq::Error.new(100, 'error!')
+    assert_equal '{"ret":100,"msg":"error!"}', error.body
+  end
+
+  def test_unsupported_format
+    error = OpenQq::Error.new(100, 'error!', :ruby)
+    assert_equal '{"ret":100,"msg":"error!"}', error.body
+  end
+
+end

data/test/open_qq/gateway_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class OpenQq::GatewayTest < MiniTest::Unit::TestCase
+
+  def setup
+    # 测试用例的签名通过腾讯联调工具产生 http://open.qq.com/tools
+    @appid   = 12345
+    @appkey  = '228bf094169a40a3bd188ba37ebe8723'
+    @env     = 'http://119.147.19.43'
+    @gateway = OpenQq::Gateway.new(@appid, @appkey, @env)
+  end
+
+  def test_call_get_request_without_params
+    assert_equal 'foo', @gateway.get('/v3/user/get_info').nickname
+  end
+
+  def test_call_get_request_with_params
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'json' }
+    assert_equal 'foo', @gateway.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_get_request_with_xml_format
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'xml' }
+    assert_equal '<?xml version="1.0" encoding="UTF-8"?>', @gateway.get('/v3/user/get_info', params)
+  end
+
+  def test_call_get_request_without_format_param
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou }
+    assert_equal 'foo', @gateway.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_get_request_with_unknow_format_param
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'ruby'}
+    assert_equal 'foo', @gateway.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_post_request
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal 'foo', @gateway.post('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_post_request_with_raw_output
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal '{ "ret": 0, "is_lost": 0, "nickname": "foo" }', @gateway.post('/v3/user/get_info', params, :raw => true)
+  end
+
+  def test_open_http_translate_error
+    gateway = OpenQq::Gateway.new('123456', @appkey, @env)
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal 2001, gateway.get('/v3/user/get_info', params).ret
+  end
+
+  def test_https_request
+    gateway = OpenQq::Gateway.new(@appid, @appkey, 'https://119.147.19.43')
+    http = gateway.instance_variable_get(:@http)
+    assert_equal 443, http.port
+    assert_equal '119.147.19.43', http.address
+    assert http.use_ssl?
+  end
+
+end

data/test/open_qq/request_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class OpenQq::RequestTest < MiniTest::Unit::TestCase
+
+  def setup
+    # 测试用例的签名通过腾讯联调工具产生 http://open.qq.com/tools
+    options = { :appid  => 12345,
+                :appkey => '228bf094169a40a3bd188ba37ebe8723',
+                :env    => 'http://119.147.19.43',
+                :url    => '/v3/user/get_info',
+              }
+    @request = OpenQq::Request.new(options)
+  end
+
+  def test_call_get_request_without_params
+    assert_equal 'foo', @request.get.nickname
+  end
+
+  def test_call_get_request_with_params
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'json' }
+    assert_equal 'foo', @request.get(params).nickname
+  end
+
+  def test_call_post_request
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal 'foo', @request.post(params).nickname
+  end
+
+  def test_call_post_request_with_raw_output
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal '{ "ret": 0, "is_lost": 0, "nickname": "foo" }', @request.post(params, :raw => true)
+  end
+
+end

data/test/open_qq/signature_test.rb

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+class Foo
+  include OpenQq::Signature
+end
+
+class OpenQq::SignatureTest < MiniTest::Unit::TestCase
+
+  def setup
+    @foo = Foo.new
+    # 测试数据是通过腾讯开放平台联调工具集生成
+    # 详见：http://open.qq.com/tools
+    @url = '/v3/user/get_info'
+    @http_method = :GET
+    @appkey = '228bf094169a40a3bd188ba37ebe8723'
+
+    #openid=11111111111111111&openkey=2222222222222222&pf=qzone&appid=123456&format=json&userip=10.0.0.1
+    @options = { :openid => '11111111111111111', :openkey => '2222222222222222', 
+                 'appid' => '123456', 'pf' => 'qzone', 
+                 :userip => '10.0.0.1', :format => :json
+               }
+  end
+
+  def test_signature_is_a_module
+    assert_equal Module, ::OpenQq::Signature.class
+  end
+
+  def test_make_source
+    expect_source = 'GET&%2Fv3%2Fuser%2Fget_info&appid%3D123456%26format%3Djson%26openid%3D11111111111111111%26openkey%3D2222222222222222%26pf%3Dqzone%26userip%3D10.0.0.1'
+    assert_equal expect_source, @foo.make_source(@http_method, @url, @options)
+  end
+
+  def test_parsed_params
+    opt = { '/ +=&' => '123@*!' }
+    assert_equal( "%2F%20%2B%3D%26=123%40%2A%21", @foo.parsed_params(opt) )
+  end
+
+  def test_url_escape
+    assert_equal 'o%2FnGo1QkVEiiN6Bqn%2FfRJtEJwLc%3D', @foo.url_escape('o/nGo1QkVEiiN6Bqn/fRJtEJwLc=')
+  end
+
+  def test_signature
+    source = @foo.make_source(@http_method, @url, @options)
+    assert_equal( 'o/nGo1QkVEiiN6Bqn/fRJtEJwLc=', @foo.signature("#{@appkey}&", source) )
+  end
+
+  #测试用例通过http://wiki.open.qq.com/wiki/回调发货URL的协议说明_V3获得
+  def test_make_callback_source
+    params = 'openid=test001&appid=33758&ts=1328855301&payitem=323003*8*1&token=53227955F80B805B50FFB511E5AD51E025360&billno=-APPDJT18700-20120210-1428215572&version=v3&zoneid=1&providetype=0&amt=80&payamt_coins=20&pubacct_payamt_coins=10'
+    options = {}
+    params.split('&').each do |param|
+      param = param.split('=')
+      options[param.first] = param.last
+    end
+    expect = 'GET&%2Fcgi-bin%2Ftemp.py&amt%3D80%26appid%3D33758%26billno%3D%252DAPPDJT18700%252D20120210%252D1428215572%26openid%3Dtest001%26payamt_coins%3D20%26payitem%3D323003%2A8%2A1%26providetype%3D0%26pubacct_payamt_coins%3D10%26token%3D53227955F80B805B50FFB511E5AD51E025360%26ts%3D1328855301%26version%3Dv3%26zoneid%3D1'
+    assert_equal expect, @foo.make_callback_source(:GET, '/cgi-bin/temp.py', options)
+  end
+
+  def test_verify_sig
+    key = '12345f9a47df4d1eaeb3bad9a7e54321&'
+    sig = 'VvKwcaMqUNpKhx0XfCvOqPRiAnU%3D'
+    params = 'openid=test001&appid=33758&ts=1328855301&payitem=323003*8*1&token=53227955F80B805B50FFB511E5AD51E025360&billno=-APPDJT18700-20120210-1428215572&version=v3&zoneid=1&providetype=0&amt=80&payamt_coins=20&pubacct_payamt_coins=10'
+    options = {}
+    params.split('&').each do |param|
+      param = param.split('=')
+      options[param.first] = param.last
+    end
+    assert @foo.verify_sig(sig, key, :GET, '/cgi-bin/temp.py', options), 'Verify sig failure'
+  end
+
+end

data/test/open_qq_test.rb

@@ -0,0 +1,131 @@
+# encoding: utf-8
+require 'test_helper'
+
+class OpenQqTest < MiniTest::Unit::TestCase
+  
+  def setup
+    @options = { :appid  => 12345,
+                 :appkey => '228bf094169a40a3bd188ba37ebe8723',
+                 :env    => 'http://119.147.19.43',
+                 :url    => '/v3/user/get_info',
+              }
+    OpenQq.setup(@options)
+  end
+
+  def teardown
+    # Need setup back for the rest test
+    OpenQq.setup{|c| 
+      c.appid = 12345
+      c.appkey ='228bf094169a40a3bd188ba37ebe8723'
+      c.env ='http://119.147.19.43'
+    }
+  end
+
+  def test_OpenQq_is_a_module
+    assert_kind_of Module, OpenQq
+  end
+
+  def test_setup
+    assert_equal 12345, OpenQq.appid
+    assert_equal '228bf094169a40a3bd188ba37ebe8723', OpenQq.appkey
+    assert_equal 'http://119.147.19.43', OpenQq.env
+    OpenQq.setup do |config|
+      config.appid = 'foo'
+    end
+    assert_equal 'foo', OpenQq.appid
+  end
+
+  # Copy from gateway_test
+
+  def test_call_get_request_without_params
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info').nickname
+  end
+
+  def test_call_get_request_with_params
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'json' }
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_get_request_with_xml_format
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'xml' }
+    assert_equal '<?xml version="1.0" encoding="UTF-8"?>', OpenQq.get('/v3/user/get_info', params)
+  end
+
+  def test_call_get_request_without_format_param
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou }
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_get_request_with_unknow_format_param
+    params = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'ruby'}
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_post_request
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal 'foo', OpenQq.post('/v3/user/get_info', params).nickname
+  end
+
+  def test_call_post_request_with_raw_output
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal '{ "ret": 0, "is_lost": 0, "nickname": "foo" }', OpenQq.post('/v3/user/get_info', params, :raw => true)
+  end
+
+  def test_open_http_translate_error
+    OpenQq.setup do |config|
+      config.appid = '123456'
+    end
+    params = {:openid => '1111', :openkey => '2222', :pf => 'pengyou'}
+    assert_equal 2001, OpenQq.get('/v3/user/get_info', params).ret
+  end
+
+  def test_call_wont_change_get_and_post_method
+    params  = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'json' }
+    respond = OpenQq.call('/v3/user/get_info', @options){|r| r.get(params) }
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info', params).nickname
+    assert_equal 'foo', respond.nickname
+  end
+
+  def test_call_has_alise_method_start
+    params  = { :openid => 1111, 'openkey' => '2222', :pf => :pengyou, :format => 'json' }
+    respond = OpenQq.start('/v3/user/get_info', @options){|r| r.get(params) }
+    assert_equal 'foo', OpenQq.get('/v3/user/get_info', params).nickname
+    assert_equal 'foo', respond.nickname
+  end
+
+  def test_verify_callback_sig
+    key = '12345f9a47df4d1eaeb3bad9a7e54321'
+    params = 'openid=test001&appid=33758&ts=1328855301&payitem=323003*8*1&token=53227955F80B805B50FFB511E5AD51E025360&billno=-APPDJT18700-20120210-1428215572&version=v3&zoneid=1&providetype=0&amt=80&payamt_coins=20&pubacct_payamt_coins=10'
+    options = {:sig => 'VvKwcaMqUNpKhx0XfCvOqPRiAnU%3D'}
+    params.split('&').each do |param|
+      param = param.split('=')
+      options[param.first] = param.last
+    end
+    assert OpenQq.verify_callback_sig(:GET, '/cgi-bin/temp.py', options, key), 'Verify sig failure 1'
+    OpenQq.setup{|c| c.appkey = key }
+    assert OpenQq.verify_callback_sig(:GET, '/cgi-bin/temp.py', options), 'Verify sig failure 2'
+    assert OpenQq.verify_callback_sig(:get, '/cgi-bin/temp.py', options), 'Verify sig failure 3'
+  end
+
+  #http://wiki.open.qq.com/wiki/v3/pay/buy_goods
+  def test_buy_goods
+    options = { :appid => 600,
+                :appkey => '12345f9a47df4d1eaeb3bad9a7e54321',
+                :env => 'https://119.147.19.43'
+    }
+    params = { :amt => 4,:appmode => 1,:format => 'json',:goodsmeta => '道具*测试描述信息！！！',
+               :goodsurl => 'http://qzonestyle.gtimg.cn/qzonestyle/act/qzone_app_img/app613_613_75.png',
+               :openid => '0000000000000000000000000E111111',
+               :openkey => '1111806DC5D1C52150CF405E42222222',
+               :payitem => '50005*4*1',
+               :pf => 'qzone',
+               :pfkey => '1B59A5C3D77C7C56D7AFC3E2C823105D',
+               :ts => '1333674935'
+    }
+    sig = 'fVcr1Imq8FjJZgf3h24haUE18rA='
+    OpenQq.call('/v3/pay/buy_goods', options) do |request|
+      assert_equal sig, request.wrap(:get, '/v3/pay/buy_goods', params)[:sig]
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,57 @@
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require "test/unit"
+require 'minitest/autorun'
+
+# Enable turn if it is available
+begin
+  require 'turn'
+rescue LoadError
+end
+
+require 'open_qq'
+
+# fake qq response
+require 'fakeweb'
+
+# 测试用例的签名通过腾讯联调工具产生 http://open.qq.com/tools
+# get
+FakeWeb.register_uri(:get, "http://119.147.19.43/v3/user/get_info?appid=12345&sig=CRkzTEcrnfRkNMt9LnVtHjGTocI%3D", 
+  :body => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }')
+
+# get with json format
+FakeWeb.register_uri(:get, 
+  "http://119.147.19.43/v3/user/get_info?openid=1111&openkey=2222&pf=pengyou&appid=12345&format=json&sig=qjReS%2Fg%2FGM9qStD9gmYNI%2B65nWo%3D", 
+  :body => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }')
+
+# get without format
+FakeWeb.register_uri(:get, 
+  "http://119.147.19.43/v3/user/get_info?openid=1111&openkey=2222&pf=pengyou&appid=12345&sig=CtBQwNTqB24SnqMnWrSJyh4atg8%3D", 
+  :body => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }')
+
+# get with xml format
+FakeWeb.register_uri(:get, 
+  "http://119.147.19.43/v3/user/get_info?openid=1111&openkey=2222&pf=pengyou&appid=12345&format=xml&sig=t4WtmJ2pG6RDgGAOfiLWMf8E4%2FM%3D", 
+  :body => '<?xml version="1.0" encoding="UTF-8"?>')
+
+# get with unsupported format
+FakeWeb.register_uri(:get, 
+  "http://119.147.19.43/v3/user/get_info?openid=1111&openkey=2222&pf=pengyou&appid=12345&format=ruby&sig=egeboQvMq5HbfntN5jdwbQaB6go%3D", 
+  :body => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }')
+
+# post without set format
+FakeWeb.register_uri(:post, 
+  "http://119.147.19.43/v3/user/get_info",
+  :parameters => {:openid => '1111', :openkey => '2222', :pf => 'pengyou', :appid => '12345', :sig => 'CtBQwNTqB24SnqMnWrSJyh4atg8%3D'},
+  :body => '{ "ret": 0, "is_lost": 0, "nickname": "foo" }')
+
+# http translate error
+FakeWeb.register_uri(:get, 
+  "http://119.147.19.43/v3/user/get_info?openid=1111&openkey=2222&pf=pengyou&appid=123456&sig=b67OwPW%2BfHFsKwgpu1b82k4dHZU%3D",
+  :exception => Net::HTTPError)

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: qq_17up
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 3
+  - 0
+  - 3
+  version: 3.0.3
+platform: ruby
+authors: 
+- veggie
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-09-07 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: !binary |
+  6IW+6K6v5byA5pS+5bmz5Y+wcnVieeeJiFNESyBodHRwOi8vb3Blbi5xcS5j
+  b20v
+
+email: 
+- kkxlkkxllb@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/open_qq/install_generator.rb
+- lib/generators/templates/open_qq.yml
+- lib/open_qq/error.rb
+- lib/open_qq/gateway.rb
+- lib/open_qq/rails/action_controller.rb
+- lib/open_qq/railtie.rb
+- lib/open_qq/request.rb
+- lib/open_qq/signature.rb
+- lib/open_qq/version.rb
+- lib/open_qq.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: https://github.com/17up/qq_17up
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: open qq ruby sdk
+test_files: 
+- test/benchmark.rb
+- test/open_qq/error_test.rb
+- test/open_qq/gateway_test.rb
+- test/open_qq/request_test.rb
+- test/open_qq/signature_test.rb
+- test/open_qq_test.rb
+- test/test_helper.rb