tipalti-ruby 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e37b79098df7e8046fedbea14803044851d44347bbda381f355824d8ba60adc6
-  data.tar.gz: 439fcc44613745ed6e6d21e7ee232c274959e555cf43e08f233ece4a5c69244b
+  metadata.gz: 6c31c8896d94b7f278e2b9dbd549e41a491d99a2321ea35d6589672325575e59
+  data.tar.gz: df548617c330afde839ea4029a3df016a2547646d2dd9441b8be8e8ba395f16b
 SHA512:
-  metadata.gz: 0e00bf980e2487d0f9f8af3c9bd178340f23ed8f89df1277ab02731cf63a2bcae7f72ea1d7980bce3cc977479b6124287d2f842458408d52dc1c23b478df0d71
-  data.tar.gz: 1433b3cc4992fdf63d5ccab4b8fc1de771b1fa7815f3db1f924712ab73afc248a463a337a310c3814328a3269252d902a68a8cee026c191210acb0592a538bcd
+  metadata.gz: 0f593b4f11033f7340b46c441a673ff8e4df3b05ed7331f46ac8dbaa771aa2a0737bbf37eb2a67102960159dd57d1d63f6623320fe3dc410a4636df57dde75d7
+  data.tar.gz: c8589eb5007b3ec5e0f60342ea65902d8de7b40367f9a509ed3dae6b12bfdf197f485f65759d72da3ce6badff6186fd2564e56981ee9f2e01ac68f8756320a9e

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.4.0
+
+- Added IPN verification
+
+## v0.3.0
+
+- Added payment get endpoint
+- Added payment batch create endpoint
+- Added payment batch instructions get endpoint
+
 ## v0.2.0
 
 - Added payees get endpoint

data/README.md

@@ -18,6 +18,8 @@ Then `bundle install`.
 
 ## Usage
 
