datatrans 5.1.0 → 5.2.0

data/lib/datatrans/config.rb

@@ -6,10 +6,10 @@ module Datatrans
     DEFAULT_SIGN_KEY = false
 
     SUBDOMAINS = {
-      payment_page: 'pay',
-      server_to_server_api: 'api'
+      payment_page: "pay",
+      server_to_server_api: "api"
     }
-    DOMAIN = 'datatrans.com'
+    DOMAIN = "datatrans.com"
 
     attr_reader :environment, :merchant_id, :sign_key, :password, :proxy
 
@@ -21,10 +21,10 @@ module Datatrans
     # * :proxy (a hash containing :http_proxyaddr, :http_proxyport, :http_proxyuser, :http_proxypass)
     def initialize(options = {})
       @merchant_id = options[:merchant_id]
-      raise ArgumentError.new(":merchant_id is required") unless self.merchant_id
+      raise ArgumentError.new(":merchant_id is required") unless merchant_id
       self.environment = options[:environment] || DEFAULT_ENVIRONMENT
       @password = options[:password]
-      raise ArgumentError.new(":password is required") unless self.password
+      raise ArgumentError.new(":password is required") unless password
       @sign_key = options[:sign_key] || DEFAULT_SIGN_KEY
       @proxy = options[:proxy] || {}
     end
@@ -34,7 +34,7 @@ module Datatrans
       if ENVIRONMENTS.include?(environment)
         @environment = environment
       else
-        raise "Unknown environment '#{environment}'. Available: #{ENVIRONMENTS.join(', ')}"
+        raise "Unknown environment '#{environment}'. Available: #{ENVIRONMENTS.join(", ")}"
       end
     end
 
@@ -42,20 +42,31 @@ module Datatrans
     def url(what, options = {})
       case what
       when :web_authorize_url
+        warn "DEPRECATION WARNING: Support for the payment page is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
         subdomain = SUBDOMAINS[:payment_page]
-        path = '/upp/jsp/upStart.jsp'
+        path = "/upp/jsp/upStart.jsp"
       when :xml_authorize_url
+        warn "DEPRECATION WARNING: Support for the XML API is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
         subdomain = SUBDOMAINS[:server_to_server_api]
-        path = '/upp/jsp/XML_authorize.jsp'
+        path = "/upp/jsp/XML_authorize.jsp"
       when :xml_settlement_url
+        warn "DEPRECATION WARNING: Support for the XML API is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
         subdomain = SUBDOMAINS[:server_to_server_api]
-        path = '/upp/jsp/XML_processor.jsp'
+        path = "/upp/jsp/XML_processor.jsp"
       when :xml_status_url
+        warn "DEPRECATION WARNING: Support for the XML API is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
         subdomain = SUBDOMAINS[:server_to_server_api]
-        path = '/upp/jsp/XML_status.jsp'
+        path = "/upp/jsp/XML_status.jsp"
       when :init_transaction
         subdomain = SUBDOMAINS[:server_to_server_api]
         path = "/v1/transactions"
+      when :authorize_transaction
+        subdomain = SUBDOMAINS[:server_to_server_api]
+        path = "/v1/transactions/authorize"
       when :start_json_transaction
         subdomain = SUBDOMAINS[:payment_page]
         path = "/v1/start/#{options[:transaction_id]}"
@@ -63,10 +74,14 @@ module Datatrans
         # https://api.sandbox.datatrans.com/v1/transactions/{transactionId}
         subdomain = SUBDOMAINS[:server_to_server_api]
         path = "/v1/transactions/#{options[:transaction_id]}"
+      when :json_settle_url
+        # https://api.sandbox.datatrans.com/v1/transactions/{transactionId}/settle
+        subdomain = SUBDOMAINS[:server_to_server_api]
+        path = "/v1/transactions/#{options[:transaction_id]}/settle"
       else
         raise "Unknown wanted action '#{what}'."
       end
