peoplegroup-connectors 0.2.4 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7d20280252218ea7b8611677e2cb47a9f1fee7c7af7fd06fd0d2cba9b62d33
-  data.tar.gz: 7f6ea3484cc733e014ca35e8eef0ee7090fd78f3a625129561bb1256642167b7
+  metadata.gz: 2188d8525330b4b9f74686e1b07e6debd9d488c91071194747a422e81507bd97
+  data.tar.gz: 5f378bc5cf32c4fec762168bc61573c8dfc423695b812377394176c1bf6a46cb
 SHA512:
-  metadata.gz: 63c2be0e26a7d273095f50e735ad79594964c37ca8a3531e298b8e001b2d5310a4cb05f68c77ad503f08ff60fea52b4bd7622b679371a96aa4e039502e59f3dd
-  data.tar.gz: c8b3ba98d40d7cb28a6f679bdfe9cc32d491a7a628b4258b39f2d78459f69c3a2cfd698b7cee8339a983c617e4ba5f52ae5e485620d0d2e93f5afeeec5184fba
+  metadata.gz: 188a66b33ede08a2af9e4e2bfd7de4f1905347fd9d63d09e7a2bc77022ebc190da720010c5b9111b25ab6923cb2b3e685876447d2d1dd2d59e745c806ccc6b12
+  data.tar.gz: a48bca2c21e59036339b9ac1445e14336c162ced1b497bd1236fe5563b0cdf58aa00f202f9ea7e7f1d727107226b0b1990b6263ff11ac5921013ab36a4a19371

data/README.md

@@ -12,11 +12,15 @@ gem 'peoplegroup-connectors'
 
 And then execute:
 
-    $ bundle install
+```bash
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install peoplegroup-connectors
+```bash
+gem install peoplegroup-connectors
+```
 
 ## Usage
 
@@ -35,8 +39,7 @@ For local development and manual testing, copy the contents of the `.env.example
 
 ## Contributing and Code of Conduct
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitLab at <https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/peoplegroup/connectors/bamboo.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'bamboozled'
+require_rel 'models/objectified_hash'
 
 module PeopleGroup
   module Connectors
@@ -112,45 +113,6 @@ module PeopleGroup
         manager
       end
 
-      def people_managers_in_functions(departments: [], divisions: [])
-        active_and_current_team_members.select do |team_member|
-          (departments.include?(team_member['department']) || divisions.include?(team_member['division'])) && has_direct_reports?(team_member['employeeNumber'])
-        end
-      end
-
-      def all_reports_for(id)
-        direct_reports_to_check = direct_reports_for(id)
-        reports_to_return = []
-        while direct_reports_to_check.present?
-          current_node = direct_reports_to_check.shift
-          reports_to_return << current_node
-          direct_reports_to_check.concat(direct_reports_for(current_node['employeeNumber']))
-        end
-        reports_to_return
-      end
-
-      def direct_reports_for(id)
-        active_and_current_team_members.select { |team_member| team_member['supervisorId'] == id.to_s }
-      end
-
-      def has_direct_reports?(id)
-        active_and_current_team_members.any? { |team_member| team_member['supervisorId'] == id.to_s }
-      end
-
-      def reports_in_departments(departments, exclude_email)
-        active_and_current_team_members.select do |team_member|
-          # exclude_email is for example to filter out the PBP itself in case their department is also the department they manage
-          departments.include?(team_member['department']) && team_member['workEmail'] != exclude_email
-        end
-      end
-
-      def reports_in_divisions(divisions, exclude_email)
-        active_and_current_team_members.select do |team_member|
-          # exclude_email is for example to filter out the PBP itself in case their department is also the department they manage
-          divisions.include?(team_member['division']) && team_member['workEmail'] != exclude_email
-        end
-      end
-
       def create_employee(employee_details_hash)
         invalidate_cache
         retry_on_error { @client.employee.add(employee_details_hash) }
@@ -164,41 +126,23 @@ module PeopleGroup
       end
       alias_method :update_team_member, :update_employee
 
-      def departments
-        meta_fields
-          .detect { |res| res['name'] == 'Department' }
-          .dig('options')
-          .each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
-      end
-
-      def divisions
-        meta_fields
-          .detect { |res| res['name'] == 'Division' }
-          .dig('options')
-          .each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
-      end
-
       def locations
         meta_fields.detect { |res| res['name'] == 'Location' }.dig('options').each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
       end
 
-      def fields
-        return @fields if @fields
-
-        meta_field_aliases = retry_on_error { @client.meta.fields }.map { |f| f['alias'] }
-        @fields = (Bamboozled::API::FieldCollection.all_names + meta_field_aliases).compact.uniq
-        @fields.delete('flsaCode') # temp fix for problems with BambooHR
-        @fields
-      end
-
       def employees
-        retry_on_error do
+        return @employees unless @employees.nil?
+
+        report = retry_on_error do
           if @use_report
-            @employees ||= @client.report.find(@use_report, 'JSON', true).reject { |employee| employee['lastName'] == 'Test-Gitlab' }
+            @client.report.find(@use_report, 'JSON', true)
           else
-            @employees ||= @client.report.custom(fields, 'JSON').reject { |employee| employee['lastName'] == 'Test-Gitlab' }
+            @client.report.custom(fields, 'JSON')
           end
         end
