payload-api 0.4.1 → 0.6.0

data/spec/support/helpers/v2_helpers.rb

@@ -0,0 +1,205 @@
+class V2Helpers
+  attr_reader :session
+
+  def initialize(session)
+    @session = session
+  end
+
+  def create_customer_account(name: 'Test', email: 'test@example.com')
+    session.Account.create(
+      type: 'customer',
+      name: name,
+      contact_details: {
+        email: email
+      }
+    )
+  end
+
+  def create_processing_account
+    org = session.Profile.all()[0]
+    session.Account.create(
+      type: 'processing',
+      name: 'Processing Account',
+      processing: {
+        status:      { funding: 'pending' },
+        settings_id: org.processing_settings_id,
+      },
+      payment_methods: [session.PaymentMethod.new(
+        type: 'bank_account',
+        bank_account: {
+          account_number: '123456789',
+          routing_number: '036001808',
+          account_type:   'checking'
+        },
+        billing_address: {
+          postal_code: '11111',
+        },
+        account_defaults: {
+          funding: 'all',
+        }
+      )],
+      entity: {
+        type:        'business',
+        legal_name:  'Example',
+        country:     'US',
+        phone_number: '123 123-1234',
+        tax_id:      { value: '123 12 1234' },
+        address: {
+          address_line_1: '123 Example St',
+          city:           'New York',
+          state_province: 'NY',
+          postal_code:    '11111',
+        },
+        business: {
+          category: 'real_estate',
+          structure: 'llc',
+          website:  'https://example.com',
+          formation: {
+            state_province: 'NY',
+            date:           '2019-10-01',
+          },
+          primary_contact: {
+            name:  'John Smith',
+            email: 'johnsmith@gmail.com',
+          },
+          stakeholders: [
+            {
+              country: 'US',
+              personal_information: {
+                full_name:    'John Smith',
+                email:        'johnsmith@gmail.com',
+                birth_date:   '1990-05-10',
+                phone_number: '123 123-1234',
+              },
+              address: {
+                address_line_1: '123 Example St',
+                city:           'New York',
+                state_province: 'NY',
+                postal_code:    '11111',
+              },
+              govt_id: {
+                tax_id: { value: '123 12 1234' },
+              },
+              association: {
+                ownership: {
+                  percentage:  100,
+                  years_owned: 5,
+                },
+                roles: ['principal_officer'],
+                title: 'CEO',
+              },
+            },
+          ],
+        },
+      },
+    )
+  end
+
+  def create_card_payment(processing_id, amount: nil, description: nil, customer_id: nil, invoice_id: nil)
+    sender = {
+      method: session.PaymentMethod.new(
+        type: 'card',
+        card: {
+          card_number: '4242 4242 4242 4242',
+            expiry: '12/35',
+            card_code: '123',
+          },
+        billing_address: {
+          postal_code: '11111'
+        }
+      )
+    }
+    if customer_id
+      sender = sender.merge({
+        account_id: customer_id,
+      })
+    end
+    payment = {
+      type: 'payment',
+      amount: amount || rand * 100,
+      description: description || 'Test Payment',
+      sender: sender,
+    }
+    if invoice_id
+      payment = payment.merge({
+        invoice_allocations: [{invoice_id: invoice_id}]
+      })
+    end
+    if processing_id
+      payment = payment.merge({
+        receiver: {
+          account_id: processing_id,
+        }
+      })
+    end
+    session.Transaction.create(payment)
+  end
+
+  def create_bank_payment
+    session.Transaction.create(
+      type: 'payment',
+      amount: rand * 1000,
+      sender: {
+          method: session.PaymentMethod.new(
+          type: 'bank_account',
+          account_holder: 'First Last',
+          bank_account: {
+            account_number: '123456789',
+            currency:       'USD',
+            routing_number: '036001808',
+            account_type:   'checking',
+            account_class:  'personal',
+          },
+        )
+      }
+    )
+  end
+
+  def create_invoice(processing_account, customer_account)
+    session.Invoice.create(
+      due_date: Date.today.strftime('%Y-%m-%d'),
+      biller: {
+        account_id: processing_account.id,
+      },
+      payer: {
+        account_id: customer_account.id,
+      },
+      items: [
+        {
+          type: 'line_item',
+          line_item: {
+            value: 29.99,
+          }
+        }
+      ],
+    )
+  end
+
+  def create_blind_refund(amount, processing_id)
+    session.Transaction.create(
+      type: 'refund',
+      amount: amount,
+      sender: {
+        account_id: processing_id,
+      },
+      receiver: {
+        method: session.PaymentMethod.new(
+          type: 'card',
+          card: {
+            card_number: '4242 4242 4242 4242',
+            expiry: '12/30',
+            card_code: '123'
+          },
+          billing_address: { postal_code: '11111' }
+        )
+      }
+    )
+  end
+
+  def create_refund(payment, amount: nil)
+    session.Transaction.create(
+      type: 'refund',
+      transfers: [{assoc_transaction_id: payment.id, amount: amount || payment.amount}]
+    )
+  end
+end

