tenpay 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+test
+pkg
+.DS_Store

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,57 @@
+Tenpay
+======
+
+A Ruby on Rails plugin for Tenpay(财付通).
+
+使用
+=======
+
+1. 修改Gemfile:
+
+gem "tenpay"
+
+2. 生成配置文件：
+
+$ script/rails g tenpay
+
+这个命令会在你的应用的config目录创建一个tenpay.yml文件，默认是快钱提供的测试帐号（关于测试帐号的使用方法请参看测试章节）
+将tenpay.yml中的商户ID和密钥替换为财付通提供给你的真实ID和密钥然后进行下一步。
+
+3. 下面的代码会创建一笔新订单：
+
+  @request = Tenpay::Request.new(
+                 'test product',     # 产品名称
+                  1,                 # 订单编号，必须保持唯一
+                  Time.now,          # 订单生成时间
+                  4500,              # 订单价格，以分为单位
+                  'http://return',   # 完成支付后的回调地址
+                  request.remote_ip, # 用于IP验证，开发模式可忽略
+                  'attach data')     # 自定义数据
+  redirect_to @request.url
+
+上面的代码会将用户重定向到财付通的支付页面。
+
+4. 在用户完成支付后，财付通会调用你在支付请求中提供的返回URL：
+
+  @response = Tenpay::Response.new(params)
+  if @response.successful?
+    # 支付成功
+  else
+    # 失败
+  end
+  
+注意，快钱可能会多次调用你的返回URL，并将结果展现给用户，因此你的代码要考虑多次执行后的输出对用户的有好度。
+
+查询
+========
+
+如果需要查询订单支付状态，可以使用下面的接口:
+
+  @query = Tenpay::Query.new(1,        # 订单id
+                             Time.now) # 订单日期
+  @query.response.successful? # true => 已支付, false => 未支付
+
+----------------
+如果在使用中遇到任何的问题或者建议，欢迎和我联系： 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 tenpay 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 = "tenpay"
+    s.summary = "A Ruby wrapper of Tenpay(财付通) Payment API"
+    s.email = "zhangyuanyi@gmail.com"
+    s.homepage = "http://github.com/yzhang/tenpay"
+    s.description = "A Ruby wrapper of Tenpay(财付通) 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/tenpay/templates/tenpay.yml

@@ -0,0 +1,9 @@
+test:
+  spid: '1900000109'
+  key: '8934e7d15453e97507ef794cf7b0519d'
+development:
+  spid: '1900000109'
+  key: '8934e7d15453e97507ef794cf7b0519d'
+production:
+  spid: '1900000109'
+  key: '8934e7d15453e97507ef794cf7b0519d'

data/lib/generators/tenpay/tenpay_generator.rb

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

data/lib/tenpay.rb

@@ -0,0 +1,5 @@
+require 'tenpay/config'
+require 'tenpay/request'
+require 'tenpay/response'
+require 'tenpay/query'
+require 'tenpay/query_response'

data/lib/tenpay/config.rb

@@ -0,0 +1,18 @@
+module Tenpay
+  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/tenpay.yml"
+          file     = File.open(filename)
+          yaml     = YAML.load(file)
+          return yaml[Rails.env]
+        end.call
+      end
+    end
+  end
+end

data/lib/tenpay/query.rb

@@ -0,0 +1,54 @@
+require 'digest/md5'
+require 'cgi'
+require 'iconv'
+require 'net/http'
+require 'uri'
+require 'hpricot'
+
+module Tenpay
+  class Query
+    GATEWAY_URL = "http://mch.tenpay.com/cgi-bin/cfbi_query_order_v3.cgi"
+
+    def initialize(order_id, date, attach=nil, charset='UTF-8')
+      @cmdno = 1
+      @date  = date.strftime("%Y%m%d")
+      @spid = Tenpay::Config.spid
+      @key = Tenpay::Config.key
+      
+      @order_id = order_id.to_i
+      @attach = attach || 'nil'
+      @charset = charset
+    end
+    
+    def response
+      @response ||= QueryResponse.new(Net::HTTP.get(URI.parse("#{GATEWAY_URL}?#{params}")))
+    end
+    
+    def transaction_id
+      @transaction_id ||= "%s%s%010d" % [@spid, @date, @order_id]
+    end
+    
+    def sign
+      @sign ||= Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    def sign_params
+      @sign_params ||= generate_sign_params
+    end
+
+    private
+    def params
+      @params ||= generate_params
+    end
+    
+    def generate_params
+      "cmdno=2&date=#{@date}&bargainor_id=#{@spid}&transaction_id=#{transaction_id}&sp_billno=#{@order_id}&attach=#{@attach}&" +
+      "output_xml=1&charset=#{@charset}&sign=#{sign}"
+    end
+    
+    def generate_sign_params
+      "attach=#{@attach}&bargainor_id=#{@spid}&charset=#{@charset}&cmdno=2&date=#{@date}&output_xml=1&" +
+      "sp_billno=#{@order_id}&transaction_id=#{transaction_id}&key=#{@key}"
+    end
+  end
+end

