agendrix-nethris 0.1.24

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5075e1abf276e20515d677fe5af327a749797126006faf1bba2b72ec5c4b59a0
+  data.tar.gz: cae6fd79334a3da19693a1deb173aaaa585506e5fa626f77eeaf68b429206cb3
+SHA512:
+  metadata.gz: 189ee43aff5a8ebca5e874cf984d4aadac51fc5888c54053fcbcbc5b6d24d1f0af9a2eb6bbcb49c87ab1a07b500dd4d77570f69c946a457d8470b83ccbd918c4
+  data.tar.gz: 404928eba5b40ec171845043f3221c2398417d4d439ddf35fa169c6ba8167a2723bb08e0f74b529d89de3ce1c11fbbcd0fd61ab26925a219ebc4b0a051f71bee

data/README.md

@@ -0,0 +1,33 @@
+# Agendrix::Nethris
+
+To experiment with that code, run `bin/test`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'agendrix-nethris'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install agendrix-nethris
+
+## Usage
+
+This gem is used to get Nethris employee data. You can get `empl_id`, `empl_number`, `first_name`, `last_name`, `date_of_birth`, `email_work`,`address_street`, `phone_type`, `area_code`, `phone_number`, `ext_number`, `empl_disp_status`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/charlesvallieres/agendrix-nethris.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "agendrix/nethris"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "dotenv"
+Dotenv.load
+
+require "agendrix/nethris"
+
+Agendrix::Nethris.app_id = ENV["NETHRIS_APP_ID"]
+Agendrix::Nethris.demo = true
+
+nethris = Agendrix::Nethris::Client.new(
+  vendor: Agendrix::Nethris::Client::Vendor::NETHRIS,
+  user_code: ENV["NETHRIS_USER_CODE"],
+  password: ENV["NETHRIS_USER_PASSWORD"],
+  business_code: ENV["NETHRIS_DEMO_BUSINESS_CODE"]
+)
+
+puts "---ALL---"
+nethris.employees.all(fields: ["EMPL_ID"]).each do |employee|
+  # employee = nethris.employees.get(employee.empl_id)
+  puts employee.inspect
+end
+
+puts "---GET---"
+employee = nethris.employees.get("zfAvL3OsQos=") # Anne Verveine
+puts employee.inspect
+puts employee.full_name
+
+puts "---LOG_OUT---"
+nethris.session.log_out
+puts "SUCCESS"

data/lib/agendrix/nethris.rb

@@ -0,0 +1,20 @@
+require "active_support/all"
+
+require "agendrix/nethris/version"
+require "agendrix/nethris/client"
+require "agendrix/nethris/errors"
+require "agendrix/nethris/request"
+require "agendrix/nethris/entity"
+require "agendrix/nethris/entities/employee"
+require "agendrix/nethris/entities/phone_number"
+require "agendrix/nethris/entities/address"
+require "agendrix/nethris/collection_proxy"
+require "agendrix/nethris/services/session_service"
+require "agendrix/nethris/services/employee_service"
+
+module Agendrix
+  module Nethris
+    mattr_accessor(:app_id)
+    mattr_accessor(:demo)
+  end
+end

data/lib/agendrix/nethris/client.rb

@@ -0,0 +1,38 @@
+module Agendrix
+  module Nethris
+    class Client
+      module Vendor
+        NETHRIS = :nethris
+        EMPLOYER_D = :employer_d
+      end
+
+      attr_reader(
+        :vendor,
+        :session
+      )
+
+      def initialize(vendor:, session_id: nil, user_code: nil, password: nil, business_code: nil)
+        unless vendor.in?([Vendor::NETHRIS, Vendor::EMPLOYER_D])
+          raise TypeError, "Vendor must be one of :#{Vendor::NETHRIS} or :#{Vendor::EMPLOYER_D}"
+        end
+
+        @vendor = vendor
+        @session = Services::SessionService.new(
+          vendor: @vendor,
+          id: session_id,
+          business_code: business_code,
+          user_code: user_code,
+          password: password
+        )
+      end
+
+      def employees
+        @employees ||= Services::EmployeeService.new(self)
+      end
+
+      def send_request(**args)
+        Request.new(@vendor, @session.id).execute(**args)
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/collection_proxy.rb

