Class: Alipay::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/alipay/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Create a client to manage all API request.

Example:

alipay_client = Alipay::Client.new(
  url: 'https://openapi.alipaydev.com/gateway.do',
  app_id: '2016000000000000',
  app_private_key: APP_PRIVATE_KEY,
  alipay_public_key: ALIPAY_PUBLIC_KEY
)

Options:

:url

Alipay Open API gateway, ‘openapi.alipaydev.com/gateway.do’(Sandbox) or ‘openapi.alipay.com/gateway.do’(Production).

:app_id

Your APP ID.

:app_private_key

APP private key.

:alipay_public_key

Alipay public key.

:format

default is ‘json’, only support ‘json’.

:charset

default is ‘UTF-8’, only support ‘UTF-8’.

:sign_type

default is ‘RSA2’, support ‘RSA2’, ‘RSA’, ‘RSA2’ is recommended.



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/alipay/client.rb', line 31

def initialize(options)
  options = ::Alipay::Utils.stringify_keys(options)
  @url = options['url']
  @app_id = options['app_id']
  @app_private_key = options['app_private_key']
  @alipay_public_key = options['alipay_public_key']
  @format = options['format'] || 'json'
  @charset = options['charset'] || 'UTF-8'
  @sign_type = options['sign_type'] || 'RSA2'
  @app_cert_sn = options['app_cert_sn']
  @alipay_root_cert_sn = options['alipay_root_cert_sn']
end

Instance Method Details

#execute(params) ⇒ Object

Immediately make a API request to Alipay and return response body.

Example:

alipay_client.execute(
  method: 'alipay.data.dataservice.bill.downloadurl.query',
  biz_content: {
    bill_type: 'trade',
    bill_date: '2016-04-01'
  }.to_json(ascii_only: true)
)
# => '{ "alipay_data_dataservice_bill_downloadurl_query_response":{...'



128
129
130
131
132
 
# File 'lib/alipay/client.rb', line 128

def execute(params)
  params = prepare_params(params)

  Net::HTTP.post_form(URI(@url), params).body
end

#page_execute_form(params) ⇒ Object

Generate a form string that use to render in view and auto POST to Alipay server.

Example:

alipay_client.page_execute_form(
  method: 'alipay.trade.page.pay',
  biz_content: {
    out_trade_no: '20160401000000',
    product_code: 'FAST_INSTANT_TRADE_PAY',
    total_amount: '0.01',
    subject: 'test'
  }.to_json(ascii_only: true),
  timestamp: '2016-04-01 00:00:00'
)
# => '<form id='alipaysubmit' name='alipaysubmit' action=...'



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/alipay/client.rb', line 104

def page_execute_form(params)
  params = prepare_params(params)

  html = %Q(<form id='alipaysubmit' name='alipaysubmit' action='#{@url}?charset=#{@charset}' method='POST'>)
  params.each do |key, value|
    html << %Q(<input type='hidden' name='#{key}' value='#{value.gsub("'", "&apos;")}'/>)
  end
  html << "<input type='submit' value='ok' style='display:none'></form>"
  html << "<script>document.forms['alipaysubmit'].submit();</script>"
  html
end

#page_execute_url(params) ⇒ Object

Generate a url that use to redirect user to Alipay payment page.

Example:

alipay_client.page_execute_url(
  method: 'alipay.trade.page.pay',
  biz_content: {
    out_trade_no: '20160401000000',
    product_code: 'FAST_INSTANT_TRADE_PAY',
    total_amount: '0.01',
    subject: 'test'
  }.to_json(ascii_only: true),
  timestamp: '2016-04-01 00:00:00'
)
# => 'https://openapi.alipaydev.com/gateway.do?app_id=2016...'



80
81
82
83
84
85
86
 
# File 'lib/alipay/client.rb', line 80

def page_execute_url(params)
  params = prepare_params(params)

  uri = URI(@url)
  uri.query = URI.encode_www_form(params)
  uri.to_s
end

#sdk_execute(params) ⇒ Object

Generate a query string that use for APP SDK excute.

Example:

alipay_client.sdk_execute(
  method: 'alipay.trade.app.pay',
  biz_content: {
    out_trade_no: '20160401000000',
    product_code: 'QUICK_MSECURITY_PAY',
    total_amount: '0.01',
    subject: 'test'
  }.to_json(ascii_only: true),
  timestamp: '2016-04-01 00:00:00'
)
# => 'app_id=2016000000000000&charset=utf-8&sig....'



59
60
61
62
63
 
# File 'lib/alipay/client.rb', line 59

def sdk_execute(params)
  params = prepare_params(params)

  URI.encode_www_form(params)
end

#sign(params) ⇒ Object

Generate sign for params.



135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/alipay/client.rb', line 135

def sign(params)
  string = params_to_string(params)

  case @sign_type
  when 'RSA'
    ::Alipay::Sign::RSA.sign(@app_private_key, string)
  when 'RSA2'
    ::Alipay::Sign::RSA2.sign(@app_private_key, string)
  else
    raise "Unsupported sign_type: #{@sign_type}"
  end
end

#verify?(params) ⇒ Boolean

Verify Alipay notification.

Example:

params = {
  out_trade_no: '20160401000000',
  trade_status: 'TRADE_SUCCESS'
  sign_type: 'RSA2',
  sign: '...'
}
alipay_client.verify?(params)
# => true / false

Returns:

  • (Boolean) 


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/alipay/client.rb', line 160

def verify?(params)
  params = Utils.stringify_keys(params)
  return false if params['sign_type'] != @sign_type

  sign = params.delete('sign')
  # sign_type does not use in notify sign
  params.delete('sign_type')
  string = params_to_string(params)
  case @sign_type
  when 'RSA'
    ::Alipay::Sign::RSA.verify?(@alipay_public_key, string, sign)
  when 'RSA2'
    ::Alipay::Sign::RSA2.verify?(@alipay_public_key, string, sign)
  else
    raise "Unsupported sign_type: #{@sign_type}"
  end
end