RubyGems - veritrans - Versions diffs - 2.0.4 → 2.1.0 - Mend

veritrans 2.0.4 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

checksums.yaml +4 -4
data/.gitignore +2 -1
data/.travis.yml +11 -3
data/CHANGELOG.md +15 -0
data/Gemfile +10 -0
data/Gemfile.lock +136 -97
data/Procfile +1 -0
data/README.md +12 -5
data/Rakefile +7 -5
data/api_reference.md +21 -1
data/example/README.md +8 -0
data/example/config.ru +6 -0
data/example/index.erb +104 -9
data/example/localization.erb +248 -0
data/example/points.erb +187 -0
data/example/recurring.erb +201 -0
data/example/response.erb +10 -1
data/example/sinatra.rb +120 -8
data/example/style.css +83 -2
data/example/veritrans.yml +0 -1
data/example/widget.erb +52 -0
data/lib/generators/templates/assets/credit_card_form.js +3 -2
data/lib/generators/templates/payments_controller.rb +5 -0
data/lib/generators/templates/veritrans.rb +20 -17
data/lib/generators/veritrans/install_generator.rb +1 -1
data/lib/generators/veritrans/payment_form_generator.rb +1 -1
data/lib/veritrans.rb +73 -44
data/lib/veritrans/api.rb +39 -5
data/lib/veritrans/cli.rb +1 -1
data/lib/veritrans/client.rb +15 -10
data/lib/veritrans/config.rb +11 -4
data/lib/veritrans/events.rb +4 -4
data/lib/veritrans/result.rb +28 -7
data/lib/veritrans/version.rb +2 -2
data/spec/cli_spec.rb +1 -0
data/spec/rails_plugin_spec.rb +72 -27
data/spec/spec_helper.rb +1 -0
data/spec/veritrans_client_spec.rb +57 -3
data/spec/veritrans_config_spec.rb +1 -1
data/spec/veritrans_events_spec.rb +2 -0
data/spec/veritrans_snap_spec.rb +39 -0
data/testing_webhooks.md +0 -2
data/veritrans.gemspec +5 -5
metadata +29 -15

data/example/veritrans.yml CHANGED

@@ -4,7 +4,6 @@ development:
   client_key: VT-client-NArmatJZqzsmTmzR
   server_key: VT-server-9Htb-RxXkg7-7hznSCCjxvoY
-  # api_host: http://papi.vt-stage.info:8080
   # For production use
   # api_host: https://api.veritrans.co.id

data/example/widget.erb ADDED

@@ -0,0 +1,52 @@
+<!doctype html>
+<html>
+<head>
+  <title>veritrans-ruby demo</title>
+  <link rel="icon" type="image/x-icon" href="https://account.veritrans.co.id/favicon.ico" />
+  <link rel="stylesheet" href="/style.css">
+</head>
+<body>
+<header>
+  <h3>
+    <a href="/">Veritrans sinatra app</a>
+  </h3>
+</header>
+<section>
+  <h4>Veritrans Widget</h4>
+  <section>
+    <p>
+      <label>Token ID</label>
+      <input type="text" id="token_id" value="<%= @token_id %>" readonly>
+    </p>
+    <button id="snap_pay">Pay Now</button>
+  </section>
+</section>
+<script src="https://app.sandbox.veritrans.co.id/snap/snap.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
+<script type="text/javascript">
+$('#snap_pay').on('click', function (e) {
+  e.preventDefault();
+  snap.pay($('#token_id').val() + "?locale=en", {
+    env: 'sandbox',
+    onSuccess: function (res) {
+      console.log('onSuccess', res);
+      alert(res.status_message + "\nRedirecting to confirm page...");
+      window.location = "/widget/confirm/" + res.transaction_id;
+    },
+    onPending: function (res) {
+      console.log('onPending', res);
+    },
+    onError: function (res) {
+      console.log('onError', res);
+    }
+  });
+});
+</script>
+</body>
+</html>

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

