peoplegroup-connectors 0.4.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcabbbbfd790a8c46fd6eda5b30e7a42962e6420e05db68413cd94a9f96537a1
-  data.tar.gz: 1049c26cf69b3b1e40c3ef3b2aabcfa83b4b6b9a10c3bb825f85abab37a47b89
+  metadata.gz: 3d996feff7137d07264509fcfe7f8bc3dcbd71eefd5d50fe87f09529c23eabba
+  data.tar.gz: bf3a847a3ecb13956246090be029241ba8965d3b69765a00afdf2cf6c8ba6172
 SHA512:
-  metadata.gz: fd37579dadad639d505686d349b8bf149159602aa07175758bd3c42554cfea3eaec4648569b720c7e5abf62c96ae0b75c4a77af091c4af540d1170b9ec266494
-  data.tar.gz: eda96caee25e0fa72511d939683fd87943c3439187aa55c9aa103614ddd0d811b2cd50c6888de95b2259109282803eae2c4467ed67ad417cb4ac99bc9d20099e
+  metadata.gz: 7e53ab3a7d2ac8609dbcfe770fb2a797c23053412dcacb52770c0a5ef177b1540543a5566e7ab7b75c83508b20e996b8b606a963ee56ac5700b64aaf1f3c8946
+  data.tar.gz: a1acda40d3c83d4428d146ea6e670aa2fd6cc0be663c87b2717cb806589cd9397a440e3aa98f5203516869eb8c01dbe0e0a8050d9f7af6d60f3037e10b6dad71

data/lib/peoplegroup/connectors/bamboo.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'bamboozled'
-require_rel 'models/objectified_hash'
 
 module PeopleGroup
   module Connectors
@@ -127,7 +126,7 @@ module PeopleGroup
       alias_method :update_team_member, :update_employee
 
       def locations
-        meta_fields.detect { |res| res['name'] == 'Location' }.dig('options').each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
+        meta_fields.detect { |res| res['name'] == 'Location' }['options'].each_with_object([]) { |option, array| array << option['name'] if option['archived'] == 'no' } || []
       end
 
       def employees
@@ -172,7 +171,7 @@ module PeopleGroup
       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')
+        row_id = current_data.first['id']
         retry_on_error { @client.employee.update_table_row(id, 'jobInfo', row_id, data) }
       end
 
@@ -231,11 +230,11 @@ module PeopleGroup
       end
 
       def resumes_folder_id(employee_number)
-        @resumes_folder_id ||= files(employee_number).dig('categories').find { |folder| folder['name'] == 'Resumes and Applications' }.dig('id')
+        @resumes_folder_id ||= files(employee_number)['categories'].find { |folder| folder['name'] == 'Resumes and Applications' }['id']
       end
 
       def contract_folder_id(employee_number)
-        @contract_folder_id ||= files(employee_number).dig('categories').find { |folder| folder['name'] == 'Contracts & Changes' }.dig('id')
+        @contract_folder_id ||= files(employee_number)['categories'].find { |folder| folder['name'] == 'Contracts & Changes' }['id']
       end
 
       def add_file(employee_number, file_name, file, folder_id)
@@ -344,16 +343,12 @@ module PeopleGroup
       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

data/lib/peoplegroup/connectors/gitlab.rb

@@ -14,24 +14,17 @@ module PeopleGroup
       end
 
       def find_gitlabber(field, query)
-        return if !query || query.empty?
-
-        possible_members = get_group_members('gitlab-com', query: query)
-        if field === :email
-          possible_members.first
-        else
-          possible_members.find { |team_member| team_member.public_send(field) === query }
-        end
+        find_gitlabber_on(field, query, 'gitlab-com')
       end
 
       def find_gitlabber_on(field, query, group)
         return if !query || query.empty?
 
         possible_members = get_group_members(group, query: query)
-        if field === :email
+        if field == :email
           possible_members.first
         else
-          possible_members.find { |team_member| team_member.public_send(field) === query }
+          possible_members.find { |team_member| team_member.public_send(field) == query }
         end
       end
 

data/lib/peoplegroup/connectors/hris.rb

@@ -7,12 +7,12 @@ module PeopleGroup
       EmployeeNotFoundError = Class.new(StandardError)
 
       def initialize
-        @workday = Workday.new
+        @workday = Workday::Client.new
         @bamboo = Bamboo.new
       end
 
       def employees
-        @employees ||= @workday.workers
+        @employees ||= Workday.workers
       end
       alias_method :team_members, :employees
 
@@ -85,7 +85,7 @@ module PeopleGroup
 
         team_members.find do |team_member|
           emails = [team_member['workEmail'], team_member['bestEmail'], team_member['homeEmail']]
