barion 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '087811487218d3c608a2e5623faa76ac7bf8e1b223b1df66df6a441c19577540'
+  data.tar.gz: d592774486b56bab36a54746bd7369dd455438057ffa87e466c866e1d4ea8e08
+SHA512:
+  metadata.gz: e0b1972b063fc2f178014b3f07725db3667b56d0203082174806d62c03946b9122863f717480d03099d0bc0d7fedbbbc83c96148f8b29d2fb23e2060360b0894
+  data.tar.gz: ef3075e553a6a96b430b574c6e9c3e3a8bf9d1dd6a5f85c0c319b430a16d2e6c8542abd5fa2dcef0bb1f8e54fc219f1e24896856b21632fbbb222f89ad66b20d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Péter Nagy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,158 @@
+# 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)
+
+This is a Ruby-on-Rails engine to use the Barion Payment Gateway in any RoR application.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'barion'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install barion
+```
+## Usage
+### Intitalization
+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
+```
+#### POSKey and PublicKey (default: empty)
+You can find your `POSKey` and `PublicKey` at the  Barion Shop website:
+
+Test : https://secure.test.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.
+
+#### 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 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
+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
+(*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
+
+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|
+  puts error.full_message
+}
+```
+
+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:
+
+```ruby
+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:
+
+```ruby
+payment.refresh_state
+```
+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:
+```ruby
+error = ::Barion::Error.new
+error.title # Holds the value of Title attribute of the API error
+error.message # Holds the value of Description attribute of the API error
+error.error_code # Holds the value of ErrorCode attribute of the API error
+error.happened_at # Holds the value of HappenedAt attribute of the API error
+error.auth_data # Holds the value of AuthData attribute of the API error
+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!
+### 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/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Barion'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/barion_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/barion .css

data/app/assets/stylesheets/barion/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/barion/main.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/barion/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Barion
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/barion/main_controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_dependency 'barion/application_controller'
+
+module Barion
+  # Barion engine's main controller to receive callback and redirects
+  class MainController < ApplicationController
+    def callback
+      @payment = ::Barion::Payment.find_by_payment_id(payment_params)
+      if @payment.present?
+        head :ok
+        @payment.refresh_state
+      else
+        head :unprocessable_entity
+      end
+    end
+
+    def land
+      @payment = ::Barion::Payment.find_by_payment_id(payment_params)
+    end
+
+    private
+
+    def payment_params
+      params.require(:paymentId)
+    end
+  end
+end

data/app/helpers/barion/application_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Barion
+  # Common helpers for the Barion engine
+  module ApplicationHelper
+  end
+end

data/app/helpers/barion/main_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Barion
+  # Helpers for main controller
+  module MainHelper
+  end
+end

data/app/models/barion/address.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: barion_addresses
+#
+#  id         :integer          not null, primary key
+#  city       :string(50)
+#  country    :string(2)        default("zz"), not null
+#  full_name  :string(45)
+#  region     :string(2)
+#  street     :string(50)
+#  street2    :string(50)
+#  street3    :string(50)
+#  zip        :string(16)
+#  created_at :datetime         not null
+#  updated_at :datetime         not null
+#  payment_id :bigint
+#
+# Indexes
+#
+#  index_barion_addresses_on_city        (city)
+#  index_barion_addresses_on_country     (country)
+#  index_barion_addresses_on_full_name   (full_name)
+#  index_barion_addresses_on_payment_id  (payment_id)
+#  index_barion_addresses_on_zip         (zip)
+#
+module Barion
+  # Represents a postal address fro Barion engine
+  class Address < ApplicationRecord
+    include ::Barion::JsonSerializer
+
+    belongs_to :payment, inverse_of: :shipping_address
+    belongs_to :payment, inverse_of: :billing_address
+
+    validates :country, presence: true, length: { is: 2 }
+    validates :zip, length: { maximum: 16 }, allow_nil: true
+    validates :city, length: { maximum: 50 }, allow_nil: true
+    validates :region, length: { is: 2 }, allow_nil: true
+    validates :street, length: { maximum: 50 }, allow_nil: true
+    validates :street2, length: { maximum: 50 }, allow_nil: true
+    validates :street3, length: { maximum: 50 }, allow_nil: true
+    validates :full_name, length: { maximum: 45 }, allow_nil: true
+
+    def serialize_options
+      {
+        map: {
+          except: %i[updated_at created_at],
+          keys: {
+            _all: :camelize
+          },
+          values: {
+            _all: proc { |v| v.respond_to?(:camelize) ? v.camelize : v },
+            _except: %w[country]
+          }
+        }
+      }
+    end
+  end
+end

data/app/models/barion/application_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Barion
+  # Abstract data record class
+  #
+  # @abstract
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/barion/gift_card_purchase.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: barion_gift_card_purchases
+#
+#  id          :integer          not null, primary key
+#  amount      :decimal(, )      not null
+#  count       :integer          not null
+#  created_at  :datetime         not null
+#  updated_at  :datetime         not null
+#  purchase_id :integer
+#
+# Indexes
+#
+#  index_barion_gift_card_purchases_on_purchase_id  (purchase_id)
+#
+
+module Barion
+  # Represents a Gift card purchase in Barion engine
+  class GiftCardPurchase < ApplicationRecord
+    include ::Barion::JsonSerializer
+
+    belongs_to :purchase, inverse_of: :gift_card_purchase
+
+    attribute :amount, :decimal
+    attribute :count, :integer
+
+    validates_associated :purchase
+    validates :amount, numericality: { greater_than: 0 }
+    validates :count, numericality: { only_integer: true }, inclusion: { in: 1..99 }
+
+    def serialize_options
+      { except: %i[id created_at updated_at currency],
+        map: {
+          keys: {
+            _all: :camelize
+          },
+          values: {
+            _all: proc { |v| v.respond_to?(:camelize) ? v.camelize : v },
+            amount: :as_string
+          }
+        } }
+    end
+
+    def amount
+      value = super
+      return nil if value.nil?
+
+      case currency
+      when nil
+        value
+      when 'HUF'
+        value.round
+      else
+        value.round(2)
+      end
+    end
+
+    def currency
+      return nil if purchase.nil? || purchase.payment.nil?
+
+      purchase.payment.currency
+    end
+  end
+end