barion 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 575b950187d8de272065169bce30d830c4731761b4b25b9d7533e8899b2674dd
-  data.tar.gz: 4465db2681c4da8f1b8b4b01b6ef34158be8d7bacb02302eae779cd1fcff7985
+  metadata.gz: 28e8f48530892a81c10e2b8cc4711acc215a64c1798646863ed2723d133c3818
+  data.tar.gz: 8997771b29049b4d42d1f4f6449d54967b7b5fe41e178ead0b17cb4591e32711
 SHA512:
-  metadata.gz: ca9acdf451e26ab69a247b8098be1db3f8f43ffada9229a9f5e0378a6db5b8c8afcf720751de5117708d2372eefd3242fbe874d2abaed5c3cf1da7930a2c15b2
-  data.tar.gz: 5b708506775ecb6ecb647ceeafd1fcd0fb707447f78b77d922c91a1e66c9532d73b373376ec72a34c2db38e2a579166eb8ac1339ada8ee97809044484ad3e829
+  metadata.gz: e0e2d5affbdfb951cdedc75f9ca35e39783fb37a6d31dfb3876a98fc3f4fea0bd0da9415f8e21ca37ae503618c679256ae49ee812f77e817b369cb36379449b0
+  data.tar.gz: 71a40b6f41f281730d3e4d8a3056dafc216234db833a5155c82536bf11ad4eca66d8fa31e6d4242d005349913a237a4d2c523ff54e60d5254fc4e2043bf89d0f

data/README.md

@@ -34,13 +34,13 @@ After installing the gem you have to initalize it.
 Just create a file in `config/initializers/barion.rb` with the below content:
 
 ```ruby
-::Barion.config do |shop|
-  shop.poskey = ''
-  shop.publickey = ''
-  shop.pixel_id = ''
-  shop.sandbox = true
-  shop.acronym = ''
-  shop.default_payee = ''
+::Barion.config do |conf|
+  conf.poskey = ''
+  conf.publickey = ''
+  conf.pixel_id = ''
+  conf.sandbox = true
+  conf.acronym = ''
+  conf.default_payee = ''
 end
 ```
 
@@ -62,8 +62,6 @@ You have to open the shop Details from the `Action` dropdown of your shop. Pleas
 
 Your Barion Pixel ID can be found in the Details page of your Barion shop. Every webshop (with a unique POSKey) has a different Barion Pixel ID. You can find your Barion Pixel ID in your Barion wallet: click `Manage my shops` menu, `Actions` next to your shop and then `Details`.
 
-
-
 #### Sandbox (default: true)
 
 It is **highly recommended** to use a Test shop first to tune the code first. That's why `sandbox` is set to **true** by default.
@@ -74,7 +72,7 @@ Acronym is used to generate the `payment_request_id` Barion requires to identify
 
 ```ruby
 def create_payment_request_id
-  self.payment_request_id = "#{::Barion.acronym}#{::Time.now.to_f.to_s.gsub('.', '')}" if payment_request_id.nil?
+  self.payment_request_id = "#{::Barion.config.acronym}#{::Time.now.to_f.to_s.gsub('.', '')}" if payment_request_id.nil?
 end
 ```
 

data/app/helpers/barion/pixel_helper.rb

@@ -16,7 +16,7 @@ module Barion
       scriptElement.async = true;
       scriptElement.src = 'https://pixel.barion.com/bp.js';
       firstScript.parentNode.insertBefore(scriptElement, firstScript);