@@ -25,8 +25,9 @@ $(document).ready(function () {
     button.val("Processing ...");
     Veritrans.token(VT_createTokenData, function (data) {
-      // console.log('Get token response:');
-      // console.log(data);
+      //console.log('Get token response:');
+      //console.log(JSON.stringify(VT_createTokenData()));
+      //console.log(JSON.stringify(data));
       // if we get redirect_url then it's 3d-secure transaction
       // so we need to open that page

data/lib/generators/templates/payments_controller.rb CHANGED

@@ -5,6 +5,7 @@ class PaymentsController < ApplicationController
     @payment = make_payment
   end
+  # Creating example payment
   def create
     @payment = make_payment
@@ -30,6 +31,9 @@ class PaymentsController < ApplicationController
     )
   end
+  # Processing HTTP Notification from Veritrans
+  # POST request with JSON-encoded body
+  # If you using Veritrans::Events then you don't need this
   def receive_webhook
     post_body = request.body.read
@@ -61,6 +65,7 @@ class PaymentsController < ApplicationController
   end
+  # You should replace this with your own model
   private
   def make_payment
     @paymentKlass = Struct.new("Payment", :amount, :token_id, :order_id, :credit_card_secure) do

data/lib/generators/templates/veritrans.rb CHANGED

@@ -8,35 +8,38 @@ Veritrans.setup do
   # Veritrans::Events is rack application to handle http notifications from Veritrans
   # To enable it, add in config/routes.rb
-  # mount Veritrans::Events.new => '/vt_events'
+  #
+  #   mount Veritrans::Events.new => '/vt_events'
+  #
   # All possible events:
   #
-  # * payment.success     == ['authorize', 'capture', 'settlement']
-  # * payment.failed      == ['deny', 'canel', 'expire']
-  # * payment.challenge   # when payment.froud_status == 'challenge'
+  # '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.canel
-  # * payment.expire
+  # 'payment.authorize'
+  # 'payment.capture'
+  # 'payment.settlement'
+  # 'payment.deny'
+  # 'payment.cancel'
+  # 'payment.expire'
   # events.subscribe 'payment.success' do |payment|
-  #   payment.mark_paid!
+  #   payment is instance of Veritrans::Result
+  #   puts "Payment #{payment.data[:order_id]} is successful"
   # end
-  #
+  #
   # events.subscribe 'payment.failed' do |payment|
-  #   payment.mark_failed!
+  #   puts "Payment #{payment.data[:order_id]} is failed"
   # end
-  #
+  #
   # events.subscribe 'payment.challenge' do |payment|
+  #   puts "Payment #{payment.data[:order_id]} chellenged by fraud system"
   #   payment.mark_challenge!
   # end
-  #
+  #
   # events.subscribe /.+/ do |payment, event_name|
-  #   p "Event: #{event_name}"
+  #   puts "Payment #{payment.data[:order_id]} has status #{payment.data[:transaction_status]}"
   #   p payment
   # end

data/lib/generators/veritrans/install_generator.rb CHANGED

@@ -1,4 +1,4 @@
-module Veritrans
+class Veritrans
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path("../../templates", __FILE__)

data/lib/generators/veritrans/payment_form_generator.rb CHANGED

@@ -1,4 +1,4 @@
-module Veritrans
+class Veritrans
   class PaymentFormGenerator < ::Rails::Generators::Base
     source_root File.expand_path("../../templates", __FILE__)

data/lib/veritrans.rb CHANGED

@@ -9,67 +9,96 @@ if defined?(::Rails)
   require 'veritrans/events'
 end
-module Veritrans
-  extend Veritrans::Client
-  extend Veritrans::Api
+class Veritrans
+  include Veritrans::Client
+  include Veritrans::Api
   class << self
-    def config(&block)
-      if block
-        instance_eval(&block)
-      else
-        Veritrans::Config
-      end
+    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 events
+      Veritrans::Events if defined?(Veritrans::Events)
     end
-    alias_method :setup, :config
+    def decode_notification_json(input)
+      return Veritrans::Client._json_decode(input)
+    end
-    # General logger
-    # for rails apps it's === Rails.logger
-    # for non-rails apps it's logging to stdout
-    def logger
-      return @logger if @logger
-      if defined?(Rails)
-        Rails.logger
-      else
-        unless @log
-          require 'logger'
-          @log = Logger.new(STDOUT)
-          @log.level = Logger::INFO
-        end
-        @log
-      end
+    def instance
+      @instance ||= new
     end
-    def logger=(value)
-      @logger = value
+  end
+  def initialize(options = nil)
+    if options && options[:logger]
+      self.logger = options.delete(:logger)
+      options.delete("logger")
     end
-    # Logger to file, only important information
-    # 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
-          @file_logger = Logger.new("/dev/null")
-        end
-      end
+    if options && options[:file_logger]
+      self.file_logger = options.delete(:file_logger)
+      options.delete("file_logger")
+    end
-      @file_logger
+    if options
+      @config = Veritrans::Config.new(options)
     end
+  end
-    def file_logger=(value)
-      @file_logger = value
+  def config(&block)
+    if block
+      instance_eval(&block)
+    else
+      @config ||= Veritrans::Config.new
     end
+  end
-    def events
-      Veritrans::Events if defined?(Veritrans::Events)
+  alias_method :setup, :config
+  # General logger
+  # for rails apps it's === Rails.logger
+  # for non-rails apps it's logging to stdout
+  def logger
+    return @logger if @logger
+    if defined?(Rails)
+      Rails.logger
+    else
+      unless @log
+        require 'logger'
+        @log = Logger.new(STDOUT)
+        @log.level = Logger::INFO
+      end
+      @log
     end
+  end
-    def decode_notification_json(input)
-      return Veritrans::Client._json_decode(input)
+  def logger=(value)
+    @logger = value
+  end
+  # Logger to file, only important information
+  # 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'
+        @file_logger = Logger.new("/dev/null")
+      end
     end
+    @file_logger
   end
+  def file_logger=(value)
+    @file_logger = value
+  end
 end

data/lib/veritrans/api.rb CHANGED

@@ -2,7 +2,7 @@
 require 'uri'
-module Veritrans
+class Veritrans
   module Api
     # POST /v2/charge { payment_type: "vtlink" }
@@ -46,23 +46,39 @@ module Veritrans
       request_with_logging(:post, config.api_host + "/v2/charge", data)
     end
+    # POST https://app.sandbox.veritrans.co.id/snap/v1/charge
+    def create_snap_token(options = {})
+      result = request_with_logging(:post, config.api_host.sub('//api.', '//app.') + "/snap/v1/charge", options)
+      Veritrans::SnapResult.new(result.response, result.url, result.request_options, result.time)
+    end
+    alias_method :create_widget_token, :create_snap_token
     # POST /v2/{id}/cancel
     # Docs http://docs.veritrans.co.id/en/api/methods.html#Cancel
     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})"
+      end
       request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/cancel", options)
     end
     # POST /v2/{id}/approve
     # Docs http://docs.veritrans.co.id/en/api/methods.html#Approve
     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})"
