payload-api 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3fb1c5560cf78f19c57bd89cdb1e13baf1ed62724aeaf79f8540063aef38ec1
-  data.tar.gz: 118974f17c2e63757df0720945ef7c2bce8a8a306f4ae22dc88caf1745883d2e
+  metadata.gz: 0711e29f8e4a39b865cda04ddc414b3b34c38d8b9f9314f785410fb4f1346c7e
+  data.tar.gz: 04cfdc8927d2c47e16db1ceaf8aff90c54b8e87bb1cb57b6e4edc907755f44b6
 SHA512:
-  metadata.gz: b3ff208b9b111d64cbb18807da8600bc4bb7dcb92b68746f21079eab95a3caf51fa089352530023a1ff4d7dc53352d3a9db68d77efba25d6b842d079fb6a73d0
-  data.tar.gz: eebbf9fa92b613fe279f3d322a8694f322e73954c7743483a222fd82dc8c0baa9b97010ccfc6c9e7ba4d5db33ab2c23ec866c82ae23c875d377ef64337d63d1e
+  metadata.gz: e2f51ded017699686030ca7c8c4ab38ebcdbf3efd11f416a467c2aac5435b68b7935b9802429f2665338e2bc5e886aa0b3399d06a881ac3d89a382200e0a2ce4
+  data.tar.gz: 82c40295cc2a47068ad93cf7dcce41c1bdaef381fde723aefb07da4826d6d52a0284b45f343b9eb6cf07d1762481e0b8bfea380d760eec33bf3a2002a27019cc

data/README.md

@@ -1,13 +1,13 @@
 # Payload RubyGem
 
