kuaiqian 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,58 @@
+快钱
+======
+
+用于支持快钱(http://99bill.com/)支付网关的Rails插件。
+演示站点：http://kqdemo.zaituu.com
+演示代码：http://github.com/yzhang/kuaiqian_demo
+
+安装
+=======
+
+$ script/plugin install git://github.com/yzhang/kuaiqian.git
+
+集成
+=======
+
+1. 安装完成后，插件会自动在你的应用的config目录创建一个kuaiqian.yml文件，默认是快钱提供的测试帐号（关于测试帐号的使用方法请参看测试章节）
+将kuaiqian.yml中的商户ID和密钥替换为快钱提供给你的真实ID和密钥然后进行下一步。
+
+2. 下面的代码会创建一笔新订单：
+
+  @request = Kuaiqian::Request.new('产品名称', # 产品名称
+                  1, # 订单ID，必须全局唯一
+                  Time.now.strftime("%Y%m%d%H%M%S"), # 订单生成时间，格式为20091104174132
+                  4500, # 订单金额，以分为单位
+                  'http://return', # 通知地址，用户支付成功后快钱会通过此地址通知商户支付结果
+                  '00', # 支付类型，00显示所有方式，10只显示银行卡方式，11只显示电话银行方式，12只显示快钱帐户支付方式，13只显示线下方式
+                  'attach') #自定义数据，会在返回URL中原样返回
+  redirect_to @request.url
+
+上面的代码会将用户重定向到快钱的支付页面。
+
+3. 在用户完成支付后，快钱会调用你在支付请求中提供的返回URL：
+
+  @response = Kuaiqian::Response.new(params)
+  if @response.successful?
+    # 支付成功
+  else
+    # 支付失败
+  end
+  
+注意，快钱可能会多次调用你的返回URL，并将结果展现给用户，因此你的代码要考虑多次执行后的输出对用户的有好度。
+
+测试
+=======
+
+要使用快钱提供的测试ID，需要修改你的hosts文件，将快钱的域名指向测试服务器：
+
+218.242.247.5 www.99bill.com
+
+然后使用下面的帐号进行支付：
+
+用户名：kquser02@sina.com 
+密码：99bill
+
+----------------
+如果在使用中遇到任何的问题或者建议，欢迎和我联系： zhangyuanyi@gmail.com
+
+Copyright (c) 2009 Yuanyi Zhang, released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Generate documentation for the kuaiqian plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tenpay'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "kuaiqian"
+    s.summary = "A Ruby wrapper of Kauqian(快钱) Payment API"
+    s.email = "zhangyuanyi@gmail.com"
+    s.homepage = "http://github.com/yzhang/kuaiqian"
+    s.description = "A Ruby wrapper of Kauqian(快钱) Payment API"
+    s.authors = ["Yuanyi Zhang"]
+    s.files =  FileList["[A-Z]*", "{lib}/**/*", '.gitignore']
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/generators/kuaiqian/kuaiqian_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+class KuaiqianGenerator < Rails::Generators::Base
+  def install_douban
+    copy_file("kuaiqian.yml", 'config/kuaiqian.yml')
+  end
+  
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+end

data/lib/generators/kuaiqian/templates/kuaiqian.yml

@@ -0,0 +1,9 @@
+test:
+  spid: '1001153656201'
+  key: 'ZUZNJB8MF63GA83J'
+development:
+  spid: '1001153656201'
+  key: 'ZUZNJB8MF63GA83J'
+production:
+  spid: '1001153656201'
+  key: 'ZUZNJB8MF63GA83J'

data/lib/kuaiqian.rb

@@ -0,0 +1,3 @@
+require 'kuaiqian/config'
+require 'kuaiqian/request'
+require 'kuaiqian/response'

data/lib/kuaiqian/config.rb

@@ -0,0 +1,18 @@
+module Kuaiqian
+  class Config
+    class << self
+      def spid; config['spid'];  end
+      def key; config['key']; end
+    
+      def config
+        @@config ||= lambda do
+          require 'yaml'
+          filename = "#{Rails.root}/config/kuaiqian.yml"
+          file     = File.open(filename)
+          yaml     = YAML.load(file)
+          return yaml[Rails.env]
+        end.call
+      end
+    end
+  end
+end

data/lib/kuaiqian/request.rb

@@ -0,0 +1,73 @@
+require 'digest/md5'
+require 'cgi'
+require 'iconv'
+
+module Kuaiqian
+  class Request
+    GATEWAY_URL = "https://www.99bill.com/gateway/recvMerchantInfoAction.htm"
+    PARAMS = %w(inputCharset bgUrl version language signType merchantAcctId payerName payerContactType payerContact orderId orderAmount orderTime productName productNum productId productDesc ext1 ext2 payType redoFlag pid)
+    
+    def initialize(product_name, order_id, order_time, total_fee, 
+                    return_url, pay_type='00', attach=nil, payer_name='用户')
+      @bank_type = 0
+      @fee_type = 1
+      
+      @order_id = order_id.to_s
+      @total_fee = total_fee.to_i.to_s
+      @order_time = order_time.strftime("%Y%m%d%H%M%S")
+      @product_name = product_name
+
+      @pay_type = pay_type
+      @return_url = return_url
+      @ext1 = attach || ''
+      
+      @payer_name = payer_name
+    end
+    
+    def url
+      "#{GATEWAY_URL}?#{html_params}&signMsg=#{sign_msg}"
+    end
+
+    def input_charset; '1'; end
+    def bg_url; @return_url; end
+    def page_url; ''; end
+    def version; 'v2.0'; end
+    def language; '1'; end
+    def sign_type; '1'; end
+    def merchant_acct_id; Kuaiqian::Config.spid; end
+    def payer_name; @payer_name; end
+    def payer_contact_type; '1'; end
+    def payer_contact; ''; end
+    def key; Kuaiqian::Config.key; end
+    def order_id; @order_id; end
+    def order_amount; @total_fee; end
+    def order_time; @order_time; end
+    def product_name; @product_name; end
+    def product_num; '1'; end
+    def product_id; ''; end
+    def product_desc; ''; end
+    def ext1; @ext1; end
+    def ext2; ''; end
+    def pay_type; @pay_type; end
+    def redo_flag; "0"; end
+    def pid; ''; end
+
+    def sign_params
+      (PARAMS + ['key']).map do |param|
+        value = send(param.underscore)
+        value == '' ? nil : "#{param}=#{value}"
+      end.compact.join('&')
+    end
+    
+    def sign_msg
+      Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    def html_params
+      PARAMS.map do |param|
+        value = send(param.underscore)
+        value == '' ? nil : "#{param}=#{CGI.escape(value)}"
+      end.compact.join('&')
+    end
+  end
+end

data/lib/kuaiqian/response.rb

@@ -0,0 +1,61 @@
+require 'digest/md5'
+require 'cgi'
+require 'iconv'
+
+module Kuaiqian
+  class Response
+    attr_reader :order_id, :total_fee, :attach, :pay_time
+    
+    BANK_NAMES = {'ICBC' => '中国工商银行', 'CMB' => '招商银行', 'CCB' => '中国建设银行',
+                  'ABC' => '中国农业银行', 'BOC_SH' => '中国银行(上海)', 'BOC_GZ' => '中国银行(广州)',
+                  'SPDB' => '上海浦东发展银行', 'BCOM' => '交通银行', 'CMBC' => '中国民生银行',
+                  'SDB' => '深圳发展银行', 'GDB' => '广东发展银行', 'CITIC' => '中信银行',
+                  'HXB' => '华夏银行', 'CIB' => '兴业银行', 'GZRCC' => '广州市农村信用合作社',
+                  'GZCB' => '广州市商业银行', 'SHRCC' => '上海农村商业银行', 'CPSRB' => '中国邮政储蓄',
+                  'CEB' => '中国光大银行', 'BOB' => '北京银行', 'CBHB' => '渤海银行', 
+                  'BJRCB' => '北京农村商业银行', 'CNPY' => '中国银联'}
+
+    SIGN_PARAMS = %w(merchantAcctId version language signType  payType bankId orderId orderTime orderAmount dealId bankDealId dealTime payAmount fee ext1 ext2  payResult errCode key)
+    def initialize(params)
+      @params = params
+    end
+    
+    def successful?
+      pay_result == '10' && valid_sign?
+    end
+    
+    def valid_sign?
+      sign_msg == Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    def sign_params
+      SIGN_PARAMS.map do |param|
+        value = send(param.underscore)
+        value == '' ? nil : "#{param}=#{value}" 
+      end.compact.join('&')
+    end
+    
+    def version;          @params[:version]; end
+    def language;         @params[:language]; end
+    def sign_type;        @params[:signType]; end
+    def merchant_acct_id; @params[:merchantAcctId]; end
+    def key;              Kuaiqian::Config.key; end
+    def order_id;         @params[:orderId]; end
+    def order_amount;     @params[:orderAmount]; end
+    def order_time;       @params[:orderTime]; end
+    def deal_id;          @params[:dealId]; end
+    def bank_deal_id;     @params[:bankDealId]; end
+    def deal_time;        @params[:dealTime]; end
+    def pay_amount;       @params[:payAmount]; end
+    def fee;              @params[:fee]; end
+    def attach;           @params[:ext1]; end
+    def ext1;             @params[:ext1]; end
+    def ext2;             @params[:ext1]; end
+    def pay_result;       @params[:payResult]; end
+    def err_code;         @params[:errCode]; end
+    def sign_msg;         @params[:signMsg]; end
+    def pay_type;         @params[:payType]; end
+    def bank_id;          @params[:bankId]; end
+    def bank_name;        BANK_NAMES[bank_id]; end
+  end
+end

data/spec/request_spec.rb

@@ -0,0 +1,105 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require 'spec'
+require "kuaiqian"
+
+describe Kuaiqian::Request do
+  before do
+    Kuaiqian::Config.stub!(:spid).and_return('1001153656201')
+    Kuaiqian::Config.stub!(:key).and_return('ZUZNJB8MF63GA83J')
+    
+    time = Time.local(2009, 10, 28, 12, 03, 45)
+    @request = Kuaiqian::Request.new('productName', '20091028120345', time,
+                 2, 'http://return', '00')
+    @order_time = "20091028120345"
+    
+    @valid_params = "inputCharset=1&bgUrl=http%3A%2F%2Freturn&version=v2.0&language=1&signType=1&merchantAcctId=1001153656201&payerName=payerName&payerContactType=1&orderId=20091028120345&orderAmount=2&orderTime=20091028120345&productName=productName&productNum=1&payType=00&redoFlag=0"
+    @valid_sign_params = "inputCharset=1&bgUrl=http://return&version=v2.0&language=1&signType=1&merchantAcctId=1001153656201&payerName=payerName&payerContactType=1&orderId=20091028120345&orderAmount=2&orderTime=20091028120345&productName=productName&productNum=1&payType=00&redoFlag=0&key=ZUZNJB8MF63GA83J"
+  end
+  
+  describe "url generation" do
+    it "should generate sign_params correctly" do
+      @request.sign_params.should == @valid_sign_params
+    end
+    
+    it "should construct url params correctly" do
+      @request.params.should == @valid_params
+    end
+  end
+  
+  describe "basic params" do
+    it "should set input charset to 1" do
+      @request.input_charset.should == '1'
+    end
+    
+    it "should set page url empty" do
+      @request.page_url.should == ''
+    end
+    
+    it "should set bg_url properly" do
+      @request.bg_url.should == 'http://return'
+    end
+  
+    it "should set version to v2.0" do
+      @request.version.should == 'v2.0'
+    end
+  
+    it "should set language to 1" do
+      @request.language.should == '1'
+    end
+  
+    it "should set signType to '1'" do
+      @request.sign_type.should == '1'
+    end
+  
+    it "should set merchantAcctId properly" do
+      @request.merchant_acct_id.should == '1001153656201'
+    end
+  
+    it "should set payer info empty" do
+      @request.payer_name.should == 'payerName'
+      @request.payer_contact_type.should == '1'
+      @request.payer_contact.should == ''
+    end
+    
+    it "should set key properly" do
+      @request.key.should == 'ZUZNJB8MF63GA83J'
+    end
+  
+    it "should set order id properly" do
+      @request.order_id.should == '20091028120345'
+    end
+  
+    it "should set order amount properly" do
+      @request.order_amount.should == '2'
+    end
+  
+    it "should set order time properly" do
+      @request.order_time.should == '20091028120345'    
+    end
+  
+    it "should set product info properly" do
+      @request.product_name.should == 'productName'
+      @request.product_num.should == '1'
+      @request.product_id.should == ''
+      @request.product_desc.should == ''
+    end
+    
+    it "should set ext properly" do
+      @request.ext1.should == ''
+      @request.ext2.should == ''
+    end
+  
+    it "should set payType properly" do
+      @request.pay_type.should == '00'
+    end
+    
+    it "should set redo flag to zero" do
+      @request.redo_flag.should == '0'
+    end
+    
+    it "should set pid empty" do
+      @request.pid.should == ''
+    end
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,75 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require 'spec'
+require "kuaiqian"
+
+describe Kuaiqian::Response do
+  before(:each) do
+    Kuaiqian::Config.stub!(:spid).and_return('1001153656201')
+    Kuaiqian::Config.stub!(:key).and_return('ZUZNJB8MF63GA83J')
+  end
+  
+  it "should be a valid response with valid params" do
+    response = Kuaiqian::Response.new(params)
+    response.should be_successful
+  end
+    
+  it "should be an invalid response with wrong pay result" do
+    response = Kuaiqian::Response.new(params(:payResult => '00'))
+    response.should_not be_successful
+  end
+  
+  it "should be an invalid response with wrong sign msg" do
+    response = Kuaiqian::Response.new(params(:signMsg => 'wrong'))
+    response.should_not be_successful
+  end
+  
+  def params(options={})
+    {
+      :merchantAcctId => "1001153656201", 
+      :payAmount =>"100", 
+      :bankId => "", 
+      :language => "1", 
+      :orderId =>"20091103164410", 
+      :id => "1",
+      :signType =>"1", 
+      :orderTime =>"20091103164410", 
+      :payResult =>"10", 
+      :version =>"v2.0", 
+      :payType =>"12", 
+      :fee =>"1", 
+      :dealId =>"5696344", 
+      :bankDealId =>"", 
+      :dealTime =>"20091104004452", 
+      :errCode =>"", 
+      :signMsg =>"361A184B9157BBEAA3627B1B0D6412D6", 
+      :ext1 =>"", 
+      :orderAmount =>"100", 
+      :ext2 =>""
+    }.merge(options)
+  end
+  
+  # def params(options={})
+  #   {:merchantAcctId => 'testid',
+  #     :version => 'v2.0',
+  #     :language => '1',
+  #     :signType => '1',
+  #     :payType => '00',
+  #     :bankId => 'ICBC',
+  #     :orderId => '1',
+  #     :orderTime => '20091021123200',
+  #     :orderAmount => '4500',
+  #     :dealId => 'testdealid',
+  #     :bankDealId => 'testbankdeal',
+  #     :dealTime => '20091021123203',
+  #     :payAmount => '4500',
+  #     :fee => '100',
+  #     :ext1 => 'nil',
+  #     :ext2 => '',
+  #     :payResult => '10',
+  #     :errCode => '',
+  #     :key => '',
+  #     :signMsg => '1D060818424C1335C157B1FA5A9A7551'
+  #   }.merge(options)
+  # end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: kuaiqian
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Yuanyi Zhang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "A Ruby wrapper of Kauqian(\xE5\xBF\xAB\xE9\x92\xB1) Payment API"
+email: zhangyuanyi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/generators/kuaiqian/kuaiqian_generator.rb
+- lib/generators/kuaiqian/templates/kuaiqian.yml
+- lib/kuaiqian.rb
+- lib/kuaiqian/config.rb
+- lib/kuaiqian/request.rb
+- lib/kuaiqian/response.rb
+has_rdoc: true
+homepage: http://github.com/yzhang/kuaiqian
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "A Ruby wrapper of Kauqian(\xE5\xBF\xAB\xE9\x92\xB1) Payment API"
+test_files: 
+- spec/request_spec.rb
+- spec/response_spec.rb