mono-merchant 0.1.0 → 0.2.0

checksums.yaml

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

data/README.md

@@ -31,6 +31,15 @@ Development: [https://api.monobank.ua/](https://api.monobank.ua/)
 
 Production: [https://fop.monobank.ua/](https://fop.monobank.ua/)
 
+### Verify webhook transaction
+
+```ruby
+
+request_to_validate = MonoMerchant::WebhookValidator.new(request)
+request_to_validate.valid?
+
+```
+
 ### Create invoice request
 
 ```ruby
@@ -40,15 +49,42 @@ MonoMerchant::Invoice::Create.new(amount) # see other params in code comments
 
 ```
 
-### Verify webhook transaction
+### Other methods
 
 ```ruby
 
-request_to_validate = MonoMerchant::WebhookValidator.new(request)
-request_to_validate.valid?
+# Invoice
+MonoMerchant::Invoice::Status.new(invoice_id) # check status
+MonoMerchant::Invoice::Cancel.new(invoice_id) # cancel successful payment
+MonoMerchant::Invoice::Remove.new(invoice_id) # invalidate created invoice 
+MonoMerchant::Invoice::Finalize.new(invoice_id, amount, items: []) # finalize holding amount with possibility to modify it 
+MonoMerchant::Invoice::FiscalChecks.new(invoice_id) # get fiscal check(s) 
+
+# QR
+MonoMerchant::Qr::List.new # list QR cash-boxes
+MonoMerchant::Qr::Details.new(qr_id) # get QR details
+MonoMerchant::Qr::ResetAmount.new(qr_id) # reset/remove payment
+
+# Submerchant
+MonoMerchant::Submerchant::List.new # get list of submerchants
+
+# Wallet
+MonoMerchant::Wallet::List.new(wallet_id)
+MonoMerchant::Wallet::Card.new(card_token) # delete card token
+MonoMerchant::Wallet::Payment.new(card_token, amount) # see other attributes directly in code
+
+# Merchant
+MonoMerchant::Details.new # basic info about merchant: Id, Name, edrpou
+MonoMerchant::Statement.new(from: 1649329978, to: 1649329978) # get bank account statement for defined period. from & to are utc unix timestamps
 
 ```
 
+## TODO
+
+- [credentials payment](https://api.monobank.ua/docs/acquiring.html#/paths/~1api~1merchant~1invoice~1payment-direct/post)
+- better Readme
+- minor todos (noticed directly in code)
+
 ## 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.

data/lib/mono-merchant/details.rb

@@ -0,0 +1,15 @@
+module MonoMerchant
+  class Details < ApiRequest
+
+    def initialize
+      super(type: :get)
+    end
+
+    protected
+
+    def data
+      %w[merchantId merchantName edrpou]
+    end
+
+  end
+end

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

@@ -8,6 +8,7 @@ module MonoMerchant
 
       def initialize(invoice_id, amount, ext_ref: nil, items: [])
         @invoice_id, @amount, @items, @ext_ref = invoice_id, amount, items, ext_ref
+        super()
       end
 
       protected

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

@@ -16,17 +16,17 @@ module MonoMerchant
       # @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)
+      def initialize(amount, currency: DEFAULT_CURRENCY, items: [], hold: false, reference: nil, redirect_url: nil, webhook_url: nil, email: nil, destination: 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
+        @currency = Money::Currency.new(currency)
+        @items = items.map { |i| Item.new(i).to_hash.presence }
+        @payment_type = hold ? 'hold' : 'debit'
         super()
       end
 

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MonoMerchant
+  module Invoice
+
+    class FiscalChecks < PaymentInfo
+
+      protected
+
+      # todo: objectify array of checks?
+      # https://api.monobank.ua/docs/acquiring.html#/paths/~1api~1merchant~1invoice~1fiscal-checks?invoiceId={invoiceId}/get
+      def data
+        %w[checks]
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module MonoMerchant
 
       def initialize(invoice_id)
         @invoice_id = invoice_id
+        super()
       end
 
       protected

data/lib/mono-merchant/qr/details.rb

@@ -0,0 +1,24 @@
+module MonoMerchant
+  module Qr
+
+    # Get info about QR paydesk
+    class Details < ApiRequest
+
+      attr_reader :qr_id
+
+      def initialize(qr_id)
+        @qr_id = qr_id
+        super(type: :get)
+      end
+
+      protected
+      def params
+        { qrId: qr_id }
+      end
+
+      def data
+        %w[shortQrId invoiceId amount ccy]
+      end
+    end
+  end
+end

data/lib/mono-merchant/qr/list.rb

@@ -0,0 +1,17 @@
+module MonoMerchant
+  module Qr
+
+    # Get list of QR paydesks
+    class List < ApiRequest
+
+      def initialize
+        super(type: :get)
+      end
+
+      # todo: make array of objects from response list (shortQrId, qrId, amountType, pageUrl)?
+      def data
+        %w[list]
+      end
+    end
+  end
+end

data/lib/mono-merchant/qr/reset_amount.rb

@@ -0,0 +1,21 @@
+module MonoMerchant
+  module Qr
+
+    # Reset/remove payment
+    class ResetAmount < ApiRequest
+
+      attr_reader :qr_id
+
+      def initialize(qr_id)
+        @qr_id = qr_id
+        super()
+      end
+
+      protected
+
+      def body
+        { qrId: qr_id }
+      end
+    end
+  end
+end

data/lib/mono-merchant/statement.rb

@@ -0,0 +1,26 @@
+module MonoMerchant
+  class Statement < ApiRequest
+
+    attr_reader :from, :to
+
+    # @param [Integer] from - utc unix timestamp
+    # @param [Integer] to - utc unix timestamp
+    def initialize(from: nil, to: nil)
+      @from, @to = from, to
+      super(type: :get)
+    end
+
+    protected
+
+    def params
+      { from: from, to: to }.compact
+    end
+
+    # todo: objectify data?
+    # https://api.monobank.ua/docs/acquiring.html#/paths/~1api~1merchant~1statement/get
+    def data
+      %w[list]
+    end
+
+  end
+end

data/lib/mono-merchant/submerchant/list.rb

@@ -0,0 +1,17 @@
+module MonoMerchant
+  module Submerchant
+
+    # Get list of sub-merchants
+    class List < ApiRequest
+
+      def initialize
+        super(type: :get)
+      end
+
+      # todo: make array of objects from response list (code, edrpou, iban)?
+      def data
+        %w[list]
+      end
+    end
+  end
+end

data/lib/mono-merchant/version.rb

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

data/lib/mono-merchant/wallet/card.rb

@@ -0,0 +1,23 @@
+module MonoMerchant
+  module Wallet
+
+    # Remove card token
+    class Card < ApiRequest
+
+      attr_reader :card_token
+
+      def initialize(card_token)
+        @card_token = card_token
+        super(type: :delete)
+      end
+
+      protected
+
+      def body
+        { cardToken: card_token }
+      end
+
+    end
+  end
+end
+

data/lib/mono-merchant/wallet/list.rb

@@ -0,0 +1,31 @@
+module MonoMerchant
+  module Wallet
+    class List < ApiRequest
+
+      attr_reader :wallet_id
+
+      # @param [String] wallet_id - wallet id
+      def initialize(wallet_id = nil)
+        @wallet_id = wallet_id
+        super(type: :get)
+      end
+
+      def url
+        "#{API_URL}/merchant/wallet/#{url_query}"
+      end
+
+      protected
+
+      def params
+        { walletId: wallet_id }.compact
+      end
+
+      # todo: objectify wallets?
+      # https://api.monobank.ua/docs/acquiring.html#/paths/~1api~1merchant~1wallet/get
+      def data
+        %w[wallet]
+      end
+
+    end
+  end
+end

data/lib/mono-merchant/wallet/payment.rb

@@ -0,0 +1,55 @@
+module MonoMerchant
+  module Wallet
+
+    # Create payment for card token
+    # todo DRY it with Invoice::Create
+    class Payment < ApiRequest
+
+      attr_reader :card_token, :amount, :currency, :initiation_kind, :customer_emails, :items, :destination, :comment, :reference, :redirect_url, :webhook_url
+
+      def initialize(card_token, amount, currency = DEFAULT_CURRENCY, by_client: false, items: [], reference: nil, redirect_url: nil, webhook_url: nil, email: nil, destination: nil, comment: nil)
+        @card_token = card_token
+        @amount = convert_to_cents(amount)
+        @destination = destination
+        @reference = reference
+        @comment = comment
+        @customer_emails = [email] if email
+        @redirect_url = redirect_url
+        @webhook_url = webhook_url
+        @currency = Money::Currency.new(currency)
+        # todo: append barcode, uktzed, tax, discounts etc.
+        @items = items.map { |i| Invoice::Item.new(i).to_hash.presence }
+        @initiation_kind = by_client ? 'client' : 'merchant'
+        super()
+      end
+
+      protected
+
+      delegate :iso_numeric, to: :currency, prefix: true
+      alias_method :ccy, :currency_iso_numeric
+
+      def body
+        {
+          ccy: ccy.to_i,
+          amount: amount,
+          initiationKind: initiation_kind,
+          redirectUrl: redirect_url,
+          webHookUrl: webhook_url,
+          merchantPaymInfo: {
+            basketOrder: items.presence,
+            reference: reference,
+            comment: comment,
+            destination: destination,
+            customerEmails: customer_emails
+          }.compact
+        }
+      end
+
+      def data
+        %w[invoiceId tdsUrl status failureReason amount ccy createdDate modifiedDate]
+      end
+
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mono-merchant
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - okliv
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-24 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -99,15 +99,25 @@ files:
 - Rakefile
 - lib/mono-merchant.rb
 - lib/mono-merchant/api_request.rb
+- lib/mono-merchant/details.rb
 - lib/mono-merchant/invoice/cancel.rb
 - lib/mono-merchant/invoice/create.rb
 - lib/mono-merchant/invoice/finalize.rb
+- lib/mono-merchant/invoice/fiscal_checks.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/qr/details.rb
+- lib/mono-merchant/qr/list.rb
+- lib/mono-merchant/qr/reset_amount.rb
+- lib/mono-merchant/statement.rb
+- lib/mono-merchant/submerchant/list.rb
 - lib/mono-merchant/version.rb
+- lib/mono-merchant/wallet/card.rb
+- lib/mono-merchant/wallet/list.rb
+- lib/mono-merchant/wallet/payment.rb
 - lib/mono-merchant/webhook_validator.rb
 - mono-merchant.gemspec
 homepage: https://github.com/okliv/mono-merchant