peoplegroup-connectors 0.4.7 → 1.0.0

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

@@ -1,84 +0,0 @@
-# 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

@@ -1,72 +0,0 @@
-# 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

@@ -1,103 +0,0 @@
-# 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

@@ -1,14 +0,0 @@
-# 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