monri 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 565bc669f0cfbbf63119c0784007bc598b2accd099b8e99fa47a483f65059a37
-  data.tar.gz: 970ef664eb0900f5c853bf860fdac430c2ac0abf14f72a1a8038b4dc2a0b94f9
+  metadata.gz: e15c7a6d551450e21cfb4d08eab441e091a8cf217e89e7cc033d864a0daf7a6e
+  data.tar.gz: b08f957de769d5a921e0e47c17b79f24409db978e36c8a91bdb264aaaf0b7d93
 SHA512:
-  metadata.gz: 9119aed8b6da8238051507afe712bcc74becda45041918030ead4f2d9ff79575d3ee180edd7c2191e808f63c17937d93563d2014ee710f107804bbf63bab6f86
-  data.tar.gz: 1f3c2dfe71df6ec9889798b787048ede14f541978d2ab915bc4c61c12373155d84bb6a2c9072024b2f286a90815d83e864b20df68b64b5a85819a944573d6c82
+  metadata.gz: c820b695a2f03781c96bf20d07966f6007bba5e7e6a40d9ffe6fc20d9d2799ac7734fc9948fe6dc43054cbab099aec7418d36c1877f608d727372759b935b15f
+  data.tar.gz: f134006d1737b1f4b03996155cd97ef2a693eeafa82906113084f48ce59bb7abaeb8eaed1b2e64ab34573c56ceb42b9c5e384d65de1bab36c84fca170ab58ad3

data/README.md

@@ -1,90 +1,3 @@
 # Monri API Library for Ruby
 
 This is the officially supported Ruby library for using Monri's APIs.
-
-## Integration
-The library supports all APIs under the following services:
-
-* [Payments API](https://docs.monri.com/documentation/api-documentation/api-v2/payment-api): Payments integration
-* [Customers API](https://docs.monri.com/documentation/api-documentation/api-v2/customers-api): Customers integration
-* [Payment Methods API](https://docs.monri.com/documentation/api-documentation/api-v2/payment-method-api): Payment methods integration
-
-For more information, refer to our [documentation](https://docs.monri.com/)
-
-## Prerequisites
-- Monri test account
-- Merchant key + authenticity token
-- Ruby >= 2.2
-
-## Installation
-
-The sole dependency is faraday for HTTP communication. Run the following command to install faraday if you don't already have it:
-
-````bash 
-bundle install
-````
-
-To validate functionality of client and run mock API tests use
-
-````bash  
-bundle install --with development 
-````
-and
-````bash 
-rspec
-````
-## Documentation
-
-Follow the rest of our guides from the [documentation](https://docs.monri.com/) on how to use this library.
-
-## Using the library
-
-### General use with API key
-
-````bash 
-require 'monri-ruby-api-library'
-````
-````ruby
-monri = Monri::Client.new
-
-monri.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
-
-````
-
-- Create a Payment
-````ruby
-response = monri.payments.create(
-  order_number: SecureRandom.hex,
-  amount: 10_00,
-  currency: 'EUR',
-  transaction_type: 'purchase'
-)
-# check if request failed
-assert !response.failed?
-# Get payment id
-puts response.id
-````
-
-### Example integration
-
-For a closer look at how our Ruby library works, clone our [example integration](https://github.com/MonriPayments/monri-ruby-example)
-
-### Running the tests
-To run the tests use :
-````bash  
-bundle install --with development 
-````
-
-
-
-## Support
-If you have a feature request, or spotted a bug or a technical problem, [create an issue here](https://github.com/MonriPayments/monri-ruby/issues/new/choose).
-
-For other questions, [contact our Support Team](https://www.monri.com).
-
-## Licence
-This repository is available under the [MIT license](https://github.com/MonriPayments/monri-ruby/blob/master/LICENSE).
-
-## See also
-* [Example integration](https://github.com/MonriPayments/monri-ruby-example)
-* [Monri docs](https://docs.monri.com/)

data/lib/monri/transactions.rb

@@ -24,6 +24,12 @@ module Monri
       :language
     ].freeze
 
+    REQUIRED_TRX_MANAGEMENT_FIELDS = [
+      :amount,
+      :currency,
+      :order_number
+    ].freeze
+
     # @param [Hash] params
     # @return [Monri::Transactions::TransactionResponse]
     def transaction(params)
@@ -49,10 +55,63 @@ module Monri
         elsif rv.success?
           rv.body
         else
-          #  TODO: how to handle this case
+          raise "Unhandled state, exception=#{rv.exception}, failed=#{rv.failed?}, success=#{rv.success?}"
         end
       end
+    end
+
+    def void(params)
+      unless params.is_a?(Hash)
+        raise Monri::Errors::InvalidArgumentsError.new('First parameter - params, should be a Hash')
+      end
+      trx_management(params.merge(transaction_type: 'void'))
+    end
+
+    def refund(params)
+      unless params.is_a?(Hash)
+        raise Monri::Errors::InvalidArgumentsError.new('First parameter - params, should be a Hash')
+      end
+      trx_management(params.merge(transaction_type: 'refund'))
+    end
+
+    def capture(params)
+      unless params.is_a?(Hash)
+        raise Monri::Errors::InvalidArgumentsError.new('First parameter - params, should be a Hash')
+      end
+      trx_management(params.merge(transaction_type: 'capture'))
+    end
+
+    private
+
+    # @param [Hash] params
+    # @return [Monri::Transactions::TransactionResponse]
+    def trx_management(params)
+      TransactionResponse.create do
+        unless params.is_a?(Hash)
+          raise Monri::Errors::InvalidArgumentsError.new('First parameter - params, should be a Hash')
+        end
+
+        missing_keys = REQUIRED_TRX_MANAGEMENT_FIELDS.reject { |k| params.has_key?(k) }
+        if missing_keys.length > 0
+          raise Monri::Errors::InvalidArgumentsError.new("Missing required keys=#{missing_keys.join(', ')}")
+        end
+
+        params[:authenticity_token] = @config.authenticity_token
+        digest_parts = [@config.merchant_key, params[:order_number], params[:amount], params[:currency]]
+        params[:digest] = Digest::SHA512.hexdigest(digest_parts.join)
 
+        req = { transaction: params }
+
+        rv = @http_client.post('/v2/trx-management', req)
+        if rv.failed?
+          raise rv.exception
+        elsif rv.success?
+          rv.body
+        else
+          raise "Unhandled state, exception=#{rv.exception}, failed=#{rv.failed?}, success=#{rv.success?}"
+        end
+      end
     end
+
   end
 end

data/monri.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'monri'
-  s.version = '0.2.0'
+  s.version = '0.3.0'
   s.required_ruby_version = '>= 2.3.0'
   s.summary = 'Ruby bindings for the Monri API'
   s.description = 'Your voyage through payment experience starts here. Learn more about how Monri helps to power your business.' \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monri
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Monri
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies: []
 description: Your voyage through payment experience starts here. Learn more about
   how Monri helps to power your business.See https://monri.com for details.