peoplegroup-connectors 0.1.96 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf603701e7dc27da76fcc61f2a8a4047133e7933ea58ec0f2549efb1d709afe
-  data.tar.gz: 8e600b62d801d284c831fb69fd55430d9322594b355ce5a65fe1cca335c387ff
+  metadata.gz: 52119b48d43178c73a802c6eb5361c052447bd6ee72a5a2a6d48b7fac5d19b41
+  data.tar.gz: 61af8cffaa0bbd000489f8ff493147bfbf2f7ffbd6e67a3daa93189f11305e2f
 SHA512:
-  metadata.gz: abd0763536f8eeeb9769e8ee5c2996e27ea459194613ab3e8bb6db249feb9620fc0a283f01e791adb9ecb04638775dd75ff33a37fbc7a957dfd38dff5d449a76
-  data.tar.gz: 07d010c5b8c01fbcfa8e2bc84e741280034974ce4e7499027f488c2af4ea0b190bfbffe55a61073a6db3a673d24a5a23c41a4209ed4cac708821c732fe74e174
+  metadata.gz: 4b5baabf6fa07a5e8c4c080682afddc5145d9419ece8d4c5df4b07f17ffdc0cbbd2ab1569148d136b749af31b0e03594e71ab936a0cf33b7e52e786d8bb25bcc
+  data.tar.gz: 331e0a2ecd5514ee3ed39a351d4c91fb4d7d3ac12c7a11227199810854a92324cf501d4ca18958ce2ca22719664927a5db504fff16cde6a88a2f00007974b545

data/README.md

@@ -31,6 +31,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
+For local development and manual testing, copy the contents of the `.env.example` file to a new file called `.env` and fill-in the environment variable values. You will then be able to run a REPL by running `bundle exec bin/console` from the root of the repository.
+
 ## 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.

data/lib/peoplegroup/connectors/bamboo.rb

@@ -15,16 +15,21 @@ module PeopleGroup
       end
 
       def get_employee_details(id)
-        employees.find { |emp| emp['id'] == id.to_s }
+        employees.find { |emp| emp['employeeNumber'] == id.to_s }
       end
       alias_method :get_team_member_details, :get_employee_details
 
       def get_employee_details!(id)
         employee_details = get_employee_details(id)
-        raise EmployeeNotFoundError, "No employee found with id #{id}" if employee_details.nil?
+        raise EmployeeNotFoundError, "No team member found with employee number #{id}" if employee_details.nil?
 
         employee_details
       end
+      alias_method :get_team_member_details!, :get_employee_details!
+
+      def bamboo_id!(employee_number)
+        get_team_member_details!(employee_number)['id']
+      end
 
       def search_employee(name)
         return if name.empty?
@@ -109,7 +114,7 @@ module PeopleGroup
 
       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['id'])
+          (departments.include?(team_member['department']) || divisions.include?(team_member['division'])) && has_direct_reports?(team_member['employeeNumber'])
         end
       end
 
@@ -119,17 +124,17 @@ module PeopleGroup
         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['id']))
+          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['supervisorEId'] == id.to_s }
+        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['supervisorEId'] == id.to_s }
+        active_and_current_team_members.any? { |team_member| team_member['supervisorId'] == id.to_s }
       end
 
       def reports_in_departments(departments, exclude_email)
@@ -149,17 +154,26 @@ module PeopleGroup
       def create_employee(employee_details_hash)
         retry_on_error { @client.employee.add(employee_details_hash) }
       end
+      alias_method :create_team_member, :create_employee
 
-      def update_employee(employee_id, employee_details_hash)
-        retry_on_error { @client.employee.update(employee_id, employee_details_hash) }
+      def update_employee(employee_number, employee_details_hash)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.update(id, employee_details_hash) }
       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' } || []
+        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' } || []
+        meta_fields
+          .detect { |res| res['name'] == 'Division' }
+          .dig('options')
+          .each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
       end
 
       def locations
@@ -199,30 +213,36 @@ module PeopleGroup
       end
       alias_method :active_and_current_team_members, :active_and_current_employees
 
