place-ruby 0.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5129d2663f57d69df1959b6af34d5c2be289eef57551f982bf3a22bfdbb0e71
+  data.tar.gz: b7240a849b674d17995cc70c28cefc5c00b7b8dbd329c93c7200e084f29a6ecf
+SHA512:
+  metadata.gz: 5f32d48027dad2b3352750cbb6dae800440d0908e67c5eb1121b2ad3cf528f9fe3a477bc84f3ba3a48860034dc8421e648ebdc6aa3fb933539e38125d991e122
+  data.tar.gz: caa19e67ee9f07d015f123bc409d5ad946bbc01123b4e4c0d05d390d4fc09ce334aa9b540ad64fa0b9e794393e85506d21da1b626c6214fda26c017020048759

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 RentShare (http://rentshare.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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Place RubyGem
+
+A RubyGem for interfacing with the Place API
+
+## Installation
+
+To install using [Bundler](https://bundler.io):
+
+```ruby
+gem 'place', :git => 'git://github.com/placepay/place-ruby.git'
+```
+
+To manually install `place-ruby` from github use gem specific_install:
+
+```bash
+gem install specific_install
+gem specific_install https://github.com/placepay/place-ruby.git
+```
+
+
+## Basic usage
+
+```ruby
+require 'place'
+
+# set your api key
+Place.api_key = 'private_key_6fsMi3GDxXg1XXSluNx1sLEd'
+
+# create an account
+account = Place::Account.create(
+    :email => 'joe.schmoe@example.com',
+    :full_name => 'Joe Schmoe',
+    :user_type => 'payer'
+)
+```
+
+## Documentation
+Read the [docs](https://developer.placepay.com/?ruby)

data/lib/place.rb

@@ -0,0 +1,21 @@
+require "place/version"
+require "place/client"
+require "place/exceptions"
+require "place/api_resource"
+require "place/resources"
+
+module Place
+
+	@PROD_URL = "https://api.placepay.com"
+	@TEST_URL = "https://test-api.placepay.com"
+
+	@api_key = nil
+	@api_url = @PROD_URL
+
+	@default_client = self::Client.new
+
+	class << self
+		attr_accessor :PROD_URL, :TEST_URL, :api_key, :api_url, :default_client
+	end
+
+end

data/lib/place/api_resource.rb

@@ -0,0 +1,227 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Place
+
+	def self.merge_obj( obj: nil, **params )
+		params = params.collect{|k,v| [k.to_s, v]}.to_h
+		if obj
+			obj = obj.merge(params)
+		else
+			obj = params
+		end
+		return obj
+	end
+
+	def self.conv_object(obj, client: nil, inverse: false)
+		obj = obj.clone
+		if obj.class == Array
+			iter = obj.map.with_index{|a,i| [i,a] }
+		else
+			iter = obj
+		end
+
+		iter.each do |key, val|
+			if inverse
+				if val.is_a?(Place::APIResource)
+					obj[key] = val._obj
+					val = obj[key]
+				end
+			elsif val.is_a?(Hash) and val['object']
+				for resource in Place::APIResource.descendants
+					if val['object'] != resource.object_type
+						next
+					end
+
+					obj[key] = resource.new(client: client, obj: val)
+					val = obj[key]
+					break
+				end
+			end
+			if [Hash, Array].member? val.class
+				obj[key] = Place::conv_object(val, client:client, inverse: inverse)
+			end
+		end
+
+		return obj
+	end
+
+	class APIResource
+		attr_accessor :_obj
+
+		def self.descendants
+			ObjectSpace.each_object(Class).select { |klass| klass < self }
+		end
+
+		@resource = nil
+		@object_type = nil
+		@@object_index = {}
+
+		@default_params = nil
+
+		class << self
+			attr_reader :resource, :object_type
+			attr_accessor :default_params
+		end
+
+		def self.new(client: nil, obj: nil, **params)
+			obj = Place::merge_obj( obj: obj, **params )
+
+			if obj["id"]
+				if @@object_index[obj["id"]]
+					@@object_index[obj["id"]]._set_obj(obj)
+					return @@object_index[obj["id"]]
+				end
+			end
+			super
+		end
+
+		def initialize(client: nil, obj: nil, **params)
+			obj = Place::merge_obj( obj: obj, **params )
+			@client = client || Place.default_client
+			self._set_obj(obj)
+		end
+
+		def _set_obj(obj)
+			@_obj = obj
+			@_obj = Place::conv_object(@_obj, client: @_client)
+			if obj["id"]
+				@@object_index[obj["id"]] = self
+			end
+		end
+
+		def method_missing(name, *args)
+			attr = name.to_s
+			if @_obj.key?(attr)
+				return @_obj[attr]
+			end
+			super
+		end
+
+		def json()
+			return JSON.pretty_generate(Place::conv_object(@_obj, inverse: true))
+		end
+
+		def self.request(method, path: nil, id: nil, client: nil, json: nil, params: nil)
+			path   = path || @resource
+			client = client || Place.default_client
+
+			if id; path = File.join(path, id) end
+			if path[0] == '/'; path = path[1..-1] end
+
+			uri = URI.join(client.api_url, path)
+			if @default_params
+				if !params; params = {} end
+				@default_params.each do |key, param|
+					if !params.key?(key.to_sym); params[key.to_sym] = param end
+				end
+			end
+			if params; uri.query = URI.encode_www_form(params) end
+
+			http = Net::HTTP.new(uri.host, uri.port)
+			if uri.port == 443; http.use_ssl = true end
+			request = Net::HTTP.const_get(method).new(uri.request_uri)
+			request.basic_auth(client.api_key, "")
+			request.add_field("X-API-Version", "v2.5")
+
+			if json
+				request.body = json.to_json
+				request.add_field("Content-Type", "application/json")
+			end
+
+			response = http.request(request)
+			status_code = response.code
+
+			begin
+				obj = JSON.parse(response.body)
+			rescue JSON::ParserError
+				if status_code == '500'
+					raise Place::InternalError.new
+				end
+
+				raise Place::InvalidResponse.new
+			end
+
+			if obj.class != Hash
+				raise Place::InvalidResponse.new
+			end
+
+			object_type = obj["object"]
+			if !object_type
+				raise Place::InvalidResponse.new('Response missing "object" attribute')
+			end
+
+			if status_code != '200'
+				if object_type != 'error'
+					raise Place::InvalidResponse.new('Expected error object')
+				end
+
+				for exc in Place::APIException.descendants
+					if exc.status_code != status_code; next end
+
+					if exc.error_type && exc.error_type != obj["error_type"]; next end
+
+					raise exc.new(obj["error_description"],obj)
+				end
+
+				raise Place::APIException.new(obj["error_description"],obj)
+			end
+
+			if object_type == 'list'
+				return obj["values"].map {|o| self.new(:client=>client, :obj=>o) }
+			end
+
+			return self.new(:client=>client, :obj=>obj)
+		end
+
+		def update(**updates)
+			self.class.request('Put', id: self.id, json: updates)
+		end
+
+		def delete()
+			self.class.request('Delete', id: self.id)
+		end
+
+		def self.get(id,update:nil, **params)
+			if id.empty? || id.nil?
+				raise Place::APIException.new('id cannot be blank')
+			end
+			if update
+				return self.request('Put', id: id, json: update, params: params )
+			end
+			return self.request('Get', id: id, params: params)
+		end
+
+		def self.select( update_all: nil, delete_all: false, **filter_by)
+			if update_all
+				return self.request('Put', params: filter_by, json: update_all)
+			elsif delete_all
+				return self.request('Delete', params: filter_by)
+			else
+				return self.request('Get', params: filter_by)
+			end
+		end
+
+		def self.create( obj, **params)
+			if obj.class == Array
+				obj = {"object"=>"list", "values"=>obj}
+			else
+				obj = Place::merge_obj( obj: obj, **params )
+			end
+			obj = Place::conv_object(obj, inverse: true)
+			return self.request('Post', json: obj)
+		end
+
+		def self.update_all(updates, **params)
+			updates = updates.map {|o, upd| Hash(id: o.id, **upd) }
+			return self.request('Put',
+								json: {"object"=>"list", "values"=>updates}, params: params)
+		end
+
+		def self.delete_all(objects)
+			deletes = objects.map {|o| o.id }.join('|')
+			return self.request('Delete', params: {'id'=>deletes})
+		end
+	end
+end

data/lib/place/client.rb

@@ -0,0 +1,25 @@
+
+module Place
+	class Client
+		attr_accessor :api_key, :api_url
+
+		def initialize(api_key: nil, api_url: nil)
+			@api_key = api_key
+			@api_url = api_url
+		end
+
+		def api_key()
+			@api_key || Place.api_key
+		end
+
+		def api_url()
+			if @api_key
+				return @api_key
+			end
+			if self.api_key && self.api_key.start_with?('test_') and Place.api_url == Place.PROD_URL
+				return Place.TEST_URL
+			end
+			return Place.api_url
+		end
+	end
+end

data/lib/place/exceptions.rb

@@ -0,0 +1,66 @@
+module Place
+	class APIException < StandardError
+		attr_accessor :error_details
+		@error_type  = nil
+		@status_code = nil
+
+		def initialize( msg = nil, error_details = nil )
+			super(msg)
+			@error_details = error_details
+		end
+
+		def self.descendants
+			ObjectSpace.each_object(Class).select { |klass| klass < self }
+		end
+
+		class << self
+			attr_reader :error_type, :status_code
+		end
+	end
+
+
+	class InvalidArguments < APIException
+		@error_type  = 'InvalidArguments'
+		@status_code = '400'
+	end
+
+
+	class InvalidRequest < APIException
+		@error_type  = 'Error'
+		@status_code = '400'
+	end
+
+
+	class Unauthorized < APIException
+		@status_code = '401'
+	end
+
+
+	class Forbidden < APIException
+		@status_code = '403'
+	end
+
+
+	class NotFound < APIException
+		@status_code = '404'
+	end
+
+
+	class MethodNotAllowed < APIException
+		@status_code = '405'
+	end
+
+
+	class TooManyRequests < APIException
+		@status_code = '429'
+	end
+
+
+	class InternalError < APIException
+		@status_code = '500'
+	end
+
+
+	class InvalidResponse < APIException
+	end
+end

data/lib/place/resources.rb

@@ -0,0 +1,84 @@
+module Place
+	class AccessToken < APIResource
+		@resource    = '/access_tokens'
+		@object_type = 'access_token'
+	end
+
+
+	class AutopayEnrollment < APIResource
+		@resource    = '/autopay_enrollments'
+		@object_type = 'autopay_enrollment'
+	end
+
+
+	class Event < APIResource
+		@resource    = '/events'
+		@object_type = 'event'
+	end
+
+
+	class Account < APIResource
+		@resource    = '/accounts'
+		@object_type = 'account'
+	end
+
+
+	class DepositAccount < APIResource
+		@resource    = '/deposit_accounts'
+		@object_type = 'deposit_account'
+	end
+
+
+	class Transaction < APIResource
+		@resource    = '/transactions'
+		@object_type = 'transaction'
+	end
+
+
+	class TransactionAllocation < APIResource
+		@resource    = '/transaction_allocations'
+		@object_type = 'transaction_allocation'
+	end
+
+
+	class PaymentMethod < APIResource
+		@resource    = '/payment_methods'
+		@object_type = 'payment_method'
+	end
+
+
+	class Address < APIResource
+		@resource    = '/addresses'
+		@object_type = 'address'
+	end
+
+
+	class RecurringInvoice < APIResource
+		@resource    = '/recurring_invoices'
+		@object_type = 'recurring_invoice'
+	end
+
+
+	class Invoice < APIResource
+		@resource    = '/invoices'
+		@object_type = 'invoice'
+	end
+
+
+	class InvoiceItem < APIResource
+		@resource    = '/invoice_items'
+		@object_type = 'invoice_item'
+	end
+
+
+	class InvoicePayer < APIResource
+		@resource    = '/invoice_payers'
+		@object_type = 'invoice_payer'
+	end
+
+
+	class InvoiceItemAllocation < APIResource
+		@resource    = '/invoice_item_allocations'
+		@object_type = 'invoice_item_allocation'
+	end
+end

data/lib/place/version.rb

@@ -0,0 +1,3 @@
+module Place
+    VERSION = '0.5.5'
+end

data/place.gemspec

@@ -0,0 +1,21 @@
+lib = File.join(File.dirname(__FILE__), "lib")
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'place/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "place-ruby"
+  spec.version = Place::VERSION
+  spec.required_ruby_version = ">= 2.0.0"
+  spec.summary = "Place ruby library"
+  spec.description = "A simple library to interface with the Place REST API. See https://developer.placepay.com for details."
+  spec.author = "Place"
+  spec.email = "help@placepay.com"
+  spec.homepage = "https://developer.placepay.com"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: place-ruby
+version: !ruby/object:Gem::Version
+  version: 0.5.5
+platform: ruby
+authors:
+- Place
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-14 00:00:00.000000000 Z
+dependencies: []
+description: A simple library to interface with the Place REST API. See https://developer.placepay.com
+  for details.
+email: help@placepay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/place.rb
+- lib/place/api_resource.rb
+- lib/place/client.rb
+- lib/place/exceptions.rb
+- lib/place/resources.rb
+- lib/place/version.rb
+- place.gemspec
+homepage: https://developer.placepay.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Place ruby library
+test_files: []