data/spec/support/helpers.rb

@@ -0,0 +1,15 @@
+require 'payload'
+require 'date'
+
+RSpec.shared_context 'test helpers' do
+  before(:all) do
+    Payload.api_key = ENV['TEST_SECRET_KEY']
+    if ENV['TEST_API_URL']
+      Payload.api_url = ENV['TEST_API_URL']
+    end
+  end
+end
+
+# Load version-specific helpers
+require_relative 'helpers/v1_helpers'
+require_relative 'helpers/v2_helpers'

data/spec/support/helpers_spec.rb

@@ -0,0 +1,21 @@
+require 'payload'
+require_relative 'helpers'
+
+RSpec.describe 'Test helpers API versions' do
+  include_context 'test helpers'
+
+  describe '#create_processing_account' do
+    [1, 2].each do |api_version|
+      context "api_version=#{api_version}" do
+        let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, api_version) }
+        let(:h) { Object.const_get("V#{api_version}Helpers").new(session) }
+
+        it 'returns a processing account' do
+          account = h.create_processing_account
+          expect(account).to respond_to(:id)
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payload-api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Payload
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-08 00:00:00.000000000 Z
+date: 2026-02-09 00:00:00.000000000 Z
 dependencies: []
 description: A simple library to interface with the Payload API. See https://docs.payload.com
   for details.
@@ -22,6 +22,7 @@ files:
 - LICENSE
 - README.md
 - lib/payload.rb
+- lib/payload/arm/attr.rb
 - lib/payload/arm/object.rb
 - lib/payload/arm/request.rb
 - lib/payload/arm/session.rb
@@ -30,14 +31,35 @@ files:
 - lib/payload/utils.rb
 - lib/payload/version.rb
 - payload.gemspec
-- spec/objects/payment_spec.rb
+- spec/objects/v1/access_token_spec.rb
+- spec/objects/v1/account_spec.rb
+- spec/objects/v1/billing_spec.rb
+- spec/objects/v1/invoice_spec.rb
+- spec/objects/v1/payment_link_spec.rb
+- spec/objects/v1/payment_method_spec.rb
+- spec/objects/v1/payment_spec.rb
+- spec/objects/v1/session_spec.rb
+- spec/objects/v1/transaction_spec.rb
+- spec/objects/v2/account_spec.rb
+- spec/objects/v2/invoice_spec.rb
+- spec/objects/v2/payment_method_spec.rb
+- spec/objects/v2/transaction_spec.rb
+- spec/payload/arm/arm_request_query_spec.rb
+- spec/payload/arm/attr_spec.rb
+- spec/payload/arm/object_spec.rb
+- spec/payload/arm/request_format_integration_spec.rb
 - spec/payload/arm/request_spec.rb
 - spec/payload/arm/session_spec.rb
+- spec/payload/exceptions_spec.rb
+- spec/support/helpers.rb
+- spec/support/helpers/v1_helpers.rb
+- spec/support/helpers/v2_helpers.rb
+- spec/support/helpers_spec.rb
 homepage: https://docs.payload.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.15
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Payload ruby library
 test_files: []