+
+        filtered = report.reject { |team_member| team_member['lastName'] == 'Test-Gitlab' }
+        @employees = filtered.map { |team_member| format_team_member(team_member) }
       end
       alias_method :team_members, :employees
 
@@ -220,11 +164,6 @@ module PeopleGroup
         retry_on_error { @client.employee.add_table_row(id, 'customEquity', data) }
       end
 
-      def stock_options_data(employee_number)
-        id = bamboo_id!(employee_number)
-        retry_on_error { @client.employee.table_data(id, 'customEquity') }
-      end
-
       def add_job_details(employee_number, data)
         id = bamboo_id!(employee_number)
         retry_on_error { @client.employee.add_table_row(id, 'jobInfo', data) }
@@ -247,19 +186,10 @@ module PeopleGroup
         retry_on_error { @client.employee.table_data(id, 'employmentStatus') }
       end
 
-      def time_off_types
-        @time_off_types ||= retry_on_error { @client.meta.time_off_types }
-      end
-
       def time_off_type(name)
         time_off_types['timeOffTypes'].find { |type| type['name'] == name }
       end
 
-      def time_off_estimate(employee_number, end_date = Date.today)
-        id = bamboo_id!(employee_number)
-        retry_on_error { @client.employee.time_off_estimate(id, end_date) }
-      end
-
       def time_off_adjustment(employee_number, options)
         id = bamboo_id!(employee_number)
         retry_on_error { @client.employee.time_off_balance_adjustment(id, options) }
@@ -355,11 +285,6 @@ module PeopleGroup
         retry_on_error { @client.employee.table_data(id, 'employmentStatus') }
       end
 
-      def currency_conversion(employee_number)
-        id = bamboo_id!(employee_number)
-        retry_on_error { @client.employee.table_data(id, 'customCurrencyConversion') }
-      end
-
       def add_bonus(employee_number, comment)
         team_member = search_employee_by_field(field: 'employeeNumber', value: employee_number)
         data = {
@@ -372,21 +297,30 @@ module PeopleGroup
         retry_on_error { @client.employee.add_table_row(team_member['id'], 'customBonus', data) }
       end
 
-      def add_rating_details(team_member_id, performance, potential)
-        data = {
-          customEffectiveDate4: Date.today.to_s,
-          customPerformanceFactor: performance,
-          customPotentialFactor: potential
-        }
-        retry_on_error { @client.employee.add_table_row(team_member_id, 'customPerformanceandPotentialTable', data) }
-      end
-
       private
 
+      def fields
+        return @fields if @fields
+
+        meta_field_aliases = retry_on_error { @client.meta.fields }.map { |f| f['alias'] }
+        @fields = (Bamboozled::API::FieldCollection.all_names + meta_field_aliases).compact.uniq
+        @fields.delete('flsaCode') # temp fix for problems with BambooHR
+        @fields
+      end
+
       def meta_fields
         @meta_fields ||= retry_on_error { @client.meta.lists }
       end
 
+      def time_off_types
+        @time_off_types ||= retry_on_error { @client.meta.time_off_types }
+      end
+
+      def time_off_estimate(employee_number, end_date = Date.today)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.time_off_estimate(id, end_date) }
+      end
+
       def files(employee_number)
         id = bamboo_id!(employee_number)
         @files ||= retry_on_error { @client.employee.files(id) }
@@ -399,6 +333,28 @@ module PeopleGroup
       def invalidate_cache
         @employees = nil
       end
+
+      MALFORMED_FIELDS = [
+        'customExportName/LocationtoTeamPage?',
+        'customI-9Processed',
+        'customJobTitleSpecialty(Multi-Select)'
+      ].freeze
+
+      # Convert BHR team member to Workday.
+      def format_team_member(team_member)
+        return nil if team_member.nil?
+
+        formatted = {
+          **team_member.except(*MALFORMED_FIELDS),
+          'customExportNameLocationtoTeamPage' => team_member['customExportName/LocationtoTeamPage?'] || 'No',
+          'customJobTitleSpecialtyMultiSelect' => team_member['customJobTitleSpecialty(Multi-Select)'],
+          'customI9Processed' => team_member['customI-9Processed']
+        }
+
+        formatted = PeopleGroup::Connectors::Models::ObjectifiedHash.new(formatted) unless @use_report
+
+        formatted
+      end
     end
   end
 end

data/lib/peoplegroup/connectors/hris.rb

@@ -8,11 +8,26 @@ module PeopleGroup
 
       def initialize
         @workday = Workday.new
+        @bamboo = Bamboo.new
       end
 
       def employees
-        @workday.workers.map { |worker| format_worker(worker) }
+        @employees ||= @workday.workers
       end
+      alias_method :team_members, :employees
+
+      def active_employees
+        employees.select { |employee| employee['status'] == 'Active' }
+      end
+      alias_method :active_team_members, :active_employees
+
+      def active_and_current_employees
+        today = Date.current
+        employees.select do |employee|
+          employee['status'] == 'Active' && Date.parse(employee['hireDate']) <= today
+        end
+      end
+      alias_method :active_and_current_team_members, :active_and_current_employees
 
       def get_employee_details(employee_number)
         employees.find { |emp| emp['employeeNumber'] == employee_number.to_s }
