monri 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a293840879ec1c2ca086127eab2b5dcd4b0ecae1e87d797ae164eb0f3f64bbe
-  data.tar.gz: 9f08d57418affeee5e63778326921edbf50341dde0dc522679a0e54e5e7a6730
+  metadata.gz: 565bc669f0cfbbf63119c0784007bc598b2accd099b8e99fa47a483f65059a37
+  data.tar.gz: 970ef664eb0900f5c853bf860fdac430c2ac0abf14f72a1a8038b4dc2a0b94f9
 SHA512:
-  metadata.gz: 2b1cade51de3cdf2694d5e4f7e98d8fbcd790087f411d1ff47fd31d10605a1aa4de675461a346c286d8aeb4318287a1d0c995546964b7b79f4b65bebcc04a4ae
-  data.tar.gz: d763cb8b2c1e5a757d2866dd4c77bbbbe0f79c9ce53d08f65d39d2f48dd30edcfc175849907ea8b3d208e3d33f8e13cc64c35d922adb8092fe9d5db6bf13bcf7
+  metadata.gz: 9119aed8b6da8238051507afe712bcc74becda45041918030ead4f2d9ff79575d3ee180edd7c2191e808f63c17937d93563d2014ee710f107804bbf63bab6f86
+  data.tar.gz: 1f3c2dfe71df6ec9889798b787048ede14f541978d2ab915bc4c61c12373155d84bb6a2c9072024b2f286a90815d83e864b20df68b64b5a85819a944573d6c82

data/Gemfile

@@ -9,16 +9,17 @@ group :development do
   gem 'mocha', '~> 0.13.2'
   gem 'rack', '>= 2.0.6'
   gem 'rake'
+  gem 'pry'
+  gem 'pry-byebug'
 
   gem 'test-unit'
 
   gem 'webmock', '>= 3.8.0'
 
   gem 'rubocop', '~> 1.43', require: false
+  gem 'simplecov', require: false, group: :test
 
   platforms :mri do
     gem 'byebug'
-    gem 'pry'
-    gem 'pry-byebug'
   end
 end

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2023] [Monri Payments]
+
+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

@@ -1 +1,90 @@
-# monri-ruby
+# 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/{bin → exe}/byebug

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/jasminsuljic/.rbenv/versions/2.6.3/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/{bin → exe}/coderay

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/jasminsuljic/.rbenv/versions/2.6.3/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/{bin → exe}/rake

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/jasminsuljic/.rbenv/versions/2.6.3/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/extensions/x86_64-darwin-19/2.6.0/byebug-11.1.3/gem_make.out

@@ -1,5 +1,5 @@
 current directory: /Users/jasminsuljic/developing/monri/ruby-sdk-monri/gems/byebug-11.1.3/ext/byebug
-/Users/jasminsuljic/.rbenv/versions/2.6.3/bin/ruby -I /Users/jasminsuljic/.rbenv/versions/2.6.3/lib/ruby/2.6.0 -r ./siteconf20221114-79509-1h8arsl.rb extconf.rb
+/Users/jasminsuljic/.rbenv/versions/2.6.3/bin/ruby -I /Users/jasminsuljic/.rbenv/versions/2.6.3/lib/ruby/2.6.0 -r ./siteconf20230111-7399-1izsgck.rb extconf.rb
 creating Makefile
 
 current directory: /Users/jasminsuljic/developing/monri/ruby-sdk-monri/gems/byebug-11.1.3/ext/byebug
@@ -1037,7 +1037,8 @@ threads.c:85:37: note: ')' token is here
                           ^~~
 2 warnings generated.
 linking shared-object byebug/byebug.bundle
+ld: warning: -undefined dynamic_lookup may not work with chained fixups
 
 current directory: /Users/jasminsuljic/developing/monri/ruby-sdk-monri/gems/byebug-11.1.3/ext/byebug
 make "DESTDIR=" install
-/usr/bin/install -c -m 0755 byebug.bundle ./.gem.20221114-79509-5pxjsw/byebug
+/usr/bin/install -c -m 0755 byebug.bundle ./.gem.20230111-7399-p10xqg/byebug

data/lib/monri/access_tokens/create_response.rb

@@ -0,0 +1,37 @@
+module Monri
+  class AccessTokens
+    class CreateResponse < Response
+
+      # @return [String]
+      def access_token
+        self[:access_token]
+      end
+
+      # @return [String]
+      def status
+        self[:status]
+      end
+
+      # @return [String]
+      def token_type
+        self[:token_type]
+      end
+
+      # @return [String]
+      def expires_in
+        self[:expires_in]
+      end
+
+      # @return [CreateResponse]
+      def self.create
+        raise ArgumentError, 'Provide a block' unless block_given?
+
+        begin
+          CreateResponse.new(yield)
+        rescue StandardError => e
+          CreateResponse.new(exception: e)
+        end
+      end
+    end
+  end
+end

data/lib/monri/access_tokens.rb

