eddy 0.1.0 → 0.3.0

data/lib/definitions/segments/manual/envelopes/iea.rb

@@ -0,0 +1,53 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: IEA
+    # - Name: Interchange Control Trailer
+    # - Purpose: To define the end of an interchange of zero or more functional groups and interchange-related control segments.
+    class IEA < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @param interchange_control_number [Integer]
+      # @return [void]
+      def initialize(store, interchange_control_number)
+        @id = "IEA"
+        @name = "Interchange Control Trailer"
+        @iea01 = Eddy::Elements::I16.new(ref: "IEA01", req: "M", val: store.number_of_included_functional_groups)
+        @iea02 = Eddy::Elements::I12.new(ref: "IEA02", req: "M", val: interchange_control_number)
+        super(store, @iea01, @iea02)
+      end
+
+      # ### ISA01
+      #
+      # - Id: I16
+      # - Name: Number of Included Functional Groups
+      # - Type: N0
+      # - Min/Max: 1/5
+      # - Description: A count of the number of functional groups included in an interchange
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def IEA01=(arg)
+        @iea01.value = arg
+      end
+      alias NumberOfIncludedFunctionalGroups= IEA01=
+
+      # ### ISA02
+      #
+      # - Id: I12
+      # - Name: Interchange Control Number
+      # - Type: N0
+      # - Min/Max: 9/9
+      # - Description: A control number assigned by the interchange sender
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def IEA02=(arg)
+        @iea02.value = arg
+      end
+      alias InterchangeControlNumber= IEA02=
+
+    end
+  end
+end

data/lib/definitions/segments/manual/envelopes/isa.rb

