payload-api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a65380dc908d716ddb1642ecb6bab391061c469ffa9951b80d3db94e84b08d
-  data.tar.gz: 77978473db8ca858d60db59155625b3133e5d8470fa69ff6a76ec497c086c17a
+  metadata.gz: 66c7eb5c0125eb3e66a5800851c6e66e42ae36138a2b89516b2ae8a823cacc7d
+  data.tar.gz: 602f23d391904acdb9ddf3540990692f8f54284746d3bba5eb528827f2f802da
 SHA512:
-  metadata.gz: '09dce62dabb4cd5d51432adec32190ffb4b0f9a924c3794c0cef3d009c6e0d73897d9d58ca1d8417a85709ca903581fbb444ad66dab3951b27b8bf2ed0e0198d'
-  data.tar.gz: e2d546eef549863a7c3da77c9c6e4ddb5446fa19cc93d854de7109530cff8645a51af2bc46f6a9095bd7b629fe99f464a30848262c459d3899d91d2eddc3ff7a
+  metadata.gz: 19b0346676cab8cbd11a997fbb30f2a9ccec35eb16bfe7905da763efc6f5b7efc27002ac828ff0b14041e284bdd10d0cbc093dbb3d09350dd08bb5cd82bfa1af
+  data.tar.gz: 7abac9292dcc52fe334f4182f59d6c4253242451a5f3e4aec7997399a6469c56caadf3862b511529d08b5e65c5779764ad868b2e06134266500deedbfa0e73f4

data/.github/workflows/test.yml

@@ -20,6 +20,8 @@ jobs:
         ruby-version: 3.0.1
 
     - name: Run RSpec tests
+      env:
+        TEST_SECRET_KEY: ${{ secrets.API_KEY }}
       run: |
         gem install rspec
         rspec spec

data/README.md

