tipalti-ruby 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03acb5dc31ac3a0e27fa741be01e2907a530f7aae8eb1bd595b2102fa252157a
-  data.tar.gz: 9c8f59917796065a0f429d512c57a3f58075ce162d95be2088584ed087c1599c
+  metadata.gz: fbb867289f56f9dfd500df89903857d6c73fe258000f0084fe15f9b9d491e515
+  data.tar.gz: 0bea49d4b1bca9b722280b59063229769a17e6d6e2b842ab719f37c552bf6faa
 SHA512:
-  metadata.gz: ceb685c7bd0d0d340be0615905b96778144bf9877c5be553da23eb3a65f56e6449ab1448d6327b574e9f858b1ba84b772311e2ca35e456fbb84b90678b9fef44
-  data.tar.gz: e39a013089b6ba6ee17d192f2a72fda89c49ab979d6efd7058a092c2df386bf6fcb03c883b84d71f1fdefccbd2a8afdd82c921735ed743a44eb82d944cb53297
+  metadata.gz: 745877696d1638187c04880bb3d0408f6b2a7dcbe2a8d6ca1b9e027ef12d00acb5906d481f5b3e1bac0fba339dcbb19e81da1d1355e03f95efc1dd16177f24cf
+  data.tar.gz: ac4053987f5eae061d1edf031467894cc3948d51ebd8f6730c5109f0c49d44979629920e1c9935dd94d0adf8f232028ff895bda13062a64f5f798ceae6b912a5

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v0.5.0
+
+- Made token refresh use form encoded body
+
+## 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).
 
@@ -93,6 +95,7 @@ Example: `client.payment_batch_instructions_get('3456789')`
 
 [API docs](https://documentation.tipalti.com/reference/get_api-v1-payments-id)
 
+
 Example: `client.payment_get('123abc')`
 
 ### Token Management
@@ -123,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/token.rb

@@ -3,13 +3,19 @@
 module Tipalti
   module Actions
     module Token
-      def token_refresh
+      def token_refresh # rubocop:disable Metrics/MethodLength
         response = connection_token.post("/connect/token",
-                                         client_id: @client_id,
-                                         client_secret: @client_secret,
-                                         grant_type: "refresh_token",
-                                         refresh_token: @refresh_token,
-                                         code_verifier: @code_verifier)
+                                         {
+                                           client_id: @client_id,
+                                           client_secret: @client_secret,
+                                           grant_type: "refresh_token",
+                                           refresh_token: @refresh_token,
+                                           code_verifier: @code_verifier
+                                         },
+                                         {
+                                           body: :form,
+                                           content_type: "application/x-www-form-urlencoded"
+                                         })
 
         # Refresh the client values inline
         @access_token   = response["access_token"]

data/lib/tipalti-ruby/client.rb

@@ -32,7 +32,7 @@ module Tipalti
     end
 
     def connection_token
-      Connection.new(access_token: @access_token, url: token_url)
+      Connection.new(url: token_url)
     end
 
     def token_url

data/lib/tipalti-ruby/connection.rb

@@ -23,20 +23,23 @@ module Tipalti
       request(:head, path, params)
     end
 
-    def post(path, **params)
-      request(:post, path, params)
+    def post(path, params = {}, options = {})
+      request(:post, path, params, options)
     end
 
     def put(path, **params)
       request(:put, path, params)
     end
 
-    private
-
-    def request(method, path, params)
+    def request(method, path, params, options = {}) # rubocop:disable Metrics/MethodLength
       response = connection.public_send(method, path, params) do |request|
         request.headers["accept"] = "application/json"
         request.headers["authorization"] = "Bearer #{@access_token}" if @access_token
+
+        if options[:body] == :form
+          request.headers["Content-Type"] = "application/x-www-form-urlencoded"
+          request.body = URI.encode_www_form(params)
+        end
       end
 
       error = Error.from_response(response)
@@ -46,6 +49,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.3.0"
+  VERSION = "0.5.0"
 end

data/lib/tipalti-ruby.rb

@@ -9,4 +9,5 @@ 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.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jordan Ell
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2023-09-14 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: []
@@ -68,6 +68,7 @@ files:
 - 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
 homepage: https://github.com/riipen/tipalti-ruby
 licenses: