wotc 0.1.0 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c55912e173441fafde565727cfea98101a699ee28b0f3b949a9949f7730cab2b
-  data.tar.gz: 69abcb3adee7d97d0832c4a4b6b26d5d316b1940f4bd26bb8b4bfe87c8761664
+  metadata.gz: cac8eac181af5b251e56003ba42aacd6e7f8ca376f48178325c0f4349f28a788
+  data.tar.gz: c51990906c2d06401afe3a2733433a4e84b7715f3b19c330916f42ef64cb2218
 SHA512:
-  metadata.gz: a72f369eb59c4deeeecaf6b6cc5a69cb2420d685745a8edf2a7e2dd38c1710d29b219754c329c445585d4d93052cd5fc4bf530a9ee06060a6a7302e729fd86db
-  data.tar.gz: a428af1f1dd944dbe1509b86e19c45dd51a0439131e02f13bb8184ca8078884935e2ede71956a26379ca4297183d7cada0a72efe205cf7347e7558233b87fc41
+  metadata.gz: f72eb6b6da6b24702f0916776944d4a51977ae11e95ceafade99f9f4a05cb446d3ec4277fad045b0e60374874f06470a26c750edef707d560f7e49d9a14f41fb
+  data.tar.gz: 8d30545f71f13374dcde47fe733815baf9324371418f245550b02be3ec9c883a0c1379de899ab679627b2b0525f42f8aa802e447f7481ffe6724f1ec6736e331

data/.travis.yml

@@ -4,4 +4,4 @@ language: ruby
 cache: bundler
 rvm:
   - 2.5.3
-before_install: gem install bundler -v 1.17.3
+before_install: gem install bundler

data/README.md

