truework 0.0.1

data/lib/truework/exceptions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Truework
+  class ClientException < StandardError; end
+  class NonExistentRecord < ClientException; end
+  class RecordAlreadyExists < ClientException; end
+  class InvalidCredentials < ClientException; end
+  class BadRequest < ClientException; end
+  class Forbidden < ClientException; end
+  class UnexpectedHTTPException < ClientException; end
+
+  class ServerException < StandardError; end
+  class InternalServerError < ServerException; end
+  class BadGateway < ServerException; end
+  class ServiceUnavailable < ServerException; end
+  class GatewayTimeout < ServerException; end
+end

data/lib/truework/http_request.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'net/https'
+require 'uri'
+require 'json'
+require 'openssl'
+
+require 'truework/exceptions'
+
+module Truework
+  module HTTPRequest
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    def request(method, path, params = {})
+      uri = URI.parse("#{Truework.api_base}#{path}")
+
+      request = build_request(method, uri, params)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == 'https'
+        http.use_ssl = true
+        http.ca_file = Truework::DEFAULT_CA_BUNDLE_PATH
+      end
+
+      response = http.request(request)
+      handle_errors(response)
+      response
+    end
+
+    private
+
+    def handle_errors(response)
+      case response
+      when Net::HTTPSuccess
+        response
+      else
+        EXCEPTION_MAP.each do |response_class, exception_class|
+          raise exception_class, error_message_from_response(response) if response.is_a?(response_class)
+        end
+
+        raise Truework::UnexpectedHTTPException, "#{response.code} #{response.body}"
+      end
+    end
+
+    EXCEPTION_MAP = {
+      Net::HTTPUnauthorized => Truework::InvalidCredentials,
+      Net::HTTPNotFound => Truework::NonExistentRecord,
+      Net::HTTPConflict => Truework::RecordAlreadyExists,
+      Net::HTTPBadRequest => Truework::BadRequest,
+      Net::HTTPForbidden => Truework::Forbidden,
+      Net::HTTPInternalServerError => Truework::InternalServerError,
+      Net::HTTPBadGateway => Truework::BadGateway,
+      Net::HTTPServiceUnavailable => Truework::ServiceUnavailable,
+      Net::HTTPGatewayTimeOut => Truework::GatewayTimeout
+    }.freeze
+
+    def error_message_from_response(response)
+      body = response.body
+      json = JSON.parse(body) if body && body.strip != ''
+      return json['error'] if json&.key?('error')
+
+      body
+    rescue JSON::ParserError
+      body
+    end
+
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+    def build_request(method, uri, params)
+      klass = case method
+              when :get
+                Net::HTTP::Get
+              when :post
+                Net::HTTP::Post
+              when :put
+                Net::HTTP::Put
+              when :delete
+                Net::HTTP::Delete
+              end
+
+      case method
+      when :get, :delete
+        uri.query = URI.encode_www_form(params) if params && !params.empty?
+        req = klass.new(uri.request_uri)
+      when :post, :put
+        req = klass.new(uri.request_uri)
+        req.body = JSON.generate(params) unless params.empty?
+      end
+
+      req['Content-Type'] = 'application/json'
+      req['Accept'] = "application/json#{"; version=#{Truework.api_version}" if Truework.api_version}"
+      req['User-Agent'] = "Truework Ruby SDK #{Truework::VERSION};"\
+                          "#{RUBY_PLATFORM};#{RUBY_ENGINE};#{RUBY_VERSION} p#{RUBY_PATCHLEVEL}"
+      req['Authorization'] = "Bearer #{Truework.api_key}"
+
+      req
+    end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+  end
+end

data/lib/truework/list_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'truework/api_response'
+
+module Truework
+  class ListResponse < APIResponse
+    attr_reader :data
+
+    def initialize(url, status_code, http_body: '', api_version: nil, klass: Truework::APIResource)
+      super
+      results = json && json[:results]
+      @data = klass.convert_to_truework_object(results) if results
+    end
+
+    def self.from_response(response, klass: Truework::APIResource)
+      new(
+        response.uri,
+        response.code.to_i,
+        http_body: response.body,
+        api_version: extract_version(response),
+        klass: klass
+      )
+    end
+
+    def num_results
+      json && json[:count]
+    end
+
+    def next_url
+      json && json[:next]
+    end
+  end
+end

data/lib/truework/resources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'truework/resources/address'
+require 'truework/resources/company'
+require 'truework/resources/document'
+require 'truework/resources/earnings'
+require 'truework/resources/employee'
+require 'truework/resources/employer'
+require 'truework/resources/position'
+require 'truework/resources/price'
+require 'truework/resources/report'
+require 'truework/resources/salary'
+require 'truework/resources/target'
+require 'truework/resources/turnaround_time'
+require 'truework/resources/verification_request'

data/lib/truework/resources/address.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Truework
+  class Address < APIResource
+    attribute? :line_one, Types::String
+    attribute? :line_two, Types::String
+    attribute? :city, Types::String
+    attribute? :state, Types::String
+    attribute? :country, Types::String
+    attribute? :postal_code, Types::String
+  end
+end

data/lib/truework/resources/company.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Truework
+  class Company < APIResource
+    extend APIOperations::List
+
+    attribute :name, Types::String
+    attribute? :id, Types::Integer
+    attribute? :domain, Types::String
+
+    def self.resource_path
+      '/companies/'
+    end
+  end
+end

data/lib/truework/resources/document.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Truework
+  class Document < APIResource
+    attribute :filename, Types::String
+  end
+end

