prodamus 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '08f4d1e8a6e80f4d32aca52776e9e798ade8acc9def89e98e957a32b65414522'
+  data.tar.gz: b0d257bf1f9904ead2472a6337ed5adb7fa6a64e7a7e4d837eb4a3764245827e
+SHA512:
+  metadata.gz: 5d5215fca8b35e60c4937f6e6f9c94fc45f96ba769e7f3203fc737b25d2f1e71a6cf5c6f912b0b8001ab97a5c23eb04a112b8d4fb120d43967228c9b27774833
+  data.tar.gz: 73fb2ea1c256fcb6b5aba066ac0e25da371d48086b1ddeae67a88a0e2e34687d73a35820871bef5ce10633f8bb724996832249e3d370afd89af4866179bd2b9b

data/README.md

@@ -0,0 +1,106 @@
+# Purchase integration with https://prodamus.ru/
+
+## Client library for ruby apps
+
+Prodamus docs https://help.prodamus.ru/
+
+# Example usage:
+
+* configure connection
+
+      Prodamus.config do |conf|
+        conf.main_payment_form_url = <payment form provided by prodamus>
+        conf.secret_key = <key from main form settings>
+      end
+
+  or
+
+      Prodamus.main_payment_form_url = <payment form provided by prodamus>
+      Prodamus.secret_key = <key from main form settings>
+
+* configure request wich be sent for get purchase link
+
+      Prodamus.link_config do |conf|
+        conf.order_id = 12
+        conf.currency = 'rub'
+        ...
+      end
+  To see more parameters https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov#obshie-neobyazatelnye-parametry
+
+  * add a product or products to be purchased (must have at least one)
+
+        Prodamus.link_config.add_product(
+          name: <name>, price: <price>,
+          quantity: 1, sku: <id in your system>
+        )
+
+    Description product params https://help.prodamus.ru/payform/integracii/rest-api/instrukcii-dlya-samostoyatelnaya-integracii-servisov#parametry-massiva-products
+
+  * set link expired datetime
+
+        Prodamus.link_config.form_access_duration = 1.hour
+
+* get payment link
+
+      Prodamus.link
+
+## Submit callback
+
+Your callback from Prodamus server can be look like this:
+
+    data = {
+        date: '2022-12-08T10:42:10+03:00',
+        order_id: <id in prodamus system>,
+        order_num: <id in your system>,
+        domain: <your main form>,
+        sum: '770.00',
+        currency: 'rub',
+        customer_phone: '+78005553535',
+        customer_extra: '',
+        payment_type: 'Оплата картой, выпущенной в РФ',
+        commission: '100',
+        commission_sum: '770.00',
+        attempt: '2',
+        callbackType: 'json',
+        link_expired: '2022-12-08 11:38',
+        products: [
+          {
+            name: <product name>,
+            price: '770.00',
+            quantity: '1',
+            sum: '770.00'
+          }
+        ],
+        payment_status: payment_status,
+        payment_status_description: 'Успешная оплата',
+        payment_init: 'manual',
+        submit: {
+          date: '2022-12-08T10:42:10+03:00',
+          order_id: <id in prodamus system>,
+          order_num: <id in your system>,
+          domain: <your main form>,
+          sum: '770.00',
+          currency: 'rub',
+          customer_phone: '+78005553535',
+          customer_extra: '',
+          payment_type: 'Оплата картой, выпущенной в РФ',
+          commission: '100',
+          commission_sum: '770.00',
+          attempt: '2',
+          callbackType: 'json',
+          link_expired: '2022-12-08 11:38',
+          products: [{ name: <product name>, price: '770.00', quantity: '1', sum: '770.00' }],
+          payment_status: 'success',
+          payment_status_description: 'Успешная оплата',
+          payment_init: 'manual'
+        }
+      }
+
+Need get signature from header 'Sign' and verify this data:
+
+    sign = request.headers['Sign']
+    Prodamus.verify(data[:submit], sign)
+
+This method returns 'true' or 'false'.
+
+You must perform some actions in your system to complete purchase if this method returns'true'

