veritrans 2.1.3 → 2.2.0

data/lib/veritrans/result.rb

@@ -1,10 +1,46 @@
 class Veritrans
+  # Midtrans response object, a wrapper for raw response object plus helper methods
+  #
+  # Usual response body for Midtrans.charge or Midtrans.status will look like this:
+  #
+  #   {
+  #     "status_code": "200",
+  #     "status_message": "Success, Mandiri Clickpay transaction is successful",
+  #     "transaction_id": "d788e503-3fab-4296-9c10-83b107324cb9",
+  #     "order_id": "2016-11-14 11:54:03 +0800",
+  #     "gross_amount": "10000.00",
+  #     "payment_type": "mandiri_clickpay",
+  #     "transaction_time": "2016-11-14 10:54:02",
+  #     "transaction_status": "settlement",
+  #     "fraud_status": "accept",
+  #     "approval_code": "1479095646260",
+  #     "masked_card": "411111-1111"
+  #   }
+  #
+  # Result object can be used like this:
+  #
+  #   result.success?    # => true
+  #   result.status_code # => 200
+  #   result.transaction_status # => "settlement"
+  #   result.fraud_status # => "accept"
+  #   result.approval_code # => "1479095646260"
+  #   result.masked_card # => "411111-1111"
+  #   
+  #   result.data # => {:status_code => "200", :status_message => "Success, Mandiri ..."} # add data as hash
+  #   result.time # => 1.3501
+  #
   class Result
+    # Response body parsed as hash
     attr_reader :data
+    # HTTP status code, should always be 200
     attr_reader :status
+    # Excon::Response object
     attr_reader :response
+    # Request options, a hash with :path, :method, :headers, :body
     attr_reader :request_options
+    # HTTP request time, a Float
     attr_reader :time
+    # Request full URL, e.g. "https://api.sandbox.midtrans.com/v2/charge"
     attr_reader :url
 
     def initialize(response, url, request_options, time)
@@ -33,28 +69,33 @@ class Veritrans
       @request_options = request_options
     end
 
+    # Return whenever transaction is successful, based on <tt>status_code</tt>
     def success?
       @data[:status_code] == '200' || @data[:status_code] == '201' || @data[:status_code] == '407'
     end
 
-    # for VT-Link
+    # Return if VT-Link page was created
     def created?
       @data[:status_code] == '201'
     end
 
-    # Docs http://docs.veritrans.co.id/en/api/status_code.html
+    # Return <tt>"status_code"</tt> field of response
+    # Docs https://api-docs.midtrans.com/#status-code
     def status_code
       @data[:status_code].to_i
     end
 
+    # Return <tt>"status_message"</tt> field of response
     def status_message
       @data[:status_message]
     end
 
+    # Return <tt>"redirect_url"</tt> field of response
     def redirect_url
       @data[:redirect_url]
     end
 
+    # Return <tt>"transaction_id"</tt> field of response
     def transaction_id
       @data[:transaction_id]
     end
@@ -67,6 +108,7 @@ class Veritrans
       end
     end
 
+    # Raw response body as String
     def body
       response.body
     end
@@ -86,12 +128,26 @@ class Veritrans
     end
   end
 
+  # SNAP response object
   class SnapResult < Result
+
+    # HTTP response status code
     def status_code
       @response.status.to_i
     end
 
+    # DEPRECATED, please use #token instead
     def token_id
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn("`token_id` on SnapResult is deprecated.  Please use `token` instead.")
+      else
+        warn "DEPRECATION WARNING: `token_id` on SnapResult is deprecated.  Please use `token` instead."
+      end
+      @data[:token]
+    end
+
+    # Acccessor for <tt>token</tt> value
+    def token
       @data[:token]
     end
 

data/lib/veritrans/testing.rb

