payload-api 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c7eb5c0125eb3e66a5800851c6e66e42ae36138a2b89516b2ae8a823cacc7d
-  data.tar.gz: 602f23d391904acdb9ddf3540990692f8f54284746d3bba5eb528827f2f802da
+  metadata.gz: a6364ada87b188e97370c985aaee315c1abe7149162d0bfe1a1feca21407e416
+  data.tar.gz: 0ba29b0d267e6dbe078c0ffe8a20ac915cfebb515e9ac20f6d7f8697160a45d5
 SHA512:
-  metadata.gz: 19b0346676cab8cbd11a997fbb30f2a9ccec35eb16bfe7905da763efc6f5b7efc27002ac828ff0b14041e284bdd10d0cbc093dbb3d09350dd08bb5cd82bfa1af
-  data.tar.gz: 7abac9292dcc52fe334f4182f59d6c4253242451a5f3e4aec7997399a6469c56caadf3862b511529d08b5e65c5779764ad868b2e06134266500deedbfa0e73f4
+  metadata.gz: d6e5b2ebca0650bc0358a0d8883681363a519795ffa49349fb936f821175d9d173f45ad49c86553ac701f3a284bfd48f8cdf901831fa7b559a7dc13c0f0adb07
+  data.tar.gz: 18634323e7c0221562430f79fc68638f2db08f2ee9caea5bb2b3c7b3f577aa2d8b70627ad17af9e3b72d2f9ed802ef211b69a2bc60566036b8922f3bb2b35b5b

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2024 Payload (http://payload.com)
+Copyright (c) 2026 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/lib/payload/arm/attr.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Payload
+  class ARMFilter
+    attr_reader :attr, :opval, :val
+
+    def initialize(attr, val)
+      @attr = attr.to_s
+      @val = val
+      @opval = self.class.op + val.to_s
+    end
+
+    def self.op
+      ''
+    end
+
+    def |(other)
+      raise TypeError, 'invalid type' unless other.is_a?(Payload::ARMFilter)
+      raise ArgumentError, '`or` only works on the same attribute' if other.attr != @attr
+      joined = [@opval, other.opval].join('|')
+      Payload::ARMEqual.new(@attr, joined)
+    end
+  end
+
+  class ARMEqual < ARMFilter
+    def self.op
+      ''
+    end
+  end
+
+  class ARMNotEqual < ARMFilter
+    def self.op
+      '!'
+    end
+  end
+
+  class ARMGreaterThan < ARMFilter
+    def self.op
+      '>'
+    end
+  end
+
+  class ARMLessThan < ARMFilter
+    def self.op
+      '<'
+    end
+  end
+
+  class ARMGreaterThanEqual < ARMFilter
+    def self.op
+      '>='
+    end
+  end
+
+  class ARMLessThanEqual < ARMFilter
+    def self.op
+      '<='
+    end
+  end
+
+  class ARMContains < ARMFilter
+    def self.op
+      '?*'
+    end
+  end
+
+  # Root proxy for pl.attr so that pl.attr.name returns an Attr (not Class#name).
+  # Session#attr returns this instead of the Attr class to avoid Class/Module methods (e.g. .name) shadowing attribute names.
+  class AttrRoot
+    def method_missing(name, *args)
+      if args.size == 1 && args[0].is_a?(Symbol)
+        inner = Attr.new(name.to_s)
+        Attr.new(args[0].to_s, inner).call
+      else
+        Attr.new(name.to_s)
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      true
+    end
+  end
+
+  # Attribute DSL for select/group_by/order_by and filter expressions.
+  # - pl.attr.id -> "id"
+  # - pl.attr.created_at(:month) -> "month(created_at)"
+  # - pl.attr.amount(:sum) -> "sum(amount)"
+  # - pl.attr.sender.account_id -> "sender[account_id]"
+  class Attr
+    attr_reader :param, :parent
+
+    class << self
+      def method_missing(name, *args)
+        new(name.to_s)
+      end
+
+      def respond_to_missing?(name, include_private = false)
+        true
+      end
+    end
+
+    def initialize(param, parent = nil)
+      @param = param.to_s
+      @parent = parent
+      @is_method = false
+    end
+
+    def key
+      @parent ? "#{@parent.key}[#{@param}]" : @param
+    end
+
+    def to_s
+      @is_method ? "#{@param}(#{@parent.key})" : key
+    end
+
+    def strip
+      to_s.strip
+    end
+
+    def method_missing(name, *args)
+      raise "cannot get attr of method" if @is_method
+
+      if args.size == 1 && args[0].is_a?(Symbol)
+        inner = Attr.new(name.to_s, self)
+        Attr.new(args[0].to_s, inner).call
+      else
+        Attr.new(name.to_s, self)
+      end
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      true
+    end
+
+    # Mark attribute as a function call (e.g. .month(), .sum())
+    def call
+      @is_method = true
+      self
+    end
+
+    def ==(other)
+      ARMEqual.new(self, other)
+    end
+
+    def !=(other)
+      ARMNotEqual.new(self, other)
+    end
+
+    def >(other)
+      ARMGreaterThan.new(self, other)
+    end
+
+    def <(other)
+      ARMLessThan.new(self, other)
+    end
+
+    def >=(other)
+      ARMGreaterThanEqual.new(self, other)
+    end
+
+    def <=(other)
+      ARMLessThanEqual.new(self, other)
+    end
+
+    def contains(other)
+      ARMContains.new(self, other)
+    end
+  end
+end

data/lib/payload/arm/object.rb

@@ -29,11 +29,26 @@ module Payload
 		def get(id)
 			return @cls.get(id, :session => @session)
 		end
-		
+
 		def select(*args, **data)
 			@cls.select(*args, **data, session: @session)
 		end
 
+		def order_by(*args, **data)
+			@cls.order_by(*args, **data, session: @session)
+		end
+
+		def limit(n, **data)
+			@cls.limit(n, **data, session: @session)
+		end
+
+		def offset(n, **data)
+			@cls.offset(n, **data, session: @session)
+		end
+
+		def group_by(*args, **data)
+			@cls.group_by(*args, **data, session: @session)
+		end
 	end
 
 	class ARMObject
@@ -103,7 +118,7 @@ module Payload
 		end
 
 		def [](key)
-			return @data[key]
+			return @data[key.to_s]
 		end
 
 		def _get_request()
@@ -118,6 +133,22 @@ module Payload
 			return self._get_request().select(*args, **data)
 		end
 
+		def self.order_by(*args, **data)
+			self._get_request().order_by(*args, **data)
+		end
+
+		def self.limit(n, **data)
+			self._get_request().limit(n)
+		end
+
+		def self.offset(n, **data)
+			self._get_request().offset(n)
+		end
+
+		def self.group_by(*args, **data)
+			self._get_request().group_by(*args, **data)
+		end
+
 		def self.filter_by(*args, **data)
 			session = data[:session]
 			data.delete(:session)
@@ -154,6 +185,10 @@ module Payload
 			return _get_request()._request('Delete', id: self.id)
 		end
 
+		def json
+			to_json
+		end
+
 		def to_json(*args)
 			serialized = {}
 			if self.class.poly

data/lib/payload/arm/request.rb

@@ -1,5 +1,6 @@
 require "payload/exceptions"
 require "payload/utils"
+require "payload/arm/attr"
 require "net/http"
 require "uri"
 require "json"
@@ -12,21 +13,46 @@ module Payload
 			@cls = cls
 			@session = session || Payload::Session.new(Payload::api_key, Payload::api_url)
 			@filters = {}
+			@group_by = []
+			@order_by = []
+			@limit = nil
+			@offset = nil
+			@filter_objects = []
 		end
 
 		def select(*args, **data)
-			@filters['fields'] = args.map {|a| a.strip }.join(',')
-
+			@filters['fields'] = args.map { |a| a.strip }.join(',')
 			return self
 		end
 
+		def group_by(*args, **data)
+			@group_by.concat(args)
+			self
+		end
+
+		def order_by(*args, **data)
+			@order_by.concat(args)
+			self
+		end
+
+		def limit(n)
+			@limit = n
+			self
+		end
+
+		def offset(n)
+			@offset = n
+			self
+		end
+
 		def filter_by(*args, **data)
+			args.each do |f|
+				@filter_objects << f if f.respond_to?(:attr) && f.respond_to?(:opval)
+			end
 			if !@cls.nil? && @cls.poly
 				data = data.merge(@cls.poly)
 			end
-
 			@filters = @filters.merge(data)
-
 			return self
 		end
 
@@ -35,6 +61,17 @@ module Payload
 			return self._request('Get')
 		end
 
+		def [](key)
+			case key
+			when Range
+				raise ArgumentError, 'Negative slice indices not supported' if key.begin && key.begin < 0
+				raise ArgumentError, 'Negative slice indices not supported' if key.end && key.end < 0
+				offset(key.begin).limit(key.size).all()
+			else
+				raise TypeError, "invalid key or index: #{key.inspect}"
+			end
+		end
+
 		def get(id)
 			if id.nil? || id.empty?
 				throw 'id cannot be empty'
@@ -127,17 +164,29 @@ module Payload
 			http.request(request)
 		end
 
+		def request_params
+			params = @filters.dup
+			@filter_objects.each { |f| params[f.attr] = f.opval }
+			@group_by.each_with_index { |v, i| params["group_by[#{i}]"] = v.to_s }
+			@order_by.each_with_index { |v, i| params["order_by[#{i}]"] = v.to_s }
+			params['limit'] = @limit.to_s if @limit
+			params['offset'] = @offset.to_s if @offset
+			params
+		end
+
 		def _request(method, id: nil, json: nil)
 			if !@cls.nil?
 				if @cls.spec.key?("endpoint")
 					endpoint = @cls.spec["endpoint"]
 				else
-					endpoint = "/"+@cls.spec["object"]+"s"
+					obj = @cls.spec["object"]
+					endpoint = "/" + (obj.end_with?("s") ? obj : obj + "s")
 				end
 			else
 				if json.is_a? Array
 					if json.all? {|obj| obj.key?("object") }
-						endpoint = json[0]["object"]+"s"
+						obj = json[0]["object"]
+						endpoint = (obj.end_with?("s") ? obj : obj + "s")
 					end
 				end
 			end
@@ -146,8 +195,9 @@ module Payload
 				endpoint = File.join(endpoint, id)
 			end
 
+			params = request_params
 			url = URI.join(@session.api_url, endpoint)
-			url.query = URI.encode_www_form(@filters)
+			url.query = URI.encode_www_form(params)
 
 			http = Net::HTTP.new(url.host, url.port)
 

data/lib/payload/arm/session.rb

@@ -1,15 +1,15 @@
 require 'payload/arm/request'
-
+require 'payload/arm/attr'
 
 module Payload
     class Session
         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
@@ -17,11 +17,15 @@ module Payload
                 end
             end
         end
-
+        
         def _get_request(cls = nil)
             return Payload::ARMRequest.new(cls, self)
         end
 
+        def attr
+            Payload::AttrRoot.new
+        end
+        
         def query(cls)
             return self._get_request(cls)
         end

data/lib/payload/exceptions.rb

@@ -18,6 +18,21 @@ module Payload
 		@code='400'
 	end
 
+	class TransactionDeclined < BadRequest
+		attr_reader :transaction
+
+		def initialize(msg, data = nil)
+			super(msg, data)
+			@transaction = if data && data['details'].is_a?(Hash)
+				cls = Payload.get_cls(data['details'])
+				cls = Payload::Transaction if cls.nil?
+				cls.new(data['details'], nil)
+			else
+				nil
+			end
+		end
+	end
+
 	class InvalidAttributes < PayloadError
 		@code='400'
 	end

data/lib/payload/objects.rb

@@ -62,10 +62,18 @@ module Payload
 		@spec = { 'object' => 'invoice' }
 	end
 
+	class InvoiceAttachment < ARMObject
+		@spec = { 'object' => 'invoice_attachment' }
+	end
+
 	class PaymentActivation < ARMObject
 		@spec = { 'object' => 'payment_activation' }
 	end
 
+	class ProcessingSettings < ARMObject
+		@spec = { 'object' => 'processing_settings' }
+	end
+
 	class Webhook < ARMObject
 		@spec = { 'object' => 'webhook' }
 	end
@@ -96,7 +104,7 @@ module Payload
 	class ProcessingAccount < ARMObject
 		@spec = { 'object' => 'processing_account' }
 	end
-	
+
 	class Org < ARMObject
 		@spec = { 'object' => 'org', 'endpoint' => '/account/orgs' }
 	end
@@ -123,7 +131,7 @@ module Payload
 	end
 
 	class Entity < ARMObject
-		@spec = { 'object' => 'entity' }
+		@spec = { 'object' => 'entity', 'endpoint' => 'entities' }
 	end
 
 	class Stakeholder < ARMObject

data/lib/payload/version.rb

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