unit-ruby 0.10.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4771e47bafd526a9a832e0552b1cc67a2e49720a44d87c727e0d2de4b764f1bf
-  data.tar.gz: d96d783374e42fb21168afd0bf86f809f8fc309de3f6e7a0a0cf7fe4f320ef05
+  metadata.gz: 611999a90eb76e2e38260184e44648705f496868a151479b26e723afe6c3934e
+  data.tar.gz: 8bb363a47f476ff15efa348e7e1319b05bc80402bfce5afe62355aac8021f0fc
 SHA512:
-  metadata.gz: 3e531d141c243bcaf32b651523092c3f543ac7a610026210ac6e165a9018de635bf3408f57dc487a9f66c8044f9659dbb98fe891705820efa413376db9e3242c
-  data.tar.gz: 1bbaa140de53f9350b48ac53c725b591054abac4427ef1ba6e16eff04b0000bca8357469dc1d91b30bc40e7a0ac7534bc5d46bbcb215360c91615c6668fe52a4
+  metadata.gz: 380415c5203e9a65cea4b573215868ec10c5da4d3d0a517ae4d14b5adbbbb7c7b3c96896d0241f531cb8c39aa3c24cdd4f4f1dbd00606fb945d7a6ca2789a0ad
+  data.tar.gz: 53d601f49d7821628cdbacfa0759ddd4f74d2a9b29c15f3990da5a35c7e80bd7fd5513ad57cf7bd2c80e3dc9b19766d46d6babf268c2195f7a844facaa68ca2f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    unit-ruby (0.10.1)
+    unit-ruby (0.12.0)
       activesupport
       faraday (>= 2.0.1, < 3)
       faraday-retry

data/lib/unit-ruby/application_form.rb

@@ -1,18 +1,22 @@
 module Unit
   class ApplicationForm < APIResource
     path '/application-forms'
+    header 'X-Accept-Version' => 'V2024_06'
 
     attribute :tags, Types::Hash # Optional
     attribute :allowed_application_types, Types::Array # Optional. Array of Individual, Business or SoleProprietorship.
     attribute :applicant_details, Types::ApplicationFormPrefill # Optional. Add data that is already known about the end-customer to be auto populated on the form.
     attribute :settings_override, Types::ApplicationFormSettingsOverride # Optional. Override disclosure URLs that were defined in the application form settings.
-
-    attribute :stage, Types::String, readonly: true
-    attribute :url, Types::String, readonly: true
+    attribute :idempotency_key, Types::String
 
     belongs_to :application, class_name: 'Unit::IndividualApplication'
 
+    def url
+      links[:related][:href]
+    end
+
     include ResourceOperations::Create
     include ResourceOperations::Find
+    include ResourceOperations::List
   end
 end

data/lib/unit-ruby/recurring_credit_ach_payment.rb

@@ -0,0 +1,40 @@
+module Unit
+  class RecurringCreditAchPayment < APIResource
+    path '/recurring-payments'
+
+    attribute :idempotency_key, Types::String # Optional
+    attribute :tags, Types::Hash # Optional
+
+    attribute :amount, Types::Integer # Amount to transfer in cents.
+    attribute :description, Types::String # Description of the transfer. Max of 10 characters.
+    attribute :addenda, Types::String # Optional. Additional payment description. Max of 80 characters.
+    attribute :schedule, Types::Schedule # Schedule for the transfer.
+
+    attribute :status, Types::String, readonly: true
+    attribute :number_of_payments, Types::Integer, readonly: true
+    attribute :created_at, Types::DateTime, readonly: true
+
+    belongs_to :account, class_name: 'Unit::DepositAccount'
+    belongs_to :counterparty, class_name: 'Unit::AchCounterparty'
+    belongs_to :customer, class_name: 'Unit::IndividualCustomer'
+
+    def disable
+      updated_resource = self.class.connection.post(
+        "#{self.class.resource_path(id)}/disable"
+      )
+      update_resource_from_json_api(updated_resource)
+    end
+
+    def enable
+      updated_resource = self.class.connection.post(
+        "#{self.class.resource_path(id)}/enable"
+      )
+      update_resource_from_json_api(updated_resource)
+    end
+
+    include ResourceOperations::List
+    include ResourceOperations::Create
+    include ResourceOperations::Find
+    include ResourceOperations::Destroy
+  end
+end

data/lib/unit-ruby/types/date.rb

@@ -5,8 +5,15 @@ module Unit
     class Date
       def self.cast(value)
         return nil if value.nil?
+        return value if value.is_a?(::Date)
 
-        ::Date.parse(value).strftime('%F')
+        ::Date.parse(value)
+      end
+
+      def self.as_json_api(value)
+        return nil if value.nil?
+
+        value.strftime('%F')
       end
     end
   end

data/lib/unit-ruby/types/schedule.rb

