monopay-ruby 0.1.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a4c5b8555a208292b20a2769fbe598cd2efd59c594e039b05d8379e3fd01c39
-  data.tar.gz: ab1d3be69331294ecc21be5aad1a10656d0f075a0fce3fa11b91484b075f4cf6
+  metadata.gz: 855262b07f7c1bc58625497799d10574a7055ab75dddda4cb82da1b902b925be
+  data.tar.gz: 662f65553e5335d096ac041f5284236555fb4c6469b39a8f56535ea36ae4932a
 SHA512:
-  metadata.gz: 16a9eb6011cc806b5c2f10d076dea0748004a527a1e036208fab3c3e51b43ac1647aaac2700b660dd3bd5db92fdeff94e0177e5b434d6513fc1eba4190248e76
-  data.tar.gz: 93faa86e2aa40b296e25a6a7806e134800bea8e0e14f892fcd81f0395bb16f6439e97e5a5c3c2ed973b6c6937854f756cf6cf7707594384afa39ef183782063e
+  metadata.gz: ef8e096ed91863d2ce3969f4740d22da0a386975d489b4d9d8bddf47db5b38f58f890c444a6baac933521dd7fefdb864419b97e42d87c640dba6eb20f3eff46d
+  data.tar.gz: b73964a630ea445906ac8b4f2fed5a7dc37df411d1854a7dc1d5d6dcebcd806d0749deaf03d5b407be6b28b6f7aecf3208c8ac8b270736bd691067182e8ef3c3

data/CHANGELOG.md

@@ -1,8 +1,27 @@
+## [1.1.0] - 2024-08-12
+- add ability make payments' requests more advanced by adding more params into `MonopayRuby::Invoices::AdvancedInvoice::create` method
+- change private methods to protected
+- modify `request_body` for additional params
+
+## [1.0.0] - 2023-06-27
+
+### Changed
+
+### Breaking Change
+Updated method signatures in the gem to use keyword arguments instead of named arguments.
+
+###### Specifically
+`MonopayRuby::Invoices::SimpleInvoice::new` method was affected by this change.
+###### Previously
+the method was called like `new("redirect/url", "webhook/url")`. Now, it should be called like `new(redirect_url: "redirect/url", webhook_url: "webhook/url")`.
+#### Note
+This is a breaking change and will require updating your code if you are updating to this version of the gem from an earlier version.
+
 ## [0.1.1] - 2023-06-19
 
 - Fix typo in a `README.md` file
-- add ability to pass reference to an invoice by `reference` parameter in a `MonopayRuby::Invoices::SimpleInvoice::create` method
-- Use named parameter of `destionation` for "MonopayRuby::Invoices::SimpleInvoice::create" method
+- Add ability to pass reference to an invoice by `reference` parameter in a `MonopayRuby::Invoices::SimpleInvoice::create` method
+- Use keyword parameter of `destination` for "MonopayRuby::Invoices::SimpleInvoice::create" method
 
 ## [0.1.0] - 2023-06-18
 

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    monopay-ruby (0.1.1)
+    monopay-ruby (1.1.0)
       base64 (~> 0.1.1)
+      bigdecimal (~> 3.1.9)
       json (~> 2.5)
       money (~> 6.13)
       rest-client (~> 2.1)
