datatrans 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb01c19e9afe3aecaa82ff08e7e9024fefb8c60d3cab86fbd3400e4598879dcd
-  data.tar.gz: 13a9c7a7068610907a8123c11cf50f60014f79b5de6db2b51f763a5509159fb3
+  metadata.gz: 6749673b2125a6a645cef06bd13d1a9d3f6f58276bd9e6abe18c287e0b821637
+  data.tar.gz: 26912c6b041d37f4af6872b5bfb138e0b9b90545058335c1f58407aa874125b9
 SHA512:
-  metadata.gz: b8d2cc670be21be5336b8856eca9603ef8351be8ebc9e8e19efca2486a2304d7a8701fcabeea629285434dcd4b6c99cf8f53b8382870cbd0a7dbf38db7b6ded2
-  data.tar.gz: a13b4a7a1934bfa437209b9eb53b2c8bba45d3e0c7e24cb699e8544c7d2af67d6497a0a1c885e3d6af034030b3b0b077d5928a4e8e6577a2b606824c1752be22
+  metadata.gz: 1f4ab534d4b3b8a684c42489c300fa6c7da8b442a4ec8faf168408712b8eb8318950dcfa25685f755826bb7270cf93adbdda7bc7a05778d8c4be4913437db439
+  data.tar.gz: d595075292ae69128eaf4f56f9c99eff69a736c91300fd2ced3baa2f4b918a5a15aa6b52ecfd0987a23e6ebf508c88239ba9075482b1dc6988540632c0f172bb

data/.github/workflows/ci.yml

@@ -1,13 +1,13 @@
 ---
 name: CI
-on: [push, pull_request]
+on: [ push, pull_request ]
 jobs:
   tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1' ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1', '3.2' ]
         rails: [ '5-2', '6-0', '6-1', '7-0' ]
         exclude:
           - ruby: 2.6 # Rails 7 requires 2.7 minimum
@@ -20,6 +20,12 @@ jobs:
             rails: 6-0
           - ruby: 3.1
             rails: 6-1
+          - ruby: 3.2 # Ruby 3.2 only works on the latest Rails 7 version
+            rails: 5-2
+          - ruby: 3.2
+            rails: 6-0
+          - ruby: 3.2
+            rails: 6-1
 
     steps:
       - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -5,6 +5,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## 5.1.0 - 2023-07-06
