unleashed 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab9f52896f8b680ac28a67a8716d0e1bafb0213be69e5e3c4ff6ceb1f6898f0e
-  data.tar.gz: 9facbcd5c5592d277b3cb3220534a38629c7d109556c971fd48f129e73c05331
+  metadata.gz: 147bdc99b6e8ce42af1eb564d90374ccaa7ae220b41b3ccc5fed0fee3e23bb6e
+  data.tar.gz: b5f3fc37b96ee6c404c95e00b33822f8025015b6e2dbe781ec25711d469a1d5d
 SHA512:
-  metadata.gz: e4195bce78819508d81b6ec88b7b166e7a4cb84a7338e26b90bb58e6b5e88e45d2e35a1428af19df4447cab4599e698e78516abc9fa455a1c828c3975ea5b3eb
-  data.tar.gz: 2f045fc73f056945c9288efb6cf1144ce8f6e29032dbe1a76445614f441e48b32f1d8bd1ec1f42260b1e667147af27d0b1d1a359d903bd3f182f4ad5d3dbb731
+  metadata.gz: 334ecfd9f511222c578654b81e2a7054c16a7a2ed9f05b6b670e41119b8527c6cb714a024e5c56efb0a00fc1756f847d4b2285efccc0684ac1d5ae8211c0686a
+  data.tar.gz: c9534ae24edb3ec3b933f1cbb5dc47510883583d93f9d20ca197a757542efc6d17085e8bc2cae1863ba14f16fd9846b25e04caa224e3ac517003923ef7c8468d

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.4] - 2019-11-11
+
+- Add `Customer` resource
+- Add `json` and `faraday` gems
+
+## [0.1.0] - 2019-11-08
+
+- Init project
+
+### Added
+
+- Added ability to request data.

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/unleashed/client.rb

@@ -0,0 +1,159 @@
+require_relative 'configurable'
+require_relative 'error'
+require_relative 'models/base_model'
+require_relative 'models/customer'
+require_relative 'resources/base_resource'
+require_relative 'resources/customer_resource'
+require 'json'
+require 'faraday'
+
+module Unleashed
+  # Client for the Unleashed API
+  #
+  # @see https://apidocs.unleashedsoftware.com
+  class Client
+    include Unleashed::Configurable
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Unleashed::Configurable.keys.each do |key|
+        instance_variable_set(
+          :"@#{key}", options[key] || Unleashed.instance_variable_get(:"@#{key}")
+        )
+      end
+    end
+
+    # Create a new Faraday connection
+    #
+    # @return [Faraday::Connection]
+    def connection
+      Faraday.new(url: @api_endpoint) do |faraday|
+        faraday.adapter :net_http
+      end
+    end
+
+    # Create a signature for request
+    def signature(params = '')
+      hash = OpenSSL::HMAC.digest('sha256', @api_key, params)
+      Base64.strict_encode64(hash)
+    end
+
+    def init_default_headers(request)
+      request.headers['client-type'] = @client_type_header
+      request.headers['Accept'] = 'application/json'
+      request.headers['Content-Type'] = 'application/json'
+      request.headers['api-auth-id'] = @api_id
+      request.headers['api-auth-signature'] = signature(request.params.to_query)
+    end
+
+    # Make a HTTP GET request
+    #
+    # @param url [String] The path, relative to {api_endpoint}
+    # @param parameters [Hash] Query params for request
+    # @return [Faraday::Response]
+    def get(url, parameters = {}, headers = {}, skip_status_check = false)
+      response = connection.get do |request|
+        request.url "#{api_endpoint}#{url}"
+        request.params = parameters
+
+        # Set headers
+        init_default_headers(request)
+
+        # Assign more custom headers
+        headers.each do |key, value|
+          request.headers[key] = value
+        end
+      end
+
+      on_complete(response) unless skip_status_check
+      response
+    end
+
+    # # Make a HTTP POST request
+    # #
+    # # @param url [String] The path, relative to {#api_endpoint}
+    # # @param parameters [Hash] Query params for request
+    # # @return [Faraday::Response]
+    # def post(url, parameters = {})
+    #   response = connection.post do |req|
+    #     req.url "#{api_endpoint}#{url}"
+    #     req.headers['Content-Type'] = 'application/json'
+    #     req.body = parameters.to_json
+    #   end
+    #   on_complete(response)
+    #   response
+    # end
+
+    # # Make a HTTP PATCH request
+    # #
+    # # @param url [String] The path, relative to {#api_endpoint}
+    # # @param parameters [Hash] Query params for request
+    # # @return [Faraday::Response]
+    # def patch(url, parameters = {})
+    #   response = connection.patch do |req|
+    #     req.url "#{api_endpoint}#{url}"
+    #     req.headers['Content-Type'] = 'application/json'
+    #     req.body = parameters.to_json
+    #   end
+    #   on_complete(response)
+    #   response
+    # end
+
+    # # Make a HTTP DELETE request
+    # #
+    # # @param url [String] The path, relative to {#api_endpoint}
+    # # @param parameters [Hash] Query params for request
+    # # @return [Faraday::Response]
+    # def delete(url, parameters = {})
+    #   response = connection.delete do |req|
+    #     req.url "#{api_endpoint}#{url}"
+    #     req.headers['Content-Type'] = 'application/json'
+    #     req.body = parameters.to_json
+    #   end
+    #   on_complete(response)
+    #   response
+    # end
+
+    # Show details of your Platform.
+    #
+    # @see https://reference.Unleashed.com/#show-marketplace
+    #
+    # @return [Hash]
+    def marketplace
+      JSON.parse(get('marketplace').body)['marketplaces']
+    end
+
+    # Available resources for {Client}
+    #
+    # @return [Hash]
+    def self.resources
+      {
+        customers: CustomerResource
+      }
+    end
+
+    # Catch calls for resources
+    #
+    def method_missing(name, *args, &block)
+      if self.class.resources.keys.include?(name)
+        resources[name] ||= self.class.resources[name].new(self)
+        resources[name]
+      else
+        super
+      end
+    end
+
+    # Resources being currently used
+    #
+    # @return [Hash]
+    def resources
+      @resources ||= {}
+    end
+
+    private
+
+    def on_complete(response)
+      fail Unleashed::Error.from_response(response, @errors_format) unless response.success?
+    end
+  end
+end

