payload-api 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb1f9ed364eb3e8d721aa2e52e3998097e764c5efdb650b7c1ab840b792197d
-  data.tar.gz: 17e0e956231c7ae5ccfb0c63ca1a50061d4ed1812b7c8871c3d54f38e7254a05
+  metadata.gz: 34f564177aca2508a3ab7864c3c86b2750fbe7b6d678bcf821d4f802da7d59b5
+  data.tar.gz: 626a0ecbdfff120ca85a8e8bef68af08fdfe7627826baeb6f88bfe10e1818197
 SHA512:
-  metadata.gz: 32dc9421316afd86f9df392613d2f6c4b5ef793c0a82e5256718bf3740408ec3b055f3916d8e9a5c06d792eb5cf589338452dec6b46ad5bf0e14ab15ce8ac81b
-  data.tar.gz: cd79ebdffa7156488217896c5b6ae37379f9efbe9781cfcdfcd6690ae9acd21eb70c4debabd48bf0e99c45a704303df5702717c510dcfe2c6ffd672efabeed55
+  metadata.gz: bbdfbe194bc9a878426bc74cd6c59107852a557a5a2fc1c9c5353bcca935ba189e64fc5a88d4a13076eb6ab104b6d57f337a7326fa9be58ab1974d595ada2a87
+  data.tar.gz: 5b9d5a44b34ecd605e94e3c6910b9f2dcef895f84ac29987bfd84234490befe616904322e2c3859ef4e062ccd1d5d11945bb33822dc8e58395576cd408fc2b3e

data/.github/workflows/ruby-app.yml

@@ -0,0 +1,25 @@
+name: RSpec Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+      
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+
+    - name: Run RSpec tests
+      run: |
+        gem install rspec
+        rspec spec

data/README.md

@@ -18,12 +18,10 @@ gem install payload
 
 ## Get Started
 
-Once you've installed the Payload Python library to your environment,
-import the `payload` module to get started. **Note:** We recommend
-using the shorthand name of `pl` when importing.
+Once Payload has been added to your Gemfile and installed, use `require` as shown below to import it into your project.
 
-```python
-import payload as pl
+```ruby
+require 'payload'
 ```
 
 ### API Authentication
@@ -31,9 +29,9 @@ import payload as pl
 To authenticate with the Payload API, you'll need a live or test API key. API
 keys are accessible from within the Payload dashboard.
 
-```python
-import payload as pl
-pl.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
+```ruby
+require 'payload'
+Payload.api_key = 'secret_key_3bW9JMZtPVDOfFNzwRdfE'
 ```
 
 ### Creating an Object

data/lib/payload/arm/request.rb

@@ -14,10 +14,8 @@ module Payload
 		end
 
 		def select(*args, **data)
-			if @cls.poly
-				data = data.merge(@cls.poly)
-			end
-
+			@filters['fields'] = args.map {|a| a.strip }.join(',')
+	
 			return self
 		end
 

data/lib/payload/objects.rb

@@ -82,4 +82,8 @@ module Payload
 	class Webhook < ARMObject
 		@spec = { 'object' => 'webhook' }
 	end
+
+	class PaymentLink < ARMObject
+		@spec = { 'object' => 'payment_link' }
+	end
 end

data/lib/payload/version.rb

@@ -1,3 +1,3 @@
 module Payload
-    VERSION = '0.2.4'
+    VERSION = '0.2.6'
 end

data/spec/payload/arm/request_spec.rb

@@ -0,0 +1,45 @@
+require "payload"
+require "payload/arm/object"
+
+
+RSpec.describe Payload::ARMRequest do
+
+    describe "#select" do
+
+        let(:instance) { described_class.new }
+
+        context "when the user selects custom fields" do
+            it "merges the given data with the class's polymorphic association" do
+                instance.select(' name', 'age  ')
+                expect(instance.instance_variable_get(:@filters)).to eq({ "fields" => "name,age" })
+                instance.select('count(id)', 'sum(amount)')
+                expect(instance.instance_variable_get(:@filters)).to eq({ "fields" => "count(id),sum(amount)" })
+            end
+        end
+    end
+
+    describe "#filter_by" do
+
+        let(:instance) do
+            class TestObject < Payload::ARMObject
+                @poly = { "type" => "test" }
+            end
+            Payload::ARMRequest.new(TestObject)
+        end
+        
+        context "when the class does not have a polymorphic association" do
+            it "sets the given data as filters" do
+                instance.filter_by(name: "John", age: 30)
+                expect(instance.instance_variable_get(:@filters)).to eq({name: "John", age: 30, "type" => "test"})
+            end
+        end
+        
+        context "when called multiple times" do
+            it "merges all the given data into a single hash" do
+                instance.filter_by(name: "John", city: "San Francisco")
+                instance.filter_by(age: ['<30', '>20'])
+                expect(instance.instance_variable_get(:@filters)).to eq({name: "John", age: ['<30', '>20'], city: "San Francisco", "type" => "test"})
+            end
+        end
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payload-api
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Payload
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies: []
 description: A simple library to interface with the Payload API. See https://docs.payload.co
   for details.
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby-app.yml"
 - LICENSE
 - README.md
 - lib/payload.rb
@@ -27,6 +28,7 @@ files:
 - lib/payload/utils.rb
 - lib/payload/version.rb
 - payload.gemspec
+- spec/payload/arm/request_spec.rb
 homepage: https://docs.payload.co
 licenses:
 - MIT