data/lib/tenpay/query_response.rb

@@ -0,0 +1,65 @@
+module Tenpay
+  class QueryResponse
+    def initialize(response)
+      @body = response
+    end
+  
+    def valid?
+      sign == Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    def successful?
+      valid? && pay_result == '0'
+    end
+  
+    def doc
+      @doc ||= Hpricot(@body)
+    end
+
+    def attach
+      @attach ||= (doc / 'attach').inner_text
+    end
+  
+    def cmdno
+      @cmdno ||= (doc / 'cmdno').inner_text
+    end
+  
+    def date
+      @date  ||= (doc / 'date').inner_text
+    end
+
+    def fee_type
+      @fee_type ||= (doc / 'fee_type').inner_text
+    end
+  
+    def pay_info
+      @pay_info ||= (doc / 'pay_info').inner_text
+    end
+
+    def pay_result
+      @pay_result ||= (doc / 'pay_result').inner_text
+    end
+
+    def order_id
+      @order_id ||= (doc / 'sp_billno').inner_text
+    end
+  
+    def total_fee
+      @total_fee ||= (doc / 'total_fee').inner_text
+    end
+    
+    def transaction_id
+      @transaction_id ||= (doc / 'transaction_id').inner_text
+    end
+  
+    def sign
+      @sign ||= (doc / 'sign').inner_text
+    end
+  private
+    def sign_params
+      "attach=#{attach}&bargainor_id=#{Tenpay::Config.spid}&cmdno=#{cmdno}&date=#{date}&fee_type=#{fee_type}" +
+      "&pay_info=#{pay_info}&pay_result=#{pay_result}&sp_billno=#{order_id}&total_fee=#{total_fee}&" +
+      "transaction_id=#{transaction_id}&key=#{Tenpay::Config.key}"
+    end
+  end
+end

data/lib/tenpay/request.rb

@@ -0,0 +1,64 @@
+require 'digest/md5'
+require 'cgi'
+require 'iconv'
+
+module Tenpay
+  class Request
+    GATEWAY_URL = "https://www.tenpay.com/cgi-bin/v1.0/pay_gate.cgi"
+
+    def initialize(description, order_id, created_at, total_fee, 
+                    return_url, purchaser_ip='', attach=nil)
+      @cmdno = 1
+      @date  = created_at.strftime("%Y%m%d")
+      @bank_type = 0
+      @fee_type = 1
+      
+      @desc = Iconv.iconv('gbk', 'utf-8', description).join
+      @spid = Tenpay::Config.spid
+      @key = Tenpay::Config.key
+      
+      @order_id = order_id.to_i
+      @total_fee = total_fee.to_i
+      @return_url = return_url
+      @attach = attach || 'nil'
+      
+      @purchaser_ip = (RAILS_ENV == 'production' ? purchaser_ip : '')
+    end
+    
+    def transaction_id
+      @transaction_id ||= "%s%s%010d" % [@spid, @date, @order_id]
+    end
+    
+    def sign
+      @sign ||= Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    def sign_params
+      @sign_params ||= generate_sign_params
+    end
+    
+    def params
+      @params ||= generate_params
+    end
+    
+    def url
+      "#{GATEWAY_URL}?#{params}&sign=#{sign}"
+    end
+    
+    private
+    def generate_params
+      params = "cmdno=#{@cmdno}&date=#{@date}&bargainor_id=#{@spid}&transaction_id=#{transaction_id}" +
+                "&sp_billno=#{@order_id}&total_fee=#{@total_fee}&fee_type=#{@fee_type}" +
+          "&return_url=#{@return_url}&attach=#{CGI.escape(@attach)}&desc=#{CGI.escape(@desc)}"
+      params << "&spbill_create_ip=#{@purchaser_ip}" unless @purchaser_ip.nil? || @purchaser_ip == ''
+      params
+    end
+    def generate_sign_params
+      sign_params = "cmdno=#{@cmdno}&date=#{@date}&bargainor_id=#{@spid}&transaction_id=#{transaction_id}" +
+                "&sp_billno=#{@order_id}&total_fee=#{@total_fee}&fee_type=#{@fee_type}" +
+                "&return_url=#{@return_url}&attach=#{CGI.escape(@attach)}"
+      sign_params << "&spbill_create_ip=#{@purchaser_ip}" unless @purchaser_ip.nil? || @purchaser_ip == ''
+      sign_params << "&key=#{@key}"
+    end
+  end
+end