@@ -0,0 +1,58 @@
+module Agendrix
+  module Nethris
+    class CollectionProxy
+      include Enumerable
+
+      def initialize(client, entity_class, options = {})
+        @client = client
+        @entity_class = entity_class
+        @options = options
+      end
+
+      def each(&block)
+        has_next_page = false
+        current_page = 0
+
+        loop do
+          current_page += 1
+          body = fetch(page: current_page)
+
+          current_page = body["CurrentPage"].to_i
+          ipp = body["RecordsPerPage"].to_i
+          total_count = body["TotalCount"].to_i
+          has_next_page = current_page * ipp < total_count
+
+          body["data"].each do |entity_hash|
+            yield(@entity_class.new(@client, entity_hash))
+          end
+
+          break if !has_next_page
+        end
+
+        self
+      end
+
+      def [](target_index)
+        self.each_with_index do |item, index|
+          return item if index == target_index
+        end
+
+        nil
+      end
+
+      protected
+
+      def fetch(page: 1)
+        parameters = @options.merge(
+          PageNumber: page
+        )
+
+        @client.send_request(
+          type: Request::Type::LIST,
+          entity_type: @entity_class.type,
+          parameters: parameters
+        )
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/entities/address.rb

@@ -0,0 +1,14 @@
+module Agendrix
+  module Nethris
+    class Address < Entity
+      FIELDS = [
+        "ADDRESS_TYPE",
+        "ADDRESS_STREET",
+        "ADDRESS_CITY",
+        "PROVINCE_CODE",
+        "POSTAL_CODE",
+        "POSTAL_ZIP"
+      ].freeze
+    end
+  end
+end

data/lib/agendrix/nethris/entities/employee.rb

@@ -0,0 +1,62 @@
+module Agendrix
+  module Nethris
+    class Employee < Entity
+      def self.type
+        Request::EntityType::EMPLOYEE
+      end
+
+      module EmplStatus
+        ACTIVE = 1.freeze
+        INACTIVE = 2.freeze
+        TERMINATED = 3.freeze
+        ON_VACATION = 4.freeze
+        LEAVE_OF_ABSENCE = 5.freeze
+      end
+
+      FIELDS = [
+        "CO_NUMBER",
+        "EMPL_ID",
+        "EMPL_NUMBER",
+        "FIRST_NAME",
+        "LAST_NAME",
+        "GENDER_CODE",
+        "EMAIL_WORK",
+        "HIRE_DATE",
+        "DATE_OF_BIRTH",
+        "EMPLOYEE_RATE",
+        "DEPARTURE_DATE",
+        "DIVISION_NO",
+        "SERVICE_NO",
+        "DEPARTM_NO",
+        "SUBDEPARTM_NO",
+        "EMPL_DISP_STATUS"
+      ].freeze
+
+      attr_reader(
+        :addresses,
+        :phones
+      )
+
+      def initialize(client, data)
+        attributes = {}
+
+        FIELDS.each do |field|
+          attributes[field] = data&.[](field)
+        end
+
+        attributes["HIRE_DATE"] = Date.parse(attributes["HIRE_DATE"]) if attributes["HIRE_DATE"]
+        attributes["DEPARTURE_DATE"] = Date.parse(attributes["DEPARTURE_DATE"]) if attributes["DEPARTURE_DATE"]
+        attributes["DATE_OF_BIRTH"] = Date.parse(attributes["DATE_OF_BIRTH"]) if attributes["DATE_OF_BIRTH"]
+
+        super(client, attributes)
+
+        @addresses = parse_relation(Address, data["Addresses"])
+        @phones = parse_relation(PhoneNumber, data["Phones"])
+      end
+
+      def full_name
+        "#{first_name} #{last_name}"
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/entities/phone_number.rb

@@ -0,0 +1,19 @@
+module Agendrix
+  module Nethris
+    class PhoneNumber < Entity
+      FIELDS = [
+        "AREA_CODE",
+        "PHONE_TYPE",
+        "PHONE_NUMBER",
+        "EXT_NUMBER"
+      ].freeze
+
+      module Type
+        MOBILE = "C".freeze
+        HOME = "R".freeze
+        SECONDARY = "S".freeze
+        WORK = "T".freeze
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/entity.rb