-          emails.compact.any? { |match| email.casecmp(match) === 0 }
+          emails.compact.any? { |match| email.casecmp(match).zero? }
         end
       end
       alias_method :slack_email_lookup_with_fallback, :search_team_member_by_email
@@ -214,7 +214,8 @@ module PeopleGroup
       end
 
       def job_details(employee_number)
-        @workday.manager_history(employee_number)
+        warn '[DEPRECATED] PeopleGroup::Connectors::Hris#job_details, use a custom workday report instead.'
+        Workday::Report.call(url: ENV.fetch('WORKDAY_MANAGER_REPORT', nil))
       end
 
       def resumes_folder_id(employee_number)

data/lib/peoplegroup/connectors/slack.rb

@@ -49,7 +49,7 @@ module PeopleGroup
         options = {
           channel: channel,
           text: text,
-          as_user: true,
+          as_user: as_user,
           attachments: attachments,
           unfurl_links: false,
           thread_ts: thread_ts,

data/lib/peoplegroup/connectors/version.rb

@@ -2,6 +2,6 @@
 
 module PeopleGroup
   module Connectors
-    VERSION = '0.4.7'
+    VERSION = '1.0.0'
   end
 end

data/lib/peoplegroup/connectors/workday/client.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'savon'
+require_relative 'xml'
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      # Workday client
+      class Client
+        include XML::GetOrganizations
+        include XML::RequestOneTimePayment
+
+        XML_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'
+        }.freeze
+
+        # The client instance
+        attr_reader :instance
+
+        # Client Options
+        attr_reader :options
+
+        # service uri
+        attr_reader :uri
+
+        # Current Workday API Version
+        API_VERSION = 'v37.0'
+
+        EmployeeNotFoundError = Class.new(StandardError)
+        ClientError = Class.new(StandardError)
+
+        def initialize(options = {})
+          @options = {
+            url: ENV.fetch('WORKDAY_SERVICE_URL', nil),
+            username: ENV.fetch('WORKDAY_ISU_USERNAME', nil),
+            password: ENV.fetch('WORKDAY_ISU_PASSWORD', nil),
+            debug: ENV.fetch('WORKDAY_SOAP_DEBUG_LOGS', false)
+          }.merge!(options)
+
+          @uri = URI.parse(@options[:url])
+          @uri.query = nil
+
+          @instance = client(services)
+        rescue URI::InvalidURIError
+          raise ClientError, "Invalid service URI: #{uri}"
+        end
+
+        def retry_on_error(&block)
+          Utils.retry_on_error(errors: [Net::ReadTimeout], delay: 3, &block)
+        end
+
+        def call(operation_name, options = {}, &block)
+          response = @instance.call(operation_name, { **options, **attributes }, &block)
+          { **response.body, code: response.http.code }
+        rescue Savon::UnknownOperationError => e
+          raise ClientError.new(e), cause: nil
+        end
+
+        def auto_paginated_call(operation_name, options = {}, &block)
+          data = nil
+          page = 1
+
+          loop do
+            response = @instance.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
+
+            page = operation_result.dig(:response_results, :page).to_i
+            total_pages = operation_result.dig(:response_results, :total_pages).to_i
+
+            # The operation data hash contains only one key named after the Workday object(s) retrieved
+            # eg. worker
+            _object_label, partial_data = operation_result[:response_data].first
+
+            page == 1 ? data = partial_data : data.concat(partial_data)
+
+            break if page == total_pages
+
+            page += 1
+          end
+
+          data
+        end
+
+        # Check if workday debug is enabled for the instance.
+        def debug_enabled?
+          @options[:debug] ? true : false
+        end
+
+        # 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
+
+        # The respective XML Service WSDL URL
+        # https://wd2-impl-services1.workday.com/ccx/service/systemreport2/gitlab/Public_Web_Services
+        # @return [String] The combined url to access the service at
+        def wsdl_url
+          @wsdl_url ||= "#{@uri}/#{API_VERSION}?wsdl"
+        end
+
+        private
+
+        def username
+          @options[:username]
+        end
+
+        def password
+          @options[:password]
+        end
+
+        # The current tenant
+        def tenant
+          @tenant ||= @uri.path.split('/')[-2]
+        end
+
+        # Authentication for Soap web service
+        def wsse_auth
+          @wsse_auth ||= ["#{username}@#{tenant}", password]
+        end
+
+        # Enabled services from the service URL
+        # @return [String] Service or services joined with '+'. Example: 'Staffing' or 'Staffing+Compensation'
+        def services
+          @services ||= @uri.path.split('/')[-1] # .split('+')
+        end
+
+        # 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: debug_enabled?,
+            wsse_auth: wsse_auth,
+            pretty_print_xml: debug_enabled?,
+            convert_request_keys_to: :camelcase,
+            env_namespace: :env,
+            namespace_identifier: :wd,
+            wsdl: wsdl_url,
+            namespaces: XML_NAMESPACES
+          }.merge!(options)
+
+          Savon.client(**client_opts)
+        end
+      end
+    end
+  end
+end

