ivymeter 0.1.0

data/lib/ivymeter/prop.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module IvyMeter
+  module Prop
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def prop(name, json_name, _csv_name, type: :string)
+        define_method(name) do
+          value = @data[json_name]
+          return nil if value.nil?
+
+          case type
+          when :date
+            Date.parse(value)
+          when :datetime
+            value.is_a?(DateTime) ? value : DateTime.parse(value)
+          else
+            value
+          end
+        end
+
+        define_method("#{name}=") do |value|
+          return @data[json_name] = nil if value.nil?
+
+          @data[json_name] = case type
+                             when :date
+                               value.is_a?(Date) ? value : Date.parse(value)
+                             when :datetime
+                               if value.is_a?(DateTime)
+                                 value
+                               else
+                                 begin
+                                   DateTime.parse(value)
+                                 rescue ArgumentError
+                                   DateTime.iso8601(value)
+                                 end
+                               end
+                             else
+                               value
+                             end
+        end
+      end
+    end
+  end
+end

data/lib/ivymeter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IvyMeter
+  VERSION = '0.1.0'
+end

data/lib/ivymeter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'ivymeter/version'
+require_relative 'ivymeter/opcode'
+require_relative 'ivymeter/opcodes'
+require_relative 'ivymeter/events/base'
+require_relative 'ivymeter/events/container'
+require_relative 'ivymeter/events/tray'
+require_relative 'ivymeter/events/bundle'
+require_relative 'ivymeter/events/piece'
+
+module IvyMeter
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/ivymeter/events/base.rbs

@@ -0,0 +1,94 @@
+module IvyMeter
+  class Event
+    include Prop
+
+    def self.inherited: (Class subclass) -> void
+    def self.property_mappings: () -> Hash[Symbol, Hash[Symbol, untyped]]
+    def self.from_json: (Hash[String, untyped] json_data) -> Event
+    def self.from_csv: (Hash[String, untyped] row) -> Event
+
+    def to_json: () -> String
+    def actual?: () -> bool
+    def assumed_actual?: () -> bool
+    def logical?: () -> bool
+    def assumed_logical?: () -> bool
+    def assumed?: () -> bool
+    def opcode: () -> IvyMeter::OpCode?
+    def stop_the_clock_scan?: () -> bool
+    def unexpected_opcode?: () -> bool
+    def clearance_cutoff_time: () -> String?
+    def mail_phase: () -> String?
+    def process_description: () -> String?
+
+    # Common properties
+    attr_accessor edoc_job_id: String?
+    attr_accessor edoc_mailing_group_id: String?
+    attr_accessor edoc_submitter_crid: String?
+
+    # Handling event properties
+    attr_accessor scan_datetime: DateTime?
+    attr_accessor scan_event_code: String?
+    attr_accessor scan_facility_city: String?
+    attr_accessor scan_facility_name: String?
+    attr_accessor scan_facility_state: String?
+    attr_accessor scan_facility_zip: String?
+    attr_accessor scan_locale_key: String?
+    attr_accessor handling_event_type: String?
+    attr_accessor handling_event_type_description: String?
+
+    # Mail properties
+    attr_accessor mail_class_description: String?
+    attr_accessor mail_shape_description: String?
+
+    # Scanner properties
+    attr_accessor scanner_type: String?
+    attr_accessor machine_name: String?
+    attr_accessor device_id: String?
+
+    # Start the clock properties
+    attr_accessor start_the_clock_date: Date?
+    attr_accessor start_the_clock_facility_address: String?
+    attr_accessor start_the_clock_facility_city: String?
+    attr_accessor start_the_clock_facility_locale_key: String?
+    attr_accessor start_the_clock_facility_name: String?
+    attr_accessor start_the_clock_facility_state: String?
+    attr_accessor start_the_clock_facility_zip: String?
+
+    # Recipient CRID properties
+    attr_accessor recipient_crid_of_mid_on_piece: String?
+    attr_accessor recipient_crid_of_mid_on_piece_delegator: String?
+    attr_accessor recipient_mail_owner_crid: String?
+    attr_accessor recipient_mail_owner_delegator_crid: String?
+    attr_accessor recipient_routing_code_authorized_crid: String?
+
+    # Operational status
+    attr_accessor operational_status: String?
+
+    # Common handling event properties
+    attr_accessor handling_event_datetime: String?
+    attr_accessor handling_event_facility_city: String?
+    attr_accessor handling_event_facility_name: String?
+    attr_accessor handling_event_facility_state: String?
+    attr_accessor handling_event_facility_zip: String?
+    attr_accessor handling_event_locale_key: String?
+    attr_accessor handling_event_scan_state: String?
+    attr_accessor handling_event_code: String?
+
+    # Common eDoc properties
+    attr_accessor edoc_container_id: String?
+    attr_accessor edoc_csa_agreement_id: String?
+    attr_accessor edoc_customer_group_id: String?
+    attr_accessor edoc_parent_container_id: String?
+    attr_accessor edoc_sibling_container_id: String?
+    attr_accessor edoc_user_license_code: String?
+
+    # Common recipient CRID properties
+    attr_accessor recipient_edoc_submitter_crid: String?
+    attr_accessor recipient_edoc_submitter_delegator_crid: String?
+    attr_accessor recipient_mail_preparer_crid: String?
+    attr_accessor recipient_mail_preparer_delegator_crid: String?
+
+    # Common mail properties
+    attr_accessor piece_count: String?
+  end
+end 

