unit-ruby 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b9811586fc39305b1c82248f0ad8f509b160f68cd1af3f4e5b8e9b39a93197
-  data.tar.gz: 160a4495282bf05385e221ae4d6a816c67669093d40de86cd8cdea6006fa1673
+  metadata.gz: 18b867d8d8816b49b9f6fc3c5ad56cf9d8f880ef7cde8d00967ada67c466b382
+  data.tar.gz: 834f229a02e5d24662e4ac0ed9726d1c0bb1122bb29ec567ed63989bbcdf9be4
 SHA512:
-  metadata.gz: 5b007e90dc256b5b099c2d4a665bf64335130471b6a642cf4cf276ced33d8ecec8eec2d9e9560736b53acbd847bd4320ac0a278b1d4dc867b0056664fe536513
-  data.tar.gz: 78240e4d1fa34353ea59eb2ff7f1febce20fea424a1bb4fc209f0915185f2851e357de6ae4013b42c91f325fe7daa28d1987ca740b24289bd3052e00dc5ca333
+  metadata.gz: 6c2dbbbd2b14d234b4452dfc6cbe1a425cb7709cf7577e3e3a7c616315efaab1c914b2471d7e3a1be0dd3e2c86b51c73bae75a0e7e6f949f7de5a6ed29436818
+  data.tar.gz: eeb6aff99dfd1c0cc9d3660714987a71ee7f269573f3a227bd532aa034eeb42e263ccce608bebc54e2f1f1dc9bef45ca312c56eb8140e1697bbdd8adbae5acfe

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.2.0
+
+- Add `Unit::BookPayment` for booking transfers between Unit accounts.
+- Allow `belongs_to` relationships to specify the JSON:API `type` sent to Unit.
+
 ## 1.1.1
 
 - Publish releases automatically to RubyGems.org via OIDC trusted publishing when `version.rb` changes on `main`.

data/README.md

@@ -95,6 +95,20 @@ debit_card = Unit::IndividualDebitCard.create(
     shipping_address: customer.address,
     tags: { externalUserId: my_user_id }
 )
+
+# Book a transfer between two Unit accounts
+other_account = Unit::DepositAccount.create(
+    deposit_product: 'checking',
+    customer: customer
+)
+
+book_payment = Unit::BookPayment.create(
+    amount: 10_000, # in cents
+    description: 'Transfer between accounts',
+    idempotency_key: "book-payment-for-#{my_user_id}",
+    account: deposit_account,
+    counterparty_account: other_account
+)
 ```
 
 > [!TIP]

data/lib/unit-ruby/book_payment.rb

@@ -0,0 +1,25 @@
+module Unit
+  # A transfer of funds between two Unit accounts
+  class BookPayment < APIResource
+    path '/payments'
+
+    attribute :amount, Types::Integer # Amount to transfer in cents.
+    attribute :description, Types::String # Description of the payment. Max of 50 characters.
+    attribute :transaction_summary_override, Types::String # Optional. Overrides the transaction summary. Max of 100 characters.
+    attribute :idempotency_key, Types::String # Optional
+    attribute :tags, Types::Hash # Optional
+
+    attribute :direction, Types::String, readonly: true
+    attribute :summary, Types::String, readonly: true
+    attribute :status, Types::String, readonly: true
+    attribute :reason, Types::String, readonly: true
+    attribute :created_at, Types::DateTime, readonly: true
+
+    belongs_to :account, class_name: 'Unit::DepositAccount'
+    belongs_to :counterparty_account, class_name: 'Unit::DepositAccount', type: :depositAccount
+    belongs_to :customer, class_name: 'Unit::IndividualCustomer'
+    belongs_to :counterparty_customer, class_name: 'Unit::IndividualCustomer'
+
+    include ResourceOperations::Create
+  end
+end

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

@@ -98,8 +98,13 @@ module Unit
 
     # Creates an association to a related resource
     # This will create a helper method to traverse into a resource's related resource(s)
-    def self.belongs_to(resource_name, class_name: nil)
+    #
+    # @param resource_name [Symbol] the name of the relationship
+    # @param class_name [String] the class of the related resource
+    # @param type [Symbol] the JSON:API type sent for the relationship, when it differs from the relationship name
+    def self.belongs_to(resource_name, class_name: nil, type: nil)
       class_name ||= resource_name.to_s.camelize
+      type ||= resource_name.to_s.camelize(:lower).to_sym
 
       define_method(resource_name) do
         relationship_id = relationships.dig(resource_name, :data, :id)
@@ -111,7 +116,7 @@ module Unit
 
       define_method("#{resource_name}=") do |resource|
         relationships[resource_name] = {
-          data: { type: resource_name.to_s.camelize(:lower).to_sym, id: resource.id }
+          data: { type: type, id: resource.id }
         }
       end
     end

data/lib/unit-ruby/version.rb

@@ -1,3 +1,3 @@
 module Unit
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/unit-ruby.rb

@@ -29,6 +29,7 @@ require 'unit-ruby/ach_payment'
 require 'unit-ruby/application_form'
 require 'unit-ruby/atm_location'
 require 'unit-ruby/authorization'
+require 'unit-ruby/book_payment'
 require 'unit-ruby/ach_counterparty'
 require 'unit-ruby/customer_token_verification'
 require 'unit-ruby/customer_token'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unit-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Chloe Isacke
@@ -172,6 +172,7 @@ files:
 - lib/unit-ruby/application_form.rb
 - lib/unit-ruby/atm_location.rb
 - lib/unit-ruby/authorization.rb
+- lib/unit-ruby/book_payment.rb
 - lib/unit-ruby/customer_bank_migration.rb
 - lib/unit-ruby/customer_token.rb
 - lib/unit-ruby/customer_token_verification.rb