@@ -0,0 +1,295 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: ISA
+    # - Name: Interchange Control Header
+    # - Purpose: To start and identify an interchange of zero or more functional groups and interchange-related control segments.
+    class ISA < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @param interchange_control_number [Integer]
+      # @return [void]
+      def initialize(store, interchange_control_number)
+        @id = "ISA"
+        @name = "Interchange Control Header"
+        @isa01 = Eddy::Elements::I01.new(ref: "ISA01", req: "M")
+        @isa02 = Eddy::Elements::I02.new(ref: "ISA02", req: "M")
+        @isa03 = Eddy::Elements::I03.new(ref: "ISA03", req: "M")
+        @isa04 = Eddy::Elements::I04.new(ref: "ISA04", req: "M")
+        @isa05 = Eddy::Elements::I05.new(ref: "ISA05", req: "M")
+        @isa06 = Eddy::Elements::I06.new(ref: "ISA06", req: "M", val: store.application_senders_code)
+        @isa07 = Eddy::Elements::I05.new(ref: "ISA07", req: "M")
+        @isa08 = Eddy::Elements::I07.new(ref: "ISA08", req: "M", val: store.application_receivers_code)
+        @isa09 = Eddy::Elements::I08.new(ref: "ISA09", req: "M", val: store.time)
+        @isa10 = Eddy::Elements::I09.new(ref: "ISA10", req: "M", val: store.time)
+        @isa11 = Eddy::Elements::I10.new(ref: "ISA11", req: "M")
+        @isa12 = Eddy::Elements::I11.new(ref: "ISA12", req: "M", val: store.edi_version)
+        @isa13 = Eddy::Elements::I12.new(ref: "ISA13", req: "M", val: interchange_control_number)
+        @isa14 = Eddy::Elements::I13.new(ref: "ISA14", req: "M")
+        @isa15 = Eddy::Elements::I14.new(ref: "ISA15", req: "M")
+        @isa16 = Eddy::Elements::I15.new(ref: "ISA16", req: "M", val: store.component_separator)
+        super(
+          store,
+          @isa01,
+          @isa02,
+          @isa03,
+          @isa04,
+          @isa05,
+          @isa06,
+          @isa07,
+          @isa08,
+          @isa09,
+          @isa10,
+          @isa11,
+          @isa12,
+          @isa13,
+          @isa14,
+          @isa15,
+          @isa16,
+        )
+      end
+
+      # ### ISA01
+      #
+      # - Id: I01
+      # - Name: Authorization Information Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code to identify the type of information in the Authorization Information
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA01=(arg)
+        @isa01.value = arg
+      end
+      alias AuthorizationInformationQualifier= ISA01=
+
+      # ### ISA02
+      #
+      # - Id: I02
+      # - Name: Authorization Information
+      # - Type: AN
+      # - Min/Max: 10/10
+      # - Description: Information used for additional identification or authorization of the interchange sender or the data in the interchange; the type of information is set by the Authorization Information Qualifier (I01)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA02=(arg)
+        @isa02.value = arg
+      end
+      alias AuthorizationInformation= ISA02=
+
+      # ### ISA03
+      #
+      # - Id: I03
+      # - Name: Security Information Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Code to identify the type of information in the Security Information
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA03=(arg)
+        @isa03.value = arg
+      end
+      alias SecurityInformationQualifier= ISA03=
+
+      # ### ISA04
+      #
+      # - Id: I04
+      # - Name: Security Information
+      # - Type: AN
+      # - Min/Max: 10/10
+      # - Description: This is used for identifying the security information about the interchange sender or the data in the interchange; the type of information is set by the Security Information Qualifier (I03)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA04=(arg)
+        @isa04.value = arg
+      end
+      alias SecurityInformation= ISA04=
+
+      # ### ISA05
+      #
+      # - Id: I05
+      # - Name: Interchange ID Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA05=(arg)
+        @isa05.value = arg
+      end
+      alias InterchangeIdQualifier1= ISA05=
+
+      # ### ISA06
+      #
+      # - Id: I06
+      # - Name: Interchange Sender ID
+      # - Type: AN
+      # - Min/Max: 15/15
+      # - Description: Identification code published by the sender for other parties to use as the receiver ID to route data to them; the sender always codes this value in the sender ID element
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA06=(arg)
+        @isa06.value = arg
+      end
+      alias InterchangeSenderId= ISA06=
+
+      # ### ISA07
+      #
+      # - Id: I05
+      # - Name: Interchange ID Qualifier
+      # - Type: ID
+      # - Min/Max: 2/2
+      # - Description: Qualifier to designate the system/method of code structure used to designate the sender or receiver ID element being qualified
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA07=(arg)
+        @isa07.value = arg
+      end
+      alias InterchangeIdQualifier2= ISA07=
+
+      # ### ISA08
+      #
+      # - Id: I07
+      # - Name: Interchange Receiver ID
+      # - Type: AN
+      # - Min/Max: 15/15
+      # - Description: Identification code published by the receiver of the data; When sending, it is used by the sender as their sending ID, thus other parties sending to them will use this as a receiving ID to route data to them
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA08=(arg)
+        @isa08.value = arg
+      end
+      alias InterchangeReceiverId= ISA08=
+
+      # ### ISA09
+      #
+      # - Id: I08
+      # - Name: Interchange Date
+      # - Type: DT
+      # - Min/Max: 6/6
+      # - Description: Date of the interchange
+      #
+      # @param arg [Time]
+      # @return [void]
+      def ISA09=(arg)
+        @isa09.value = arg
+      end
+      alias InterchangeDate= ISA09=
+
+      # ### ISA10
+      #
+      # - Id: I09
+      # - Name: Interchange Time
+      # - Type: TM
+      # - Min/Max: 4/4
+      # - Description: Time of the interchange
+      #
+      # @param arg [Time]
+      # @return [void]
+      def ISA10=(arg)
+        @isa10.value = arg
+      end
+      alias InterchangeTime= ISA10=
+
+      # ### ISA11
+      #
+      # - Id: I10
+      # - Name: Interchange Control Standards Identifier
+      # - Type: ID
+      # - Min/Max: 1/1
+      # - Description: Code to identify the agency responsible for the control standard used by the message that is enclosed by the interchange header and trailer
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA11=(arg)
+        @isa11.value = arg
+      end
+      alias InterchangeControlStandardsIdentifier= ISA11=
+
+      # ### ISA12
+      #
+      # - Id: I11
+      # - Name: Interchange Control Version Number
+      # - Type: ID
+      # - Min/Max: 5/5
+      # - Description: This version number covers the interchange control segments
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA12=(arg)
+        @isa12.value = arg
+      end
+      alias InterchangeControlVersionNumber= ISA12=
+
+      # ### ISA13
+      #
+      # - Id: I12
+      # - Name: Interchange Control Number
+      # - Type: N0
+      # - Min/Max: 9/9
+      # - Description: A control number assigned by the interchange sender
+      #
+      # @param arg [Integer]
+      # @return [void]
+      def ISA13=(arg)
+        @isa13.value = arg
+      end
+      alias InterchangeControlNumber= ISA13=
+
+      # ### ISA14
+      #
+      # - Id: I13
+      # - Name: Acknowledgment Requested
+      # - Type: ID
+      # - Min/Max: 1/1
+      # - Description: Code sent by the sender to request an interchange acknowledgment (TA1)
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA14=(arg)
+        @isa14.value = arg
+      end
+      alias AcknowledgmentRequested= ISA14=
+
+      # ### ISA15
+      #
+      # - Id: I14
+      # - Name: Usage Indicator
+      # - Type: ID
+      # - Min/Max: 1/1
+      # - Description: Code to indicate whether data enclosed by this interchange envelope is test, production or information
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA15=(arg)
+        @isa15.value = arg
+      end
+      alias UsageIndicator= ISA15=
+
+      # ### ISA16
+      #
+      # - Id: I15
+      # - Name: Component Element Separator
+      # - Type: AN
+      # - Min/Max: 1/1
+      # - Description: Type is not applicable; the component element separator is a delimiter and not a data element; this field provides the delimiter used to separate component data elements within a composite data structure; this value must be different than the data element separator and the segment terminator
+      #
+      # @param arg [String]
+      # @return [void]
+      def ISA16=(arg)
+        @isa16.value = arg
+      end
+      alias ComponentElementSeparator= ISA16=
+
+    end
+  end
+end