-      subdomain += '.sandbox' unless self.environment == :production
+      subdomain += ".sandbox" unless environment == :production
       "https://#{subdomain}.#{DOMAIN}#{path}"
     end
 

data/lib/datatrans/json/transaction/authorize.rb

@@ -1,48 +1,10 @@
-require 'httparty'
-require 'datatrans/json/transaction/response'
+require_relative "init"
 
 class Datatrans::JSON::Transaction
-  class Authorize
-    # class to initialize a new transaction https://api-reference.datatrans.ch/#tag/v1transactions/operation/init
-    attr_accessor :params, :datatrans
-
+  class Authorize < Init
     def initialize(datatrans, params)
-      @datatrans = datatrans
-      @params = params
-    end
-
-    def post(url, options = {})
-      options = options
-        .merge(self.datatrans.proxy)
-        .merge(:basic_auth => { :username => self.datatrans.merchant_id, :password => self.datatrans.password })
-      HTTParty.post(url, **options)
-    end
-
-    def process
-      post(self.datatrans.url(:init_transaction),
-        :headers => { 'Content-Type' => 'application/json' },
-        :body => request_body.to_json).parsed_response
-    end
-
-    def request_body
-      {
-        "currency": params[:currency],
-        "refno": params[:refno],
-        "amount": params[:amount],
-        "autoSettle": true,
-        "paymentMethods": params[:payment_methods],
-        "redirect": {
-          "successUrl": params[:success_url],
-          "cancelUrl": params[:cancel_url],
-          "errorUrl": params[:error_url]
-        }
-      }
-    end
-  end
-
-  class AuthorizeResponse < Response
-    def successful?
-      params["error"].blank? && params["transactionId"].present?
+      warn "[DEPRECATION] `Datatrans::JSON::Transaction::Authorize` is deprecated.  Please use `Datatrans::JSON::Transaction::Init` instead."
+      super(datatrans, params)
     end
   end
 end

data/lib/datatrans/json/transaction/init.rb

@@ -0,0 +1,61 @@
+require "httparty"
+require "datatrans/json/transaction/response"
+
+class Datatrans::JSON::Transaction
+  class Init
+    # class to initialize a new transaction https://api-reference.datatrans.ch/#tag/v1transactions/operation/init
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def post(url, options = {})
+      options = options
+        .merge(datatrans.proxy)
+        .merge(basic_auth: {username: datatrans.merchant_id, password: datatrans.password})
+      HTTParty.post(url, **options)
+    end
+
+    def process
+      post(datatrans.url(:init_transaction),
+        headers: {"Content-Type" => "application/json"},
+        body: request_body.to_json).parsed_response
+    end
+
+    def request_body
+      auto_settle = params[:auto_settle].nil? ? true : params[:auto_settle]
+
+      body = {
+        currency: params[:currency],
+        refno: params[:refno],
+        amount: params[:amount],
+        autoSettle: auto_settle,
+        paymentMethods: params[:payment_methods],
+        redirect: {
+          successUrl: params[:success_url],
+          cancelUrl: params[:cancel_url],
+          errorUrl: params[:error_url]
+        }
+      }
+
+      body["option"] = params[:option] if params[:option].present?
+
+      body
+    end
+  end
+
+  class InitResponse < Response
+    def successful?
+      params["error"].blank? && params["transactionId"].present?
+    end
+  end
+
+  class AuthorizeResponse < InitResponse
+    def initialize(datatrans, params)
+      warn "[DEPRECATION] `Datatrans::JSON::Transaction::AuthorizeResponse` is deprecated.  Please use `Datatrans::JSON::Transaction::InitResponse` instead."
+      super(datatrans, params)
+    end
+  end
+end

data/lib/datatrans/json/transaction/merchant_authorize.rb