data/sig/ivymeter/events/bundle.rbs

@@ -0,0 +1,33 @@
+module IvyMeter
+  class Event::BundleEvent < Event
+    # Bundle-specific properties
+    attr_accessor bundle_id: String?
+    attr_accessor edoc_container_id: String?
+    attr_accessor edoc_container_zip: String?
+    attr_accessor edoc_csa_agreement_id: String?
+    attr_accessor edoc_customer_group_id: String?
+    attr_accessor edoc_parent_container_id: String?
+    attr_accessor edoc_sibling_container_id: String?
+    attr_accessor edoc_user_license_code: String?
+    attr_accessor piece_count: String?
+
+    # Bundle IMb properties
+    attr_accessor imb: String?
+    attr_accessor imb_mid: String?
+    attr_accessor imb_routing_code: String?
+    attr_accessor imb_serial_number: String?
+    attr_accessor imb_stid: String?
+    attr_accessor imb_tracking_code: String?
+
+    # Bundle-specific recipient CRID properties
+    attr_accessor recipient_crid_of_mid_on_bundle: String?
+    attr_accessor recipient_crid_of_mid_on_bundle_delegator: String?
+
+    # Postage statement properties
+    attr_accessor postage_statement_finalization_datetime: DateTime?
+    attr_accessor postage_statement_finalization_facility_name: String?
+
+    # Routing code
+    attr_accessor routing_code_imb_matching_portion: String?
+  end
+end 

data/sig/ivymeter/events/container.rbs

@@ -0,0 +1,48 @@
+module IvyMeter
+  class Event::ContainerEvent < Event
+    # Container-specific properties
+    attr_accessor container_id: String?
+    attr_accessor bundle_count: String?
+    attr_accessor edoc_container_id: String?
+    attr_accessor edoc_container_zip: String?
+    attr_accessor edoc_csa_agreement_id: String?
+    attr_accessor edoc_customer_group_id: String?
+    attr_accessor edoc_parent_container_id: String?
+    attr_accessor edoc_sibling_container_id: String?
+    attr_accessor edoc_user_license_code: String?
+
+    # FAST appointment properties
+    attr_accessor fast_appointment_scheduled_datetime: DateTime?
+    attr_accessor fast_appointment_unload_end_time: DateTime?
+    attr_accessor fast_appointment_unload_start_time: DateTime?
+
+    # Count properties
+    attr_accessor piece_count: String?
+    attr_accessor tray_count: String?
+
+    # Container IMb properties
+    attr_accessor imcb: String?
+    attr_accessor imcb_mid: String?
+    attr_accessor imcb_routing_code: String?
+    attr_accessor imcb_serial_number: String?
+    attr_accessor imcb_stid: String?
+    attr_accessor imcb_tracking_code: String?
+
+    # Container-specific recipient CRID properties
+    attr_accessor recipient_crid_of_mid_on_container: String?
+    attr_accessor recipient_crid_of_mid_on_container_delegator: String?
+    attr_accessor recipient_fast_scheduler_crid: String?
+    attr_accessor recipient_fast_scheduler_delegator_crid: String?
+
+    # Parent references
+    attr_accessor parent_tray_edoc_container_id: String?
+    attr_accessor parent_tray_edoc_imtb: String?
+
+    # Postage statement properties
+    attr_accessor postage_statement_finalization_datetime: DateTime?
+    attr_accessor postage_statement_finalization_facility_name: String?
+
+    # Routing code
+    attr_accessor routing_code_imcb_matching_portion: String?
+  end
+end 

