barion 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 611496f7b1fb886173917b2602801c6e06616157386e1946fc3c126daa5e8e91
-  data.tar.gz: c9190682e267624f4f3a05e597255ec136a023385d74c3a1eabd547f1eb26510
+  metadata.gz: 18b5fa982b714053631efb5c9827a00d72fa965a9e864f8f4e2e1db810d451c7
+  data.tar.gz: 8edc1391bcb596b9566621fe4b5954188b99808c4840e8cadca8102ef5d567de
 SHA512:
-  metadata.gz: 30784325a4ad023aa0582ca59430ff5e7609e6020dbb2548afe70aa026eb9c0abd4ad375f2aea57fcb8e8d0b4a115c1dbee99b99dd24cd8c887616ea70b31fbc
-  data.tar.gz: 543aa965c0e8695bac259823c0f0b8f820debf428053f4a68ee6dd7837800a986c0574592c2e62b0c29dc742ebb7f43ade6c8af7b8507f3623662d5b486c0b62
+  metadata.gz: 9580e31fa373aae0ea5e9f828eaf26133a614f6818ab93ecb6db646d0d4af65339e9e3f7a5328597910a82314c05a15a4d550a74394c88d5fa48e519150f9cce
+  data.tar.gz: 3e9b2780bda61403434b742dc02b29263ae8adeccbab05dc5eed7ff57bc45fc7b08a4fda6b40b9798e88591bd87d75dea7684f766b8dbfcfac4ceea060367ad0

data/README.md