@@ -0,0 +1,45 @@
+require "httparty"
+require "datatrans/json/transaction/response"
+
+class Datatrans::JSON::Transaction
+  class MerchantAuthorize
+    # class to authorize a transaction without user interaction https://api-reference.datatrans.ch/#tag/v1transactions/operation/authorize
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def post(url, options = {})
+      options = options
+        .merge(datatrans.proxy)
+        .merge(basic_auth: {username: datatrans.merchant_id, password: datatrans.password})
+      HTTParty.post(url, **options)
+    end
+
+    def process
+      post(datatrans.url(:authorize_transaction),
+        headers: {"Content-Type" => "application/json"},
+        body: request_body.to_json).parsed_response
+    end
+
+    def request_body
+      auto_settle = params[:auto_settle].nil? ? true : params[:auto_settle]
+
+      {
+        currency: params[:currency],
+        refno: params[:refno],
+        amount: params[:amount],
+        card: params[:card],
+        autoSettle: auto_settle
+      }
+    end
+  end
+
+  class MerchantAuthorizeResponse < Response
+    def successful?
+      params["error"].blank? && params["transactionId"].present?
+    end
+  end
+end

data/lib/datatrans/json/transaction/response.rb

@@ -8,15 +8,19 @@ class Datatrans::JSON::Transaction
     end
 
     def successful?
-      raise 'overwrite in subclass!'
+      raise "overwrite in subclass!"
     end
 
     def error_code
-      params["error"]["code"] rescue nil
+      params["error"]["code"]
+    rescue
+      nil
     end
 
     def error_message
-      params["error"]["message"] rescue nil
+      params["error"]["message"]
+    rescue
+      nil
     end
   end
 end

data/lib/datatrans/json/transaction/settle.rb

@@ -0,0 +1,41 @@
+require "httparty"
+require "datatrans/json/transaction/response"
+
+class Datatrans::JSON::Transaction
+  class Settle
+    # Class to settle a transaction https://api-reference.datatrans.ch/#tag/v1transactions/operation/settle
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def post(url, options = {})
+      options = options
+        .merge(datatrans.proxy)
+        .merge(basic_auth: {username: datatrans.merchant_id, password: datatrans.password})
+      HTTParty.post(url, **options)
+    end
+
+    def process
+      post(datatrans.url(:json_settle_url, transaction_id: params[:transaction_id]),
+        headers: {"Content-Type" => "application/json"},
+        body: request_body.to_json).parsed_response
+    end
+
+    def request_body
+      {
+        currency: params[:currency],
+        amount: params[:amount],
+        refno: params[:refno]
+      }
+    end
+  end
+
+  class SettleResponse < Response
+    def successful?
+      params["error"].blank?
+    end
+  end
+end

data/lib/datatrans/json/transaction/status.rb

@@ -1,5 +1,5 @@
-require 'httparty'
-require 'datatrans/json/transaction/response'
+require "httparty"
+require "datatrans/json/transaction/response"
 
 class Datatrans::JSON::Transaction
   class Status
@@ -13,14 +13,14 @@ class Datatrans::JSON::Transaction
 
     def get(url, options = {})
       options = options
-        .merge(self.datatrans.proxy)
-        .merge(:basic_auth => { :username => self.datatrans.merchant_id, :password => self.datatrans.password })
+        .merge(datatrans.proxy)
+        .merge(basic_auth: {username: datatrans.merchant_id, password: datatrans.password})
       HTTParty.get(url, **options)
     end
 
     def process
-      get(self.datatrans.url(:json_status_url, transaction_id: params[:transaction_id]),
-        :headers => { 'Content-Type' => 'application/json' }).parsed_response
+      get(datatrans.url(:json_status_url, transaction_id: params[:transaction_id]),
+        headers: {"Content-Type" => "application/json"}).parsed_response
     end
   end
 
@@ -30,15 +30,21 @@ class Datatrans::JSON::Transaction
     end
 
     def response_code
-      params["status"] rescue nil
+      params["status"]
+    rescue
+      nil
     end
 
     def reference_number
