veritrans 2.1.2 → 2.4.0

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

data/lib/veritrans/midtrans_error.rb

@@ -0,0 +1,15 @@
+class MidtransError < StandardError
+  attr_reader :status
+  alias_method :http_status_code, :status
+  attr_reader :data
+  alias_method :api_response, :data
+  attr_reader :response
+  alias_method :raw_http_client_data, :response
+
+  def initialize(message, http_status_code = nil, api_response = nil, raw_http_client_data = nil)
+    super(message)
+    @status = http_status_code
+    @data = api_response
+    @response = raw_http_client_data
+  end
+end

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,17 +128,36 @@ 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
-      @data[: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
+
+    # Acccessor for <tt>redirect_url</tt> value
+    def redirect_url
+      @data[:redirect_url]
     end
 
     def success?
-      status_code == 200
+      status_code == 201
     end
   end
-end
+end

data/lib/veritrans/version.rb

@@ -1,3 +1,3 @@
 class Veritrans
-  VERSION = "2.1.2"
+  VERSION = "2.4.0"
 end

data/lib/veritrans.rb

@@ -1,9 +1,9 @@
 require 'veritrans/version'
-require 'veritrans/core_extensions'
 require 'veritrans/config'
 require 'veritrans/client'
 require 'veritrans/api'
 require 'veritrans/result'
+require 'veritrans/midtrans_error'
 
 if defined?(::Rails)
   require 'veritrans/events'
@@ -13,18 +13,29 @@ class Veritrans
   include Veritrans::Client
   include Veritrans::Api
 
+  autoload :Events,     'veritrans/events'
+
   class << self
     extend Forwardable
 
     def_delegators :instance, :logger, :logger=, :config, :setup, :file_logger, :file_logger=
-    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, :request_with_logging, :basic_auth_header, :get, :post, :delete, :make_request, :patch
+    def_delegators :instance, :charge, :cancel, :approve, :status, :capture, :expire, :refund, :deny
+    def_delegators :instance, :create_vtlink, :delete_vtlink, :inquiry_points, :create_widget_token, :create_snap_redirect_url, :create_snap_token, :create_snap_token_string, :create_snap_redirect_url_str, :test_token, :create_card_token
+    def_delegators :instance, :link_payment_account, :get_payment_account, :unlink_payment_account, :create_subscription, :get_subscription, :disable_subscription, :enable_subscription, :update_subscription
+    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 +46,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 +79,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 +102,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 +169,10 @@ class Veritrans
     end
   end
 
+  # Set custom logger
+  #
+  #   Midtrans.logger = Logger.new("./log/midtrans.log")
+  #
   def logger=(value)
     @logger = value
   end
@@ -86,10 +181,19 @@ class Veritrans
   # For rails apps it will write log to RAILS_ROOT/log/veritrans.log
   def file_logger
     if !@file_logger
-      if defined?(Rails) && Rails.root
-        @file_logger = Logger.new(Rails.root.join("log/veritrans.log").to_s)
-      else
-        require 'logger'
+      require 'logger'
+      begin
+        if defined?(Rails) && Rails.root
+          require 'fileutils'
+          FileUtils.mkdir_p(Rails.root.join("log"))
+          @file_logger = Logger.new(Rails.root.join("log/veritrans.log").to_s)
+        else
+          @file_logger = Logger.new("/dev/null")
+        end
+      rescue => error
+        STDERR.puts "Failed to create Midtrans.file_logger, will use /dev/null"
+        STDERR.puts "#{error.class}: #{error.message}"
+        STDERR.puts error.backtrace
         @file_logger = Logger.new("/dev/null")
       end
     end
@@ -97,10 +201,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/veritrans.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.version    = Veritrans::VERSION
   s.author     = ["Veritrans Dev Team"]
   s.description= "Veritrans ruby client"
-  s.email      = ["dev@veritrans.co.id"]
+  s.email      = ["pavel.evstigneev@midtrans.com"]
   s.homepage   = "https://github.com/veritrans/veritrans-ruby"
   s.summary    = %q{Veritrans ruby library}
   s.license    = 'MIT'
@@ -14,15 +14,8 @@ Gem::Specification.new do |s|
   s.files      = `git ls-files`.split("\n")
   s.test_files = []
 
-  s.require_paths = ["lib"] 
-  s.executables   = ["veritrans", "midtrans"]
+  s.require_paths = ["lib"]
 
   s.add_runtime_dependency "excon", "~> 0.20"
-
-  s.add_development_dependency "rspec", '~> 3.4'
-  s.add_development_dependency "rails", ">= 4.0", "< 6"
-  s.add_development_dependency 'webmock', '>= 1.20'
-  s.add_development_dependency 'vcr', '~> 3.0'
-  s.add_development_dependency "poltergeist", '~> 1.8'
 end