veritrans 1.2.6 → 2.0.0beta

data/lib/veritrans/config.rb

@@ -1,74 +1,60 @@
-require "yaml"
+require 'yaml'
 
-# :nodoc:
 module Veritrans
 
-  # hold constants configuration define in server merchant
   module Config
+    extend self
 
-    # server Veritrans - defined in gem - no change!
-    SERVER_HOST = "https://vtweb.veritrans.co.id"
-
-    # Request Key Url - use in #get_keys - defined in gem - no change!
-    REQUEST_KEY_URL      = "/web1/commodityRegist.action"
-
-    # Request Key Url - use in #get_keys - defined in gem - no change!
-    TOKENS_URL            = "/vtdirect/v1/tokens"
-
-    # Charges Url - use in #get_keys - defined in gem - no change!
-    CHARGES_URL          = "/vtdirect/v1/charges"
-
-    # Void Url - use in #get_keys - defined in gem - no change!
-    VOID_URL             = "/vtdirect/v1/void"
-
-    # Payment Redirect Url - defined in gem - no change!
-    PAYMENT_REDIRECT_URL = "/web1/deviceCheck.action"
-
-    # CA_PATH
-    # CA_PATH = "/usr/lib/ssl/certs"
-    
-    # :nodoc:
-    CUSTOMER_SPECIFICATION_FLAG = '0' #Billing same as shipping address '1' Different, manually input in Veritrans-web
-
-    # Default Settlement method:
-    SETTLEMENT_TYPE_CARD = "01" #Paymanet Type
-    
-    # Flag: Sales and Sales Credit, 0: only 1 credit. If not specified, 0
-    CARD_CAPTURE_FLAG = "1"
-
-    def Config.included(mod)
-      class <<self
-        template = {
-          'merchant_id' => nil,
-          'merchant_hash_key' => nil,
-          'finish_payment_return_url' => nil,
-          'unfinish_payment_return_url' => nil,
-          'error_payment_return_url' => nil,
-          'server_key' => nil,
-          'server_host' => nil,
-          'charges_url' => nil,
-          'token_url' => nil
-        }
-        @@config_env = ::Object.const_defined?(:Rails) ? Rails.env : "development"
-        @@config = File.exists?("./config/veritrans.yml") ? YAML.load_file("./config/veritrans.yml") : {}
-        @@config['development'] = {} if !@@config['development']
-        @@config['production' ] = {} if !@@config['production']
-        @@config['development'] = template.clone.merge(@@config['development'])
-        @@config['production']  = template.clone.merge(@@config['production'])
-        #@@config['production' ].merge!(template)
-      end
+    @api_host = "https://api.sandbox.veritrans.co.id"
+
+    def client_key
+      @client_key
+    end
+
+    def client_key=(value)
+      @client_key = value
+    end
+
+    def server_key
+      @server_key
+    end
+
+    def server_key=(value)
+      @server_key = value
+    end
+
+    def api_host
+      @api_host
+    end
+
+    def api_host=(value)
+      @api_host = value
+    end
 
-      mod.instance_eval <<CODE
+    def load_config(filename)
+      yml_file, yml_section = filename.to_s.split('#')
+      config_data = YAML.load(File.read(yml_file))
 
-      def self.config_env=(env)
-        @@config_env = env
+      if defined?(Rails) && !yml_section
+        yml_section = Rails.env.to_s
       end
 
-      def self.config
-        @@config[@@config_env]
-      end 
-CODE
+      apply(yml_section ? config_data[yml_section] : config_data)
+    end
+
+    alias :load_yml :load_config
 
+    def inspect
+      "<Veritrans::Config @api_host=#{@api_host.inspect} @server_key=#{@server_key.inspect} @client_key=#{@client_key.inspect}>"
+    end
+
+    private
+
+    def apply(hash)
+      hash.each do |key, value|
+        send(:"#{key}=", value)
+      end
     end
   end
-end
+
+end

data/lib/veritrans/events.rb