@@ -0,0 +1,43 @@
+module Agendrix
+  module Nethris
+    class Entity
+      def initialize(client, attributes)
+        @client = client
+        @attributes = attributes
+      end
+
+      def inspect
+        variables = self.instance_variables - [:"@client"]
+        variables.map! { |v| "#{v}=#{self.instance_eval(v.to_s)}" }
+        "#<#{self.class} #{variables.join(', ')}>"
+      end
+
+      def method_missing(method_name)
+        method_name_s = method_name.to_s
+
+        if @attributes.key?(method_name_s.upcase)
+          @attributes[method_name_s.upcase]
+        elsif @attributes.key?(method_name_s)
+          @attributes[method_name_s]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        method_name_s = method_name.to_s
+        @attributes.key?(method_name_s) || @attributes.key?(method_name_s.upcase) || super
+      end
+
+      protected
+
+      def parse_relation(klass, data)
+        return [] if data.blank?
+
+        data["childData"].map do |child_data|
+          klass.new(@client, child_data)
+        end
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/errors.rb

@@ -0,0 +1,27 @@
+module Agendrix
+  module Nethris
+    class NethrisError < StandardError
+      attr_reader(
+        :broken_rules
+      )
+
+      def initialize(message, broken_rules = [])
+        @broken_rules = broken_rules
+        message += " (" + @broken_rules.first["Text"] + ")" if message && @broken_rules.try(:first)
+        super(message)
+      end
+    end
+
+    # Raised when the session_id you provided is incorrect or not authorized to access certain type of data.
+    class AuthenticationError < NethrisError
+    end
+
+    # Raised when we experience a socket read timeout
+    class ServiceUnavailableError < NethrisError
+    end
+
+    # Raised when the request has bad syntax
+    class BadRequestError < NethrisError
+    end
+  end
+end

data/lib/agendrix/nethris/request.rb

@@ -0,0 +1,103 @@
+require "uri"
+require "net/https"
+
+module Agendrix
+  module Nethris
+    class Request
+      module Type
+        LOG_IN = "logIn".freeze
+        LOG_OUT = "logOut".freeze
+        LIST = "getList".freeze
+        UPDATE = "updateItem".freeze
+        GET = "getItem".freeze
+        UPLOAD_FILE = "putFile".freeze
+      end
+
+      module EntityType
+        EMPLOYEE = "employee".freeze
+      end
+
+      def initialize(vendor, session_id = nil)
+        raise TypeError, "vendor can't be nil" if vendor.nil?
+
+        @vendor = vendor
+        @session_id = session_id
+      end
+
+      def execute(type:, entity_type: nil, id: nil, parameters: nil)
+        body = generate_body(type: type, entity_type: entity_type, id: id, parameters: parameters)
+        request = generate_request(body)
+        response = client.request(request)
+        parsed_body = parse_body(response.body)
+        raise_errors_on_failure(parsed_body)
+        parse_data(parsed_body)
+      rescue Timeout::Error
+        raise ServiceUnavailableError, "Service Unavailable [request timed out]"
+      end
+
+      protected
+
+      def endpoints
+        if Agendrix::Nethris.demo
+          {
+            Client::Vendor::NETHRIS     => "https://demo.nethris.com/CSPaySuiteServices/wsWebSuiteService.svc/V.1.00/ExecuteRequest",
+            Client::Vendor::EMPLOYER_D  => "https://demo.employeurd.com/CSPaySuiteServices/wsWebSuiteService.svc/V.1.00/ExecuteRequest"
+          }
+        else
+          {
+            Client::Vendor::NETHRIS     => "https://clients.nethris.com/CSPaySuiteServices/wsWebSuiteService.svc/V.1.00/ExecuteRequest",
+            Client::Vendor::EMPLOYER_D  => "https://employeurd.com/CSPaySuiteServices/wsWebSuiteService.svc/V.1.00/ExecuteRequest"
+          }
+        end
+      end
+
+      def endpoint_uri
+        @_endpoint_uri ||= URI.parse(endpoints[@vendor])
+      end
+
+      def client
+        Net::HTTP.new(endpoint_uri.host, endpoint_uri.port).tap do |net|
+          if endpoint_uri.is_a?(URI::HTTPS)
+            net.use_ssl = true
+            net.verify_mode = OpenSSL::SSL::VERIFY_NONE # VERIFY_PEER
+            # net.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
+          end
+
+          net.read_timeout = 90
+          net.open_timeout = 30
+        end
+      end
+
+      def generate_request(body)
+        Net::HTTP::Post.new(endpoint_uri.to_s).tap do |request|
+          request.body = body.to_json
+          request["Content-Type"] = "application/json"
+        end
+      end
+
+      def generate_body(type:, entity_type:, id: nil, parameters: {})
+        {
+          SessionId: @session_id,
+          Type: type || "",
+          Entity: entity_type || "",
+          Id: id || "",
+          Parameters: parameters.to_json
+        }
+      end
+
+      def parse_body(body)
+        JSON.parse(body)
+      end
+
+      def raise_errors_on_failure(body)
+        if body["ReturnCode"].to_i == -1
+          raise BadRequestError.new("Bad request", body["BrokenRules"])
+        end
+      end
+
+      def parse_data(body)
+        JSON.parse(body["ReturnData"])
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/services/employee_service.rb

