eancom 1.6.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19b3025a2247de418a9ecaea334e21ab978fb152d062065473342867ced390ed
-  data.tar.gz: c943c8a90306f0bd0c681dfc4f21d958afeae3232121ea87472e5e99d536a5d7
+  metadata.gz: 37e80db4ce2849be0d078d6cc80719f660f401b0a3f3141953af97568487a6b7
+  data.tar.gz: d95843f6ca45bc82ad47d49a1f5843d137f07626d6e230d04627a9e548cec48a
 SHA512:
-  metadata.gz: 36fcd021c3d6defd6d9b0b6e1b229b035f573205a60538448bb22e03e0b907946b0929b13b620d24acc42cf83ff34d75da8b3d5596ddc5876d7c5a4e61404de3
-  data.tar.gz: 0b1cef338f4e6e1c5bb0a07e97be69cdc94c5f9fce6bf837dea9ea62809c4333f1019ee5ca9638a905e45796519a77ef4e5929b0365fce1dbef43b814bed22fd
+  metadata.gz: 9e4de3651ecc8acbe7beaf5e1f2d0a8f60d0fd1bc036af2a139c8d328bfae568585494298f555d1472fe06f0e7e0bda8324bce2e72f99e2fd9fea6c4bc0b009c
+  data.tar.gz: 020572b6a835b381c3d1519fcdf4445c53f5cc82722ca56882451e4d6bed7c39f3a61405f71c83740712060cc3eed1890ade00b0c79440ff991e666bc1c9ebba

data/.gitignore

@@ -19,7 +19,7 @@
 
 ### macOS ###
 # General
-*.DS_Store
+.DS_Store
 .AppleDouble
 .LSOverride
 
@@ -49,7 +49,6 @@ Temporary Items
 *.rbc
 capybara-*.html
 .rspec
