mono-merchant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 860b077a7edd26128447c2a0060fed0306052cf77c0407e1962820162458e4f2
+  data.tar.gz: 137cbd38e0e13f0e236a022806e75eb1d20afe2ac39779776a9ee0a1515a1505
+SHA512:
+  metadata.gz: ec0b7c50d1d580835ab9058d683ba8a305f475acbe991e1d82f2d971c4d14818e51fb6ee0bcc67b51e9114e6236cbcb8854d63ca1cfceabe9ac051838290d2e2
+  data.tar.gz: 53ab66068dcd5728e68f614dd9c2f7091798912d59828e8c27dcf7b456c7b8f017968b543d440d1f2a391d44850faa6521815bbe6f1cb076aa6b4640fce61b3f

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mono-merchant.gemspec
+gemspec
+
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    mono-merchant (1.0.0)
+      activesupport (~> 7)
+      base64 (~> 0.2)
+      json (~> 2.5)
+      money (~> 6.16)
+      rest-client (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    domain_name (0.6.20240107)
+    drb (2.2.0)
+      ruby2_keywords
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.7.1)
+    mime-types (3.5.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2024.0206)
+    minitest (5.22.2)
+    money (6.16.0)
+      i18n (>= 0.6.4, <= 2)
+    mutex_m (0.2.0)
+    netrc (0.11.0)
+    rake (13.1.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mono-merchant!
+  rake
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 okliv
+
+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,64 @@
+# MonoMerchant
+
+The "mono-merchant" gem simplifies [Monobank API](https://api.monobank.ua/docs/acquiring.html) usage in Ruby applications.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add "mono-merchant"
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```ruby
+gem install "mono-merchant"
+```
+
+## Usage
+
+Add API token to the environment variable:
+
+```bash
+# .env
+MONOBANK_API_TOKEN=your_api_token
+```
+
+#### You can get the API token depending on the environment:
+
+Development: [https://api.monobank.ua/](https://api.monobank.ua/)
+
+Production: [https://fop.monobank.ua/](https://fop.monobank.ua/)
+
+### Create invoice request
+
+```ruby
+
+amount = 100 # in cents
+MonoMerchant::Invoice::Create.new(amount) # see other params in code comments 
+
+```
+
+### Verify webhook transaction
+
+```ruby
+
+request_to_validate = MonoMerchant::WebhookValidator.new(request)
+request_to_validate.valid?
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/okliv/mono-merchant.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/mono-merchant/api_request.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  class ApiRequest
+
+    API_URL = "https://api.monobank.ua/api"
+    DEFAULT_CURRENCY = "UAH"
+
+    attr_reader :errors, :type
+
+    def initialize(type: :post)
+      @type = type
+      @errors = []
+      response
+    end
+
+    def url
+      "#{API_URL}/#{self.class.name.underscore.dasherize.sub('mono-', '')}#{url_query}"
+    end
+
+    protected
+
+    # Required headers for Monobank API
+    #
+    # @return [Hash] headers
+    def headers
+      warn 'ENV["MONOBANK_API_TOKEN"] is absent' unless ENV["MONOBANK_API_TOKEN"]
+      {
+        content_type: :json,
+        accept: :json,
+        "X-Token": ENV["MONOBANK_API_TOKEN"]
+      }
+    end
+
+    def url_query
+      "#{'?' if params.presence}#{URI.encode_www_form(params.to_hash)}" if type == :get
+    end
+
+    def params
+      {}
+    end
+
+    def body
+      {}
+    end
+
+    def convert_to_cents(amount)
+      if amount.is_a?(BigDecimal)
+        Money.from_amount(amount, currency).cents
+      else
+        amount
+      end
+    end
+
+    private
+
+    # @return [Hash] response body or false in case of errors
+    def response
+      @response ||= begin
+                      response = case type
+                                 when :post
+                                   RestClient.post(url, body.compact.to_json, headers)
+                                 when :get
+                                   RestClient.get(url, headers)
+                                 when :delete
+                                   RestClient.delete(url, headers)
+                                 end
+                      body = JSON.parse(response.body)
+                      Hash[data.map { |rp| [rp, body[rp]] }]
+                    rescue StandardError => e
+                      response_body = JSON.parse(e.response.body) rescue {}
+                      @errors << [e.message, { response_body['errCode'] => response_body['errText'] }]
+                      warn @errors
+                      false
+                    end
+    end
+    def method_missing(name, *args)
+      cam_name = name.to_s.camelize(:lower)
+      return super unless data.include?(cam_name)
+
+      response[cam_name] if response
+    end
+  end
+end

data/lib/mono-merchant/invoice/cancel.rb

@@ -0,0 +1,25 @@
+module MonoMerchant
+  module Invoice
+
+    # Cancel successful payment
+    class Cancel < ApiRequest
+
+      attr_reader :ext_ref, :invoice_id, :amount, :items
+
+      def initialize(invoice_id, amount, ext_ref: nil, items: [])
+        @invoice_id, @amount, @items, @ext_ref = invoice_id, amount, items, ext_ref
+      end
+
+      protected
+
+      def body
+        { invoiceId: invoice_id,
+          amount: amount,
+          extRef: ext_ref,
+          items: items.presence
+        }
+      end
+    end
+  end
+end
+

data/lib/mono-merchant/invoice/create.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+    # Create invoice
+    class Create < ApiRequest
+      attr_reader :amount, :currency, :payment_type, :customer_emails, :items, :destination, :comment, :reference, :redirect_url, :webhook_url
+
+      # @param [BigDecimal,Integer] amount (cents) to request payment
+      # @param [String] destination - additional info about payment
+      # @param [String] reference - bill number or other reference
+      # @param [String] comment - internal service info
+      # @param [String] currency - currency iso code
+      # @param [Boolean] hold - if payment type is 'hold' (default: 'debit')
+      # @param [String] email - client email
+      # @param [Array] items - cart content
+      # @param [String] redirect_url - url where user will be redirected after payment
+      # @param [String] webhook_url - url where Monobank will send webhook after payment
+      def initialize(amount, destination: nil, reference: nil, currency: DEFAULT_CURRENCY, hold: false, email: nil, items: [], redirect_url: nil, webhook_url: nil, comment: nil)
+        @amount = convert_to_cents(amount)
+        @destination = destination
+        @reference = reference
+        @comment = comment
+        @currency = Money::Currency.new(currency)
+        @payment_type = hold ? 'hold' : 'debit'
+        @customer_emails = [email] if email
+        @items = items.map { |i| Item.new(i).to_hash.presence }
+        @redirect_url = redirect_url
+        @webhook_url = webhook_url
+        super()
+      end
+
+      protected
+
+      delegate :iso_numeric, to: :currency, prefix: true
+      alias_method :ccy, :currency_iso_numeric
+      def body
+        {
+          ccy: ccy.to_i,
+          amount: amount,
+          paymentType: payment_type,
+          redirectUrl: redirect_url,
+          webHookUrl: webhook_url,
+          merchantPaymInfo: {
+            basketOrder: items.presence,
+            reference: reference,
+            comment: comment,
+            destination: destination,
+            customerEmails: customer_emails
+          }.compact
+        }
+      end
+
+      def data
+        %w[pageUrl invoiceId]
+      end
+
+    end
+  end
+end

data/lib/mono-merchant/invoice/finalize.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+
+    # Finalize holding amount
+    class Finalize < ApiRequest
+      attr_reader :invoice_id, :amount, :items
+
+      def initialize(invoice_id, amount, items: [])
+        @invoice_id = invoice_id
+        @amount = amount
+        @items = items.map { |i| Item.new(i).to_hash }
+        super()
+      end
+
+      protected
+
+      def body
+        { invoiceId: invoice_id,
+          amount: amount,
+          items: items.presence
+        }
+      end
+
+      def data
+        %w[status]
+      end
+    end
+  end
+end

data/lib/mono-merchant/invoice/item.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+    class Item
+
+      REQUIRED_ATTRS = %i[name qty sum code]
+
+      attr_reader *REQUIRED_ATTRS, :icon, :unit, :header, :footer
+
+      def initialize(i)
+        # TODO: check required?
+        @name = i[:name]
+        @qty = i[:qty]
+        @sum = i[:sum]
+        @code = i[:code]
+        # optional
+        @icon = i[:icon]
+        @unit = i[:unit]
+        @header = i[:header]
+        @footer = i[:footer]
+      end
+
+      def to_hash
+        { name: name,
+          qty: qty,
+          sum: sum,
+          code: code,
+          icon: icon,
+          unit: unit,
+          header: header,
+          footer: footer }.compact
+      end
+    end
+  end
+end

data/lib/mono-merchant/invoice/payment_info.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+
+    class PaymentInfo < ApiRequest
+
+      attr_reader :invoice_id
+
+      def initialize(invoice_id)
+        @invoice_id = invoice_id
+        super(type: :get)
+      end
+
+      protected
+      def params
+        { invoiceId: invoice_id }
+      end
+
+      def data
+        %w[maskedPan approvalCode rrn amount ccy finalAmount createdDate terminal paymentScheme paymentMethod fee domesticCard domesticCard cancelList]
+      end
+    end
+  end
+end

data/lib/mono-merchant/invoice/remove.rb

@@ -0,0 +1,22 @@
+module MonoMerchant
+  module Invoice
+
+    # Invalidate invoice
+    class Remove < ApiRequest
+
+      attr_reader :invoice_id
+
+      def initialize(invoice_id)
+        @invoice_id = invoice_id
+      end
+
+      protected
+
+      def body
+        { invoiceId: invoice_id }
+      end
+
+    end
+  end
+end
+

data/lib/mono-merchant/invoice/status.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+
+    class Status < PaymentInfo
+
+      protected
+
+      def data
+        %w[status failureReason errCode amount ccy finalAmount createdDate modifiedDate reference cancelList walletData]
+      end
+    end
+  end
+end

data/lib/mono-merchant/pubkey.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  class Pubkey < ApiRequest
+
+    def self.get
+      @@get ||= begin
+                  key = new.key
+                  Base.decode key if key
+                end
+    end
+
+    def self.reset
+      @@get = nil
+      self.get
+    end
+
+    def initialize
+      super(type: :get)
+    end
+
+    private
+
+    def data
+      %w[key]
+    end
+  end
+end

data/lib/mono-merchant/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  VERSION = "0.1.0"
+end

data/lib/mono-merchant/webhook_validator.rb

@@ -0,0 +1,47 @@
+module MonoMerchant
+  class WebhookValidator
+
+    def initialize(request)
+      @request = request
+      @webhook_data = @request.raw_post
+    end
+
+    def public_key
+      Pubkey.get
+    end
+
+    # Validate webhook data signature with public key
+    #
+    # @return [Boolean] valid?
+    def valid?
+      return false if @webhook_data.nil?
+      return false if signature.nil?
+      return false unless public_key
+
+      openssl_ec = OpenSSL::PKey::EC.new(public_key)
+      openssl_ec.check_key
+
+      return true if openssl_ec.verify(digest, signature, @webhook_data)
+
+      warn "Webhook isn't authorized. Might be wrong signature or inconsistent webhook data."
+
+      false
+    end
+
+    private
+
+    # Get signature from request headers
+    #
+    # @return [String] signature
+    def signature
+      @signature ||= Base.decode(@request.headers["X-Sign"])
+    end
+
+    # Get digest from OpenSSL
+    #
+    # @return [OpenSSL::Digest] digest
+    def digest
+      @digest ||= OpenSSL::Digest.new("SHA256")
+    end
+  end
+end

data/lib/mono-merchant.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/object/blank'
+require "base64"
+require "bigdecimal"
+require "json"
+require "money"
+require "rest-client"
+
+module MonoMerchant
+  class Base
+    def self.decode(str)
+      Base64.decode64(str)
+    end
+  end
+end
+
+Dir.glob(File.join(__dir__, "mono-merchant", "/**/*.rb")).sort.each { |file| require file }

data/mono-merchant.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# to load all /lib files
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require_relative "lib/mono-merchant/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mono-merchant"
+  spec.version = MonoMerchant::VERSION
+  spec.authors = ['okliv']
+  spec.email = ["ok@entitative.com"]
+
+  spec.summary = "The \"mono-merchant\" gem is a powerful Ruby library designed for seamless integration with Monobank's acquiring system. It provides a convenient way to handle Monobank payments."
+  spec.description = "The \"mono-merchant\" gem simplifies Monobank payment integration in Ruby applications. It provides an simplified interface and essential functionalities for generating invoice requests, verifying transactions, handling webhooks to ensure data integrity. With this gem, you can quickly and securely implement Monobank payments."
+  spec.homepage = "https://github.com/okliv/mono-merchant"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/okliv/mono-merchant"
+  spec.metadata["changelog_uri"] = "https://github.com/okliv/mono-merchant/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rest-client", "~> 2.1"
+  spec.add_dependency "base64", "~> 0.2"
+  spec.add_dependency "json", "~> 2.5"
+  spec.add_dependency "money", "~> 6.16"
+  spec.add_dependency "activesupport", "~> 7"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: mono-merchant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- okliv
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.16'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: The "mono-merchant" gem simplifies Monobank payment integration in Ruby
+  applications. It provides an simplified interface and essential functionalities
+  for generating invoice requests, verifying transactions, handling webhooks to ensure
+  data integrity. With this gem, you can quickly and securely implement Monobank payments.
+email:
+- ok@entitative.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mono-merchant.rb
+- lib/mono-merchant/api_request.rb
+- lib/mono-merchant/invoice/cancel.rb
+- lib/mono-merchant/invoice/create.rb
+- lib/mono-merchant/invoice/finalize.rb
+- lib/mono-merchant/invoice/item.rb
+- lib/mono-merchant/invoice/payment_info.rb
+- lib/mono-merchant/invoice/remove.rb
+- lib/mono-merchant/invoice/status.rb
+- lib/mono-merchant/pubkey.rb
+- lib/mono-merchant/version.rb
+- lib/mono-merchant/webhook_validator.rb
+- mono-merchant.gemspec
+homepage: https://github.com/okliv/mono-merchant
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/okliv/mono-merchant
+  source_code_uri: https://github.com/okliv/mono-merchant
+  changelog_uri: https://github.com/okliv/mono-merchant/blob/master/CHANGELOG.md
+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.1.4
+signing_key:
+specification_version: 4
+summary: The "mono-merchant" gem is a powerful Ruby library designed for seamless
+  integration with Monobank's acquiring system. It provides a convenient way to handle
+  Monobank payments.
+test_files: []