data/lib/unleashed/configurable.rb

@@ -0,0 +1,40 @@
+module Unleashed
+  # Configuration options for {Client}, defaulting to values in {Default}.
+  module Configurable
+    attr_accessor :api_domain, :api_id, :api_key, :client_type_header, :errors_format
+
+    class << self
+      # List of configurable keys for {Unleashed::Client}.
+      #
+      # @return [Array] of option keys
+      def keys
+        @keys ||= [
+          :api_domain,
+          :api_id,
+          :api_key,
+          :client_type_header,
+          :errors_format
+        ]
+      end
+    end
+
+    # Reset configuration options to default values.
+    def reset!
+      Unleashed::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Unleashed::Default.options[key])
+      end
+
+      self
+    end
+
+    alias setup reset!
+
+    # API endpoint to be used by {Unleashed::Client}.
+    # Built from {#api_domain}
+    #
+    # @return [String]
+    def api_endpoint
+      "https://#{@api_domain}/"
+    end
+  end
+end

data/lib/unleashed/default.rb

@@ -0,0 +1,53 @@
+module Unleashed
+  # Default configuration options for {Client}
+  module Default
+    # Default API domain
+    API_DOMAIN = 'api.unleashedsoftware.com'.freeze
+    # Default client_type_header
+    CLIENT_TYPE_HEADER = 'API-Sandbox'.freeze
+
+    class << self
+      # Configuration options.
+      #
+      # @return [Hash]
+      def options
+        Hash[Unleashed::Configurable.keys.map { |key| [key, send(key)] }]
+      end
+
+      # Default API domain from ENV or {API_DOMAIN}.
+      #
+      # @return [String]
+      def api_domain
+        ENV['UNLEASHED_API_DOMAIN'] || API_DOMAIN
+      end
+
+      # Default api_id from ENV.
+      #
+      # @return [String]
+      def api_id
+        ENV['UNLEASHED_API_ID']
+      end
+
+      # Default api_key from ENV.
+      #
+      # @return [String]
+      def api_key
+        ENV['UNLEASHED_API_KEY']
+      end
+
+      # Default client_type_header from ENV.
+      #
+      # @return [String]
+      def client_type_header
+        ENV['UNLEASHED_CLIENT_TYPE_HEADER'] || CLIENT_TYPE_HEADER
+      end
+
+      # Default errors_format from ENV.
+      #
+      # @return [String]
+      def errors_format
+        ENV['UNLEASHED_ERRORS_FORMAT'] || 'processed'
+      end
+    end
+  end
+end

