veritrans 2.3.0 → 2.4.0

data/example/sinatra/webapp.rb

@@ -0,0 +1,113 @@
+require 'veritrans'
+require 'json'
+require 'sinatra'
+
+Midtrans.config.server_key = "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2"
+Midtrans.config.client_key = "SB-Mid-client-ArNfhrh7st9bQKmz"
+Midtrans.config.api_host = "https://api.sandbox.midtrans.com"
+
+set :public_folder, File.dirname(__FILE__)
+set :views, File.dirname(__FILE__)
+set :run, $0 == __FILE__
+
+def generate_order_id
+  "sinatra-example-#{Time.now.to_i}"
+end
+
+get "/" do
+  erb :index
+end
+
+get "/snap" do
+  result = Midtrans.create_snap_token(
+    transaction_details: {
+      order_id: generate_order_id,
+      gross_amount: 100000,
+      secure: true
+    }
+  )
+  @token = result.token
+  erb :snap
+end
+
+get "/snap_redirect" do
+  result = Midtrans.create_snap_redirect_url(
+    transaction_details: {
+      order_id: generate_order_id,
+      gross_amount: 100000,
+      secure: true
+    }
+  )
+  @redirecturl = result.redirect_url
+  erb :snap_redirect
+end
+
+post "/coreapi_card_charge_ajax_handler" do
+  @data = JSON.parse(request.body.read)
+  @result = Midtrans.charge(
+    payment_type: "credit_card",
+    credit_card: {
+      token_id: @data['token_id'],
+      authentication: @data['authenticate_3ds']
+    },
+    transaction_details: {
+      order_id: generate_order_id,
+      gross_amount: 20000
+    })
+
+  if params[:format] == "json"
+    content_type :json
+    @result.response.body
+  else
+    erb :response
+  end
+end
+
+post "/check_transaction_status" do
+  @data = JSON.parse(request.body.read)
+  transaction_id = @data['transaction_id']
+  @result = Midtrans.status(transaction_id)
+
+  if params[:format] == "json"
+    content_type :json
+    @result.response.body
+  else
+    erb :response
+  end
+end
+
+post "/handle_http_notification" do
+  post_body = JSON.parse(request.body.read)
+  notification = Midtrans.status(post_body['transaction_id'])
+
+  order_id = notification.data[:order_id]
+  payment_type = notification.data[:payment_type]
+  transaction_status = notification.data[:transaction_status]
+  fraud_status = notification.data[:fraud_status]
+
+  puts "Transaction order_id: #{order_id}"
+  puts "Payment type:   #{payment_type}"
+  puts "Transaction status: #{transaction_status}"
+  puts "Fraud status:   #{fraud_status}"
+
+  return "Transaction notification received. Order ID: #{order_id}. Transaction status: #{transaction_status}. Fraud status: #{fraud_status}"
+
+  # Sample transactionStatus handling logic
+  if transaction_status == "capture" && fraud_status == "challange"
+    # TODO set transaction status on your databaase to 'challenge'
+  elsif transaction_status == "capture" && fraud_status == "success"
+    # TODO set transaction status on your databaase to 'success'
+  elsif transaction_status == "settlement"
+    # TODO set transaction status on your databaase to 'success'
+  elsif transaction_status == "deny"
+    # TODO you can ignore 'deny', because most of the time it allows payment retries
+  elsif transaction_status == "cancel" || transaction_status == "expire"
+    # TODO set transaction status on your databaase to 'failure'
+  elsif transaction_status == "pending"
+    # Todo set transaction status on your databaase to 'pending' / waiting payment
+  end
+
+end
+
+
+

data/example/snap/readme.md

@@ -0,0 +1,4 @@
+How to run snap_example:
+
+1. Install dependencies: `gem install veritrans`
+2. Run the file: `ruby snap_example.rb`

data/example/snap/snap_example.rb