@@ -7,20 +7,37 @@ module Monri
     # @return [Monri::HttpClient]
     attr_writer :http_client
 
+    # @param [Hash] options
+    # @return [Monri::AccessTokens::CreateResponse]
+    def create!(options)
+      rv = create(options)
+      if rv.failed?
+        #noinspection RubyMismatchedArgumentType
+        raise rv.exception
+      end
+      rv
+    end
+
+    # @param [Hash] options
+    # @return [Monri::AccessTokens::CreateResponse]
     def create(options)
-      body = {
-        client_id: config.authenticity_token,
-        client_secret: config.merchant_key,
-        grant_type: 'client_credentials',
-        scopes: options.delete(:scopes) || []
-      }
-      response = @http_client.post('/v2/oauth', body)
-      # TODO: do we set exception?
-      if response.success?
-        response.body
-      else
-        # TODO: handle this case
+      Monri::AccessTokens::CreateResponse.create do
+        body = {
+          client_id: config.authenticity_token,
+          client_secret: config.merchant_key,
+          grant_type: 'client_credentials',
+          scopes: options.delete(:scopes) || []
+        }
+        response = @http_client.post('/v2/oauth', body)
+        if response.failed?
+          raise response.exception
+        elsif response.success?
+          response.body
+        else
+          # TODO: handle this case
+        end
       end
+
     end
   end
 end

data/lib/monri/client.rb

@@ -32,6 +32,24 @@ module Monri
       @payment_methods ||= create_payment_methods_api
     end
 
+    # @return [Monri::Tokens]
+    def tokens
+      @tokens ||= create_tokens_api
+    end
+
+    # @return [Monri::Transactions]
+    def transactions
+      @transactions ||= create_transactions_api
+    end
+
+    # @param [String] header
+    # @param [String] body
+    # @param [Hash] options
+    # @return [Hash{Symbol->String | TrueClass | FalseClass}]
+    def validate_callback(header, body, options = {})
+      create_validate_callback.validate(header, body, options)
+    end
+
     private
 
     def ensure_config_set!
@@ -41,14 +59,41 @@ module Monri
     end
 
     def http_client
-      if @http_client == nil
-        @http_client = Monri::HttpClient.new
-        @http_client.config = @config
+      if defined?(@http_client) && @http_client != nil
+        return @http_client
       end
-
+      @http_client = Monri::HttpClient.new
+      @http_client.config = @config
       @http_client
     end
 
+    # @return [Monri::ValidateCallback]
+    def create_validate_callback
+      if @validate_callback_action != nil
+        return @validate_callback_action
+      end
+      ensure_config_set!
+      @validate_callback_action = Monri::ValidateCallback.new
+      @validate_callback_action.config = @config
+      @validate_callback_action
+    end
+
+    def create_tokens_api
+      ensure_config_set!
+      rv = Monri::Tokens.new
+      rv.config = @config
+      rv.http_client = http_client
+      rv
+    end
+
+    def create_transactions_api
+      ensure_config_set!
+      rv = Monri::Transactions.new
+      rv.config = @config
+      rv.http_client = http_client
+      rv
+    end
+
     def create_customers_api
       ensure_config_set!
       rv = Monri::Customers.new

data/lib/monri/customers/create_response.rb

@@ -0,0 +1,97 @@
+module Monri
+  class Customers
+    class CreateResponse < Response
+
+      # @return [String]
+      def uuid
+        self[:uuid]
+      end
+
+      # @return [String]
+      def merchant_customer_id
+        self[:merchant_customer_id]
+      end
+
+      # @return [String]
+      def description
+        self[:description]
+      end
+
+      # @return [String]
+      def email
+        self[:email]
+      end
+
+      # @return [String]
+      def name
+        self[:name]
+      end
+
+      # @return [String]
+      def phone
+        self[:phone]
+      end
+
+      # @return [String]
+      def status
+        self[:status]
+      end
+
+      # @return [String]
+      def deleted
+        self[:deleted]
+      end
+
+      # @return [String]
+      def city
+        self[:city]
+      end
+
+      # @return [String]
+      def country
+        self[:country]
+      end
+
+      # @return [String]
+      def zip_code
+        self[:zip_code]
+      end
+
+      # @return [String]
+      def address
+        self[:address]
+      end
+
+      # @return [String]
+      def metadata
+        self[:metadata]
+      end
+
+      # @return [String]
+      def created_at
+        self[:created_at]
+      end
+
+      # @return [String]
+      def updated_at
+        self[:updated_at]
+      end
+
+      # @return [String]
+      def deleted_at
+        self[:deleted_at]
+      end
+
+      # @return [CreateResponse]
+      def self.create
+        raise ArgumentError, 'Provide a block' unless block_given?
+
+        begin
+          CreateResponse.new(yield)
+        rescue StandardError => e
+          CreateResponse.new(exception: e)
+        end
+      end
+    end
+  end
+end

data/lib/monri/customers.rb

@@ -9,16 +9,18 @@ module Monri
 
     # @param [Hash] options
     def create(options)