@@ -1,8 +1,10 @@
 ![WOTC_logo_header-02](https://user-images.githubusercontent.com/1224077/79107910-d97bc880-7da7-11ea-95a3-40be03be614c.png)
 
+
 # wotc-ruby-gem
 
-Ruby toolkit for wotc.com API
+Ruby toolkit for wotc.com API [![Build Status](https://secure.travis-ci.org/helloworld1812/wotc-ruby-gem.svg)](http://travis-ci.org/helloworld1812/wotc-ruby-gem)
+
 
 ## wotc.com REST APIs and documentation
 

data/Rakefile

@@ -1,10 +1,13 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+require 'rspec/core/rake_task'
+desc 'Run the specs'
+RSpec::Core::RakeTask.new do |r|
+  r.verbose = false
 end
 
-task :default => :test
+task :test => :spec
+
+# Add rubycop
+task :default => [:spec]

data/lib/faraday/raise_http_exception.rb

@@ -10,25 +10,21 @@ module FaradayMiddleWare
       @app.call(env).on_complete do |response|
         case response.status.to_i
         when 400
-          raise WOTC::BadRequest, error_message(env)
+          raise WOTC::BadRequest.new(response)
+        when 401
+          raise WOTC::Unauthorized.new(response)
         when 404
-          raise WOTC::NotFound, error_message(env)
+          raise WOTC::NotFound.new(response)
         when 500
-          raise WOTC::InternalServerError, error_message(env)
+          raise WOTC::InternalServerError.new(response)
         when 502
-          raise WOTC::BadGateway, error_message(env)
+          raise WOTC::BadGateway.new(response)
         when 503
-          raise WOTC::ServiceUnavailable, error_message(env)
+          raise WOTC::ServiceUnavailable.new(response)
         when 504
-          raise WOTC::GatewayTimeout, error_message(env)
+          raise WOTC::GatewayTimeout.new(response)
         end
       end
     end
-
-    private
-
-    def error_message(env)
-      "\nURL: #{env.url}\nmethod: #{env.method} \nstatus: #{env.status}\nerrors: #{env.response.body}"
-    end
   end
 end

data/lib/wotc/client/companies.rb

@@ -20,6 +20,12 @@ module WOTC
           put("company/settings?company_id=#{company_id}", options)
         end
       end
+
+      # Get the info of company
+      def current_company
+        result = get('user').body
+        result["company"] 
+      end
     end
   end
 end

data/lib/wotc/client/employees.rb

@@ -33,8 +33,15 @@ module WOTC
       end
 
       # Generate an auto fill WOTC url
-      def employee_auto_fill_wotc_url(employee_id)
-        get("employees/#{employee_id}/wotc/url")
+      def employee_auto_fill_wotc_url(employee_id, redirect=nil)
+        uri = URI.parse(redirect) rescue false
+        result = if uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
+          get("employees/#{employee_id}/wotc/url?redirect=#{redirect}")
+        else
+          get("employees/#{employee_id}/wotc/url")
+        end
+
+        return result.body["url"]
       end
 
       # Get employees with certified WOTC status

data/lib/wotc/client/registers.rb

@@ -3,8 +3,14 @@ module WOTC
     module Registers
 
       # Register for an account and get back a life time access token.
-      def register(options)
-        post("register", options)
+      def register(options = {})
+        response = post("register", options)
+        if response.body.is_a?(Hash) && response.body["token"]
+          return response
+        else
+          # raise error when token is missing.
+          raise WOTC::BadRequest.new(response)
+        end
       end
     end
   end

data/lib/wotc/client/utils.rb

@@ -0,0 +1,21 @@
+module WOTC
+  class Client
+    # Defines methods related to utils
+    module Utils
+
+      # Trigger an api call to verify access_token is valid.
+      def token_valid?
+        user = get('user').body
+        return true if user&.fetch("id")
+      rescue => e
+        return false
+      end
+      
+      # Pre-qualify an application of WOTC status
+      def wotc_calculator(options={})
+        result = post('wotc/calculator', options)
+        result.body == true
+      end
+    end
+  end
+end

data/lib/wotc/client.rb

@@ -16,5 +16,6 @@ module WOTC
     include WOTC::Client::Users
     include WOTC::Client::Registers
     include WOTC::Client::Wotcs
+    include WOTC::Client::Utils
   end
 end

data/lib/wotc/configuration.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require File.expand_path('../version', __FILE__)
 
 module WOTC
 # Defines constants and methods related to configuration
@@ -8,12 +9,15 @@ module WOTC
       :access_token,
       :adapter,
       :connection_options,
+      :host,
       :endpoint,
       :format,
       :proxy,
       :user_agent,
       :auto_paginate,
       :per_page,
+      :timeout,
+      :open_timeout,
     ].freeze
 
     # By default, don't set an access token
@@ -30,12 +34,19 @@ module WOTC
     # @note The default faraday adapter is Net::HTTP.
     DEFAULT_ADAPTER = Faraday.default_adapter
 
-    # By default, don't set any connection options
+    # By default, don't set connection options.
     DEFAULT_CONNECTION_OPTIONS = {}
 
+    # Default timeout time is 20 seconds
+    DEFAULT_TIMEOUT = 20
+
+    # By default, the open timeout is 20 seconds.
+    DEFAULT_OPEN_TIMEOUT = 20
+
+    # By default, use sandbox environment 
+    DEFAULT_HOST = 'https://sandbox.wotc.com'.freeze
+
     # The endpoint that will be used to connect if none is set
-    #
-    # @note There is no reason to use any other endpoint at this time
     DEFAULT_ENDPOINT = 'https://sandbox.wotc.com/portal/api/v1/'.freeze
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
@@ -77,12 +88,15 @@ module WOTC
       self.access_token       = DEFAULT_ACCESS_TOKEN
       self.adapter            = DEFAULT_ADAPTER
       self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.host               = DEFAULT_HOST
       self.endpoint           = DEFAULT_ENDPOINT
       self.format             = DEFAULT_FORMAT
       self.proxy              = DEFAULT_PROXY
       self.user_agent         = DEFAULT_USER_AGENT
       self.auto_paginate      = DEFAULT_AUTO_PAGINATE
       self.per_page           = DEFAULT_PER_PAGE
+      self.timeout            = DEFAULT_TIMEOUT
+      self.open_timeout       = DEFAULT_OPEN_TIMEOUT
     end
   end
 end

data/lib/wotc/connection.rb

@@ -18,6 +18,9 @@ module WOTC
 
       Faraday::Connection.new(options) do |conn|
         conn.authorization :Bearer, access_token
+        # https://github.com/lostisland/faraday/issues/417#issuecomment-223413386
+        conn.options[:timeout] = timeout 
+        conn.options[:open_timeout] = open_timeout 
         conn.request :json
 
         conn.use FaradayMiddleWare::RaiseHttpException

data/lib/wotc/error.rb

@@ -1,10 +1,49 @@
 module WOTC
   # Custom error class for rescuing from all wotc.com errors
-  class Error < StandardError; end
+  class Error < StandardError
+    attr_reader :http_method, :url, :errors
+
+    def initialize(response)
+      super
+      @response = response.dup
+      @http_method = response.method.to_s
+      @url = response.url
+      if response.body.is_a?(Hash) && !response.body.empty? && !response.body.fetch("errors", nil).nil?
+        @raw_errors = response.body.fetch("errors")
+      end
+    end
+
+    def message
+      <<-HEREDOC
+      URL: #{@response.url}
+      method: #{@response.method}
+      response status: #{@response.status}
+      response body: #{@response.response.body}
+      HEREDOC
+    end
+
+    def raw_errors
+      @raw_errors
+    end
+
+    def error_sentence
+      return if @raw_errors.nil?
+
+      array = []
+      @raw_errors.each do |_, v| 
+        array += v
+      end
+
+      array.join(' ')
+    end
+  end
 
   # Raised when wotc.com returns the HTTP status code 400
   class BadRequest < Error; end
 
+  # Raised when wotc.com returns the HTTP status code 401
+  class Unauthorized < Error; end
+
   # Raised when wotc.com returns the HTTP status code 404
   class NotFound < Error; end
 

data/lib/wotc/request.rb

@@ -38,10 +38,10 @@ module WOTC
 
       # return all results when enabled auto paginate
       last_response = response.dup
-      data = response["data"]
-      while last_response["next_page_url"]
-        last_response = get(last_response["next_page_url"] + "&per_page=#{per_page}")
-        data.concat(last_response["data"]) if last_response["data"].is_a?(Array)
+      data = response.body["data"]
+      while last_response.body["next_page_url"]
+        last_response = get(last_response.body["next_page_url"])
+        data.concat(last_response.body["data"]) if last_response.body["data"].is_a?(Array)
       end
 
       return data
@@ -51,14 +51,14 @@ module WOTC
       response = connection.send(method) do |request|
         case method
         when :get, :delete
-          request.url(URI.encode(path), options)
+          request.url(Addressable::URI.escape(path), options)
         when :post, :put
-          request.path = URI.encode(path)
+          request.path = Addressable::URI.escape(path)
           request.body = options
         end
       end
 
-      return response.body
+      response
     end
   end
-end
+end

data/lib/wotc/version.rb

@@ -1,3 +1,3 @@
 module WOTC
-  VERSION = "0.1.0"
+  VERSION = '0.1.10'
 end

data/wotc.gemspec

@@ -35,11 +35,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.9.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "webmock"
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'faraday_middleware'
+  spec.add_runtime_dependency 'addressable'
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: wotc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.10
 platform: ruby
 authors:
 - workstream.us
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-13 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.9.0
 - !ruby/object:Gem::Dependency
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
 description: An Ruby wrapper for wotc.com REST APIs
 email:
 - ryan@workstream.is
@@ -138,6 +152,7 @@ files:
 - lib/wotc/client/payrolls.rb
 - lib/wotc/client/registers.rb
 - lib/wotc/client/users.rb
+- lib/wotc/client/utils.rb
 - lib/wotc/client/webhooks.rb
 - lib/wotc/client/wotcs.rb
 - lib/wotc/configuration.rb
@@ -168,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for wotc.com APIs