ivymeter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc2746075be195abde3b585c1d422494b5abcec9091c794ff885680aa8b83336
+  data.tar.gz: 6a108ab4252785296d6cac5f8462deadd422f0a81acba0691fa2590d43a2e1a0
+SHA512:
+  metadata.gz: bc1a26fd3db8906baaed1a249a4fb901857cdae1f5e2eb65c2b384f876a429e777a7b89a2299e357a1811e1212db065583a09766fb7e6fe6e2715f4e47e275ce
+  data.tar.gz: c3bb8f7e24844a3daa5b173e83b977bda541b9b54f02dde015a8e01f0c096164b747fd55dbc68aa6be3f9fe50fcd23f5351588208126c421afc2e46c1256e077

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i':    '()'
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# changelog
+### v0.1.0 – 2025-04-14
+initial release! should be maybe up-to-date-ish?

data/README.md

@@ -0,0 +1,38 @@
+# IVyMeTeR
+
+a lil' gem for handling USPS IV-MTR event data
+
+mainly focused on piece data bc i don't really do capital-C Commercial mail, but the other stuff might should work too?
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add ivymeter
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install ivymeter
+```
+
+## Usage
+
+```ruby
+IvyMeter::Event::{Container,Tray,Bundle,Piece}Event
+  .from_json(<hash from USPS webhook>) or
+  .from_csv(<hash from USPS delimited file>)
+```
+
+## Development
+
+`bundle exec exe/generate_operation_codes <xlsx>` whenever they come out with a new [opcode list](https://postalpro.usps.com/informedvisibility/OperationCodesList)
+
+modify the `prop` statements in the event classes when a new version of the [external data dictionary](https://postalpro.usps.com/node/6307) is released
+## Contributing
+
+pull requests welcome! bug reports less welcome...
+
+this project is housed on GitHub at [24c02/ivymeter](https://github.com/24c02/ivymeter).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)

data/exe/generate_operation_codes

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'xsv'
+require 'pathname'
+
+module IvyMeter
+  class GenerateOperationCodes    
+    SHEET_CONFIGS = {
+      'OpCodes' => 1,
+      'Unexpected OpCodes' => 2
+    }.freeze
+
+    def self.from_xlsx(xlsx_file)
+      workbook = Xsv.open(xlsx_file)
+      results = {}
+
+      SHEET_CONFIGS.each do |sheet_name, config|
+        sheet = workbook.sheets.find { |s| s.name == sheet_name }
+        next unless sheet
+
+        setup_sheet(sheet, sheet[config])
+        results[sheet_name] = process_sheet(sheet, config)
+      end
+
+      [results['OpCodes'] || {}, results['Unexpected OpCodes'] || {}]
+    end
+
+    def self.setup_sheet(sheet, headers)
+      sheet.instance_variable_set(:@headers, headers)
+      sheet.instance_variable_set(:@mode, :hash)
+    end
+
+    def self.process_sheet(sheet, config)
+      sheet.each_with_index.each_with_object({}) do |(row, index), codes|
+        # next if index <= config
+
+        code = row['Operation Code'].to_s
+        next if code.empty?
+        code = code.rjust(3, '0') if code.match?(/^\d+$/)
+
+        codes[code] = build_code_attributes(row)
+      end
+    end
+
+    def self.build_code_attributes(row)
+      {
+        code: row['Operation Code'].to_s.rjust(3, '0'),
+        machine_type: row['Machine Type'].to_s,
+        equipment_description: row['Equipment Description'].to_s,
+        stop_the_clock_scan: row['Stop-the-Clock Scan?'].to_s == 'Yes',
+        clearance_cutoff_time: row['Clearance Cutoff Time'].to_s,
+        handling_event_type: row['Piece'].to_s,
+        piece_mail_type: row['Piece Mail Type'].to_s,
+        mail_level: row['Mail Level'].to_s,
+        mail_phase: row['Mail Phase'].to_s,
+        process_description: row['Process Description'].to_s,
+        available_date: row['Available Date'].to_s,
+        last_updated: row['Last Updated'].to_s
+      }
+    end
+
+    def self.write_ruby_code(opcodes, unexpected_codes, output_file)
+      puts "writing #{opcodes.size} operation codes and #{unexpected_codes.size} unexpected codes..."
+      
+      File.open(output_file, 'w') do |f|
+        f.write(<<~RUBY
+          # dis file is auto-generated from the xlsx file
+          # pwease do not edit it directly
+          module IvyMeter
+            class OperationCode
+
+              #{generate_constant('OPCODES', opcodes)}
+
+              #{generate_constant('UNEXPECTED_CODES', unexpected_codes)}
+            end
+          end
+        RUBY
+        )
+      end
+    end
+
+    def self.generate_constant(constant_name, codes)
+      sorted_codes = codes.sort_by do |code, _|
+        Integer(code)
+      rescue StandardError
+        9999
+      end
+
+      code_entries = sorted_codes.map do |code, attributes|
+        attributes_str = attributes.map do |key, value|
+          "            #{key}: #{value.inspect},"
+        end.join("\n")
+
+        <<RUBY
+        "#{code}" => new(
+#{attributes_str}
+        ),
+RUBY
+      end.join("\n")
+
+      <<RUBY
+#{constant_name} = {
+#{code_entries}
+}.freeze
+RUBY
+    end
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  if ARGV.length != 1
+    puts "Usage: #{$PROGRAM_NAME} <xlsx_file>"
+    exit 1
+  end
+
+  xlsx_file = ARGV[0]
+  opcodes, unexpected_codes = IvyMeter::GenerateOperationCodes.from_xlsx(xlsx_file)
+  output_file = Pathname.new(__dir__).join('..', 'lib', 'ivymeter', 'opcodes.rb')
+  IvyMeter::GenerateOperationCodes.write_ruby_code(opcodes, unexpected_codes, output_file)
+  puts "Generated operation codes in #{output_file}"
+end

data/lib/ivymeter/events/base.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'date'
+require_relative '../prop'
+require_relative '../opcode'
+
+module IvyMeter
+  class Event
+    include Prop
+
+    class << self
+      def inherited(subclass)
+        subclass.instance_variable_set(:@property_mappings, property_mappings.dup)
+      end
+
+      def prop(name, json_name, csv_name, type: nil)
+        attr_accessor name
+
+        @property_mappings ||= {}
+        @property_mappings[name] = { json: json_name, csv: csv_name, type: type }
+      end
+
+      def property_mappings
+        @property_mappings || {}
+      end
+
+      def from_json(json_data)
+        event = new
+        property_mappings.each do |attr_name, mappings|
+          value = json_data[mappings[:json]]
+          next if value.nil?
+
+          event.send("#{attr_name}=", convert_value(value, mappings[:type]))
+        end
+        event
+      end
+
+      def from_csv(row)
+        event = new
+        property_mappings.each do |attr_name, mappings|
+          value = row[mappings[:csv]]
+          next if value.nil?
+
+          event.send("#{attr_name}=", convert_value(value, mappings[:type]))
+        end
+        event
+      end
+
+      private
+
+      def convert_value(value, type)
+        case type
+        when :date
+          Date.parse(value)
+        when :datetime
+          DateTime.parse(value)
+        else
+          value
+        end
+      end
+    end
+
+    def to_json(*_args)
+      result = {}
+      self.class.property_mappings.each do |attr_name, mappings|
+        value = send(attr_name)
+        if value.is_a?(DateTime) && mappings[:type] == :datetime
+          value = value.strftime('%Y-%m-%d %H:%M:%S%z')
+        elsif value.is_a?(Date) && mappings[:type] == :date
+          value = value.strftime('%Y-%m-%d')
+        end
+        result[mappings[:json]] = value
+      end
+      result.compact.to_json
+    end
+
+    # Common eDoc properties
+    prop :edoc_job_id, 'edocJobId', 'eDoc Job ID'
+    prop :edoc_mailing_group_id, 'edocMailingGroupId', 'eDoc Mailing Group ID'
+    prop :edoc_submitter_crid, 'edocSubmitterCrid', 'eDoc Submitter CRID'
+
+    # Common handling event properties
+    prop :scan_datetime, 'scanDatetime', 'Scan DateTime', type: :datetime
+    prop :scan_event_code, 'scanEventCode', 'Scan Event Code'
+    prop :scan_facility_city, 'scanFacilityCity', 'Scan Facility City'
+    prop :scan_facility_name, 'scanFacilityName', 'Scan Facility Name'
+    prop :scan_facility_state, 'scanFacilityState', 'Scan Facility State'
+    prop :scan_facility_zip, 'scanFacilityZip', 'Scan Facility ZIP'
+    prop :scan_locale_key, 'scanLocaleKey', 'Scan Locale Key'
+    prop :handling_event_type, 'handlingEventType', 'Handling Event Type'
+    prop :handling_event_type_description, 'handlingEventTypeDescription', 'Handling Event Type Description'
+
+    # Common mail properties
+    prop :mail_class_description, 'mailClassDescription', 'Mail Class Description'
+    prop :mail_shape_description, 'mailShapeDescription', 'Mail Shape Description'
+
+    # Common scanner properties
+    prop :scanner_type, 'scannerType', 'Scanner Type'
+    prop :machine_name, 'machineName', 'Machine Name'
+    prop :device_id, 'deviceId', 'Device ID'
+
+    # Common start the clock properties
+    prop :start_the_clock_date, 'startTheClockDate', 'Start the Clock Date', type: :date
+    prop :start_the_clock_facility_address, 'startTheClockFacilityAddress', 'Start the Clock Facility Address'
+    prop :start_the_clock_facility_city, 'startTheClockFacilityCity', 'Start the Clock Facility City'
+    prop :start_the_clock_facility_locale_key, 'startTheClockFacilityLocaleKey', 'Start the Clock Facility Locale Key'
+    prop :start_the_clock_facility_name, 'startTheClockFacilityName', 'Start the Clock Facility Name'
+    prop :start_the_clock_facility_state, 'startTheClockFacilityState', 'Start the Clock Facility State'
+    prop :start_the_clock_facility_zip, 'startTheClockFacilityZip', 'Start the Clock Facility ZIP'
+
+    # Common recipient CRID properties
+    prop :recipient_crid_of_mid_on_piece, 'recipientCridOfMidOnPiece', 'Recipient CRID of MID on Piece'
+    prop :recipient_crid_of_mid_on_piece_delegator, 'recipientCridOfMidOnPieceDelegator',
+         'Recipient CRID of MID on Piece Delegator'
+    prop :recipient_mail_owner_crid, 'recipientMailOwnerCrid', 'Recipient Mail Owner CRID'
+    prop :recipient_mail_owner_delegator_crid, 'recipientMailOwnerDelegatorCrid', 'Recipient Mail Owner Delegator CRID'
+    prop :recipient_routing_code_authorized_crid, 'recipientRoutingCodeAuthorizedCrid',
+         'Recipient Routing Code Authorized CRID'
+
+    # Common operational status
+    prop :operational_status, 'operationalStatus', 'Operational Status'
+
+    # Common handling event properties
+    prop :handling_event_datetime, 'handlingEventDateTime', 'Handling Event DateTime'
+    prop :handling_event_facility_city, 'handlingEventFacilityCity', 'Handling Event Facility City'
+    prop :handling_event_facility_name, 'handlingEventFacilityName', 'Handling Event Facility Name'
+    prop :handling_event_facility_state, 'handlingEventFacilityState', 'Handling Event Facility State'
+    prop :handling_event_facility_zip, 'handlingEventFacilityZip', 'Handling Event Facility ZIP Code'
+    prop :handling_event_locale_key, 'handlingEventLocaleKey', 'Handling Event Locale Key'
+    prop :handling_event_scan_state, 'handlingEventScanState', 'Handling Event Scan State'
+
+    # Common eDoc properties
+    prop :edoc_container_id, 'edocContainerId', 'eDoc Container ID'
+    prop :edoc_csa_agreement_id, 'edocCsaAgreementId', 'eDoc CSA Agreement ID'
+    prop :edoc_customer_group_id, 'edocCustomerGroupId', 'eDoc Customer Group ID'
+    prop :edoc_parent_container_id, 'edocParentContainerId', 'eDoc Parent Container ID'
+    prop :edoc_sibling_container_id, 'edocSiblingContainerId', 'eDoc Sibling Container ID'
+    prop :edoc_user_license_code, 'edocUserLicenseCode', 'eDoc User License Code'
+
+    # Common recipient CRID properties
+    prop :recipient_edoc_submitter_crid, 'recipientEdocSubmitterCrid', 'Recipient eDoc Submitter CRID'
+    prop :recipient_edoc_submitter_delegator_crid, 'recipientEdocSubmitterDelegatorCrid',
+         'Recipient eDoc Submitter Delegator CRID'
+    prop :recipient_mail_preparer_crid, 'recipientMailPreparerCrid', 'Recipient Mail Preparer CRID'
+    prop :recipient_mail_preparer_delegator_crid, 'recipientMailPreparerDelegatorCrid',
+         'Recipient Mail Preparer Delegator CRID'
+
+    # Common mail properties
+    prop :piece_count, 'pieceCount', 'Piece Count'
+
+    def actual?
+      handling_event_type == 'A'
+    end
+
+    def assumed_actual?
+      handling_event_type == 'AA'
+    end
+
+    def logical?
+      handling_event_type == 'L'
+    end
+
+    def assumed_logical?
+      handling_event_type == 'AL'
+    end
+
+    def assumed?
+      assumed_actual? || assumed_logical?
+    end
+
+    def opcode
+      @opcode ||= OpCode.find(scan_event_code)
+    end
+
+    def stop_the_clock_scan?
+      opcode&.stop_the_clock_scan?
+    end
+
+    def unexpected_opcode?
+      opcode&.unexpected?
+    end
+
+    def clearance_cutoff_time
+      opcode&.clearance_cutoff_time
+    end
+
+    def mail_phase
+      opcode&.mail_phase
+    end
+
+    def process_description
+      opcode&.process_description
+    end
+  end
+end

data/lib/ivymeter/events/bundle.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module IvyMeter
+  class Event
+    class BundleEvent < Event
+      # Bundle-specific properties
+      prop :bundle_id, 'bundleId', 'Bundle ID'
+      prop :edoc_container_id, 'edocContainerId', 'eDoc Container ID'
+      prop :edoc_container_zip, 'edocContainerZip', 'eDoc Container ZIP'
+      prop :edoc_csa_agreement_id, 'edocCsaAgreementId', 'eDoc CSA Agreement ID'
+      prop :edoc_customer_group_id, 'edocCustomerGroupId', 'eDoc Customer Group ID'
+      prop :edoc_parent_container_id, 'edocParentContainerId', 'eDoc Parent Container ID'
+      prop :edoc_sibling_container_id, 'edocSiblingContainerId', 'eDoc Sibling Container ID'
+      prop :edoc_user_license_code, 'edocUserLicenseCode', 'eDoc User License Code'
+      prop :piece_count, 'pieceCount', 'Piece Count'
+
+      # Bundle IMb properties
+      prop :imb, 'imb', 'IMb'
+      prop :imb_mid, 'imbMid', 'IMb MID'
+      prop :imb_routing_code, 'imbRoutingCode', 'IMb Routing Code'
+      prop :imb_serial_number, 'imbSerialNumber', 'IMb Serial Number'
+      prop :imb_stid, 'imbStid', 'IMb STID'
+      prop :imb_tracking_code, 'imbTrackingCode', 'IMb Tracking Code'
+
+      # Bundle-specific recipient CRID properties
+      prop :recipient_crid_of_mid_on_bundle, 'recipientCridOfMidOnBundle', 'Recipient CRID of MID on Bundle'
+      prop :recipient_crid_of_mid_on_bundle_delegator, 'recipientCridOfMidOnBundleDelegator',
+           'Recipient CRID of MID on Bundle Delegator'
+
+      # Postage statement properties
+      prop :postage_statement_finalization_datetime, 'postageStatementFinalizationDatetime',
+           'Postage Statement Finalization DateTime', type: :datetime
+      prop :postage_statement_finalization_facility_name, 'postageStatementFinalizationFacilityName',
+           'Postage Statement Finalization Facility Name'
+
+      # Routing code
+      prop :routing_code_imb_matching_portion, 'routingCodeImbMatchingPortion', 'Routing Code (IMb Matching Portion)'
+    end
+  end
+end

data/lib/ivymeter/events/container.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module IvyMeter
+  class Event
+    class ContainerEvent < Event
+      # Container-specific properties
+      prop :container_id, 'containerId', 'Container ID'
+      prop :bundle_count, 'bundleCount', 'Bundle Count'
+      prop :edoc_container_id, 'edocContainerId', 'eDoc Container ID'
+      prop :edoc_container_zip, 'edocContainerZip', 'eDoc Container ZIP'
+      prop :edoc_csa_agreement_id, 'edocCsaAgreementId', 'eDoc CSA Agreement ID'
+      prop :edoc_customer_group_id, 'edocCustomerGroupId', 'eDoc Customer Group ID'
+      prop :edoc_parent_container_id, 'edocParentContainerId', 'eDoc Parent Container ID'
+      prop :edoc_sibling_container_id, 'edocSiblingContainerId', 'eDoc Sibling Container ID'
+      prop :edoc_user_license_code, 'edocUserLicenseCode', 'eDoc User License Code'
+
+      # FAST appointment properties
+      prop :fast_appointment_scheduled_datetime, 'fastAppointmentScheduledDatetime',
+           'FAST Appointment Scheduled DateTime', type: :datetime
+      prop :fast_appointment_unload_end_time, 'fastAppointmentUnloadEndTime', 'FAST Appointment Unload End Time',
+           type: :datetime
+      prop :fast_appointment_unload_start_time, 'fastAppointmentUnloadStartTime', 'FAST Appointment Unload Start Time',
+           type: :datetime
+
+      # Count properties
+      prop :piece_count, 'pieceCount', 'Piece Count'
+      prop :tray_count, 'trayCount', 'Tray Count'
+
+      # Container IMb properties
+      prop :imcb, 'imcb', 'IMcb'
+      prop :imcb_mid, 'imcbMid', 'IMcb MID'
+      prop :imcb_routing_code, 'imcbRoutingCode', 'IMcb Routing Code'
+      prop :imcb_serial_number, 'imcbSerialNumber', 'IMcb Serial Number'
+      prop :imcb_stid, 'imcbStid', 'IMcb STID'
+      prop :imcb_tracking_code, 'imcbTrackingCode', 'IMcb Tracking Code'
+
+      # Container-specific recipient CRID properties
+      prop :recipient_crid_of_mid_on_container, 'recipientCridOfMidOnContainer', 'Recipient CRID of MID on Container'
+      prop :recipient_crid_of_mid_on_container_delegator, 'recipientCridOfMidOnContainerDelegator',
+           'Recipient CRID of MID on Container Delegator'
+      prop :recipient_fast_scheduler_crid, 'recipientFASTSchedulerCrid', 'Recipient FAST Scheduler CRID'
+      prop :recipient_fast_scheduler_delegator_crid, 'recipientFASTSchedulerDelegatorCrid',
+           'Recipient FAST Scheduler Delegator CRID'
+
+      # Parent references
+      prop :parent_tray_edoc_container_id, 'parentTrayEdocContainerId', 'Parent Tray eDoc Container ID'
+      prop :parent_tray_edoc_imtb, 'parentTrayEdocImtb', 'Parent Tray eDoc IMtb'
+
+      # Postage statement properties
+      prop :postage_statement_finalization_datetime, 'postageStatementFinalizationDatetime',
+           'Postage Statement Finalization DateTime', type: :datetime
+      prop :postage_statement_finalization_facility_name, 'postageStatementFinalizationFacilityName',
+           'Postage Statement Finalization Facility Name'
+
+      # Routing code
+      prop :routing_code_imcb_matching_portion, 'routingCodeImcbMatchingPortion', 'Routing Code (IMcb Matching Portion)'
+    end
+  end
+end

data/lib/ivymeter/events/piece.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module IvyMeter
+  class Event
+    class PieceEvent < Event
+      # Delivery date properties
+      prop :anticipated_delivery_date, 'anticipatedDeliveryDate', 'Anticipated Delivery Date', type: :date
+      prop :expected_delivery_date, 'expectedDeliveryDate', 'Expected Delivery Date', type: :date
+      prop :predicted_delivery_date, 'predictedDeliveryDate', 'Predicted Delivery Date', type: :date
+
+      # IMb properties
+      prop :imb, 'imb', 'IMb'
+      prop :imb_mid, 'imbMid', 'IMb MID'
+      prop :imb_routing_code, 'imbRoutingCode', 'IMb Routing Code'
+      prop :imb_serial_number, 'imbSerialNumber', 'IMb Serial Number'
+      prop :imb_stid, 'imbStid', 'IMb STID'
+      prop :imb_tracking_code, 'imbTrackingCode', 'IMb Tracking Code'
+
+      # IMpb properties
+      prop :impb, 'impb', 'IMpb'
+
+      # LDE properties
+      prop :lde_delivery_mode, 'ldeDeliveryMode', 'LDE Delivery Mode'
+      prop :lde_inventory_method, 'ldeInventoryMethod', 'LDE Inventory Method'
+      prop :lde_trigger_method, 'ldeTriggerMethod', 'LDE Trigger Method'
+
+      # Mail phase
+      prop :mail_phase, 'mailPhase', 'Mail Phase'
+
+      # Operational status
+      prop :operational_status, 'operationalStatus', 'Operational Status'
+
+      # Parent references
+      prop :parent_container_edoc_container_id, 'parentContainerEdocContainerId', 'Parent Container eDoc Container ID'
+      prop :parent_container_edoc_imtb, 'parentContainerEdocImtb', 'Parent Container eDoc IMcb'
+      prop :parent_tray_edoc_container_id, 'parentTrayEdocContainerId', 'Parent Tray eDoc Container ID'
+      prop :parent_tray_edoc_imtb, 'parentTrayEdocImtb', 'Parent Tray eDoc IMtb'
+
+      # Piece identifier
+      prop :piece_id, 'pieceId', 'Piece ID'
+
+      # Postage statement properties
+      prop :postage_statement_finalization_datetime, 'postageStatementFinalizationDatetime',
+           'Postage Statement Finalization DateTime', type: :datetime
+      prop :postage_statement_finalization_facility_name, 'postageStatementFinalizationFacilityName',
+           'Postage Statement Finalization Facility Name'
+
+      # Routing code
+      prop :routing_code_imb_matching_portion, 'routingCodeImbMatchingPortion', 'Routing Code (IMb Matching Portion)'
+    end
+  end
+end

data/lib/ivymeter/events/tray.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module IvyMeter
+  class Event
+    class TrayEvent < Event
+      # Tray-specific properties
+      prop :tray_id, 'trayId', 'Tray ID'
+      prop :edoc_container_id, 'edocContainerId', 'eDoc Container ID'
+      prop :edoc_container_zip, 'edocContainerZip', 'eDoc Container ZIP'
+      prop :edoc_csa_agreement_id, 'edocCsaAgreementId', 'eDoc CSA Agreement ID'
+      prop :edoc_customer_group_id, 'edocCustomerGroupId', 'eDoc Customer Group ID'
+      prop :edoc_parent_container_id, 'edocParentContainerId', 'eDoc Parent Container ID'
+      prop :edoc_sibling_container_id, 'edocSiblingContainerId', 'eDoc Sibling Container ID'
+      prop :edoc_user_license_code, 'edocUserLicenseCode', 'eDoc User License Code'
+      prop :piece_count, 'pieceCount', 'Piece Count'
+
+      # Tray IMb properties
+      prop :imtb, 'imtb', 'IMtb'
+      prop :imtb_mid, 'imtbMid', 'IMtb MID'
+      prop :imtb_routing_code, 'imtbRoutingCode', 'IMtb Routing Code'
+      prop :imtb_serial_number, 'imtbSerialNumber', 'IMtb Serial Number'
+      prop :imtb_stid, 'imtbStid', 'IMtb STID'
+      prop :imtb_tracking_code, 'imtbTrackingCode', 'IMtb Tracking Code'
+
+      # Tray-specific recipient CRID properties
+      prop :recipient_crid_of_mid_on_tray, 'recipientCridOfMidOnTray', 'Recipient CRID of MID on Tray'
+      prop :recipient_crid_of_mid_on_tray_delegator, 'recipientCridOfMidOnTrayDelegator',
+           'Recipient CRID of MID on Tray Delegator'
+
+      # Parent references
+      prop :parent_bundle_edoc_container_id, 'parentBundleEdocContainerId', 'Parent Bundle eDoc Container ID'
+      prop :parent_bundle_edoc_imb, 'parentBundleEdocImb', 'Parent Bundle eDoc IMb'
+
+      # Postage statement properties
+      prop :postage_statement_finalization_datetime, 'postageStatementFinalizationDatetime',
+           'Postage Statement Finalization DateTime', type: :datetime
+      prop :postage_statement_finalization_facility_name, 'postageStatementFinalizationFacilityName',
+           'Postage Statement Finalization Facility Name'
+
+      # Routing code
+      prop :routing_code_imtb_matching_portion, 'routingCodeImtbMatchingPortion', 'Routing Code (IMtb Matching Portion)'
+    end
+  end
+end

data/lib/ivymeter/opcode.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module IvyMeter
+  class OpCode
+    attr_reader :machine_type, :code, :equipment_description, :stop_the_clock_scan,
+                :clearance_cutoff_time, :handling_event_type, :piece_mail_type, :mail_level,
+                :mail_phase, :process_description, :available_date, :last_updated
+
+    def initialize(attributes = {})
+      @machine_type = attributes[:machine_type]
+      @code = attributes[:code]
+      @equipment_description = attributes[:equipment_description]
+      @stop_the_clock_scan = attributes[:stop_the_clock_scan]
+      @clearance_cutoff_time = attributes[:clearance_cutoff_time]
+      @handling_event_type = attributes[:handling_event_type]
+      @piece_mail_type = attributes[:piece_mail_type]
+      @mail_level = attributes[:mail_level]
+      @mail_phase = attributes[:mail_phase]
+      @process_description = attributes[:process_description]
+      @available_date = attributes[:available_date]
+      @last_updated = attributes[:last_updated]
+    end
+
+    def self.find(code)
+      code = code.to_s
+      OPCODES[code] || UNEXPECTED_CODES[code]
+    end
+
+    def unexpected?
+      UNEXPECTED_CODES.key?(code)
+    end
+
+    def stop_the_clock_scan?
+      !!stop_the_clock_scan
+    end
+  end
+end