datatrans 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0cd93431049ffc3deba79d3c594ae93aff9e6fd91dc158ad0a68ae1e766a83e
-  data.tar.gz: c67ba41b81de8adfbe9962cb85c80e881a57b69490972dae577f93e269935659
+  metadata.gz: eb01c19e9afe3aecaa82ff08e7e9024fefb8c60d3cab86fbd3400e4598879dcd
+  data.tar.gz: 13a9c7a7068610907a8123c11cf50f60014f79b5de6db2b51f763a5509159fb3
 SHA512:
-  metadata.gz: 2bf90e36d3ef096f0904cc03309931408d1e26c23761645de6e46ce1588c350850d4466127c7443408eddf2a3475b48a2fd4db69fa761779a2a15d0e5d37031c
-  data.tar.gz: eb8aa923a6599f0cbf10b4ed1fc2fc76e3068fbbd589768635f4d89e55063072c2c691f8a91504c04fb4eec761d798b92ad4522000094b932d775c5c195be6aa
+  metadata.gz: b8d2cc670be21be5336b8856eca9603ef8351be8ebc9e8e19efca2486a2304d7a8701fcabeea629285434dcd4b6c99cf8f53b8382870cbd0a7dbf38db7b6ded2
+  data.tar.gz: a13b4a7a1934bfa437209b9eb53b2c8bba45d3e0c7e24cb699e8544c7d2af67d6497a0a1c885e3d6af034030b3b0b077d5928a4e8e6577a2b606824c1752be22

data/CHANGELOG.md