@@ -25,49 +40,233 @@ module PeopleGroup
 
         employee_details
       end
+      alias_method :get_team_member_details!, :get_employee_details!
 
-      private
+      def search_employee(name)
+        return if name.empty?
 
-      # Convert Workday worker to BambooHR employee
-      def format_worker(worker)
-        return nil if worker.nil?
+        employees.find do |emp|
+          [
+            emp['displayName']&.downcase,
+            "#{emp['firstName']&.downcase} #{emp['lastName']&.downcase}",
+            "#{emp['preferredName']&.downcase} #{emp['lastName']&.downcase}",
+            "#{emp['firstName']&.downcase} #{emp['customPreferredLastName']&.downcase}",
+            "#{emp['preferredName']&.downcase} #{emp['customPreferredLastName']&.downcase}",
+            emp['fullName5']&.downcase # this is firstName middleName lastName
+          ].include?(name.downcase)
+        end
+      end
+      alias_method :search_team_member, :search_employee
+
+      def search_employee!(name)
+        employee = search_employee(name)
+        raise EmployeeNotFoundError, "No employee found with name #{name}" if employee.nil?
 
-        {
-          'employeeNumber' => worker.dig(:worker_data, :worker_id),
-          'firstName' => worker.dig(:worker_data, :personal_data, :name_data, :legal_name_data, :name_detail_data, :first_name),
-          'lastName' => worker.dig(:worker_data, :personal_data, :name_data, :legal_name_data, :name_detail_data, :last_name),
-          'preferredName' => worker.dig(:worker_data, :personal_data, :name_data, :preferred_name_data, :name_detail_data, :first_name),
-          'customPreferredLastName' => worker.dig(:worker_data, :personal_data, :name_data, :preferred_name_data, :name_detail_data, :last_name),
-          **format_emails(worker),
-          'status' => worker.dig(:worker_data, :employment_data, :worker_status_data, :active) == '1' ? 'Active' : 'Inactive',
-          'hireDate' => worker.dig(:worker_data, :employment_data, :worker_status_data, :hire_date).to_s,
-          'jobTitle' => worker.dig(:worker_data, :employment_data, :worker_job_data, :position_data, :position_title)
-        }
+        employee
       end
+      alias_method :search_team_member!, :search_employee!
 
-      def format_emails(worker)
-        formatted_emails = {
-          'workEmail' => nil,
-          'homeEmail' => nil
-        }
+      def search_employee_by_field(field:, value:)
+        employees.find { |employee| employee[field] == value.to_s }
+      end
+      alias_method :search_team_member_by_field, :search_employee_by_field
 
-        email_addresses = worker.dig(:worker_data, :personal_data, :contact_data, :email_address_data)
+      def search_employee_by_field!(field:, value:)
+        employee = search_employee_by_field(field: field, value: value)
+        raise EmployeeNotFoundError, "No employee found with #{field}: #{value}" if employee.nil?
 
-        return formatted_emails if email_addresses.nil?
+        employee
+      end
+      alias_method :search_team_member_by_field!, :search_employee_by_field!
 
-        # If there is only one email, Workday returns a hash
-        # If there are more than one, Workday returns an array of hashes
-        # rubocop:disable Style/ArrayCoercion
-        email_addresses = [email_addresses] unless email_addresses.is_a?(Array)
-        # rubocop:enable Style/ArrayCoercion
+      # Find the associated team member without checking case on their e-mail fields.
+      def search_team_member_by_email(email)
+        return nil unless email
 
-        email_addresses.each do |email_address_data|
-          email_type = email_address_data.dig(:usage_data, :type_data, :type_reference, :id).second
-          formatted_emails['workEmail'] = email_address_data[:email_address] if email_type == 'WORK'
-          formatted_emails['homeEmail'] = email_address_data[:email_address] if email_type == 'HOME'
+        team_members.find do |team_member|
+          emails = [team_member['workEmail'], team_member['bestEmail'], team_member['homeEmail']]
+          emails.compact.any? { |match| email.casecmp(match) === 0 }
         end