@@ -0,0 +1,156 @@
+require 'excon'
+require 'json'
+require 'uri'
+
+# Client for Midtrans Testing API and some helper methods for SNAP API
+#
+# Status: still in development
+#
+class Veritrans::TestingLib
+
+  def initialize(server_url = "https://api.sandbox.midtrans.com:7676")
+    @server_url = server_url
+  end
+
+  def logger
+    @logger || Veritrans.logger
+  end
+
+  def logger=(value)
+    @logger = value
+  end
+
+  def GET(url, options = {})
+    logger.info("Veritrans::Testing GET #{url}")
+    result = Excon.get(url)
+    logger.info("Veritrans::Testing -> #{result.status}\n#{result.body}")
+    options[:return_raw] ? result : result_json(result)
+  end
+
+  def POST(url, options = {})
+    logger.info("Veritrans::Testing POST #{url} #{options[:body]}")
+    result = Excon.post(url, options)
+    logger.info("Veritrans::Testing -> #{result.status}\n#{result.body}")
+    options[:return_raw] ? result : result_json(result)
+  end
+
+  def get_permata_va(va_number)
+    GET(@server_url + "/api/permata_va/#{va_number}")
+  end
+
+  def pay_permata_va(va_number)
+    POST(@server_url + "/api/permata_va/#{va_number}/pay")
+  end
+
+  def get_bca_va(va_number)
+    GET(@server_url + "/api/bca_va/#{va_number}")
+  end
+
+  def pay_bca_va(va_number)
+    POST(@server_url + "/api/bca_va/#{va_number}/pay")
+  end
+
+  def get_klik_bca(merchant_code, user_id)
+    GET(@server_url + "/api/klikbca/#{merchant_code}/#{user_id}")
+  end
+
+  def pay_klik_bca(merchant_code, user_id, order_id = nil)
+    POST(@server_url + "/api/klikbca/#{merchant_code}/#{user_id}/pay" + (order_id ? "?order_id=#{order_id}" : ''))
+  end
+
+  def get_mandiri_bill(bill_key)
+    GET(@server_url + "/api/mandiri_bill/#{bill_key}")
+  end
+
+  def pay_mandiri_bill(bill_key)
+    POST(@server_url + "/api/mandiri_bill/#{bill_key}/pay")
+  end
+
+  def get_indomaret(payment_code)
+    GET(@server_url + "/api/indomaret/#{payment_code}")
+  end
+
+  def pay_indomaret(payment_code)
+    POST(@server_url + "/api/indomaret/#{payment_code}/pay")
+  end
+
+  def get_cimb_clicks(redirect_url)
+    gateway_result = GET(redirect_url, return_raw: true)
+
+    form_result = extract_form(gateway_result.body)
+
+    POST(form_result[:url].sub("cimb/clicks/index", "api/cimb/inquiry"),
+      body: URI.encode_www_form(form_result[:fields].to_a),
+      headers: {'Content-Type' => 'application/x-www-form-urlencoded'}
+    )
+  end
+
+  def pay_cimb_clicks(redirect_url, user_id = "testuser00")
+    gateway_result = GET(redirect_url, return_raw: true)
+
+    form_result = extract_form(gateway_result.body)
+
+    form_result[:fields]["AccountId"] = user_id
+
+    result = POST(form_result[:url].sub("cimb/clicks/index", "api/cimb/pay"),
+      body: URI.encode_www_form(form_result[:fields].to_a),
+      headers: {'Content-Type' => 'application/x-www-form-urlencoded'}
+    )
+
+    result2 = POST(result['redirect_url'],
+      body: URI.encode_www_form(result['redirect_params'].to_a),
+      headers: {'Content-Type' => 'application/x-www-form-urlencoded'},
+      return_raw: true
+    )
+
+    result
+  end
+
+  # experimental
+  def pay_snap(snap_token, payment_type, transaction_params = {})
+    #snap_data = GET("https://app.sandbox.veritrans.co.id/snap/v1/payment_pages/#{snap_token}")
+    #snap_data = GET("https://app.sandbox.midtrans.com/snap/v1/transactions/#{snap_token}")
+
+    result = POST("https://app.sandbox.midtrans.com/snap/v1/transactions/#{snap_token}/pay",
+      body: JSON.pretty_generate({
+        payment_type: payment_type
+      }.merge(transaction_params)),
+      headers: json_headers
+    )
+
+    result
+  end
+
+  def extract_form(html)
+    form_html = html.match(/(<form.+<\/form>)/m)[1]
+    form_url = form_html.match(/action="(.+?)"/)[1]
+    form_method = form_html.match(/method="(.+?)"/)[1]
+    fields = {}
+    form_html.gsub(/<input(.+?)>/) do |token|
+      key = (token.match(/name="(.+?)"/) || [])[1]
+      value = (token.match(/value="(.+?)"/) || [])[1]
+      fields[key] = value
+    end
+
+    return {
+      method: form_method,
+      url: form_url,
+      fields: fields
+    }
+  end
+
+  def result_json(result) # :nodoc:
+    JSON.parse(result.body)
+  end
+
+  def json_headers # :nodoc:
+    {
+      'Content-Type' => 'application/json;charset=UTF-8',
+      'Accept' => 'application/json, text/plain, */*'
+    }
+  end
+end
+
+class Veritrans
+  Testing = Veritrans::TestingLib.new
+end

data/lib/veritrans/version.rb

@@ -1,3 +1,3 @@
 class Veritrans
-  VERSION = "2.1.3"
+  VERSION = "2.2.0"
 end

data/spec/cli_spec.rb

@@ -27,7 +27,7 @@ describe Veritrans do
 
   it "should raise error if payment not found" do
     CONFIG[:order] = "1111-not-exists"
-    CONFIG[:config_path] = "./example/veritrans.yml"
+    CONFIG[:config_path] = "./example/sinatra/veritrans.yml"
 
     VCR.use_cassette("cli_test_not_exists") do
       silence_stream(STDOUT) do
