veritrans 2.1.3 → 2.2.0

data/lib/generators/templates/assets/credit_card_form.js

@@ -1,3 +1,8 @@
+// Veritrans is defined in https://api.midtrans.com/v2/assets/js/midtrans.min.js
+// and it has no JS dependecies, but this example uses jquery for simplicity
+
+//= require jquery
+
 $(document).ready(function () {
 
   function VT_createTokenData() {
@@ -23,6 +28,7 @@ $(document).ready(function () {
     var button = $(form).find('input[type=submit]:last');
     var buttonValBefore = button.val();
     button.val("Processing ...");
+    button.attr('disabled', true); // prevent double submit
 
     Veritrans.token(VT_createTokenData, function (data) {
       //console.log('Get token response:');

data/lib/generators/templates/payments_controller.rb

@@ -1,5 +1,5 @@
-class PaymentsController < ApplicationController
-  skip_before_filter :verify_authenticity_token, only: [:receive_webhook]
+class PaymentsController < ApplicationController # :nodoc:
+  skip_before_action :verify_authenticity_token, only: [:receive_webhook]
 
   def new
     @payment = make_payment
@@ -53,14 +53,14 @@ class PaymentsController < ApplicationController
       puts "Payment amount: #{verified_data.data[:gross_amount]}"
       puts "--- Transaction callback ---"
 
-      render text: "ok"
+      render plain: "ok"
     else
       Veritrans.file_logger.info("Callback verification failed for order: " +
         "#{params[:order_id]} #{params[:transaction_status]}}\n" +
         verified_data.body + "\n"
       )
 
-      render text: "ok", :status => :not_found
+      render plain: "ok", :status => :not_found
     end
 
   end

data/lib/generators/templates/veritrans.yml

@@ -1,18 +1,18 @@
 development:
   # Register in sandbox veritrans and get your keys here:
-  # https://my.sandbox.veritrans.co.id/settings/config_info
+  # https://dashboard.sandbox.midtrans.com/settings/config_info
   client_key: ""
   server_key: ""
-  api_host: https://api.sandbox.veritrans.co.id
+  api_host: https://api.sandbox.midtrans.com
 
 production:
   # Register and get your keys here:
-  # https://my.veritrans.co.id/settings/config_info
+  # https://dashboard.midtrans.com/settings/config_info
   client_key: <%= ENV['VERITRANS_CLIENT_KEY'] %>
   server_key: <%= ENV['VERITRANS_SERVER_KEY'] %>
-  api_host: https://api.veritrans.co.id
+  api_host: https://api.midtrans.com
 
 staging:
   client_key: <%= ENV['VT_SANDBOX_CLIENT_KEY'] %>
   server_key: <%= ENV['VT_SANDBOX_SERVER_KEY'] %>
-  api_host: https://api.sandbox.veritrans.co.id
+  api_host: https://api.sandbox.midtrans.com

data/lib/generators/templates/views/_credit_card_form.erb

@@ -16,7 +16,7 @@
     <button onclick="$('#credit_card_number').val('4511 1111 1111 1117'); return false">challenge</button>
     <button onclick="$('#credit_card_number').val('4611 1111 1111 1116'); return false">Deny by FDS</button>
     <button onclick="$('#credit_card_number').val('4911 1111 1111 1113'); return false">Deny by bank</button>
-    <a href="http://docs.veritrans.co.id/sandbox/card_list.html" target="_blank">documentation</a>
+    <a href="https://docs.midtrans.com/en/reference/test.html" target="_blank">documentation</a>
   </p>
 
   <p>
@@ -26,7 +26,7 @@
 
   <p>
     <%= label_tag :credit_card_expire %>
-    <%= text_field_tag :credit_card_expire, '12 / 16', placeholder: "MM / YY", name: nil %>
+    <%= text_field_tag :credit_card_expire, '12 / 18', placeholder: "MM / YY", name: nil %>
   </p>
 
   <p>

data/lib/generators/templates/views/_veritrans_include.erb

@@ -1,4 +1,4 @@
-<%= javascript_include_tag "#{Veritrans.config.api_host}/v2/assets/veritrans.js" %>
+<%= javascript_include_tag "#{Veritrans.config.api_host}/v2/assets/js/midtrans.min.js" %>
 
 <script type="text/javascript">
   Veritrans.url = "<%= Veritrans.config.api_host %>/v2/token";

data/lib/generators/veritrans/install_generator.rb

@@ -1,5 +1,5 @@
 class Veritrans
-  class InstallGenerator < ::Rails::Generators::Base
+  class InstallGenerator < ::Rails::Generators::Base # :nodoc:
     source_root File.expand_path("../../templates", __FILE__)
 
 desc %{

data/lib/generators/veritrans/payment_form_generator.rb

@@ -1,5 +1,5 @@
 class Veritrans
-  class PaymentFormGenerator < ::Rails::Generators::Base
+  class PaymentFormGenerator < ::Rails::Generators::Base # :nodoc:
     source_root File.expand_path("../../templates", __FILE__)
 
 desc %{

data/lib/veritrans.rb

@@ -1,5 +1,4 @@
 require 'veritrans/version'
-require 'veritrans/core_extensions'
 require 'veritrans/config'
 require 'veritrans/client'
 require 'veritrans/api'
@@ -13,6 +12,11 @@ class Veritrans
   include Veritrans::Client
   include Veritrans::Api
 
+  autoload :Testing,    'veritrans/testing'
+  autoload :TestingLib, 'veritrans/testing'
+  autoload :CLI,        'veritrans/cli'
+  autoload :Events,     'veritrans/events'
+
   class << self
     extend Forwardable
 
@@ -20,11 +24,19 @@ class Veritrans
     def_delegators :instance, :request_with_logging, :basic_auth_header, :get, :post, :delete, :make_request
     def_delegators :instance, :charge, :cancel, :approve, :status, :capture, :expire
     def_delegators :instance, :create_vtlink, :delete_vtlink, :inquiry_points, :create_widget_token, :create_snap_token
+    def_delegators :instance, :checksum, :events
 
+    # Shortcut for Veritrans::Events
     def events
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn("`Veritrans.events` is deprecated.  Please use `Veritrans::Events`.")
+      else
+        warn "`Veritrans.events` is deprecated.  Please use `Veritrans::Events`."
+      end
       Veritrans::Events if defined?(Veritrans::Events)
     end
 
+    # More safe json parser
     def decode_notification_json(input)
       return Veritrans::Client._json_decode(input)
     end
@@ -35,6 +47,23 @@ class Veritrans
 
   end
 
+  def events
+    self.class.events
+  end
+
+  # If you want to use multiple instances of Midtrans in your code (e.g. process payments in different accounts),
+  # then you can create instance of Midtrans client
+  #
+  #   mt_client = Midtrans.new(
+  #     server_key: "My-Different-Key",
+  #     client_key: "...",
+  #     api_host: "https://api.sandbox.midtrans.com", # default
+  #     http_options: { }, # optional
+  #     logger: Logger.new(STDOUT), # optional
+  #     file_logger: Logger.new(STDOUT), # optional
+  #   )
+  #   mt_client.status("my-different-order-id")
+  #
   def initialize(options = nil)
     if options && options[:logger]
       self.logger = options.delete(:logger)
@@ -51,6 +80,22 @@ class Veritrans
     end
   end
 
+  # Midtrans configuration. Can be used as DSL and as object
+  #
+  # Use with block:
+  #
+  #   Midtrans.setup do
+  #     config.load_yml "./midtrans.yml", Rails.env # load values from config
+  #     # also can set one by one:
+  #     config.server_key = "..."
+  #     config.client_key = "..."
+  #     config.api_host = "https://api.sandbox.midtrans.com" # (default)
+  #   end
+  #
+  # Use as object:
+  # 
+  #   Midtrans.config.server_key
+  #
   def config(&block)
     if block
       instance_eval(&block)
@@ -58,12 +103,59 @@ class Veritrans
       @config ||= Veritrans::Config.new
     end
   end
-
   alias_method :setup, :config
 
-  # General logger
-  # for rails apps it's === Rails.logger
-  # for non-rails apps it's logging to stdout
+  # Calculate signature_key sha512 checksum for validating HTTP notifications
+  #
+  # Arguments:
+  # [params]  A hash, should contain <tt>:order_id, :status_code, :gross_amount</tt>.
+  #           Additional key <tt>:server_key</tt> is required if Midtrans.config.server_key is not set
+  #
+  # Example
+  #
+  #   Midtrans.checksum(order_id: "aa11", status_code: "200", gross_amount: 1000, server_key: "my-key")
+  #   # => "5e00499b23a8932e833238b2f65dd4dd3d10451708c7ec4d93da69e8e7a2bac4f7f97f9f35a986a7d100d7fc58034e12..."
+  #
+  # Raises:
+  # - <tt>ArgumentError</tt> when missing or invalid parameters
+  #
+  def checksum(params)
+    require 'digest' unless defined?(Digest)
+
+    params_sym = {}
+    params.each do |key, value|
+      params_sym[key.to_sym] = value
+    end
+
+    if (config.server_key.nil? || config.server_key == "") && params_sym[:server_key].nil?
+      raise ArgumentError, "Server key is required. Please set Veritrans.config.server_key or :server_key key"
+    end
+
+    required = [:order_id, :status_code, :gross_amount]
+    missing = required - params_sym.keys.select {|k| !!params_sym[k] }
+    if missing.size > 0
+      raise ArgumentError, "Missing required parameters: #{missing.map(&:inspect).join(", ")}"
+    end
+
+    if params_sym[:gross_amount].is_a?(Numeric)
+      params_sym[:gross_amount] = "%0.2f" % params_sym[:gross_amount]
+    elsif params_sym[:gross_amount].is_a?(String) && params_sym[:gross_amount] !~ /\d+\.\d\d$/
+      raise ArgumentError, %{gross_amount has invalid format, should be a number or string with cents e.g "52.00" (given: #{params_sym[:gross_amount].inspect})}
+    end
+
+    seed = "#{params_sym[:order_id]}#{params_sym[:status_code]}" +
+           "#{params_sym[:gross_amount]}#{params_sym[:server_key] || config.server_key}"
+
+    logger.debug("checksum source: #{seed}")
+
+    Digest::SHA2.new(512).hexdigest(seed)
+  end
+
+  # General Midtrans logger.
+  # For rails apps it will try to use <tt>Rails.logger</tt>, for non-rails apps -- it print to stdout
+  #
+  #  Midtrans.logger.info "Processing payment"
+  #
   def logger
     return @logger if @logger
     if defined?(Rails)
@@ -78,6 +170,10 @@ class Veritrans
     end
   end
 
+  # Set custom logger
+  #
+  #   Midtrans.logger = Logger.new("./log/midtrans.log")
+  #
   def logger=(value)
     @logger = value
   end
@@ -97,10 +193,15 @@ class Veritrans
     @file_logger
   end
 
+  # Set custom file_logger
+  #
+  #  Midtrans.file_logger = Logger.new("./log/midtrans.log")
+  #
   def file_logger=(value)
     @file_logger = value
   end
 
 end
 
+# Alias constant for new name of company
 Midtrans = Veritrans

data/lib/veritrans/api.rb

@@ -5,9 +5,8 @@ require 'uri'
 class Veritrans
   module Api
 
-    # POST /v2/charge { payment_type: "vtlink" }
-    # Docs http://docs.veritrans.co.id/vtdirect/integration_cc.html#step2
-    # Docs http://docs.veritrans.co.id/sandbox/charge.html
+    # POST /v2/charge { payment_type: "credit_card" }
+    # Docs https://api-docs.midtrans.com/#charge-features
     #
     # Example:
     # Veritrans.charge(
@@ -55,7 +54,7 @@ class Veritrans
     alias_method :create_widget_token, :create_snap_token
 
     # POST /v2/{id}/cancel
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Cancel
+    # Docs https://api-docs.midtrans.com/#cancel-transaction
     def cancel(payment_id, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
@@ -65,7 +64,7 @@ class Veritrans
     end
 
     # POST /v2/{id}/approve
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Approve
+    # Docs https://api-docs.midtrans.com/#approve-transaction
     def approve(payment_id, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
@@ -75,7 +74,7 @@ class Veritrans
     end
 
     # GET /v2/{id}/status
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Status
+    # Docs https://api-docs.midtrans.com/#get-status-transaction
     def status(payment_id)
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
@@ -85,7 +84,7 @@ class Veritrans
     end
 
     # POST /v2/capture
-    # Docs http://docs.veritrans.co.id/en/api/methods.html#Capture
+    # Docs https://api-docs.midtrans.com/#capture-transaction
     def capture(payment_id, gross_amount, options = {})
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
@@ -95,6 +94,7 @@ class Veritrans
     end
 
     # POST /v2/{id}/expire
+    # Docs https://api-docs.midtrans.com/#expire-transaction
     def expire(payment_id)
       if !payment_id || payment_id.to_s == ""
         raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"

data/lib/veritrans/cli.rb

@@ -3,10 +3,10 @@ require 'securerandom'
 require 'logger'
 
 class Veritrans
-  module CLI
+  module CLI #:nodoc:
     # can't find order
-    class OrderNotFound < Exception; end
-    class AuthenticationError < Exception; end
+    class OrderNotFound < Exception; end  # :nodoc:
+    class AuthenticationError < Exception; end  # :nodoc:
 
     extend self
 
@@ -119,8 +119,8 @@ class Veritrans
       if CONFIG[:order]
         load_local_config!
         order_info = get_order_info(CONFIG[:order])
-        order_data = order_info.data.except(:status_message, :signature_key)
-        data = data.except(:fraud_status, :masked_card).merge(order_data)
+        order_data = hash_except(order_info.data, :status_message, :signature_key)
+        data = hash_except(data, :fraud_status, :masked_card).merge(order_data)
       end
 
       JSON.pretty_generate(data)
@@ -151,5 +151,11 @@ class Veritrans
     end
     def cyan(str); colorize(str, 36) end
 
+    def hash_except(hash, *except_keys)
+      copy = hash.dup
+      except_keys.each { |key| copy.delete(key) }
+      copy
+    end
+
   end
 end

data/lib/veritrans/client.rb

@@ -7,7 +7,8 @@ require 'excon'
 class Veritrans
   module Client
 
-    # Failback for activesupport
+    # If you using Rails then it will call ActiveSupport::JSON.encode
+    # Otherwise JSON.pretty_generate
     def self._json_encode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.encode(params)
@@ -21,6 +22,8 @@ class Veritrans
       Veritrans::Client._json_encode(params)
     end
 
+    # If you using Rails then it will call ActiveSupport::JSON.decode
+    # Otherwise JSON.parse
     def self._json_decode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.decode(params)
@@ -78,7 +81,7 @@ class Veritrans
       default_options = config.http_options || {}
 
       # Add authentication and content type
-      # Docs http://docs.veritrans.co.id/sandbox/introduction.html
+      # Docs https://api-docs.midtrans.com/#http-s-header
       request_options = {
         :path => URI.parse(url).path,
         :headers => {
@@ -99,7 +102,7 @@ class Veritrans
         read_timeout: 120,
         write_timeout: 120,
         connect_timeout: 120
-      }.deep_merge(default_options)
+      }.merge(default_options)
 
       s_time = Time.now
       request = Excon.new(url, connection_options)
@@ -111,7 +114,7 @@ class Veritrans
       Result.new(response, url, request_options, Time.now - s_time)
 
     rescue Excon::Errors::SocketError => error
-      logger.info "Veritrans: socket error, can not connect"
+      logger.info "Veritrans: socket error, can not connect (#{error.message})"
       error_response = Excon::Response.new(
         body: '{"status_code": "500", "status_message": "Internal server error, no response from backend. Try again later"}',
         status: '500'

data/lib/veritrans/config.rb

@@ -7,7 +7,7 @@ class Veritrans
   class Config
 
     def initialize(options = nil)
-      @api_host = "https://api.sandbox.veritrans.co.id"
+      @api_host = "https://api.sandbox.midtrans.com"
       apply(options) if options
     end
 
@@ -41,9 +41,9 @@ class Veritrans
     ##
     # API Server hostname, this allow to switch between production and sandbox
     #
-    # Should be "https://api.sandbox.veritrans.co.id" or "https://api.veritrans.co.id"
+    # Should be "https://api.sandbox.midtrans.com" or "https://api.midtrans.com"
     #
-    # Default is "https://api.sandbox.veritrans.co.id"
+    # Default is "https://api.sandbox.midtrans.com"
     #
     def api_host=(value)
       @api_host = value
@@ -93,6 +93,8 @@ class Veritrans
     #
     #   Veritrans.setup do
     #     config.load_yml "#{Rails.root.to_s}/config/veritrans.yml#development"
+    #     # or
+    #     config.load_yml "#{Rails.root.to_s}/config/veritrans.yml", :development
     #   end
     #
     def load_config(filename, yml_section = nil)

data/lib/veritrans/events.rb

@@ -1,41 +1,45 @@
-# Rack based event notification callback processor
-#
-# Usage:
-#
-#     Rails.application.routes.draw do
-#       ...
-#       mount Veritrans::Events.new => '/vt_events'
-#     end
-#     
-#     Veritrans.events.subscribe('payment.success') do |payment|
-#       payment.mark_paid!(payment.masked_card)
-#     end
-#
-
-# All possible events:
-#
-# * payment.success     == ['authorize', 'capture', 'settlement']
-# * payment.failed      == ['deny', 'cancel', 'expire']
-# * payment.challenge   # when payment.fraud_status == 'challenge'
-#
-# * payment.authorize
-# * payment.capture
-# * payment.settlement
-# * payment.deny
-# * payment.cancel
-# * payment.expire
-#
-# * error
-
-# For sinatra you can use Rack::URLMap
-#
-#     run Rack::URLMap.new("/" => MyApp.new, "/payment_events" => Veritrans::Events.new)
-#
-
 class Veritrans
+  #
+  # Rack based event notification callback processor
+  #
+  # Usage:
+  #
+  #   Rails.application.routes.draw do
+  #     # ...
+  #     mount Veritrans::Events.new => '/vt_events'
+  #   end
+  #   
+  #   Veritrans::Events.subscribe('payment.success') do |payment|
+  #     payment.mark_paid!(payment.masked_card)
+  #   end
+  #
+  #
+  # All possible events:
+  #
+  # * payment.success     == ['authorize', 'capture', 'settlement']
+  # * payment.failed      == ['deny', 'cancel', 'expire']
+  # * payment.challenge   # when payment.fraud_status == 'challenge'
+  #
+  # * payment.authorize
+  # * payment.capture
+  # * payment.settlement
+  # * payment.deny
+  # * payment.cancel
+  # * payment.expire
+  #
+  # * error
+  #
+  # For sinatra you can use Rack::URLMap
+  #
+  #     run Rack::URLMap.new("/" => MyApp.new, "/payment_events" => Veritrans::Events.new)
+  #
   class Events
 
     # This is rack application
+    # Can be used as:
+    #
+    #   use Veritrans::Events.new
+    #
     def call(env)
       Veritrans.logger.info "Receive notification callback"
 
@@ -92,7 +96,7 @@ class Veritrans
       return send_text("Server error:\n#{error.message}", 500)
     end
 
-    def send_text(body, status = 200)
+    def send_text(body, status = 200) # :nodoc:
       [status, {"Content-Type" => "text/html"}, [body]]
     end
 
@@ -101,6 +105,12 @@ class Veritrans
     class << self
       attr_accessor :listeners
 
+      # Subscribe for events. The event object will be an instance of Midtrans::Result
+      #
+      #   Midtrans::Events.subscribe('payment.success') do |payment_status|
+      #     Order.find_by(order_id: payment_status.order_id).mark_paid!
+      #   end
+      #
       def subscribe(*event_types, &handler)
         @listeners ||= []
         event_types.each do |event_type|
@@ -108,6 +118,7 @@ class Veritrans
         end
       end
 
+      # Used internally to dispatch event
       def dispatch(new_event, event_data)
         @listeners.each do |pair|
           event_type, handler = *pair