+      end
+      alias_method :slack_email_lookup_with_fallback, :search_team_member_by_email
+
+      # Find the team member by email and raise error if not found.
+      def search_team_member_by_email!(email)
+        team_member = search_team_member_by_email(email)
+
+        return team_member if team_member
+
+        raise EmployeeNotFoundError, "Could not find team member with the e-mail: #{email}"
+      end
+      alias_method :slack_email_lookup_with_fallback!, :search_team_member_by_email!
+
+      def team_members_by_department(department)
+        active_and_current_team_members.select { |team_member| team_member['department'] == department }
+      end
+
+      def team_members_by_division(division)
+        active_and_current_team_members.select { |team_member| team_member['division'] == division }
+      end
+
+      def fetch_manager(team_member)
+        active_team_members.find { |tm| tm['employeeNumber'] == team_member['supervisorId'] }
+      end
+
+      def fetch_manager!(team_member)
+        manager = fetch_manager(team_member)
+        raise EmployeeNotFoundError, "Manager not found for employee #{team_member['employeeNumber']}" if manager.nil?
+
+        manager
+      end
+
+      def fetch_second_level_manager(team_member)
+        fetch_manager(fetch_manager(team_member))
+      end
+
+      def fetch_second_level_manager!(team_member)
+        manager = fetch_second_level_manager(team_member)
+        raise EmployeeNotFoundError, "No second level manager found for employee #{team_member['employeeNumber']}" if manager.nil?
+
+        manager
+      end
+
+      def create_employee(employee_details_hash)
+        @bamboo.create_employee(employee_details_hash)
+      end
+      alias_method :create_team_member, :create_employee
+
+      def update_employee(employee_number, employee_details_hash)
+        # Only used in activate_team_members.rb, which is not needed in Workday
+        @bamboo.update_employee(employee_number, employee_details_hash)
+      end
+      alias_method :update_team_member, :update_employee
+
+      def locations
+        @workday.locations
+      end
+
+      def add_stock_options(employee_number, data)
+        @bamboo.add_stock_options(employee_number, data)
+      end
+
+      def add_job_details(employee_number, data)
+        @bamboo.add_job_details(employee_number, data)
+      end
+
+      def update_job_details(employee_number, data)
+        @bamboo.update_job_details(employee_number, data)
+      end
+
+      def add_compensation_details(employee_number, data)
+        @bamboo.add_compensation_details(employee_number, data)
+      end
+
+      def employment_statuses(employee_number)
+        # Terminated/Active in one field already. Those are the statuses we need to care about
+        # Look for a hire date that is after the start date (not original hire date) to account for rehires
+        # Affected: joining.rb
+
+        # Probation period, CXC contract ending, temporary contract ending won't be needed
+        # We can ignore garden leave (terminate access to systems without pausing benefits/stock vesting)
+        # Affected:
+        # - anniversary.rb
+        # - cxc_contract_renewal_email.rb
+        # - extension_netherlands_contract_email.rb
+        # - probation_email.rb
+        # - probation_status.rb
+
+        raise NotImplementedError
+      end
+
+      def time_off_type(name)
+        # Staying in bamboo for workday first release
+        # Will need to have talks with pto by roots admin
+        @bamboo.time_off_type(name)
+      end
+
+      def time_off_adjustment(employee_number, options)
+        # Staying in bamboo for workday first release
+        # Will need to have talks with pto by roots admin
+        @bamboo.time_off_adjustment(employee_number, options)
+      end
+
+      def accrued_days(employee_number)
+        # Staying in bamboo for workday first release
+        # Will need to have talks with pto by roots admin
+        @bamboo.accrued_days(employee_number)
+      end
+
+      def time_off_policies
+        @bamboo.time_off_policies
+      end
+
+      def employee_time_off_policies(employee_number)
+        @bamboo.employee_time_off_policies(employee_number)
+      end
+      alias_method :team_member_time_off_policies, :employee_time_off_policies
+
+      def add_time_off_policy(employee_number, time_off_policy_id, accrual_start_date)
+        @bamboo.add_time_off_policy(employee_number, time_off_policy_id, accrual_start_date)
+      end
+
+      def remove_time_off_policy(employee_number, time_off_policy_id)
+        @bamboo.remove_time_off_policy(employee_number, time_off_policy_id)
+      end
+
+      def job_details(employee_number)
+        @workday.manager_history(employee_number)
+      end
+
+      def resumes_folder_id(employee_number)
+        @bamboo.resumes_folder_id(employee_number)
+      end
+
+      def contract_folder_id(employee_number)
+        @bamboo.contract_folder_id(employee_number)
+      end
+
+      def add_file(employee_number, file_name, file, folder_id)
+        @bamboo.add_file(employee_number, file_name, file, folder_id)
+      end
+
+      def add_employment_status(employee_number, data)
+        # Only used in parental_pto_to_bamboo.rb
+        # That integration adds the following statuses: Parental Leave, End of Parental Leave, Active
+        # Asked what to do about this one on Slack: https://gitlab.slack.com/archives/C02FHJ9BYTZ/p1650666853127429
+
+        raise NotImplementedError
+      end
+
+      def add_currency_conversion(employee_number, data)
+        @bamboo.add_currency_conversion(employee_number, data)
+      end
+
+      def add_on_target_earnings(employee_number, data)
+        @bamboo.add_on_target_earnings(employee_number, data)
+      end
+
+      def add_signing_bonus(employee_number, data)
+        @bamboo.add_signing_bonus(employee_number, data)
+      end
+
+      def add_family_member(employee_number, data)
+        @bamboo.add_family_member(employee_number, data)
+      end
+
+      def add_additional_data(employee_number, data)
+        @bamboo.add_additional_data(employee_number, data)
+      end
+
+      def additional_data(employee_number)
+        @bamboo.additional_data(employee_number)
+      end
+
+      def add_bonus(employee_number, comment)
+        @workday.add_bonus(employee_number, comment)
+      end
 
-        formatted_emails
+      def departments
+        @workday.departments
       end
     end
   end