@@ -11,6 +12,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     base64 (0.1.1)
+    bigdecimal (3.1.9)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
@@ -23,7 +25,7 @@ GEM
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    method_source (1.0.0)
+    method_source (1.1.0)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2023.0218.1)
@@ -64,6 +66,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -1,4 +1,4 @@
-[![Actions Status](https://github.com/loqimean/monopay-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/loqimean/monopay-ruby/actions)
+[![Actions Status](https://github.com/loqimean/monopay-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/loqimean/monopay-ruby/actions/workflows/ci.yml)
 
 # MonopayRuby
 
@@ -54,11 +54,32 @@ Just get the token and go to earn moneys! 🚀
 class PaymentsController < ApplicationController
   def create
     payment = MonopayRuby::Invoices::SimpleInvoice.new(
+      "https://example.com",
+      "https://example.com/payments/webhook"
+    )
+
+    if payment.create(amount: 100, destination: "Payment description",)
+      # your success code processing
+    else
+      # your error code processing
+      # flash[:error] = payment.error_messages
+    end
+  end
+end
+```
+
+## Generate advanced payment request:
+
+```ruby
+# app/controllers/payments_controller.rb
+class PaymentsController < ApplicationController
+  def create
+    payment = MonopayRuby::Invoices::AdvancedInvoice.new(
       redirect_url: "https://example.com",
       webhook_url: "https://example.com/payments/webhook"
     )
 
-    if payment.create(amount: 100, destination: "Payment description",)
+    if payment.create(amount, additional_params: {})
       # your success code processing
     else
       # your error code processing
@@ -68,6 +89,8 @@ class PaymentsController < ApplicationController
 end
 ```
 
+`additional_params` - [Read more about params](https://api.monobank.ua/docs/acquiring.html)
+
 ### Verify transaction
 
 ```ruby
@@ -88,6 +111,9 @@ class PaymentsController < ApplicationController
 end
 ```
 
+## Useful
+[Test cards](https://na-gateway.mastercard.com/api/documentation/integrationGuidelines/supportedFeatures/testAndGoLive.html?locale=en_US)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -101,3 +127,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/loqime
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Thanks for your support!
+[<img width="100" alt="RailsJazz" src="https://avatars.githubusercontent.com/u/104008706?s=200">](https://github.com/railsjazz)

data/lib/monopay-ruby/extensions/blank_method_extension.rb

@@ -0,0 +1,23 @@
+module MonopayRuby
+  module Extensions
+    module BlankMethodExtension
+      BLANK_RE = /\A[[:space:]]*\z/
+
+      refine Object do
+        # Check if the object is blank
+        #
+        # @return [Boolean] true if the object is blank, false otherwise
+        def blank?
+          nil? || respond_to?(:empty?) && empty? || (self.is_a?(String) && BLANK_RE.match?(self))
+        end
+
+        # Check if the object is present
+        #
+        # @return [Boolean] true if the object is present, false otherwise
+        def present?
+          !blank?
+        end
+      end
+    end
+  end
+end

data/lib/monopay-ruby/invoices/advanced_invoice.rb

@@ -0,0 +1,78 @@
+require_relative "simple_invoice"
+
+module MonopayRuby
+  module Invoices
+    class AdvancedInvoice < MonopayRuby::Invoices::SimpleInvoice
+      using MonopayRuby::Extensions::BlankMethodExtension
+
+      attr_reader :additional_params, :amount
+
+      # Create invoice for Monobank API
+      #
+      # This method sets up the required instance variables and then calls the `create`
+      # method from the parent class with the relevant parameters.
+      #
+      # @param amount [Numeric] The amount of the payment.
+      # @param additional_params [Hash] (optional) Additional parameters for the payment.
+      #   - :merchantPaymInfo [Hash] Information about the merchant payment.
+      #     - :destination [String] The destination of the payment.
+      #     - :reference [String] A reference for the payment.
+      #
+      # @return [Boolean] The result of the `create` method in the parent class,
+      #   which returns true if invoice was created successfully, false otherwise
+      #
+      # @example Create a payment with amount and additional parameters
+      #   create(100, additional_params: { merchantPaymInfo: { destination: "Happy payment", reference: "ref123" } })
+      def create(amount, additional_params: {})
+        @amount = amount
+        @additional_params = additional_params
+        @destination = @additional_params.dig(:merchantPaymInfo, :destination)
+        @reference = @additional_params.dig(:merchantPaymInfo, :reference)
+
+        super(amount, destination: @destination, reference: @reference)
+      end
+
+      protected
+
+      def request_body
+        current_params = default_params
+
+        return current_params.to_json if additional_params.blank?
+
+        merge_merchant_payment_info!(current_params)
+        current_params.merge!(additional_params.except(:merchantPaymInfo))
+
+        update_sum_and_qty_params(current_params.dig(:merchantPaymInfo, :basketOrder))
+        update_sum_and_qty_params(current_params[:items])
+
+        current_params.to_json
+      end
+
+      # Merges merchant payment information into the current parameters.
+      #
+      # @param current_params [Hash] The current parameters to update.
+      def merge_merchant_payment_info!(current_params)
+        return if additional_params[:merchantPaymInfo].blank?
+
+        current_params[:merchantPaymInfo] = {
+          reference: @reference,
+          destination: @destination
+        }.merge!(additional_params[:merchantPaymInfo].except(:reference, :destination))
+      end
+
+      # Updates sum and quantity parameters for the given items.
+      #
+      # @param items [Array<Hash>] The items to update.
+      def update_sum_and_qty_params(items)
+        return if items.blank?
+
+        items.each do |item|
+          next if item.blank?
+
+          item[:sum] = convert_to_cents(item[:sum] || amount)
+          item[:qty] ||= 1
+        end
+      end
+    end
+  end
+end

data/lib/monopay-ruby/invoices/simple_invoice.rb

@@ -17,7 +17,7 @@ module MonopayRuby
       #
       # @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(redirect_url = nil, webhook_url = nil)
+      def initialize(redirect_url: nil, webhook_url: nil)
         @redirect_url = redirect_url
         @webhook_url = webhook_url
 
@@ -43,7 +43,7 @@ module MonopayRuby
           @invoice_id = JSON.parse(response.body)[INVOICE_ID_KEY]
 
           true
-        rescue Exception => e
+        rescue RestClient::ExceptionWithResponse => e
           response_body = JSON.parse(e.response.body)
           @error_messages << [e.message, response_body].join(", ")
           # TODO: use errors and full_messages like rails
@@ -53,12 +53,12 @@ module MonopayRuby
         end
       end
 
-      private
+      protected
 
-      # Request body required for Monobank API
+      # Default params required for request to Monobank
       #
-      # @return [Hash] request body
-      def request_body
+      # @return [Hash] default params
+      def default_params
         # TODO: add "ccy" and another missing params
         # TODO: remove nil valued params
         {
@@ -69,7 +69,14 @@ module MonopayRuby
             reference: reference,
             destination: destination
           }
-        }.to_json
+        }
+      end
+
+      # Request body required for Monobank API
+      #
+      # @return [Hash] request body
+      def request_body
+        default_params.to_json
       end
 
       def convert_to_cents(amount)

data/lib/monopay-ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MonopayRuby
-  VERSION = "0.1.1"
+  VERSION = "1.1.0"
 end

data/lib/monopay-ruby/webhooks/public_key.rb

@@ -2,7 +2,6 @@ require "rest-client"
 require "base64"
 require "json"
 
-require "pry"
 module MonopayRuby
   module Webhooks
     class PublicKey < MonopayRuby::Base

data/lib/monopay-ruby.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+begin
+  require "pry"
+rescue LoadError
+end
+
 module MonopayRuby
   class Base
     API_URL = "https://api.monobank.ua/api".freeze

data/monopay-ruby.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "json", "~> 2.5"
   # spec.add_dependency "openssl", "~> 2.1"
   spec.add_dependency "money", "~> 6.13"
+  spec.add_dependency "bigdecimal", "~> 3.1.9"
 
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.14.2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monopay-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.1.0
 platform: ruby
 authors:
 - loqimean
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2025-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.13'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.9
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -130,6 +144,8 @@ files:
 - Rakefile
 - lib/monopay-ruby.rb
 - lib/monopay-ruby/configuration.rb
+- lib/monopay-ruby/extensions/blank_method_extension.rb
+- lib/monopay-ruby/invoices/advanced_invoice.rb
 - lib/monopay-ruby/invoices/simple_invoice.rb
 - lib/monopay-ruby/version.rb
 - lib/monopay-ruby/webhooks/public_key.rb
@@ -158,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The "monopay-ruby" gem is a powerful Ruby library designed for seamless integration