@@ -0,0 +1,39 @@
+require 'veritrans'
+
+# This is just for very basic implementation reference, in production, you should validate the incoming requests and implement your backend more securely.
+# Please refer to this docs for snap popup:
+# https://docs.midtrans.com/en/snap/integration-guide?id=integration-steps-overview
+
+# Please refer to this docs for snap-redirect:
+# https://docs.midtrans.com/en/snap/integration-guide?id=alternative-way-to-display-snap-payment-page-via-redirect
+
+# Set Midtrans config
+# You can find it in Merchant Portal -> Settings -> Access keys
+Midtrans.config.server_key = "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2"
+Midtrans.config.client_key = "SB-Mid-client-ArNfhrh7st9bQKmz"
+Midtrans.config.api_host = "https://api.sandbox.midtrans.com"
+
+# Create snap transaction
+begin
+result = Midtrans.create_snap_token(
+  transaction_details: {
+    order_id: "snap-example-test-#{Time.now.to_i}",
+    gross_amount: 200000
+  },
+  "credit_card": {
+    "secure": true
+  }
+)
+puts "Snap result : #{result.data}"
+rescue MidtransError => e
+  puts e.message # Basic message error
+  puts e.http_status_code # HTTP status code e.g: 400, 401, etc.
+  puts e.api_response # API response body in String
+  puts e.raw_http_client_data # Raw HTTP client response
+end
+
+# result.data this will be Hash representation of the API JSON response, of example:
+# {
+# : token => "008e586b-17f5-459f-8418-2764f08f1d8c",
+# : redirect_url => "https://app.sandbox.midtrans.com/snap/v2/vtweb/008e586b-17f5-459f-8418-2764f08f1d8c"
+# }

data/lib/test/all.rb

@@ -0,0 +1 @@
+Dir[File.dirname(File.absolute_path(__FILE__)) + '/**/*_test.rb'].each {|file| require file }

data/lib/test/api_test.rb