@@ -0,0 +1,125 @@
+# 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', 'canel', 'expire']
+# * payment.challenge   # when payment.froud_status == 'challenge'
+#
+# * payment.authorize
+# * payment.capture
+# * payment.settlement
+# * payment.deny
+# * payment.canel
+# * payment.expire
+#
+# * error
+
+# For sinatra you can use Rack::URLMap
+#
+#     run Rack::URLMap.new("/" => MyApp.new, "/payment_events" => Veritrans::Events.new)
+#
+
+module Veritrans
+  class Events
+
+    # This is rack application
+    def call(env)
+      Veritrans.logger.info "Receive notification callback"
+
+      post_body = env["rack.input"].read
+      env["rack.input"].rewind
+      request_data = Veritrans.decode_notification_json(post_body)
+
+      Veritrans.file_logger.info("Callback for order: " +
+        "#{request_data['order_id']} #{request_data['transaction_status']}\n" +
+        post_body + "\n"
+      )
+
+      verified_data = Veritrans.status(request_data['transaction_id'])
+
+      if verified_data.status_code != 404
+        #puts "--- Transaction callback ---"
+        #puts "Payment:        #{verified_data.data[:order_id]}"
+        #puts "Payment type:   #{verified_data.data[:payment_type]}"
+        #puts "Payment status: #{verified_data.data[:transaction_status]}"
+        #puts "Fraud status:   #{verified_data.data[:fraud_status]}" if verified_data.data[:fraud_status]
+        #puts "Payment amount: #{verified_data.data[:gross_amount]}"
+        #puts "--- Transaction callback ---"
+
+        event_name = verified_data.data[:transaction_status]
+        if verified_data.data[:fraud_status] == 'challenge'
+          event_name = 'challenge'
+        end
+
+        Veritrans::Events.dispatch("payment.#{event_name}", verified_data)
+
+        if %w{capture authorize settlement}.include?(event_name)
+          Veritrans::Events.dispatch("payment.success", verified_data)
+        elsif event_name != 'challenge'
+          Veritrans::Events.dispatch("payment.failed", verified_data)
+        end
+
+        return send_text("ok", 200)
+      else
+        Veritrans::Events.dispatch("error", request_data)
+        Veritrans.file_logger.info("Callback verification failed:" +
+          "#{request_data['order_id']} #{request_data['transaction_status']}}\n" +
+          verified_data.body + "\n"
+        )
+        return send_text("Can not verify payment via Payment API: #{verified_data.status_message}", 404)
+      end
+
+    rescue Object => error
+      Veritrans.file_logger.info("Callback proccesing failed. \n" +
+        "RAW_POST_DATA: #{env["rack.input"].read}\n" +
+        error.message +
+        error.backtrace.join("\n") + "\n"
+      )
+      Veritrans::Events.dispatch("error", verified_data || request_data || post_body)
+      return send_text("Server error:\n#{error.message}", 500)
+    end
+
+    def send_text(body, status = 200)
+      [status, {"Content-Type" => "text/html"}, [body]]
+    end
+
+    # processing events
+
+    class << self
+      attr_accessor :listeners
+
+      def subscribe(*event_types, &handler)
+        @listeners ||= []
+        event_types.each do |event_type|
+          @listeners << [event_type, handler]
+        end
+      end
+
+      def dispatch(new_event, event_data)
+        @listeners.each do |pair|
+          event_type, handler = *pair
+
+          if event_type.is_a?(String) && event_type == new_event
+            handler.call(event_data)
+          elsif event_type.is_a?(Regexp) && event_type =~ new_event
+            handler.call(event_data, new_event)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/veritrans/result.rb

