genesis_ruby 0.1.5 → 0.1.7

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/airline_itinerary_attributes.rb

@@ -0,0 +1,166 @@
+require 'genesis_ruby/utils/transactions/travel_data/airline_itinerary/leg'
+require 'genesis_ruby/utils/transactions/travel_data/airline_itinerary/tax'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module TravelData
+            # Level 3 Data Airline Itinerary Attributes
+            module AirlineItineraryAttributes
+
+              attr_reader :travel_aid_restricted_ticket_indicator, :travel_aid_ticket_number,
+                          :travel_aid_passenger_name, :travel_aid_customer_code, :travel_aid_issuing_carrier,
+                          :travel_aid_agency_name, :travel_aid_agency_code
+              attr_accessor :travel_aid_total_fare, :travel_aid_confirmation_information
+
+              # Date Of Issue
+              def travel_aid_date_of_issue
+                @travel_aid_date_of_issue&.strftime GenesisRuby::Api::Constants::DateTimeFormats::DD_MM_YYYY_L_HYPHENS
+              end
+
+              # Date Of Issue
+              def travel_aid_date_of_issue=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Restricted Ticket Indicator
+              def travel_aid_restricted_ticket_indicator=(value)
+                allowed_options attribute: __method__, value: value.to_i, allow_empty: true, allowed: [0, 1]
+              end
+
+              # Ticket Number
+              def travel_aid_ticket_number=(value)
+                limited_string attribute: __method__, value: value, max: 15
+              end
+
+              # Passenger name
+              def travel_aid_passenger_name=(value)
+                limited_string attribute: __method__, value: value, max: 29
+              end
+
+              # Customer code
+              def travel_aid_customer_code=(value)
+                limited_string attribute: __method__, value: value, max: 17
+              end
+
+              # Issuing carrier
+              def travel_aid_issuing_carrier=(value)
+                limited_string attribute: __method__, value: value, max: 4
+              end
+
+              # Agency name
+              def travel_aid_agency_name=(value)
+                limited_string attribute: __method__, value: value, max: 30
+              end
+
+              # Agency code
+              def travel_aid_agency_code=(value)
+                limited_string attribute: __method__, value: value, max: 8
+              end
+
+              # AirlineItinerary Legs data. Max legs 10
+              def travel_aid_legs
+                @travel_aid_legs || []
+              end
+
+              # AirlineItinerary Taxes data. Max taxes 10
+              def travel_aid_taxes
+                @travel_aid_taxes || []
+              end
+
+              # Add a single AirlineItinerary Leg data
+              def add_travel_aid_leg(leg)
+                @travel_aid_legs ||= travel_aid_legs
+                leg_obj      = GenesisRuby::Utils::Transactions::TravelData::AirlineItinerary::Leg
+
+                raise InvalidArgumentError, "Leg must be instance of #{leg_obj.name}" unless leg.instance_of? leg_obj
+
+                if travel_aid_legs.count == ALLOWED_ITEMS_COUNT
+                  raise InvalidArgumentError, "Allowed Legs count exceeded. Allowed #{ALLOWED_ITEMS_COUNT}."
+                end
+
+                @travel_aid_legs.push leg
+              end
+
+              # Add a single AirlineItinerary Tax data
+              def add_travel_aid_tax(tax)
+                @travel_aid_taxes ||= travel_aid_taxes
+                tax_obj       = GenesisRuby::Utils::Transactions::TravelData::AirlineItinerary::Tax
+
+                raise InvalidArgumentError, "Tax must be instance of #{tax_obj.name}" unless tax.instance_of? tax_obj
+
+                if travel_aid_taxes.count == ALLOWED_ITEMS_COUNT
+                  raise InvalidArgumentError, "Allowed Legs count exceeded. Allowed #{ALLOWED_ITEMS_COUNT}."
+                end
+
+                @travel_aid_taxes.push tax
+              end
+
+              # Reset Legs data
+              def clear_travel_aid_legs
+                @travel_aid_legs = []
+              end
+
+              # Reset Taxes
+              def clear_travel_aid_taxes
+                @travel_aid_taxes = []
+              end
+
+              protected
+
+              ALLOWED_ITEMS_COUNT = 10
+
+              # Legs structure
+              def legs_structure
+                parse_items 'leg', travel_aid_legs
+              end
+
+              # Taxes structure
+              def taxes_structure
+                parse_items 'tax', travel_aid_taxes
+              end
+
+              # Prepare structure
+              def parse_items(node_name, items)
+                data = []
+
+                items.each do |item|
+                  item.currency = currency if item.respond_to?(:currency) && respond_to?(:currency)
+                  data.push item.attributes_structure
+                end
+
+                Hash[node_name.to_sym, data]
+              end
+
+              # Attributes Structure
+              def airline_attributes_structure # rubocop:disable RSpec/MethodLength
+                {
+                  ticket_number:               travel_aid_ticket_number,
+                  passenger_name:              travel_aid_passenger_name,
+                  customer_code:               travel_aid_customer_code,
+                  restricted_ticket_indicator: travel_aid_restricted_ticket_indicator,
+                  issuing_carrier:             travel_aid_issuing_carrier,
+                  total_fare:                  parse_total_fare,
+                  agency_name:                 travel_aid_agency_name,
+                  agency_code:                 travel_aid_agency_code,
+                  confirmation_information:    travel_aid_confirmation_information,
+                  date_of_issue:               travel_aid_date_of_issue
+                }
+              end
+
+              # Parse Total Fare amount
+              def parse_total_fare
+                return travel_aid_total_fare if currency.nil? || travel_aid_total_fare.nil?
+
+                transform_amount travel_aid_total_fare, currency
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/car_rental_attributes.rb

