platon.ua 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 311e575bab7c341ed7595269d2422af27b06921fbd6742966763436e167ddcca
+  data.tar.gz: a568585fefe948ae0ad65a1673be4011241bb3a33b5651e893411bedbb5c2b66
+SHA512:
+  metadata.gz: 90967ab09017870cfe376b1af09d6942ca49a37f3a5509bb8e1523996591c7ed409575e893a1b6d2226a0ca4977eb0acabafd43c42e701b81fdeee328b21bd68
+  data.tar.gz: 8ea4cc0fc2d49c5ab21aa6df97ef0cc83b8b91dc4b26eaf20ad4cd1f5bfde4d13bb44938db8c5e40cdd20dd6b74c680c67087821aa13afd41efdd39f163297b6

data/.env.example

@@ -0,0 +1,6 @@
+PLATON_KEY=
+PLATON_PASSWORD=
+PLATON_PAY=https://secure.platononline.com/payment/auth
+PLATON_CALLBACK=
+PLATON_ERROR=
+PLATON_PAYMENT_METHOD=CC

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+#
+
+version: 2
+updates:
+  - package-ecosystem: "" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.github/workflows/gem-push.yml

@@ -0,0 +1,38 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+        
+    - name: Run tests
+      run: |
+           bundle install
+           bundle exec rspec
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,9 @@
+.idea
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in platon.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/Gemfile.lock

