datatrans 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6749673b2125a6a645cef06bd13d1a9d3f6f58276bd9e6abe18c287e0b821637
-  data.tar.gz: 26912c6b041d37f4af6872b5bfb138e0b9b90545058335c1f58407aa874125b9
+  metadata.gz: c2f34eb8d332a694f26cb82bb7f9f6d953914b4f314d6eb6cf73896b5398a228
+  data.tar.gz: d62d36a4d876a1b594706ef77e845fa10d80d22bfe712e01acb1d4e7d7e1b394
 SHA512:
-  metadata.gz: 1f4ab534d4b3b8a684c42489c300fa6c7da8b442a4ec8faf168408712b8eb8318950dcfa25685f755826bb7270cf93adbdda7bc7a05778d8c4be4913437db439
-  data.tar.gz: d595075292ae69128eaf4f56f9c99eff69a736c91300fd2ced3baa2f4b918a5a15aa6b52ecfd0987a23e6ebf508c88239ba9075482b1dc6988540632c0f172bb
+  metadata.gz: c6d5a9d7d70dec2c18bcc7b18060003f6e769497479851c8646c5b04df703a504ab5dac6f0a8b7144891ae0c65c2f3894e762429da3f9586cb06d0a08398d181
+  data.tar.gz: abdef0e7fc212ae0ac3015f271bf98bb9f22ce163d43bbb88e68e1b056b4deeca1f903374d50a64c9078cdfdc33da9c532a4822349f5a99a69aa8deae867ef52

data/.github/workflows/ci.yml

@@ -2,16 +2,33 @@
 name: CI
 on: [ push, pull_request ]
 jobs:
+  standard:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6 # keep it on the lowest supported Ruby version
+          bundler-cache: true
+
+      - name: Run Standard
+        run: bundle exec standardrb
+
   tests:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.7', '3.0', '3.1', '3.2' ]
-        rails: [ '5-2', '6-0', '6-1', '7-0' ]
+        ruby: [ '2.6', '2.7', '3.0', '3.1', '3.2', '3.3' ]
+        rails: [ '5-2', '6-0', '6-1', '7-0', '7-1' ]
+        # excludes are sorted by Ruby version, then Rails version
         exclude:
           - ruby: 2.6 # Rails 7 requires 2.7 minimum
             rails: 7-0
+          - ruby: 2.6 # Rails 7.1 requires 2.7 minimum
+            rails: 7-1
           - ruby: 3.0 # Ruby 3 support for 5.2 hasn't been added
             rails: 5-2
           - ruby: 3.1 # Ruby 3.1 only works on the latest Rails 7 version
@@ -26,9 +43,19 @@ jobs:
             rails: 6-0
           - ruby: 3.2
             rails: 6-1
+          - ruby: 3.3 # Ruby 3.3 only works on the latest Rails 7 version
+            rails: 5-2
+          - ruby: 3.3
+            rails: 6-0
+          - ruby: 3.3
+            rails: 6-1
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
+
+      # we otherwise run into issues with different versions of actionpack / activesupport with Appraisal
+      - name: Remove Gemfile.lock
+        run: rm Gemfile.lock
 
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1

data/.github/workflows/release.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/master'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7

data/.gitignore

