paycargo 0.1.0

data/lib/paycargo/resource.rb

@@ -0,0 +1,51 @@
+module Paycargo
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, default_headers.merge(headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, default_headers.merge(headers))
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, default_headers.merge(headers))
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, default_headers.merge(headers))
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, default_headers.merge(headers))
+    end
+
+    def default_headers
+      { authorization: client.token }
+    end
+
+    def handle_response(response)
+      #message = response.body["message"]
+
+      case response.status
+        when 401
+            raise Error, "#{response.body}"
+        when 404
+            raise Error, "#{response.body}"
+        when 429
+            raise Error, "#{response.body}"
+        when 500
+            raise Error, "#{response.body}"
+      end
+
+      response
+    end
+
+  end
+end

data/lib/paycargo/resources/payer.rb

@@ -0,0 +1,12 @@
+module Paycargo
+  class PayerResource < Resource
+
+    # This endpoint retrieves the following data, per payer, per payment method:
+    # - get funds availability
+    # - get funds limit
+    def funds(id)
+      get_request("payer/funds/#{id}").body
+    end
+
+  end
+end

data/lib/paycargo/resources/reports.rb

@@ -0,0 +1,34 @@
+module Paycargo
+  class ReportsResource < Resource
+
+    #Get Payer ACH Report
+    # PARAMS
+    #- fleet_id: 283046
+    #- Account fleet id ( payerId)
+
+    #- startDate: 10/01/2020
+    #Start Date in MM/DD/YYYY format
+
+    #- endDate: 11/01/2020
+    #End Date in MM/DD/YYYY format
+
+    #- client_id: 284347
+    #Account client id
+
+    #- report_action_name: getACHReconciliation
+    #PayCargo report type name, for ACH report : getACHReconciliation
+
+    #- type: SHIPPER
+    #Account type : SHIPPER or CARRIER
+
+    #- accountName: all
+    #- Account name of branch if any. Apply "all" to get data from branches for HQ
+
+    #- fleetLimit: fleet_id
+    #- providerLimit: provier_id
+    def payer(**params)
+      get_request("reports/singleReport", params: params).body
+    end
+
+  end
+end

data/lib/paycargo/resources/transactions.rb

@@ -0,0 +1,71 @@
+module Paycargo
+  class TransactionsResource < Resource
+
+    #GET all Transactions for a client.
+    #PARAMS
+    #- page
+    #- count
+    def list(**params)
+      Collection.from_response get_request("transactions", params: params), type: Transaction
+    end
+
+    #GET a transaction by id (must update token)
+    def retreive(id, **params)
+      Transaction.new get_request("transaction/#{id}", params: params).body
+    end
+
+    #POSTing a new transaction
+    #BODY
+    #- payerId: 281302
+    #- vendorId: 279546
+    #- type: Other
+    #- subcategory: I-432188
+    #- number: 929-83294551
+    #- departureDate: 2018-04-01
+    #- arrivalDate: 2018-04-24
+    #- total: 100
+    #- notes: This is a test for paycargo credit new flow
+    #- userId: 778042
+    #- direction: Outbound
+    #- parent: dsgfdg
+    #- paymentDueDate: 2018-04-24
+    #- hasArrived: Y
+    #- customerRefNumber: 63045050500000
+    #- shipperRefNumber: tdfgfdgfd
+    #- paymentType: PAYCARGO_CREDIT
+    def create(**attributes)
+      Transaction.new post_request("transaction", body: attributes).body
+    end
+
+    #PUT Approve a Transaction
+    def approve(id)
+      Transaction.new put_request("transaction/pay/#{id}").body
+    end
+
+    #Proof Transaction
+    #PUTing a transaction to 'proof'
+    def proof(id)
+      Transaction.new put_request("transaction/proof/#{id}").body
+    end
+
+    #GETs a transaction by number (must update token)
+    #PARAMS
+    #- number
+    #- vendorId
+    def by_number(**params)
+      Transaction.new get_request("transaction/number/", params: params).body
+    end
+
+    #GETing a transaction's history
+    def history(id, **params)
+      get_request("transaction/history/#{id}", params: params).body
+    end
+
+    #Get Fees for transaction. paymentType and transactionId OR paymentType
+    #and vendorId and payerId are required to getFees
+    def fees(**params)
+      get_request("transaction/fees", params: params).body
+    end
+
+  end
+end

data/lib/paycargo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Paycargo
+  VERSION = "0.1.0"
+end

data/lib/paycargo.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "paycargo/version"
+
+module Paycargo
+  autoload :Client, "paycargo/client"
+  autoload :Collection, "paycargo/collection"
+  autoload :Error, "paycargo/error"
+  autoload :Object, "paycargo/object"
+  autoload :Resource, "paycargo/resource"
+
+  autoload :TransactionsResource, "paycargo/resources/transactions"
+  autoload :PayerResource, "paycargo/resources/payer"
+  autoload :ReportsResource, "paycargo/resources/reports"
+
+  autoload :Transaction, "paycargo/objects/transaction.rb"
+  autoload :Payer, "paycargo/objects/payer.rb"
+  autoload :Report, "paycargo/objects/report.rb"
+end

data/sig/paycargo.rbs

@@ -0,0 +1,4 @@
+module Paycargo
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: paycargo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Perez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: Ruby wrapper library for Paycargo's API.
+email:
+- jose.perez@vertilux.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- docs/index.html
+- docs/style.css
+- lib/paycargo.rb
+- lib/paycargo/client.rb
+- lib/paycargo/collection.rb
+- lib/paycargo/error.rb
+- lib/paycargo/object.rb
+- lib/paycargo/objects/payer.rb
+- lib/paycargo/objects/report.rb
+- lib/paycargo/objects/transaction.rb
+- lib/paycargo/resource.rb
+- lib/paycargo/resources/payer.rb
+- lib/paycargo/resources/reports.rb
+- lib/paycargo/resources/transactions.rb
+- lib/paycargo/version.rb
+- sig/paycargo.rbs
+homepage: https://lepepe.github.io/paycargo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://lepepe.github.io/paycargo
+  source_code_uri: https://lepepe.github.io/paycargo
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Ruby wrapper library for Paycargo's API.
+test_files: []