ruby-hotfile 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ada4084e4841bb645fec91e314bc2abb8739f2d71da8ed07ea78ce7f4bd540f
+  data.tar.gz: dfd9412ca7eeacc2aed6a67023f880f0df49d4c61486511073584a48c73ef06b
+SHA512:
+  metadata.gz: 160bc7ab8ec531549bb156784ad5e9c3f362dcc1b29ebaa9017808911c10eae3d25bfdab3b6864c709efe8b19d1f63c03f43ee31152b0c12925c08aa37ea93f5
+  data.tar.gz: 3627b9d28611ce72d127f453db1aa1f098e90e94e031e9b691df7dfceaecd3ebbd324a899ee214558e7bc820792ad5fa63cf5decd30bb75fe176cb77ca8592c4

data/lib/hotfile/date.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Hotfile
+  # Parses a string date into a Date object
+  class Date
+    require 'date'
+
+    def initialize(date_string)
+      @raw_value = date_string.to_s.strip
+    end
+
+    def to_date
+      return nil if @raw_value.delete('0') == ''
+
+      case @raw_value.length
+        when 0 then nil
+        when 5 then ::Date.strptime(@raw_value, '%d%b')
+        when 6 then ::Date.strptime(@raw_value, '%y%m%d')
+        when 7 then ::Date.strptime(@raw_value, '%d%b%y')
+        when 8 then ::Date.strptime(@raw_value, '%Y%m%d')
+        else raise NotImplementedError("Unknown date format: #{@raw_value}")
+      end
+    end
+  end
+end

data/lib/hotfile/integer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Hotfile
+  # Parses a string integer (possibly overpunched) into a real Integer
+  class Integer
+    def initialize(int_string)
+      @raw_value = +int_string
+    end
+
+    def to_i
+      temp_string = @raw_value.clone
+      overpunch_char = temp_string[-1]
+      last_digit = case overpunch_char
+                     when '{', '}' then 0
+                     when /[0-9]/ then overpunch_char.to_i
+                     when /[A-I]/ then overpunch_char.unpack1('c') - 64
+                     when /[J-R]/ then overpunch_char.unpack1('c') - 73
+                   end
+      temp_string[-1] = last_digit.to_s
+      temp_string = "-#{temp_string}" if negative?
+      temp_string.to_i
+    end
+
+    def negative?
+      '}JKLMNOPQR'.include? @raw_value[-1]
+    end
+  end
+end

data/lib/hotfile/parser.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class Hotfile
+  ## Functions for parsing HOT file data
+  module Parser
+    def parse
+      return if @file.nil?
+
+      records = @file.lines(chomp: true).map { |line| parse_line line }
+      @parse ||= {
+        records: records,
+        date: records.map { |x| x[:date] }.compact.first,
+        doc_nr: records.map { |x| x[:doc_nr] }.compact.first,
+        transactions: records.map { |x| x[:transaction] }.compact.uniq.count
+      }
+    end
+
+    def unparsable
+      parse[:records].select! { |x| x[:data].nil? }
+    end
+
+    def parse_line(line)
+      code1, line_number, code2, payload = line.scan(/([A-Z]{3})(\d{8})(\d{2})(.*)/).flatten
+      code = code1 + code2
+      line_number = line_number.to_i
+
+      if (10..81).include? code2.to_i
+        date, transaction, doc_nr, check_digit, payload =
+          payload.scan(/
+            (\d{6})
+            (\d{6})
+            ([A-Z0-9 ]{14})
+            (\d)
+            (.*)
+          /x).flatten
+      end
+
+      begin
+        record_parser = Hotfile::Record.const_get(code)
+      rescue NameError
+        # Record type does not have a class implementing it.
+      end
+      data = record_parser.new(payload).parse if record_parser
+
+      {
+        code: { id: code, category: code1, number: code2.to_i },
+        line_number: line_number,
+        raw_payload: payload.strip,
+        date: Hotfile::Date.new(date).to_date,
+        transaction: transaction&.to_i,
+        doc_nr: doc_nr&.strip,
+        check_digit: check_digit&.to_i,
+        data: data
+      }
+    end
+  end
+end

data/lib/hotfile/record/BAR64.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Document Amounts Record
+    class BAR64 < Record
+      def initialize(line)
+        super
+
+        fare, ti_indicator, equivalent_fare, total, system_id, fcm_indicator, booking_agent, outlet_type, fcp_indicator,
+            issuing_agent, reserved =
+          line.scan(/
+            (.{12})
+            (.)
+            (.{12})
+            (.{12})
+            ([A-Z0-9 ]{4})
+            ([A-Z0-9 ])
+            ([A-Z0-9 ]{6})
+            ([A-Z0-9 ])
+            ([A-Z0-9 ])
+            ([A-Z0-9 ]{8})
+            (.{38})
+          /x).flatten
+
+        @data = {
+          fare: fare.strip,
+          equivalent_fare: equivalent_fare.strip,
+          total_fare: total.strip,
+          system_id: system_id.strip,
+          booking_agent: booking_agent.strip,
+          outlet_type: outlet_type.strip,
+          issuing_agent: issuing_agent.strip,
+          indicators: {
+            ti: ti_indicator.strip,
+            fcm: fcm_indicator.strip,
+            fcp: fcp_indicator.strip
+          },
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BAR65.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Additional Information–Passenger Record
+    class BAR65 < Record
+      def initialize(line)
+        super
+
+        name, passenger_data, date_of_birth, type, reserved =
+          line.scan(/
+            (.{49})
+            (.{29})
+            ([A-Z0-9 ]{7})
+            ([A-Z0-9 ]{3})
+            (.{8})
+          /x).flatten
+
+        @data = {
+          name: name.strip,
+          passenger_data: passenger_data.strip,
+          date_of_birth: Hotfile::Date.new(date_of_birth).to_date,
+          type: type.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BAR66.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Additional Information–Form of Payment Record
+    class BAR66 < Record
+      def initialize(line)
+        super
+
+        sequence_number, payment_information, reserved =
+          line.scan(/
+            (\d)
+            (.{50})
+            (.{45})
+          /x).flatten
+
+        @data = {
+          sequence_number: sequence_number.to_i,
+          payment_information: payment_information.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BAR67.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Additional Information–Taxes
+    # ! not tested, I hope this code works at all...
+    class BAR67 < Record
+      def initialize(line)
+        super
+
+        sequence_number, info_id, additional_info, reserved =
+          line.scan(/
+            (\d{2})
+            (.{4})
+            (.{70})
+            (.{20})
+          /x).flatten
+
+        @data = {
+          sequence_number: sequence_number.to_i,
+          info_id: info_id.strip,
+          additional_info: additional_info.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BCC82.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Additional Card Information Record
+    # ! not tested, I hope this code works at all...
+    class BCC82 < Record
+      def initialize(line)
+        super
+
+        date_of_issue, transaction_number, payment_type, transaction_id, reserved =
+          line.scan(/
+            (\d{6})
+            (\d{6})
+            (.{10})
+            (.{25})
+            (.{76})
+          /x).flatten
+
+        @data = {
+          date_of_issue: Hotfile::Date.new(date_of_issue).to_date,
+          transaction_number: transaction_number.to_i,
+          transaction_id: transaction_id.strip,
+          payment_type: payment_type.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BCH02.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Billing Analysis (Cycle) Header Record
+    class BCH02 < Record
+      def initialize(line)
+        super
+
+        processing_date, cycle, billing_end_date, run_id, reporting_end_date, reserved =
+          line.scan(/
+            ([A-Z0-9]{3})
+            (\d)
+            (\d{6})
+            ([A-Z0-9])
+            (\d{6})
+            (.{106})
+          /x).flatten
+
+        @data = {
+          processing_date: processing_date,
+          cycle: cycle.to_i,
+          billing_end_date: Hotfile::Date.new(billing_end_date).to_date,
+          run: run_id,
+          reporting_end_date: Hotfile::Date.new(reporting_end_date).to_date,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BCT95.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Billing Analysis (Cycle) Totals per Currency Type Record
+    class BCT95 < Record
+      def initialize(line)
+        super
+
+        processing_date_id, cycle_id, office_count, gross, remittance, commission, tax, commission_tax, reserved,
+            currency =
+          line.scan(/
+            ([A-Z0-9 ]{3})
+            (\d)
+            (\d{5})
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (.{35})
+            ([A-Z0-9]{4})
+          /x).flatten
+
+        @data = {
+          currency: currency.strip,
+          processing: { date: processing_date_id.strip, cycle: cycle_id.to_i },
+          office_count: Hotfile::Integer.new(office_count).to_i,
+          gross: Hotfile::Integer.new(gross).to_i,
+          remittance: Hotfile::Integer.new(remittance).to_i,
+          commission: Hotfile::Integer.new(commission).to_i,
+          tax: Hotfile::Integer.new(tax).to_i,
+          commission_tax: Hotfile::Integer.new(commission_tax).to_i,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BCX83.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## 3DS Authentication and Additional Card Payment Information Record
+    # ! not tested, I hope this code works at all...
+    class BCX83 < Record
+      def initialize(line)
+        super
+
+        date_of_issue, transaction_number, payment_type, auth_sequence_nr, reserved =
+          line.scan(/
+            (\d{6})
+            (\d{6})
+            (.{10})
+            (\d{2})
+            (.{99})
+          /x).flatten
+
+        @data = {
+          date_of_issue: Hotfile::Date.new(date_of_issue).to_date,
+          transaction_number: transaction_number.to_i,
+          auth_sequence_nr: auth_sequence_nr.strip,
+          payment_type: payment_type.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BFH01.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## File Header Record
+    class BFH01 < Record
+      def initialize(line)
+        super
+
+        bsp_id, airline_code, revision, environment, processing_date, processing_time, country, file_sequence,
+            reserved =
+          line.scan(/
+            ([A-Z0-9]{3})
+            ([A-Z0-9]{3})
+            (\d{3})
+            ([A-Z0-9]{4})
+            (\d{6})
+            (\d{4})
+            ([A-Z]{2})
+            (\d{6})
+            (.{92})
+          /x).flatten
+
+        @data = {
+          bsp_id: bsp_id,
+          airline_code: airline_code,
+          revision: revision.to_i,
+          environment: environment,
+          processed: DateTime.parse("#{Hotfile::Date.new(processing_date).to_date} #{processing_time.insert(2, ':')}"),
+          country: country,
+          file_sequence: file_sequence.to_i,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BFT99.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## File Totals per Currency Type Record
+    class BFT99 < Record
+      def initialize(line)
+        super
+
+        bsp_id, office_count, gross, remittance, commission, tax, commission_tax, reserved, currency =
+          line.scan(/
+            ([A-Z0-9 ]{3})
+            (\d{5})
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (\d{14}.)
+            (.{36})
+            ([A-Z0-9]{4})
+          /x).flatten
+
+        @data = {
+          currency: currency.strip,
+          bsp_id: bsp_id.strip,
+          office_count: Hotfile::Integer.new(office_count).to_i,
+          gross: Hotfile::Integer.new(gross).to_i,
+          remittance: Hotfile::Integer.new(remittance).to_i,
+          commission: Hotfile::Integer.new(commission).to_i,
+          tax: Hotfile::Integer.new(tax).to_i,
+          commission_tax: Hotfile::Integer.new(commission_tax).to_i,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BKF81.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Fare Calculation Record
+    class BKF81 < Record
+      def initialize(line)
+        super
+
+        sequence_number, info, reserved =
+          line.scan(/
+            (\d)
+            (.{87})
+            (.{8})
+          /x).flatten
+
+        @data = {
+          sequence_number: sequence_number.to_i,
+          info: info.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BKI61.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Unticketed Point Information Record
+    # ! not tested, I hope this code works at all...
+    class BKI61 < Record
+      def initialize(line)
+        super
+
+        segment, arrival_airport, arrival_date, arrival_time, departure_date, departure_time, equipment, reserved =
+          line.scan(/
+            (\d)
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{7})
+            ([\d ]{5})
+            ([A-Z0-9 ]{7})
+            ([\d ]{5})
+            ([A-Z0-9 ]{3})
+            (.{63})
+          /x).flatten
+
+        @data = {
+          segment: segment.to_i,
+          airport: arrival_airport.strip,
+          departure_datetime:
+            DateTime.parse("#{Hotfile::Date.new(departure_date).to_date} #{departure_time.strip.insert(2, ':')}"),
+          arrival_datetime:
+            DateTime.parse("#{Hotfile::Date.new(arrival_date).to_date} #{arrival_time.strip.insert(2, ':')}"),
+          equipment: equipment.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BKI62.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Unticketed Point Information Record
+    class BKI62 < Record
+      def initialize(line)
+        super
+
+        segment, departure_airport, departure_date, departure_time, departure_terminal, arrival_airport, arrival_date,
+          arrival_time, arrival_terminal, reserved =
+          line.scan(/
+            (\d)
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{7})
+            ([\d ]{5})
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{7})
+            ([\d ]{5})
+            ([A-Z0-9 ]{5})
+            (.{51})
+          /x).flatten
+
+        @data = {
+          segment: segment.to_i,
+          departure: {
+            airport: departure_airport.strip,
+            datetime:
+              DateTime.parse("#{Hotfile::Date.new(departure_date).to_date} #{departure_time.strip.insert(2, ':')}"),
+            terminal: departure_terminal.strip
+          },
+          arrival: {
+            airport: arrival_airport.strip,
+            datetime:
+              DateTime.parse("#{Hotfile::Date.new(arrival_date).to_date} #{arrival_time.strip.insert(2, ':')}"),
+            terminal: arrival_terminal.strip
+          },
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BKI63.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Itinerary Data Segment Record
+    class BKI63 < Record
+      def initialize(line)
+        super
+
+        segment, stopover, not_valid_before, not_valid_after, departure_airport, arrival_airport, carrier, cabin,
+            flight_number, booking_designator, departure_date, departure_time, booking_status, baggage, fare_basis,
+            ff_ref, fare_class, change_of_gauge, equipment, reserved =
+          line.scan(/
+            (\d)
+            ([A-Z])
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{5})
+            ([A-Z0-9 ]{3})
+            ([A-Z0-9 ])
+            ([A-Z0-9 ]{5})
+            ([A-Z ]{2})
+            ([A-Z0-9 ]{7})
+            ([A-Z0-9 ]{5})
+            ([A-Z ]{2})
+            ([A-Z0-9 ]{3})
+            ([A-Z0-9 ]{15})
+            ([A-Z0-9 ]{20})
+            ([A-Z0-9 ]{3})
+            ([A-Z0-9 ])
+            ([A-Z0-9 ]{3})
+            (.{4})
+          /x).flatten
+
+        @data = {
+          segment: segment.to_i,
+          carrier: carrier.strip,
+          flight_number: flight_number.strip,
+          departure: {
+            airport: departure_airport.strip,
+            datetime:
+              DateTime.parse("#{Hotfile::Date.new(departure_date).to_date} #{departure_time.strip.insert(2, ':')}")
+          },
+          stopover: stopover.strip,
+          arrival: {
+            airport: arrival_airport.strip
+          },
+          validity: {
+            not_before: Hotfile::Date.new(not_valid_before).to_date,
+            not_after: Hotfile::Date.new(not_valid_after).to_date
+          },
+          cabin: cabin.strip,
+          baggage: baggage.strip,
+          equipment: equipment.strip,
+          booking: {
+            designator: booking_designator.strip,
+            status: booking_status.strip,
+            frequent_flyer_ref: ff_ref.strip,
+            fare_basis: fare_basis.strip,
+            fare_class: fare_class.strip,
+            change_of_gauge: change_of_gauge.strip
+          },
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end

data/lib/hotfile/record/BKP84.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class Hotfile
+  class Record
+    ## Form of Payment Record
+    class BKP84 < Record
+      def initialize(line)
+        super
+
+        date_of_issue, transaction_number, payment_type, amount, account, expiry, extend_code, approval_code,
+            invoice_number, invoice_date, remittance_amount, verification, reserved, currency =
+          line.scan(/
+            (\d{6})
+            (\d{6})
+            ([A-Z0-9 ]{10})
+            (\d{10}.)
+            ([A-Z0-9 ]{19})
+            ([A-Z0-9 ]{4})
+            ([A-Z0-9 ]{2})
+            ([A-Z0-9 ]{6})
+            ([A-Z0-9 ]{14})
+            ([\d ]{6})
+            (\d{10}.)
+            (.)
+            (.{23})
+            ([A-Z0-9]{4})
+          /x).flatten
+
+        @data = {
+          currency: currency.strip,
+          date_of_issue: Hotfile::Date.new(date_of_issue).to_date,
+          transaction_number: Hotfile::Integer.new(transaction_number).to_i,
+          payment_type: payment_type.strip,
+          amount: Hotfile::Integer.new(amount).to_i,
+          account: account.strip,
+          expiry: expiry.strip,
+          extend_code: extend_code.strip,
+          approval_code: approval_code.strip,
+          invoice_number: invoice_number.strip,
+          invoice_date: Hotfile::Date.new(invoice_date).to_date,
+          remittance_amount: Hotfile::Integer.new(remittance_amount).to_i,
+          verification: verification.strip,
+          reserved: reserved.strip
+        }
+      end
+    end
+  end
+end