data/lib/definitions/segments/manual/envelopes/se.rb

@@ -0,0 +1,52 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: SE
+    # - Name: Transaction Set Trailer
+    # - Purpose: To indicate the end of the transaction set and provide the count of the transmitted segments (including the beginning (ST) and ending (SE) segments).
+    class SE < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "SE"
+        @name = "Transaction Set Trailer"
+        @se01 = Eddy::Elements::E96.new(ref:  "SE01", req: "M")
+        @se02 = Eddy::Elements::E329.new(ref: "SE02", req: "M") # TODO: store.transaction_set_control_number
+        super(store, @se01, @se02)
+      end
+
+      # ### SE01
+      #
+      # - Id: 96
+      # - Name: Number of Included Segments
+      # - Type: N0
+      # - Min/Max: 1/10
+      # - Description: Total number of segments included in a transaction set including ST and SE segments
+      #
+      # @param arg [String]
+      # @return [void]
+      def SE01=(arg)
+        @se01.value = arg
+      end
+      alias NumberOfIncludedSegments= SE01=
+
+      # ### SE02
+      #
+      # - Id: 329
+      # - Name: Transaction Set Control Number
+      # - Type: AN
+      # - Min/Max: 4/9
+      # - Description: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
+      #
+      # @param arg [String]
+      # @return [void]
+      def SE02=(arg)
+        @se02.value = arg
+      end
+      alias TransactionSetControlNumber= SE02=
+
+    end
+  end
+end

data/lib/definitions/segments/manual/envelopes/st.rb

@@ -0,0 +1,52 @@
+module Eddy
+  module Segments
+    # ### Segment Summary:
+    #
+    # - Id: ST
+    # - Name: Transaction Set Header
+    # - Purpose: To indicate the start of a transaction set and to assign a control number.
+    class ST < Eddy::Segment
+
+      # @param store [Eddy::Data::Store]
+      # @return [void]
+      def initialize(store)
+        @id = "ST"
+        @name = "Transaction Set Header"
+        @st01 = Eddy::Elements::E143.new(ref: "ST01", req: "M")
+        @st02 = Eddy::Elements::E329.new(ref: "ST02", req: "M") # TODO: store.transaction_set_control_number
+        super(store, @st01, @st02)
+      end
+
+      # ### ST01
+      #
+      # - Id: 143
+      # - Name: Transaction Set Identifier Code
+      # - Type: ID
+      # - Min/Max: 3/3
+      # - Description: Code uniquely identifying a Transaction Set
+      #
+      # @param arg [String]
+      # @return [void]
+      def ST01=(arg)
+        @st01.value = arg
+      end
+      alias TransactionSetIdentifierCode= ST01=
+
+      # ### ST02
+      #
+      # - Id: 329
+      # - Name: Transaction Set Control Number
+      # - Type: AN
+      # - Min/Max: 4/9
+      # - Description: Identifying control number that must be unique within the transaction set functional group assigned by the originator for a transaction set
+      #
+      # @param arg [String]
+      # @return [void]
+      def ST02=(arg)
+        @st02.value = arg
+      end
+      alias TransactionSetControlNumber= ST02=
+
+    end
+  end
+end