fasttrack-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e550af164fd3e9964567dd95ec3bd9d59873d186
+  data.tar.gz: 4907511370c8d19c267e8692e6e63131b8a3a874
+SHA512:
+  metadata.gz: bdcb822a31096835b9e1b3e228ed6f7860959e98af5c0eaaaf4d90aad1b19466d05cf03e813bfae5e1fdc6cbc93f538c8132382c544ab6890ad1f87f600d6f3e
+  data.tar.gz: b064380567856d7eb4f48feb29e7a57f0b1f19140e9a8a46d4824dc6d5d95b0598693c7bc815a2dcc7e52e7f8f0ad5ce372e91ed48a118e34eac426bcfd8c063

data/lib/common.rb

@@ -0,0 +1,39 @@
+require_relative './exceptions'
+
+ERRORS_BY_STATUS = {
+  '400' => FastTrack::BadRequestException,
+  '401' => FastTrack::UnauthorizedException,
+  '404' => FastTrack::NotFoundException,
+  '405' => FastTrack::MethodNotAllowedException,
+  '406' => FastTrack::NotAcceptableException,
+  '429' => FastTrack::TooManyRequestsException
+}
+
+ERRORS_BY_ERROR_CODE = {
+  '1' => FastTrack::VersionRequiredException,
+  '2' => FastTrack::NoResultException,
+  '3' => FastTrack::BadParametersException,
+  '4' => FastTrack::InvalidVersionException
+}
+
+def exceptionForResponse(status, errorCode)
+  fastTrackError = nil
+
+  if errorCode != nil
+    fastTrackError = ERRORS_BY_ERROR_CODE[errorCode]
+  end
+
+  if fastTrackError == nil && status != nil
+    fastTrackError = ERRORS_BY_STATUS[status.to_s]
+
+    if status >= 500 && status < 600
+      fastTrackError = FastTrack::InternalServerException
+    end
+  end
+
+  if fastTrackError == nil
+    fastTrackError = Exception
+  end
+
+  return fastTrackError
+end

data/lib/constants.rb

@@ -0,0 +1,8 @@
+ACCEPT  = 'application/vnd.fasttrack+json';
+URL     = 'https://api.fasttrack-intl.com';
+VERSION = 1;
+
+PATHNAME_COMPANY = '/company';
+PATHNAME_CONTACT = '/contact';
+
+TIMEOUT = 5000;

data/lib/exceptions.rb

@@ -0,0 +1,46 @@
+
+module FastTrack
+  # Bad parameters
+  class BadParametersException < Exception
+  end
+
+  # Bad request
+  class  BadRequestException < Exception
+  end
+
+  # Internal server error
+  class InternalServerException < Exception
+  end
+
+  # Invalid version
+  class InvalidVersionException < Exception
+  end
+
+  # Method not allowed
+  class MethodNotAllowedException < Exception
+  end
+
+  # No result
+  class NoResultException < Exception
+  end
+
+  # Not acceptable
+  class NotAcceptableException < Exception
+  end
+
+  # Not found
+  class NotFoundException < Exception
+  end
+
+  # Too many requests
+  class TooManyRequestsException < Exception
+  end
+
+  # Unauthorized
+  class UnauthorizedException < Exception
+  end
+
+  # Version required
+  class VersionRequiredException < Exception
+  end
+end

data/lib/fasttrack.rb

@@ -0,0 +1,57 @@
+require 'JSON'
+require 'rest-client'
+
+require_relative './common'
+require_relative './constants'
+
+module FastTrack
+  class Client
+    def initialize(token, opts = {})
+      @token = token
+      @opts = opts
+    end
+
+    # Request to the API endpoint
+    def get(path, params)
+      begin
+        headers = {
+          'Authorization' => 'Token ' + @token,
+          'Accept'        => ACCEPT + '; version = ' + VERSION.to_s,
+          'params'        => params
+        };
+
+        url = 'https://api.fasttrack-intl.com' + path
+
+        response = RestClient.get(url, headers)
+
+        return JSON.parse(response.body)
+      rescue RestClient::ExceptionWithResponse => e
+        body = nil;
+        response = e.response
+
+        begin
+          body = JSON.parse(response.body)
+        rescue
+          body = {}
+        end
+
+        exception = exceptionForResponse(response.code, body['error_code'])
+        raise exception, body['detail']
+      end
+    end
+
+    # Retrieve company details with a `domain`
+    def getCompany(domain)
+      return self.get PATHNAME_COMPANY, {
+        'domain' => domain
+      }
+    end
+
+    # Retrieve contact details with an `email`
+    def getContact(email)
+      return self.get PATHNAME_CONTACT, {
+        'email' => email
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: fasttrack-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fast Track
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This Fasttrack library enables you to request the Fasttrack API in a
+  convenient way. For more information about the Fasttrack API please see https://api.fasttrack-intl.com
+email: info@fasttrack-intl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/common.rb
+- lib/constants.rb
+- lib/exceptions.rb
+- lib/fasttrack.rb
+homepage: https://github.com/fasttrack/fasttrack-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Fast Track client
+test_files: []