data/sig/ivymeter/events/piece.rbs

@@ -0,0 +1,46 @@
+module IvyMeter
+  class Event::PieceEvent < Event
+    # Delivery date properties
+    attr_accessor anticipated_delivery_date: Date?
+    attr_accessor expected_delivery_date: Date?
+    attr_accessor predicted_delivery_date: Date?
+
+    # IMb properties
+    attr_accessor imb: String?
+    attr_accessor imb_mid: String?
+    attr_accessor imb_routing_code: String?
+    attr_accessor imb_serial_number: String?
+    attr_accessor imb_stid: String?
+    attr_accessor imb_tracking_code: String?
+
+    # IMpb properties
+    attr_accessor impb: String?
+
+    # LDE properties
+    attr_accessor lde_delivery_mode: String?
+    attr_accessor lde_inventory_method: String?
+    attr_accessor lde_trigger_method: String?
+
+    # Mail phase
+    attr_accessor mail_phase: String?
+
+    # Operational status
+    attr_accessor operational_status: String?
+
+    # Parent references
+    attr_accessor parent_container_edoc_container_id: String?
+    attr_accessor parent_container_edoc_imtb: String?
+    attr_accessor parent_tray_edoc_container_id: String?
+    attr_accessor parent_tray_edoc_imtb: String?
+
+    # Piece identifier
+    attr_accessor piece_id: String?
+
+    # Postage statement properties
+    attr_accessor postage_statement_finalization_datetime: DateTime?
+    attr_accessor postage_statement_finalization_facility_name: String?
+
+    # Routing code
+    attr_accessor routing_code_imb_matching_portion: String?
+  end
+end 

data/sig/ivymeter/events/tray.rbs

@@ -0,0 +1,37 @@
+module IvyMeter
+  class Event::TrayEvent < Event
+    # Tray-specific properties
+    attr_accessor tray_id: String?
+    attr_accessor edoc_container_id: String?
+    attr_accessor edoc_container_zip: String?
+    attr_accessor edoc_csa_agreement_id: String?
+    attr_accessor edoc_customer_group_id: String?
+    attr_accessor edoc_parent_container_id: String?
+    attr_accessor edoc_sibling_container_id: String?
+    attr_accessor edoc_user_license_code: String?
+    attr_accessor piece_count: String?
+
+    # Tray IMb properties
+    attr_accessor imtb: String?
+    attr_accessor imtb_mid: String?
+    attr_accessor imtb_routing_code: String?
+    attr_accessor imtb_serial_number: String?
+    attr_accessor imtb_stid: String?
+    attr_accessor imtb_tracking_code: String?
+
+    # Tray-specific recipient CRID properties
+    attr_accessor recipient_crid_of_mid_on_tray: String?
+    attr_accessor recipient_crid_of_mid_on_tray_delegator: String?
+
+    # Parent references
+    attr_accessor parent_bundle_edoc_container_id: String?
+    attr_accessor parent_bundle_edoc_imb: String?
+
+    # Postage statement properties
+    attr_accessor postage_statement_finalization_datetime: DateTime?
+    attr_accessor postage_statement_finalization_facility_name: String?
+
+    # Routing code
+    attr_accessor routing_code_imtb_matching_portion: String?
+  end
+end 

