zaala 0.1.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23d2b71b2a1a767732f1e981ec456ee03d30dfa9aae6da0b331d7f19aee61050
-  data.tar.gz: 060b17d5d44dda277f3c463358f94083dc03e8f55ae75715ea13322b37298208
+  metadata.gz: e4509ce6426dfdc533917459dfe74aaf5188c04c0de9ba8d6179871a44e1e29c
+  data.tar.gz: f4e4c1a148ef03541b42bd721c11d270749fcd632b53397f3b91d1fb240395b7
 SHA512:
-  metadata.gz: 91778343fc0ee1a12d34e217e72b6486330a4533d28fd0654a0a9ad900b12769731bcd88e453d49a48c17d7686201c148d1cb473abf46498ffb0d82186f1fa86
-  data.tar.gz: '085382d92b9b1e165d10e071fa1fe0fa5486c3024b8a8848b6074507ee5b775ed95e88437fda5b07e8dd34cc89a90bf58ff7aaf5f80e0b4de6c6b35cf1d02a4c'
+  metadata.gz: 3f214835a9a492b5fc289b7d547ea8324ab637e31b3f845afc380328a6db01af22afb37d3bcd461b0ae8c836acd97117ae220c83074f662ae67561925d02e1db
+  data.tar.gz: 79083f534a65c849311cf8e96a0ed2bc89ca5df09b8511240fd9df0de8a0d15a751f9fbe56b1f79596100533d538eb6dfa0f6a4f4738c0a4af49d4dd358a28c2

data/lib/zaala/api/client.rb

@@ -13,8 +13,8 @@ module Zaala::API
       symbolize_keys = lambda { |key| key.to_sym }
       params = {
         wsdl: wsdl,
-        open_timeout: 30, # in seconds
-        read_timeout: 30, # in seconds
+        open_timeout: 30, # seconds
+        read_timeout: 30, # seconds
         convert_response_tags_to: symbolize_keys,
         log: log,
         proxy: proxy
@@ -43,14 +43,8 @@ module Zaala::API
       ensure_operation_exists(:pre_authorize)
       raise BadRequestError.new("pre_authorize operation requires an AuthorizationRequest parameter") unless req.is_a?(AuthorizationRequest)
 
-      @kar.call(:pre_authorize) do
-        message(authorizationRequest: req.to_message)
-      end
-    rescue Savon::SOAPFault => e
-      # IS0003
-      # TODO: Extract error code from response body
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
+      res = call(:pre_authorize, authorizationRequest: req.to_message)
+      AuthorizationResponse.from_message(res.body[:preAuthorizeResponse][:return])
     end
 
     # Authorizes a purchase transaction.
@@ -58,13 +52,8 @@ module Zaala::API
       ensure_operation_exists(:authorize)
       raise BadRequestError.new("authorize operation requires an AuthorizationRequest parameter") unless req.is_a?(AuthorizationRequest)
 
-      res = @kar.call(:authorize) do
-        message(authorizationRequest: req.to_message)
-      end
+      res = call(:authorize, authorizationRequest: req.to_message)
       AuthorizationResponse.from_message(res.body[:authorizeResponse][:return])
-    rescue Savon::SOAPFault => e
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
     end
 
     # Cancel a previous reservation of funds.
@@ -72,12 +61,8 @@ module Zaala::API
       ensure_operation_exists(:cancel_authorization)
       raise BadRequestError.new("cancel_authorization operation requires a CancellationRequest parameter") unless req.is_a?(CancellationRequest)
 
-      @kar.call(:cancel_authorization) do
-        message(cancellationRequest: req.to_message)
-      end
-    rescue Savon::SOAPFault => e
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
+      res = call(:cancel_authorization, cancellationRequest: req.to_message)
+      CancellationResponse.from_message(res.body[:cancelAuthorizationResponse][:return])
     end
 
     # Perform a solvency check.
@@ -85,12 +70,8 @@ module Zaala::API
       ensure_operation_exists(:check)
       raise BadRequestError.new("check operation requires a CheckRequest parameter") unless req.is_a?(CheckRequest)
 
-      @kar.call(:check) do
-        message(checkRequest: req.to_message)
-      end
-    rescue Savon::SOAPFault => e
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
+      res = call(:check, checkRequest: req.to_message)
+      CheckResponse.from_message(res.body[:checkResponse][:return])
     end
 
     # Returns available information about an authorization-ID.
@@ -98,13 +79,8 @@ module Zaala::API
       ensure_operation_exists(:info)
       raise BadRequestError.new("info operation requires an InfoRequest parameter") unless req.is_a?(InfoRequest)
 
-      @kar.call(:info) do
-        message(infoRequest: req.to_message)
-      end
-    rescue Savon::SOAPFault => e
-      # TODO: Extract error code from response body
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
+      res = call(:info, infoRequest: req.to_message)
+      InfoResponse.from_message(res.body[:infoResponse][:return])
     end
 
     # Verifies the given MTAN.
@@ -112,13 +88,8 @@ module Zaala::API
       ensure_operation_exists(:verify)
       raise BadRequestError.new("info operation requires a VerifyRequest parameter") unless req.is_a?(VerifyRequest)
 
-      @kar.call(:verify) do
-        message(verifyRequest: req.to_message)
-      end
-    rescue Savon::SOAPFault => e
-      # TODO: Extract error code from response body
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
+      res = call(:verify, verifyRequest: req.to_message)
+      VerifyResponse.from_message(res.body[:verifyResponse][:return])
     end
 
     # Submits a purchase transaction with a previous authorization of funds.
@@ -126,14 +97,8 @@ module Zaala::API
       ensure_operation_exists(:submit_authorization)
       raise BadRequestError.new("info operation requires a SubmissionRequest parameter") unless req.is_a?(SubmissionRequest)
 
-      res = @kar.call(:submit_authorization) do
-        message(submissionRequest: req.to_message)
-      end
+      res = call(:submit_authorization, submissionRequest: req.to_message)
       SubmissionResponse.from_message(res.body[:submitAuthorizationResponse][:return])
-    rescue Savon::SOAPFault => e
-      # TODO: Extract error code from response body
-      # e.g. (The content of at least one field is invalid and did not pass the validation)
-      raise BadRequestError.new(e)
     end
 
     # Authorizes a credit transaction.
@@ -144,6 +109,33 @@ module Zaala::API
 
     private
 
+    def call(request, attributes)
+      @kar.call(request) do
+        message(attributes)
+      end
+    rescue Savon::SOAPFault => e
+      # Extract permission errors
+      maybe_raise_authentication_error(e.to_hash[:Fault])
+      # Extract bad request errors
+      maybe_raise_invalid_fields(e.to_hash[:Fault])
+      # Fallback to standard errors
+      raise StandardError, e.to_hash.dig(:Fault, :faultstring)
+    end
+
+    def maybe_raise_authentication_error(fault)
+      code = fault.dig(:detail, :serverFaultMessage, :code)
+      raise PermissionError.new(fault[:faultstring]) if code == 'IS0003'
+    end
+
+    def maybe_raise_invalid_fields(fault)
+      fields = fault.dig(:detail, :invalidFieldsFaultMessage, :invalidFields)
+      fields = [fields] if fields.kind_of?(Hash)
+      return [] unless fields.kind_of?(Array)
+
+      fields = fields.map { |f| FieldViolation.new(f[:code], f[:message]) }
+      raise BadRequestError.new(fault[:faultstring], fields) unless fields.empty?
+    end
+
     def ensure_operation_exists(op)
       raise(UnsupportedServiceEndpoint, op) unless @kar.operations.include?(op)
     end

data/lib/zaala/api/error.rb

@@ -1,7 +1,21 @@
 module Zaala::API
   class MissingError < StandardError
   end
+  class FieldViolation
+    attr_reader :field, :description
+
+    def initialize(field, description)
+      @field = field
+      @description = description
+    end
+  end
   class BadRequestError < StandardError
+    attr_reader :fields
+
+    def initialize(msg, fields = [])
+      super(msg)
+      @fields = fields
+    end
   end
   class PermissionError < StandardError
   end

data/lib/zaala/api/types.rb

@@ -470,9 +470,6 @@ module Zaala::API
     # The content of the attachment (base64 encoded).
     attribute :value, Types::Strict::String
 
-    def from_file
-    end
-
     def self.from_message(h)
       Attachment.new({
         name: h[:name],
@@ -483,8 +480,8 @@ module Zaala::API
 
     def to_message
       {
-        name: name,
-        mimeType: mime_type,
+        :@name => name,
+        :@mimeType => mime_type,
         value: value
       }
     end
@@ -695,7 +692,7 @@ module Zaala::API
         identifier: identifier.to_message,
         basket: basket.to_message,
         additionalData: additional_data.to_message,
-        attachments: attachments.map(&:to_message),
+        attachment: attachments.map(&:to_message),
       }
     end
   end
@@ -804,7 +801,7 @@ module Zaala::API
       {
         identifier: identifier.to_message,
         additionalData: additional_data.to_message,
-        verificationCode: verification_code,
+        verificationCode: verification_code
       }
     end
   end
@@ -830,4 +827,50 @@ module Zaala::API
       })
     end
   end
