allinpay 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19b0dd054a0b1c2d9649eee3914ce54e9aa5059f
-  data.tar.gz: f0bbb5215e09e201dd1c118264edaa9dd0c50c9a
+  metadata.gz: a084b8c15c36cbc55fff5ed3918ec51f191cba20
+  data.tar.gz: bb451c938351c648250923c878570b0aad9d567b
 SHA512:
-  metadata.gz: 9e31f2c609d3eea074782c21eda2abd9f158a118b1827797d4df3953bacdc9eb137f2b124e640c9eedb0cab1c27aae853445c79cf02c48488caf4b7893e7f82e
-  data.tar.gz: c08c10e3d229171b96e5c86a02de665c372cbaa2d1b737b787c6ccea4a96ae32839425e20749a6adb102d1903a31495d2fe30165a2370e91aa0d6b2b77048821
+  metadata.gz: e7b87b109da3b588b57c30761664d9c989e189fcf6b3ade61117c315cf78b901d57c8de52aab368a1583c04299a334d0e510e2d6d948895060665d9b02428a49
+  data.tar.gz: 3647485074150a7d673c3f6f4aa951d0e2957dc4fe4d6d41ef8f89d7a2448cfcbc4c9ee0dbd187c14f389da3f9efdec84df1343a3452f7af766a6bb8092f9511

data/.yardopts

@@ -0,0 +1 @@
+--plugin activesupport-concern

data/Gemfile

@@ -2,5 +2,7 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
+gem 'yard'
+gem 'yard-activesupport-concern'
 # Specify your gem's dependencies in allinpay.gemspec
 gemspec

data/README.md