data/sig/ivymeter/prop.rbs

@@ -0,0 +1,18 @@
+module IvyMeter
+  module Prop
+    def self.included: (Module base) -> void
+
+    module ClassMethods
+      def prop: (
+        Symbol name,
+        String json_name,
+        String csv_name,
+        ?type: (:string | :date | :datetime)
+      ) -> void
+    end
+
+    def initialize: () -> void
+    def []: (String key) -> untyped
+    def []=: (String key, untyped value) -> untyped
+  end
+end 

data/sig/ivymeter.rbs

@@ -0,0 +1,136 @@
+module IvyMeter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
+
+  class Event
+    include Prop
+
+    def self.inherited: (Class) -> void
+    def self.prop: (Symbol name, String json_name, String csv_name, ?type: Symbol) -> void
+    def self.property_mappings: () -> Hash[Symbol, Hash[Symbol, untyped]]
+    def self.from_json: (Hash[Symbol, untyped] json_data) -> Event
+    def self.from_csv: (Hash[Symbol, untyped] row) -> Event
+
+    def to_json: () -> String
+    def actual?: () -> bool
+    def assumed_actual?: () -> bool
+    def logical?: () -> bool
+    def assumed_logical?: () -> bool
+    def assumed?: () -> bool
+    def opcode: () -> untyped
+    def stop_the_clock_scan?: () -> bool
+    def unexpected_opcode?: () -> bool
+    def clearance_cutoff_time: () -> untyped
+    def mail_phase: () -> untyped
+    def process_description: () -> untyped
+  end
+
+  class Event::ContainerEvent < Event
+    attr_accessor container_id: String
+    attr_accessor bundle_count: Integer
+    attr_accessor edoc_container_id: String
+    attr_accessor edoc_container_zip: String
+    attr_accessor edoc_csa_agreement_id: String
+    attr_accessor edoc_customer_group_id: String
+    attr_accessor edoc_parent_container_id: String
+    attr_accessor edoc_sibling_container_id: String
+    attr_accessor edoc_user_license_code: String
+    attr_accessor fast_appointment_scheduled_datetime: Time
+    attr_accessor fast_appointment_unload_end_time: Time
+    attr_accessor fast_appointment_unload_start_time: Time
+    attr_accessor piece_count: Integer
+    attr_accessor tray_count: Integer
+    attr_accessor imcb: String
+    attr_accessor imcb_mid: String
+    attr_accessor imcb_routing_code: String
+    attr_accessor imcb_serial_number: String
+    attr_accessor imcb_stid: String
+    attr_accessor imcb_tracking_code: String
+    attr_accessor recipient_crid_of_mid_on_container: String
+    attr_accessor recipient_crid_of_mid_on_container_delegator: String
+    attr_accessor recipient_fast_scheduler_crid: String
+    attr_accessor recipient_fast_scheduler_delegator_crid: String
+    attr_accessor parent_tray_edoc_container_id: String
+    attr_accessor parent_tray_edoc_imtb: String
+    attr_accessor postage_statement_finalization_datetime: Time
+    attr_accessor postage_statement_finalization_facility_name: String
+    attr_accessor routing_code_imcb_matching_portion: String
+  end
+
+  class Event::TrayEvent < Event
+    attr_accessor tray_id: String
+    attr_accessor edoc_container_id: String
+    attr_accessor edoc_container_zip: String
+    attr_accessor edoc_csa_agreement_id: String
+    attr_accessor edoc_customer_group_id: String
+    attr_accessor edoc_parent_container_id: String
+    attr_accessor edoc_sibling_container_id: String
+    attr_accessor edoc_user_license_code: String
+    attr_accessor piece_count: Integer
+    attr_accessor imtb: String
+    attr_accessor imtb_mid: String
+    attr_accessor imtb_routing_code: String
+    attr_accessor imtb_serial_number: String
+    attr_accessor imtb_stid: String
+    attr_accessor imtb_tracking_code: String
+    attr_accessor recipient_crid_of_mid_on_tray: String
+    attr_accessor recipient_crid_of_mid_on_tray_delegator: String
+    attr_accessor parent_bundle_edoc_container_id: String
+    attr_accessor parent_bundle_edoc_imb: String
+    attr_accessor postage_statement_finalization_datetime: Time
+    attr_accessor postage_statement_finalization_facility_name: String
+    attr_accessor routing_code_imtb_matching_portion: String
+  end
+
+  class Event::BundleEvent < Event
+    attr_accessor bundle_id: String
+    attr_accessor edoc_container_id: String
+    attr_accessor edoc_container_zip: String
+    attr_accessor edoc_csa_agreement_id: String
+    attr_accessor edoc_customer_group_id: String
+    attr_accessor edoc_parent_container_id: String
+    attr_accessor edoc_sibling_container_id: String
+    attr_accessor edoc_user_license_code: String
+    attr_accessor piece_count: Integer
+    attr_accessor imb: String
+    attr_accessor imb_mid: String
+    attr_accessor imb_routing_code: String
+    attr_accessor imb_serial_number: String
+    attr_accessor imb_stid: String
+    attr_accessor imb_tracking_code: String
+    attr_accessor recipient_crid_of_mid_on_bundle: String
+    attr_accessor recipient_crid_of_mid_on_bundle_delegator: String
+    attr_accessor postage_statement_finalization_datetime: Time
+    attr_accessor postage_statement_finalization_facility_name: String
+    attr_accessor routing_code_imb_matching_portion: String
+  end
+
+  class Event::PieceEvent < Event
+    attr_accessor anticipated_delivery_date: Date
+    attr_accessor expected_delivery_date: Date
+    attr_accessor predicted_delivery_date: Date
+    attr_accessor imb: String
+    attr_accessor imb_mid: String
+    attr_accessor imb_routing_code: String
+    attr_accessor imb_serial_number: String
+    attr_accessor imb_stid: String
+    attr_accessor imb_tracking_code: String
+    attr_accessor impb: String
+    attr_accessor lde_delivery_mode: String
+    attr_accessor lde_inventory_method: String
+    attr_accessor lde_trigger_method: String
+    attr_accessor mail_phase: String
+    attr_accessor operational_status: String
+    attr_accessor parent_container_edoc_container_id: String
+    attr_accessor parent_container_edoc_imtb: String
+    attr_accessor parent_tray_edoc_container_id: String
+    attr_accessor parent_tray_edoc_imtb: String
+    attr_accessor piece_id: String
+    attr_accessor postage_statement_finalization_datetime: Time
+    attr_accessor postage_statement_finalization_facility_name: String
+    attr_accessor routing_code_imb_matching_portion: String
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ivymeter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nora
+bindir: exe
+cert_chain: []
+date: 2025-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xsv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+email:
+- nora@hackclub.com
+executables:
+- generate_operation_codes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/generate_operation_codes
+- lib/ivymeter.rb
+- lib/ivymeter/events/base.rb
+- lib/ivymeter/events/bundle.rb
+- lib/ivymeter/events/container.rb
+- lib/ivymeter/events/piece.rb
+- lib/ivymeter/events/tray.rb
+- lib/ivymeter/opcode.rb
+- lib/ivymeter/opcodes.rb
+- lib/ivymeter/prop.rb
+- lib/ivymeter/version.rb
+- sig/ivymeter.rbs
+- sig/ivymeter/events/base.rbs
+- sig/ivymeter/events/bundle.rbs
+- sig/ivymeter/events/container.rbs
+- sig/ivymeter/events/piece.rbs
+- sig/ivymeter/events/tray.rbs
+- sig/ivymeter/prop.rbs
+homepage: https://github.com/24c02/ivymeter
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/24c02/ivymeter
+  source_code_uri: https://github.com/yourusername/ivymeter
+  changelog_uri: https://github.com/yourusername/ivymeter/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: data classes for USPS' IV-MTR
+test_files: []