-.rspec_status
 /db/*.sqlite3
 /db/*.sqlite3-journal
 /public/system
@@ -163,7 +162,7 @@ build-iPhoneSimulator/
 
 ### Ruby Patch ###
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
-.rubocop-https?--*
+# .rubocop-https?--*
 
 ### Vim ###
 # Swap
@@ -190,4 +189,8 @@ tags
 # Coc configuration directory
 .vim
 
-# End of https://www.gitignore.io/api/git,vim,ruby,rails,macos
+# Ignore Gemfile.lock
+Gemfile.lock
+
+# Rspec
+.rspec_status

data/.gitlab-ci.yml

@@ -1,27 +1,25 @@
-variables:
-  RUBY_DOCKER_IMAGE: eu.gcr.io/fadendaten-staging/ruby:3.0.2-alpine-dev
-
 include:
-  - project: fadendaten/infrastructure/gitlab-runner
-    file: gitlabci/base.yml
+  - project: fadendaten/meta
+    file: gitlab-ci.base.yml
+
 
 stages:
   - pre-test
-  - lint
   - test
 
 Cache assets:
   stage: pre-test
-  extends: .cache_assets:fadendaten
-
-pronto:
-  stage: pre-test
-  extends: .pronto:fadendaten
+  extends: .cache_assets
 
 rspec:
   stage: test
-  extends: .rspec:base:fadendaten
-  before_script: # exclude rake db:schema:load in before_script
+  cache:
+    key: ${CI_PROJECT_NAME}-bundle-cache
+    paths:
+      - vendor/ruby
+    policy: pull
+  image: ruby:3.0.0
+  before_script:
     - bundle check --path=vendor || bundle install --path=vendor --jobs=$(nproc)
   script:
     - bundle exec rspec spec/

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+3.0.0

data/Gemfile

@@ -3,7 +3,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in eancom.gemspec
 gemspec
 
-group :development, :lint do
-  gem 'pronto'
-  gem 'pronto-rubocop'
-end
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,69 +1,15 @@
 PATH
   remote: .
   specs:
-    eancom (1.6.3)
+    eancom (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.4.0)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    gitlab (4.18.0)
-      httparty (~> 0.18)
-      terminal-table (>= 1.5.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
-      multi_xml (>= 0.5.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     method_source (0.9.2)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
-    multi_xml (0.6.0)
-    multipart-post (2.1.1)
-    octokit (4.22.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
-    parallel (1.22.1)
-    parser (3.1.2.0)
-      ast (~> 2.4.1)
-    pronto (0.11.0)
-      gitlab (~> 4.4, >= 4.4.0)
-      httparty (>= 0.13.7)
-      octokit (~> 4.7, >= 4.7.0)
-      rainbow (>= 2.2, < 4.0)
-      rexml (~> 3.2)
-      rugged (>= 0.23.0, < 1.1.0)
-      thor (>= 0.20.3, < 2.0)
-    pronto-rubocop (0.11.1)
-      pronto (~> 0.11.0)
-      rubocop (>= 0.63.1, < 2.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -72,69 +18,41 @@ GEM
     pry-remote (0.1.8)
       pry (~> 0.9)
       slop (~> 3.0)
-    public_suffix (4.0.7)
-    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (2.4.0)
-    rexml (3.2.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (1.29.1)
-      parallel (~> 1.10)
-      parser (>= 3.1.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    rugged (1.0.1)
-    sawyer (0.8.2)
-      addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
-    simplecov (0.22.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
+    simplecov_json_formatter (0.1.2)
     slop (3.6.0)
-    terminal-table (3.0.2)
-      unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    timecop (0.9.1)
-    unicode-display_width (2.1.0)
+    timecop (0.9.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   eancom!
-  pronto
-  pronto-rubocop
   pry
   pry-nav
   pry-remote
-  rake
-  rspec
-  rubocop
+  rake (~> 12.0)
+  rspec (~> 3.0)
   simplecov
   timecop
 
 BUNDLED WITH
-   2.2.22
+   2.2.11

data/README.md

@@ -1,2 +1,48 @@
 # Eancom
 
+This software translates EDI to JSON messages.
+The following message types are supported:
+
+* ORDRSP
+* PRICAT
+* ORDERS
+* DESADV
+* INVOIC
+* SLSRPT
+* RETANN
+
+It will be expanded into a fully fledged gem later on.
+
+## Translate EDI to JSON messages
+
+In order to translate EDI to JSON messages, open the terminal and type in the following commands within the project structure.
+
+* `bin/console`<br/>
+Opens the console.
+* `edi_file = File.open('filepath')`<br/>
+Opens the EDI file that needs to be translated.
+* `json = Eancom::Parser::Document.new(file: edi_file).parse.to_json`<br/>
+Translates the EDI file to a JSON file and stores it under the name json.
+
+## Translate JSON to EDI messages
+
+Similarily, in order to translate JSON to EDI messages, open the terminal and type the following commands within the project structure.
+
+* `bin/console`<br/>
+Opens the console.
+* `json_file = File.open('filepath')`<br/>
+Opens the EDI file that needs to be translated.
+* `edi = Eancom::Factory.new(json: json_file.read).build.to_s`<br/>
+Translates the JSON file to a EDI file and stores it under the name edi.
+
+## Supported message formats
+
+The GS1 standard contains many different messaging formats. Two of the most popular ones are the D96A and the D01B formats, both of which are implemented in this translator. The main difference between them is how the messages are structured, not what kind of segments or descriptions they contain. Please respect the structure defined by these formats. Otherwise the translator may reject your file.
+
+## Usage
+
+You can add this gem to your project by either installing it using `bundle install prime-eancom` or by adding `gem "prime-eancom", "~> 0.1.0"` to your Gemfile. If you choose the latter option, go to your projects file structure within the terminal, type `bundle install` and hit `enter`. The prime-eancom now serenely inhabits your project.
+
+## Testing
+
+The prime-eancom is being tested with `rspec`. If you wan't to run the tests, go to the projects file structure within the terminal, type `rspec` and hit `enter`. You can also use `bundle exec rspec spec/` if the former option doesn't work.

data/definitions/desadv/d01b.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 Eancom::Definition.create(name: 'D01B', type: :desadv) do |document, config|
   document.header do |header|
     header.segment Eancom::Edifact::UNA.new
@@ -14,8 +12,8 @@ Eancom::Definition.create(name: 'D01B', type: :desadv) do |document, config|
       date: config.header.date,
       time: config.header.time,
       interchange_control_reference: config.header.interchange_control_reference,
-      application_reference: 'DESADV0720',
-      interchange_agreement_identifier: 'EANCOM76170270000007613067000000900',
+      application_reference: config.header.application_reference,
+      interchange_agreement_identifier: config.header.interchange_agreement_identifier,
       test_indicator: '0'
     )
 
@@ -35,106 +33,130 @@ Eancom::Definition.create(name: 'D01B', type: :desadv) do |document, config|
 
     messages.each do |message|
       body.segment Eancom::Edifact::BGM.new(
-        document_name_code: '351',
+        document_name_code: message.document_name_code,
         document_identifier: message.document_identifier,
-        message_function_code: '9'
+        message_function_code: message.message_function_code
       )
 
-      # Document Date
-      body.segment Eancom::Edifact::DTM.new(
-        type: '137',
-        date_time: message.document_message_date_time.date_time,
-        format: '204'
-      )
+      date_time_messages = message.date_time_messages
+      date_time_messages.each_with_index do |dtm, index|
+        next unless index == 0
 
-      # Delivery Date Estimated
-      if date_time = message.delivery_date_time_estimated.date_time
+        structure = Eancom.find_structure(tag: 'DTM')
+        key = dtm.identifier.intern.to_sym
         body.segment Eancom::Edifact::DTM.new(
-          type: '17',
-          date_time: date_time,
+          type: structure.dictionary_lookup(:type, dtm.identifier),
+          date_time: dtm[key].date_time,
           format: '204'
         )
       end
 
-      # Order Reference
-      if order_number_buyer = message.order_number_buyer
-        body.segment Eancom::Edifact::RFF.new(
-          reference_code_qualifier: 'ON',
-          reference_identifier: order_number_buyer.reference_identifier
+      date_time_messages.each_with_index do |dtm, index|
+        next unless index == 1
+
+        structure = Eancom.find_structure(tag: 'DTM')
+        key = dtm.identifier.intern.to_sym
+        body.segment Eancom::Edifact::DTM.new(
+          type: structure.dictionary_lookup(:type, dtm.identifier),
+          date_time: dtm[key].date_time,
+          format: '204'
         )
       end
 
-      # Buyer
-      if buyer = message.buyer
-        body.segment Eancom::Edifact::NAD.new(
-          party_function_code_qualifier: 'BY',
-          party_identifier: buyer.party_identifier,
-          code_list_responsible_agancy_code_1: '9'
+      references = message.references
+      references.each_with_index do |rff, index|
+        next unless index == 0
+        structure = Eancom.find_structure(tag: 'RFF')
+        key = rff.identifier.intern.to_sym
+        body.segment Eancom::Edifact::RFF.new(
+          reference_code_qualifier: structure.dictionary_lookup(:reference_code_qualifier, rff.identifier),
+          reference_identifier: rff[key].reference_identifier
         )
       end
 
       # Supplier
-      if supplier = message.supplier
+      nads = message.nads
+      nads.each_with_index do |nad, index|
+        next unless index == 0
+
+        structure = Eancom.find_structure(tag: 'NAD')
+        key = nad.identifier.intern.to_sym
         body.segment Eancom::Edifact::NAD.new(
-          party_function_code_qualifier: 'SU',
-          party_identifier: supplier.party_identifier,
-          code_list_responsible_agancy_code_1: '9'
+          party_function_code_qualifier: structure.dictionary_lookup(:party_function_code_qualifier, nad.identifier),
+          party_identifier: nad[key].party_identifier,
+          code_list_responsible_agency_code_1: '9'
         )
       end
 
       # Manufacturer ILN
-      if manufacturer = message.manufacturer
+      nads = message.nads
+      nads.each_with_index do |nad, index|
+        next unless index == 1
+
+        structure = Eancom.find_structure(tag: 'NAD')
+        key = nad.identifier.intern.to_sym
         body.segment Eancom::Edifact::NAD.new(
-          party_function_code_qualifier: 'MF',
-          party_identifier: manufacturer.party_identifier,
-          code_list_responsible_agancy_code_1: '9'
+          party_function_code_qualifier: structure.dictionary_lookup(:party_function_code_qualifier, nad.identifier),
+          party_identifier: nad[key].party_identifier,
+          code_list_responsible_agency_code_1: '9'
         )
       end
 
-      # Delivery Party
-      if delivery_party = message.delivery_party
+      nads = message.nads
+      nads.each_with_index do |nad, index|
+        next unless index == 2
+
+        structure = Eancom.find_structure(tag: 'NAD')
+        key = nad.identifier.intern.to_sym
         body.segment Eancom::Edifact::NAD.new(
-          party_function_code_qualifier: 'DP',
-          party_identifier: delivery_party.party_identifier,
-          code_list_responsible_agancy_code_1: '9',
-          city_name: delivery_party.city_name,
-          party_name_1: delivery_party.party_name_1,
-          postal_identification_code: delivery_party.postal_identification_code,
-          street_and_number_1: delivery_party.street_and_number_1,
-          country_name_code: delivery_party.country_name_code
+          party_function_code_qualifier: structure.dictionary_lookup(:party_function_code_qualifier, nad.identifier),
+          party_identifier: nad[key].party_identifier,
+          code_list_responsible_agency_code_1: '9',
+          city_name: nad[key].city_name,
+          party_name_1: nad[key].party_name_1,
+          postal_identification_code: nad[key].postal_identification_code,
+          street_and_number_1: nad[key].street_and_number_1,
+          country_name_code: nad[key].country_name_code
         )
       end
 
       # Ultimate consignee
-      if ultimate_consignee = message.ultimate_consignee
+      nads = message.nads
+      nads.each_with_index do |nad, index|
+        next unless index == 3
+
+        structure = Eancom.find_structure(tag: 'NAD')
+        key = nad.identifier.intern.to_sym
         body.segment Eancom::Edifact::NAD.new(
-          party_function_code_qualifier: 'UC',
-          party_identifier: ultimate_consignee.party_identifier,
-          code_list_responsible_agancy_code_1: '9',
-          city_name: ultimate_consignee.city_name,
-          party_name_1: ultimate_consignee.party_name_1,
-          postal_identification_code: ultimate_consignee.postal_identification_code,
-          street_and_number_1: ultimate_consignee.street_and_number_1,
-          country_name_code: ultimate_consignee.country_name_code
+          party_function_code_qualifier: structure.dictionary_lookup(:party_function_code_qualifier, nad.identifier),
+          party_identifier: nad[key].party_identifier,
+          code_list_responsible_agency_code_1: '9',
+          city_name: nad[key].city_name,
+          party_name_1: nad[key].party_name_1,
+          postal_identification_code: nad[key].postal_identification_code,
+          street_and_number_1: nad[key].street_and_number_1,
+          country_name_code: nad[key].country_name_code
         )
       end
 
+      structure = Eancom.find_structure(tag: 'TDT')
+      qualifier = structure.dictionary_lookup(:transport_stage_code_qualifier, message.transport_stage_code_qualifier)
       body.segment Eancom::Edifact::TDT.new(
-        transport_stage_code_qualifier: '20',
-        transport_mode_name_code: '30'
+        transport_stage_code_qualifier: qualifier,
+        transport_mode_name_code: message.transport_mode_name_code
       )
-      # Delivery Note Mode
+      # CPS can remain hardcoded.
       body.segment Eancom::Edifact::CPS.new(
         hierarchical_structure_level_identifier: '1'
       )
 
       body.segment Eancom::Edifact::PAC.new(
-        package_quantity: '1'
+        package_quantity: message.package_quantity
       )
 
       body.segment Eancom::Edifact::CPS.new(
         hierarchical_structure_level_identifier: '2',
-        hierarchical_structure_parent_identifier: '1'
+        hierarchical_structure_parent_identifier: message.hierarchical_structure_parent_identifier
       )
 
       # Items
@@ -145,59 +167,84 @@ Eancom::Definition.create(name: 'D01B', type: :desadv) do |document, config|
       items.each_with_index do |item, index|
         total_quantity += item.quantity.to_i
 
+        structure = Eancom.find_structure(tag: 'LIN')
         body.segment Eancom::Edifact::LIN.new(
-          line_item_identifier_1: item.line_item_identifier_1 || index,
+          line_item_identifier_1: (index + 1).to_s,
           item_identifier: item.ean,
-          item_type_identification_code: 'SRV'
+          item_type_identification_code: structure.dictionary_lookup(:item_type_identification_code, item.item_type_identification_code)
         )
 
         if additional_product_id = item.additional_product_id
           additional_product_id.each do |id|
-            if (additional_information = id.additional_information)
-              body.segment Eancom::Edifact::PIA.new(
-                product_identifier_code_qualifier: '1',
-                item_identifier_1: additional_information.item_identifier_1,
-                item_type_identification_code_1: 'IN'
-              )
-            end
+            next unless additional_information = id.additional_information
+
+            structure = Eancom.find_structure(tag: 'PIA')
+            body.segment Eancom::Edifact::PIA.new(
+              product_identifier_code_qualifier: structure.dictionary_lookup(:product_identifier_code_qualifier, additional_information.product_identifier_code_qualifier),
+              item_identifier_1: additional_information.item_identifier_1,
+              item_type_identification_code_1: structure.dictionary_lookup(:item_type_identification_code_1,
+                                                                           additional_information.item_type_identification_code_1)
+            )
           end
         end
 
-        body.segment Eancom::Edifact::IMD.new(
-          description_format_code: 'C',
-          item_description_code: 'CU',
-          code_list_responsible_agency_code_1: '9'
-        )
+        item_descriptions = item.item_descriptions
+        item_descriptions.each do |description|
+          structure = Eancom.find_structure(tag: 'IMD')
+          body.segment Eancom::Edifact::IMD.new(
+            description_format_code: structure.dictionary_lookup(:description_format_code,
+                                                                 description.description_format_code),
+            item_description_code: structure.dictionary_lookup(:item_description_code,
+                                                               description.item_description_code),
+            code_list_responsible_agency_code_1: structure.dictionary_lookup(:code_list_responsible_agency_code_1, description.code_list_responsible_agency_code_1)
+          )
+        end
 
-        body.segment Eancom::Edifact::QTY.new(
-          quantity_type_code_qualifier: '12',
-          quantity: item.despatch_quantity.quantity.to_s
-        )
+        quantities = item.quantities
+        quantities.each_with_index do |qty, index|
+          next unless index == 0
+          structure = Eancom.find_structure(tag: 'QTY')
+          key = qty.identifier.intern.to_sym
+          body.segment Eancom::Edifact::QTY.new(
+            quantity_type_code_qualifier: structure.dictionary_lookup(:quantity_type_code_qualifier, qty.identifier),
+            quantity: qty[key].quantity.to_s
+          )
+        end
+
+        quantities.each_with_index do |qty, index|
+          next unless index == 1
+          structure = Eancom.find_structure(tag: 'QTY')
+          key = qty.identifier.intern.to_sym
+          body.segment Eancom::Edifact::QTY.new(
+            quantity_type_code_qualifier: structure.dictionary_lookup(:quantity_type_code_qualifier, qty.identifier),
+            quantity: qty[key].quantity.to_s
+          )
+        end
 
-        body.segment Eancom::Edifact::QTY.new(
-          quantity_type_code_qualifier: '59',
-          quantity: item.despatch_quantity.quantity.to_s
-        )
 
-        if (order_number_buyer = message.order_number_buyer)
+        references = item.references
+        references.each_with_index do |rff, index|
+          structure = Eancom.find_structure(tag: 'RFF')
+          key = rff.identifier.intern.to_sym
           body.segment Eancom::Edifact::RFF.new(
-            reference_code_qualifier: 'ON',
-            reference_identifier: order_number_buyer.reference_identifier,
-            document_line_identifier: ((index + 1) * 10).to_s
+            reference_code_qualifier: structure.dictionary_lookup(:reference_code_qualifier, rff.identifier),
+            reference_identifier: rff[key].reference_identifier,
+            document_line_identifier: rff[key].document_line_identifier
           )
         end
       end
 
       body.segment Eancom::Edifact::UNT.new(
         number_of_segments_in_message: (document.total_segments + 2).to_s,
-        message_reference_number: '1'
+        message_reference_number: config.header.message_reference_number
       )
     end
   end
 
+  messages = config.body.messages
   document.footer do |footer|
     footer.segment Eancom::Edifact::UNZ.new(
-      interchange_control_count: '1',
+      interchange_control_count: messages.size.to_s,
       interchange_control_reference: config.header.interchange_control_reference.to_s
     )
   end