@@ -0,0 +1,43 @@
+module Agendrix
+  module Nethris
+    module Services
+      class EmployeeService
+        def initialize(client)
+          @client = client
+        end
+
+        def all(options = {})
+          parameters = options.merge(
+            OutputFields: options.fetch(:fields, all_fields)
+          )
+
+          CollectionProxy.new(@client, Nethris::Employee, parameters)
+        end
+
+        def get(id, options = {})
+          parameters = options.merge(
+            fields: options.fetch(:fields, all_fields)
+          )
+
+          data = @client.send_request(
+            type: Request::Type::GET,
+            entity_type: Nethris::Employee.type,
+            id: id,
+            parameters: parameters
+          )
+
+          data = data["Employee"]["data"][0]
+          data["EMPL_ID"] = id # Manually set id because API doesn't return it
+
+          Nethris::Employee.new(@client, data)
+        end
+
+        protected
+
+        def all_fields
+          Nethris::Employee::FIELDS + Nethris::Address::FIELDS + Nethris::PhoneNumber::FIELDS
+        end
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/services/session_service.rb

@@ -0,0 +1,52 @@
+module Agendrix
+  module Nethris
+    module Services
+      class SessionService
+        attr_reader(
+          :id
+        )
+
+        def initialize(vendor:, id: nil, user_code: nil, password: nil, business_code: nil)
+          @vendor = vendor
+
+          if id.present?
+            @id = id
+          else
+            login(user_code: user_code, password: password, business_code: business_code)
+          end
+
+          raise AuthenticationError.new("Missing authentification credentials") if @id.blank?
+        end
+
+        def log_in(user_code:, password:, business_code:)
+          raise AuthenticationError.new("Already logged in") if @id.present?
+
+          data = Request.new(@vendor).execute(
+            type: Request::Type::LOG_IN,
+            parameters: {
+              APPID: Nethris.app_id,
+              businessCode: business_code,
+              userCode: user_code,
+              userPassword: password,
+              language: "en-US"
+            }
+          )
+
+          @id = data["sessionId"]
+        end
+
+        alias login log_in
+
+        def log_out
+          return unless @id
+
+          Request.new(@vendor, @id).execute(
+            type: Request::Type::LOG_OUT
+          )
+        end
+
+        alias logout log_out
+      end
+    end
+  end
+end

data/lib/agendrix/nethris/version.rb

@@ -0,0 +1,5 @@
+module Agendrix
+  module Nethris
+    VERSION = "0.1.24".freeze
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: agendrix-nethris
+version: !ruby/object:Gem::Version
+  version: 0.1.24
+platform: ruby
+authors:
+- Charles Vallières
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- charles@agendrix.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- bin/test
+- lib/agendrix/nethris.rb
+- lib/agendrix/nethris/client.rb
+- lib/agendrix/nethris/collection_proxy.rb
+- lib/agendrix/nethris/entities/address.rb
+- lib/agendrix/nethris/entities/employee.rb
+- lib/agendrix/nethris/entities/phone_number.rb
+- lib/agendrix/nethris/entity.rb
+- lib/agendrix/nethris/errors.rb
+- lib/agendrix/nethris/request.rb
+- lib/agendrix/nethris/services/employee_service.rb
+- lib/agendrix/nethris/services/session_service.rb
+- lib/agendrix/nethris/version.rb
+homepage: 
+licenses: []
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for the Nethris API
+test_files: []