data/lib/peoplegroup/connectors/workday/report.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      class ReportError < StandardError
+        def initialize(message = '', request = nil)
+          @request = request
+          @message = message
+          super(message)
+        end
+      end
+
+      # Report
+      class Report
+        # The authorization header used for the report.
+        attr_reader :auth_header
+
+        # The parsed URI of the report URL
+        attr_reader :uri
+
+        # Create a new report instance
+        # @param url [String] The report URL without any parameters.
+        # @raises [ReportError]
+        def initialize(url:, password: nil)
+          @uri = URI.parse(url)
+
+          # Ensure URI is properly read
+          raise ReportError, "Error with report URL: #{url}. Is this a valid URL?" unless @uri.scheme && @uri.host && @uri.path
+
+          @uri.query = nil # clear any query params
+
+          # Use provided password or search in env.
+          pass = password || ENV.fetch('WORKDAY_ISU_PASSWORD', nil)
+
+          raise ReportError, "No username provided for report: #{url}" if username.nil?
+          raise ReportError, "No password provided for report: #{url}" if pass.nil?
+
+          # Encode credentials
+          auth = Base64.strict_encode64("#{username}:#{pass}")
+
+          # Base64 Encode
+          @auth_header = { Authorization: "Basic  #{auth}" }
+        rescue URI::InvalidURIError
+          raise ReportError, "Invalid URI detected for report: '#{url}'."
+        end
+
+        # @param url [String] The report URL without any parameters
+        # @param prompts [Hash] Report input prompts/parameters.
+        # @return [Array|Hash] the JSON report response.
+        # @see run for more info.
+        def self.call(url:, password: nil, prompts: {})
+          new(url: url, password: password)&.run(prompts)
+        end
+
+        # Run the report with the given prompts
+        # @param [Hash] prompts The report key value pair of parameters or 'prompts' (as referred to in Workday).
+        # @return [Array|Hash] the JSON report response.
+        # @raise [StandardError] if the report returns with any status other than 200.
+        def run(prompts = {})
+          url = report_url(prompts)
+          RestClient.get(url, @auth_header) do |response, _req, _result|
+            # Raise a report error if we ran into any issues accessing the report
+            raise ReportError, inspect, response unless response&.code == 200
+
+            # parse the response body into JSON
+            json = JSON.parse(response.body)
+
+            # if return content of 'Report_Entry' or the whole set if key does not exist.
+            json['Report_Entry'] || json
+          end
+        end
+
+        # Extract username from URI path (needed for auth)
+        def username
+          @username ||= @uri.path.split('/')[-2]
+        end
+
+        # Combine the url and extra input parameters in an encoded format.
+        # @param [Hash] prompts The report prompts/parameters.
+        # @return [String] The @url (report url) combined with report type `?type='json'` and any extra parameters.
+        def report_url(prompts = {})
+          uri = @uri.clone # copy the URI object
+          params = prompts.merge!({ type: :json }) # ensure report format is always JSON
+          uri.query = URI.encode_www_form(params)
+          uri.to_s
+        end
+
+        # Inspect the Workday Report instance
+        def inspect
+          "#<#{self.class.name}:#{object_id} @uri='#{@uri}' @auth_header=#{@auth_header ? 'HIDDEN' : auth_header} @username=#{username}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      module XML
+        # GetOrganization operation.
+        # @see https://community.workday.com/sites/default/files/file-hosting/productionapi/Staffing/v37.2/Get_Organizations.html
+        module GetOrganizations
+          # 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 { |location| location[: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|
+              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
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      module XML
+        # Common wrapper components for Workday XML queries
+        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
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      module XML
+        # RequestOneTimePayment module
+        # Uses the [PeopleGroup::Connectors::Workday::Client] to add a bonus to the speified team member.
+        # @see https://community.workday.com/sites/default/files/file-hosting/productionapi/Compensation/v37.0/Request_One-Time_Payment.html
+        module RequestOneTimePayment
+          # 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
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'xml/get_organizations'
+require_relative 'xml/request_one_time_payment'
+
+module PeopleGroup
+  module Connectors
+    module Workday
+      module XML; end
+    end
+  end
+end