-      params["refno"] rescue nil
+      params["refno"]
+    rescue
+      nil
     end
 
     def amount
-      params["detail"]["settle"]["amount"] rescue nil
+      params["detail"]["settle"]["amount"]
+    rescue
+      nil
     end
   end
 end

data/lib/datatrans/json/transaction.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/hash'
+require "active_support/core_ext/hash"
 
 module Datatrans::JSON
   class Transaction
@@ -11,22 +11,44 @@ module Datatrans::JSON
     end
 
     def authorize
-      self.request = Authorize.new(self.datatrans, params)
-      @response = AuthorizeResponse.new(self.datatrans, request.process)
+      warn "[DEPRECATION] `Datatrans::JSON::Transaction#authorize` is deprecated.  Please use `Datatrans::JSON::Transaction#init` instead."
+
+      self.request = Authorize.new(datatrans, params)
+      @response = AuthorizeResponse.new(datatrans, request.process)
+      @response.successful?
+    end
+
+    def init
+      self.request = Init.new(datatrans, params)
+      @response = InitResponse.new(datatrans, request.process)
+      @response.successful?
+    end
+
+    def merchant_authorize
+      self.request = MerchantAuthorize.new(datatrans, params)
+      @response = MerchantAuthorizeResponse.new(datatrans, request.process)
       @response.successful?
     end
 
     def status
-      self.request = Status.new(self.datatrans, params)
-      @response = StatusResponse.new(self.datatrans, request.process)
+      self.request = Status.new(datatrans, params)
+      @response = StatusResponse.new(datatrans, request.process)
+      @response.successful?
+    end
+
+    def settle
+      self.request = Settle.new(datatrans, params)
+      @response = SettleResponse.new(datatrans, request.process)
       @response.successful?
     end
 
     def transaction_path
-      self.datatrans.url(:start_json_transaction, transaction_id: params[:transaction_id])
+      datatrans.url(:start_json_transaction, transaction_id: params[:transaction_id])
     end
   end
 end
 
-require 'datatrans/json/transaction/authorize'
-require 'datatrans/json/transaction/status'
+require "datatrans/json/transaction/authorize"
+require "datatrans/json/transaction/merchant_authorize"
+require "datatrans/json/transaction/status"
+require "datatrans/json/transaction/settle"

data/lib/datatrans/version.rb

@@ -1,3 +1,3 @@
 module Datatrans
-  VERSION = "5.1.0"
+  VERSION = "5.2.0"
 end

data/lib/datatrans/web/transaction/authorize.rb

@@ -3,78 +3,107 @@ class Datatrans::Web::Transaction
     attr_accessor :params, :datatrans
 
     def initialize(datatrans, params)
+      warn "DEPRECATION WARNING: Support for the payment page is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
       @datatrans = datatrans
       @params = params
     end
 
     def successful?
       raise Datatrans::InvalidSignatureError unless valid_signature?
-      response_code == '01' && status == 'success' && !errors_occurred?
+      response_code == "01" && status == "success" && !errors_occurred?
     end
 
     def valid_signature?
       # TODO: does not make sense... true if errors?
       return true if errors_occurred? # no sign2 sent on error
-      sign(self.datatrans.merchant_id, params[:amount], params[:currency], params[:uppTransactionId]) == params[:sign2]
+      sign(datatrans.merchant_id, params[:amount], params[:currency], params[:uppTransactionId]) == params[:sign2]
     end
 
     def status
-      params[:status] rescue nil
+      params[:status]
+    rescue
+      nil
     end
 
     def response_code
-      params[:responseCode] rescue nil
+      params[:responseCode]
+    rescue
+      nil
     end
 
     def response_message
-      params[:responseMessage] rescue nil
+      params[:responseMessage]
+    rescue
+      nil
     end
 
     def transaction_id
-      params[:uppTransactionId] rescue nil
+      params[:uppTransactionId]
+    rescue
+      nil
     end
 
     def reference_number