-      def add_stock_options(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customEquity', data) }
+      def add_stock_options(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customEquity', data) }
       end
 
-      def stock_options_data(employee_id)
-        retry_on_error { @client.employee.table_data(employee_id, 'customEquity') }
+      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_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'jobInfo', data) }
+      def add_job_details(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'jobInfo', data) }
       end
 
-      def update_job_details(employee_id, data)
-        current_data = job_details(employee_id) # it should only be one row as we just created this user
+      def update_job_details(employee_number, data)
+        id = bamboo_id!(employee_number)
+        current_data = job_details(employee_number) # it should only be one row as we just created this user
         row_id = current_data.first.dig('id')
-        retry_on_error { @client.employee.update_table_row(employee_id, 'jobInfo', row_id, data) }
+        retry_on_error { @client.employee.update_table_row(id, 'jobInfo', row_id, data) }
       end
 
-      def add_compensation_details(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'compensation', data) }
+      def add_compensation_details(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'compensation', data) }
       end
 
-      def employment_statuses(employee_id)
-        retry_on_error { @client.employee.table_data(employee_id, 'employmentStatus') }
+      def employment_statuses(employee_number)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.table_data(id, 'employmentStatus') }
       end
 
       def time_off_types
@@ -233,17 +253,19 @@ module PeopleGroup
         time_off_types['timeOffTypes'].find { |type| type['name'] == name }
       end
 
-      def time_off_estimate(employee_id, end_date = Date.today)
-        retry_on_error { @client.employee.time_off_estimate(employee_id, end_date) }
+      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_id, options)
-        retry_on_error { @client.employee.time_off_balance_adjustment(employee_id, options) }
+      def time_off_adjustment(employee_number, options)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.time_off_balance_adjustment(id, options) }
       end
 
-      def accrued_days(employee_id)
+      def accrued_days(employee_number)
         employee_accruals_type = time_off_type('Employee Accruals')
-        total_accruals = time_off_estimate(employee_id).find { |type| type['timeOffType'] == employee_accruals_type['id'] }
+        total_accruals = time_off_estimate(employee_number).find { |type| type['timeOffType'] == employee_accruals_type['id'] }
 
         total_accruals['balance'].to_f
       end
@@ -252,75 +274,88 @@ module PeopleGroup
         @time_off_policies ||= retry_on_error { @client.meta.time_off_policies }
       end
 
-      def employee_time_off_policies(employee_id)
-        retry_on_error { @client.employee.time_off_policies(employee_id) }
+      def employee_time_off_policies(employee_number)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.time_off_policies(id) }
       end
       alias_method :team_member_time_off_policies, :employee_time_off_policies
 
-      def add_time_off_policy(employee_id, time_off_policy_id, accrual_start_date)
+      def add_time_off_policy(employee_number, time_off_policy_id, accrual_start_date)
         policies = [{ timeOffPolicyId: time_off_policy_id, accrualStartDate: accrual_start_date }]
+        id = bamboo_id!(employee_number)
 
-        retry_on_error { @client.employee.add_time_off_policies(employee_id, policies) }
+        retry_on_error { @client.employee.add_time_off_policies(id, policies) }
       end
 
-      def remove_time_off_policy(employee_id, time_off_policy_id)
+      def remove_time_off_policy(employee_number, time_off_policy_id)
         # A nil accrual start date removes a policy assignment
         # Reference: https://documentation.bamboohr.com/reference#time-off-assign-time-off-policies-for-an-employee
-        add_time_off_policy(employee_id, time_off_policy_id, nil)
+        add_time_off_policy(employee_number, time_off_policy_id, nil)
       end
 
-      def job_details(employee_id)
-        retry_on_error { @client.employee.table_data(employee_id, 'jobInfo') }
+      def job_details(employee_number)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.table_data(id, 'jobInfo') }
       end
 
-      def resumes_folder_id(employee_id)
-        @resumes_folder_id ||= files(employee_id).dig('categories').find { |folder| folder['name'] == 'Resumes and Applications' }.dig('id')
+      def resumes_folder_id(employee_number)
+        @resumes_folder_id ||= files(employee_number).dig('categories').find { |folder| folder['name'] == 'Resumes and Applications' }.dig('id')
       end
 
