peoplegroup-connectors 0.4.7 → 1.0.1

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

data/lib/peoplegroup/connectors/workday.rb

@@ -1,201 +1,11 @@
 # frozen_string_literal: true
 
-require 'savon'
-require_rel 'xml'
-
 module PeopleGroup
   module Connectors
-    class Workday
-      include XML
-      attr_accessor :staffing_client, :compensation_client, :subdomain, :tenant
-
-      # Current Workday API Version
-      API_VERSION = 'v37.0'
-
-      EmployeeNotFoundError = Class.new(StandardError)
-
-      def initialize
-        @subdomain = ENV['WORKDAY_SUBDOMAIN']
-        @tenant = ENV['WORKDAY_TENANT']
-        @api_base_path = "https://#{@subdomain}.#{ENV['WORKDAY_BASE_URL']}.com/ccx/service"
-        @isu_username = ENV['WORKDAY_ISU_USERNAME']
-        @isu_password = ENV['WORKDAY_ISU_PASSWORD']
-
-        soap_debug_logs_enabled = ENV['WORKDAY_SOAP_DEBUG_LOGS'] == 'true'
-        options = {
-          log: soap_debug_logs_enabled,
-          pretty_print_xml: soap_debug_logs_enabled
-        }
-
-        @staffing_client = client('Staffing', options)
-        @compensation_client = client('Compensation', options)
-      end
-
-      def workers
-        @workers ||= safe_report(report_name: ENV['WORKDAY_WORKERS_REPORT'])
-      end
-
-      def eligibility_status(work_email, salary_min, salary_max)
-        params = {
-          WorkEmail: work_email,
-          Salary_Min: salary_min,
-          Salary_Max: salary_max
-        }
-        safe_report(report_name: ENV['WORKDAY_ELIGIBILITY_REPORT'], params: params)&.first
-      end
-
-      # Grabs manager history for the specified team member or all team members.
-      # @return <PeopleGroup::Connectors::Models::ObjectifiedHash>
-      #   keys:
-      #         employeeNumber - The team members employee number.
-      #         hireDate - The team members hireDate or transition date.
-      #         supervisorId - The team members future manager ID.
-      #         previousManagerId - The team members previous manager id.
-      #         department - The team members upcoming department
-      #         division - The team members upcoming division.
-      #         managerChangeGroup - This will always be nil.
-      def manager_history(employee_number = nil)
-        options = { report_name: ENV['WORKDAY_MANAGER_REPORT'] }
-        options[:params] = { 'Employee_ID' => employee_number } unless employee_number.nil?
-
-        resp = safe_report(**options).first
-        change_group = resp[:JOB_INFO_group]
-        reformatted = {
-          **resp.hash.except(:JOB_INFO_group),
-          'transitionDate' => change_group.first['transitionDate'],
-          'supervisorId' => change_group.first['supervisorId'],
-          'jobTitle' => change_group.first['jobTitle'],
-          'department' => change_group.first['department'],
-          'division' => change_group.first['division'],
-          'previousManagerId' => change_group[1]['supervisorId'],
-          'previousJobTitle' => change_group[1]['jobTitle']
-        }
-
-        ObjectifiedHash.new(reformatted)
-      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 RestClient::InternalServerError => e
-        pp "Encountered an error when accessing report from Workday.\nArgs: #{args}"
-        raise e
-      rescue StandardError => e
-        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 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
-          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
-
-          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
-
-          if page == 1
-            data = partial_data
-          else
-            data.concat(partial_data)
-          end
-
-          break if page == total_pages
-
-          page += 1
-        end
-
-        data
-      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
-
-      # 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
+    module Workday; end
   end
 end
+
+require_relative 'workday/client'
+require_relative 'workday/report'
+require_relative 'workday/xml'

data/lib/peoplegroup/connectors.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require 'require_all'
-require_rel 'utils'
-require_rel 'connectors'
+require_relative 'utils'
+
+# include the 'connectors' directory.
+Dir.glob(File.join(File.dirname(__FILE__), 'connectors', '**', '*.rb')).each { |x| require(x) }
 
 module PeopleGroup
   module Connectors
-    class Error < StandardError; end
+    Error = Class.new(StandardError)
   end
 end

metadata

@@ -1,85 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: peoplegroup-connectors
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 1.0.1
 platform: ruby
 authors:
 - lien van den steen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2023-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gitlab
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: google_drive
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: slack-ruby-client
+  name: bamboozled-gitlab
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.2.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.2.14
 - !ruby/object:Gem::Dependency
-  name: splinter-pto
+  name: gitlab
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bamboozled-gitlab
+  name: google_drive
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.14
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: greenhouse_io-gitlab
   requirement: !ruby/object:Gem::Requirement
@@ -123,159 +95,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.12.1
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.91'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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: '7.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '7.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-packaging
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.44'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.44'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: splinter-pto
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
+        version: '0.1'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '0.1'
 description: Avoid repeating methods in different projects for our connectos.
 email:
 - lvandensteen@gitlab.com
@@ -291,15 +137,16 @@ 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/connectors/workday/client.rb
+- lib/peoplegroup/connectors/workday/report.rb
+- lib/peoplegroup/connectors/workday/xml.rb
+- lib/peoplegroup/connectors/workday/xml/get_organizations.rb
+- lib/peoplegroup/connectors/workday/xml/helpers.rb
+- lib/peoplegroup/connectors/workday/xml/request_one_time_payment.rb
 - lib/peoplegroup/utils.rb
 homepage: https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem
 licenses:
@@ -308,6 +155,7 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem
   source_code_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem
   changelog_uri: https://gitlab.com/gitlab-com/people-group/peopleops-eng/connectors-gem
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,105 +0,0 @@
-# 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)
-            @data[key.to_s] = value
-            @hash[key.to_sym] = value
-            self.class.send(:attr_reader, key) # rubocop:disable GitlabSecurity/PublicSend
-          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
-
-        def except(*args)
-          args.each do |key|
-            @data.delete(key.to_s)
-            @hash.delete(key.to_sym)
-            instance_variable_set("@#{key}", nil)
-          end
-          self
-        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] || @hash[key.to_sym]
-        end
-
-        # Allows us to override the json data
-        def []=(key, value)
-          sym = key.to_sym
-          str = key.to_s
-          @data[str] = value if @data[str]
-          @hash[sym] = value if @hash[sym]
-        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