@@ -1,5 +1,5 @@
 *.gem
 .bundle
 pkg/*
-*.lock
+gemfiles/*.lock
 coverage

data/.ruby-version

@@ -1 +1 @@
-2.6.9
+2.6.10

data/Appraisals

@@ -1,31 +1,39 @@
 appraise "rails-5-2" do
-  gem "activesupport", "~> 5.2"
+  gem "activesupport", "~> 5.2.0"
 
   group :development, :test do
-    gem "actionpack", "~> 5.2"
+    gem "actionpack", "~> 5.2.0"
   end
 end
 
 appraise "rails-6-0" do
-  gem "activesupport", "~> 6.0"
+  gem "activesupport", "~> 6.0.0"
 
   group :development, :test do
-    gem "actionpack", "~> 6.0"
+    gem "actionpack", "~> 6.0.0"
   end
 end
 
 appraise "rails-6-1" do
-  gem "activesupport", "~> 6.1"
+  gem "activesupport", "~> 6.1.0"
 
   group :development, :test do
-    gem "actionpack", "~> 6.1"
+    gem "actionpack", "~> 6.1.0"
   end
 end
 
 appraise "rails-7-0" do
-  gem "activesupport", "~> 7.0"
+  gem "activesupport", "~> 7.0.0"
 
   group :development, :test do
-    gem "actionpack", "~> 7.0"
+    gem "actionpack", "~> 7.0.0"
+  end
+end
+
+appraise "rails-7-1" do
+  gem "activesupport", "~> 7.1.0"
+
+  group :development, :test do
+    gem "actionpack", "~> 7.1.0"
   end
 end

data/CHANGELOG.md

@@ -5,6 +5,19 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## 5.2.0 - 2024-01-31
+
+### Added
+
+* Support for Ruby 3.3 and Rails 7.1 (@andyundso [#47](https://github.com/simplificator/datatrans/pull/47))
+* Support for Merchant Initiated Payments (@visini [#48](https://github.com/simplificator/datatrans/pull/48), [#52](https://github.com/simplificator/datatrans/pull/52), [#53](https://github.com/simplificator/datatrans/pull/53), [#56](https://github.com/simplificator/datatrans/pull/56))
+
+### Changed
+
+* Reformatted code with standardrb (@andyundso [#57](https://github.com/simplificator/datatrans/pull/57))
+* Marked XML APIs and Web APIs as deprecated (@andyundso [#60](https://github.com/simplificator/datatrans/pull/60))
+* Renamed `Datatrans::JSON::Transaction::Authorize` to `Datatrans::JSON::Transaction::Init`. `::Authorize` will still work until the next major release (@andyundso [#60](https://github.com/simplificator/datatrans/pull/60))
+
 ## 5.1.0 - 2023-07-06
 
 ### Added

data/Gemfile

@@ -3,3 +3,4 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in datatrans.gemspec
 gemspec
 gem "simplecov", group: :test, require: nil
+gem "standard", group: :development, require: false

data/Gemfile.lock

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    datatrans (5.2.0)
+      activesupport (>= 5.2)
+      builder
+      httparty
+      i18n
+      multi_xml (>= 0.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (6.1.5)
+      actionview (= 6.1.5)
+      activesupport (= 6.1.5)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.1.5)
+      activesupport (= 6.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    erubi (1.10.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.16.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.15.0)
+    multi_xml (0.6.0)
+    nokogiri (1.13.4)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.4-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.28.5)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  actionpack (>= 5.2)
+  appraisal
+  datatrans!
+  rake
+  rspec
+  simplecov
+  standard
+
+BUNDLED WITH
+   2.3.3

data/README.markdown

@@ -31,6 +31,10 @@ Possible values for the environment: `:production`, `:development`
 Web Authorization
 =================
 
+> [!IMPORTANT]
+>
+> Datatrans no longer supports the Payment Page API. The support in this gem will be removed in the next major release. Please use the [JSON API](#json-transactions) instead.
+
 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).
@@ -98,12 +102,24 @@ 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).
+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 devices).
 
-Authorize
+Saving Payment Information
+--------------------------
+
+According to the [docs](https://docs.datatrans.ch/docs/customer-initiated-payments#saving-payment-information), there are three possible flows:
+
+- **Customer Initiated Payments**: _Your customer pays and nothing is registered._
+  - This is the most basic setup and does _not_ save any payment information: First, call `transaction.init`, and then redirect the user to the `transaction_path` (see the sections `Initialize` and `Start a transaction` below).
+- **Customer Initiated Payment** and creating an `alias` for subsequent **Merchant Initiated Payments**: _Your customer pays and the card or payment method information is registered. You receive an alias which you save for later merchant initiated payments or one-click checkouts._
+  - In order to save payment information after your customer has finalized their payment, without them having to re-enter their payment information and go through the 3D-Secure flow, pass `option: {"createAlias": true}`. More information can be found [here](https://docs.datatrans.ch/docs/redirect-lightbox#saving-payment-information).
+- **Merchant Initiated Payments**: _Your customer registers their card or payment method information without any payment. Their account is not charged. This is what we call a dedicated registration._
+  - This setup allows you to save a customers payment information without any charge in the beginning. This is useful in the context of setting up a subscription model (e.g., usage-based billing at the end of a billing period). See the section `Merchant Initiated Payments` below.
+
+Initialize
 ---------
 
-Authorize JSON transaction:
+Initialize a JSON transaction:
 
 ```ruby
 transaction = datatrans.json_transaction(
@@ -116,9 +132,9 @@ transaction = datatrans.json_transaction(
   error_url: <your_application_return_url>
 )
 
-# call to init endpoint to initialize a transaction
+# call to initialize endpoint to initialize a transaction
 # returns true or false depending if response was successful or not
-init = transaction.authorize
+init = transaction.init
 
 # successful authorization call returns in response a transaction id
 if init
@@ -139,7 +155,7 @@ Once you have a transaction id, you can start a transaction. Users of your appli
  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.
+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. This can be overridden by setting `auto_settle: false` when authorizing a transaction.
 
 Transaction status
 ------------------
@@ -196,11 +212,58 @@ You can check the trasaction [status](https://api-reference.datatrans.ch/#tag/v1
   end
 ```
 
+Merchant Initiated Payments
+---------
+
+It's possible to authorize transactions without user interaction, via [merchant initiated payments](https://docs.datatrans.ch/docs/merchant-initiated-payments).
+
+To perform a so-called "dedicated registration" (so we can later charge the card via its `alias`), you should follow the same steps as described above, but not provide an amount:
+
+```ruby
+transaction = datatrans.json_transaction(
+  refno: 'ABCDEF',
+  amount: 0, # omit amount for dedicated registrations
+  currency: "CHF",
+  payment_methods: ["ECA", "VIS"],
+  success_url: <your_application_return_url>,
+  cancel_url: <your_application_return_url>,
+  error_url: <your_application_return_url>
+)
+
+init = transaction.init
+
+# successful authorization call returns in response a transaction id
+if init
+  transaction_id = transaction.response.params["transactionId"]
+end
+```
+
+Then, at a later point in time, and without needing any user interaction, you can create a payment via `merchant_authorize`:
+
+```ruby
+dedicated_registration = datatrans.json_transaction(transaction_id: transaction_id)
+dedicated_registration.status # this will contain the card information
+
+card_alias = dedicated_registration.response.params["card"]["alias"]
+card_expiry_month = dedicated_registration.response.params["card"]["expiryMonth"]
+card_expiry_year = dedicated_registration.response.params["card"]["expiryYear"]
+
+transaction = datatrans.json_transaction(
+  refno: "ABCDEF",
+  amount: 1000,
+  currency: "CHF",
+  card: {alias: card_alias, expiryMonth: card_expiry_month, expiryYear: card_expiry_year}
+)
+
+transaction.merchant_authorize # this will charge the card without user interaction
+```
 
 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.
+> [!IMPORTANT]
+>
+> Datatrans will stop supporting the XML API on June 3rd, 2024. The support in this gem will be removed in the next major release. Please use the [JSON API](#json-transactions) instead.
 
 If you have already a credit card alias or an authorized transaction you can
 use the convenient XML methods to process payments.

data/Rakefile

@@ -1,5 +1,5 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new("spec")
-task :default => :spec
+task default: :spec

data/datatrans.gemspec

@@ -1,34 +1,32 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "datatrans/version"
 
 Gem::Specification.new do |s|
-  s.name        = "datatrans"
-  s.version     = Datatrans::VERSION
-  s.authors     = ["Tobias Miesel", "Thomas Maurer", "Corin Langosch", "Pascal Betz"]
-  s.email       = ["info@simplificator.com"]
-  s.homepage    = ""
-  s.summary     = %q{Datatrans Integration for Ruby on Rails}
-  s.description = %q{Datatrans Integration for Ruby on Rails}
+  s.name = "datatrans"
+  s.version = Datatrans::VERSION
+  s.authors = ["Tobias Miesel", "Thomas Maurer", "Corin Langosch", "Pascal Betz"]
+  s.email = ["info@simplificator.com"]
+  s.homepage = ""
+  s.summary = "Datatrans Integration for Ruby on Rails"
+  s.description = "Datatrans Integration for Ruby on Rails"
 
   s.rubyforge_project = "datatrans"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.required_ruby_version = '>= 2.6'
+  s.required_ruby_version = ">= 2.6"
 
-  s.add_dependency 'httparty'
-  s.add_dependency 'activesupport', '>= 5.2'
-  s.add_dependency 'i18n'
-  s.add_dependency 'builder'
-  s.add_dependency 'multi_xml', '>= 0.5.1'
+  s.add_dependency "httparty"
+  s.add_dependency "activesupport", ">= 5.2"
+  s.add_dependency "i18n"
+  s.add_dependency "builder"
+  s.add_dependency "multi_xml", ">= 0.5.1"
 
-  s.add_development_dependency 'actionpack', '>= 5.2'
-  s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.license = 'MIT'
+  s.add_development_dependency "actionpack", ">= 5.2"
+  s.add_development_dependency "appraisal"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.license = "MIT"
 end

data/gemfiles/rails_5_2.gemfile

@@ -3,10 +3,10 @@
 source "http://rubygems.org"
 
 gem "simplecov", group: :test, require: nil
-gem "activesupport", "~> 5.2"
+gem "activesupport", "~> 5.2.0"
 
 group :development, :test do
-  gem "actionpack", "~> 5.2"
+  gem "actionpack", "~> 5.2.0"
 end
 
 gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -3,10 +3,10 @@
 source "http://rubygems.org"
 
 gem "simplecov", group: :test, require: nil
-gem "activesupport", "~> 6.0"
+gem "activesupport", "~> 6.0.0"
 
 group :development, :test do
-  gem "actionpack", "~> 6.0"
+  gem "actionpack", "~> 6.0.0"
 end
 
 gemspec path: "../"

data/gemfiles/rails_6_1.gemfile

@@ -3,10 +3,10 @@
 source "http://rubygems.org"
 
 gem "simplecov", group: :test, require: nil
-gem "activesupport", "~> 6.1"
+gem "activesupport", "~> 6.1.0"
 
 group :development, :test do
-  gem "actionpack", "~> 6.1"
+  gem "actionpack", "~> 6.1.0"
 end
 
 gemspec path: "../"

data/gemfiles/rails_7_0.gemfile

@@ -3,10 +3,10 @@
 source "http://rubygems.org"
 
 gem "simplecov", group: :test, require: nil
-gem "activesupport", "~> 7.0"
+gem "activesupport", "~> 7.0.0"
 
 group :development, :test do
-  gem "actionpack", "~> 7.0"
+  gem "actionpack", "~> 7.0.0"
 end
 
 gemspec path: "../"

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "simplecov", group: :test, require: nil
+gem "activesupport", "~> 7.1.0"
+
+group :development, :test do
+  gem "actionpack", "~> 7.1.0"
+end
+
+gemspec path: "../"

data/lib/datatrans/common.rb

@@ -1,10 +1,10 @@
-require 'openssl'
+require "openssl"
 
 module Datatrans::Common
   def sign(*fields)
-    return nil unless self.datatrans.sign_key
-    key = self.datatrans.sign_key.split(/([a-f0-9][a-f0-9])/).reject(&:empty?)
+    return nil unless datatrans.sign_key
+    key = datatrans.sign_key.split(/([a-f0-9][a-f0-9])/).reject(&:empty?)
     key = key.pack("H*" * key.size)
-    OpenSSL::HMAC.hexdigest(OpenSSL::Digest::MD5.new, key, fields.join)
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new("MD5"), key, fields.join)
   end
-end
+end