@@ -7,13 +7,13 @@ A RubyGem for integrating [Payload](https://payload.com).
 To install using [Bundler](https://bundler.io):
 
 ```ruby
-gem 'payload-api', '~> 0.2.4'
+gem 'payload-api', '~> 0.5.0'
 ```
 
 To install using gem:
 
 ```bash
-gem install payload
+gem install payload-api
 ```
 
 ## Get Started
@@ -34,6 +34,27 @@ require 'payload'
 Payload.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
 ```
 
+### API Versioning
+
+The Payload API supports multiple versions. You can specify which version to use when making requests:
+
+```ruby
+require 'payload'
+Payload.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
+Payload.api_version = 'v2'  # Use API v2
+```
+
+Or with sessions:
+
+```ruby
+pl = Payload::Session.new(
+    'secret_key_3bW9JMZtPVDOfFNzwRdfE', 
+    api_version: 'v2'
+)
+```
+
+API v2 introduces new objects including `Profile`, `Intent`, `Entity`, `Transfer`, `ProcessingAgreement`, and more. See the [Payload API Documentation](https://docs.payload.com) for details on API versions.
+
 ### Creating an Object
 
 Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of

data/lib/payload/arm/object.rb

@@ -29,6 +29,10 @@ module Payload
 		def get(id)
 			return @cls.get(id, :session => @session)
 		end
+		
+		def select(*args, **data)
+			@cls.select(*args, **data, session: @session)
+		end
 
 	end
 
@@ -158,5 +162,9 @@ module Payload
 			serialized.merge!(@data)
 			return serialized.to_json(*args)
 		end
+
+		def respond_to_missing?(name, include_private = false)
+			@data && @data.key?(name.to_s) || super
+		end
 	end
 end

data/lib/payload/arm/request.rb

@@ -31,6 +31,7 @@ module Payload
 		end
 
 		def all()
+			# TODO: I don't think this applies the @poly variable as intended?
 			return self._request('Get')
 		end
 
@@ -162,6 +163,10 @@ module Payload
 				request.add_field('Content-Type', 'application/json')
 			end
 
+			if @session.api_version
+				request.add_field('X-API-Version', @session.api_version)
+			end
+
 			response = self._execute_request(http, request)
 
 			begin
@@ -170,7 +175,7 @@ module Payload
 				if response.code == '500'
 					raise Payload::InternalError.new
 				else
-					raise Place::UnknownResponse.new
+					raise Payload::UnknownResponse.new
 				end
 			end
 
@@ -178,6 +183,7 @@ module Payload
 				if data['object'] == 'list'
 					return data['values'].map do |obj|
 						cls = Payload::get_cls(obj)
+						cls = @cls if cls.nil? && !@cls.nil?
 						if cls.nil?
 							obj
 						else
@@ -186,7 +192,13 @@ module Payload
 						end
 					end
 				else
-					return Payload::get_cls(data).new(data, @session)
+					cls = Payload::get_cls(data)
+					cls = @cls if cls.nil? && !@cls.nil?
+					if cls.nil?
+						return data
+					else
+						return cls.new(data, @session)
+					end
 				end
 			else
 				for error in Payload::subclasses(Payload::PayloadError)

data/lib/payload/arm/session.rb

@@ -2,14 +2,14 @@ require 'payload/arm/request'
 
 
 module Payload
-
     class Session
-        attr_accessor :api_key, :api_url
-
-        def initialize(api_key, api_url=nil)
-            @api_key = api_key
-            @api_url = api_url || Payload.URL
+        attr_accessor :api_key, :api_url, :api_version
 
+        def initialize(api_key = nil, api_url = nil, api_version = nil, **kwargs)
+            @api_key = kwargs[:api_key] || api_key
+            @api_url = kwargs[:api_url] || api_url || Payload.URL
+            @api_version = kwargs[:api_version] || api_version || Payload.api_version
+        
             Payload.constants.each do |c|
                 val = Payload.const_get(c)
                 if val.is_a?(Class) && val < Payload::ARMObject

data/lib/payload/objects.rb

@@ -18,18 +18,6 @@ module Payload
 		@spec = { 'object' => 'account' }
 	end
 
-	class Customer < ARMObject
-		@spec = { 'object' => 'customer' }
-	end
-
-	class ProcessingAccount < ARMObject
-		@spec = { 'object' => 'processing_account' }
-	end
-
-	class Org < ARMObject
-		@spec = { 'object' => 'org', 'endpoint' => '/account/orgs' }
-	end
-
 	class Transaction < ARMObject
 		@spec = { 'object' => 'transaction' }
 	end
@@ -74,6 +62,19 @@ module Payload
 		@spec = { 'object' => 'invoice' }
 	end
 
+	class PaymentActivation < ARMObject
+		@spec = { 'object' => 'payment_activation' }
+	end
+
+	class Webhook < ARMObject
+		@spec = { 'object' => 'webhook' }
+	end
+
+	class PaymentLink < ARMObject
+		@spec = { 'object' => 'payment_link' }
+	end
+
+	# V1 objects
 	class LineItem < ARMObject
 		@spec = { 'object' => 'line_item' }
 	end
@@ -88,15 +89,69 @@ module Payload
 		@poly = { 'entry_type' => 'payment' }
 	end
 
-	class PaymentActivation < ARMObject
-		@spec = { 'object' => 'payment_activation' }
+	class Customer < ARMObject
+		@spec = { 'object' => 'customer' }
 	end
 
-	class Webhook < ARMObject
-		@spec = { 'object' => 'webhook' }
+	class ProcessingAccount < ARMObject
+		@spec = { 'object' => 'processing_account' }
+	end
+	
+	class Org < ARMObject
+		@spec = { 'object' => 'org', 'endpoint' => '/account/orgs' }
 	end
 
-	class PaymentLink < ARMObject
-		@spec = { 'object' => 'payment_link' }
+	# V2 objects
+	class InvoiceItem < ARMObject
+		@spec = { 'object' => 'invoice_item' }
+	end
+
+	class PaymentAllocation < ARMObject
+		@spec = { 'object' => 'payment_allocation' }
+	end
+
+	class Profile < ARMObject
+		@spec = { 'object' => 'profile' }
+	end
+
+	class BillingItem < ARMObject
+		@spec = { 'object' => 'billing_item' }
+	end
+
+	class Intent < ARMObject
+		@spec = { 'object' => 'intent' }
+	end
+
+	class Entity < ARMObject
+		@spec = { 'object' => 'entity' }
 	end
+
+	class Stakeholder < ARMObject
+		@spec = { 'object' => 'stakeholder' }
+	end
+
+	class ProcessingAgreement < ARMObject
+		@spec = { 'object' => 'processing_agreement' }
+	end
+
+	class Transfer < ARMObject
+		@spec = { 'object' => 'transfer' }
+	end
+
+	class TransactionOperation < ARMObject
+		@spec = { 'object' => 'transaction_operation' }
+	end
+
+	class CheckFront < ARMObject
+		@spec = { 'object' => 'check_front' }
+	end
+
+	class CheckBack < ARMObject
+		@spec = { 'object' => 'check_back' }
+	end
+
+	class ProcessingRule < ARMObject
+		@spec = { 'object' => 'processing_rule' }
+	end
+
 end

data/lib/payload/version.rb

@@ -1,3 +1,3 @@
 module Payload
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
 end

data/lib/payload.rb

@@ -3,8 +3,8 @@ require "payload/objects"
 require "payload/arm/session"
 
 module Payload
-	@URL = "https://api.payload.com"
-
+  @URL = "https://api.payload.com"
+	
 	class << self
 		def api_key=(value)
 			session.api_key = value
@@ -22,15 +22,24 @@ module Payload
 			session.api_url
 		end
 
+    def api_version=(version)
+      @api_version = version
+      @session = nil
+    end
+    
+    def api_version
+      @api_version
+    end
+    
 		def URL
 			@URL
 		end
 
 		private
 
-		def session
-			@session ||= Payload::Session.new(nil, @URL)
-		end
+    def session
+      @session ||= Payload::Session.new(nil, @URL)
+    end
 	end
 
 	def self.create(objects)
@@ -44,4 +53,5 @@ module Payload
 	def self.delete(objects)
 		return Payload::ARMRequest.new().delete_all(objects)
 	end
+
 end

data/spec/objects/v1/access_token_spec.rb

@@ -0,0 +1,19 @@
+require 'payload'
+require 'payload/arm/object'
+require_relative '../../support/helpers'
+
+RSpec.describe 'Access Token Integration Tests' do
+  include_context 'test helpers'
+
+  let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, 1) }
+
+  describe 'Access Token' do
+    it 'creates a client token' do
+      client_token = session.ClientToken.create
+      expect(client_token.status).to eq('active')
+      expect(client_token.type).to eq('client')
+      expect(client_token.environ).to eq('test')
+    end
+  end
+end
+

data/spec/objects/v1/account_spec.rb

@@ -0,0 +1,97 @@
+require 'payload'
+require 'payload/arm/object'
+require_relative '../../support/helpers'
+
+RSpec.describe 'Account Integration Tests - V1' do
+  include_context 'test helpers'
+
+  let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, 1) }
+  let(:h) { V1Helpers.new(session) }
+
+  describe 'Customer Account' do
+    it 'creates a customer account' do
+      customer_account = session.Customer.create(name: 'Test', email: 'test@example.com')
+      expect(customer_account.id).to be_truthy
+    end
+
+    it 'deletes a customer account' do
+      cust_account = session.Customer.create(name: 'Test', email: 'test@example.com')
+      cust_account.delete
+
+      expect {
+        session.Customer.get(cust_account.id)
+      }.to raise_error(Payload::NotFound)
+    end
+
+    it 'creates multiple accounts' do
+      rand_email1 = (0...5).map { ('a'..'z').to_a[rand(26)] }.join + '@example.com'
+      rand_email2 = (0...5).map { ('a'..'z').to_a[rand(26)] }.join + '@example.com'
+
+      name1 = 'Matt Perez'
+      name2 = 'Andrea Kearney'
+
+      accounts_to_create = [
+        session.Customer.new(email: rand_email1, name: name1),
+        session.Customer.new(email: rand_email2, name: name2)
+      ]
+      session.create(accounts_to_create)
+
+      get_account_1 = session.Customer.filter_by(email: rand_email1).all[0]
+      get_account_2 = session.Customer.filter_by(email: rand_email2).all[0]
+
+      expect(get_account_1).to be_truthy
+      expect(get_account_2).to be_truthy
+    end
+
+    it 'gets a processing account' do
+      proc_account = h.create_processing_account
+      retrieved = session.ProcessingAccount.get(proc_account.id)
+      expect(retrieved).to be_truthy
+      expect(retrieved.status).to eq('pending')
+    end
+
+    it 'pages and orders results' do
+      accounts_to_create = [
+        session.Customer.new(email: 'account1@example.com', name: 'Randy Robson'),
+        session.Customer.new(email: 'account2@example.com', name: 'Brandy Bobson'),
+        session.Customer.new(email: 'account3@example.com', name: 'Mandy Johnson')
+      ]
+      session.create(accounts_to_create)
+      customers = session.Customer.filter_by(order_by: 'created_at', limit: 3, offset: 1).all
+
+      expect(customers.length).to eq(3)
+      require 'time'
+      expect(Time.parse(customers[0].created_at)).to be <= Time.parse(customers[1].created_at)
+      expect(Time.parse(customers[1].created_at)).to be <= Time.parse(customers[2].created_at)
+    end
+
+    it 'updates a customer' do
+      cust_account = session.Customer.create(name: 'Test', email: 'test@example.com')
+      cust_account.update(email: 'test2@example.com')
+      expect(cust_account.email).to eq('test2@example.com')
+    end
+
+    it 'updates multiple accounts' do
+      customer_account_1 = session.Customer.create(name: 'Brandy', email: 'test1@example.com')
+      customer_account_2 = session.Customer.create(name: 'Sandy', email: 'test2@example.com')
+      updated_accounts = session.update([
+        [customer_account_1, { email: 'brandy@example.com' }],
+        [customer_account_2, { email: 'sandy@example.com' }]
+      ])
+
+      expect(updated_accounts[0].email).to eq('brandy@example.com')
+      expect(updated_accounts[1].email).to eq('sandy@example.com')
+    end
+
+    it 'gets a customer' do
+      cust_account = session.Customer.create(name: 'Test', email: 'test@example.com')
+      expect(session.Customer.get(cust_account.id)).to be_truthy
+    end
+
+    it 'selects customer attributes' do
+      cust_account = session.Customer.create(name: 'Test', email: 'test@example.com')
+      selected = session.Customer.select('id').get(cust_account.id)
+      expect(selected['id']).to eq(cust_account.id)
+    end
+  end
+end

data/spec/objects/v1/billing_spec.rb

@@ -0,0 +1,54 @@
+require 'payload'
+require 'payload/arm/object'
+require_relative '../../support/helpers'
+
+RSpec.describe 'Billing Integration Tests - V1' do
+  include_context 'test helpers'
+
+  let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, 1) }
+  let(:h) { V1Helpers.new(session) }
+
+  describe 'Billing Schedule' do
+    let(:billing_schedule) do
+      proc_account = h.create_processing_account
+      customer_account = h.create_customer_account
+      session.BillingSchedule.create(
+        start_date: '2019-01-01',
+        end_date: '2019-12-31',
+        recurring_frequency: 'monthly',
+        type: 'subscription',
+        customer_id: customer_account.id,
+        processing_id: proc_account.id,
+        charges: [
+          {
+            type: 'option_1',
+            amount: 39.99
+          }
+        ]
+      )
+    end
+
+    it 'creates a billing schedule' do
+      schedule = billing_schedule
+      expect(schedule.charges[0]['amount']).to eq(39.99)
+    end
+
+    it 'updates billing schedule frequency' do
+      schedule = billing_schedule
+      expect(schedule.charges[0]['amount']).to eq(39.99)
+
+      schedule.update(recurring_frequency: 'quarterly')
+      expect(schedule.recurring_frequency).to eq('quarterly')
+    end
+
+    it 'deletes a billing schedule' do
+      schedule = billing_schedule
+      schedule.delete
+      
+      expect {
+        session.BillingSchedule.get(schedule.id)
+      }.to raise_error(Payload::NotFound)
+    end
+  end
+end
+

data/spec/objects/v1/invoice_spec.rb

@@ -0,0 +1,53 @@
+require 'payload'
+require 'payload/arm/object'
+require 'date'
+require_relative '../../support/helpers'
+
+RSpec.describe 'Invoice Integration Tests - V1' do
+  include_context 'test helpers'
+
+  let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, 1) }
+  let(:h) { V1Helpers.new(session) }
+
+  let(:proc_account)       { h.create_processing_account }
+  let(:customer_account)   { h.create_customer_account }
+  let(:invoice)            { h.create_invoice(proc_account, customer_account) }
+
+  describe 'Invoice' do
+    it 'creates an invoice' do
+      inv = invoice
+      expect(inv.due_date).to eq(Date.today.strftime('%Y-%m-%d'))
+      expect(inv.status).to eq('unpaid')
+    end
+
+    it 'pays an invoice' do
+      inv = invoice
+      expect(inv.due_date).to eq(Date.today.strftime('%Y-%m-%d'))
+      expect(inv.status).to eq('unpaid')
+
+      amount = inv.amount_due
+
+      if inv.status != 'paid'
+        h.create_card_payment(
+          proc_account.id,
+          amount: amount,
+          description: 'Test Payment',
+          customer_id: customer_account.id,
+          invoice_id: inv.id
+        )
+      end
+
+      get_invoice = session.Invoice.get(inv.id)
+      expect(get_invoice.status).to eq('paid')
+    end
+
+    it 'deletes an invoice' do
+      inv = invoice
+      inv.delete
+
+      expect {
+        session.Invoice.get(inv.id)
+      }.to raise_error(Payload::NotFound)
+    end
+  end
+end

data/spec/objects/v1/payment_link_spec.rb

@@ -0,0 +1,50 @@
+require 'payload'
+require 'payload/arm/object'
+require_relative '../../support/helpers'
+
+RSpec.describe 'Payment Link Integration Tests - V1' do
+  include_context 'test helpers'
+
+  let(:session) { Payload::Session.new(Payload.api_key, Payload.api_url, 1) }
+  let(:h) { V1Helpers.new(session) }
+
+  describe 'Payment Link' do
+
+    it 'creates a one-time payment link' do
+      proc_account = h.create_processing_account
+      payment_link = h.create_payment_link_one_time(proc_account)
+
+      expect(payment_link.processing_id).to eq(proc_account.id)
+      expect(payment_link.type).to eq('one_time')
+    end
+
+    it 'creates a reusable payment link' do
+      proc_account = h.create_processing_account
+      payment_link = h.create_payment_link_reusable(proc_account)
+
+      expect(payment_link.processing_id).to eq(proc_account.id)
+      expect(payment_link.type).to eq('reusable')
+    end
+
+    it 'deletes a reusable payment link' do
+      proc_account = h.create_processing_account
+      payment_link = h.create_payment_link_reusable(proc_account)
+      payment_link.delete
+
+      expect {
+        session.PaymentLink.get(payment_link.id)
+      }.to raise_error(Payload::NotFound)
+    end
+
+    it 'deletes a one-time payment link' do
+      proc_account = h.create_processing_account
+      payment_link = h.create_payment_link_one_time(proc_account)
+      payment_link.delete
+
+      expect {
+        session.PaymentLink.get(payment_link.id)
+      }.to raise_error(Payload::NotFound)
+    end
+  end
+end
+