paymentrails 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f075f2b06d9c9ce0d11833e11268288a727e10fb79f1ce44a070fbb5d9a55e2b
-  data.tar.gz: 82eed4cf841783902a59c32edc955b6ec7a0541ab679cb5193e7493c0d00d662
+  metadata.gz: de20eb1c3acb982d1306b963f86928eb8ea02f3ecb761867f429604356f09230
+  data.tar.gz: 5979525e925822b4e4021b26deee565e1ed1c22871697ae8d9cfc109d4c431e2
 SHA512:
-  metadata.gz: 7e6ee052161182aff7763683512b8bb66dc90b79394f19923fb3b53f544e0c6134cf66ab885b7905768d659918a8b812555cc2b7deef2878090434d7ff5c928c
-  data.tar.gz: 2fc33f250b401fb53d9a3d729798886db4a60a419750fbab5e47f57664aa2a8aa1a496a0aa77e252339abf9475cdb619ab5f961f5b9cdd8045abee49200e9c6c
+  metadata.gz: a2cb8e7a7fa9607dc308f89d164d135a281ccd5a528c9b368db1bc01aab28f366ab1a63a0e6ea23886d47950fc9fa7f635981beafc2b9a667eec426aa81c5959
+  data.tar.gz: a7d20fa103dd5dc444c4725b07289cad0e5b7ba81a5ae18c4b70ce1b70c413b4fe0b1e9316abb7c63c594f0ffc0aaecfccd59760b82ab745bc9f0a5c610269cc

data/lib/paymentrails/BatchSummary.rb

@@ -14,7 +14,8 @@ module PaymentRails
       :methods,
       :detail,
       :total,
-      :balances
+      :balances,
+      :accounts
     )
   end
 end

data/lib/paymentrails/Gateway.rb

@@ -24,6 +24,9 @@ module PaymentRails
     attr_reader :offline_payment
     attr_writer :offline_payment
 
+    attr_accessor :invoice
+    attr_accessor :invoice_payment
+
     def initialize(config)
       @config = config
       @client = Client.new(config)
@@ -33,6 +36,8 @@ module PaymentRails
       @payment = PaymentGateway.new(client)
       @balance = BalanceGateway.new(client)
       @offline_payment = OfflinePaymentGateway.new(client)
+      @invoice = InvoiceGateway.new(client)
+      @invoice_payment = InvoicePaymentGateway.new(client)
     end
   end
 end

data/lib/paymentrails/Invoice.rb

@@ -0,0 +1,22 @@
+module PaymentRails
+  class Invoice
+    attr_accessor(
+      :id,
+      :description,
+      :externalId,
+      :invoiceDate,
+      :dueDate,
+      :invoiceNumber,
+      :status,
+      :releaseAfter,
+      :createdAt,
+      :updatedAt,
+      :totalAmount,
+      :paidAmount,
+      :dueAmount,
+      :tags,
+      :recipientId,
+      :lines
+    )
+  end
+end

data/lib/paymentrails/InvoicePayment.rb

@@ -0,0 +1,13 @@
+module PaymentRails
+  class InvoicePayment
+    attr_accessor(
+      :id,
+      :batchId,
+      :paymentId,
+      :invoiceId,
+      :invoiceLineId,
+      :amount,
+      :invoicePayments
+    )
+  end
+end

data/lib/paymentrails/Payment.rb

@@ -45,7 +45,8 @@ module PaymentRails
       :returnedReason,
       :failureMessage,
       :merchantId,
-      :checkNumber
+      :checkNumber,
+      :forceUsTaxActivity
     )
   end
 end

data/lib/paymentrails/Recipient.rb

@@ -35,7 +35,8 @@ module PaymentRails
       :placeOfBirth,
       :tags,
       :taxDeliveryType,
-      :riskScore
+      :riskScore,
+      :isPortalUser
     )
   end
 end

data/lib/paymentrails/gateways/InvoiceGateway.rb