@@ -44,6 +44,8 @@ Just create a file in `config/initializers/barion.rb` with the below content:
 end
 ```
 
+The configuration is also available in the Rail application configuration under ```Rails.application.config.barion```.
+
 #### POSKey and PublicKey (default: empty)
 
 You can find your `POSKey` and `PublicKey` at the  Barion Shop website:
@@ -203,7 +205,7 @@ error.endpoint # Holds the value of Endpoint attribute of the API error
 
 When a payment has been sent to the gateway it will become readonly for Rails. Only the Gateway is allowed to change its state trough the callbacks.
 
-To achieve this, a has is calculated for every payment when validating it. This hash will be stored in the DB and when a record is loaded in Rails it will be checked against the stored hash. If the hash does not match with the stored data a `::Barion::TamperedData` exception will be raised and the record will not be loaded. This basically mean that the data in the DB has been tampered outside this gem and cannot be considered financially safe.
+To achieve this, a hash is calculated for every payment when validating it. This hash will be stored in the DB and when a record is loaded in Rails it will be checked against the stored hash. If the hash does not match with the stored data a `::Barion::TamperedData` exception will be raised and the record will not be loaded. This basically mean that the data in the DB has been tampered outside this gem and cannot be considered financially safe.
 
 ## Contributing
 

data/app/models/barion/item.rb

@@ -72,7 +72,7 @@ module Barion
 
     def item_total=(value)
       value = calculate_total if value.nil?
-      super(value)
+      super
     end
 
     private

data/app/models/barion/payment.rb

@@ -168,7 +168,7 @@ module Barion
 
     def poskey=(value = nil)
       value = ::Barion.config.poskey if value.nil?
-      super(value)
+      super
     end
 
     def payment_type=(value)
@@ -183,7 +183,7 @@ module Barion
       else
         raise ArgumentError, "#{value} is not a valid payment_type"
       end
-      super(value)
+      super
     end
 
     def payer_work_phone_number=(number)
@@ -281,7 +281,7 @@ module Barion
 
     # rubocop:disable Lint/UselessMethodDefinition
     def checksum=(value)
-      super(value)
+      super
     end
     # rubocop:enable Lint/UselessMethodDefinition
 

data/app/models/barion/payment_transaction.rb

@@ -85,7 +85,7 @@ module Barion
 
     def total=(value)
       value = calc_item_totals if value.nil?
-      super(value)
+      super
     end
 
     def serialize_options

data/config/initializers/barion.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-# ::Barion.config do |shop|
+# Barion.config do |shop|
+#  shop.pixel_id = 'BP-0000000000-00'
 #  shop.poskey = 'test'
 #  shop.publickey = 'test2'
 #  shop.sandbox = true

data/lib/barion/config.rb

@@ -7,18 +7,40 @@ module Barion
   class Config
     include Singleton
 
-    attr_accessor :publickey, :default_payee
+    # @!attribute [rw] publickey
+    #   Set this to the string provided by Barion registration
+    #   @return [String, nil] the public key provided by Barion (default: nil)
+    attr_accessor :publickey
+    # @!attribute [rw] default_payee
+    #   Set this to the registered email address of your shop
+    #   @return [String, nil] registered email address for your Barion shop (default: nil)
+    attr_accessor :default_payee
+    # @!attribute [w] acronym
+    #   Set this to the string provided by Barion registration
+    #   @return [String, nil] the acronym provided by Barion (default: '')
     attr_writer :acronym
+    # @!attribute [r] pixel_id
+    #   The pixel ID set up in the initalizer
+    #   @return [String, nil] the acronym provided by Barion (default: '')
     attr_reader :pixel_id
 
+    # @!attribute [r] poskey
+    #   The POSKey set up in the initalizer
+    #   @return [String, nil] the POSKey provided by Barion (default: nil)
     def poskey
       @_poskey || nil
     end
 
+    # The acronym set up in the initalizer
+    # @return [String] the acronym provided by Barion (default: '')
     def acronym
       @acronym || ''
     end
 
+    # Set the POSKey for the shop
+    #
+    # @param key [String] the POSKey provided by Barion
+    # @raise [ArgumentError] if the key is not a String
     def poskey=(key)
       unless key.is_a?(String)
         raise ArgumentError,
@@ -28,25 +50,46 @@ module Barion
       @_poskey = key
     end
 
+    # Returns the current sandbox mode setting.
+    # Delegates to the sandbox? method to determine the current state.
+    #
+    # @return [Boolean] true if in sandbox mode, false otherwise
     def sandbox
       sandbox?
     end
 
+    # Returns the current sandbox mode setting.
+    #
+    # If the sandbox mode was not set explicitly, it defaults to true.
+    #
+    # @return [Boolean] true if in sandbox mode, false otherwise
     def sandbox?
       @_sandbox = true if @_sandbox.nil?
       @_sandbox
     end
 
+    # Sets the sandbox mode.
+    #
+    # @param val [Boolean] the desired state for sandbox mode
+    #   true to enable sandbox mode, false to disable it
     def sandbox=(val)
       @_sandbox = !!val
     end
 
+    # Sets the Barion Pixel ID.
+    #
+    # Validates that the provided ID is a string and matches the Barion Pixel ID format.
+    #
+    # @param id [String] the Barion Pixel ID to set
+    # @raise [ArgumentError] if the ID is not a string or does not match the expected format
     def pixel_id=(id)
       unless id.is_a?(String)
         raise ArgumentError,
               "::Barion::Config.pixel_id must be set to a ::String, got #{id.inspect}"
       end
 
+      return if id.empty?
+
       if PIXELID_PATTERN.match(id).nil?
         raise ::ArgumentError,
               "String:'#{id}' is not in Barion Pixel ID format: 'BP-0000000000-00'"
@@ -55,11 +98,25 @@ module Barion
       @pixel_id = id
     end
 
+    # Returns the REST client endpoint based on the current environment.
+    #
+    # Determines the environment by checking if the sandbox mode is enabled.
+    # If sandbox mode is enabled, the test environment URL is used; otherwise,
+    # the production environment URL is used.
+    #
+    # @return [Object] a new instance of the REST client class initialized with
+    #   the appropriate base URL for the current environment.
     def endpoint
       env = sandbox? ? :test : :prod
       rest_client_class.new ::Barion::BASE_URL[env]
     end
 
+    # Sets the user class used for user authentication.
+    #
+    # Validates that the provided user class is a string.
+    #
+    # @param class_name [String] the user class to use for user authentication
+    # @raise [ArgumentError] if the user class is not a string
     def user_class=(class_name)
       unless class_name.is_a?(String)
         raise ArgumentError, "::Barion:.config.user_class must be set to a ::String, got #{class_name.inspect}"
@@ -68,6 +125,9 @@ module Barion
       @_user_class = class_name
     end
 
+    # Returns the user class set in the initializer.
+    #
+    # @return [Class] the class set in the initializer
     def user_class
       # This is nil before the initializer is installed.
       return nil if @_user_class.nil?
@@ -75,6 +135,9 @@ module Barion
       @_user_class.constantize
     end
 
+    # Sets the class used for item representation.
+    #
+    # @param val [Class] the class to use for item representation
     def item_class=(class_name)
       unless class_name.is_a?(String)
         raise ArgumentError, "::Barion.config.item_class must be set to a ::String, got #{class_name.inspect}"
@@ -83,6 +146,11 @@ module Barion
       @_item_class = class_name
     end
 
+    # Returns the item class set in the initializer.
+    #
+    # This method returns +nil+ until the initializer is installed.
+    #
+    # @return [Class] the class set in the initializer
     def item_class
       # This is nil before the initializer is installed.
       return nil if @_item_class.nil?
@@ -90,10 +158,22 @@ module Barion
       @_item_class.constantize
     end
 
+    # Returns the class used for making REST calls to the Barion API.
+    #
+    # If it was not set explicitly, it defaults to `::RestClient::Resource`.
+    #
+    # @return [Class] the class used for making REST calls
     def rest_client_class
       (@_rest_client_class || '::RestClient::Resource').constantize
     end
 
+    # Sets the class used for making REST calls to the Barion API.
+    #
+    # The class set with this method is used for making REST calls to the Barion API.
+    # It should be set to a class that responds to the same methods as
+    # `::RestClient::Resource`.
+    #
+    # @param class_name [Class, String] the class to use for making REST calls
     def rest_client_class=(class_name)
       unless class_name.is_a?(String)
         raise ArgumentError, "::Barion::Config.rest_client_class must be set to a ::String, got #{class_name.inspect}"
@@ -101,5 +181,19 @@ module Barion
 
       @_rest_client_class = class_name
     end
+
+    # Resets all configuration options to +nil+.
+    #
+    # It is useful when you want to restore the default configuration as the class is a Singleton.
+    def reset
+      @_poskey = nil
+      @_sandbox = nil
+      @_user_class = nil
+      @_item_class = nil
+      @_rest_client_class = nil
+      @acronym = nil
+      @pixel_id = nil
+      @publickey = nil
+    end
   end
 end

data/lib/barion/engine.rb

@@ -11,6 +11,10 @@ module Barion
       g.fixture_replacement :factory_bot
       g.factory_bot dir: 'test/factories'
     end
+
+    initializer 'barion.config', before: :load_config_initializers do |app|
+      app.config.barion = Barion.config
+    end
   end
 
   ActiveSupport.on_load(:action_view) do
@@ -18,8 +22,4 @@ module Barion
     # so we can call .include
     include ::Barion::PixelHelper
   end
-
-  def self.deprecator
-    @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Barion')
-  end
 end

data/lib/barion/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Barion
-  VERSION = '0.5.1'
+  VERSION = '0.5.3'
 end

data/lib/barion.rb

@@ -13,14 +13,33 @@ module Barion
 
   PIXELID_PATTERN = ::Regexp.new('BP-.{10}-\d{2}').freeze
 
+  # Returns the deprecator instance for the Barion module.
+  #
+  # This is a singleton method that initializes the deprecator
+  # if it hasn't been initialized yet, using ActiveSupport::Deprecation.
+  #
+  # @return [ActiveSupport::Deprecation] the deprecator instance
   def self.deprecator
     @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Barion')
   end
 
-  def self.config
-    ::Barion::Config.instance
+  # Configure the Barion engine
+  #
+  # @example
+  #   ::Barion.config do |conf|
+  #     conf.poskey = 'test'
+  #     conf.sandbox = true
+  #   end
+  def self.config(&_block)
+    return Barion::Config.instance unless block_given?
+
+    yield(Barion::Config.instance)
   end
 
+  # Returns whether the Barion engine is in sandbox mode.
+  #
+  # @return [boolean] whether the engine is in sandbox mode
+  # @deprecated
   def self.sandbox
     config.sandbox
     deprecator.warn(
@@ -29,6 +48,11 @@ module Barion
     )
   end
 
+  # Sets whether the Barion engine is in sandbox mode.
+  #
+  # @param val [boolean] the desired state for sandbox mode
+  #   true to enable sandbox mode, false to disable it
+  # @deprecated Use ::Barion.config.sandbox= instead
   def self.sandbox=(val)
     config.sandbox = val
     deprecator.warn(
@@ -37,6 +61,13 @@ module Barion
     )
   end
 
+  # Returns whether the Barion engine is in sandbox mode.
+  #
+  # This method delegates to the Barion::Config instance's sandbox? method
+  # to determine the current sandbox mode setting.
+  #
+  # @return [Boolean] true if in sandbox mode, false otherwise
+  # @deprecated Use ::Barion.config.sandbox? instead.
   def self.sandbox?
     config.sandbox?
     deprecator.warn(
@@ -45,6 +76,10 @@ module Barion
     )
   end
 
+  # Returns the current POSKey setting.
+  #
+  # @return [String, nil] the current POSKey setting
+  # @deprecated Use ::Barion.config.poskey instead.
   def self.poskey
     config.poskey
     deprecator.warn(
@@ -53,6 +88,10 @@ module Barion
     )
   end
 
+  # Sets the POSKey for the shop.
+  #
+  # @param val [String] the POSKey provided by Barion
+  # @deprecated Use ::Barion.config.poskey= instead
   def self.poskey=(val)
     config.poskey = (val)
     deprecator.warn(
@@ -61,6 +100,9 @@ module Barion
     )
   end
 
+  # Returns the current PublicKey setting.
+  #
+  # @return [String, nil] the current PublicKey setting
   def self.publickey
     config.publickey
     deprecator.warn(
@@ -69,6 +111,9 @@ module Barion
     )
   end
 
+  # Sets the PublicKey for the shop.
+  #
+  # @param val [String] the PublicKey provided by Barion
   def self.publickey=(val)
     config.publickey = (val)
     deprecator.warn(
@@ -77,6 +122,9 @@ module Barion
     )
   end
 
+  # Returns the current acronym for Barion.
+  #
+  # @return [String] the current acronym setting, empty string by default
   def self.acronym
     config.acronym
     deprecator.warn(
@@ -85,6 +133,9 @@ module Barion
     )
   end
 
+  # Sets the acronym for Barion.
+  #
+  # @param val [String] the desired acronym, empty string by default
   def self.acronym=(val)
     config.acronym = val
     deprecator.warn(
@@ -93,6 +144,12 @@ module Barion
     )
   end
 
+  # Returns the current Barion Pixel ID.
+  #
+  # The Pixel ID is used for tracking and analytics purposes.
+  #
+  # @return [String, nil] the current Pixel ID setting
+  # @deprecated Use ::Barion.config.pixel_id instead.
   def self.pixel_id
     config.pixel_id
     deprecator.warn(
@@ -101,6 +158,13 @@ module Barion
     )
   end
 
+  # Sets the Barion Pixel ID.
+  #
+  # Updates the Barion configuration with the provided Pixel ID.
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.pixel_id=` instead.
+  #
+  # @param val [String] the Pixel ID to set
   def self.pixel_id=(val)
     config.pixel_id = val
     deprecator.warn(
@@ -109,6 +173,13 @@ module Barion
     )
   end
 
+  # Returns the current default payee for Barion.
+  #
+  # The default payee is the default email address to which the payment
+  # confirmation email is sent.
+  #
+  # @return [String] the current default payee setting, empty string by default
+  # @deprecated Use ::Barion.config.default_payee instead
   def self.default_payee
     config.default_payee
     deprecator.warn(
@@ -117,6 +188,14 @@ module Barion
     )
   end
 
+  # Sets the default payee for Barion.
+  #
+  # Updates the Barion configuration with the provided default payee.
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.default_payee=` instead.
+  #
+  # @param val [String] the default payee to set
+  # @deprecated Use ::Barion.config.default_payee= instead
   def self.default_payee=(val)
     config.default_payee = val
     deprecator.warn(
@@ -125,6 +204,11 @@ module Barion
     )
   end
 
+  # Returns the class used for user authentication.
+  #
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.user_class` instead.
+  # @deprecated Use ::Barion.config.user_class instead
   def self.user_class
     config.user_class
     deprecator.warn(
@@ -133,6 +217,14 @@ module Barion
     )
   end
 
+  # Sets the class used for user authentication.
+  #
+  # Updates the Barion configuration with the provided user class.
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.user_class=` instead.
+  #
+  # @param val [Class] the class to use for user authentication
+  # @deprecated Use ::Barion.config.user_class= instead
   def self.user_class=(val)
     config.user_class = val
     deprecator.warn(
@@ -141,6 +233,13 @@ module Barion
     )
   end
 
+  # Returns the class used for item representation.
+  #
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.item_class` instead.
+  # @deprecated Use ::Barion.config.item_class instead
+  # @return [Class] the class used for item representation
+  # @deprecated Use ::Barion.config.item_class instead
   def self.item_class
     config.item_class
     deprecator.warn(
@@ -149,6 +248,15 @@ module Barion
     )
   end
 