+
+### Added
+
+* Test against Ruby 3.2 (@andyundso [#43](https://github.com/simplificator/datatrans/pull/43))
+* Add support for Datatrans JSON API (@TatianaPan [#45](https://github.com/simplificator/datatrans/pull/45)). Check Readme for details on how to use it.
+
+XML API is [deprecated](https://mailchi.mp/datatrans/basic-authdynamic-sign_reminder) by Datatrans and will not be supported by them after June 3rd, 2024. Consider to moving to a [new JSON API](https://api-reference.datatrans.ch/).
+
 ## 5.0.0 - 2022-09-21
 
 ### Changed

data/README.markdown

@@ -8,6 +8,7 @@ Configuration
 
 Build your Datatrans Configuration like so:
 
+```ruby
     datatrans = Datatrans::Config.new(
       :merchant_id => '1234567',
       :sign_key => 'ab739fd5b7c2a1...',
@@ -20,7 +21,7 @@ Build your Datatrans Configuration like so:
         :http_proxpass => "xxx",
       }
     )
-
+```
 
 If you don't want to use signed requests (disabled in datatrans web console), you can set `config.sign_key` to `false`.
 The configuration is then used as parameter to all the constructors and helpers, see examples below.
@@ -33,6 +34,7 @@ Web Authorization
 If you want to process a credit card the first time a web authorization is
 necessary. Add the following code to a controller action that shows the form.
 You need to pass at least `amount`, `currency` and `refno` (order number).
+```ruby
     @transaction = datatrans.web_transaction(
       :amount => 1000, # in cents!
       :currency => 'CHF',
@@ -40,9 +42,11 @@ You need to pass at least `amount`, `currency` and `refno` (order number).
       :uppCustomerEmail => 'customer@email.com',
       # feel free to add more upp infos here ...
     )
+```
 
 In your View your show the credit card form with a convenient helper:
 
+```ruby
     = form_tag Datatrans.web_authorize_url do
 
       = text_field_tag :paymentmethod, 'ECA'
@@ -58,6 +62,7 @@ In your View your show the credit card form with a convenient helper:
       = datatrans_notification_request_hidden_fields(datatrans, @transaction)
 
       = submit_tag "send"
+```
 
 In this example we use just ECA (Mastercard) as paymentmethod. Feel free to
 provide an appropriate select field to offer more payment methods. Don't forget
@@ -66,7 +71,7 @@ to the same value.
 
 After you submit the request to Datatrans they redirect back to your application.
 Now you can process the transaction like this:
-
+```ruby
     begin
       transaction = datatrans.web_transaction(params)
 
@@ -86,16 +91,124 @@ Now you can process the transaction like this:
     rescue Datatrans::InvalidSignatureError => exception
       # the signature was wrong, the request may have been compromised...
     end
+```
+
+JSON Transactions
+=================
+
+More information about Datatrans JSON API can be found [here](https://api-reference.datatrans.ch/). Our gem uses endpoints from `/v1/transactions` section. 
+
+We implemented support for [Redirect mode](https://docs.datatrans.ch/docs/redirect-lightbox) (since Lightbox mode may not work correctly on mobile, whereas Redirect works well on all devises).
+
+Authorize
+---------
+
+Authorize JSON transaction:
+
+```ruby
+transaction = datatrans.json_transaction(
+  refno: 'ABCDEF',
+  amount: 1000, # in cents!
+  currency: "CHF",
+  payment_methods: ["ECA", "VIS"],
+  success_url: <your_application_return_url>,
+  cancel_url: <your_application_return_url>,
+  error_url: <your_application_return_url>
+)
+
+# call to init endpoint to initialize a transaction
+# returns true or false depending if response was successful or not
+init = transaction.authorize
+
+# successful authorization call returns in response a transaction id
+if init
+  transaction_id = transaction.response.params["transactionId"]
+end
+```
+
+Start a transaction
+-------------------
+
+Once you have a transaction id, you can start a transaction. Users of your application will be redirected to the datatrans payment pages: `https://pay.sandbox.datatrans.com/v1/start/{{transactionId}}`.
+
+```ruby
+ path = datatrans.json_transaction(transaction_id: transaction_id).transaction_path
+
+ redirect_to path
+ # or if you redirect after AJAX request:
+ render js: "window.location='#{path}'"
+```
+
+You do not have to [settle a transaction](https://api-reference.datatrans.ch/#tag/v1transactions/operation/settle) by yourself: we set `"autoSettle": true` by default when authorizing a transaction, which means the transaction will be settled automatically.
+
+Transaction status
+------------------
+
+You can check the trasaction [status](https://api-reference.datatrans.ch/#tag/v1transactions/operation/status), see its history and retrieve the card information.
+
+```ruby
+  transaction = datatrans.json_transaction(transaction_id: transaction_id)
+
+  # status method returns true or false depending if response was successfull
+  if transaction.status
+    data = transaction.response.params
+    # this will return following hash (may vary dependong on your payment method):
+    {
+      "transactionId"=>"230223022302230223",
+      "merchantId"=>"1100000000",
+      "type"=>"payment",
+      "status"=>"settled",
+      "currency"=>"CHF",
+      "refno"=>"123456abc",
+      "paymentMethod"=>"VIS",
+      "detail"=>
+        {"authorize"=>{"amount"=>1000, "acquirerAuthorizationCode"=>"100000"}, "settle"=>{"amount"=>1000}},
+      "language"=>"en",
+      "card"=>
+        {"masked"=>"400000xxxxxx0018",
+        "expiryMonth"=>"06",
+        "expiryYear"=>"25",
+        "info"=>
+          {"brand"=>"VISA",
+          "type"=>"debit",
+          "usage"=>"consumer",
+          "country"=>"SE",
+          "issuer"=>"SVENSKA HANDELSBANKEN AB"},
+        "3D"=>{"authenticationResponse"=>"Y"}},
+      "history"=>
+        [{"action"=>"init",
+          "amount"=>1000,
+          "source"=>"api",
+          "date"=>"2023-06-06T08:37:23Z",
+          "success"=>true,
+          "ip"=>"8.8.8.8"},
+        {"action"=>"authorize",
+          "autoSettle"=>true,
+          "amount"=>1000,
+          "source"=>"redirect",
+          "date"=>"2023-06-06T08:37:42Z",
+          "success"=>true,
+          "ip"=>"8.8.8.8"}]
+    }
+  else
+    transaction.response.error_code
+    transaction.response.error_message
+  end
+```
+
 
 XML Transactions
 ================
 
+XML API is [deprecated](https://mailchi.mp/datatrans/basic-authdynamic-sign_reminder) by Datatrans. After June 3rd, 2024 all merchants will have to use JSON API.
+
 If you have already a credit card alias or an authorized transaction you can
 use the convenient XML methods to process payments.
 
 Authorize
 ---------
 
+```ruby
     transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
@@ -111,6 +224,7 @@ Authorize
     else
       # transaction.error_code, transaction.error_message, transaction.error_detail
     end
+```
 
 
 Capture
@@ -118,6 +232,7 @@ Capture
 
 To capture an authorized transaction you use the following code:
 
+```ruby
     transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
@@ -130,13 +245,14 @@ To capture an authorized transaction you use the following code:
     else
       # transaction.error_code, transaction.error_message, transaction.error_detail
     end
-
+```
 
 Void
 ----
 
 To make an authorized transaction invalid use void.
 
+```ruby
     transaction = datatrans.xml_transaction(
       :refno => 'ABCDEF',
       :amount => 1000, # in cents!
@@ -149,6 +265,7 @@ To make an authorized transaction invalid use void.
     else
       # transaction.error_code, transaction.error_message, transaction.error_detail
     end
+```
 
 Todo
 ====

data/lib/datatrans/config.rb

@@ -39,7 +39,7 @@ module Datatrans
     end
 
     # Access a url, is automatically scoped to environment
-    def url(what)
+    def url(what, options = {})
       case what
       when :web_authorize_url
         subdomain = SUBDOMAINS[:payment_page]
@@ -53,6 +53,16 @@ module Datatrans
       when :xml_status_url
         subdomain = SUBDOMAINS[:server_to_server_api]
         path = '/upp/jsp/XML_status.jsp'
+      when :init_transaction
+        subdomain = SUBDOMAINS[:server_to_server_api]
+        path = "/v1/transactions"
+      when :start_json_transaction
+        subdomain = SUBDOMAINS[:payment_page]
+        path = "/v1/start/#{options[:transaction_id]}"
+      when :json_status_url
+        # https://api.sandbox.datatrans.com/v1/transactions/{transactionId}
+        subdomain = SUBDOMAINS[:server_to_server_api]
+        path = "/v1/transactions/#{options[:transaction_id]}"
       else
         raise "Unknown wanted action '#{what}'."
       end
@@ -67,5 +77,9 @@ module Datatrans
     def xml_transaction(*args)
       XML::Transaction.new(self, *args)
     end
+
+    def json_transaction(*args)
+      JSON::Transaction.new(self, *args)
+    end
   end
 end

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

@@ -0,0 +1,48 @@
+require 'httparty'
+require 'datatrans/json/transaction/response'
+
+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
+
+    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?
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+class Datatrans::JSON::Transaction
+  class Response
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def successful?
+      raise 'overwrite in subclass!'
+    end
+
+    def error_code
+      params["error"]["code"] rescue nil
+    end
+
+    def error_message
+      params["error"]["message"] rescue nil
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+require 'httparty'
+require 'datatrans/json/transaction/response'
+
+class Datatrans::JSON::Transaction
+  class Status
+    # class to check a transaction status and get a transaction info: https://api-reference.datatrans.ch/#tag/v1transactions/operation/status
+    attr_accessor :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def get(url, options = {})
+      options = options
+        .merge(self.datatrans.proxy)
+        .merge(:basic_auth => { :username => self.datatrans.merchant_id, :password => self.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
+    end
+  end
+
+  class StatusResponse < Response
+    def successful?
+      params["error"].blank? && ["settled", "transmitted"].include?(response_code)
+    end
+
+    def response_code
+      params["status"] rescue nil
+    end
+
+    def reference_number
+      params["refno"] rescue nil
+    end
+
+    def amount
+      params["detail"]["settle"]["amount"] rescue nil
+    end
+  end
+end

data/lib/datatrans/json/transaction.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/hash'
+
+module Datatrans::JSON
+  class Transaction
+    attr_accessor :request
+    attr_reader :response, :params, :datatrans
+
+    def initialize(datatrans, params)
+      @datatrans = datatrans
+      @params = params
+    end
+
+    def authorize
+      self.request = Authorize.new(self.datatrans, params)
+      @response = AuthorizeResponse.new(self.datatrans, request.process)
+      @response.successful?
+    end
+
+    def status
+      self.request = Status.new(self.datatrans, params)
+      @response = StatusResponse.new(self.datatrans, request.process)
+      @response.successful?
+    end
+
+    def transaction_path
+      self.datatrans.url(:start_json_transaction, transaction_id: params[:transaction_id])
+    end
+  end
+end
+
+require 'datatrans/json/transaction/authorize'
+require 'datatrans/json/transaction/status'

data/lib/datatrans/version.rb

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

data/lib/datatrans.rb

@@ -9,6 +9,7 @@ require 'datatrans/common'
 require 'datatrans/config'
 require 'datatrans/xml/transaction'
 require 'datatrans/web/transaction'
+require 'datatrans/json/transaction'
 
 begin
   require 'action_view'

data/spec/config_spec.rb

@@ -17,5 +17,11 @@ describe Datatrans::Config do
         expect(@datatrans.xml_transaction({}).class).to eq(Datatrans::XML::Transaction)
       end
     end
+
+    describe "json_transaction" do
+      it "builds a new json transaction object" do
+        expect(@datatrans.json_transaction({}).class).to eq(Datatrans::JSON::Transaction)
+      end
+    end
   end
 end

data/spec/json/authorize_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+describe Datatrans::JSON::Transaction::Authorize do
+  before do
+    @successful_response = {
+      "transactionId" => "230223022302230223"
+    }
+
+    @failed_response = {
+      "error" => {
+        "code" => "INVALID_PROPERTY",
+        "message" => "init.refno must not be null"
+      }
+    }
+
+    @valid_params = {
+      currency: "CHF",
+      refno: "B4B4B4B4B",
+      amount: 1337,
+      payment_methods: ["ECA", "VIS"],
+      success_url: "https://pay.sandbox.datatrans.com/upp/merchant/successPage.jsp",
+      cancel_url: "https://pay.sandbox.datatrans.com/upp/merchant/cancelPage.jsp",
+      error_url: "https://pay.sandbox.datatrans.com/upp/merchant/errorPage.jsp"
+    }
+
+    @invalid_params = {
+      currency: "CHF",
+      refno: nil,
+      amount: 1337,
+      payment_methods: ["ECA", "VIS"],
+    }
+  end
+
+  context "successful response" do
+    before do
+      allow_any_instance_of(Datatrans::JSON::Transaction::Authorize).to receive(:process).and_return(@successful_response)
+    end
+
+    it "generates correct request_body" do
+      expected = {
+        "currency": "CHF",
+        "refno": "B4B4B4B4B",
+        "amount": 1337,
+        "autoSettle": true,
+        "paymentMethods": ["ECA", "VIS"],
+        "redirect": {
+          "successUrl": "https://pay.sandbox.datatrans.com/upp/merchant/successPage.jsp",
+          "cancelUrl": "https://pay.sandbox.datatrans.com/upp/merchant/cancelPage.jsp",
+          "errorUrl": "https://pay.sandbox.datatrans.com/upp/merchant/errorPage.jsp"
+        }
+      }
+      request = Datatrans::JSON::Transaction::Authorize.new(@datatrans, @valid_params)
+
+      expect(request.request_body).to eq(expected)
+    end
+
+    it "#process handles a valid datatrans authorize response" do
+      @transaction = Datatrans::JSON::Transaction.new(@datatrans, @valid_params)
+      expect(@transaction.authorize).to be true
+    end
+  end
+
+  context "failed response" do
+    before do
+      allow_any_instance_of(Datatrans::JSON::Transaction::Authorize).to receive(:process).and_return(@failed_response)
+      @transaction = Datatrans::JSON::Transaction.new(@datatrans, @invalid_params)
+    end
+
+    it "#process handles a failed datatrans authorize response" do
+      expect(@transaction.authorize).to be false
+    end
+
+    it "returns error details" do
+      @transaction.authorize
+      expect(@transaction.response.error_code).to eq "INVALID_PROPERTY"
+      expect(@transaction.response.error_message).to eq "init.refno must not be null"
+    end
+  end
+end

data/spec/json/status_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe Datatrans::JSON::Transaction::Status do
+  before do
+    @successful_response = {
+      "transactionId" => "230223022302230223",
+      "merchantId" => "1100000000",
+      "type" => "payment",
+      "status" => "settled",
+      "currency" => "CHF",
+      "refno" => "B4B4B4B4B",
+      "paymentMethod" => "VIS",
+      "detail" => {
+        "authorize" => {}
+      },
+      "card" => {
+        "masked" => "424242xxxxxx4242",
+        "expiryMonth" => "06",
+        "expiryYear" => "25",
+        "info" => {}
+      },
+      "history" => [
+        {
+          "action" => "authorize",
+          "amount" => 1000,
+          "source" => "api",
+          "date" => "2023-02-08T14:25:24Z",
+          "success" => true,
+          "ip" => "8.8.8.8"
+        }
+      ]
+    }
+
+    @failed_response = {
+      "error" => {
+        "code" => "INVALID_PROPERTY",
+        "message" => "status transactionId length must be 18 digits"
+      }
+    }
+
+    @valid_params = {
+      transaction_id: '230223022302230223',
+    }
+
+    @invalid_params = {
+      transaction_id: '0208020802080208', # wrong number of digits in ID
+    }
+  end
+
+  context "successful response" do
+    before do
+      allow_any_instance_of(Datatrans::JSON::Transaction::Status).to receive(:process).and_return(@successful_response)
+    end
+
+    it "#process handles a valid datatrans status response" do
+      transaction = Datatrans::JSON::Transaction.new(@datatrans, @valid_params)
+      expect(transaction.status).to be true
+      expect(transaction.response.params["refno"]).to eq "B4B4B4B4B"
+      expect(transaction.response.params["paymentMethod"]).to eq "VIS"
+    end
+  end
+
+  context "failed response" do
+    before do
+      allow_any_instance_of(Datatrans::JSON::Transaction::Status).to receive(:process).and_return(@failed_response)
+      @transaction = Datatrans::JSON::Transaction.new(@datatrans, @invalid_params)
+    end
+
+    it "handles a failed datatrans status response" do
+      expect(@transaction.status).to be false
+      expect(@transaction.response.error_code).to eq "INVALID_PROPERTY"
+      expect(@transaction.response.error_message).to eq "status transactionId length must be 18 digits"
+    end
+  end
+end

data/spec/json/transaction_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe Datatrans::JSON::Transaction do
+  it "returns correct trasaction_path" do
+    params = {transaction_id: "230223022302230223"}
+    transaction = Datatrans::JSON::Transaction.new(@datatrans, params)
+
+    expect(transaction.transaction_path).to eq "https://pay.sandbox.datatrans.com/v1/start/230223022302230223"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datatrans
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Tobias Miesel
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-21 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -165,6 +165,10 @@ files:
 - lib/datatrans.rb
 - lib/datatrans/common.rb
 - lib/datatrans/config.rb
+- lib/datatrans/json/transaction.rb
+- lib/datatrans/json/transaction/authorize.rb
+- lib/datatrans/json/transaction/response.rb
+- lib/datatrans/json/transaction/status.rb
 - lib/datatrans/version.rb
 - lib/datatrans/web/transaction.rb
 - lib/datatrans/web/transaction/authorize.rb
@@ -178,6 +182,9 @@ files:
 - lib/datatrans/xml/transaction/void.rb
 - spec/common_spec.rb
 - spec/config_spec.rb
+- spec/json/authorize_spec.rb
+- spec/json/status_spec.rb
+- spec/json/transaction_spec.rb
 - spec/spec_helper.rb
 - spec/web/authorize_spec.rb
 - spec/xml/authorize_spec.rb