barion 0.3.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99100de21393d99ec14a7fbb36b45f470b0f400a1ab4267ccac25b30bd692aff
-  data.tar.gz: c0f7fcdb1d15bdc3556520d25f5a03c47a4a152aeba1620b4df64582d937d648
+  metadata.gz: 1ce7445be623c98ab928342e5a7c91e6cefba8289c000deffee990b231ec5579
+  data.tar.gz: 279f4a94a13cc650e92f37da59b8fa32819d120192062a931da51cf1dce4f2c0
 SHA512:
-  metadata.gz: 8370b7ae8f031cc2e466bceab7c9e5b9546fbd4cc5e793c9d133cce8fa5649bef5f1cd976a7edddc081b5ce1059c33e37ebbb6df2833ffa25709ddcb81590371
-  data.tar.gz: de5e8b523272341bb6a3f52a48f99b54cc699cf7c832c3a9ff1d1eaef83922f151d4a78765073d8d1d51e148fb3540989b704479858e6ee740291eeb3623d270
+  metadata.gz: e149b35819edab85f6455fde84cdcbc9bf90073de71ace121fe77c56175475fdf9d390538320112877018c2c39b6421c5a4018e42ab99df5b25159301b2b9dbc
+  data.tar.gz: f17d849b68270f45113ba7a23a1680644f4b2f764fc65bd070308c580165369465ba4913acfbbcae35c5b1adddaa877ad4b49b9707e6ce2dc8ec29240d1315ec

data/README.md

@@ -1,4 +1,5 @@
 # Barion