@@ -0,0 +1,162 @@
+PATH
+  remote: .
+  specs:
+    platon.ua (1.0.1)
+      jbuilder (~> 2.6)
+      rails (~> 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.7)
+      actionpack (= 5.1.7)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.7)
+      actionview (= 5.1.7)
+      activesupport (= 5.1.7)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.7)
+      activesupport (= 5.1.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.7)
+      activesupport (= 5.1.7)
+      globalid (>= 0.3.6)
+    activemodel (5.1.7)
+      activesupport (= 5.1.7)
+    activerecord (5.1.7)
+      activemodel (= 5.1.7)
+      activesupport (= 5.1.7)
+      arel (~> 8.0)
+    activesupport (5.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.4)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    dotenv (2.2.0)
+    erubi (1.11.0)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jbuilder (2.6.3)
+      activesupport (>= 3.0.0, < 5.2)
+      multi_json (~> 1.2)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.2)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.3)
+    multi_json (1.12.2)
+    multipart-post (2.0.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (5.1.7)
+      actioncable (= 5.1.7)
+      actionmailer (= 5.1.7)
+      actionpack (= 5.1.7)
+      actionview (= 5.1.7)
+      activejob (= 5.1.7)
+      activemodel (= 5.1.7)
+      activerecord (= 5.1.7)
+      activesupport (= 5.1.7)
+      bundler (>= 1.3.0)
+      railties (= 5.1.7)
+      sprockets-rails (>= 2.0.0)
+    rails-controller-testing (1.0.2)
+      actionpack (~> 5.x, >= 5.0.1)
+      actionview (~> 5.x, >= 5.0.1)
+      activesupport (~> 5.x)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (5.1.7)
+      actionpack (= 5.1.7)
+      activesupport (= 5.1.7)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (13.0.6)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    sprockets (4.1.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.2.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  dotenv
+  faraday
+  jbuilder
+  platon.ua!
+  pry
+  rails-controller-testing
+  rake (~> 13.0)
+  rspec-rails
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,103 @@
+# Platon [![Ruby Gem](https://github.com/mikhail-krainik/platon/actions/workflows/gem-push.yml/badge.svg)](https://github.com/mikhail-krainik/platon/actions/workflows/gem-push.yml)
+Gateway for Platon processing center
+(https://platon.ua/)
+
+## Installation
+
+```ruby
+gem 'platon'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install platon
+```
+
+## Usage as engine
+
+##### /config/routes.rb
+
+```ruby
+Rails.application.routes.draw do
+  mount Platon::Engine => "/platon"
+end
+```
+##### /config/initializer/platon.rb
+
+Methods which called when something happen.
+```ruby
+Platon::Callbacks.setup.success =->(_result) { puts 'success' }
+
+Platon::Callbacks.setup.failed =->(_result) { puts 'failed' }
+
+Platon::Callbacks.setup.error =->(_result) { puts 'error' }
+```
+
+## Usage as service
+
+#### create form
+```
+# product description (important keys)
+data = {amount: '99.99', currency: 'USD', description: 'Show desciption less that 255 byte'} 
+
+# product order id (important key)
+order = 1892
+
+# addition field in form :name, :value
+ext = [{name: 'discont', value: 10}]
+
+@service = Platon::FormService.call(data, order: order, extra_fields: ext)
+
+# views/pay/index.html.erb
+<form action="<%= @service.form_prop[:url] %>" method="<%= @service.form_prop[:method] %>">
+  <% @service.fields.map do |field| %>
+    <input type="<%= field[:type] %>" name="<%= field[:name] %>" value="<%= field[:value] %>">
+  <% end %>
+  <input type="submit" value="Pay">
+</form>
+```
+
+#### parse response
+
+```
+# /app/controllers/callback_controller.rb
+
+def create
+    service = Platon::CallbackService.call(params)
+    
+    if service.success?
+        head :ok
+    else
+        head :bad_request
+    end
+end    
+```
+
+## General options
+
+```
+gem 'dotenv-rails'
+
+# config/application.rb
+Bundler.require(*Rails.groups)
+
+Dotenv::Railtie.load
+```
+
+##### /.env
+
+```ruby
+PLATON_KEY=XXXXXXXXXX
+PLATON_PASSWORD=XXXXXXXXXX
+PLATON_URL=https://secure.platononline.com/payment/auth
+PLATON_CALLBACK_URL=http://localhost/platon
+PLATON_PAYMENT_METHOD=CC
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/platon/application_controller.rb

@@ -0,0 +1,4 @@
+module Platon
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/platon/callbacks_controller.rb

@@ -0,0 +1,14 @@
+module Platon
+  class CallbacksController < ApplicationController
+
+    def create
+      service = CallbackService.call(params)
+      if service.success?
+        Platon::Callbacks.setup.success.call(params)
+      else
+        Platon::Callbacks.setup.failed.call(params)
+      end
+      head :ok
+    end
+  end
+end

data/app/controllers/platon/errors_controller.rb

@@ -0,0 +1,9 @@
+module Platon
+  class ErrorsController < ApplicationController
+
+    def show
+      Platon::Callbacks.setup.error.call(params)
+      head :ok
+    end
+  end
+end

data/app/controllers/platon/forms_controller.rb

@@ -0,0 +1,14 @@
+module Platon
+  class FormsController < ApplicationController
+    def show
+      @service = FormService.call(form_params[:data], order: form_params[:id])
+    end
+
+    private def form_params
+      params.permit(:id,
+          data: [:amount, :currency, :description, :selected, :recurring],
+          ext: [:name, :value]
+      )
+    end
+  end
+end

data/app/models/platon/callbacks.rb

@@ -0,0 +1,11 @@
+module Platon
+  class Callbacks < Struct.new(:success, :failed, :error)
+    def self.setup
+      @setup ||= Callbacks.new
+    end
+  end
+
+  Callbacks.setup.success = ->(_) {}
+  Callbacks.setup.failed = ->(_) {}
+  Callbacks.setup.error = ->(_) {}
+end

data/app/models/platon/configure.rb

@@ -0,0 +1,11 @@
+module Platon
+  class Configure < Struct.new(:account_key, :account_password, :pay_url, :callback_url, :error_url, :payment_method)
+    def self.cfg
+      @@cfg ||= Configure.new
+      if block_given?
+        yield @@cfg
+      end
+      @@cfg
+    end
+  end
+end

data/app/models/platon/encrypt.rb

@@ -0,0 +1,13 @@
+module Platon
+  class Encrypt
+    class << self
+      def code(data)
+        Base64.strict_encode64(
+            ActiveSupport::JSON.encode(
+                Hash(data)
+            )
+        )
+      end
+    end
+  end
+end

data/app/models/platon/status.rb

@@ -0,0 +1,17 @@
+module Platon
+  class Status
+    attr_accessor :order_status
+
+    def initialize(order_status)
+      @order_status = order_status.upcase
+    end
+
+    def failed?
+      %w{CHARGEBACK REFUND}.include?(@order_status)
+    end
+
+    def success?
+      %w{SALE ACCEPTED}.include?(@order_status)
+    end
+  end
+end

data/app/services/platon/callback_service.rb

@@ -0,0 +1,30 @@
+module Platon
+  class CallbackService
+    class Error < Struct.new(:message)
+      def success?
+        false
+      end
+    end
+
+    class << self
+      def call(params)
+        if params['sign'] == callback_signature(params).to_str
+          Platon::Status.new(params['status'])
+        else
+          Error.new('Error: Invalid signature')
+        end
+      end
+
+      private
+
+      def callback_signature(params)
+        Digest::MD5.hexdigest([
+                                  params['email'].to_s.reverse,
+                                  Platon::Configure.cfg.account_password,
+                                  params['order'],
+                                  (params['card'][0, 6] + params['card'][-4, 4]).reverse
+                              ].map { |_| _.to_s.upcase }.join)
+      end
+    end
+  end
+end

data/app/services/platon/form_service.rb

@@ -0,0 +1,42 @@
+require 'base64'
+
+module Platon
+  class FormService < Struct.new(:form_prop, :fields)
+    class << self
+      def call(data, order:, extra_fields: nil)
+        form_prop = { method: :POST, url: cfg.pay_url }
+
+        encrypted_data = Platon::Encrypt.code(data)
+        sign = Platon::RequestChecksumHashService.call(encrypted_data)
+
+        fields = [{ type: 'hidden', name: 'key', value: cfg.account_key },
+                  { type: 'hidden', name: 'payment', value: cfg.payment_method },
+                  { type: 'hidden', name: 'url', value: cfg.callback_url },
+                  { type: 'hidden', name: 'order', value: order },
+                  { type: 'hidden', name: 'data', value: encrypted_data },
+                  { type: 'hidden', name: 'sign', value: sign }]
+
+        if extra_fields.is_a? Hash
+          fields.push extract_extra_fields(extra_fields, keys_skip: fields.map { |i| i[:name] })
+        end
+
+        new(form_prop, fields)
+      end
+
+      private
+
+      def extract_extra_fields(extra_fields, keys_skip: [])
+        extra_fields[:ext].map do |ext|
+          skip if keys_skip.include? ext[:name]
+          {type: 'hidden', name: ext[:name], value: ext[:value]}
+        end
+      end
+
+      def cfg
+        cfg = Platon::Configure.cfg
+        raise ArgumentError, "Can't find Platon credentials" if cfg.account_key.nil?
+        cfg
+      end
+    end
+  end
+end

data/app/services/platon/request_checksum_hash_service.rb

@@ -0,0 +1,21 @@
+require 'digest'
+
+module Platon
+  class RequestChecksumHashService
+    class << self
+      def call(product_prop)
+        cfg = Platon::Configure.cfg
+        params = [
+          cfg.account_key,
+          cfg.payment_method,
+          product_prop,
+          cfg.callback_url,
+          cfg.account_password
+        ].map { |k| k.to_s.reverse.upcase }.join
+
+        d = Digest::MD5.new
+        d.hexdigest(params)
+      end
+    end
+  end
+end

data/app/views/layouts/platon/application.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/platon/forms/show.html.erb

@@ -0,0 +1,6 @@
+<form action="<%= @service.form_prop[:url] %>" method="<%= @service.form_prop[:method] %>">
+  <% @service.fields.map do |field| %>
+    <input type="<%= field[:type] %>" name="<%= field[:name] %>" value="<%= field[:value] %>">
+  <% end %>
+  <input type="submit" value="Pay">
+</form>

data/app/views/platon/forms/show.json.jbuilder

@@ -0,0 +1,12 @@
+json.form do
+  json.url @service.form_prop[:url]
+  json.method @service.form_prop[:method]
+
+  json.fields @service.fields do |field|
+    unless field[:value].nil?
+      json.type field[:type]
+      json.name field[:name]
+      json.value field[:value]
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/platon/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bitbucket-pipelines.yml

@@ -0,0 +1,19 @@
+options:
+  docker: true
+
+pipelines:
+  default:
+    - step:
+        name: install gems and run tests
+        image: eticket/eticket-ruby-base:2.3.1
+        caches:
+          - bundler
+        script:
+          - export RAILS_ENV=ci
+          - gem install bundler
+          - gem install bundler --no-ri --no-rdoc
+          - bundle install --path vendor/bundle
+          - bundle exec rspec spec
+definitions:
+  caches:
+    bundler: vendor/bundle

data/config/routes.rb

@@ -0,0 +1,5 @@
+Platon::Engine.routes.draw do
+  resource :callbacks, only: :create
+  resource :errors, only: :show
+  resource :forms, only: :show
+end

data/lib/platon/engine.rb

@@ -0,0 +1,12 @@
+module Platon
+  class Engine < ::Rails::Engine
+    isolate_namespace Platon
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/support/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/platon/version.rb

@@ -0,0 +1,3 @@
+module Platon
+  VERSION = '1.0.1'
+end

data/lib/platon.rb

@@ -0,0 +1,5 @@
+require "platon/engine"
+
+module Platon
+  # Your code goes here...
+end

data/lib/tasks/platon_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :platon do
+#   # Task goes here
+# end