payload-api 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c1b0ae0bea650ee31b523d697b18fa5823ae0178ad8bb8ada76a02c06fa4d1b
-  data.tar.gz: f474d53fb54ac628452b82634eccd292f68a472fa0e03250c889bd35980a1ecc
+  metadata.gz: c6a65380dc908d716ddb1642ecb6bab391061c469ffa9951b80d3db94e84b08d
+  data.tar.gz: 77978473db8ca858d60db59155625b3133e5d8470fa69ff6a76ec497c086c17a
 SHA512:
-  metadata.gz: c1141993256d880877999ca29b9564c828432e0fa924189272ed7778c7f27995394a2576967e13192b6fabed5860a630ba503290d76f18a6660b7a92638ee548
-  data.tar.gz: 68235f8ceb1fcdd0411f608add58c038b9d9fb79edd47a9f7b72af4abe62aa3b880491849aeca9d67b24585f62ba1ae1bc4168e8dd2406d31099c86f0ae2c85c
+  metadata.gz: '09dce62dabb4cd5d51432adec32190ffb4b0f9a924c3794c0cef3d009c6e0d73897d9d58ca1d8417a85709ca903581fbb444ad66dab3951b27b8bf2ed0e0198d'
+  data.tar.gz: e2d546eef549863a7c3da77c9c6e4ddb5446fa19cc93d854de7109530cff8645a51af2bc46f6a9095bd7b629fe99f464a30848262c459d3899d91d2eddc3ff7a

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2017 RentShare (http://rentshare.com)
+Copyright (c) 2024 Payload (http://payload.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # Payload RubyGem
 
-A RubyGem for integrating [Payload](https://payload.co).
+A RubyGem for integrating [Payload](https://payload.com).
 
 ## Installation
 
@@ -91,4 +91,4 @@ customers = Payload::Customer.filter_by(
 ## Documentation
 
 To get further information on Payload's RubyGem and API capabilities,
-visit the unabridged [Payload Documentation](https://docs.payload.co/?ruby).
+visit the unabridged [Payload Documentation](https://docs.payload.com/?ruby).

data/lib/payload/objects.rb

@@ -85,7 +85,7 @@ module Payload
 
 	class PaymentItem < ARMObject
 		@spec = { 'object' => 'line_item' }
-		@poly = { 'type' => 'payment' }
+		@poly = { 'entry_type' => 'payment' }
 	end
 
 	class PaymentActivation < ARMObject

data/lib/payload/version.rb

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

data/lib/payload.rb

@@ -3,7 +3,7 @@ require "payload/objects"
 require "payload/arm/session"
 
 module Payload
-	@URL = "https://api.payload.co"
+	@URL = "https://api.payload.com"
 
 	class << self
 		def api_key=(value)

data/payload.gemspec

@@ -8,10 +8,10 @@ Gem::Specification.new do |spec|
   spec.version = Payload::VERSION
   spec.required_ruby_version = ">= 2.0.0"
   spec.summary = "Payload ruby library"
-  spec.description = "A simple library to interface with the Payload API. See https://docs.payload.co for details."
+  spec.description = "A simple library to interface with the Payload API. See https://docs.payload.com for details."
   spec.author = "Payload"
   spec.email = "help@payload.co"
-  spec.homepage = "https://docs.payload.co"
+  spec.homepage = "https://docs.payload.com"
   spec.license = "MIT"
 
   spec.files = `git ls-files`.split("\n")

data/spec/objects/payment_spec.rb

@@ -0,0 +1,62 @@
+require "payload"
+require "payload/arm/object"
+require 'base64'
+
+
+RSpec.describe Payload::ARMRequest do
+
+    describe "#create" do
+
+        let(:instance) { described_class.new }
+
+        context "when a payment is created for an invoice" do
+            it "executes the appropriate request and returns the appropriate object" do
+
+                $test_id = 'txn_' + rand(9000000...9999999).to_s
+
+                Payload::api_key = 'test_key'
+                instance.instance_variable_set(:@cls, Payload::Payment)
+
+                expect(instance).to receive(:_execute_request) do |http, request|
+                    expect(request.method).to eq("POST")
+                    expect(http.address).to eq("api.payload.com")
+                    expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
+                    expect(request.path).to eq("/transactions?")
+                    expect(request.body).to eq("{\"amount\":129.0,\"customer_id\":\"acct_3bW9JMoGYQul5fCIa9f8q\",\"allocations\":[{\"entry_type\":\"payment\",\"invoice_id\":\"inv_3eNP6uf94xHTXr0rMyvZJ\"}],\"type\":\"payment\"}")
+
+                    class MockResponse
+                        def initialize
+                        end
+
+                        def code
+                            '200'
+                        end
+
+                        def body
+                            '{
+                                "id": "' + $test_id + '",
+                                "object": "transaction"
+                            }'
+                        end
+                    end
+
+                    MockResponse.new
+                end
+                
+                payment = instance.create(
+                  amount: 129.0,
+                    customer_id: 'acct_3bW9JMoGYQul5fCIa9f8q',
+                    allocations: [
+                        Payload::PaymentItem.new(
+                            invoice_id: 'inv_3eNP6uf94xHTXr0rMyvZJ'
+                        )
+                    ],
+                )
+
+                expect(payment.id).to eq($test_id)
+                expect(payment.object).to eq("transaction")
+                expect(payment.session).to eq(instance.instance_variable_get(:@session))
+            end
+        end
+    end
+end

data/spec/payload/arm/request_spec.rb

@@ -26,7 +26,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("GET")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?fields=name%2Cage")
 
@@ -81,7 +81,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("GET")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?name=John&age=30")
 
@@ -144,7 +144,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("POST")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?")
                     expect(request.body).to eq("{\"type\":\"bill\",\"processing_id\":\"acct_3bz0zU99AX06SJwfMmfn0\",\"due_date\":\"2020-01-01\",\"items\":[{\"entry_type\":\"charge\",\"type\":\"item1\",\"amount\":29.99}],\"customer_id\":\"acct_3bW9JMoGYQul5fCIa9f8q\"}")
@@ -198,7 +198,7 @@ RSpec.describe Payload::ARMRequest do
             
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("POST")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?")
                     expect(request.body).to eq("{\"object\":\"list\",\"values\":[{\"name\":\"John\",\"age\":30},{\"name\":\"Alice\",\"age\":25},{\"name\":\"Bob\",\"age\":35}]}")
@@ -255,7 +255,7 @@ RSpec.describe Payload::ARMRequest do
             
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("POST")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?")
                     expect(request.body).to eq("{\"object\":\"list\",\"values\":[{\"name\":\"John\",\"age\":30},{\"name\":\"Alice\",\"age\":25},{\"name\":\"Bob\",\"age\":35}]}")
@@ -316,7 +316,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect(instance).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("GET")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers/" + $test_id + "?")
 
@@ -362,7 +362,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("PUT")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers/" + $test_id + "?")
                     expect(request.body).to eq("{\"name\":\"John\",\"age\":30}")
@@ -400,14 +400,14 @@ RSpec.describe Payload::ARMRequest do
                 $test_id = 'acct_' + rand(9000000...9999999).to_s
 
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 cust = Payload::Customer.new({id: $test_id})
                 cust.set_session(instance)
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("PUT")
-                    expect(http.address).to eq("sandbox.payload.co")
+                    expect(http.address).to eq("sandbox.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('session_key')
                     expect(request.path).to eq("/customers/" + $test_id + "?")
                     expect(request.body).to eq("{\"name\":\"John\",\"age\":30}")
@@ -448,7 +448,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("PUT")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?")
                     expect(request.body).to eq("{\"object\":\"list\",\"values\":[{\"name\":\"John\",\"age\":30,\"id\":\"" + $test_id_a + "\"},{\"name\":\"Alice\",\"age\":25,\"id\":\"" + $test_id_b + "\"},{\"name\":\"Bob\",\"age\":35,\"id\":\"" + $test_id_c + "\"}]}")
@@ -509,7 +509,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("PUT")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?name=John+Smith&mode=query")
                     expect(request.body).to eq("{\"name\":\"John\",\"age\":30}")
@@ -562,7 +562,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("DELETE")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers/" + $test_id + "?")
                     expect(request.body).to eq(nil)
@@ -600,14 +600,14 @@ RSpec.describe Payload::ARMRequest do
                 $test_id = 'acct_' + rand(9000000...9999999).to_s
 
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 cust = Payload::Customer.new({id: $test_id})
                 cust.set_session(instance)
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("DELETE")
-                    expect(http.address).to eq("sandbox.payload.co")
+                    expect(http.address).to eq("sandbox.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('session_key')
                     expect(request.path).to eq("/customers/" + $test_id + "?")
                     expect(request.body).to eq(nil)
@@ -648,7 +648,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("DELETE")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?")
                     expect(request.body).to eq("{\"object\":\"list\",\"values\":[{\"id\":\"" + $test_id_a + "\"},{\"id\":\"" + $test_id_b + "\"},{\"id\":\"" + $test_id_c + "\"}]}")
@@ -711,7 +711,7 @@ RSpec.describe Payload::ARMRequest do
 
                 expect_any_instance_of(Payload::ARMRequest).to receive(:_execute_request) do |inst, http, request|
                     expect(request.method).to eq("DELETE")
-                    expect(http.address).to eq("api.payload.co")
+                    expect(http.address).to eq("api.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('test_key')
                     expect(request.path).to eq("/customers?name=John+Smith&mode=query")
                     expect(request.body).to eq(nil)
@@ -759,4 +759,4 @@ RSpec.describe Payload::ARMRequest do
             end
         end
     end
-end
+end

data/spec/payload/arm/session_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Payload::Session do
 
             it "sets the api key and uses default url" do
                 expect(instance1.api_key).to eq('test_key')
-                expect(instance1.api_url).to eq('https://api.payload.co')
+                expect(instance1.api_url).to eq('https://api.payload.com')
             end
         end
 
@@ -32,7 +32,7 @@ RSpec.describe Payload::Session do
                 $test_id = 'acct_' + rand(9000000...9999999).to_s
 
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 arm_request = instance.query(Payload::Customer)
 
@@ -41,7 +41,7 @@ RSpec.describe Payload::Session do
 
                 expect(arm_request).to receive(:_execute_request) do |http, request|
                     expect(request.method).to eq("GET")
-                    expect(http.address).to eq("sandbox.payload.co")
+                    expect(http.address).to eq("sandbox.payload.com")
                     expect(Base64.decode64(request['authorization'].split(' ')[1]).split(':')[0]).to eq('session_key')
                     expect(request.path).to eq("/customers?fields=name%2Cage")
 
@@ -88,7 +88,7 @@ RSpec.describe Payload::Session do
 
             it "builds the appropriate ARMRequest" do
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 cust = Payload::Customer.new({})
 
@@ -108,7 +108,7 @@ RSpec.describe Payload::Session do
 
             it "builds the appropriate ARMRequest" do
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 cust = Payload::Customer.new({})
 
@@ -128,7 +128,7 @@ RSpec.describe Payload::Session do
 
             it "builds the appropriate ARMRequest" do
                 Payload::api_key = 'test_key'
-                instance = Payload::Session.new('session_key', 'https://sandbox.payload.co')
+                instance = Payload::Session.new('session_key', 'https://sandbox.payload.com')
 
                 cust = Payload::Customer.new({})
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: payload-api
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Payload
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-10 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies: []
-description: A simple library to interface with the Payload API. See https://docs.payload.co
+description: A simple library to interface with the Payload API. See https://docs.payload.com
   for details.
 email: help@payload.co
 executables: []
@@ -18,7 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/publish.yml"
-- ".github/workflows/ruby-app.yml"
+- ".github/workflows/test.yml"
 - LICENSE
 - README.md
 - lib/payload.rb
@@ -30,9 +30,10 @@ files:
 - lib/payload/utils.rb
 - lib/payload/version.rb
 - payload.gemspec
+- spec/objects/payment_spec.rb
 - spec/payload/arm/request_spec.rb
 - spec/payload/arm/session_spec.rb
-homepage: https://docs.payload.co
+homepage: https://docs.payload.com
 licenses:
 - MIT
 metadata: {}