+### API Client
+
 The Tipalti API uses OAuth to authenticate API requests. 
 
 First you need ot get an access code externally by following the [Tipalti authorization flow](https://documentation.tipalti.com/docs/authorization-flow).
@@ -43,7 +45,7 @@ client = Tipalti::Client.new(
 )
 ```
 
-### Endpoints
+### API Endpoints
 
 For use of each endpoint and available attributes or filtering criteria, please consult the [Tipalti API reference](https://documentation.tipalti.com/reference/introduction).
 
@@ -65,6 +67,37 @@ Example: `client.payee_get('123abc')`
 
 Example: `client.payee_list(filter: 'status=="ACTIVE"')`
 
+#### Payment batches create
+
+[API docs](https://documentation.tipalti.com/reference/post_api-v1-payment-batches)
+
+Example:
+
+```ruby
+client.payment_batch_create({ 
+                              paymentInstructions: [
+                                { 
+                                  payeeId: '123456', 
+                                  amountSubmitted: { amount: 5, currency: 'USD' }, 
+                                  refCode: '123ref' 
+                                }
+                              ] 
+                            })
+```
+
+#### Payment batches instructions get
+
+[API docs](https://documentation.tipalti.com/reference/get_api-v1-payment-batches-id-instructions)
+
+Example: `client.payment_batch_instructions_get('3456789')`
+
+#### Payments get
+
+[API docs](https://documentation.tipalti.com/reference/get_api-v1-payments-id)
+
+
+Example: `client.payment_get('123abc')`
+
 ### Token Management
 
 #### Refresh
@@ -93,6 +126,33 @@ Any error code returned by the Tipalti API will result in one of the following e
 |503| Tipalti::ServiceUnavailable|
 |500| Tipalti::ServerError|
 
+### IPNs
+
+Tiplati uses an IPN (instance payment notification) messaging service that enables you to receive notifications from Tipalti. Notifications are triggered when defined events occur (e.g., changes in payee details, system events and payment statuses).
+
+To manage IPNs you will need to instantiate a IPN instance like so.
+
+```ruby
+ipn = Tipalti::Ipn.new(
+  payload: '...', # The raw payload received to your server from the Tipalti IPN
+)
+```
+
+You can use the Tipalti sandbox by setting `ipn.sanbox = true` or as part of the initialization
+
+```ruby
+ipn = Tipalti::Ipn.new(
+  ...
+  sandbox: true
+)
+```
+
+#### Verify
+
+[API docs](https://support.tipalti.com/Content/Topics/Development/IPNs/ipnprotocol.htm#AcknowledgeAndVerifyIPN)
+
+Example: `ipn.verify`
+
 ## License
 
 Copyright (C) 2023 Jordan Ell. See [LICENSE](https://github.com/riipen/tipalti-ruby/blob/master/LICENSE.md) for details.

data/lib/tipalti-ruby/actions/payment.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Tipalti
+  module Actions
+    module Payment
+      def payment_get(id)
+        connection.get("/api/v1/payments/#{id}")
+      end
+    end
+  end
+end

data/lib/tipalti-ruby/actions/payment_batch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tipalti
+  module Actions
+    module PaymentBatch
+      def payment_batch_create(**params)
+        connection.post("/api/v1/payment-batches", **params)
+      end
+
+      def payment_batch_instructions_get(id)
+        connection.get("/api/v1/payment-batches/#{id}/instructions")
+      end
+    end
+  end
+end

data/lib/tipalti-ruby/client.rb

@@ -3,6 +3,8 @@
 module Tipalti
   class Client
     include Tipalti::Actions::Payee
+    include Tipalti::Actions::Payment
+    include Tipalti::Actions::PaymentBatch
     include Tipalti::Actions::Token
 
     BASE_URL_P  = "https://api-p.tipalti.com"

data/lib/tipalti-ruby/connection.rb

@@ -31,8 +31,6 @@ module Tipalti
       request(:put, path, params)
     end
 
-    private
-
     def request(method, path, params)
       response = connection.public_send(method, path, params) do |request|
         request.headers["accept"] = "application/json"
@@ -46,6 +44,8 @@ module Tipalti
       response.body
     end
 
+    private
+
     def connection
       @connection ||= Faraday.new(url: @url) do |c|
         c.request :json, content_type: /\bjson$/

data/lib/tipalti-ruby/error.rb

@@ -2,6 +2,8 @@
 
 module Tipalti
   class Error < StandardError
+    attr_reader :response
+
     def self.from_response(response) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength:
       klass =
         case response.status

data/lib/tipalti-ruby/ipn.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Tipalti
+  class Ipn
+    BASE_URL_P  = "https://console.tipalti.com"
+    BASE_URL_S  = "https://console.sandbox.tipalti.com"
+
+    attr_accessor :sandbox
+
+    def initialize(payload:, sandbox: false)
+      @payload = payload
+      @sandbox = sandbox
+    end
+
+    def base_url
+      @sandbox ? BASE_URL_S : BASE_URL_P
+    end
+
+    def connection
+      Connection.new(url: base_url)
+    end
+
+    def verify
+      connection.request(:post, "/notif/ipn.aspx", @payload)
+    end
+  end
+end

data/lib/tipalti-ruby/version.rb

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

data/lib/tipalti-ruby.rb

@@ -3,8 +3,11 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require "tipalti-ruby/actions/payee"
+require "tipalti-ruby/actions/payment"
+require "tipalti-ruby/actions/payment_batch"
 require "tipalti-ruby/actions/token"
 require "tipalti-ruby/client"
 require "tipalti-ruby/connection"
 require "tipalti-ruby/error"
+require "tipalti-ruby/ipn"
 require "tipalti-ruby/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tipalti-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jordan Ell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,7 +44,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: An API client for Tipalti in ruby.
+description: Access the Tipalti REST API via OAuth2.
 email:
 - me@jordanell.com
 executables: []
@@ -62,12 +62,14 @@ files:
 - Rakefile
 - lib/tipalti-ruby.rb
 - lib/tipalti-ruby/actions/payee.rb
+- lib/tipalti-ruby/actions/payment.rb
+- lib/tipalti-ruby/actions/payment_batch.rb
 - lib/tipalti-ruby/actions/token.rb
 - lib/tipalti-ruby/client.rb
 - lib/tipalti-ruby/connection.rb
 - lib/tipalti-ruby/error.rb
+- lib/tipalti-ruby/ipn.rb
 - lib/tipalti-ruby/version.rb
-- tipalti-ruby-0.1.0.gem
 homepage: https://github.com/riipen/tipalti-ruby
 licenses:
 - MIT