data/lib/unleashed/error.rb

@@ -0,0 +1,97 @@
+module Unleashed
+  # Custom error class for rescuing from all Unleashed errors
+  class Error < StandardError
+    # Returns the appropriate Unleashed::Error subclass based on status
+    #
+    # @param [Faraday::Response] response Faraday HTTP response
+    # @return [Unleashed::Error]
+    def self.from_response(response, errors_format = nil)
+      klass = case response.status
+              when 400      then Unleashed::BadRequest
+              when 401      then Unleashed::Unauthorized
+              when 403      then Unleashed::Forbidden
+              when 404      then Unleashed::NotFound
+              when 405      then Unleashed::MethodNotAllowed
+              when 406      then Unleashed::NotAcceptable
+              when 409      then Unleashed::Conflict
+              when 422      then Unleashed::UnprocessableEntity
+              when 400..499 then Unleashed::ClientError
+              when 500      then Unleashed::InternalServerError
+              when 501      then Unleashed::NotImplemented
+              when 502      then Unleashed::BadGateway
+              when 503      then Unleashed::ServiceUnavailable
+              when 500..599 then Unleashed::ServerError
+              end
+      klass ? klass.new(response, errors_format) : new(response, errors_format)
+    end
+
+    def initialize(response = nil, errors_format = nil)
+      @response = response
+      @errors_format = errors_format
+      super(build_error_message)
+    end
+
+    private
+
+    def build_error_message
+      return nil if @response.nil? || @response.body.nil?
+
+      case @errors_format
+      when 'raw'
+        @response.body
+      else
+        json_response = JSON.parse(@response.body)
+        message = ''
+        message << json_response['message'] if json_response.key?('message')
+
+        if json_response.key?('errors')
+          message << json_response['errors'].map { |attribute, content| "#{attribute}: #{content}" }.join(', ')
+        end
+
+        message
+      end
+    end
+  end
+
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
+  # Raised when Unleashed returns a 400 HTTP status code
+  class BadRequest < ClientError; end
+
+  # Raised when Unleashed returns a 401 HTTP status code
+  class Unauthorized < ClientError; end
+
+  # Raised when Unleashed returns a 403 HTTP status code
+  class Forbidden < ClientError; end
+
+  # Raised when Unleashed returns a 404 HTTP status code
+  class NotFound < ClientError; end
+
+  # Raised when Unleashed returns a 405 HTTP status code
+  class MethodNotAllowed < ClientError; end
+
+  # Raised when Unleashed returns a 406 HTTP status code
+  class NotAcceptable < ClientError; end
+
+  # Raised when Unleashed returns a 409 HTTP status code
+  class Conflict < ClientError; end
+
+  # Raised when Unleashed returns a 422 HTTP status code
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
+
+  # Raised when Unleashed returns a 500 HTTP status code
+  class InternalServerError < ServerError; end
+
+  # Raised when Unleashed returns a 501 HTTP status code
+  class NotImplemented < ServerError; end
+
+  # Raised when Unleashed returns a 502 HTTP status code
+  class BadGateway < ServerError; end
+
+  # Raised when Unleashed returns a 503 HTTP status code
+  class ServiceUnavailable < ServerError; end
+end

data/lib/unleashed/models/base_model.rb