data/lib/peoplegroup/connectors/models/objectified_hash.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module PeopleGroup
+  module Connectors
+    module Models
+      # Turns a hash into a Ruby object.
+      # This will assign the key of the hash as an instance method, and the value as the return value.
+      # This will also convert any nested hashes into another ObjectifiedHash.
+      class ObjectifiedHash
+        # The raw hash prior to objectification.
+        attr_reader :hash
+
+        # The data with any objectified children.
+        attr_reader :data
+
+        def initialize(hash)
+          @hash = hash.transform_keys(&:to_sym)
+          @data = hash.transform_keys(&:to_s)
+          hash.each do |key, value|
+            if value.is_a?(Hash) && value.size.positive?
+              value = self.class.new(value)
+            elsif value.is_a?(Array) && value.first.is_a?(Hash)
+              value = value.map { |data| self.class.new(data) }
+            end
+
+            instance_variable_set("@#{key}", value)
+            self.class.send(:attr_reader, key) # rubocop:disable GitlabSecurity/PublicSend
+            @data[key] = value
+          end
+        end
+
+        # Mimicks the Hash#dig method.
+        # @param [Array] Nested keys of the object.
+        # @return The value of the key at the nested location.
+        def dig(*args)
+          @data.dig(*args)
+        end
+
+        # Create a new instance from an array of Hashes
+        def self.from_array(array)
+          array.map { |data| new(data) if data.is_a?(Hash) }
+        end
+
+        # Maintains normal json data structure
+        def [](key)
+          @data[key.to_s]
+        end
+
+        # Allows us to override the json data
+        def []=(key, value)
+          @data[key.to_s] = value
+        end
+
+        # Return the stored raw hash value.
+        def to_h
+          @hash
+        end
+
+        # Returns the hash with keys converted to strings.
+        def to_json # rubocop:disable Lint/ToJSON
+          JSON.parse(hash.to_json)
+        end
+
+        # Returns both the hash and json styled keys.
+        def keys
+          @keys ||= @hash.keys + @data.keys
+        end
+
+        private
+
+        # For handling Object.respond_to?(:method)
+        def respond_to_missing?(method, include_private = false)
+          super
+        end
+
+        # Enforces read only access as well as mimicking the return value of a hash.
+        # @param method [Symbol] The method to be called.
+        # @param args [Array] The arguments attempted to be passed into the method.
+        # @raises [NoMethodError] if the method is attempting to set data on the object.
+        # @return nil
+        def method_missing(method, *args)
+          return raise NoMethodError, "This object is read-only." if method.end_with?('=')
+          return nil if method.start_with?('[')
+
+          raise NoMethodError, "Undefined method `#{method}` called for #{inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/peoplegroup/connectors/slack.rb

@@ -6,12 +6,8 @@ module PeopleGroup
   module Connectors
     class Slack
       def initialize
-        ::Slack::Web::Client.configure do |config|
+        ::Slack.configure do |config|
           config.token = ENV['SLACK_API_TOKEN']
-
-          # configure certificate file
-          # fixed in slack-ruby-client 2.x
-          config.ca_file = ENV.fetch('SSL_CERT_FILE', '/usr/lib/ssl/certs/ca-certificates.crt')
         end
         @client = ::Slack::Web::Client.new
       end

data/lib/peoplegroup/connectors/version.rb

@@ -2,6 +2,6 @@
 
 module PeopleGroup
   module Connectors
-    VERSION = '0.2.4'
+    VERSION = '0.3.1'
   end
 end

data/lib/peoplegroup/connectors/workday.rb

@@ -1,87 +1,110 @@
 # frozen_string_literal: true
 
 require 'savon'
+require_rel 'xml'
 
 module PeopleGroup
   module Connectors
     class Workday
-      attr_accessor :client, :subdomain, :tenant
+      include XML
+      attr_accessor :staffing_client, :compensation_client, :subdomain, :tenant
 
+      # Current Workday API Version
       API_VERSION = 'v37.0'
-      MAX_RESULTS_PER_PAGE = 999
 
       EmployeeNotFoundError = Class.new(StandardError)
 
       def initialize
         @subdomain = ENV['WORKDAY_SUBDOMAIN']
         @tenant = ENV['WORKDAY_TENANT']
-        isu_username = ENV['WORKDAY_ISU_USERNAME']
-        isu_password = ENV['WORKDAY_ISU_PASSWORD']
-        soap_debug_logs_enabled = ENV['WORKDAY_SOAP_DEBUG_LOGS'].present?
+        @api_base_path = "https://#{@subdomain}.workday.com/ccx/service"
+        @isu_username = ENV['WORKDAY_ISU_USERNAME']
+        @isu_password = ENV['WORKDAY_ISU_PASSWORD']
 
-        @client = Savon.client(
-          wsdl: "https://#{@subdomain}.workday.com/ccx/service/#{@tenant}/Human_Resources/#{API_VERSION}?wsdl",
+        soap_debug_logs_enabled = ENV['WORKDAY_SOAP_DEBUG_LOGS'] == 'true'
+        options = {
           log: soap_debug_logs_enabled,
-          wsse_auth: ["#{isu_username}@#{@tenant}", isu_password],
-          pretty_print_xml: true,
-          convert_request_keys_to: :camelcase,
-          env_namespace: :env,
-          namespace_identifier: nil,
-          namespaces: {
-            'xmlns' => nil,
-            'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
-            'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
-            'xmlns:wsse' => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd'
-          }
-        )
+          pretty_print_xml: soap_debug_logs_enabled
+        }
+
+        @staffing_client = client('Staffing', options)
+        @compensation_client = client('Compensation', options)
       end
 
       def workers