+  # Sets the class used for item representation.
+  #
+  # Updates the Barion configuration with the provided item class.
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.item_class=` instead.
+  #
+  # @param val [Class] the class to use for item representation
+  # @deprecated Use ::Barion.config.item_class= instead
+  # @deprecated Use ::Barion.config.item_class= instead
   def self.item_class=(val)
     config.item_class = val
     deprecator.warn(
@@ -157,6 +265,12 @@ module Barion
     )
   end
 
+  # Returns the class used for making REST calls to the Barion API.
+  #
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.rest_client_class` instead.
+  # @deprecated Use ::Barion.config.rest_client_class instead
+  # @return [Class] the class used for making REST calls
   def self.rest_client_class
     config.rest_client_class
     deprecator.warn(
@@ -165,6 +279,14 @@ module Barion
     )
   end
 
+  # Sets the class used for making REST calls to the Barion API.
+  #
+  # Updates the Barion configuration with the provided REST client class.
+  # This method is deprecated and it is recommended to use
+  # `::Barion.config.rest_client_class=` instead.
+  #
+  # @param val [Class] the class to use for making REST calls
+  # @deprecated Use ::Barion.config.rest_client_class= instead
   def self.rest_client_class=(val)
     config.rest_client_class = val
     deprecator.warn(
@@ -179,8 +301,18 @@ module Barion
 
   # Generic error class for Barion module
   class Error < StandardError
-    attr_reader :title, :error_code, :happened_at, :auth_data, :endpoint, :errors
+    attr_reader :title, :error_code, :happened_at, :auth_data, :endpoint, :errors, :description
 
+    # Creates a new instance of the Barion::Error class. It can hold nested errors.
+    #
+    # @param params [Hash] a hash containing the error data
+    # @option params [String] :Title the title of the error
+    # @option params [Integer] :ErrorCode the error code
+    # @option params [String] :HappenedAt when the error happened in ISO 8601 format
+    # @option params [String] :AuthData authentication data
+    # @option params [String] :Endpoint the endpoint where the error happened
+    # @option params [Array<Hash>] :Errors the errors that happened
+    # @option params [String] :Description the description of the error
     def initialize(params)
       @title = params[:Title]
       @error_code = params[:ErrorCode]
@@ -188,9 +320,13 @@ module Barion
       @auth_data = params[:AuthData]
       @endpoint = params[:Endpoint]
       @errors = Array(params[:Errors]).map { |e| Barion::Error.new(e) } if params.key? :Errors
-      super(params[:Description])
+      @description = params[:Description]
+      super(@description)
     end
 
+    # Returns all errors that happened in the request in a single string
+    #
+    # @return [String] all errors that happened in the request
     def all_errors
       Array(@errors).map(&:message).join("\n")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barion
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Péter Nagy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -89,7 +89,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Barion payment engine for Ruby on Rails
 test_files: []