-      def contract_folder_id(employee_id)
-        @contract_folder_id ||= files(employee_id).dig('categories').find { |folder| folder['name'] == 'Contracts & Changes' }.dig('id')
+      def contract_folder_id(employee_number)
+        @contract_folder_id ||= files(employee_number).dig('categories').find { |folder| folder['name'] == 'Contracts & Changes' }.dig('id')
       end
 
-      def add_file(employee_id, file_name, file, folder_id)
+      def add_file(employee_number, file_name, file, folder_id)
+        id = bamboo_id!(employee_number)
+
         options = {
           category: folder_id,
           fileName: file_name,
           share: 'yes',
           file: file
         }
-        retry_on_error { @client.employee.add_file(employee_id, options) }
+        retry_on_error { @client.employee.add_file(id, options) }
       end
 
-      def add_employment_status(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'employmentStatus', data) }
+      def add_employment_status(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'employmentStatus', data) }
       end
 
-      def add_currency_conversion(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customCurrencyConversion', data) }
+      def add_currency_conversion(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customCurrencyConversion', data) }
       end
 
-      def add_on_target_earnings(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customOnTargetEarnings', data) }
+      def add_on_target_earnings(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customOnTargetEarnings', data) }
       end
 
-      def add_signing_bonus(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customBonus', data) }
+      def add_signing_bonus(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customBonus', data) }
       end
 
-      def add_family_member(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customFamilyMember', data) }
+      def add_family_member(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customFamilyMember', data) }
       end
 
-      def add_additional_data(employee_id, data)
-        retry_on_error { @client.employee.add_table_row(employee_id, 'customAdditionalInformation1', data) }
+      def add_additional_data(employee_number, data)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.add_table_row(id, 'customAdditionalInformation1', data) }
       end
 
-      def additional_data(employee_id)
-        retry_on_error { @client.employee.table_data(employee_id, 'employmentStatus') }
+      def additional_data(employee_number)
+        id = bamboo_id!(employee_number)
+        retry_on_error { @client.employee.table_data(id, 'employmentStatus') }
       end
 
-      def currency_conversion(employee_id)
-        retry_on_error { @client.employee.table_data(employee_id, 'customCurrencyConversion') }
+      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)
@@ -350,8 +385,9 @@ module PeopleGroup
         @meta_fields ||= retry_on_error { @client.meta.lists }
       end
 
-      def files(employee_id)
-        @files ||= retry_on_error { @client.employee.files(employee_id) }
+      def files(employee_number)
+        id = bamboo_id!(employee_number)
+        @files ||= retry_on_error { @client.employee.files(id) }
       end
 
       def retry_on_error(&block)

data/lib/peoplegroup/connectors/hris.rb

@@ -14,14 +14,14 @@ module PeopleGroup
         @workday.workers.map { |worker| format_worker(worker) }
       end
 
-      def get_employee_details(id)
-        employees.find { |emp| emp['id'] == id.to_s }
+      def get_employee_details(employee_number)
+        employees.find { |emp| emp['employeeNumber'] == employee_number.to_s }
       end
       alias_method :get_team_member_details, :get_employee_details
 
-      def get_employee_details!(id)
-        employee_details = get_employee_details(id)
-        raise EmployeeNotFoundError, "No employee found with id #{id}" if employee_details.nil?
+      def get_employee_details!(employee_number)
+        employee_details = get_employee_details(employee_number)
+        raise EmployeeNotFoundError, "No team member found with employee number #{employee_number}" if employee_details.nil?
 
         employee_details
       end
@@ -33,7 +33,7 @@ module PeopleGroup
         return nil if worker.nil?
 
         {
-          'id' => worker.dig(:worker_data, :worker_id),
+          '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),

data/lib/peoplegroup/connectors/version.rb

@@ -2,6 +2,6 @@
 
 module PeopleGroup
   module Connectors
-    VERSION = '0.1.96'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peoplegroup-connectors
 version: !ruby/object:Gem::Version
-  version: 0.1.96
+  version: 0.2.0
 platform: ruby
 authors:
 - lien van den steen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -150,34 +150,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.91'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: gitlab-styles
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.6'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.6'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
 description: Avoid repeating methods in different projects for our connectos.
 email:
 - lvandensteen@gitlab.com
@@ -262,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Library for our shared connectors.