@@ -0,0 +1,319 @@
+require 'veritrans'
+require 'minitest/autorun'
+
+class TestVeritrans < Minitest::Test
+
+  def setup
+    @mt_test = Veritrans.new(
+      server_key: "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2",
+      client_key: "SB-Mid-client-ArNfhrh7st9bQKmz",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+
+    @mt_test_invalid_key = Veritrans.new(
+      server_key: "invalid server key",
+      client_key: "invalid client key",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+  end
+
+  def test_get_token_credit_card
+    card = {
+      card_number: 4811111111111114,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2025
+    }
+    result = @mt_test.test_token(card)
+    assert_equal 200, result.status_code
+    assert_equal "Credit card token is created as Token ID.", result.status_message
+  end
+
+  def test_charge_credit_card
+    card = {
+      card_number: 5211111111111117,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2025
+    }
+    get_token = @mt_test.test_token(card)
+    result = @mt_test.charge(
+      {
+        "payment_type": "credit_card",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-creditcard-#{Time.now.to_i}"
+        },
+        "credit_card": {
+          "token_id": "#{get_token.token_id}"
+        }
+      }
+    )
+    assert_equal "Success, Credit Card transaction is successful", result.status_message
+    assert_equal 200, result.status_code
+    assert_equal "Approved", result.channel_response_message
+  end
+
+  def test_charge_bca_va
+    result = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-bcava#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "bca",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, Bank Transfer transaction is created", result.status_message
+  end
+
+  def test_charge_bni_va
+    result = @mt_test.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-bniva-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "bni",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, Bank Transfer transaction is created", result.status_message
+  end
+
+  def test_point_inquiry
+    card = {
+      card_number: 4617006959746656,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2026
+    }
+    result = @mt_test.test_token(card)
+    card_point_response = @mt_test.point_inquiry(result.token_id)
+    assert_equal 200, card_point_response.status_code
+  end
+
+  def test_charge_cimb_clicks
+    result = @mt_test.charge(
+      {
+        "payment_type": "cimb_clicks",
+        "transaction_details": {
+          "order_id": "ruby-lib-test-cimbclicks-#{Time.now.to_i}",
+          "gross_amount": 44000
+        },
+        "cimb_clicks": {
+          "description": "Purchase of a Food Delivery"
+        }
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, CIMB Clicks transaction is successful", result.status_message
+  end
+
+  def test_charge_epay_bri
+    result = @mt_test.charge(
+      {
+        "payment_type": "bri_epay",
+        "transaction_details": {
+          "order_id": "ruby-lib-test-epaybri-#{Time.now.to_i}",
+          "gross_amount": 44000
+        }
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, BRI E-Pay transaction is successful", result.status_message
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_charge_mandiri_bill
+    result = @mt_test.charge(
+      "payment_type": "echannel",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-mandiribill-#{Time.now.to_i}",
+        "gross_amount": 44000
+      },
+      "echannel": {
+        "bill_info1": "Payment for:",
+        "bill_info2": "Item descriptions"
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "OK, Mandiri Bill transaction is successful", result.status_message
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_charge_indomaret
+    result = @mt_test.charge(
+      "payment_type": "cstore",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-indomaret-#{Time.now.to_i}",
+        "gross_amount": 44000
+      },
+      "cstore": {
+        "store": "Indomaret",
+        "message": "Message to display"
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, cstore transaction is successful", result.status_message
+    assert_equal "indomaret", result.store
+  end
+
+  def test_charge_alfamart
+    result = @mt_test.charge(
+      "payment_type": "cstore",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-alfamart-#{Time.now.to_i}",
+        "gross_amount": 44000
+      },
+      "cstore": {
+        "store": "alfamart",
+        "alfamart_free_text_1": "1st row of receipt",
+        "alfamart_free_text_2": "2nd row",
+        "alfamart_free_text_3": "3rd row"
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, cstore transaction is successful", result.status_message
+    assert_equal "alfamart", result.store
+  end
+
+  def test_charge_gopay
+    result = @mt_test.charge(
+      "payment_type": "gopay",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-gopay-#{Time.now.to_i}",
+        "gross_amount": 44000
+      },
+      "gopay": {
+        "enable_callback": "true",
+        "callback_url": "someapps://callback"
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "GoPay transaction is created", result.status_message
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_charge_bcaklikpay
+    result = @mt_test.charge(
+      "payment_type": "bca_klikpay",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-bcaklikpay-#{Time.now.to_i}",
+        "gross_amount": 44000
+      },
+      "bca_klikpay": {
+        "type": "1",
+        "description": "pembelian produk"
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "OK, BCA KlikPay transaction is successful", result.status_message
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_charge_akulaku
+    result = @mt_test.charge(
+      "payment_type": "akulaku",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-#{Time.now.to_i}",
+        "gross_amount": 44000
+      }
+    )
+    assert_equal 201, result.status_code
+    assert_equal "Success, Akulaku transaction is created", result.status_message
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_charge_danamon_online
+    result = @mt_test.charge(
+      "payment_type": "danamon_online",
+      "transaction_details": {
+        "order_id": "ruby-lib-test-#{Time.now.to_i}",
+        "gross_amount": 44000
+      }
+    )
+    assert_equal "Success, Danamon Online transaction is successful", result.status_message
+    assert_equal 201, result.status_code
+    assert_equal "pending", result.transaction_status
+  end
+
+  def test_create_widget_token
+    result = @mt_test.create_widget_token(
+      transaction_details: {
+        order_id: "ruby-lib-test-#{Time.now.to_i}",
+        gross_amount: 200000
+      },
+      "credit_card": {
+        "secure": true
+      }
+    )
+    assert_equal 201, result.status_code
+  end
+
+  def test_fail_charge_invalid_key
+    @mt_test_invalid_key = Veritrans.new(
+      server_key: "invalid server key",
+      client_key: "invalid client key",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+
+    begin
+    @mt_test_invalid_key.charge(
+      {
+        "payment_type": "bank_transfer",
+        "transaction_details": {
+          "gross_amount": 10000,
+          "order_id": "ruby-lib-test-bcava-#{Time.now.to_i}"
+        },
+        "bank_transfer": {
+          "bank": "bca",
+          "va_number": "1234567891"
+        }
+      }
+    )
+    rescue MidtransError => e
+    assert_equal "401", e.status
+    assert_match "Transaction cannot be authorized with the current client/server key.", e.data
+    end
+  end
+
+  def test_fail_get_token
+    @mt_test_invalid_key = Veritrans.new(
+      server_key: "invalid server key",
+      client_key: "invalid client key",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+
+    card = {
+      card_number: 4617006959746656,
+      card_cvv: 123,
+      card_exp_month: 12,
+      card_exp_year: 2026
+    }
+    begin
+      @mt_test_invalid_key.test_token(card)
+    rescue MidtransError => e
+      assert_equal "401", e.status
+      assert_match "Transaction cannot be authorized with the current client/server key.", e.data
+    end
+  end
+
+end

data/lib/test/config_test.rb

@@ -0,0 +1,26 @@
+require 'veritrans'
+require 'minitest/autorun'
+
+class TestVeritrans < Minitest::Test
+  def setup
+    @mt_test = Veritrans.new(
+      server_key: "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2",
+      client_key: "SB-Mid-client-ArNfhrh7st9bQKmz",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+  end
+
+  def test_api_host
+    assert_equal "https://api.sandbox.midtrans.com", Veritrans.config.api_host
+  end
+
+  def test_client_key_server_key
+    Veritrans.config.client_key = "kk-1"
+    Veritrans.config.server_key = "sk-1"
+
+    assert_equal "kk-1", Veritrans.config.client_key
+    assert_equal "sk-1", Veritrans.config.server_key
+  end
+end

data/lib/test/gopay_tokenization_test.rb

@@ -0,0 +1,80 @@
+require 'veritrans'
+require 'minitest/autorun'
+
+class TestVeritrans < Minitest::Test
+  i_suck_and_my_tests_are_order_dependent!
+
+  def setup
+    @mt_test = Veritrans.new(
+      server_key: "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2",
+      client_key: "SB-Mid-client-ArNfhrh7st9bQKmz",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+  end
+
+  def test_link_payment_account
+    p 1
+    param = {
+      "payment_type": "gopay",
+      "gopay_partner": {
+        "phone_number": "81987654321",
+        "country_code": "62",
+        "redirect_url": "https://www.gojek.com"
+      }
+    }
+    result = @mt_test.link_payment_account(param)
+    assert_equal 201, result.status_code
+    assert_equal "PENDING", result.account_status
+    $test_gopay_id = result.account_id
+  end
+
+  def test_get_payment_account
+    p 2
+    param = {
+      "payment_type": "gopay",
+      "gopay_partner": {
+        "phone_number": "81987654321",
+        "country_code": "62",
+        "redirect_url": "https://www.gojek.com"
+      }
+    }
+    charge = @mt_test.link_payment_account(param)
+    result = @mt_test.get_payment_account(charge.account_id)
+    assert_equal 201, result.status_code
+    assert_equal "PENDING", result.account_status
+  end
+
+  def test_unlink_payment_account
+    #expected the API call will fail because of not click activation from link_payment_account
+    p 3
+    begin
+      @mt_test.unlink_payment_account($test_gopay_id)
+    rescue MidtransError => e
+      assert_equal "412", e.status
+      assert_match "Account status cannot be updated.", e.data
+    end
+  end
+
+  def test_get_payment_acc_dummy
+    p 4
+    begin
+    @mt_test.get_payment_account("dummy")
+    rescue MidtransError => e
+    assert_equal "404", e.status
+    assert_match "Account doesn't exist.", e.data
+    end
+  end
+
+  def test_unlink_dummy_account
+    p 5
+    begin
+    @mt_test.unlink_payment_account("dummy")
+    rescue MidtransError => e
+    assert_equal "404", e.status
+    assert_match "Account doesn't exist.", e.data
+    end
+  end
+
+end

data/lib/test/snap_test.rb

@@ -0,0 +1,79 @@
+require 'veritrans'
+require 'minitest/autorun'
+
+class TestVeritrans < Minitest::Test
+
+  def setup
+    @mt_test = Veritrans.new(
+      server_key: "SB-Mid-server-uQmMImQMeo0Ky3Svl90QTUj2",
+      client_key: "SB-Mid-client-ArNfhrh7st9bQKmz",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+  end
+
+  def test_create_widget_token
+    result = @mt_test.create_widget_token(
+      transaction_details: {
+        order_id: "ruby-lib-test-#{Time.now.to_i}",
+        gross_amount: 200000
+      },
+      "credit_card": {
+        "secure": true
+      }
+    )
+    assert_equal 201, result.status_code
+  end
+
+  def test_create_snap_token_string
+    result = @mt_test.create_snap_token_string(
+      transaction_details: {
+        order_id: "ruby-lib-test-snap-#{Time.now.to_i}",
+        gross_amount: 200000
+      },
+      "credit_card": {
+        "secure": true
+      }
+    )
+    assert result != nil
+  end
+
+  def test_snap_redirect_url_str
+    result = @mt_test.create_snap_redirect_url_str(
+      transaction_details: {
+        order_id: "ruby-lib-test-snap#{Time.now.to_i}",
+        gross_amount: 200000
+      },
+      "credit_card": {
+        "secure": true
+      }
+    )
+    assert_match "https://", result
+  end
+
+  def test_snap_invalid_serverkey
+    @mt_test_invalid_key = Veritrans.new(
+      server_key: "invalid server key",
+      client_key: "invalid client key",
+      api_host: "https://api.sandbox.midtrans.com",
+      logger: Logger.new(STDOUT),
+      file_logger: Logger.new(STDOUT)
+    )
+    begin
+    @mt_test_invalid_key.create_widget_token(
+      transaction_details: {
+        order_id: "ruby-lib-test-#{Time.now.to_i}",
+        gross_amount: 200000
+      },
+      "credit_card": {
+        "secure": true
+      }
+    )
+    rescue MidtransError => e
+    assert_equal "401", e.status
+    assert_match "please check client or server key", e.data
+    end
+  end
+
+  end