@@ -0,0 +1,77 @@
+require_relative '../Client.rb'
+require_relative 'GatewayHelper'
+
+module PaymentRails
+  class InvoiceGateway
+    include GatewayHelper
+
+    def initialize(client)
+      @client = client
+    end
+
+    def find(body)
+      response = @client.post('/v1/invoices/get', body)
+      invoice_builder(response)
+    end
+
+    def create(body)
+      response = @client.post('/v1/invoices/create', body)
+      invoice_builder(response)
+    end
+
+    def create_line(body)
+      response = @client.post('/v1/invoices/create-lines', body)
+      invoice_builder(response)
+    end
+
+    def search(body)
+      response = @client.post('/v1/invoices/search', body)
+      invoice_list_builder(response)
+    end
+
+    def update(body)
+      @client.post('/v1/invoices/update', body)
+      true
+    end
+
+    def update_line(body)
+      @client.post('/v1/invoices/update-lines', body)
+      true
+    end
+
+    def delete(body)
+      @client.post('/v1/invoices/delete', body)
+      true
+    end
+
+    def delete_line(body)
+      @client.post('/v1/invoices/delete-lines', body)
+      true
+    end
+
+    def invoice_builder(response)
+      invoice = Invoice.new
+      data = JSON.parse(response)
+      data.each do |key, value|
+        next unless key === 'invoice'
+        loosely_hydrate_model(invoice, value)
+      end
+      invoice
+    end
+
+    def invoice_list_builder(response)
+      invoices = []
+      data = JSON.parse(response)
+
+      data.each do |key, value|
+        next unless key === 'invoices'
+        value.each do |newKey, _newValue|
+          invoices.push(
+            loosely_hydrate_model(Invoice.new, newKey)
+          )
+        end
+      end
+      invoices
+    end
+  end
+end

data/lib/paymentrails/gateways/InvoicePaymentGateway.rb

@@ -0,0 +1,56 @@
+require_relative '../Client.rb'
+require_relative 'GatewayHelper'
+
+module PaymentRails
+  class InvoicePaymentGateway
+    include GatewayHelper
+
+    def initialize(client)
+      @client = client
+    end
+
+    def create(body)
+      response = @client.post('/v1/invoices/payment/create', body)
+      invoice_payment_builder(response)
+    end
+
+    def update(body)
+      @client.post('/v1/invoices/payment/update', body)
+      true
+    end
+
+    def delete(body)
+      @client.post('/v1/invoices/payment/delete', body)
+      true
+    end
+
+    def search(body)
+      response = @client.post('/v1/invoices/payment/search', body)
+      invoice_payments_list_builder(response)
+    end
+
+    def invoice_payment_builder(response)
+      invoice_payment = InvoicePayment.new
+      data = JSON.parse(response)
+      data.each do |key, value|
+        next unless key === 'invoicePayment'
+        loosely_hydrate_model(invoice_payment, value)
+      end
+      invoice_payment
+    end
+
+    def invoice_payments_list_builder(response)
+      invoice_payments = []
+      data = JSON.parse(response)
+
+      data.each do |key, value|
+        next unless key === 'invoicePayments'
+        value.each do |newKey, _newValue|
+          invoice_payment = loosely_hydrate_model(InvoicePayment.new, newKey)
+          invoice_payments.push(invoice_payment)
+        end
+      end
+      invoice_payments
+    end
+  end
+end

data/lib/paymentrails/gateways/RecipientGateway.rb

@@ -29,8 +29,15 @@ module PaymentRails
       true
     end
 
-    def search(page = 1, page_size = 10, term = '')
-      response = @client.get('/v1/recipients?page=' + page.to_s + '&pageSize=' + page_size.to_s + '&search=' + term)
+    # TODO: if we can afford a breaking change ideally these should be kwargs
+    def search(page = 1, page_size = 10, prefix_search = '', filters = {})
+      query_string = URI.encode_www_form(
+        page: page.to_s,
+        pageSize: page_size.to_s,
+        search: prefix_search,
+        **filters
+      )
+      response = @client.get("/v1/recipients?#{query_string}")
       recipient_list_builder(response)
     end
 

data/lib/paymentrails.rb

@@ -7,6 +7,8 @@ require 'paymentrails/gateways/PaymentGateway'
 require 'paymentrails/gateways/RecipientGateway'
 require 'paymentrails/gateways/RecipientAccountGateway'
 require 'paymentrails/gateways/OfflinePaymentGateway'
+require 'paymentrails/gateways/InvoiceGateway'
+require 'paymentrails/gateways/InvoicePaymentGateway'
 
 require 'paymentrails/Balance'
 require 'paymentrails/Batch'
@@ -16,6 +18,8 @@ require 'paymentrails/Payment'
 require 'paymentrails/Recipient'
 require 'paymentrails/RecipientAccount'
 require 'paymentrails/OfflinePayment'
+require 'paymentrails/Invoice'
+require 'paymentrails/InvoicePayment'
 
 module PaymentRails
   def self.client(key, secret, environment = 'production', **optionals)

data/paymentrails.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name = "paymentrails"
   s.summary = "PaymentRails Ruby SDK"
   s.description = "Ruby SDK for interacting with the PaymentRails API"
-  s.version = '0.2.6'
+  s.version = '0.2.10'
   s.homepage = 'https://www.paymentrails.com/'
   s.email = ['joshua@paymentrails.com']
   s.license = "MIT"

data/spec/integration/InvoicePaymentTest.rb

@@ -0,0 +1,99 @@
+require_relative 'helper'
+
+class InvoicePaymentTest < Test::Unit::TestCase
+  def setup
+    @client = PaymentRails.client(
+      ENV.fetch('SANDBOX_API_KEY'),
+      ENV.fetch('SANDBOX_SECRET_KEY'),
+      'production',
+      proxy_uri: ENV['PROXY_URI']
+    )
+  end
+
+  def create_recipient
+    uuid = SecureRandom.uuid.to_s
+    recipient = @client.recipient.create(
+      type: 'individual',
+      firstName: 'Tom',
+      lastName: 'Jones',
+      email: 'test.batch' + uuid + '@example.com',
+      address: {
+        street1: '123 Wolfstrasse',
+        city: 'Berlin',
+        country: 'DE',
+        postalCode: '123123'
+      }
+    )
+    @client.recipient_account.create(recipient.id, type: 'bank-transfer', currency: 'EUR', country: 'DE', iban: 'DE89 3704 0044 0532 0130 00')
+    recipient
+  end
+
+  def test_create
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+    assert_equal('open', invoice.status)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+    assert_not_nil(invoice_line.lines)
+    assert_not_nil(invoice_line.lines.first['id'])
+
+    @client.invoice_payment.create(ids: [invoiceId: invoice.id])
+    invoice_payments = @client.invoice_payment.search(invoiceIds: [invoice.id])
+    assert_true(invoice_payments.count > 0)
+
+    findInvoice = @client.invoice.find(invoiceId: invoice.id)
+    assert_equal('paid', findInvoice.status)
+  end
+
+  def test_update
+    recipient = create_recipient
+
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+
+    invoices = @client.invoice.search({})
+    assert_true(invoices.count > 0)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+    assert_not_nil(invoice_line.lines)
+    assert_not_nil(invoice_line.lines.first['id'])
+
+    invoice_payment = @client.invoice_payment.create(ids: [invoiceId: invoice.id])
+    invoice_payments = @client.invoice_payment.search(invoiceIds: [invoice.id])
+    assert_true(invoice_payments.count > 0)
+    assert_equal('2000.00', invoice_payments.first.amount['value'])
+
+    response = @client.invoice_payment.update(paymentId: invoice_payment.paymentId, invoiceLineId: invoice_payment.invoicePayments.first['invoiceLineId'], amount: { value: '5000', currency: 'USD' })
+    assert_true(response)
+    invoice_payments = @client.invoice_payment.search(invoiceIds: [invoice.id])
+    assert_true(invoice_payments.count > 0)
+    assert_equal('5000.00', invoice_payments.first.amount['value'])
+  end
+
+  def test_delete
+    recipient = create_recipient
+
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+
+    invoices = @client.invoice.search({})
+    assert_true(invoices.count > 0)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+    assert_not_nil(invoice_line.lines)
+    assert_not_nil(invoice_line.lines.first['id'])
+
+    invoice_payment = @client.invoice_payment.create(ids: [invoiceId: invoice.id])
+    invoice_payments = @client.invoice_payment.search(invoiceIds: [invoice.id])
+    assert_true(invoice_payments.count > 0)
+
+    response = @client.invoice_payment.delete(paymentId: invoice_payment.paymentId, invoiceLineIds: [invoice_payment.invoicePayments.first['invoiceLineId']])
+    assert_true(response)
+    invoice_payments = @client.invoice_payment.search(invoiceIds: [invoice.id])
+    assert_true(invoice_payments.count == 0)
+  end
+end

data/spec/integration/InvoiceTest.rb

@@ -0,0 +1,124 @@
+require_relative 'helper'
+
+class InvoiceTest < Test::Unit::TestCase
+  def setup
+    @client = PaymentRails.client(
+      ENV.fetch('SANDBOX_API_KEY'),
+      ENV.fetch('SANDBOX_SECRET_KEY'),
+      'production',
+      proxy_uri: ENV['PROXY_URI']
+    )
+  end
+
+  def create_recipient
+    uuid = SecureRandom.uuid.to_s
+    recipient = @client.recipient.create(
+      type: 'individual',
+      firstName: 'Tom',
+      lastName: 'Jones',
+      email: 'test.batch' + uuid + '@example.com',
+      address: {
+        street1: '123 Wolfstrasse',
+        city: 'Berlin',
+        country: 'DE',
+        postalCode: '123123'
+      }
+    )
+    @client.recipient_account.create(recipient.id, type: 'bank-transfer', currency: 'EUR', country: 'DE', iban: 'DE89 3704 0044 0532 0130 00')
+    recipient
+  end
+
+  def test_create
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+
+    invoice = @client.invoice.search({})
+    assert_true(invoice.count > 0)
+  end
+
+  def test_create_line
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+    assert_equal([], invoice.lines)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+    assert_not_nil(invoice_line.lines)
+    assert_not_nil(invoice_line.lines.first['id'])
+
+    findInvoice = @client.invoice.find(invoiceId: invoice.id)
+    assert_true(findInvoice.lines.count > 0)
+  end
+
+  def test_update
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+
+    invoices = @client.invoice.search({})
+    assert_true(invoices.count > 0)
+
+    response = @client.invoice.update(invoiceId: invoice.id, description: 'Integration Test Invoice Update')
+    assert_true(response)
+    findInvoice = @client.invoice.find(invoiceId: invoice.id)
+    assert_equal('Integration Test Invoice Update', findInvoice.description)
+    assert_equal('open', findInvoice.status)
+  end
+
+  def test_update_line
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+    assert_equal([], invoice.lines)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+    assert_not_nil(invoice_line.lines)
+    assert_not_nil(invoice_line.lines.first['id'])
+
+    response = @client.invoice.update_line(
+      invoiceId: invoice.id,
+      lines: [{
+        invoiceLineId: invoice_line.lines.first['id'],
+        unitAmount: { value: '3000', currency: 'USD' }
+      }]
+    )
+    assert_true(response)
+
+    findInvoice = @client.invoice.find(invoiceId: invoice.id)
+    assert_equal('3000.00', findInvoice.lines.first['unitAmount']['value'])
+  end
+
+  def test_delete
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+
+    invoices = @client.invoice.search({})
+    assert_true(invoices.count > 0)
+
+    response = @client.invoice.delete(invoiceIds: invoices.map(&:id))
+    assert_true(response)
+
+    final_invoices = @client.invoice.search({})
+    assert_true(final_invoices.count == 0)
+  end
+
+  def test_delete_line
+    recipient = create_recipient
+    invoice = @client.invoice.create(recipientId: recipient.id, description: 'Integration Test Invoice Create')
+    assert_not_nil(invoice)
+    assert_not_nil(invoice.id)
+    assert_equal([], invoice.lines)
+
+    invoice_line = @client.invoice.create_line(invoiceId: invoice.id, lines: [{ unitAmount: { value: '2000', currency: 'USD' } }])
+
+    response = @client.invoice.delete_line(invoiceId: invoice.id, invoiceLineIds: [invoice_line.lines.first['id']])
+    assert_true(response)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paymentrails
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.10
 platform: ruby
 authors:
 - PaymentRails
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -82,6 +82,8 @@ files:
 - lib/paymentrails/Configuration.rb
 - lib/paymentrails/Exceptions.rb
 - lib/paymentrails/Gateway.rb
+- lib/paymentrails/Invoice.rb
+- lib/paymentrails/InvoicePayment.rb
 - lib/paymentrails/OfflinePayment.rb
 - lib/paymentrails/Payment.rb
 - lib/paymentrails/Recipient.rb
@@ -89,12 +91,16 @@ files:
 - lib/paymentrails/gateways/BalanceGateway.rb
 - lib/paymentrails/gateways/BatchGateway.rb
 - lib/paymentrails/gateways/GatewayHelper.rb
+- lib/paymentrails/gateways/InvoiceGateway.rb
+- lib/paymentrails/gateways/InvoicePaymentGateway.rb
 - lib/paymentrails/gateways/OfflinePaymentGateway.rb
 - lib/paymentrails/gateways/PaymentGateway.rb
 - lib/paymentrails/gateways/RecipientAccountGateway.rb
 - lib/paymentrails/gateways/RecipientGateway.rb
 - paymentrails.gemspec
 - spec/integration/BatchTest.rb
+- spec/integration/InvoicePaymentTest.rb
+- spec/integration/InvoiceTest.rb
 - spec/integration/RecipientTest.rb
 - spec/integration/helper.rb
 - spec/unit/ConfigurationTest.rb
@@ -118,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: PaymentRails Ruby SDK