-        retry_on_error do
-          @workers ||= auto_paginated_call(:get_workers, { message_tag: 'wd:Get_Workers_Request', attributes: attributes })
-        end
+        @workers ||= safe_report(report_name: ENV['WORKDAY_WORKERS_REPORT'])
       end
 
-      def get_worker(id)
-        message = {
-          'wd:Request_References' => {
-            'wd:Worker_Reference' => {
-              'wd:ID' => id,
-              attributes!: {
-                'wd:ID' => {
-                  'wd:type' => 'Employee_ID'
-                }
-              }
-            }
-          },
-          attributes!: {
-            'wd:Request_References' => {
-              'wd:Skip_Non_Existing_Instances' => 'true',
-              'wd:Ignore_Invalid_References' => 'true'
-            }
-          }
-        }
-
-        retry_on_error do
-          auto_paginated_call(:get_workers, { message_tag: 'wd:Get_Workers_Request', message: message, attributes: attributes })
+      # Grabs manager history for the specified team member or all team members.
+      # @return [Array<PeopleGroup::Connectors::Models::ObjectifiedHash>]
+      #   keys:
+      #      Reports_to - Employee_ID of who they were reporting too at this time.
+      #      Managed_From_Date - When they became the team members manager.
+      #      Managed_To_Date - The date they were no longer the team members manager. This field is missing if they are the current manager.
+      def manager_history(employee_number = nil)
+        options = { report_name: ENV['WORKDAY_MANAGER_REPORT'] }
+
+        if employee_number
+          options[:params] = { 'Employee_ID' => employee_number } unless employee_number.nil?
+          options[:nested_key] = 'Manager_Change_group'
         end
+
+        safe_report(**options)
       end
 
       private
 
+      # A generalized report method for Workday.
+      # @param! [String] report_name the name of the report.
+      # @param [Hash] params key value parameters for the report.
+      # @return [Array<PeopleGroup::Models::ObjectifiedHash>]
+      def report(report_name:, params: {}, nested_key: nil)
+        url = report_url(report_name, params)
+        p "Accessing Report: #{url}" if ENV['WORKDAY_SOAP_DEBUG_LOGS']
+        response = retry_on_error { RestClient.get(url, basic_auth_header) }
+        data = JSON.parse(response.body)['Report_Entry']
+        data = data.first[nested_key] if nested_key.is_a?(String) && data.first[nested_key]
+        data.map { |obj| XML::ObjectifiedHash.new obj }
+      end
+
+      # A wrapper for the report logic to handle any Workday specific errors.
+      # @param [Hash] args
+      def safe_report(**args)
+        report(**args)
+      rescue StandardError => e
+        # TODO add common Workday errors here.
+        raise e
+      end
+
+      def report_url(report_name, params)
+        options = URI.encode_www_form({ format: 'json', **params })
+        name = report_name.tr(' ', '_')
+        "#{@api_base_path}/customreport2/#{@tenant}/#{@isu_username}/#{name}?#{options}"
+      end
+
       def retry_on_error(&block)
         Utils.retry_on_error(errors: [Net::ReadTimeout], delay: 3, &block)
       end
 
-      def auto_paginated_call(operation_name, locals = {}, &block)
+      def client_from_operation(operation_name)
+        return @staffing_client if @staffing_client.operations.include?(operation_name)
+
+        @compensation_client
+      end
+
+      def call(operation_name, options = {}, &block)
+        client = client_from_operation(operation_name)
+        response = client.call(operation_name, { **options, **attributes }, &block)
+        { **response.body, code: response.http.code }
+      end
+
+      def auto_paginated_call(operation_name, options = {}, &block)
+        client = client_from_operation(operation_name)
         data = nil
         page = 1
 
         loop do
-          message = locals[:message] || {}
-          message_with_pagination_parameters = { **message, **pagination_parameters(page) }
-          response = @client.call(operation_name, { **locals, message: message_with_pagination_parameters }, &block)
-
+          response = client.call(operation_name, { **options, **attributes }, &block)
           # The response hash contains only one key named after the operation performed
           # eg. get_workers_response
           _operation_response_name, operation_result = response.to_hash.first
@@ -107,20 +130,47 @@ module PeopleGroup
         data
       end
 
-      def pagination_parameters(page = 1, results_per_page = MAX_RESULTS_PER_PAGE)
-        {
-          'wd:Response_Filter' => {
-            'wd:Page' => page,
-            'wd:Count' => results_per_page
-          }
-        }
+      # Default Workday specific body paramaters
+      # xmlns:wd - The URN of the XMLNS file
+      # wd:version - The API Version of workday
+      def attributes
+        { attributes: { 'xmlns:wd' => 'urn:com.workday/bsvc', 'wd:version' => API_VERSION } }
       end
 