@@ -0,0 +1,81 @@
+module Veritrans
+  class Result
+    attr_reader :data
+    attr_reader :status
+    attr_reader :response
+
+    def initialize(response, url, options, time)
+      begin
+        if url =~ %r{/v2/.+/transcript$}
+          @data = {}
+        else
+          @data = Veritrans._json_decode(response.body)
+
+          # Failback for Hash#symbolize_keys
+          @data.keys.each do |key|
+            @data[(key.to_sym rescue key) || key] = @data.delete(key)
+          end
+        end
+
+      rescue => e
+        Veritrans.logger.info "Error parsing papi response #{e.message}"
+        Veritrans.logger.info e.backtrace.join("\n")
+        @data = {}
+      end
+
+      @time = time
+      @status = response.status
+      @response = response
+      @url = url
+      @options = options
+    end
+
+    def success?
+      @data[:status_code] == '200' || @data[:status_code] == '201'
+    end
+
+    # for VT-Link
+    def created?
+      @data[:status_code] == '201'
+    end
+
+    # Docs http://docs.veritrans.co.id/sandbox/status_code.html
+    def status_code
+      @data[:status_code].to_i
+    end
+
+    def status_message
+      @data[:status_message]
+    end
+
+    def redirect_url
+      @data[:redirect_url]
+    end
+
+    def messages
+      if @data[:message].present?
+        @data[:message].chomp(']').sub(/^\[/, '').split(',').map(&:strip)
+      else
+        []
+      end
+    end
+
+    def body
+      response.body
+    end
+
+    def method_missing(method_name, *args)
+      if args.size == 0 && @data && @data.has_key?(method_name)
+        return @data[method_name]
+      else
+        super
+      end
+    end
+
+    def inspect
+      time_ms = (@time * 1000).round
+      data = @data.inspect.gsub(/:([^\s]+)=>/, "\\1: ")
+      "#<Veritrans::Result:#{object_id} ^^ http_status: #{@status} time: #{time_ms}ms ^^ data: #{data}>"
+    end
+  end
+end

data/lib/veritrans/version.rb

@@ -1,43 +1,3 @@
-# :nodoc:
 module Veritrans
-	# hold version number of this library
-	# it use class methods to generate it 
-	#
-  # Example:
-  #
-	#   Veritrans::Version.to_s
-	class Version
-
-		class <<self
-
-	    private
-
-			# :nodoc:
-			def major
-				1
-			end
-
-			# :nodoc:
-			def minor
-				2
-			end
-
-			# :nodoc:
-			def patch
-				6
-			end
-
-			# :nodoc:
-			def pre
-				nil
-			end
-		end
-
-		# ==== Return:
-		#
-		# * <tt>String</tt> - version information
-		def self.to_s
-			[major, minor, patch, pre].compact.join('.')
-		end
-  end
+  VERSION = "2.0.0beta"
 end

data/lib/veritrans.rb

@@ -1,19 +1,83 @@
-$:.unshift File.dirname(__FILE__)
+require 'veritrans/version'
+require 'veritrans/config'
+require 'veritrans/client'
+require 'veritrans/api'
+require 'veritrans/result'
 
-# Required gems
-require 'rubygems'
-require 'digest/sha2'
-require "addressable/uri"
-require 'faraday'
+if defined?(::Rails)
+  require 'veritrans/events'
+end
 
-# root namespace 
 module Veritrans
-end
+  extend Veritrans::Client
+  extend Veritrans::Api
 
-require 'veritrans/hash_generator'
-require 'veritrans/post_data'
-require 'veritrans/version'
-require 'veritrans/config'
-require 'veritrans/client'
-require 'veritrans/v_t_direct'
-require 'generators/install_generator.rb'
+  class << self
+    def config(&block)
+      if block
+        instance_eval(&block)
+      else
+        Veritrans::Config
+      end
+    end
+
+    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 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
+          @file_logger = Logger.new("/dev/null")
+        end
+      end
+
+      @file_logger
+    end
+
+    def file_logger=(value)
+      @file_logger = value
+    end
+
+    def events
+      Veritrans::Events if defined?(Veritrans::Events)
+    end
+
+    # Note: Veritrans sending notification data as json, encoded twice
+    # so we should call JSON.parse twice
+    def decode_notification_json(input)
+      if input.start_with?('"{') && input.end_with?('}"')
+        # ruby's JSON library can't excpect only hash or array. To decode string I wrap it in array.
+        request_data = Veritrans::Client._json_decode('[' + input + ']').first
+        return Veritrans::Client._json_decode(request_data)
+      else
+        # in case we will make it in expected way later
+        return Veritrans::Client._json_decode(input)
+      end
+    end
+
+  end
+end

data/license.txt

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.