@@ -0,0 +1,119 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module TravelData
+            # Car Rental attributes
+            module CarRentalAttributes
+
+              attr_reader :travel_car_rental_purchase_identifier, :travel_car_rental_class_id,
+                          :travel_car_rental_renter_name, :travel_car_rental_return_city,
+                          :travel_car_rental_return_state, :travel_car_rental_return_country,
+                          :travel_car_rental_renter_return_location_id, :travel_car_rental_customer_code,
+                          :travel_car_rental_extra_charges, :travel_car_rental_no_show_indicator
+
+              # Travel Data Purchase Identifier
+              def travel_car_rental_purchase_identifier=(value)
+                limited_string attribute: __method__, value: value, max: 9
+              end
+
+              # Travel Data Class id
+              def travel_car_rental_class_id=(value)
+                allowed_options attribute: __method__,
+                                value: value.to_i,
+                                allow_empty: true,
+                                allowed: [*1..30].push(9999)
+              end
+
+              # Travel Data PickUp Date
+              def travel_car_rental_pickup_date
+                @travel_car_rental_pickup_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::
+                    DD_MM_YYYY_L_HYPHENS
+              end
+
+              # Travel Data PickUp Date
+              def travel_car_rental_pickup_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Travel Data Renter Name
+              def travel_car_rental_renter_name=(value)
+                limited_string attribute: __method__, value: value, max: 20
+              end
+
+              # Travel Data Return City
+              def travel_car_rental_return_city=(value)
+                limited_string attribute: __method__, value: value, max: 18
+              end
+
+              # Travel Data Return State
+              def travel_car_rental_return_state=(value)
+                limited_string attribute: __method__, value: value, max: 3
+              end
+
+              # Travel Data Return Country
+              def travel_car_rental_return_country=(value)
+                limited_string attribute: __method__, value: value, max: 3
+              end
+
+              # Travel Data Return Date
+              def travel_car_rental_return_date
+                @travel_car_rental_return_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::
+                    DD_MM_YYYY_L_HYPHENS
+              end
+
+              # Travel Data Return Date
+              def travel_car_rental_return_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Travel Data Renter Return Location id
+              def travel_car_rental_renter_return_location_id=(value)
+                limited_string attribute: __method__, value: value, max: 10
+              end
+
+              # Travel Data Customer Code
+              def travel_car_rental_customer_code=(value)
+                limited_string attribute: __method__, value: value, max: 17
+              end
+
+              # Travel Data Extra Charges
+              def travel_car_rental_extra_charges=(value)
+                allowed_options attribute: __method__, value: value.to_i, allow_empty: true, allowed: [*1..5]
+              end
+
+              # Travel Data No Show Indicator
+              def travel_car_rental_no_show_indicator=(value)
+                allowed_options attribute: __method__, value: value.to_i, allow_empty: true, allowed: [0, 1]
+              end
+
+              protected
+
+              # Travel Data Car Rental Attributes Structure
+              def car_rental_attributes_structure # rubocop:disable Metrics/MethodLength
+                {
+                  car_rental: {
+                    purchase_identifier:       travel_car_rental_purchase_identifier,
+                    class_id:                  travel_car_rental_class_id,
+                    pickup_date:               travel_car_rental_pickup_date,
+                    renter_name:               travel_car_rental_renter_name,
+                    return_city:               travel_car_rental_return_city,
+                    return_state:              travel_car_rental_return_state,
+                    return_country:            travel_car_rental_return_country,
+                    return_date:               travel_car_rental_return_date,
+                    renter_return_location_id: travel_car_rental_renter_return_location_id,
+                    customer_code:             travel_car_rental_customer_code,
+                    extra_charges:             travel_car_rental_extra_charges,
+                    no_show_indicator:         travel_car_rental_no_show_indicator
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/hotel_rental_attributes.rb

@@ -0,0 +1,77 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module TravelData
+            # Hotel Rental Attributes
+            module HotelRentalAttributes
+
+              attr_reader :travel_hotel_rental_purchase_identifier, :travel_hotel_rental_customer_code,
+                          :travel_hotel_rental_extra_charges, :travel_hotel_rental_no_show_indicator
+
+              # Hotel Rental Purchase Identifier
+              def travel_hotel_rental_purchase_identifier=(value)
+                limited_string attribute: __method__, value: value, max: 10
+              end
+
+              # Travel Data Arrival date
+              def travel_hotel_rental_arrival_date
+                @travel_hotel_rental_arrival_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::
+                    DD_MM_YYYY_L_HYPHENS
+              end
+
+              # Travel Data Arrival Date
+              def travel_hotel_rental_arrival_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Travel Data Departure date
+              def travel_hotel_rental_departure_date
+                @travel_hotel_rental_departure_date&.strftime GenesisRuby::Api::Constants::DateTimeFormats::
+                    DD_MM_YYYY_L_HYPHENS
+              end
+
+              # Travel Data Departure Date
+              def travel_hotel_rental_departure_date=(value)
+                parse_date attribute: __method__, value: value, allow_empty: true
+              end
+
+              # Travel Data Customer Code
+              def travel_hotel_rental_customer_code=(value)
+                limited_string attribute: __method__, value: value, max: 17
+              end
+
+              # Travel Data Extra Charges
+              def travel_hotel_rental_extra_charges=(value)
+                allowed_options attribute: __method__, value: value, allow_empty: true, allowed: [*2..7]
+              end
+
+              # Travel Data No Show Indicator
+              def travel_hotel_rental_no_show_indicator=(value)
+                allowed_options attribute: __method__, value: value, allow_empty: true, allowed: [0, 1]
+              end
+
+              protected
+
+              # Hotel Rental attributes structure
+              def hotel_rental_attributes_structure
+                {
+                  hotel_rental: {
+                    purchase_identifier: travel_hotel_rental_purchase_identifier,
+                    arrival_date:        travel_hotel_rental_arrival_date,
+                    departure_date:      travel_hotel_rental_departure_date,
+                    customer_code:       travel_hotel_rental_customer_code,
+                    extra_charges:       travel_hotel_rental_extra_charges,
+                    no_show_indicator:   travel_hotel_rental_no_show_indicator
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/reference_ticket_attributes.rb

@@ -0,0 +1,75 @@
+require 'genesis_ruby/api/constants/transactions/parameters/travel_data/ancillary_charges_types'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module TravelData
+            # Ancillary Charges
+            module ReferenceTicketAttributes
+
+              attr_reader :travel_ac_ticket_reference_id, :travel_ac_type, :travel_ac_ticket_document_number,
+                          :travel_ac_issued_with_ticket_number, :travel_ac_sub_type
+
+              # Ancillary Charges ticker reference id
+              def travel_ac_ticket_reference_id=(value)
+                limited_string attribute: __method__, value: value, max: 32
+              end
+
+              # Ancillary Charges Type
+              def travel_ac_type=(value)
+                allowed_options attribute:   __method__,
+                                value:       value.to_s.upcase,
+                                allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::TravelData::
+                                    AncillaryChargesTypes.all,
+                                allow_empty: true
+              end
+
+              # Ancillary Charges Ticket document number
+              def travel_ac_ticket_document_number=(value)
+                limited_string attribute: __method__, value: value, max: 15
+              end
+
+              # Ancillary Charges issued with ticket number
+              def travel_ac_issued_with_ticket_number=(value)
+                limited_string attribute: __method__, value: value, max: 15
+              end
+
+              # Ancillary Charges Sub Type
+              def travel_ac_sub_type=(value)
+                allowed_options attribute:   __method__,
+                                value:       value.to_s.upcase,
+                                allowed:     GenesisRuby::Api::Constants::Transactions::Parameters::TravelData::
+                                    AncillaryChargesTypes.all,
+                                allow_empty: true
+              end
+
+              protected
+
+              # Reference Ticket attributes structure
+              def reference_ticket_attributes_structure
+                {
+                  ticket_reference_id:       travel_ac_ticket_reference_id,
+                  ticket_document_number:    travel_ac_ticket_document_number,
+                  issued_with_ticket_number: travel_ac_issued_with_ticket_number
+                }
+              end
+
+              # Ancillary Charges attributes structure
+              def charges_attributes_structure
+                {
+                  charge: {
+                    type:     travel_ac_type,
+                    sub_type: travel_ac_sub_type
+                  }
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/financial/travel_data/travel_attributes.rb

@@ -0,0 +1,34 @@
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        module Financial
+          module TravelData
+            # Travel Data Attributes
+            module TravelAttributes
+
+              include TravelData::AirlineItineraryAttributes
+              include TravelData::CarRentalAttributes
+              include TravelData::HotelRentalAttributes
+              include TravelData::ReferenceTicketAttributes
+
+              protected
+
+              # Travel Data attributes structure
+              def travel_data_attributes_structure
+                {
+                  ticket:  airline_attributes_structure.merge(reference_ticket_attributes_structure),
+                  legs:    legs_structure,
+                  taxes:   taxes_structure,
+                  rentals: car_rental_attributes_structure.merge(hotel_rental_attributes_structure),
+                  charges: charges_attributes_structure
+                }
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/mixins/requests/wpf_reminders_attributes.rb

@@ -0,0 +1,59 @@
+require 'genesis_ruby/utils/options/reminder'
+
+module GenesisRuby
+  module Api
+    module Mixins
+      module Requests
+        # Settings for reminders sending when using the ’Pay Later’ feature
+        module WpfRemindersAttributes
+
+          attr_reader :reminder_language
+          attr_writer :reminders
+
+          # It must be a valid language abbreviation
+          def reminder_language=(value)
+            allowed_options attribute: __method__,
+                            allowed: Api::Constants::I18n.all,
+                            value: value.to_s.downcase,
+                            allow_empty: true
+          end
+
+          # Settings for a single reminder. Upto three reminders are allowed
+          def add_reminder(channel:, after:)
+            raise InvalidArgumentError, 'Reminders exceed the allowed count of 3.' if reminders.count >= 3
+
+            reminders << init_reminder(channel: channel, after: after)
+          end
+
+          protected
+
+          # Reminders structure
+          def reminders_structure
+            return reminders if reminders.empty?
+
+            reminders.map &:object_structure
+          end
+
+          private :reminders=
+
+          # Reminder Data Object
+          def init_reminder(channel:, after:)
+            reminder = Utils::Options::Reminder.new
+
+            reminder.channel = channel
+            reminder.after   = after.to_i
+
+            reminder
+          end
+
+          # The number of the sent reminders would be exactly as sent or configured and delivery failures could be
+          # handled on demand. Also there will be no reminders sent if the WPF is already completed
+          def reminders
+            @reminders ||= []
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/genesis_ruby/api/requests/financial/capture.rb

@@ -6,6 +6,7 @@ module GenesisRuby
         class Capture < Requests::Base::Reference
 
           include Mixins::Requests::Financial::Business::BusinessAttributes
+          include Mixins::Requests::Financial::TravelData::TravelAttributes
 
           protected
 
@@ -18,7 +19,8 @@ module GenesisRuby
           def reference_transaction_structure
             {
               reference_id:        reference_id,
-              business_attributes: business_attributes_structure
+              business_attributes: business_attributes_structure,
+              travel:              travel_data_attributes_structure
             }
           end
 

data/lib/genesis_ruby/api/requests/financial/cards/authorize.rb

@@ -23,6 +23,7 @@ module GenesisRuby
             include Mixins::Requests::Financial::ReferenceAttributes
             include Mixins::Requests::Financial::RiskAttributes
             include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::Financial::TravelData::TravelAttributes
 
             protected
 
@@ -55,7 +56,8 @@ module GenesisRuby
                 recurring_type:            recurring_type,
                 recurring_category:        recurring_category,
                 sca_params:                sca_attributes_structure,
-                managed_recurring:         managed_recurring_attributes_structure
+                managed_recurring:         managed_recurring_attributes_structure,
+                travel:                    travel_data_attributes_structure
               )
             end
 

data/lib/genesis_ruby/api/requests/financial/cards/authorize3d.rb

@@ -26,6 +26,7 @@ module GenesisRuby
             include Mixins::Requests::Financial::RiskAttributes
             include Mixins::Requests::Financial::ScaAttributes
             include Mixins::Requests::Financial::Threeds::Version2::CommonAttributes
+            include Mixins::Requests::Financial::TravelData::TravelAttributes
 
             # Specifies the recurring type of transaction
             def recurring_type=(value)
@@ -67,7 +68,8 @@ module GenesisRuby
                 recurring_category:        recurring_category,
                 sca_params:                sca_attributes_structure,
                 threeds_v2_params:         threeds_v2_common_attributes_structure,
-                managed_recurring:         managed_recurring_attributes_structure
+                managed_recurring:         managed_recurring_attributes_structure,
+                travel:                    travel_data_attributes_structure
               )
             end
 

data/lib/genesis_ruby/api/requests/financial/cards/sale.rb

@@ -22,6 +22,7 @@ module GenesisRuby
             include Mixins::Requests::Financial::ReferenceAttributes
             include Mixins::Requests::Financial::RiskAttributes
             include Mixins::Requests::Financial::ScaAttributes
+            include Mixins::Requests::Financial::TravelData::TravelAttributes
 
             protected
 
@@ -54,7 +55,8 @@ module GenesisRuby
                 recurring_type:            recurring_type,
                 recurring_category:        recurring_category,
                 sca_params:                sca_attributes_structure,
-                managed_recurring:         managed_recurring_attributes_structure
+                managed_recurring:         managed_recurring_attributes_structure,
+                travel:                    travel_data_attributes_structure
               )
             end
 

data/lib/genesis_ruby/api/requests/financial/cards/sale3d.rb

@@ -25,6 +25,7 @@ module GenesisRuby
             include Mixins::Requests::Financial::RiskAttributes
             include Mixins::Requests::Financial::ScaAttributes
             include Mixins::Requests::Financial::Threeds::Version2::CommonAttributes
+            include Mixins::Requests::Financial::TravelData::TravelAttributes
 
             # Specifies the recurring type of transaction
             def recurring_type=(value)
@@ -66,7 +67,8 @@ module GenesisRuby
                 recurring_category:        recurring_category,
                 sca_params:                sca_attributes_structure,
                 threeds_v2_params:         threeds_v2_common_attributes_structure,
-                managed_recurring:         managed_recurring_attributes_structure
+                managed_recurring:         managed_recurring_attributes_structure,
+                travel:                    travel_data_attributes_structure
               )
             end