@@ -0,0 +1,23 @@
+module Unleashed
+  # Base model for all the other models to inherit from
+  class BaseModel
+    def initialize(client, attributes = {})
+      @client = client
+      @attributes = stringify_keys(attributes)
+    end
+
+    def method_missing(name, *args, &block)
+      if @attributes.key?(name.to_s)
+        @attributes[name.to_s]
+      else
+        super
+      end
+    end
+
+    private
+
+    def stringify_keys(hash)
+      Hash[hash.map { |key, value| [key.to_s, value] }]
+    end
+  end
+end

data/lib/unleashed/models/customer.rb

@@ -0,0 +1,6 @@
+
+module Unleashed
+  # Manage Customers
+  class Customer < BaseModel
+  end
+end

data/lib/unleashed/resources/base_resource.rb

@@ -0,0 +1,20 @@
+module Unleashed
+  # Base resource for all the other resources to inherit from
+  class BaseResource
+    def initialize(client)
+      @client = client
+    end
+
+    def method_missing(name, *args, &block)
+      if instance_methods.include?(model) && respond_to?(name)
+        model.new(@client, id: args[0]).send(name, *args[1..-1])
+      else
+        super
+      end
+    end
+
+    def respond_to?(name, include_all = false)
+      super || model.new(@client).respond_to?(name, include_all)
+    end
+  end
+end

data/lib/unleashed/resources/customer_resource.rb

@@ -0,0 +1,38 @@
+module Unleashed
+  # Resource for the Customers API
+  # The Customers resource allows Customers to be listed, viewed, created, and updated.
+  # An individual Customer's details can be viewed, or updated by appending its identifier
+  # (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX) to the URI
+  #
+  # @see https://apidocs.unleashedsoftware.com/Customers
+  class CustomerResource < BaseResource
+    def model
+      Unleashed::Customer
+    end
+
+    # List all customers
+    # /Customers - also returns the first 200 customers because page number 1 is the default.
+    #
+    # @param options [Hash] Optional options.
+    # @option options [Integer] :page_size Can ask for up to 200 customers. default: 10
+    # @option options [Integer] :page Page index. default: 1
+    #
+    # @return [Array<Unleashed::Customer>] List all customers.
+    def all(options = { page: 1, page_size: 10 })
+      response = JSON.parse(@client.get('Customers', options).body)
+      customers = response.key?('Items') ? response['Items'] : []
+      customers.map { |attributes| Unleashed::Customer.new(@client, attributes) }
+    end
+
+    # Get a single customer
+    # /Customers/E6E8163F-6911-40e9-B740-90E5A0A3A996 - returns details of a particular customer.
+    #
+    # @param id [String] customer ID.
+    #
+    # @return [Unleashed::Customer]
+    def find(id)
+      response = JSON.parse(@client.get("Customers/#{id}").body)
+      Unleashed::Customer.new(@client, response)
+    end
+  end
+end

data/lib/unleashed/version.rb

@@ -2,7 +2,7 @@ module Unleashed
   module Version
     MAJOR = 0
     MINOR = 1
-    TINY = 3
+    TINY = 4
 
     STRING = "#{MAJOR}.#{MINOR}.#{TINY}".freeze
   end

data/lib/unleashed.rb

@@ -1,5 +1,12 @@
-require 'unleashed/version'
+require_relative 'unleashed/client'
+require_relative 'unleashed/default'
+require_relative 'unleashed/error'
+require_relative 'unleashed/version'
 
 module Unleashed
-  # Your code goes here...
+  class << self
+    include Unleashed::Configurable
+  end
 end
+
+Unleashed.setup

data/unleashed.gemspec

@@ -40,6 +40,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'json'
   spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.1'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: unleashed
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -69,6 +97,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -78,6 +107,14 @@ files:
 - bin/console
 - bin/setup
 - lib/unleashed.rb
+- lib/unleashed/client.rb
+- lib/unleashed/configurable.rb
+- lib/unleashed/default.rb
+- lib/unleashed/error.rb
+- lib/unleashed/models/base_model.rb
+- lib/unleashed/models/customer.rb
+- lib/unleashed/resources/base_resource.rb
+- lib/unleashed/resources/customer_resource.rb
 - lib/unleashed/version.rb
 - unleashed.gemspec
 homepage: https://github.com/nnhansg/unleashed-ruby