-      access_token = @access_tokens.create(scopes: ['customers'])[:access_token]
-      response = @http_client.post('/v2/customers', options, headers: { 'Authorization' => "Bearer #{access_token}" })
-      if response.success?
-        response.body
-      else
-        # TODO: handle this case
+      CreateResponse.create do
+        token_rv = @access_tokens.create!(scopes: ['customers'])
+        response = @http_client.post('/v2/customers', options, oauth: token_rv.access_token)
+
+        if response.failed?
+          raise response.exception
+        elsif response.success?
+          response.body
+        else
+          # TODO: handle this case
+        end
       end
-    rescue StandardError => e
-      # TODO: handle this case
-      nil
     end
   end
 end

data/lib/monri/errors.rb

@@ -1,9 +1,15 @@
 module Monri
   module Errors
+
+    class InvalidArgumentsError < StandardError
+
+    end
+
     class HttpRequestError < StandardError
 
       # @return [Integer]
       attr_reader :code
+
       # @return [String, NilClass]
       attr_reader :body
 
@@ -16,7 +22,7 @@ module Monri
         super(message)
         @code = options.delete(:code) || 500
         @body = options.delete(:body)
-        @headers = options.delete(:headers)
+        @headers = options.delete(:headers) || {}
       end
     end
   end

data/lib/monri/http_client.rb

@@ -10,11 +10,7 @@ module Monri
     def get(url, options = {})
       # TODO: validate
       uri = build_url(url)
-      req_headers = options.delete(:headers) || {}
-      headers = {
-        'Accept': 'application/json',
-        'x-request-id': SecureRandom.hex
-      }.merge(req_headers)
+      headers = prepare_headers(options)
       # Create the HTTP objects
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -31,12 +27,7 @@ module Monri
     def post(url, body, options = {})
       # TODO: validate
       uri = build_url(url)
-      req_headers = options.delete(:headers) || {}
-      headers = {
-        'Content-Type': 'application/json',
-        'Accept': 'application/json',
-        'x-request-id': SecureRandom.hex
-      }.merge(req_headers)
+      headers = prepare_headers(options)
       # Create the HTTP objects
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -53,5 +44,25 @@ module Monri
       URI.parse("#{config.base_api_url}#{url}")
     end
 
+    private
+
+    # @param [Hash] options
+    # @return [Hash{Symbol->String}]
+    def prepare_headers(options)
+      req_headers = options.delete(:headers) || {}
+      headers = {
+        'Content-Type': 'application/json',
+        'Accept': 'application/json',
+        'x-request-id': SecureRandom.hex
+      }
+
+      if options.has_key?(:oauth)
+        headers['Authorization'] = "Bearer #{options.delete(:oauth)}"
+      end
+
+      headers.merge!(req_headers)
+      headers
+    end
+
   end
 end

data/lib/monri/payment_methods.rb

@@ -10,8 +10,8 @@ module Monri
 
     # @param [Hash] options
     def list(options = {})
-      access_token = @access_tokens.create(scopes: ['payment-methods'])[:access_token]
-      response = @http_client.get('/v2/payment-methods', headers: { 'Authorization' => "Bearer #{access_token}" })
+      access_token = @access_tokens.create!(scopes: ['payment-methods']).access_token
+      response = @http_client.get('/v2/payment-methods', oauth: access_token)
       if response.success?
         response.body
       else

data/lib/monri/payments/create_response.rb

@@ -0,0 +1,36 @@
+module Monri
+  class Payments
+    class CreateResponse < Response
+
+      def approved?
+        status == 'approved'
+      end
+
+      # @return [String]
+      def status
+        self[:status]
+      end
+
+      # @return [String]
+      def id
+        self[:id]
+      end
+
+      # @return [String]
+      def client_secret
+        self[:client_secret]
+      end
+
+      # @return [CreateResponse]
+      def self.create
+        raise ArgumentError, 'Provide a block' unless block_given?
+
+        begin
+          CreateResponse.new(yield)
+        rescue StandardError => e
+          CreateResponse.new(exception: e)
+        end
+      end
+    end
+  end
+end

data/lib/monri/payments/payment_result.rb

@@ -0,0 +1,52 @@
+module Monri
+  class Payments
+    class PaymentResult < Hash
+
+      # @param [Hash] params
+      def initialize(params)
+        merge!(params)
+      end
+
+      # @return [String]
+      def currency
+        self[:currency]
+      end
+
+      # @return [String]
+      def amount
+        self[:amount]
+      end
+
+      # @return [String]
+      def order_number
+        self[:order_number]
+      end
+
+      # @return [String]
+      def created_at
+        self[:created_at]
+      end
+
+      # @return [String]
+      def status
+        self[:status]
+      end
+
+      # @return [String]
+      def transaction_type
+        self[:transaction_type]
+      end
+
+      # @return [String]
+      def payment_method
+        self[:payment_method]
+      end
+
+      # @return [String]
+      def response_message
+        self[:response_message]
+      end
+
+    end
+  end
+end