@@ -64,7 +64,7 @@ describe Veritrans do
 
   it "should send real data as json" do
     CONFIG[:order] = "testing-0.2703-1415600236"
-    CONFIG[:config_path] = "./example/veritrans.yml"
+    CONFIG[:config_path] = "./example/sinatra/veritrans.yml"
 
     VCR.use_cassette("cli_test_real_txn") do
       silence_stream(STDOUT) do

data/spec/fixtures/approve_failed.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/not-exists/cancel
+    uri: https://api.sandbox.midtrans.com/v2/not-exists/cancel
     body:
       encoding: UTF-8
       string: "{}"

data/spec/fixtures/cancel_failed.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/not-exists/cancel
+    uri: https://api.sandbox.midtrans.com/v2/not-exists/cancel
     body:
       encoding: UTF-8
       string: "{}"

data/spec/fixtures/cancel_success.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/charge
+    uri: https://api.sandbox.midtrans.com/v2/charge
     body:
       encoding: UTF-8
       string: '{"payment_type":"permata","transaction_details":{"order_id":1415110696,"gross_amount":100000}}'
@@ -54,7 +54,7 @@ http_interactions:
   recorded_at: Tue, 04 Nov 2014 14:18:17 GMT
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/1415110696/cancel
+    uri: https://api.sandbox.midtrans.com/v2/1415110696/cancel
     body:
       encoding: UTF-8
       string: "{}"

data/spec/fixtures/capture_failed.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/capture
+    uri: https://api.sandbox.midtrans.com/v2/capture
     body:
       encoding: UTF-8
       string: '{"transaction_id":"not-exists","gross_amount":1000}'

data/spec/fixtures/charge.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/charge
+    uri: https://api.sandbox.midtrans.com/v2/charge
     body:
       encoding: UTF-8
       string: '{"payment_type":"VTWEB","transaction_details":{"order_id":"2014-11-04
@@ -43,7 +43,7 @@ http_interactions:
         {
           "status_code" : "201",
           "status_message" : "OK, success do VTWeb transaction, please go to redirect_url",
-          "redirect_url" : "https://vtweb.sandbox.veritrans.co.id/v2/vtweb/f523ecff-34e7-4791-a558-3f579f731b75"
+          "redirect_url" : "https://vtweb.sandbox.midtrans.com/v2/vtweb/f523ecff-34e7-4791-a558-3f579f731b75"
         }
     http_version: 
   recorded_at: Tue, 04 Nov 2014 13:58:15 GMT

data/spec/fixtures/charge_direct.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/charge
+    uri: https://api.sandbox.midtrans.com/v2/charge
     body:
       encoding: UTF-8
       string: '{"payment_type":"permata","transaction_details":{"order_id":"2014-11-04

data/spec/fixtures/charge_vtweb.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/charge
+    uri: https://api.sandbox.midtrans.com/v2/charge
     body:
       encoding: UTF-8
       string: '{"payment_type":"vtweb","transaction_details":{"order_id":"2014-11-04
@@ -43,7 +43,7 @@ http_interactions:
         {
           "status_code" : "201",
           "status_message" : "OK, success do VTWeb transaction, please go to redirect_url",
-          "redirect_url" : "https://vtweb.sandbox.veritrans.co.id/v2/vtweb/aff32361-ad6b-4e3f-9173-95b057e68157"
+          "redirect_url" : "https://vtweb.sandbox.midtrans.com/v2/vtweb/aff32361-ad6b-4e3f-9173-95b057e68157"
         }
     http_version: 
   recorded_at: Tue, 04 Nov 2014 14:10:15 GMT

data/spec/fixtures/cli_test_1111-not-exists.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.veritrans.co.id/v2/1111-not-exists/status
+    uri: https://api.sandbox.midtrans.com/v2/1111-not-exists/status
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cli_test_not_exists.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.veritrans.co.id/v2/1111-not-exists/status
+    uri: https://api.sandbox.midtrans.com/v2/1111-not-exists/status
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cli_test_real_txn.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.veritrans.co.id/v2/testing-0.2703-1415600236/status
+    uri: https://api.sandbox.midtrans.com/v2/testing-0.2703-1415600236/status
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/cli_test_unauthorized.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.veritrans.co.id/v2/1111-not-exists/status
+    uri: https://api.sandbox.midtrans.com/v2/1111-not-exists/status
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/events_test_real_txn.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.sandbox.veritrans.co.id/v2/testing-0.2703-1415600236/status
+    uri: https://api.sandbox.midtrans.com/v2/testing-0.2703-1415600236/status
     body:
       encoding: US-ASCII
       string: ''

data/spec/fixtures/expire_failed.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.sandbox.veritrans.co.id/v2/not-exists/expire
+    uri: https://api.sandbox.midtrans.com/v2/not-exists/expire
     body:
       encoding: UTF-8
       string: "{}"