@@ -0,0 +1,45 @@
+module Unit
+  module Types
+    class Schedule
+      attr_reader :start_time, :end_time, :interval,
+                  :day_of_month, :day_of_week,
+                  :total_number_of_payments, :next_scheduled_action
+
+      def initialize(schedule_params)
+        @start_time = schedule_params[:start_time]
+        @end_time = schedule_params[:end_time]
+        @interval = schedule_params[:interval]
+        @day_of_month = schedule_params[:day_of_month]
+        @day_of_week = schedule_params[:day_of_week]
+        @total_number_of_payments = schedule_params[:total_number_of_payments]
+        @next_scheduled_action = schedule_params[:next_scheduled_action]
+      end
+
+      def self.cast(val)
+        return val if val.is_a? self
+        return nil if val.nil?
+
+        new(
+          start_time: Unit::Types::Date.cast(val[:start_time]),
+          end_time: Unit::Types::Date.cast(val[:end_time]),
+          next_scheduled_action: Unit::Types::Date.cast(val[:next_scheduled_action]),
+          interval: val[:interval],
+          day_of_month: val[:day_of_month],
+          day_of_week: val[:day_of_week],
+          total_number_of_payments: val[:total_number_of_payments],
+        )
+      end
+
+      def as_json_api
+        {
+          start_time: Unit::Types::Date.as_json_api(start_time),
+          end_time: Unit::Types::Date.as_json_api(end_time),
+          interval: interval,
+          day_of_month: day_of_month,
+          day_of_week: day_of_week,
+          total_number_of_payments: total_number_of_payments
+        }.compact
+      end
+    end
+  end
+end

data/lib/unit-ruby/util/api_resource.rb

@@ -1,6 +1,6 @@
 module Unit
   class APIResource
-    attr_accessor :id, :type, :raw_data
+    attr_accessor :id, :type, :raw_data, :links
 
     def initialize(attributes = {})
       clear_attributes!
@@ -14,7 +14,7 @@ module Unit
     # Creates a base http connection to the API
     #
     def self.connection
-      @connection ||= Connection.new
+      @connection ||= Connection.new(headers)
     end
 
     # Defines the schema for a resource's attributes
@@ -66,6 +66,21 @@ module Unit
       @path = route
     end
 
+    # Sets resource-specific headers
+    #
+    # Usage:
+    #  class Customer < Unit::Resource
+    #      header 'X-Some-Header' => 'Header Value'
+    #  end
+    def self.header(header_key_value_pair)
+      key, value = header_key_value_pair.first
+      headers[key] = value
+    end
+
+    def self.headers
+      @headers ||= {}
+    end
+
     def self.resource_path(id)
       "#{path}/#{id}"
     end
@@ -149,6 +164,7 @@ module Unit
       self.type = data[:type]
       self.raw_data = data
       self.relationships = data[:relationships]
+      self.links = data[:links]
 
       clear_attributes!
 

data/lib/unit-ruby/util/connection.rb

@@ -10,11 +10,12 @@ module Unit
 
     attr_reader :connection
 
-    def initialize
+    def initialize(custom_headers = {})
       @connection = Faraday.new(self.class.base_url) do |f|
         f.headers['UNIT_TRUST_TOKEN'] = self.class.trust_token if self.class.trust_token
         f.headers['Authorization'] = "Bearer #{self.class.api_key}"
         f.headers['Content-Type'] = 'application/vnd.api+json'
+        f.headers.merge!(custom_headers)
         f.request :json # encode req bodies as JSON
         f.request :retry # retry transient failures
         f.response :json # decode response bodies as JSON
@@ -46,6 +47,17 @@ module Unit
       from_json_api(response.body)
     end
 
+    # Executes a DELETE request to the API
+    #
+    # @return boolean
+    def delete(path)
+      response = connection.delete(path)
+
+      handle_errors(response)
+
+      from_json_api(response.body)
+    end
+
     # Executes a PATCH request to the API
     def patch(path, data = nil)
       response = connection.patch do |req|

data/lib/unit-ruby/util/error.rb

@@ -10,5 +10,9 @@ module Unit
 
       super(@details)
     end
+
+    def to_s
+      "#{@status} #{@message}: #{@details}"
+    end
   end
 end

data/lib/unit-ruby/util/resource_operations.rb

@@ -97,5 +97,13 @@ module Unit
         replace(JSON.parse(json_attributes))
       end
     end
+
+    module Destroy
+      def destroy
+        updated_resource = self.class.connection.delete(self.class.resource_path(id))
+
+        update_resource_from_json_api(updated_resource)
+      end
+    end
   end
 end

data/lib/unit-ruby/version.rb

@@ -1,3 +1,3 @@
 module Unit
-  VERSION = '0.10.1'
+  VERSION = '0.12.0'
 end

data/lib/unit-ruby.rb

@@ -22,6 +22,7 @@ require 'unit-ruby/types/full_name'
 require 'unit-ruby/types/hash'
 require 'unit-ruby/types/integer'
 require 'unit-ruby/types/phone'
+require 'unit-ruby/types/schedule'
 require 'unit-ruby/types/string'
 
 require 'unit-ruby/ach_payment'
@@ -39,6 +40,7 @@ require 'unit-ruby/institution'
 require 'unit-ruby/customer_bank_migration'
 require 'unit-ruby/outreach_settings'
 require 'unit-ruby/received_payment'
+require 'unit-ruby/recurring_credit_ach_payment'
 require 'unit-ruby/pin_status'
 require 'unit-ruby/statement'
 require 'unit-ruby/transaction'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit-ruby
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Chloe Isacke
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-11 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -183,6 +183,7 @@ files:
 - lib/unit-ruby/outreach_settings.rb
 - lib/unit-ruby/pin_status.rb
 - lib/unit-ruby/received_payment.rb
+- lib/unit-ruby/recurring_credit_ach_payment.rb
 - lib/unit-ruby/statement.rb
 - lib/unit-ruby/tax_form.rb
 - lib/unit-ruby/transaction.rb
@@ -204,6 +205,7 @@ files:
 - lib/unit-ruby/types/hash.rb
 - lib/unit-ruby/types/integer.rb
 - lib/unit-ruby/types/phone.rb
+- lib/unit-ruby/types/schedule.rb
 - lib/unit-ruby/types/string.rb
 - lib/unit-ruby/util/api_resource.rb
 - lib/unit-ruby/util/connection.rb