-      params[:refno] rescue nil
+      params[:refno]
+    rescue
+      nil
     end
 
     def authorization_code
-      params[:authorizationCode] rescue nil
+      params[:authorizationCode]
+    rescue
+      nil
     end
 
     def payment_method
-      params[:pmethod] rescue nil
+      params[:pmethod]
+    rescue
+      nil
     end
 
     def masked_cc
-      params[:maskedCC] rescue nil
+      params[:maskedCC]
+    rescue
+      nil
     end
 
     def exp_year
-      params[:expy] rescue nil
+      params[:expy]
+    rescue
+      nil
     end
 
     def exp_month
-      params[:expm] rescue nil
+      params[:expm]
+    rescue
+      nil
     end
 
     def creditcard_alias
-      params[:aliasCC] rescue nil
+      params[:aliasCC]
+    rescue
+      nil
     end
 
     def error_code
-      params[:errorCode] rescue nil
+      params[:errorCode]
+    rescue
+      nil
     end
 
     def error_message
-      params[:errorMessage] rescue nil
+      params[:errorMessage]
+    rescue
+      nil
     end
 
     def error_detail
-      params[:errorDetail] rescue nil
+      params[:errorDetail]
+    rescue
+      nil
     end
 
-
     private
 
     def errors_occurred?

data/lib/datatrans/web/transaction.rb

@@ -1,4 +1,4 @@
-require 'active_support/core_ext/hash'
+require "active_support/core_ext/hash"
 
 module Datatrans::Web
   class Transaction
@@ -8,15 +8,17 @@ module Datatrans::Web
     attr_reader :response, :params, :datatrans
 
     def initialize(datatrans, params)
+      warn "DEPRECATION WARNING: Support for the payment page is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
       @datatrans = datatrans
       params = params.to_hash
       params.symbolize_keys!
-      params.reverse_merge!(:reqtype => 'NOA', :useAlias => 'yes', :hiddenMode => 'yes')
+      params.reverse_merge!(reqtype: "NOA", useAlias: "yes", hiddenMode: "yes")
       @params = params
     end
 
     def signature
-      sign(self.datatrans.merchant_id, params[:amount], params[:currency], params[:refno])
+      sign(datatrans.merchant_id, params[:amount], params[:currency], params[:refno])
     end
 
     def authorize
@@ -24,6 +26,10 @@ module Datatrans::Web
       @response.successful?
     end
 
+    def respond_to_missing?(method, *)
+      response.respond_to?(method.to_sym) || super
+    end
+
     def method_missing(method, *args, &block)
       if response.respond_to? method.to_sym
         response.send(method)
@@ -34,4 +40,4 @@ module Datatrans::Web
   end
 end
 
-require 'datatrans/web/transaction/authorize'
+require "datatrans/web/transaction/authorize"

data/lib/datatrans/web/view_helper.rb

@@ -1,6 +1,8 @@
 module Datatrans::Web
   module ViewHelper
     def datatrans_notification_request_hidden_fields(datatrans, transaction)
+      warn "DEPRECATION WARNING: Support for the payment page is deprecated and will be removed in the next major version. Please use the JSON API instead."
+
       fields = [
         hidden_field_tag(:merchantId, datatrans.merchant_id),
         hidden_field_tag(:hiddenMode, transaction.params[:hiddenMode]),
@@ -10,7 +12,7 @@ module Datatrans::Web
         hidden_field_tag(:useAlias, transaction.params[:useAlias]),
         hidden_field_tag(:sign, transaction.signature),
         hidden_field_tag(:refno, transaction.params[:refno]),
-        hidden_field_tag(:uppCustomerDetails, transaction.params[:uppCustomerDetails]),
+        hidden_field_tag(:uppCustomerDetails, transaction.params[:uppCustomerDetails])
       ]
 
       [:uppCustomerName, :uppCustomerEmail].each do |field_name|