genesis_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88fa7a15b9a49833d8de193195478d25730cd08832a9f1c77a9e8029bead7fe7
+  data.tar.gz: 17a9e30b42dc026cd920e7be4d5983b0631baad23655bf2703b28b92c7f61d04
+SHA512:
+  metadata.gz: 1c7ea66d38e6ce58bf8a9560ade34eff61013a580e2af31f96164482891738874a70c3d481fcf4ab19158b5105003df849e6f145c1dbf1e1d46ddb405fd48134
+  data.tar.gz: 836820c824e0eb854e9b7c22eb95cfdfcdf990f4f8c0362a77ff6935e28c7fbbaeb81dd046a11e66661018797d77c8ade7e01d19a1ac0d2e664a16c955789b29

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+0.1.0
+-----
+**Features**:
+
+* Added initial Genesis Client Library version 0.1.0
+* Added support for the creation of the following transaction requests:
+    * Web Payment Form
+    * Authorize
+    * Authorize 3D
+    * Sale
+    * Sale 3D

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in genesis_ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,158 @@
+PATH
+  remote: .
+  specs:
+    genesis_ruby (0.1.0)
+      net-http (~> 0.3.2)
+      nokogiri (~> 1.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faker (2.23.0)
+      i18n (>= 1.8.11, < 2)
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.4)
+    multi_xml (0.6.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    net-http (0.3.2)
+      uri
+    nokogiri (1.15.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    octokit (6.1.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    pronto (0.11.1)
+      gitlab (>= 4.4.0, < 5.0)
+      httparty (>= 0.13.7, < 1.0)
+      octokit (>= 4.7.0, < 7.0)
+      rainbow (>= 2.2, < 4.0)
+      rexml (>= 3.2.5, < 4.0)
+      rugged (>= 0.23.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
+    pronto-rubocop (0.11.5)
+      pronto (~> 0.11.0)
+      rubocop (>= 0.63.1, < 2.0)
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-protection (3.1.0)
+      rack (~> 2.2, >= 2.2.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-faker (1.1.0)
+      faker (>= 2.12.0)
+      rubocop (>= 0.82.0)
+    rubocop-rspec (2.24.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    rugged (1.7.1)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    sinatra (3.1.0)
+      mustermann (~> 3.0)
+      rack (~> 2.2, >= 2.2.4)
+      rack-protection (= 3.1.0)
+      tilt (~> 2.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.2)
+    tilt (2.3.0)
+    unicode-display_width (2.4.2)
+    uri (0.12.2)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-21
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  faker (~> 2.22)
+  faraday-retry (~> 2.0)
+  genesis_ruby!
+  pronto (~> 0.11)
+  pronto-rubocop (~> 0.11)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-faker (~> 1.1)
+  rubocop-rspec (~> 2.13)
+  sinatra (~> 3.0)
+  webmock (~> 3.18)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Genesis Gateway
+
+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,343 @@
+
+# Genesis Ruby
+
+[![Software License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)
+
+Ruby Client for Genesis Payment Processing Gateway
+
+## Overview
+
+Client Library for processing payments through Genesis Payment Processing Gateway. Its highly recommended to checkout "Genesis Payment Gateway API Documentation" first, in order to get an overview of Genesis's Payment Gateway API and functionality.
+
+## Requirements
+
+* Ruby version 2.7 or newer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'genesis_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install genesis_ruby
+
+## Getting Started
+
+### Configuration
+```ruby
+configuration             = GenesisRuby::Configuration.new
+configuration.username    = '<YOUR USERNAME>'
+configuration.password    = '<YOUR PASSWORD>'
+configuration.token       = '<YOUR TOKEN>'
+configuration.environment = GenesisRuby::Api::Constants::Environments::STAGING   # Support alias strings: 'test', 'testing', 'staging', 'live', 'prod', 'production'
+configuration.endpoint    = GenesisRuby::Api::Constants::Endpoints::EMERCHANTPAY # Support alias strings: 'emp', 'emerchantpay', 'ecp', 'ecomprocessing', 'e-comprocessing'
+```
+
+### Web Payment Form 
+```ruby
+require 'genesis_ruby'
+
+begin
+  genesis = GenesisRuby::Genesis.for(config: configuration, request: GenesisRuby::Api::Requests::Wpf::Create) do |request|
+    # Common Attributes
+    request.transaction_id     = '12345-67890'
+    request.amount             = '0.99'
+    request.currency           = 'EUR'
+    request.usage              = 'Example usage'
+    request.description        = 'You are about to complete you purchase'
+    request.customer_email     = 'travis@example.com'
+    request.customer_phone     = '+1987987987987'
+    request.notification_url   = 'https://www.example.com/notification'
+    request.return_success_url = 'https://www.example.com/success'
+    request.return_cancel_url  = 'https://www.example.com/failure'
+    request.return_failure_url = 'https://www.example.com/cancel.html'
+    request.return_pending_url = 'https://www.example.com/payment-pending.html'
+
+    # Transaction Types
+    request.add_transaction_type('authorize3d')
+    # Transaction Type with Customer Attribute 
+    request.add_transaction_type('sale3d', { bin: '420000' })
+
+    # Tokenization Attributes
+    request.consumer_id   = '123456789'
+    request.remember_card = true
+
+    # Billing Attributes
+    request.billing_first_name = 'Travis'
+    request.billing_last_name  = 'Pastrana'
+    request.billing_address1   = 'Muster Str. 12'
+    request.billing_zip_code   = '10178'
+    request.billing_city       = 'Los Angeles'
+    request.billing_state      = 'CA'
+    request.billing_country    = 'US'
+
+    # Shipping Attributes
+    request.shipping_first_name = 'Travis'
+    request.shipping_last_name  = 'Pastrana'
+    request.shipping_address1   = 'Muster Str. 12'
+    request.shipping_zip_code   = '10178'
+    request.shipping_city       = 'Los Angeles'
+    request.shipping_state      = 'CA'
+    request.shipping_country    = 'US'
+
+    # Internationalization
+    request.locale = 'EN'
+
+    # Other
+    request.lifetime            = 30
+    request.web_payment_form_id = '987654321'
+  end.execute
+  
+  puts genesis.response.response_object
+
+rescue GenesisRuby::Error => error
+  puts error.message
+end
+```
+
+### Transactions
+
+```ruby
+require 'genesis_ruby'
+
+begin
+  genesis = GenesisRuby::Genesis.for(config: configuration, request: GenesisRuby::Api::Requests::Financial::Cards::Sale) do |request|
+    # Common Attributes
+    request.transaction_id     = '12345-67890'
+    request.amount             = '0.99'
+    request.currency           = 'EUR'
+    request.usage              = 'Example usage'
+    request.customer_email     = 'travis@example.com'
+    request.customer_phone     = '+1987987987987'
+
+    # Credit Card Attributes
+    request.card_holder      = 'Travis Pastrana'
+    request.card_number      = '4200000000000000'
+    request.expiration_month = '12'
+    request.expiration_year  = '2040'
+    request.cvv              = '834'
+
+    # Billing Attributes
+    request.billing_first_name = 'Travis'
+    request.billing_last_name  = 'Pastrana'
+    request.billing_address1   = 'Muster Str. 12'
+    request.billing_zip_code   = '10178'
+    request.billing_city       = 'Los Angeles'
+    request.billing_state      = 'CA'
+    request.billing_country    = 'US'
+  end.execute
+
+  puts genesis.response.response_object
+
+rescue GenesisRuby::Error => error
+  puts error.message
+end
+```
+
+A full list of the Transaction Types and Custom Attributes can be found [here](https://emerchantpay.github.io/gateway-api-docs/?shell#wpf-transaction-types).
+
+### Recurring
+
+A recurring transaction describes a payment where the cardholder’s account is periodically charged for a repeated 
+delivery and use of a product or service (subscription, membership fee, etc.) over time. A recurring payment consists of an initial transaction and one or several repeated subsequent transactions.
+
+```ruby
+request.recurring_type = GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::INITIAL
+```
+
+#### Managed Recurring
+
+Managed Recurring provides the option to automatically schedule recurring transactions for a specific day and time.
+Managed Recurring is available after additional configuration. More info can be found [here](https://emerchantpay.github.io/gateway-api-docs/?shell#managed-recurring-intro)
+
+```ruby
+request.recurring_type = GenesisRuby::Api::Constants::Transactions::Parameters::Recurring::Types::MANAGED
+```
+
+* <details>
+  <summary>Web Payment Form</summary>
+  
+  ```ruby
+  request.add_transaction_type(
+    'sale3d',
+    {
+      managed_recurring: {
+        mode:        'automatic',
+        interval:    'days',
+        first_date:  ((Date.today) + 1).strftime('%Y-%d-%m'),
+        time_of_day: 1,
+        period:      1,
+        amount:      GenesisRuby::Utils::MoneyFormat.amount_to_exponent('0.99', 'EUR'),
+        max_count:   1
+      }
+    }
+  )
+  ```
+  </details>
+
+
+## Response
+
+After Request execution (`genesis.execute`) a Response object can be accessed `genesis.response`.  
+
+The Response contains the original response from the Gateway:
+```ruby
+genesis.response.response_raw
+```
+
+The Response contains the parsed response from the Gateway:
+```ruby
+genesis.response.response_object
+```
+
+### Success Request
+
+You receive from the Response Object a Hash collection. The data contains a `:status`.
+
+
+If the Transaction is Successful the status is one of the following:
+* `new`
+* `approved`
+* `pending_async`
+
+<details>
+<summary>Example Successful Transaction Execution</summary>
+
+```ruby
+  {:status=>"new",
+  :unique_id=>"2993ad9c2dd45ecfa9862b9eaf0ceb29",
+  :transaction_id=>"9c8b862b-4f91-478b-8a14-87bffab7e55d",
+  :timestamp=>
+  #<DateTime: 2023-04-20T12:11:42+00:00 ((2460055j,43902s,0n),+0s,2299161j)>,
+  :amount=>"0.99",
+  :currency=>"EUR",
+  :redirect_url=>
+  "https://staging.wpf.emerchantpay.net/ja/v2/payment/2993ad9c2dd45ecfa9862b9eaf0ceb29"}
+```
+</details>
+
+If an error occurs during the Transaction Execution the status is one of the following:
+* `error`
+* `declined`
+
+<details>
+<summary>Example Transaction Execution with Error</summary>
+
+```ruby
+{:status=>"error",
+ :unique_id=>"fc94d7cdebe5f81618785d1033948fcc",
+ :transaction_id=>"8bf4556b-a6ba-4389-a2e8-b7efa9e384b3",
+ :code=>"120",
+ :technical_message=>
+   "Lacking Terminal/MID setups for the currency 'USD' for the requested transaction types",
+ :message=>"Transaction failed, please contact support!",
+ :timestamp=>
+   #<DateTime: 2023-04-20T12:13:52+00:00 ((2460055j,44032s,0n),+0s,2299161j)>,
+   :amount=>"0.99",
+ :currency=>"USD"}
+```
+</details>
+
+### Response Helpers
+
+#### Sates
+
+The Response object has predefined checks for validating the status of the received response. 
+Every available status received from the Gateway can be checked in the following way.
+
+```ruby
+genesis.response.new?
+genesis.response.approved?
+genesis.response.declined?
+genesis.response.error?
+...
+```
+
+#### Formatters
+
+By default, the Response Object is formatted. For example, amounts are transformed in major currency format, timestamps in `DateTime`, etc.
+If you want to stop formatting you can do it by defining `format_reponse` in the [Configuration](#Configuration).
+
+```ruby
+configuration.format_response = false
+```
+
+#### Sanitization
+
+By default, the Response Object is sanitized, and `<empty/>` values are removed.
+If you want to stop sanitization you can do it by defining `configuration.sanitize_response` in the [Configuration](#Configuration).
+
+```ruby
+configuration.sanitize_response = false
+```
+
+## Requests
+
+You can use the following request classes to initialize the Genesis client:
+
+```ruby
+# Transactions
+## Cards
+GenesisRuby::Api::Requests::Financial::Cards::Authorize
+GenesisRuby::Api::Requests::Financial::Cards::Authorize3d
+GenesisRuby::Api::Requests::Financial::Cards::Sale
+GenesisRuby::Api::Requests::Financial::Cards::Sale3d
+
+# Web Payment Form
+## Create
+GenesisRuby::Api::Requests::Wpf::Create
+```
+
+### Manual initialization
+
+<details>
+<summary>Manual Client initialization</summary>
+
+```ruby
+require 'genesis_ruby'
+
+begin
+  request = GenesisRuby::Api::Requests::Wpf::Create.new(configuration)
+
+  request.transaction_id     = '12345-67890'
+  request.amount             = '0.99'
+  request.currency           = 'EUR'
+  request.usage              = 'Example usage'
+  request.description        = 'You are about to complete you purchase'
+  request.customer_email     = 'travis@example.com'
+  request.customer_phone     = '+1987987987987'
+  request.notification_url   = 'https://www.example.com/notification'
+  request.return_success_url = 'https://www.example.com/success'
+  request.return_cancel_url  = 'https://www.example.com/failure'
+  request.return_failure_url = 'https://www.example.com/cancel.html'
+  request.return_pending_url = 'https://www.example.com/payment-pending.html'
+
+  # Transaction Types
+  request.add_transaction_type('authorize3d')
+  
+  genesis = GenesisRuby::Genesis.new(configuration, request)
+
+  puts genesis.execute.response.response_object
+
+rescue GenesisRuby::Error => error
+  puts error.message
+end
+```
+
+</details>
+
+## Running Specs
+
+`rake test`
+
+## Running Linters
+
+`rake styles`

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+task test: :spec
+task styles: :rubocop

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/genesis_ruby.gemspec

@@ -0,0 +1,43 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'genesis_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name                        = 'genesis_ruby'
+  spec.version                     = GenesisRuby::VERSION
+  spec.authors                     = ['emerchantpay Ltd.']
+  spec.email                       = ['client_integrations@emerchantpay.com']
+
+  spec.summary                     = 'Ruby Client for Genesis Payment Processing Gateway'
+  spec.homepage                    = 'https://github.com/GenesisGateway/genesis_ruby'
+  spec.license                     = 'MIT'
+  spec.required_ruby_version       = '>= 2.7.0'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/GenesisGateway/genesis_ruby'
+  spec.metadata['changelog_uri']   = 'https://github.com/GenesisGateway/genesis_ruby/CHANGELOG.md'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(bin|test|spec|features|sig)/|\.(?:git|pronto|rspec|rubocop)})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'net-http', '~> 0.3.2'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.14'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'faker', '~> 2.22'
+  spec.add_development_dependency 'faraday-retry', '~> 2.0'
+  spec.add_development_dependency 'pronto', '~> 0.11'
+  spec.add_development_dependency 'pronto-rubocop', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-faker', '~> 1.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.13'
+  spec.add_development_dependency 'sinatra', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+end