data/lib/tenpay/response.rb

@@ -0,0 +1,41 @@
+require 'digest/md5'
+require 'cgi'
+require 'iconv'
+
+module Tenpay
+  class Response
+    attr_reader :order_id, :total_fee, :attach, :pay_time
+    
+    def initialize(params)
+      @cmdno = params[:cmdno] || ''
+      @date = params[:date] || ''
+      @fee_type = params[:fee_type] || ''
+      @pay_info = params[:pay_info] || ''
+      @pay_result = params[:pay_result] || ''
+      @pay_time = Time.at((params[:pay_time] || '0').to_i)
+      @sign = params[:sign] || ''
+      @order_id = (params[:sp_billno] || '').to_i
+      @transaction_id = params[:transaction_id] || ''
+      @total_fee = params[:total_fee] || ''
+      @attach = params[:attach] || ''
+      
+      @spid = Tenpay::Config.spid
+      @key = Tenpay::Config.key
+    end
+    
+    def successful?
+      @pay_info == 'OK' && @pay_result == '0' && valid_sign?
+    end
+    
+    def valid_sign?
+      @sign == Digest::MD5.hexdigest(sign_params).upcase
+    end
+    
+    private
+    def sign_params
+      @sign_params ||= "cmdno=#{@cmdno}&pay_result=#{@pay_result}&date=#{@date}&transaction_id=#{@transaction_id}" +
+                "&sp_billno=#{@order_id}&total_fee=#{@total_fee}&fee_type=#{@fee_type}" +
+                "&attach=#{CGI.escape(@attach)}&key=#{@key}"
+    end
+  end
+end

data/spec/query_spec.rb

@@ -0,0 +1,80 @@
+ENV["RAILS_ENV"] = "test"
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require "tenpay"
+require 'net/http'
+
+describe Tenpay::Request do
+  before do
+    @query = Tenpay::Query.new(1, Date.new(2009, 9, 12))
+    @sign_params = "attach=nil&bargainor_id=1900000109&charset=UTF-8&cmdno=2&date=20090912&output_xml=1&" +
+              "sp_billno=1&transaction_id=1900000109200909120000000001&key=8934e7d15453e97507ef794cf7b0519d"
+    @sign = Digest::MD5.hexdigest(@sign_params).upcase
+    @params = "cmdno=2&date=20090912&bargainor_id=1900000109&transaction_id=1900000109200909120000000001" +
+              "&sp_billno=1&attach=nil&output_xml=1&charset=UTF-8&sign=#{@sign}"
+  end
+  
+  it "should return a Query Response object." do
+    @uri = mock('uri')
+    URI.should_receive(:parse).with("#{Tenpay::Query::GATEWAY_URL}?#{@params}").and_return(@uri)
+    Net::HTTP.should_receive(:get).with(@uri)
+    Tenpay::QueryResponse.stub!(:new).and_return(mock('response'))
+    @query.response
+  end
+  
+  it "should construct sign params properly." do
+    @query.sign_params.should == @sign_params
+  end
+end
+
+describe Tenpay::QueryResponse do
+  before do
+    @valid_response   = VALID_XML
+    @invalid_response = ''
+  end
+  
+  it "should be invalid with invalid response" do
+    @response = Tenpay::QueryResponse.new(@invalid_response)
+    @response.should_not be_valid
+  end
+  
+  it "should be valid with valid response" do
+    @response = Tenpay::QueryResponse.new(@valid_response)
+    @response.attach.should == 'a'
+    @response.cmdno.should == '2'
+    @response.date.should == '20090315'
+    @response.fee_type.should == '1'
+    @response.pay_info.should == 'test'
+    @response.pay_result.should == '2006'
+    @response.order_id.should == '56212087'
+    @response.total_fee.should == '3000'
+    @response.transaction_id.should == '1900000108200903150056212087'
+    @response.sign.should == 'A8D50F1DC2E2E4CC83191AE39C702C27'
+    
+    @response.should be_valid
+  end
+  
+  VALID_XML = %(<?xml version="1.0" encoding="GB2312" ?>
+  <root> 
+    <attach>a</attach>  
+    <bank_type />  
+    <bargainor_id>1900000108</bargainor_id>  
+    <bill_no />  
+    <charset>GB2312</charset>  
+    <cmdno>2</cmdno>  
+    <date>20090315</date>  
+    <dump_html_file />  
+    <fee_type>1</fee_type>  
+    <output_xml>1</output_xml>  
+    <pay_info>test</pay_info>
+    <pay_result>2006</pay_result>  
+    <retcode>00</retcode>  
+    <retmsg>交易成功</retmsg>  
+    <return_url>http://192.168.1.129/bank/cft_return.aspx</return_url>  
+    <sign>A8D50F1DC2E2E4CC83191AE39C702C27</sign>  
+    <sp_billno>56212087</sp_billno>  
+    <total_fee>3000</total_fee>  
+    <transaction_id>1900000108200903150056212087</transaction_id>  
+  </root>
+  )
+end