+
 ![Barion](https://github.com/Meter-reader/Barion/workflows/Ruby/badge.svg)
 [![codecov](https://codecov.io/gh/Meter-Reader/barion/branch/main/graph/badge.svg?token=DCOKCM7B2J)](https://codecov.io/gh/Meter-Reader/barion)
 [![Gem Version](https://badge.fury.io/rb/barion.svg)](https://badge.fury.io/rb/barion)
@@ -6,6 +7,7 @@
 This is a Ruby-on-Rails engine to use the Barion Payment Gateway in any RoR application.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -13,42 +15,59 @@ gem 'barion'
 ```
 
 And then execute:
+
 ```bash
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
+
 ```bash
-$ gem install barion
+gem install barion
 ```
+
 ## Usage
+
 ### Initalization
+
 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.sandbox = true
-  shop.acronym = ''
-  shop.default_payee = ''
-end
+Barion.poskey = ''
+Barion.publickey = ''
+Barion.pixel_id = ''
+Barion.sandbox = true
+Barion.acronym = ''
+Barion.default_payee = ''
 ```
+
 #### POSKey and PublicKey (default: empty)
+
 You can find your `POSKey` and `PublicKey` at the  Barion Shop website:
 
-Test : https://secure.test.barion.com/Shop/
+Test : <https://secure.test.barion.com/Shop/>
 
-Production : https://secure.barion.com/Shop/
+Production : <https://secure.barion.com/Shop/>
 
 ![POSKey and PublicKey at Barion Shop](https://docs.barion.com/images/2/2b/Poskey.jpg "POSKey and PublicKey at Barion Shop")
 
 You have to open the shop Details from the `Action` dropdown of your shop. Please be aware that these values are different for Test and Production shops.
 
+#### Pixel ID (default: '')
+
+[Implementing the Base Barion Pixel](https://docs.barion.com/Implementing_the_Base_Barion_Pixel)
+
+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.
 
-#### Acronym (default: empyty)
+#### Acronym (default: empty)
+
 Acronym is used to generate the `payment_request_id` Barion requires to identify every payment request as the below code snippets shows. You can change this by overriding/decorating this method in your code.
 
 ```ruby
@@ -56,39 +75,49 @@ def create_payment_request_id
   self.payment_request_id = "#{::Barion.acronym}#{::Time.now.to_f.to_s.gsub('.', '')}" if payment_request_id.nil?
 end
 ```
+
 #### Default payee (Default: empty)
+
 Barion requires an e-mail address in every transaction to identify the recipient user of the transaction. The Barion wallet which has this e-mail address registeres will receives the money when the payment is completed by the payer.
 
 You can see this address in the Barion Shop interface below your shop icon on the top left corner.
 
 ### Set up your database
+
 This gem comes with predefined models. To use them, you have to copy the migrations into your application and migrate them using:
+
 ```bash
 bundle exec rails barion:install:migrations
 bundle exec rails db:migrate SCOPE=barion
 ```
 
 ### Mounting the engine
+
 You have to mount the Barion engine to be able to receive callback(s) from Barion Gateway like:
+
 ```ruby
 mount ::Barion::Engine, at: "/barion"
 ```
 
 ### Creating payment
+
 Once initialized you can create payments like below:
+
 ```ruby
 payment = ::Barion:Payment.new
 transaction = payment.transactions.build
 item = transaction.items.build
 ```
-* You can find the properties of Payment here: https://docs.barion.com/Payment-Start-v2,
 
-* for the properties of Transaction see here: https://docs.barion.com/PaymentTransaction
+* You can find the properties of Payment here: <https://docs.barion.com/Payment-Start-v2>,
+
+* for the properties of Transaction see here: <https://docs.barion.com/PaymentTransaction>
 (*Note*: Transaction is used not just for starting the payment but to collect transaction details during the payment lifecycle.)
 
-* and for Item properties: https://docs.barion.com/Item
+* and for Item properties: <https://docs.barion.com/Item>
 
 To check if all required properties are filled out you can use Rails built in validation:
+
 ```ruby
 unless payment.valid?
 payment.errors.object.each { |error|
@@ -97,9 +126,11 @@ payment.errors.object.each { |error|
 ```
 
 Once the payment is prepared you can start it by issuing
+
 ```ruby
 payment.execute
 ```
+
 This will send the required API requests to the Barion Gateway, depending on the `::Barion.sandbox` value either to the Test or the Production environment.
 
 When the payment started you will receive callback(s) from Barion Gateway when the state of your payment has been changed. There are several routes defined by this gem:
@@ -108,6 +139,7 @@ When the payment started you will receive callback(s) from Barion Gateway when t
 post 'callback', to: 'main#callback', as: :gateway_callback
 get 'land', to: 'main#land', as: :gateway_back
 ```
+
 The `gateway_callback` route will receive these callbacks from Barion Gateway. Every such message contains a `PaymentId` to identify which Payment has a state change. The gem is automatically tries to call a state refresh and get all the data of the payment from the Gateway.
 
 You can call this manually too by issuing:
@@ -115,23 +147,28 @@ You can call this manually too by issuing:
 ```ruby
 payment.refresh_state
 ```
-You can read more about this callback mechanism at https://docs.barion.com/Callback_mechanism.
+
+You can read more about this callback mechanism at <https://docs.barion.com/Callback_mechanism>.
 
 #### Payment successful
+
 When a payment is completed at the Barion Gateway it will automatically redirect the user back to your application. By default every payment request will held this redirect URL, which points to this gem's `:gateway_back` route.
 You can change this however by setting the URL in the actual payment when creating it.
 
 #### Payment failed
+
 When a payment hasn't been completed if will eventually timeout at the Gateway. But if there was an issue of
 
 ### Error handling
+
 The gem has a lightweight wrapper for errors that the Barion API reports.
 
 When executing a payment (or in fact any other method which has an API call behind) an error can happen which the Barion API returns.
 
 The gem will raise a ``::Barion::Error`` type exception when receives such error(s). If multiple errors are returned, the exception will have an `errors` property which will contains all errors in an array also wrapped by ``::Barion::Error``.
 
-``::Barion::Error`` has the folowinf properties:
+``::Barion::Error`` has the following properties:
+
 ```ruby
 error = ::Barion::Error.new
 error.title # Holds the value of Title attribute of the API error
@@ -143,14 +180,37 @@ error.endpoint # Holds the value of Endpoint attribute of the API error
 ```
 
 ### Security
+
 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.
 
 ## Contributing
-We encourage you to contribute to Barion gem!
+
+We encourage you to contribute to this Barion gem!
+To run tests:
+
+1. Fork the repository
+2. Check out your fork of this repo
+3. Set up rbenv and add rbenv-vars as plugin
+4. Set up your variables in .rbenv-vars like this:
+
+    ```ruby
+    CODECOV_TOKEN=<your token from Codecov.io>
+    TEST_PAYEE=<your registered test shop email address at Barion>
+    TEST_PIXEL_ID=<your test pixel id from Barion>
+    TEST_POSKEY=<your test poskey from Barion>
+    TEST_PUBKEY=<your test pubkey from Barion>
+    ```
+
+5. Run ``rails t`` to see if tests are working.
+6. start modifying the code and run tests all the time.
+7. Submit pull-request when done.
+
 ### Reporting issues or requesting features
+
 This gem uses [GitHub Issue Tracking](https://github.com/meter-reader/barion/issues) to track issues (primarily bugs and contributions of new code). If you've found a bug  or have a good idea of a cool feature, this is the place to start. You'll need to create a (free) GitHub account in order to submit an issue, to comment on them, or to create pull requests.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/helpers/barion/pixel_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Barion related functions
+module Barion
+  # Adds Barion Pixel javascript to views
+  require 'action_view'
+  # Provides functions for Barion Pixel implementations in views
+  module PixelHelper
+    include ActionView::Helpers::TagHelper
+    def pixel_basic_js
+      javascript_tag %(
+      window["bp"] = window["bp"] || function () {(window["bp"].q = window["bp"].q || []).push(arguments);};
+      window["bp"].l = 1 * new Date();
+      scriptElement = document.createElement("script");
+      firstScript = document.getElementsByTagName("script")[0];
+      scriptElement.async = true;
+      scriptElement.src = 'https://pixel.barion.com/bp.js';
+      firstScript.parentNode.insertBefore(scriptElement, firstScript);
+      window['barion_pixel_id'] = '#{::Barion.pixel_id}';
+      // Send init event
+      bp('init', 'addBarionPixelId', window['barion_pixel_id']);'
+).gsub!(/^#{[/\A\s*/]}/, '')
+    end
+
+    def pixel_basic_noscript
+      tag.noscript do
+        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"
+      end
+    end
+
+    def pixel_basic_tags
+      pixel_basic_js + pixel_basic_noscript
+    end
+  end
+end

data/config/initializers/barion.rb

@@ -5,5 +5,6 @@
 #  shop.publickey = 'test2'
 #  shop.sandbox = true
 #  shop.acronym = ''
+#  shop.pixel_id = ''
 #  shop.default_payee = 'me@example.org'
 # end

data/config/routes.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# == Route Map
-#
-
 Barion::Engine.routes.draw do
   root to: 'main#land'
   post 'callback', to: 'main#callback', as: :gateway_callback

data/lib/barion/engine.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Module enclosing all Barion related functionality
 module Barion
   # Barion engine main class
   class Engine < ::Rails::Engine
@@ -11,4 +12,10 @@ module Barion
       g.factory_bot dir: 'test/factories'
     end
   end
+
+  ActiveSupport.on_load(:action_view) do
+    # self refers to ActiveRecord::Base here,
+    # so we can call .include
+    include ::Barion::PixelHelper
+  end
 end

data/lib/barion/version.rb

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

data/lib/barion.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'barion/engine'
+require 'barion/engine' if defined?(Rails::Engine)
 
 # Main module of Barion engine
 module Barion
@@ -9,21 +9,42 @@ module Barion
     prod: 'https://api.barion.com'
   }.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.poskey=(key)
+    raise ArgumentError, "::Barion.poskey must be set to a String, got #{key.inspect}" unless key.is_a?(String)
+
+    @@poskey = key
+  end
+
   def self.sandbox?
-    !!sandbox
+    sandbox
   end
 
-  def sandbox=(val)
-    super(!!val)
+  def self.sandbox=(val)
+    @@sandbox = !!val
+  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)
+
+    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 self.endpoint
@@ -31,7 +52,6 @@ module Barion
     rest_client_class.new BASE_URL[env]
   end
 
-  # rubocop:disable Style/ClassVars
   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}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barion
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.1
 platform: ruby
 authors:
 - Péter Nagy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -56,6 +56,7 @@ files:
 - app/controllers/barion/main_controller.rb
 - app/helpers/barion/application_helper.rb
 - app/helpers/barion/main_helper.rb
+- app/helpers/barion/pixel_helper.rb
 - app/models/barion/address.rb
 - app/models/barion/application_record.rb
 - app/models/barion/gift_card_purchase.rb
@@ -102,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Barion payment engine for Ruby on Rails