@@ -1,35 +1,39 @@
-# Allinpay
+[![Gem Version](https://badge.fury.io/rb/allinpay.svg)](https://badge.fury.io/rb/allinpay)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/allinpay`. To experiment with that code, run `bin/console` for an interactive prompt.
+## 通联支付Ruby接口
 
-TODO: Delete this and the text above, and describe your gem
+### 安装
 
-## Installation
-
-Add this line to your application's Gemfile:
+将以下代码添加到 Gemfile:
 
 ```ruby
 gem 'allinpay'
 ```
 
-And then execute:
+然后执行
 
     $ bundle
 
-Or install it yourself as:
+或者直接运行以下命令安装:
 
     $ gem install allinpay
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### 使用
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+在Rails中使用, 需要将以下代码添加到config/initializers/allinpay.rb中
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/allinpay.
+```ruby
+require 'allinpay'
+
+options = {
+  merchant: '商户号',
+  username: '用户名: 商户号 + 02',
+  password: '登录密码',
+  env: '使用环境',
+  private_path: '私钥文件',
+  private_password: '私钥密码',
+  public_path: '公钥文件'
+}
+
+$allinpay_client = Allinpay::Client.new(options)
+```

data/lib/allinpay.rb

@@ -5,7 +5,6 @@ require 'active_support/concern'
 require 'faraday'
 
 module Allinpay
-  # Your code goes here...
   autoload :Client, 'allinpay/client'
   autoload :Signature, 'allinpay/signature'
   autoload :Service, 'allinpay/service'

data/lib/allinpay/account.rb

@@ -1,19 +1,24 @@
-###
-#  财务接口
-#  1. 账户充值
-#
-###
-
 module Allinpay
+  # 通联支付 账户查询接口
+  # 
+  # 具体文档请查看 http://113.108.182.3:8282/techsp/helper/interapi/tlt/interapi1.html
+  #
+  # @todo
+  #  * 添加历史余额查询
+  #  * 账户提现
   module Account
     extend ActiveSupport::Concern
     included do
 
-      # 询商户在通联的虚拟账户基本信息
+      # 账户信息查询    交易代码：300000
+      # 查询商户在通联的虚拟账户基本信息
+      #
+      # @param account_number [String] 账户号码
       #
+      # @return [Hash] (see Allinpay::Client#result_wrap)
       
       def account(account_number = nil)
-        params = set_infomation('300000',{ REQTIME: timestamps, LEVEL: 9 })
+        params = set_infomation('300000', { REQTIME: timestamps, LEVEL: 9 })
         params[:ACQUERYREQ] = { ACCTNO: account_number} if account_number
         res = conn.request(params)
         return result_wrap(:fail, res, params) if res["INFO"]["RET_CODE"] != "0000"
@@ -22,17 +27,17 @@ module Allinpay
 
       # 账户充值接口
       #
-      # Paramters:
+      # @param bank_account [String] 银行账户
+      # @param amount [Integer] 充值金额
+      # @param business_code [String] 业务代码 默认 100005
+      # @param options [Hash] 其它
+      # @option options [String] :summary 银行交易2
+      # @option options [String] :remark 商户交易备注  
       #
-      # bank_account 银行账户
-      # amount 充值金额
-      # business_code 业务代码 默认 100005
-      # options 
-      #   summary 网银交易备注
-      #   remark 商户交易备注
+      # @return [Hash] (see Allinpay::Client#result_wrap)
       
       def charge(bank_account, amount, business_code = '19900', options = {})
-        params = set_infomation('300006',{ REQTIME: timestamps, LEVEL: 9 })
+        params = set_infomation('300006', { REQTIME: timestamps, LEVEL: 9 })
         charge_info = { 
           BUSINESS_CODE: business_code,
           BANKACCT: bank_account,

data/lib/allinpay/client.rb

@@ -1,4 +1,14 @@
 module Allinpay
+  # 通联支付
+  # @attr merchant [String] 通联支付商户号
+  # @attr username  [String] 通联支付用户名
+  # @attr password  [String] 通联支付密码
+  # @attr public_path  [String]  公共证书位置
+  # @attr private_path  [String]  私密证书位置
+  # @attr private_password [String]  私密证书密码
+  # @attr conn [Request] 请求信息
+
+
   class Client
     attr_accessor :merchant, :username, :password, :conn
 
@@ -6,6 +16,17 @@ module Allinpay
       attr_accessor :private_path, :public_path, :private_password
     end
 
+    # 初始化通联支付
+    #
+    # @param options [Hash] 交易信息
+    # @option options [String] :merchant 通联支付商户号
+    # @option options [String] :username 通联支付用户名
+    # @option options [String] :password 通联支付密码
+    # @option options [String] :env 设置环境
+    # @option options [String] :public_path 公共证书位置
+    # @option options [String] :private_path 私密证书位置
+    # @option options [String] :private_password 私密证书密码
+
     def initialize(options)
       @merchant = options[:merchant]
       @username = options[:username]
@@ -16,6 +37,13 @@ module Allinpay
 
     private
 
+    # 设置基本信息
+    #
+    # @param code [String] 交易代码
+    # @param options [Hash] 其它信息
+    #
+    # return [Hash] 
+
     def set_infomation(code, options = {})
       info = {
         TRX_CODE: code,
@@ -28,14 +56,23 @@ module Allinpay
       return { INFO: info }
     end
 
+    # 生成交易序号
+
     def req_sn
       merchant + timestamps + rand(1000).to_s.ljust(4, '0')
     end
 
+    # 生成时间
+
     def timestamps
       Time.now.strftime('%Y%m%d%H%M%S')
     end
 
+    # 将结果重新包装
+    # @param status [String] 返回状态
+    # @param data [String, Hash, Array, nil] 包装数据
+    # @param request [Hash] 请求数据 
+
     def result_wrap(status, data, request = nil)
       return { "status" => status.to_s, "data" => data, "request" => request }
     end

data/lib/allinpay/payment.rb

@@ -1,16 +1,22 @@
-###
-#  交易接口
-#  1. 单笔实时支付
-#
-###
-
-
 module Allinpay
+  # 通联支付 支付接口
+  #
+  # 具体文档请查看 http://113.108.182.3:8282/techsp/helper/interapi/tlt/interapi0.html
   module Payment
     extend ActiveSupport::Concern
     included do
 
-      # 通联支付单笔实时支付
+      # 单笔实时付款    交易代码：100014
+      #
+      # @param tran [Hash] 交易信息
+      # @option tran [String] :bank_code 银行代码，存折必须填写
+      # @option tran [String] :account_number 银行卡或存折号码
+      # @option tran [String] :account_name 银行卡或存折上的所有人姓名
+      # @option tran [String] :account_prop 账号属性 0私人，1公司。不填时，默认为私人0
+      # @param options [Hash] 其它信息 具体参考http://113.108.182.3:8282/techsp/helper/filedetail/tlt/filedetail743.html
+      #
+      # @return [Hash] (see Allinpay::Client#result_wrap)
+
       def pay(tran, options = {})
         params = set_infomation('100014')
         tran_body = {
@@ -30,7 +36,17 @@ module Allinpay
         return result_wrap(:success, res, params)
       end
 
-      # 通联支付批量付款
+      # 批量代付    交易代码：100002
+      # 
+      # @param trans [Array<Hash>] 交易信息
+      # @option trans [String] :bank_code 银行代码，存折必须填写
+      # @option trans [String] :account_number 银行卡或存折号码
+      # @option trans [String] :account_name 银行卡或存折上的所有人姓名
+      # @option trans [String] :account_prop 账号属性 0私人，1公司。不填时，默认为私人0
+      # @param options [Hash] 其它信息 具体参考http://113.108.182.3:8282/techsp/helper/filedetail/tlt/filedetail131.html
+      #
+      # @return [Hash] (see Allinpay::Client#result_wrap)
+      
       def batch_pay(trans, options = {})
         params = set_infomation('100002', {LEVEL: 9})
         details = []

data/lib/allinpay/query.rb

@@ -10,12 +10,14 @@ module Allinpay
     extend ActiveSupport::Concern
     included do
 
-      # 支付交易结果查询
+      # 交易结果查询 交易代码：200004
       #
-      # Paramters:
-      #
-      # sn: 交易序号
-      # options:
+      # @param sn [String] 要查询的交易流水, 若不填时间必填
+      # @param options [Hash] 其它信息
+      # @option options [String] :type 查询类型, 如果使用0查询，未完成交易将查不到
+      # @option options [String] :status 状态,  如果开始时间和结束时间不为空，该字段生效，不可为空
+      # @option options [String] :start_day 开始时间, 若不填QUERY_SN则必填
+      # @option options [String] :end_day 结束时间, 填了开始时间必填
       
       def query_batch_pay(sn, options = {})
         params = set_infomation('200004')

data/lib/allinpay/service.rb

@@ -1,5 +1,9 @@
 module Allinpay
   module Service
+    # 网关信息处理
+    # @param env [String] 所在环境
+    # @param options [Hash] (see #set_signature_infomation)
+    
     def self.connection(env, options)
       set_signature_infomation(options)
       ssl_options = {}
@@ -17,6 +21,10 @@ module Allinpay
       end.new(env, ssl_options)
     end
 
+    # 处理请求
+    # @param params [Hash] 将参数发送服务器
+    #
+    # @return [Hash] 将处理后的结果转换成Hash 
     def request(params)
       params[:INFO][:SIGNED_MSG] = Signature.generate(parse_xml(params)).unpack('H*').first
       body = parse_xml(params)
@@ -33,18 +41,37 @@ module Allinpay
 
     private
 
+    # 验证服务器返回结果
+    #
+    # @param res [String] 服务返回body信息
+    # @param result [Hash] 返回xml转换后的信息
+    #
+    # return [Boolean] 验证结果
+
     def verify_signature?(res, result)
       signed = result["AIPG"]["INFO"]["SIGNED_MSG"]
       xml_body = res.encode('utf-8', 'gbk').gsub(/<SIGNED_MSG>.*<\/SIGNED_MSG>/, '')
       Signature.verify?(xml_body.encode('gbk', 'utf-8'), [signed].pack("H*"))
     end
 
+    # 将数据转换成XML
+    #
+    # @param data [String] 待装换信息
+    # @param indent [Integer] 开始位置, 默认为0
+    #
+    # @return [String] xml信息
+    
     def parse_xml(data, indent = 0)
       data_xml = data.to_xml(root: 'AIPG', skip_types: true, dasherize: false, indent: indent).sub('UTF-8', 'GBK')
       data_xml.encode! 'gbk','utf-8'
       data_xml
     end
 
+    # 设置支付网关
+    #
+    # @param env [String] 所在环境
+    # @return [String] 网关链接
+    
     def set_gateway_url(env)
       if env.to_s == "development" || env.to_s == "test"
         return 'https://113.108.182.3/aipg/ProcessServlet'
@@ -53,6 +80,10 @@ module Allinpay
       end
     end
 
+    # 设置加密信息以及检查证书是否存在
+    #
+    # @param options [Hash](see Allinpay::Client#new)
+
     def self.set_signature_infomation(options)
       raise "Allinpay private key not exists" if !File.exists?(options[:private_path])
       raise "Allinpay public key not exists" if !File.exists?(options[:public_path])

data/lib/allinpay/signature.rb

@@ -1,7 +1,13 @@
 require 'openssl'
 
 module Allinpay
+
   class Signature
+    # 通联支付 参数加密
+    # 
+    # @param str [String] 待加密参数
+    #
+    # @return [String] 加密后信息
     def self.generate(str)
       private_file = File.open(Allinpay::Client.private_path)
       private_key= OpenSSL::PKCS12.new(private_file, Allinpay::Client.private_password).key.export
@@ -9,6 +15,12 @@ module Allinpay
       rsa.sign("sha1", str.force_encoding("GBK"))
     end
 
+    # 通联支付 信息验证
+    #
+    # @param str [String] 待加密信息
+    # @param sign [String] 签名
+    #
+    # @return [Boolean] 验证后信息
     def self.verify?(str, sign)
       public_file = File.open(Allinpay::Client.public_path)
       public_key = OpenSSL::X509::Certificate.new(public_file).public_key.export

data/lib/allinpay/version.rb

@@ -1,3 +1,3 @@
 module Allinpay
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allinpay
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ye.li
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-30 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - Gemfile
 - README.md
 - Rakefile