clayful 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2a9aaad387dd8b0bcb19a627a4a47b54341e9bd87946fc536e62ea2700f6ce6
+  data.tar.gz: 04b7890835ab15bd81c0b10e6936016d2617c74c9f8632be80a8c58fe63255b4
+SHA512:
+  metadata.gz: 4637fd8d3db1c22c97c7ecde2637358962b9a8cae29bc3e28af29c0c971200b0c0812c64decddb880f0f8a1898701478e1d96f7e2eb2d3268cfd6ae5eb8ed82e
+  data.tar.gz: 461a1012c113a6d284aeb1d5565ee9d9864b39c2f1d54b36128defcef77db43617b7fc4559ce44f9a45c5aa5c7e95f3f4362e41d5e55fdeac3dbbf178fe343a4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2017 Clayful
+
+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,13 @@
+# Clayful Ruby SDK
+
+Official Ruby SDK for [clayful.io](https://clayful.io).
+
+## Tests
+
+```sh
+ruby test/run.rb
+```
+
+## Links
+
+- [API & SDK Documentation](https://dev.clayful.io)

data/lib/clayful.rb

@@ -0,0 +1,314 @@
+require 'erb'
+require_relative './exception'
+require_relative './requester'
+require_relative './models/binder'
+
+module Clayful
+
+	@@base_url = 'https://api.clayful.io'
+
+	@@default_headers = {
+		'Accept-Encoding' => 'gzip',
+		'User-Agent'      => 'clayful-ruby',
+		'Clayful-SDK'     => 'clayful-ruby'
+	}
+
+	@@plugins = {
+		'request' => Clayful::Requester.request
+	}
+
+	@@listeners = {
+		'request'  => [],
+		'response' => []
+	}
+
+
+	def self.base_url; @@base_url end;
+	def self.base_url=v; @@base_url = v end;
+
+	def self.default_headers; @@default_headers end;
+	def self.default_headers=v; @@default_headers = v end;
+
+	def self.plugins; @@plugins end;
+	def self.plugins=v; @@plugins = v end;
+
+	def self.listeners; @@listeners end;
+	def self.listeners=v; @@listeners = v end;
+
+
+	def self.options_to_headers(o = {})
+
+		headers = {}
+
+		if o['language']
+			headers['Accept-Language'] = o['language']
+		end
+
+		if o['currency']
+			headers['Accept-Currency'] = o['currency']
+		end
+
+		if o['time_zone']
+			headers['Accept-Time-Zone'] = o['time_zone']
+		end
+
+		if o['client']
+			headers['Authorization'] = 'Bearer ' + o['client']
+		end
+
+		if o['customer']
+			headers['Authorization-Customer'] = o['customer']
+		end
+
+		if o['reCAPTCHA']
+			headers['reCAPTCHA-Response'] = o['reCAPTCHA']
+		end
+
+		if o['debug_language']
+			headers['Accept-Debug-Language'] = o['debug_language']
+		end
+
+		if o['headers']
+			headers = headers.merge(o['headers'])
+		end
+
+		headers
+
+	end
+
+
+	def self.get_endpoint(path)
+
+		@@base_url + path
+
+	end
+
+
+	def self.normalize_query_values(query = {})
+
+		Hash[ query.map { |k, v| [k.to_s, ERB::Util.url_encode(v.to_s)] } ]
+
+	end
+
+
+	def self.extract_request_arguments(options = {})
+
+		result = {
+			'http_method' => options['http_method'],
+			'request_url' => options['path'],
+			'payload'     => nil,
+			'query'       => {},
+			'headers'     => {},
+			'meta'        => {}
+		}
+
+		rest = options['args'].slice(options['params'].length..-1)
+
+		options['params'].each.with_index do |key, i|
+
+			result['request_url'] = result['request_url'].sub('{' + key + '}', options['args'][i].to_s)
+		end
+
+		http_method = options['http_method']
+
+		if (http_method == 'POST' or http_method == 'PUT') and (not options['without_payload'])
+
+			result['payload'] = rest.shift
+		end
+
+		query_headers = rest[0] ? rest[0] : {}
+		query = query_headers.fetch('query', {})
+		meta = query_headers.fetch('meta', {})
+
+		result['query'] = self.normalize_query_values(query)
+		result['headers'] = self.options_to_headers(query_headers)
+		result['meta'] = meta
+
+		result
+
+	end
+
+
+	def self.call_api(options)
+
+		extracted = self.extract_request_arguments(options)
+
+		extracted = extracted.merge({
+			'request_url'    => self.get_endpoint(extracted['request_url']),
+			'model_name'     => options['model_name'],
+			'method_name'    => options['method_name'],
+			'uses_form_data' => !!options['uses_form_data'],
+			'error'          => nil,
+			'response'       => nil,
+		})
+
+		# Extend default headers with header options
+		extracted['headers'] = @@default_headers.clone.merge(extracted['headers'])
+
+		self.trigger('request', extracted)
+
+		begin
+
+			response = self.plugins['request'].call(extracted)
+
+			extracted['response'] = response
+
+			self.trigger('response', extracted)
+
+			return response
+
+		rescue Clayful::Exception => e
+
+			extracted['error'] = e
+
+			self.trigger('response', extracted)
+
+			raise # re-raise the error
+
+		end
+
+	end
+
+
+	def self.config(options = {})
+
+		headers = self.options_to_headers(options)
+
+		@@default_headers = @@default_headers.merge(headers)
+
+	end
+
+
+	def self.install(scope, plugin)
+
+		if @@plugins[scope]
+
+			@@plugins[scope] = plugin
+		end
+
+	end
+
+
+	def self.on(event_name, callback)
+
+		listeners = @@listeners[event_name]
+
+		if listeners
+
+			listeners.push(callback)
+		end
+
+	end
+
+
+	def self.off(event_name, callback)
+
+		listeners = @@listeners[event_name]
+
+		if listeners
+
+			listeners.delete(callback)
+		end
+
+	end
+
+
+	def self.trigger(event_name, data)
+
+		listeners = @@listeners[event_name]
+
+		if listeners
+
+			listeners.each do |listener|
+
+				listener.call(data)
+			end
+		end
+
+	end
+
+
+	def self.format_image_url(base_url, options = {})
+
+		query = []
+
+		normalized = self.normalize_query_values(options)
+
+		normalized.each do |k, v|
+			query.push("#{k}=#{v}")
+		end
+
+		query = query.join('&')
+
+		query.empty? ? base_url : base_url + '?' + query
+
+	end
+
+
+	def self.format_number(number, currency = {})
+
+		if not number.is_a? Numeric
+
+			return ''
+		end
+
+		precision = currency.fetch('precision', nil)
+		delimiter = currency.fetch('delimiter', {})
+		thousands = delimiter.fetch('thousands', '')
+		decimal = delimiter.fetch('decimal', '.')
+
+		if precision.is_a? Numeric
+
+			# Conver to float to keep '.n'
+			n = (10 ** precision).to_f
+
+			number = (number * n).round / n
+
+			# To deal with 0.0 case..
+			if precision == 0
+
+				number = number.round
+			end
+
+		end
+
+		a, b = number.to_s.split('.')
+
+		a = a.reverse.scan(/.{1,3}/).join(thousands).reverse
+		b = b ? b : ''
+
+		if precision.is_a? Numeric
+
+			diff = precision - b.length
+			diff = diff < 0 ? 0 : diff
+
+			b += '0' * diff
+
+		end
+
+		decimal = b.empty? ? '' : decimal
+
+		[a, b].join(decimal)
+
+	end
+
+
+	def self.format_price(number, currency = {})
+
+		formatted_number = self.format_number(number, currency)
+
+		if formatted_number.empty?
+
+			return ''
+		end
+
+		symbol = currency.fetch('symbol', '')
+		format_string = currency.fetch('format', '{price}')
+
+		format_string
+			.sub('{symbol}', symbol)
+			.sub('{price}', formatted_number)
+
+	end
+
+end

data/lib/exception.rb

@@ -0,0 +1,38 @@
+module Clayful
+
+	class Exception < StandardError
+
+		attr_reader :is_clayful
+		attr_reader :model
+		attr_reader :method
+		attr_reader :status
+		attr_reader :headers
+		attr_reader :code
+		attr_reader :message
+		attr_reader :validation
+
+		def initialize(
+			model = nil,
+			method = nil,
+			status = nil,
+			headers = nil,
+			code = nil,
+			message = '',
+			validation = nil)
+
+			@is_clayful = true
+			@model = model
+			@method = method
+			@status = status
+			@headers = headers
+			@code = code
+			@message = message
+			@validation = validation
+
+			super(message)
+
+		end
+
+	end
+
+end

data/lib/models/binder.rb

@@ -0,0 +1,26 @@
+require_relative './brand'
+require_relative './cart'
+require_relative './catalog'
+require_relative './collection'
+require_relative './country'
+require_relative './coupon'
+require_relative './currency'
+require_relative './customer'
+require_relative './discount'
+require_relative './downloadable'
+require_relative './group'
+require_relative './image'
+require_relative './impression'
+require_relative './order'
+require_relative './order_tag'
+require_relative './payment_method'
+require_relative './product'
+require_relative './review'
+require_relative './review_comment'
+require_relative './shipping_method'
+require_relative './store'
+require_relative './subscription'
+require_relative './subscription_plan'
+require_relative './tax_category'
+require_relative './tracker'
+require_relative './wish_list'

data/lib/models/brand.rb

@@ -0,0 +1,109 @@
+module Clayful
+
+	class Brand
+
+		@@name = 'Brand'
+		@@path = 'brands'
+
+		def self.name
+			@@name
+		end
+
+		def self.path
+			@@path
+		end
+
+		def self.list(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'list',
+				'http_method'      => 'GET',
+				'path'             => '/v1/brands',
+				'params'           => [],
+				'args'             => args
+			})
+
+		end
+
+		def self.count(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'count',
+				'http_method'      => 'GET',
+				'path'             => '/v1/brands/count',
+				'params'           => [],
+				'args'             => args
+			})
+
+		end
+
+		def self.get(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'get',
+				'http_method'      => 'GET',
+				'path'             => '/v1/brands/{brandId}',
+				'params'           => ['brandId', ],
+				'args'             => args
+			})
+
+		end
+
+		def self.pull_from_metafield(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'pull_from_metafield',
+				'http_method'      => 'POST',
+				'path'             => '/v1/brands/{brandId}/meta/{field}/pull',
+				'params'           => ['brandId', 'field', ],
+				'args'             => args
+			})
+
+		end
+
+		def self.push_to_metafield(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'push_to_metafield',
+				'http_method'      => 'POST',
+				'path'             => '/v1/brands/{brandId}/meta/{field}/push',
+				'params'           => ['brandId', 'field', ],
+				'args'             => args
+			})
+
+		end
+
+		def self.increase_metafield(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'increase_metafield',
+				'http_method'      => 'POST',
+				'path'             => '/v1/brands/{brandId}/meta/{field}/inc',
+				'params'           => ['brandId', 'field', ],
+				'args'             => args
+			})
+
+		end
+
+		def self.delete_metafield(*args)
+
+			Clayful.call_api({
+				'model_name'       => @@name,
+				'method_name'      => 'delete_metafield',
+				'http_method'      => 'DELETE',
+				'path'             => '/v1/brands/{brandId}/meta/{field}',
+				'params'           => ['brandId', 'field', ],
+				'args'             => args
+			})
+
+		end
+
+	end
+
+end