@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## 5.0.0 - 2022-09-21
+
+### Changed
+
+* [BREAKING CHANGE] Authenticate requests with HTTP Basic Auth (@crackofdusk [#41](https://github.com/simplificator/datatrans/pull/41))
+
+  Datatrans requires [HTTP Basic Auth for XML API calls](https://api-reference.datatrans.ch/xml/#authentication-tls) since 2022-09-14 ([announcement](https://mailchi.mp/datatrans/basic-authsign2_1-email_en))
+
+## 4.0.1 - 2022-03-18
+### Fixed
+* Check for successful transaction depends on `status` and not on `response_message` that can be diferent for different payment methods (@schmijos [#8](https://github.com/simplificator/datatrans/pull/8) and @TatianaPan [#39](https://github.com/simplificator/datatrans/pull/39))
 ## 4.0.0 - 2022-02-25
 ### Changed
 * [BREAKING CHANGE] Bump minimum required Ruby version to 2.6 and Rails to 5.2 (@andyundso [#34](https://github.com/simplificator/datatrans/pull/34))

data/README.markdown

@@ -11,6 +11,7 @@ Build your Datatrans Configuration like so:
     datatrans = Datatrans::Config.new(
       :merchant_id => '1234567',
       :sign_key => 'ab739fd5b7c2a1...',
+      :password => 'server to server request password',
       :environment => :production,
       :proxy => {
         :http_proxyaddr => "proxy.com",

data/lib/datatrans/config.rb

@@ -11,10 +11,11 @@ module Datatrans
     }
     DOMAIN = 'datatrans.com'
 
-    attr_reader :environment, :merchant_id, :sign_key, :proxy
+    attr_reader :environment, :merchant_id, :sign_key, :password, :proxy
 
     # Configure with following options
     # * :merchant_id (required)
+    # * :password (required)
     # * :sign_key (defaults to false)
     # * :environment (defaults to :development, available environments are defined in ENVIRONMENTS)
     # * :proxy (a hash containing :http_proxyaddr, :http_proxyport, :http_proxyuser, :http_proxypass)
@@ -22,6 +23,8 @@ module Datatrans
       @merchant_id = options[:merchant_id]
       raise ArgumentError.new(":merchant_id is required") unless self.merchant_id
       self.environment = options[:environment] || DEFAULT_ENVIRONMENT
+      @password = options[:password]
+      raise ArgumentError.new(":password is required") unless self.password
       @sign_key = options[:sign_key] || DEFAULT_SIGN_KEY
       @proxy = options[:proxy] || {}
     end

data/lib/datatrans/version.rb

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

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

@@ -9,7 +9,7 @@ class Datatrans::Web::Transaction
 
     def successful?
       raise Datatrans::InvalidSignatureError unless valid_signature?
-      response_code == '01' && response_message == 'Authorized' && !errors_occurred?
+      response_code == '01' && status == 'success' && !errors_occurred?
     end
 
     def valid_signature?
@@ -18,6 +18,10 @@ class Datatrans::Web::Transaction
       sign(self.datatrans.merchant_id, params[:amount], params[:currency], params[:uppTransactionId]) == params[:sign2]
     end
 
+    def status
+      params[:status] rescue nil
+    end
+
     def response_code
       params[:responseCode] rescue nil
     end
@@ -79,4 +83,4 @@ class Datatrans::Web::Transaction
 
     include Datatrans::Common
   end
-end
+end

data/lib/datatrans/xml/transaction/request.rb

@@ -7,7 +7,9 @@ class Datatrans::XML::Transaction
     attr_accessor :params, :datatrans
 
     def post(url, options = {})
-      options = options.merge(self.datatrans.proxy)
+      options = options
+        .merge(self.datatrans.proxy)
+        .merge(:basic_auth => { :username => self.datatrans.merchant_id, :password => self.datatrans.password })
       HTTParty.post(url, **options)
     end
 
@@ -39,4 +41,4 @@ class Datatrans::XML::Transaction
       xml.target!
     end
   end
-end
+end

data/spec/config_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Datatrans::Config do
   describe "Instance Methods" do
     before do
-      @datatrans = Datatrans::Config.new(:merchant_id => "xxx")
+      @datatrans = Datatrans::Config.new(:merchant_id => "xxx", :password => "yyy")
     end
 
     describe "web_transaction" do

data/spec/spec_helper.rb

@@ -15,6 +15,7 @@ RSpec.configure do |config|
     @datatrans = Datatrans::Config.new(
       :merchant_id => '1100000000',
       :sign_key => 'd777c17ba2010282c2d2350a68b441ca07a799d294bfaa630b7c8442207c0b69703cc55775b0ca5a4e455b818a9bb10a43669c0c20ce31f4a43f10e0cabb9525',
+      :password => 'basic_auth_password',
       :environment => :development
     )
   end

data/spec/web/authorize_spec.rb

@@ -31,6 +31,12 @@ describe Datatrans::Web::Transaction do
       :acqAuthorizationCode => "173520"
     }
 
+    @successful_swisspost_response = @successful_response.merge({
+      :pmethod => "PFC",
+      :txtEp2TrxID => "7777777000000001",
+      :responseMessage => "YellowPay transaction Ok"
+    })
+
     @failed_response = {
       :status => "error",
       :returnCustomerCountry => "CHE",
@@ -78,7 +84,7 @@ describe Datatrans::Web::Transaction do
     end
 
     it 'should generate valid form field string' do
-      if Gem.loaded_specs['activesupport'].version >= Gem::Version.create('7.0')
+      if Gem.loaded_specs['activesupport'].version >= Gem::Version.create('6.0')
         expected_output = '<input type="hidden" name="merchantId" id="merchantId" value="1100000000" autocomplete="off" /><input type="hidden" name="hiddenMode" id="hiddenMode" value="yes" autocomplete="off" /><input type="hidden" name="reqtype" id="reqtype" value="NOA" autocomplete="off" /><input type="hidden" name="amount" id="amount" value="1000" autocomplete="off" /><input type="hidden" name="currency" id="currency" value="CHF" autocomplete="off" /><input type="hidden" name="useAlias" id="useAlias" value="yes" autocomplete="off" /><input type="hidden" name="sign" id="sign" value="0402fb3fba8c6fcb40df9b7756e7e637" autocomplete="off" /><input type="hidden" name="refno" id="refno" value="ABCDEF" autocomplete="off" /><input type="hidden" name="uppCustomerDetails" id="uppCustomerDetails" autocomplete="off" /><input type="hidden" name="uppCustomerEmail" id="uppCustomerEmail" value="customer@email.com" autocomplete="off" />'
       else
         expected_output = '<input type="hidden" name="merchantId" id="merchantId" value="1100000000" /><input type="hidden" name="hiddenMode" id="hiddenMode" value="yes" /><input type="hidden" name="reqtype" id="reqtype" value="NOA" /><input type="hidden" name="amount" id="amount" value="1000" /><input type="hidden" name="currency" id="currency" value="CHF" /><input type="hidden" name="useAlias" id="useAlias" value="yes" /><input type="hidden" name="sign" id="sign" value="0402fb3fba8c6fcb40df9b7756e7e637" /><input type="hidden" name="refno" id="refno" value="ABCDEF" /><input type="hidden" name="uppCustomerDetails" id="uppCustomerDetails" /><input type="hidden" name="uppCustomerEmail" id="uppCustomerEmail" value="customer@email.com" />'
@@ -101,6 +107,19 @@ describe Datatrans::Web::Transaction do
     end
   end
 
+  context "successful response (swiss post)" do
+    before do
+      allow_any_instance_of(Datatrans::Web::Transaction::AuthorizeResponse).to receive(:params).and_return(@successful_swisspost_response)
+    end
+
+    context "process" do
+      it "handles a valid datatrans authorize response" do
+        @transaction = Datatrans::Web::Transaction.new(@datatrans, @valid_params)
+        expect(@transaction.authorize).to be true
+      end
+    end
+  end
+
   context "compromised response" do
     before do
       fake_response = @successful_response

data/spec/xml/request_spec.rb

@@ -7,6 +7,7 @@ describe Datatrans::XML::Transaction::Request do
         @datatrans = Datatrans::Config.new(
           :merchant_id => '1100000000',
           :sign_key => 'd777c17ba2010282c2d2350a68b441ca07a799d294bfaa630b7c8442207c0b69703cc55775b0ca5a4e455b818a9bb10a43669c0c20ce31f4a43f10e0cabb9525',
+          :password => 'basic_auth_password',
           :key => "value",
           :proxy => {
             :http_proxyaddr => "proxy.com",
@@ -21,6 +22,7 @@ describe Datatrans::XML::Transaction::Request do
       it "forward those options to HTTParty" do
         request = Datatrans::XML::Transaction::Request.new(@datatrans, {})
         expect(HTTParty).to receive(:post).with('lirum',
+         :basic_auth => {:password => 'basic_auth_password', :username => '1100000000'},
          :params => {:foo => :bar},
            :http_proxpass => 'xxx',
            :http_proxyuser => 'hans',
@@ -33,7 +35,7 @@ describe Datatrans::XML::Transaction::Request do
     describe "not configured" do
       it "should not add any proxy settings" do
         request = Datatrans::XML::Transaction::Request.new(@datatrans, {})
-        expect(HTTParty).to receive(:post).with('lirum', :params => {:foo => :bar})
+        expect(HTTParty).to receive(:post).with('lirum', :basic_auth => {:password => 'basic_auth_password', :username => '1100000000'}, :params => {:foo => :bar})
         request.post('lirum', :params => {:foo => :bar})
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datatrans
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Tobias Miesel
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty