trolley 0.2.14 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ba931e6ff7016ee325fd67c087b7e20bc762c54d8d6e8982abf63a7fb8d507c
-  data.tar.gz: 62b9f604e9ecb631c8e83129cf70aed9c3a09142cb8a6ad9e4f79cb981256203
+  metadata.gz: 262a1acbb09a0cd81c2c73058df52605cfb43e949a742dd5afb40bdcfc5b6b5b
+  data.tar.gz: f900a5a7b7bfbdda5591d160e1a7dfdabd8c60c05de618047039b145af7f5b61
 SHA512:
-  metadata.gz: e55a122666265822edac8d924cfbeeeda8c3beef272bc0f244fbd125885d4bec6998bfc8351c57e6628b57f1bae7cde1896519130a938453e6c51090cadbf97e
-  data.tar.gz: '08bf65fcf30c78570d790a76401dca50df8ae87f72821cbef6f48363733505cc0fc606a4e0d8b108cade33f13e0a99330ecdd612b6c80a363057ef4081adabe9'
+  metadata.gz: c9dea4abf4ad7ed4c11c936646b42991c70094000185a000a4725354ae374694c8ec599d51e607853cf6bf2075269545dcf573caff5b6c62c5ea5117b78f70c0
+  data.tar.gz: dcb1e1788bc0435aebacf59518d6184048f6f6fc64d9e734d56176c958e5d1ed9a8b98ec47dbbb4a8ffadc1d721783f2aaa970518c3facec821504108fc22751

data/lib/trolley/Balance.rb

@@ -0,0 +1,4 @@
+module Trolley
+  class Balance
+  end
+end

data/lib/trolley/Batch.rb

@@ -0,0 +1,20 @@
+module Trolley
+  class Batch
+    attr_accessor(
+      :id,
+      :amount,
+      :completedAt,
+      :createdAt,
+      :currency,
+      :description,
+      :sentAt,
+      :status,
+      :totalPayments,
+      :updatedAt,
+      :quoteExpiredAt,
+      :payments,
+      :tags,
+      :coverFees
+    )
+  end
+end

data/lib/trolley/BatchSummary.rb

@@ -0,0 +1,21 @@
+module Trolley
+  class BatchSummary
+    attr_accessor(
+      :id,
+      :amount,
+      :completedAt,
+      :createdAt,
+      :currency,
+      :description,
+      :sentAt,
+      :status,
+      :totalPayments,
+      :updatedAt,
+      :methods,
+      :detail,
+      :total,
+      :balances,
+      :accounts
+    )
+  end
+end

data/lib/trolley/Client.rb

@@ -0,0 +1,117 @@
+# require_relative 'Exceptions.rb'
+require 'digest'
+require 'net/http'
+require 'openssl'
+require 'uri'
+require 'json'
+require "rubygems"
+
+module Trolley
+  class Client
+    def initialize(config)
+      @config = config
+    end
+
+    def get(endPoint)
+      send_request(endPoint, 'GET')
+    end
+
+    def post(endPoint, body)
+      body = body.to_json
+      send_request(endPoint, 'POST', body)
+    end
+
+    def delete(endPoint, body = '')
+      body = body.to_json if body != ''
+      send_request(endPoint, 'DELETE', body)
+    end
+
+    def patch(endPoint, body)
+      body = body.to_json
+      send_request(endPoint, 'PATCH', body)
+    end
+
+    private
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    def send_request(endPoint, method, body = '')
+      uri = URI.parse(@config.api_base + endPoint)
+      http = Net::HTTP.new(
+        uri.host, uri.port,
+        @config.proxy&.host, @config.proxy&.port, @config.proxy&.user, @config.proxy&.password
+      )
+      http.use_ssl = @config.useSsl?
+
+      time = Time.now.to_i
+      headers = {'X-PR-Timestamp': time.to_s,
+                'Authorization': generate_authorization(time, endPoint, method, body),
+                'Content-Type': 'application/json',
+                'Trolley-Source': "ruby-sdk_#{::Trolley::VERSION}"}
+
+      if method === "GET"
+        request = Net::HTTP::Get.new(uri.request_uri, headers)
+      elsif method === "POST"
+        request = Net::HTTP::Post.new(uri.request_uri, headers)
+        request.body = body
+      elsif method === "PATCH"
+        request = Net::HTTP::Patch.new(uri.request_uri, headers)
+        request.body = body
+      elsif method === "DELETE"
+        request = Net::HTTP::Delete.new(uri.request_uri, headers)
+        request.body = body
+      end
+
+      response = http.request(request)
+
+      if response.code != '200' && response.code != '204'
+        throw_status_code_exception("#{response.message} #{response.body}" , response.code, response.body)
+      end
+      response.body
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+
+    private
+    def generate_authorization(time, endPoint, method, body)
+      message = "#{[time.to_s, method, endPoint, body].join("\n")}\n"
+      signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), @config.privateKey, message)
+      "prsign #{@config.publicKey}:#{signature}"
+    end
+
+    private
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    def throw_status_code_exception(message, code, body = nil)
+      validation_errors = []
+      unless body.nil?
+        begin
+          body = JSON.parse(body)
+          validation_errors = body['errors']
+        rescue JSON::ParserError
+          # no-op
+        end
+      end
+
+      case code
+      when '400'
+        raise MalformedRequestError.new(message, validation_errors)
+      when '401'
+        raise AuthenticationError.new(message, validation_errors)
+      when '403'
+        raise AuthorizationError.new(message, validation_errors)
+      when '404'
+        raise NotFoundError.new(message, validation_errors)
+      when '429'
+        raise TooManyRequestsError.new(message, validation_errors)
+      when '500'
+        raise ServerError.new(message, validation_errors)
+      when '503'
+        raise DownForMaintenanceError.new(message, validation_errors)
+      else
+        raise UnexpectedError.new(message, validation_errors)
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+  end
+end

data/lib/trolley/Configuration.rb

@@ -0,0 +1,30 @@
+module Trolley
+  class Configuration
+    class InvalidProxyAddress < StandardError; end
+    attr_reader :api_base, :proxy, :environment
+
+    DEFAULT_API_BASE = 'https://api.trolley.com'.freeze
+
+    def initialize(publicKey, privateKey, **optionals)
+      raise ArgumentError, 'Both key/secret must be a nonempty string' if publicKey.to_s&.empty? || privateKey.to_s&.empty?
+
+      @publicKey = publicKey
+      @privateKey = privateKey
+      @api_base = optionals[:api_base] || DEFAULT_API_BASE
+      # failfast on a bad proxy
+      proxy_uri = optionals[:proxy_uri]
+      begin
+        @proxy = proxy_uri.nil? ? nil : URI.parse(proxy_uri)
+      rescue URI::InvalidURIError
+        raise InvalidProxyAddress, "Invalid proxy provided to configuration: #{proxy_uri}"
+      end
+    end
+
+    def useSsl?
+      api_base.start_with? 'https'
+    end
+
+    attr_accessor :publicKey, :privateKey
+
+  end
+end

data/lib/trolley/Exceptions.rb

@@ -0,0 +1,26 @@
+module Trolley
+    class TrolleyError < ::StandardError
+        attr_reader :validation_errors
+
+        def initialize(message, validation_errors)
+            super(message)
+            @validation_errors = validation_errors
+        end
+    end
+
+    class AuthenticationError < TrolleyError; end
+
+    class AuthorizationError < TrolleyError; end
+
+    class DownForMaintenanceError < TrolleyError; end
+
+    class NotFoundError < TrolleyError; end
+
+    class ServerError < TrolleyError; end
+
+    class TooManyRequestsError < TrolleyError; end
+
+    class UnexpectedError < TrolleyError; end
+
+    class MalformedRequestError < TrolleyError; end
+end

data/lib/trolley/Gateway.rb

@@ -0,0 +1,18 @@
+module Trolley
+  class Gateway
+    attr_accessor :config, :client, :recipient, :recipient_account, :batch, :payment, :balance, :offline_payment, :invoice, :invoice_payment
+
+    def initialize(config)
+      @config = config
+      @client = Client.new(config)
+      @recipient = RecipientGateway.new(client)
+      @recipient_account = RecipientAccountGateway.new(client)
+      @batch = BatchGateway.new(client)
+      @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/trolley/Invoice.rb

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

data/lib/trolley/InvoicePayment.rb

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

data/lib/trolley/OfflinePayment.rb

@@ -0,0 +1,23 @@
+module Trolley
+  class OfflinePayment
+    attr_accessor(
+      :id,
+      :recipientId,
+      :externalId,
+      :memo,
+      :tags,
+      :taxReportable,
+      :category,
+      :amount,
+      :currency,
+      :withholdingAmount,
+      :withholdingCurrency,
+      :processedAt,
+      :equivalentWithholdingAmount,
+      :equivalentWithholdingCurrency,
+      :updatedAt,
+      :createdAt,
+      :deletedAt
+    )
+  end
+end

data/lib/trolley/Payment.rb

@@ -0,0 +1,52 @@
+module Trolley
+  class Payment
+    attr_accessor(
+      :id,
+      :status,
+      :isSupplyPayment,
+      :returnedAmount,
+      :sourceAmount,
+      :sourceCurrency,
+      :targetAmount,
+      :targetCurrency,
+      :exchangeRate,
+      :fees,
+      :recipientFees,
+      :fxRate,
+      :memo,
+      :externalId,
+      :processedAt,
+      :createdAt,
+      :updatedAt,
+      :merchantFees,
+      :compliance,
+      :payoutMethod,
+      :estimatedDeliveryAt,
+      :recipient,
+      :withholdingAmount,
+      :withholdingCurrency,
+      :equivalentWithholdingAmount,
+      :equivalentWithholdingCurrency,
+      :methodDisplay,
+      :batch,
+      :coverFees,
+      :category,
+      :amount,
+      :currency,
+      :taxReportable,
+      :taxBasisAmount,
+      :taxBasisCurrency,
+      :tags,
+      :account,
+      :initiatedAt,
+      :settledAt,
+      :returnedAt,
+      :returnedNote,
+      :returnedReason,
+      :failureMessage,
+      :merchantId,
+      :checkNumber,
+      :forceUsTaxActivity
+    )
+  end
+end

data/lib/trolley/Recipient.rb

@@ -0,0 +1,44 @@
+module Trolley
+  class Recipient
+    attr_accessor(
+      :id,
+      :routeMinimum,
+      :routeType,
+      :estimatedFees,
+      :referenceId,
+      :email,
+      :name,
+      :lastName,
+      :firstName,
+      :type,
+      :taxType,
+      :status,
+      :language,
+      :complianceStatus,
+      :dob,
+      :contactEmails,
+      :passport,
+      :updatedAt,
+      :createdAt,
+      :gravatarUrl,
+      :governmentId,
+      :ssn,
+      :primaryCurrency,
+      :merchantId,
+      :payout,
+      :compliance,
+      :accounts,
+      :address,
+      :taxWithholdingPercentage,
+      :taxForm,
+      :taxFormStatus,
+      :inactiveReasons,
+      :payoutMethod,
+      :placeOfBirth,
+      :tags,
+      :taxDeliveryType,
+      :riskScore,
+      :isPortalUser
+    )
+  end
+end

data/lib/trolley/RecipientAccount.rb

@@ -0,0 +1,30 @@
+module Trolley
+  class RecipientAccount
+    attr_accessor(
+      :id,
+      :primary,
+      :currency,
+      :recipientAccountId,
+      :recipientId,
+      :recipientReferenceId,
+      :routeType,
+      :recipientFees,
+      :emailAddress,
+      :country,
+      :type,
+      :iban,
+      :accountNum,
+      :accountHolderName,
+      :swiftBic,
+      :branchId,
+      :bankId,
+      :bankName,
+      :bankAddress,
+      :bankCity,
+      :bankRegionCode,
+      :bankPostalCode,
+      :status,
+      :disabledAt
+    )
+  end
+end

data/lib/trolley/gateways/BalanceGateway.rb

@@ -0,0 +1,15 @@
+require_relative '../Client'
+
+module Trolley
+  class BalanceGateway
+    def initialize(client)
+      @client = client
+    end
+
+    def find(term = '')
+      response = @client.get("/v1/balances/#{term}" )
+      JSON.parse(response,  object_class: OpenStruct)
+    end
+
+  end
+end

data/lib/trolley/gateways/BatchGateway.rb

@@ -0,0 +1,74 @@
+require_relative '../Client'
+
+module Trolley
+  class BatchGateway
+    def initialize(client)
+      @client = client
+    end
+
+    def find(batch_id)
+      response = @client.get("/v1/batches/#{batch_id}")
+      batch_builder(response)
+    end
+
+    def all
+      response = @client.get('/v1/batches/')
+      batch_list_builder(response)
+    end
+
+    def create(body)
+      response = @client.post('/v1/batches/', body)
+      batch_builder(response)
+    end
+
+    def update(batch_id, body)
+      @client.patch("/v1/batches/#{batch_id}", body)
+      true
+    end
+
+    # @param batch_id [String] or [Array] The id (or array of ids) of the batch to delete
+    def delete(batch_id)
+      path = '/v1/batches/'
+      body = ''
+
+      if batch_id.is_a?(String)
+        path += batch_id
+      elsif batch_id.is_a?(Array)
+        body = { ids: batch_id }
+      else
+        raise 'Invalid batch_id type, please pass a string or array of strings'
+      end
+
+      @client.delete(path, body)
+      true
+    end
+
+    def generate_quote(batch_id)
+      response = @client.post("/v1/batches/#{batch_id}/generate-quote", {})
+      batch_builder(response)
+    end
+
+    def start_processing(batch_id)
+      response = @client.post("/v1/batches/#{batch_id}/start-processing", {})
+      batch_builder(response)
+    end
+
+    def search(page = 1, page_size = 10, term = '')
+      response = @client.get("/v1/batches?page=#{page}&pageSize=#{page_size}&search=#{term}")
+      batch_list_builder(response)
+    end
+
+    def batch_builder(response)
+      Utils::ResponseMapper.build(response, Batch)
+    end
+
+    def summary(batch_id)
+      response = @client.get("/v1/batches/#{batch_id}/summary")
+      Utils::ResponseMapper.build(response, BatchSummary)
+    end
+
+    def batch_list_builder(response)
+      Utils::PaginatedArray.from_response(response, Batch)
+    end
+  end
+end

data/lib/trolley/gateways/InvoiceGateway.rb

@@ -0,0 +1,57 @@
+require_relative '../Client'
+
+module Trolley
+  class InvoiceGateway
+    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)
+      Utils::ResponseMapper.build(response, Invoice)
+    end
+
+    def invoice_list_builder(response)
+      Utils::PaginatedArray.from_response(response, Invoice)
+    end
+  end
+end

data/lib/trolley/gateways/InvoicePaymentGateway.rb

@@ -0,0 +1,37 @@
+require_relative '../Client'
+
+module Trolley
+  class InvoicePaymentGateway
+    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)
+      Utils::ResponseMapper.build(response, InvoicePayment)
+    end
+
+    def invoice_payments_list_builder(response)
+      Utils::PaginatedArray.from_response(response, InvoicePayment)
+    end
+  end
+end

data/lib/trolley/gateways/OfflinePaymentGateway.rb

@@ -0,0 +1,44 @@
+require_relative '../Client'
+
+module Trolley
+  class OfflinePaymentGateway
+    def initialize(client)
+      @client = client
+    end
+
+    def create(recipient_id, body)
+      response = @client.post("/v1/recipients/#{recipient_id}/offlinePayments", body)
+      offline_payment_builder(response)
+    end
+
+    def update(recipient_id, offline_payment_id, body)
+      @client.patch("/v1/recipients/#{recipient_id}/offlinePayments/#{offline_payment_id}", body)
+      true
+    end
+
+    def delete(recipient_id, offline_payment_id)
+      @client.delete("/v1/recipients/#{recipient_id}/offlinePayments/#{offline_payment_id}")
+      true
+    end
+
+    # rubocop:disable Metrics/ParameterLists
+    def search(recipient_id = '', page = 1, page_size = 10, term = '')
+      if recipient_id === ''
+        response = @client.get("/v1/offline-payments?page=#{page}&pageSize=#{page_size}&search=#{term}")
+      else
+        response = @client.get("/v1/recipients/#{recipient_id}/offlinePayments?page=#{page}&pageSize=#{page_size}&search=#{term}")
+      end
+
+      offline_payments_list_builder(response)
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def offline_payment_builder(response)
+      Utils::ResponseMapper.build(response, OfflinePayment)
+    end
+
+    def offline_payments_list_builder(response)
+      Utils::PaginatedArray.from_response(response, OfflinePayment)
+    end
+  end
+end