-      def attributes
-        {
-          'xmlns:wd' => 'urn:com.workday/bsvc',
-          'wd:version' => API_VERSION
+      # Returns the client based on the service.
+      # @param Service [String] The service to use, ie: Staffing, Compensation
+      # @param options [Hash] default options for the client.
+      #
+      # @return [Savon::Client] The client connected to the specified service.
+      def client(service, options = {})
+        client_opts = {
+          log: false,
+          wsse_auth: [
+            "#{@isu_username}@#{@tenant}",
+            @isu_password
+          ],
+          pretty_print_xml: false,
+          convert_request_keys_to: :camelcase,
+          env_namespace: :env,
+          namespace_identifier: :wd,
+          wsdl: "#{@api_base_path}/#{@tenant}/#{service}/#{API_VERSION}?wsdl",
+          namespaces: {
+            'xmlns' => nil,
+            'xmlns:env' => 'http://schemas.xmlsoap.org/soap/envelope/',
+            'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+            'xmlns:wsse' => 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd'
+          },
+          **options
         }
+
+        Savon.client(**client_opts)
+      end
+
+      def basic_auth_header
+        return @basic_auth_header unless @basic_auth_header.nil?
+
+        base_64 = Base64.strict_encode64("#{@isu_username}:#{@isu_password}")
+        @basic_auth_header = { Authorization: "Basic  #{base_64}" }
       end
     end
   end

data/lib/peoplegroup/connectors/xml/get_organizations.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_rel 'helpers'
+
+module PeopleGroup
+  module Connectors
+    module XML
+      # https://community.workday.com/sites/default/files/file-hosting/productionapi/Staffing/v37.2/Get_Organizations.html
+      module GetOrganizations
+        include Helpers
+
+        # The Operation for this Module
+        OPERATION = :get_organizations
+
+        # List all of the active departments.
+        def departments
+          get('Cost_Center')
+        end
+
+        # List all of the active regions.
+        def regions
+          get('Region')
+        end
+
+        # List all of the active entities.
+        def locations
+          @locations ||= get('Company').map(&:reference_id)
+        end
+
+        # List all of the active pay groups.
+        def pay_groups
+          get('Pay_Group')
+        end
+
+        private
+
+        # Call the specified endpoint.
+        # @param type [String] The type of organization to request.
+        # @return [Array<PeopleGroup::Connectors::Models::ObjectifiedHash>] An array of the requested organzation types resources.
+        def get(type, additional = {})
+          options = {
+            **org_request_criteria_by_type(type),
+            **Helpers.default_response_group,
+            **Helpers.pagination_parameters,
+            **additional
+          }
+
+          request = Helpers.construct_options(OPERATION, options)
+          auto_paginated_call(OPERATION, request).map do |data|
+            ObjectifiedHash.new data[:organization_data]
+          end
+        end
+
+        # Get the Request_Criteria via type
+        # @param type [String] Company, Cost Center, Pay Group, Region
+        #
+        # @return [Request_Criteria] The Organiztion_Request_Criteria for the specified type.
+        def org_request_criteria_by_type(type)
+          org_criteria = organization_request_criteria(type: type)
+          Helpers.request_criteria(org_criteria)
+        end
+
+        # Get the Organization_Request_Criteria as a hash.
+        # @param type [String] The type of Organization to perform the search on.
+        # @param include_inactive [boolean] Whether to include inactive organizations, defaults to false.
+        # @param field_and_param_data [Hash] A Hash containing the key value pair of Field and Parameter Criteria Data.
+        def organization_request_criteria(type:, include_inactive: false, field_and_param_data: nil)
+          hash = {
+            'Organization_Type_Reference' => {
+              'ID' => type,
+              :attributes! => { 'ID' => { 'wd:type' => 'Organization_Type_ID' } }
+            },
+            'Include_Inactive' => include_inactive
+          }
+
+          # Only add parameter criteria if present.
+          hash['Field_And_Parameter_Criteria_Data'] = field_and_param_data unless field_and_param_data.nil?
+
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/peoplegroup/connectors/xml/helpers.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module PeopleGroup
+  module Connectors
+    module XML
+      module Helpers
+        MAX_RESULTS_PER_PAGE = 999
+
+        def self.request_references(refs = {})
+          {
+            'Request_References' => refs
+          }
+        end
+
+        def self.response_filter(filters = {})
+          {
+            'Response_Filter' => filters
+          }
+        end
+
+        # Default Request Criteria XML Wrapper
+        # @param criteria [Hash] A list of key value pair XML attributes.
+        #
+        # @return [Hash] - The <wd:Request_Criteria> XML Component containing a set of options.
+        def self.request_criteria(criteria = {})
+          {
+            'Request_Criteria' => criteria
+          }
+        end
+
+        def self.response_group(group = {})
+          { 'Response_Group' => group }
+        end
+
+        def self.default_response_group(additional = {})
+          groups = { 'Include_Hierarchy_Data' => false, **additional }
+          response_group groups
+        end
+
+        # Contructs a hash that we can pass into the #call Savon client method.
+        def self.construct_options(operation, message)
+          operation = operation.to_s.split('_').collect(&:capitalize).join('_') unless operation.is_a?(String)
+          {
+            message_tag: "#{operation}_Request",
+            message: message
+          }
+        end
+
+        def self.pagination_parameters(page = 1, results_per_page = MAX_RESULTS_PER_PAGE)
+          response_filter(
+            {
+              'Page' => page,
+              'Count' => results_per_page
+            }
+          )
+        end
+
+        # The <wd:Employee_Reference> object wrapper.
+        # @param id [Integer] The employee number of the team member.
+        # @return [Hash] The <wd:Employee_Reference> XML wrapper component.
+        def self.team_member_reference(id)
+          {
+            'Employee_Reference' => {
+              'ID' => id,
+              attributes!: { 'ID' => { 'wd:type' => 'Employee_ID' } }
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/peoplegroup/connectors/xml/request_one_time_payment.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_rel 'helpers'
+
+module PeopleGroup
+  module Connectors
+    module XML
+      # https://community.workday.com/sites/default/files/file-hosting/productionapi/Compensation/v37.0/Request_One-Time_Payment.html
+      module RequestOneTimePayment
+        include Helpers
+
+        # The Operation for this Module
+        OPERATION = :request_one_time_payment
+        OPERATION_AS_PARAM = 'Request_One-Time_Payment'
+
+        # The amount in USD to give for bonuses, must be a decimal.
+        DISCRETIONARY_BONUS = 1000.0
+
+        # Adds a bonus to the team members
+        # @param employee_number [Integer] The Employee Number of the team member receiving the bonus.
+        # @param comment [String] The comment to leave on the business process.
+        def add_bonus(employee_number, comment)
+          options = {
+            **business_process_params(comment),
+            **one_time_payment_data(employee_number, comment)
+          }
+
+          request = Helpers.construct_options(OPERATION_AS_PARAM, options)
+          call(OPERATION, request)
+        end
+
+        private
+
+        # https://community.workday.com/sites/default/files/file-hosting/productionapi/Compensation/v37.0/Request_One-Time_Payment.html#Business_Process_ParametersType
+        # @param comment [String] The comment associated with the bonus.
+        # @param run_now: [Boolean] Defaults to true to process this transaction immediatley.
+        # @param auto_complete: [Boolean] Defaults to true to apply this bonus without needing approval.
+        #
+        # @return [Hash] The <wd:Business_Process_Parameters> for this request.
+        def business_process_params(comment, run_now: true, auto_complete: true)
+          {
+            'Business_Process_Parameters' => {
+              'Auto_Complete' => auto_complete,
+              'Run_Now' => run_now,
+
+              # Comment Data
+              # https://community.workday.com/sites/default/files/file-hosting/productionapi/Compensation/v37.0/Request_One-Time_Payment.html#Business_Process_Comment_DataType
+              'Comment_Data' => {
+                'Comment' => comment
+              }
+            }
+          }
+        end
+
+        # The Effective Date parameter for when to apply the payment, defaults to today.
+        # @param date [Date] The day to apply the payment.
+        # @return [Hash] The <wd:Effective_Date> parameter set to the specified date.
+        def effective_date(date = Date.today)
+          {
+            'Effective_Date' => date.to_s
+          }
+        end
+
+        # The payment specific data for what should be applied.
+        # @param comment [String] The comment for the discretionary bonus.
+        # @param amount [Double] The amount to include in the bonus with decimal accuracy.
+        def one_time_payment_sub_data(comment, amount = DISCRETIONARY_BONUS)
+          {
+            'One-Time_Payment_Sub_Data' => {
+              **payment_plan_reference,
+              'Amount' => amount,
+              'Comment' => comment
+            }
+          }
+        end
+
+        # The type of one time payment we want to group this under.
+        def payment_plan_reference
+          {
+            'One_Time_Payment_Plan_Reference' => {
+              'ID' => 'Discretionary Bonus',
+              attributes!: { 'ID' => { 'wd:type' => 'One-Time_Payment_Plan_ID' } }
+            }
+          }
+        end
+
+        # https://community.workday.com/sites/default/files/file-hosting/productionapi/Compensation/v37.0/Request_One-Time_Payment.html#Request_One-Time_Payment_DataType
+        # @param employee_number [Integer] The team member's employee number.
+        # @param comment [String] A comment describing why the payment is being requested.
+        # @return [Hash] The <wd:One-Time_Payment_Data> component.
+        def one_time_payment_data(employee_number, comment)
+          {
+            'One-Time_Payment_Data' => {
+              **Helpers.team_member_reference(employee_number),
+              **effective_date,
+              **one_time_payment_sub_data(comment)
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/peoplegroup/connectors/xml.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_rel 'xml'
+require_rel 'models/objectified_hash'
+
+module PeopleGroup::Connectors
+  module XML
+    include GetOrganizations
+    include RequestOneTimePayment
+
+    # Rename Objectified hash for ease of use.
+    ObjectifiedHash = PeopleGroup::Connectors::Models::ObjectifiedHash
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peoplegroup-connectors
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.1
 platform: ruby
 authors:
 - lien van den steen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +248,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  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: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -263,10 +291,15 @@ files:
 - lib/peoplegroup/connectors/google_sheets.rb
 - lib/peoplegroup/connectors/greenhouse.rb
 - lib/peoplegroup/connectors/hris.rb
+- lib/peoplegroup/connectors/models/objectified_hash.rb
 - lib/peoplegroup/connectors/pto_roots.rb
 - lib/peoplegroup/connectors/slack.rb
 - lib/peoplegroup/connectors/version.rb
 - lib/peoplegroup/connectors/workday.rb
+- lib/peoplegroup/connectors/xml.rb
+- lib/peoplegroup/connectors/xml/get_organizations.rb
+- lib/peoplegroup/connectors/xml/helpers.rb
+- lib/peoplegroup/connectors/xml/request_one_time_payment.rb
 - lib/peoplegroup/utils.rb
 homepage: https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem
 licenses:
@@ -283,14 +316,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Library for our shared connectors.