+
+  class CheckRequest < Dry::Struct
+    # Environment parameters and information to identify the caller.
+    attribute :identifier, Zaala::API::RequestIdentifier
+    # Personal data of the customer.
+    attribute :personal_data, Zaala::API::PersonalData
+    # Invoice address of the purchase.
+    attribute :invoice_address, Zaala::API::InvoiceAddress
+    # Key-value pairs holding information of the service's client (e.g. IPv4 address).
+    # attribute :client_info, Zaala::API::ClientInfo
+    # Requested amount of the preauthorization/authorization.
+    # It corresponds to the total amount, which has to be authorized.
+    # Mandatory if no Basket is provided in the request.
+    # (IF0001) If a Basket is provided in the request, this value is ignored.
+    attribute :requested_amount, Types::Strict::Float
+    # Additional purchase related information.
+    attribute :additional_data, Zaala::API::AdditionalData
+
+    def to_message
+      {
+        identifier: identifier.to_message,
+        personal_data: personal_data.to_message,
+        invoice_address: invoice_address.to_message,
+        requested_amount: requested_amount,
+        additional_data: additional_data.to_message
+      }
+    end
+  end
+
+  class CheckResponse < Dry::Struct
+    # Contains information to identify the authorization in a future request.
+    attribute :identifier, Zaala::API::ResponseIdentifier
+    # Contains additional information concerning the authorization.
+    attribute :decision, Zaala::API::Decision
+
+    # Contains additional information concerning the authorization.
+    attribute :info, Zaala::API::Info.optional.default(nil)
+
+    def self.from_message(h)
+      VerifyResponse.new({
+        identifier: Zaala::API::ResponseIdentifier.from_message(h[:identifier]),
+        decision: Zaala::API::Decision.from_message(h[:decision]),
+        info: h[:info] ? Zaala::API::Info.from_message(h[:info]) : nil,
+      })
+    end
+  end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: zaala
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Denteo AG
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: dry-struct
+  name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ homepage: https://rubygems.org/gems/zaala
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Ruby client interacting with Zaala
 test_files: []