eancom 0.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66282d8cdd5814a9cd6ddb733530d578c025da6b215e577a0d5f890b1324295f
-  data.tar.gz: 39b225da80ab4dbc9886259b7cf61146e68364855f5f584c66348daee02e31d1
+  metadata.gz: 37e80db4ce2849be0d078d6cc80719f660f401b0a3f3141953af97568487a6b7
+  data.tar.gz: d95843f6ca45bc82ad47d49a1f5843d137f07626d6e230d04627a9e548cec48a
 SHA512:
-  metadata.gz: a0efc78d25648823163e8e2e19b8c7e5aea2db94206bdf691ef1a2ba066501b8bc72799ad6de0d89dc42d66999600a61595dbb3f83e3a855fe088ddf7257f56c
-  data.tar.gz: 5791816403f0ebd74821f43c8fc8aaa8f609c9f44fb99429ed61e59eb1c91ea8122a220fc9f9ec960b2019adbad5bed239bf2301f6d536aa4f7da5f5aa6d1bfe
+  metadata.gz: 9e4de3651ecc8acbe7beaf5e1f2d0a8f60d0fd1bc036af2a139c8d328bfae568585494298f555d1472fe06f0e7e0bda8324bce2e72f99e2fd9fea6c4bc0b009c
+  data.tar.gz: 020572b6a835b381c3d1519fcdf4445c53f5cc82722ca56882451e4d6bed7c39f3a61405f71c83740712060cc3eed1890ade00b0c79440ff991e666bc1c9ebba

data/.gitignore

@@ -1,11 +1,196 @@
-/.bundle/
-/.yardoc
-/_yardoc/
+
+# Created by https://www.gitignore.io/api/git,vim,ruby,rails,macos
+# Edit at https://www.gitignore.io/?templates=git,vim,ruby,rails,macos
+
+### Git ###
+# Created by git for backups. To disable backups in Git:
+# $ git config --global mergetool.keepBackup false
+*.orig
+
+# Created by git when using merge tools for conflicts
+*.BACKUP.*
+*.BASE.*
+*.LOCAL.*
+*.REMOTE.*
+*_BACKUP_*.txt
+*_BASE_*.txt
+*_LOCAL_*.txt
+*_REMOTE_*.txt
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Rails ###
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
 /coverage/
-/doc/
+/spec/tmp
+rerun.txt
+pickle-email-*.html
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+### Ruby ###
+*.gem
+/.config
+/InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
 /tmp/
 
-# rspec failure tracking
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+
+### Ruby Patch ###
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+Sessionx.vim
+
+# Temporary
+.netrwhist
+*~
+
+# Auto-generated tag files
+tags
+
+# Persistent undo
+[._]*.un~
+
+# Coc configuration directory
+.vim
+
+# Ignore Gemfile.lock
+Gemfile.lock
+
+# Rspec
 .rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,25 @@
+include:
+  - project: fadendaten/meta
+    file: gitlab-ci.base.yml
+
+
+stages:
+  - pre-test
+  - test
+
+Cache assets:
+  stage: pre-test
+  extends: .cache_assets
+
+rspec:
+  stage: test
+  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

@@ -0,0 +1 @@
+3.0.0

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    eancom (0.1.0)
+    eancom (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    docile (1.3.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     method_source (0.9.2)
     pry (0.12.2)
       coderay (~> 1.1.0)
@@ -19,24 +19,27 @@ GEM
       pry (~> 0.9)
       slop (~> 3.0)
     rake (12.3.3)
-    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)
-    simplecov (0.18.5)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     slop (3.6.0)
+    timecop (0.9.4)
 
 PLATFORMS
   ruby
@@ -49,6 +52,7 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   simplecov
+  timecop
 
 BUNDLED WITH
-   2.1.4
+   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/bin/console

@@ -10,5 +10,6 @@ require "eancom"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start(__FILE__)
+# require "irb"
+require 'pry'
+Pry.start

data/definitions/desadv/d01b.rb

@@ -0,0 +1,251 @@
+Eancom::Definition.create(name: 'D01B', type: :desadv) do |document, config|
+  document.header do |header|
+    header.segment Eancom::Edifact::UNA.new
+
+    header.segment Eancom::Edifact::UNB.new(
+      syntax_identifier: 'UNOC',
+      syntax_version_number: '3',
+      interchange_sender_identification: config.header.interchange_sender_identification,
+      sender_identifiction_code_qualifier: '14',
+      interchange_recipient_identification: config.header.interchange_recipient_identification,
+      recipient_identifiction_code_qualifier: '14',
+      date: config.header.date,
+      time: config.header.time,
+      interchange_control_reference: config.header.interchange_control_reference,
+      application_reference: config.header.application_reference,
+      interchange_agreement_identifier: config.header.interchange_agreement_identifier,
+      test_indicator: '0'
+    )
+
+    header.segment Eancom::Edifact::UNH.new(
+      message_reference_number: config.header.message_reference_number,
+      message_type: config.header.message_type,
+      message_version_number: config.header.message_version_number,
+      message_release_number: config.header.message_release_number,
+      controlling_agency: config.header.controlling_agency,
+      association_assigned_code: config.header.association_assigned_code
+    )
+  end
+
+  document.body do |body|
+    # Messages
+    messages = config.body.messages
+
+    messages.each do |message|
+      body.segment Eancom::Edifact::BGM.new(
+        document_name_code: message.document_name_code,
+        document_identifier: message.document_identifier,
+        message_function_code: message.message_function_code
+      )
+
+      date_time_messages = message.date_time_messages
+      date_time_messages.each_with_index do |dtm, index|
+        next unless index == 0
+
+        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
+
+      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
+
+      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
+      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: 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
+      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: structure.dictionary_lookup(:party_function_code_qualifier, nad.identifier),
+          party_identifier: nad[key].party_identifier,
+          code_list_responsible_agency_code_1: '9'
+        )
+      end
+
+      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: 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
+      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: 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: qualifier,
+        transport_mode_name_code: message.transport_mode_name_code
+      )
+      # CPS can remain hardcoded.
+      body.segment Eancom::Edifact::CPS.new(
+        hierarchical_structure_level_identifier: '1'
+      )
+
+      body.segment Eancom::Edifact::PAC.new(
+        package_quantity: message.package_quantity
+      )
+
+      body.segment Eancom::Edifact::CPS.new(
+        hierarchical_structure_level_identifier: '2',
+        hierarchical_structure_parent_identifier: message.hierarchical_structure_parent_identifier
+      )
+
+      # Items
+      total_quantity = 0
+
+      items = message.items
+
+      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: (index + 1).to_s,
+          item_identifier: item.ean,
+          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|
+            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
+
+        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
+
+        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
+
+
+        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: 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: config.header.message_reference_number
+      )
+    end
+  end
+
+  messages = config.body.messages
+  document.footer do |footer|
+    footer.segment Eancom::Edifact::UNZ.new(
+      interchange_control_count: messages.size.to_s,
+      interchange_control_reference: config.header.interchange_control_reference.to_s
+    )
+  end
+end