-      window['barion_pixel_id'] = '#{::Barion.pixel_id}';
+      window['barion_pixel_id'] = '#{::Barion.config.pixel_id}';
       // Send init event
       bp('init', 'addBarionPixelId', window['barion_pixel_id']);'
 ).gsub!(/^#{[/\A\s*/]}/, '')
@@ -27,7 +27,7 @@ module Barion
         tag.img height: 1, width: 1,
                 style: 'display:none',
                 alt: 'Barion Pixel',
-                src: "https://pixel.barion.com/a.gif?ba_pixel_id='#{::Barion.pixel_id}'&ev=contentView&noscript=1"
+                src: "https://pixel.barion.com/a.gif?ba_pixel_id='#{::Barion.config.pixel_id}'&ev=contentView&noscript=1"
       end
     end
 

data/app/models/barion/payment.rb

@@ -167,7 +167,7 @@ module Barion
     before_validation :refresh_checksum
 
     def poskey=(value = nil)
-      value = ::Barion.poskey if value.nil?
+      value = ::Barion.config.poskey if value.nil?
       super(value)
     end
 
@@ -210,7 +210,7 @@ module Barion
 
     def execute
       if valid?
-        ::Barion.endpoint['v2/Payment/Start'].post(
+        ::Barion.config.endpoint['v2/Payment/Start'].post(
           as_json.to_json,
           { content_type: :json, accept: :json }
         ) { |response, request, _result| handle_response(response, request) }
@@ -220,7 +220,7 @@ module Barion
     end
 
     def refresh_state
-      ::Barion.endpoint['v2/Payment/GetPaymentState'].get(
+      ::Barion.config.endpoint['v2/Payment/GetPaymentState'].get(
         {
           params: {
             POSKey: poskey,
@@ -316,13 +316,16 @@ module Barion
     end
 
     def set_defaults
-      self.poskey = ::Barion.poskey if poskey.nil?
+      self.poskey = ::Barion.config.poskey if poskey.nil?
       self.callback_url = ::Barion::Engine.routes.url_helpers.gateway_callback_url
       self.redirect_url = ::Barion::Engine.routes.url_helpers.gateway_back_url
     end
 
     def create_payment_request_id
-      self.payment_request_id = "#{::Barion.acronym}#{::Time.now.to_f.to_s.gsub('.', '')}" if payment_request_id.nil?
+      return unless payment_request_id.nil?
+
+      self.payment_request_id = "#{::Barion.config.acronym}#{::Time.now.to_f.to_s.gsub('.',
+                                                                                       '')}"
     end
 
     def gen_checksum

data/app/models/barion/payment_transaction.rb

@@ -80,7 +80,7 @@ module Barion
 
     def set_defaults
       self.currency = payment&.currency if currency.nil?
-      self.payee = ::Barion.default_payee if payee.nil?
+      self.payee = ::Barion.config.default_payee if payee.nil?
     end
 
     def total=(value)

data/lib/barion/config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module Barion
+  # Encloses all Barion related configuration
+  class Config
+    include Singleton
+
+    attr_accessor :publickey, :default_payee
+    attr_writer :acronym
+    attr_reader :pixel_id
+
+    def poskey
+      @_poskey || nil
+    end
+
+    def acronym
+      @acronym || ''
+    end
+
+    def poskey=(key)
+      unless key.is_a?(String)
+        raise ArgumentError,
+              "::Barion::Config.poskey must be set to a ::String, got #{key.inspect}"
+      end
+
+      @_poskey = key
+    end
+
+    def sandbox
+      sandbox?
+    end
+
+    def sandbox?
+      @_sandbox = true if @_sandbox.nil?
+      @_sandbox
+    end
+
+    def sandbox=(val)
+      @_sandbox = !!val
+    end
+
+    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
+
+      if PIXELID_PATTERN.match(id).nil?
+        raise ::ArgumentError,
+              "String:'#{id}' is not in Barion Pixel ID format: 'BP-0000000000-00'"
+      end
+
+      @pixel_id = id
+    end
+
+    def endpoint
+      env = sandbox? ? :test : :prod
+      rest_client_class.new ::Barion::BASE_URL[env]
+    end
+
+    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}"
+      end
+
+      @_user_class = class_name
+    end
+
+    def user_class
+      # This is nil before the initializer is installed.
+      return nil if @_user_class.nil?
+
+      @_user_class.constantize
+    end
+
+    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}"
+      end
+
+      @_item_class = class_name
+    end
+
+    def item_class
+      # This is nil before the initializer is installed.
+      return nil if @_item_class.nil?
+
+      @_item_class.constantize
+    end
+
+    def rest_client_class
+      (@_rest_client_class || '::RestClient::Resource').constantize
+    end
+
+    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}"
+      end
+
+      @_rest_client_class = class_name
+    end
+  end
+end

data/lib/barion/engine.rb

@@ -18,4 +18,8 @@ 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.4.0'
+  VERSION = '0.5.0'
 end

data/lib/barion.rb

@@ -1,99 +1,177 @@
 # frozen_string_literal: true
 
 require 'barion/engine' if defined?(Rails::Engine)
+require 'barion/config'
 
 # Main module of Barion engine
+# rubocop:disable Metrics/ModuleLength
 module Barion
   BASE_URL = {
     test: 'https://api.test.barion.com',
     prod: 'https://api.barion.com'
   }.freeze
 
-  PIXELID_PATTERN = ::Regexp.new('BP-\d{10}-\d{2}').freeze
+  PIXELID_PATTERN = ::Regexp.new('BP-.{10}-\d{2}').freeze
 
-  # rubocop:disable Style/ClassVars
-  mattr_accessor :poskey, default: nil
-  mattr_accessor :publickey, default: nil
-  mattr_accessor :acronym, default: ''
-  mattr_accessor :pixel_id, default: ''
-  mattr_accessor :sandbox, default: true
-  mattr_accessor :default_payee
-  mattr_accessor :user_class
-  mattr_accessor :item_class
-  mattr_accessor :rest_client_class, default: '::RestClient::Resource'
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new('1.0', 'Barion')
+  end
+
+  def self.config
+    ::Barion::Config.instance
+  end
 
-  def self.poskey=(key)
-    raise ArgumentError, "::Barion.poskey must be set to a String, got #{key.inspect}" unless key.is_a?(String)
+  def self.sandbox
+    config.sandbox
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@poskey = key
+  def self.sandbox=(val)
+    config.sandbox = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
   def self.sandbox?
-    sandbox
+    config.sandbox?
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.sandbox=(val)
-    @@sandbox = !!val
+  def self.poskey
+    config.poskey
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.pixel_id=(id)
-    raise ArgumentError, "::Barion.pixel_id must be set to a String, got #{id.inspect}" unless id.is_a?(String)
+  def self.poskey=(val)
+    config.poskey = (val)
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    if PIXELID_PATTERN.match(id).nil?
-      raise ::ArgumentError,
-            "String:'#{id}' is not in Barion Pixel ID format: 'BP-0000000000-00'"
-    end
+  def self.publickey
+    config.publickey
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@pixel_id = id
+  def self.publickey=(val)
+    config.publickey = (val)
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.endpoint
-    env = sandbox? ? :test : :prod
-    rest_client_class.new BASE_URL[env]
+  def self.acronym
+    config.acronym
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.user_class=(class_name)
-    unless class_name.is_a?(String)
-      raise ArgumentError, "Barion.user_class must be set to a String, got #{class_name.inspect}"
-    end
+  def self.acronym=(val)
+    config.acronym = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@user_class = class_name
+  def self.pixel_id
+    config.pixel_id
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.user_class
-    # This is nil before the initializer is installed.
-    return nil if @@user_class.nil?
+  def self.pixel_id=(val)
+    config.pixel_id = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@user_class.constantize
+  def self.default_payee
+    config.default_payee
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.item_class=(class_name)
-    unless class_name.is_a?(String)
-      raise ArgumentError, "Barion.item_class must be set to a String, got #{class_name.inspect}"
-    end
+  def self.default_payee=(val)
+    config.default_payee = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
+
+  def self.user_class
+    config.user_class
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@item_class = class_name
+  def self.user_class=(val)
+    config.user_class = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
   def self.item_class
-    # This is nil before the initializer is installed.
-    return nil if @@item_class.nil?
+    config.item_class
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
+  end
 
-    @@item_class.constantize
+  def self.item_class=(val)
+    config.item_class = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
   def self.rest_client_class
-    @@rest_client_class.constantize
+    config.rest_client_class
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
 
-  def self.rest_client_class=(class_name)
-    unless class_name.is_a?(String)
-      raise ArgumentError, "Barion.rest_client_class must be set to a String, got #{class_name.inspect}"
-    end
-
-    @@rest_client_class = class_name
+  def self.rest_client_class=(val)
+    config.rest_client_class = val
+    deprecator.warn(
+      "#{__method__} is deprecated. " \
+      "Use ::Barion.config.#{__method__} instead."
+    )
   end
-  # rubocop:enable Style/ClassVars
 
   # Error to signal the data in the db has been changed since saving it
   class TamperedData < RuntimeError
@@ -118,3 +196,4 @@ module Barion
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barion
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Péter Nagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,6 +79,7 @@ files:
 - db/migrate/20210128220347_create_barion_items.rb
 - db/migrate/20210201120609_create_barion_gift_card_purchases.rb
 - lib/barion.rb
+- lib/barion/config.rb
 - lib/barion/engine.rb
 - lib/barion/version.rb
 - lib/tasks/auto_annotate_models.rake