data/spec/request_spec.rb

@@ -0,0 +1,33 @@
+ENV["RAILS_ENV"] = "test"
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require "tenpay"
+
+describe Tenpay::Request do
+  before do
+    @request = Tenpay::Request.new('test product', 1, 
+	                 4500, 'http://return', '', 'order_id=1')
+    today = Date.today
+    @date = "%d%02d%02d" % [today.year, today.month, today.day]
+    @params = "cmdno=1&date=#{@date}&bargainor_id=1900000109&" +
+        "transaction_id=1900000109#{@date}0000000001&sp_billno=1&total_fee=4500&fee_type=1" +
+        "&return_url=#{'http://return'}&attach=#{CGI.escape('order_id=1')}"
+    @sign = Digest::MD5.hexdigest("#{@params}&key=8934e7d15453e97507ef794cf7b0519d").upcase
+  end
+  
+  it "should construct transaction correctly." do
+    @request.transaction_id.should == "1900000109#{@date}0000000001"
+  end
+  
+  it "should construct params correctly." do
+    @request.params.should == "#{@params}&desc=test product"
+  end
+  
+  it "should sign the params" do
+    @request.sign.should == @sign
+  end
+  
+  it "should generate url for user paying" do
+    @request.url.should == "https://www.tenpay.com/cgi-bin/v1.0/pay_gate.cgi?#{@params}&desc=test product&sign=#{@sign}"
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,26 @@
+ENV["RAILS_ENV"] = "test"
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require "tenpay"
+
+describe Tenpay::Response do
+  before do
+    @valid_params = {:cmdno => '1', :date => '20090818',
+                          :fee_type => '1', :pay_info => 'OK', :pay_result => '0',
+                          :pay_time => '1250554120',
+                          :sign => 'D2171C4319EE7A7A8008F1A4479C8C93',
+                          :sp_billno => '2',
+                          :transaction_id => '1900000109200908180000000002',
+                          :total_fee => '1',
+                          :attach => 'nil'}
+  end
+  
+  it "should be successful with valid params and key" do
+    Tenpay::Response.new(@valid_params).should be_successful
+  end
+  
+  it "should not be successful with invalid params and key" do
+    @valid_params[:date] = '20100912'
+    Tenpay::Response.new(@valid_params).should_not be_successful
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: tenpay
+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-07-06 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "A Ruby wrapper of Tenpay(\xE8\xB4\xA2\xE4\xBB\x98\xE9\x80\x9A) Payment API"
+email: zhangyuanyi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/generators/tenpay/templates/tenpay.yml
+- lib/generators/tenpay/tenpay_generator.rb
+- lib/tenpay.rb
+- lib/tenpay/config.rb
+- lib/tenpay/query.rb
+- lib/tenpay/query_response.rb
+- lib/tenpay/request.rb
+- lib/tenpay/response.rb
+has_rdoc: true
+homepage: http://github.com/yzhang/tenpay
+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 Tenpay(\xE8\xB4\xA2\xE4\xBB\x98\xE9\x80\x9A) Payment API"
+test_files: 
+- spec/query_spec.rb
+- spec/request_spec.rb
+- spec/response_spec.rb