data/lib/entities/product.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative '../prodamus'
+
+module Prodamus
+  # Some product to be sent to prodamus
+  class Product
+    attr_reader :name, :sku, :quantity, :price
+
+    def initialize(name:, price:, quantity: 1, sku: nil)
+      @sku = sku.to_s
+      @name = name
+      @price = price.to_s
+      @quantity = quantity.to_s
+    end
+  end
+end

data/lib/helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Prodamus
+  NON_INSTALLMENTS_PAYMENT_METHODS = %w[
+    AC ACkz ACkztjp ACf ACeuruk ACusduk ACEURNMBX
+    ACUSDNMBX SBP PC QW GP sbol invoice
+  ].freeze
+
+  INSTALLMENTS_PAYMENT_METHODS = %w[
+    installment installment_5_21 installment_6_28
+    installment_10_28 installment_12_28 installment_0_0_3
+    installment_0_0_4 installment_0_0_6 installment_0_0_10
+    installment_0_0_12 installment_0_0_24 credit
+    vsegdada_installment_0_0_4 vsegdada_installment_0_0_6 vsegdada_installment_0_0_10
+    vsegdada_installment_0_0_12 vsegdada_installment_0_0_24
+  ].freeze
+
+  ALL_AVAIBLE_PAYMENT_METHODS = NON_INSTALLMENTS_PAYMENT_METHODS + INSTALLMENTS_PAYMENT_METHODS
+end

data/lib/prodamus/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Prodamus
+  VERSION = '1.0.0'
+end

data/lib/prodamus.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require_relative 'helper'
+require_relative 'entities/product'
+require_relative 'services/verifier'
+require_relative 'services/link_config'
+
+# Main settings
+module Prodamus
+  class << self
+    # payment form provided by prodamus
+    attr_accessor :main_payment_form_url
+
+    # key from main form settings
+    attr_accessor :secret_key
+
+    def config
+      yield self if block_given?
+    end
+
+    # verify signatured data
+    def verify(data, sign)
+      verifier(data).verify(sign)
+    end
+
+    # get link to payment form
+    def link
+      response = Faraday.new(
+        url: @main_payment_form_url,
+        params: @link_config.format_result,
+        headers: { 'Content-Type' => 'text/plain', 'charset' => 'utf-8' },
+        request: { timeout: 5 }
+      ).get
+
+      raise response.body.force_encoding('utf-8') if response.status != 200
+
+      response.body
+    end
+
+    # configure the payload to receive the payment form
+    def link_config(&block)
+      @link_config ||= LinkConfig.new(&block)
+    end
+
+    def verifier(data, algorithm = 'sha256')
+      raise 'Missing secret_key.' if @secret_key.nil?
+
+      @verifier ||= Verifier.new(data, @secret_key, algorithm)
+    end
+  end
+end