data/lib/truework/resources/earnings.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Truework
+  class Earnings < APIResource
+    attribute :year, Types::Integer
+    attribute :base, Types::JSON::Decimal
+    attribute :overtime, Types::JSON::Decimal
+    attribute :commission, Types::JSON::Decimal
+    attribute :bonus, Types::JSON::Decimal
+    attribute :total, Types::JSON::Decimal
+  end
+end

data/lib/truework/resources/employee.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'truework/resources/earnings'
+require 'truework/resources/position'
+require 'truework/resources/salary'
+
+module Truework
+  class Employee < APIResource
+    attribute :first_name, Types::String
+    attribute :last_name, Types::String
+    attribute :status, Types::String
+    attribute? :hired_date, Types::JSON::Date
+    attribute? :end_of_employment, Types::JSON::Date
+    attribute? :earnings, Types::Array.of(Earnings)
+    attribute? :positions, Types::Array.of(Position)
+    attribute? :salary, Salary
+  end
+end

data/lib/truework/resources/employer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'truework/resources/address'
+
+module Truework
+  class Employer < APIResource
+    attribute :name, Types::String
+    attribute? :address, Truework::Address
+  end
+end

data/lib/truework/resources/position.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Truework
+  class Position < APIResource
+    attribute :title, Types::String
+    attribute :start_date, Types::JSON::Date
+    attribute? :end_date, Types::JSON::Date
+  end
+end

data/lib/truework/resources/price.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Truework
+  class Price < APIResource
+    attribute :amount, Types::JSON::Decimal
+    attribute :currency, Types::String
+  end
+end

data/lib/truework/resources/report.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'truework/resources/employee'
+require 'truework/resources/employer'
+require 'truework/resources/verification_request'
+
+module Truework
+  class Report < APIResource
+    extend APIOperations::Retrieve
+
+    attribute :created, Types::JSON::DateTime
+    attribute :current_as_of, Types::JSON::DateTime
+    attribute :verification_request, VerificationRequest
+    attribute :employer, Employer
+    attribute :employee, Employee
+
+    def self.instance_url(verification_request_id)
+      "/verification-requests/#{verification_request_id}/report/"
+    end
+  end
+end

data/lib/truework/resources/salary.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Truework
+  class Salary < APIResource
+    attribute :gross_pay, Types::JSON::Decimal
+    attribute? :pay_frequency, Types::String
+    attribute? :hours_per_week, Types::Coercible::Integer
+  end
+end

data/lib/truework/resources/target.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Truework
+  class Target < APIResource
+    attribute :company, Company
+    attribute :first_name, Types::String
+    attribute :last_name, Types::String
+    attribute :contact_email, Types::String
+  end
+end

data/lib/truework/resources/turnaround_time.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Truework
+  class TurnaroundTime < APIResource
+    attribute? :upper_bound, Types::Params::Integer
+    attribute? :lower_bound, Types::Params::Integer
+  end
+end

data/lib/truework/resources/verification_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'truework/resources/document'
+require 'truework/resources/target'
+require 'truework/resources/turnaround_time'
+
+module Truework
+  class VerificationRequest < APIResource
+    extend APIOperations::Create
+    extend APIOperations::List
+    extend APIOperations::Retrieve
+
+    attribute :id, Types::String
+    attribute? :type, Types::String
+    attribute :created, Types::Params::DateTime
+    attribute? :state, Types::String
+    attribute? :price, Price
+    attribute? :turnaround_time, TurnaroundTime
+    attribute? :permissible_purpose, Types::String
+    attribute? :target, Target
+    attribute? :documents, Types::Array.of(Document)
+
+    def self.resource_path
+      '/verification-requests/'
+    end
+  end
+end

data/lib/truework/types.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Truework
+  module Types
+    include Dry.Types()
+  end
+end

data/lib/truework/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Truework
+  VERSION = '0.0.1'
+end

data/truework.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'truework/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'truework'
+  spec.version       = Truework::VERSION
+  spec.required_ruby_version = '>= 2.4'
+  spec.authors       = ['Truework']
+  spec.email         = ['ruby-sdk@truework.com']
+
+  spec.summary       = 'Ruby bindings for the Truework API.'
+  spec.homepage      = 'https://www.github.com/truework/truework-ruby-sdk'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'dry-struct', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: truework
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Truework
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.79'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: 
+email:
+- ruby-sdk@truework.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/truework.rb
+- lib/truework/api_operations/create.rb
+- lib/truework/api_operations/list.rb
+- lib/truework/api_operations/retrieve.rb
+- lib/truework/api_resource.rb
+- lib/truework/api_response.rb
+- lib/truework/data/ca-certificates.crt
+- lib/truework/exceptions.rb
+- lib/truework/http_request.rb
+- lib/truework/list_response.rb
+- lib/truework/resources.rb
+- lib/truework/resources/address.rb
+- lib/truework/resources/company.rb
+- lib/truework/resources/document.rb
+- lib/truework/resources/earnings.rb
+- lib/truework/resources/employee.rb
+- lib/truework/resources/employer.rb
+- lib/truework/resources/position.rb
+- lib/truework/resources/price.rb
+- lib/truework/resources/report.rb
+- lib/truework/resources/salary.rb
+- lib/truework/resources/target.rb
+- lib/truework/resources/turnaround_time.rb
+- lib/truework/resources/verification_request.rb
+- lib/truework/types.rb
+- lib/truework/version.rb
+- truework.gemspec
+homepage: https://www.github.com/truework/truework-ruby-sdk
+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.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Truework API.
+test_files: []