+      end
       request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/approve", options)
     end
     # GET /v2/{id}/status
     # Docs http://docs.veritrans.co.id/en/api/methods.html#Status
     def status(payment_id)
-      if !payment_id || payment_id == ""
-        raise ArgumentError, "parameter payment_id can not be bank"
+      if !payment_id || payment_id.to_s == ""
+        raise ArgumentError, "parameter payment_id can not be blank (got #{payment_id.class} : #{payment_id.inspect})"
       end
       get(config.api_host + "/v2/#{URI.escape(payment_id)}/status")
@@ -71,12 +87,20 @@ module Veritrans
     # POST /v2/capture
     # Docs http://docs.veritrans.co.id/en/api/methods.html#Capture
     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})"
+      end
       post(config.api_host + "/v2/capture", options.merge(transaction_id: payment_id, gross_amount: gross_amount))
     end
     # POST /v2/{id}/expire
-    def expire(id)
-      request_with_logging(:post, config.api_host + "/v2/#{URI.escape(id)}/expire", nil)
+    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})"
+      end
+      request_with_logging(:post, config.api_host + "/v2/#{URI.escape(payment_id)}/expire", nil)
     end
     # POST /v2/charge { payment_type: "vtlink" }
@@ -91,5 +115,15 @@ module Veritrans
       request_with_logging(:delete, config.api_host + "/v2/vtlink/#{URI.escape(id)}", options)
     end
+    # GET /v2/point_inquiry/{token_id}
+    def inquiry_points(token_id)
+      if token_id == nil || token_id.to_s == ""
+        raise ArgumentError, "parameter token_id can not be bank"
+      end
+      request_with_logging(:get, config.api_host + "/v2/point_inquiry/#{token_id}", {})
+    end
+    alias_method :point_inquiry, :inquiry_points
   end
 end

data/lib/veritrans/cli.rb CHANGED

@@ -2,7 +2,7 @@ require 'json'
 require 'securerandom'
 require 'logger'
-module Veritrans
+class Veritrans
   module CLI
     # can't find order
     class OrderNotFound < Exception; end

data/lib/veritrans/client.rb CHANGED

@@ -4,21 +4,24 @@ require "base64"
 require 'uri'
 require 'excon'
-module Veritrans
+class Veritrans
   module Client
-    extend self
     # Failback for activesupport
-    def _json_encode(params)
+    def self._json_encode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.encode(params)
       else
         require 'json' unless defined?(JSON)
-        JSON.generate(params)
+        JSON.pretty_generate(params)
       end
     end
-    def _json_decode(params)
+    def _json_encode(params)
+      Veritrans::Client._json_encode(params)
+    end
+    def self._json_decode(params)
       if defined?(ActiveSupport) && defined?(ActiveSupport::JSON)
         ActiveSupport::JSON.decode(params)
       else
@@ -69,6 +72,8 @@ module Veritrans
       method = method.to_s.upcase
       logger.info "Veritrans: #{method} #{url} #{_json_encode(params)}"
+      logger.info "Veritrans: Using server key: #{config.server_key}"
+      #puts "Veritrans: #{method} #{url} #{_json_encode(params)}"
       default_options = config.http_options || {}
@@ -91,9 +96,9 @@ module Veritrans
       end
       connection_options = {
-        read_timeout: 40,
-        write_timeout: 40,
-        connect_timeout: 40
+        read_timeout: 120,
+        write_timeout: 120,
+        connect_timeout: 120
       }.deep_merge(default_options)
       s_time = Time.now
@@ -106,12 +111,12 @@ module Veritrans
       Result.new(response, url, request_options, Time.now - s_time)
     rescue Excon::Errors::SocketError => error
-      logger.info "PAPI: socket error, can not connect"
+      logger.info "Veritrans: socket error, can not connect"
       error_response = Excon::Response.new(
         body: '{"status_code": "500", "status_message": "Internal server error, no response from backend. Try again later"}',
         status: '500'
       )
-      Veritrans::Result.new(error_response, url, options, Time.now - s_time)
+      Veritrans::Result.new(error_response, url, request_options, Time.now - s_time)
     end
   end