data/lib/services/link_config.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/time_with_zone'
+require_relative '../prodamus'
+
+# Main settings
+module Prodamus
+  # Configure request wich be sent for get purchase link
+  class LinkConfig
+    DEFAULT_PAYMENTS_LIMIT = 1
+
+    # rubocop:disable Naming/MethodName
+    attr_accessor :order_id, :sys, :customer_phone, :customer_email,
+                  :customer_extra, :payment_method,
+                  :urlReturn, :urlSuccess, :urlNotification,
+                  :currency, :payments_limit
+    # rubocop:enable Naming/MethodName
+
+    attr_writer :form_access_duration, :timezone
+    attr_reader :products, :available_payment_methods
+
+    def initialize
+      @products = []
+      yield self if block_given?
+    end
+
+    # Transform payload to be sent
+    # rubocop:disable Metrics/MethodLength
+    def format_result
+      raise 'Product must be exists' if @products.empty?
+
+      result = {
+        'do' => 'link',
+        'callbackType' => 'json',
+        'sys' => @sys,
+        'order_id' => @order_id,
+        'customer_phone' => @customer_phone,
+        'customer_email' => @customer_email,
+        'customer_extra' => @customer_extra,
+        'payment_method' => @payment_method,
+        'available_payment_methods' => (@available_payment_methods || NON_INSTALLMENTS_PAYMENT_METHODS).join('|'),
+        'urlReturn' => @urlReturn,
+        'urlSuccess' => @urlSuccess,
+        'urlNotification' => @urlNotification,
+        'installments_disabled' => (@installments_disabled || 1).to_s,
+        'currency' => @currency,
+        'payments_limit' => (@payments_limit || DEFAULT_PAYMENTS_LIMIT).to_s,
+        'link_expired' => link_expired
+      }.compact!
+
+      @products.each_with_index do |product, index|
+        result.merge!({
+                        "products[#{index}][name]" => product.name,
+                        "products[#{index}][sku]" => product.sku,
+                        "products[#{index}][price]" => product.price,
+                        "products[#{index}][quantity]" => product.quantity
+                      })
+      end
+
+      result
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def add_product(name:, price:, quantity: 1, sku: nil)
+      @products << Product.new(name: name, price: price, quantity: quantity, sku: sku)
+    end
+
+    def add_available_payment_methods(*payment_methods)
+      payment_methods.flatten!
+
+      raise 'payment_method is already defined' if @payment
+      raise ArgumentError, 'Not avaible payment methods.' unless (payment_methods - ALL_AVAIBLE_PAYMENT_METHODS).empty?
+
+      if @installments_disabled&.positive? && !(payment_methods - NON_INSTALLMENTS_PAYMENT_METHODS).empty?
+        raise ArgumentError, 'Installments payment methods is not avaible when installments disabled.'
+      end
+
+      @available_payment_methods = [] if @available_payment_methods.nil?
+      @available_payment_methods += payment_methods
+    end
+
+    def installments_disabled=(disabled)
+      @installments_disabled = disabled ? 1 : 0
+    end
+
+    def installments_disabled
+      !@installments_disabled.zero?
+    end
+
+    def link_expired
+      tz = ActiveSupport::TimeZone.new(timezone)
+      date = tz.now + form_access_duration.to_i.seconds
+      date.strftime('%Y-%m-%d %H:%M')
+    end
+
+    def form_access_duration
+      @form_access_duration || 1.day
+    end
+
+    def timezone
+      @timezone || 'Moscow'
+    end
+  end
+end

data/lib/services/verifier.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../prodamus'
+
+module Prodamus
+  # HMAC encoding and verify signature
+  class Verifier
+    attr_accessor :data, :key, :algorithm
+
+    def initialize(data, key, algorithm = 'sha256')
+      @data = data
+      @key = key
+      @algorithm = algorithm
+    end
+
+    def verify(sign)
+      encoded_data = encode
+      encoded_data && (encoded_data == sign)
+    end
+
+    def encode
+      data = sort(@data).to_json
+      digest = OpenSSL::Digest.new(@algorithm)
+
+      OpenSSL::HMAC.hexdigest(digest, @key, data)
+    rescue NoMethodError
+      raise ArgumentError, 'Expected a Hash with array of hashes.'
+    end
+
+    private
+
+    def sort(data)
+      data.sort.to_h.transform_values do |value|
+        value.is_a?(Array) ? value.map { |product| product.sort.to_h.transform_values(&:to_s) } : value.to_s
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: prodamus
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nikita Kondrashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.47'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.14'
+description: This gem allows to integrate Prodamus purchases service in your Rails
+  app or simple Ruby app.
+email:
+- hasenberg41@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/entities/product.rb
+- lib/helper.rb
+- lib/prodamus.rb
+- lib/prodamus/version.rb
+- lib/services/link_config.rb
+- lib/services/verifier.rb
+homepage: https://github.com/hasenberg41/prodamus
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key: 
+specification_version: 4
+summary: Prodamus purchases integration for Ruby on Rails
+test_files: []