-A RubyGem for interfacing with the Payload API
+A RubyGem for integrating [Payload](https://payload.co).
 
 ## Installation
 
 To install using [Bundler](https://bundler.io):
 
 ```ruby
-gem 'place-api', '~> 0.5.5'
+gem 'payload-api', '~> 0.1.0'
 ```
 
 To install using gem:
@@ -16,9 +16,81 @@ To install using gem:
 gem install payload
 ```
 
+## Get Started
 
-## Basic usage
-Coming Soon
+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.
+
+```python
+import payload as pl
+```
+
+### API Authentication
+
+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'
+```
+
+### Creating an Object
+
+Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of
+creating a customer using the `Payload::Customer` object.
+
+
+```ruby
+# Create a Customer
+customer = Payload::Customer.create(
+	email: 'matt.perez@example.com',
+	full_name: 'Matt Perez'
+)
+```
+
+
+```ruby
+# Create a Payment
+payment = Payload::Payment.create(
+    amount: 100.0,
+    payment_method: Payload::Card(
+        card_number: '4242 4242 4242 4242'
+    )
+)
+```
+
+### Accessing Object Attributes
+
+Object attributes are accessible through both dot and bracket notation.
+
+```ruby
+customer.name
+customer['name']
+```
+
+### Updating an Object
+
+Updating an object is a simple call to the `update` object method.
+
+```ruby
+# Updating a customer's email
+customer.update( email: 'matt.perez@newwork.com' )
+```
+
+### Selecting Objects
+
+Objects can be selected using any of their attributes.
+
+```ruby
+# Select a customer by email
+customers = Payload::Customer.filter_by(
+    email: 'matt.perez@example.com'
+)
+```
 
 ## Documentation
-Read the [docs](https://docs.payload.co/?ruby)
+
+To get further information on Payload's RubyGem and API capabilities,
+visit the unabridged [Payload Documentation](https://docs.payload.co/?ruby).

data/lib/payload.rb

@@ -1,6 +1,16 @@
-require "place/version"
+require "payload/version"
+require "payload/objects"
 
 module Payload
+	@URL = "https://api.payload.co"
+	@api_url = @URL
+	@api_key = nil
+
 	class << self
+		attr_accessor :api_key, :api_url
+	end
+
+	def self.create(objects)
+		return Payload::ARMRequest.new().create(objects)
 	end
 end

data/lib/payload/arm/object.rb

@@ -0,0 +1,85 @@
+require "payload/arm/request"
+
+module Payload
+	class ARMObject
+		@poly = nil
+		@data = nil
+		@@cache = {}
+
+		class << self
+			attr_reader :spec, :poly, :data
+		end
+
+		def initialize(data)
+			self.set_data(data)
+		end
+
+		def self.new(data)
+			if data.key?('id') and @@cache.key?(data['id'])
+				@@cache[data['id']].set_data(data)
+				return @@cache[data['id']]
+			else
+				inst = super
+				if data.key?('id') and not data['id'].nil? and not data['id'].empty?
+					@@cache[data['id']] = inst
+				end
+
+				return inst
+			end
+		end
+
+		def data
+			@data
+		end
+
+		def set_data(data)
+			@data = data
+		end
+
+		def method_missing(name, *args)
+			attr = name.to_s
+			if @data.key?(attr)
+				return @data[attr]
+			else
+				super
+			end
+		end
+
+		def [](key)
+			return @data[key]
+		end
+
+		def self.select(*args, **data)
+			return Payload::ARMRequest.new(self).select(*args, **data)
+		end
+
+		def self.filter_by(*args, **data)
+			return Payload::ARMRequest.new(self).filter_by(*args, **data)
+		end
+
+		def self.create(*args, **data)
+			if args.length != 0
+				return Payload::ARMRequest.new(self).create(args[0])
+			else
+				return Payload::ARMRequest.new(self).create(data)
+			end
+		end
+
+		def self.get(id)
+			return Payload::ARMRequest.new(self).get(id)
+		end
+
+		def self.delete(objects)
+			return Payload::ARMRequest.new(self).delete(objects)
+		end
+
+		def update(**update)
+			return Payload::ARMRequest.new(self.class)._request('Put', id: self.id, json: update)
+		end
+
+		def delete()
+			return Payload::ARMRequest.new(self.class)._request('Delete', id: self.id)
+		end
+	end
+end
+

data/lib/payload/arm/request.rb

@@ -0,0 +1,145 @@
+require "payload/exceptions"
+require "payload/utils"
+require "net/http"
+require "uri"
+require "json"
+
+module Payload
+	class ARMRequest
+		@cls = nil
+
+		def initialize(cls=nil)
+			@cls = cls
+			@filters = {}
+		end
+
+		def select(*args, **data)
+			if @cls.poly
+				data = data.merge(@cls.poly)
+			end
+
+			return self
+		end
+
+		def filter_by(*args, **data)
+			if @cls.poly
+				data = data.merge(@cls.poly)
+			end
+
+			@filters = @filters.merge(data)
+
+			return self
+		end
+
+		def all()
+			return self._request('Get')
+		end
+
+		def get(id)
+			if id.nil? || id.empty?
+				throw 'id cannot be empty'
+			end
+
+			return self._request('Get', id: id)
+		end
+
+		def update(**updates)
+			return self.filter_by(mode: 'query')
+				._request('Put', json: updates)
+		end
+
+		def delete(objects)
+			deletes = objects.map {|o| o.id }.join('|')
+			return self.filter_by(mode: 'query', id: deletes)
+				._request('Delete')
+		end
+
+		def create(data)
+			if data.is_a? Array
+				data = data.map do |obj|
+					if obj.kind_of?(ARMObject)
+						if @cls and not obj.instance_of?(@cls)
+							throw "All objects must be of the same type"
+						end
+
+						@cls = obj.class
+						obj = obj.data
+					end
+
+					if @cls.poly
+						obj = obj.merge(@cls.poly)
+					end
+
+					obj
+				end
+
+				data = { object: 'list', values: data }
+			else
+				if @cls.poly
+					data = data.merge(@cls.poly)
+				end
+			end
+
+			return self._request('Post', json: data)
+		end
+
+		def _request(method, id: nil, json: nil)
+			if @cls.spec.key?("endpoint")
+				endpoint = @cls.spec["endpoint"]
+			else
+				endpoint = "/"+@cls.spec["object"]+"s"
+			end
+
+			if id
+				endpoint = File.join(endpoint, id)
+			end
+
+			url = URI.join(Payload::api_url, endpoint)
+			url.query = URI.encode_www_form(@filters)
+
+			http = Net::HTTP.new(url.host, url.port)
+
+			if url.port == 443
+				http.use_ssl = true
+			end
+
+			request = Net::HTTP.const_get(method).new(url.request_uri)
+			request.basic_auth(Payload::api_key, '')
+
+			if json
+				request.body = json.to_json
+				request.add_field('Content-Type', 'application/json')
+			end
+
+			response = http.request(request)
+
+			begin
+				data = JSON.parse(response.body)
+			rescue JSON::ParserError
+				if response.code == '500'
+					raise Payload::InternalError.new
+				else
+					raise Place::UnknownResponse.new
+				end
+			end
+
+			if response.code == '200'
+				if data['object'] == 'list'
+					return data['values'].map {|obj| Payload::get_cls(obj).new(obj) }
+				else
+					return Payload::get_cls(data).new(data)
+				end
+			else
+				for error in Payload::subclasses(Payload::PayloadError)
+					if error.code != response.code or error.name.split('::')[-1] != data['error_type']
+						next
+					end
+
+					raise error.new(data['description'], data)
+				end
+
+				raise Payload::BadRequest.new(data['description'], data)
+			end
+		end
+	end
+end

data/lib/payload/exceptions.rb

@@ -0,0 +1,48 @@
+module Payload
+	class PayloadError < StandardError
+		@code = nil
+		class << self
+			attr_reader :code
+		end
+
+		def initialize(msg, details = nil)
+			super(msg)
+			@details = details
+		end
+	end
+
+	class UnknownResponse < PayloadError
+	end
+
+	class BadRequest < PayloadError
+		@code='400'
+	end
+
+	class InvalidAttributes < PayloadError
+		@code='400'
+	end
+
+	class Unauthorized < PayloadError
+		@code='401'
+	end
+
+	class Forbidden < PayloadError
+		@code='403'
+	end
+
+	class NotFound < PayloadError
+		@code='404'
+	end
+
+	class TooManyRequests < PayloadError
+		@code='429'
+	end
+
+	class InternalServerError < PayloadError
+		@code='500'
+	end
+
+	class ServiceUnavailable < PayloadError
+		@code='503'
+	end
+end

data/lib/payload/objects.rb

@@ -0,0 +1,79 @@
+require "payload/arm/object"
+
+module Payload
+	class Account < ARMObject
+		@spec = { 'object' => 'account' }
+	end
+
+	class Customer < ARMObject
+		@spec = { 'object' => 'account' }
+		@poly = { 'type' => 'customer' }
+	end
+
+	class ProcessingAccount < ARMObject
+		@spec = { 'object' => 'account' }
+		@poly = { 'type' => 'processing' }
+	end
+
+	class Org < ARMObject
+		@spec = { 'object' => 'org', 'endoint' => '/account/orgs' }
+	end
+
+	class Transaction < ARMObject
+		@spec = { 'object' => 'transaction' }
+	end
+
+	class Payment < ARMObject
+		@spec = { 'object' => 'transaction' }
+		@poly = { 'type' => 'payment' }
+	end
+
+	class Refund < ARMObject
+		@spec = { 'object' => 'transaction' }
+		@poly = { 'type' => 'refund' }
+	end
+
+	class Ledger < ARMObject
+		@spec = { 'object' => 'transaction_ledger' }
+	end
+
+	class PaymentMethod < ARMObject
+		@spec = { 'object' => 'payment_method' }
+	end
+
+	class Card < ARMObject
+		@spec = { 'object' => 'payment_method' }
+		@poly = { 'type' => 'card' }
+	end
+
+	class BankAccount < ARMObject
+		@spec = { 'object' => 'payment_method' }
+		@poly = { 'type' => 'bank_account' }
+	end
+
+	class BillingSchedule < ARMObject
+		@spec = { 'object' => 'billing_schedule' }
+	end
+
+	class BillingCharge < ARMObject
+		@spec = { 'object' => 'billing_charge' }
+	end
+
+	class Invoice < ARMObject
+		@spec = { 'object' => 'invoice' }
+	end
+
+	class LineItem < ARMObject
+		@spec = { 'object' => 'line_item' }
+	end
+
+	class ChargeItem < ARMObject
+		@spec = { 'object' => 'line_item' }
+		@poly = { 'type' => 'charge' }
+	end
+
+	class PaymentItem < ARMObject
+		@spec = { 'object' => 'line_item' }
+		@poly = { 'type' => 'payment' }
+	end
+end

data/lib/payload/utils.rb

@@ -0,0 +1,38 @@
+module Payload
+
+	def self.subclasses(super_cls)
+		ObjectSpace.each_object(Class).select { |cls| cls < super_cls }
+	end
+
+	def self.get_cls(data)
+		match = nil
+		for cls in subclasses(Payload::ARMObject)
+			if cls.spec['object'] != data['object']
+				next
+			end
+
+			if not cls.poly and not match
+				match = cls
+
+			elsif cls.poly
+
+				invalid = false
+				cls.poly.each do |key, value|
+					if data[key] != value
+						invalid = true
+					end
+				end
+
+				if invalid
+					next
+				end
+
+				match = cls
+				break
+			end
+		end
+
+		match
+	end
+
+end

data/lib/payload/version.rb

@@ -1,3 +1,3 @@
 module Payload
-    VERSION = '0.0.0'
+    VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: payload-api
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Payload
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-28 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies: []
 description: A simple library to interface with the Payload API. See https://docs.payload.co
   for details.
@@ -20,6 +20,11 @@ files:
 - LICENSE
 - README.md
 - lib/payload.rb
+- lib/payload/arm/object.rb
+- lib/payload/arm/request.rb
+- lib/payload/exceptions.rb
+- lib/payload/objects.rb
+- lib/payload/utils.rb
 - lib/payload/version.rb
 - payload.gemspec
 homepage: https://docs.payload.co
@@ -41,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Payload ruby library