gs1 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24b04c0b10ceed0d1bc8745d597110030cdd3d61
+  data.tar.gz: 6960554532b52b1b2e83caa82eed49d01288b356
+SHA512:
+  metadata.gz: edd1c509c1cee9d40ce143f2da1a398af424edeb52d87068d70e78bac40ecac8e8c6fdd16bc6583d55c05f7cfd86d5853d8b7d9d9123b1442d5749796f57779b
+  data.tar.gz: c5bb3a874be97053f38a957030da6d163da6f3ac69c083b9404f7bcbcf24bfdf125d0bce3b9049ef0129101109f800f5dd6861b8229409bc31b53d2126ca6067

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'gs1.gemspec'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+  - 2.5.1
+before_install: gem install bundler -v 1.16.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at stefan.ahman@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in gs1.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Stefan Åhman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# GS1
+
+GS1 provides the tools to make your code GS1 compliant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gs1'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gs1
+
+## Usage
+
+Follow the examples below to start using the gem.
+
+### Application identifiers
+
+To access the defined application identifier:
+
+```ruby
+GS1::AI::GTIN # => "01"
+```
+
+or via the class:
+
+```ruby
+GS1::ExpirationDate::AI # => "17"
+GS1::ExpirationDate.ai # => "17"
+```
+
+To get the class from a numeric id:
+
+```ruby
+GS1::AI_CLASSES[GS1::AI::BATCH_LOT] # => "GS1::Batch"
+```
+
+### Healthcare barcodes
+
+To initialize a healthcare barcode from scan input:
+
+```ruby
+GS1::Barcode::Healthcare.from_scan("01034531200000111719112510ABCD1234\u001E2110")
+# => #<GS1::Barcode::Healthcare:0x007fe1b99ea280
+#      @gtin=#<GS1::GTIN:0x007fe1b99e9a10 @errors=[], @data="03453120000011">,
+#      @expiration_date=#<GS1::ExpirationDate:0x007fe1b99e8700 @errors=[], @data="191125">,
+#      @batch=#<GS1::Batch:0x007fe1b99e3b10 @errors=[], @data="ABCD1234">,
+#      @serial_number=#<GS1::SerialNumber:0x007fe1b99e2670 @errors=[], @data="10">,
+#      @errors=[]>
+```
+
+or just get the attributes
+
+```ruby
+GS1::Barcode::Healthcare.from_scan("01034531200000111719112510ABCD1234\u001E2110")
+# => {:gtin=>"03453120000011", :expiration_date=>"191125", :batch=>"ABCD1234", :serial_number=>"10"}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apoex/gs1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gs1 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/apoex/gs1/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gs1'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gs1.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gs1/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gs1'
+  spec.version       = GS1::VERSION
+  spec.authors       = ['Stefan Åhman']
+  spec.email         = ['stefan.ahman@apoex.se']
+
+  spec.summary       = 'A ruby gem for implementing GS1 standards'
+  spec.description   = 'GS1 defines a set of GS1 standards directly from the documentation'
+  spec.homepage      = 'https://github.com/apoex/gs1'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'byebug', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rb-readline', '~> 0.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.1'
+  spec.add_development_dependency 'simplecov', '~> 0.1'
+end

data/lib/gs1/ai.rb

@@ -0,0 +1,294 @@
+# Application identifiers constants.
+#
+# Version 18.0
+# Date: Jan 2018
+# Read more: https://www.gs1.org/standards/barcodes-epcrfid-id-keys/gs1-general-specifications
+# Change log: https://www.gs1.org/genspecs/gscn_archive
+#
+module GS1
+  module AI
+    #
+    # GS1 Application Identifiers starting with digit 0
+
+    # Serial Shipping Container Code (SSCC)
+    SSCC = '00'.freeze
+
+    # Global Trade Item Number (GTIN)
+    GTIN = '01'.freeze
+
+    # GTIN of contained trade items
+    CONTENT = '02'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 1
+
+    # Batch or lot number
+    BATCH_LOT = '10'.freeze
+
+    # Production date (YYMMDD)
+    PROD_DATE = '11'.freeze
+
+    # Due date (YYMMDD)
+    DUE_DATE = '12'.freeze
+
+    # Packaging date (YYMMDD)
+    PACK_DATE = '13'.freeze
+
+    # Best before date (YYMMDD)
+    BEST_BY = '15'.freeze
+
+    # Sell by date (YYMMDD)
+    SELL_BY = '16'.freeze
+
+    # Expiration date (YYMMDD)
+    USE_BY = '17'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 2
+
+    # Variant number
+    VARIANT = '20'.freeze
+
+    # Serial number
+    SERIAL = '21'.freeze
+
+    # Consumer product variant
+    CPV = '22'.freeze
+
+    # Additional item identification
+    ADDITIONAL_ID = '240'.freeze
+
+    # Customer part number
+    CUST_PART_NO = '241'.freeze
+
+    # Made-to-Order variation number
+    MTO_VARIANT = '242'.freeze
+
+    # Packaging component number
+    PCN = '243'.freeze
+
+    # Secondary serial number
+    SECONDARY_SERIAL = '250'.freeze
+
+    # Reference to source entity
+    REF_TO_SOURCE = '251'.freeze
+
+    # Global Document Type Identifier (GDTI)
+    GDTI = '253'.freeze
+
+    # GLN extension component
+    GLN_EXTENSION_COMPONENT = '254'.freeze
+
+    # Global Coupon Number (GCN)
+    GCN = '255'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 3
+
+    # Count of items (variable measure trade item)
+    VAR_COUNT = '30'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 4
+
+    # Customer's purchase order number
+    ORDER_NUMBER = '400'.freeze
+
+    # Global Identification Number for Consignment (GINC)
+    GINC = '401'.freeze
+
+    # Global Shipment Identification Number (GSIN)
+    GSIN = '402'.freeze
+
+    # Routing code
+    ROUTE = '403'.freeze
+
+    # Ship to - Deliver to Global Location Number
+    SHIP_TO_LOC = '410'.freeze
+
+    # Bill to - Invoice to Global Location Number
+    BILL_TO = '411'.freeze
+
+    # Purchased from Global Location Number
+    PURCHASE_FROM = '412'.freeze
+
+    # Ship for - Deliver for - Forward to Global Location Number
+    SHIP_FOR_LOC = '413'.freeze
+
+    # Identification of a physical location - Global Location Number
+    LOC_NO = '414'.freeze
+
+    # Global Location Number of the invoicing party
+    PAY_TO = '415'.freeze
+
+    # GLN of the production or service location
+    PROD_SERV_LOC = '416'.freeze
+
+    # Ship to - Deliver to postal code within a single postal authority
+    SHIP_TO_POST = '420'.freeze
+
+    # Ship to - Deliver to postal code with ISO country code
+    SHIP_TO_POST_ISO = '421'.freeze
+
+    # Country of origin of a trade item
+    ORIGIN = '422'.freeze
+
+    # Country of initial processing
+    COUNTRY_INITIAL_PROCESS = '423'.freeze
+
+    # Country of processing
+    COUNTRY_PROCESS = '424'.freeze
+
+    # Country of disassembly
+    COUNTRY_DISASSEMBLY = '425'.freeze
+
+    # Country covering full process chain
+    COUNTRY_FULL_PROCESS = '426'.freeze
+
+    # Country subdivision Of origin
+    ORIGIN_SUBDIVISION = '427'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 7
+
+    # NATO Stock Number (NSN)
+    NSN = '7001'.freeze
+
+    # UN/ECE meat carcasses and cuts classification
+    MEAT_CUT = '7002'.freeze
+
+    # Expiration date and time
+    EXPIRY_TIME = '7003'.freeze
+
+    # Active potency
+    ACTIVE_POTENCY = '7004'.freeze
+
+    # Catch area
+    CATCH_AREA = '7005'.freeze
+
+    # First freeze date
+    FIRST_FREEZE_DATE = '7006'.freeze
+
+    # Harvest date
+    HARVEST_DATE = '7007'.freeze
+
+    # Species for fishery purposes
+    AQUATIC_SPECIES = '7008'.freeze
+
+    # Fishing gear type
+    FISHING_GEAR_TYPE = '7009'.freeze
+
+    # Production method
+    PROD_METHOD = '7010'.freeze
+
+    # Refurbishment lot ID
+    REFURB_LOT = '7020'.freeze
+
+    # Functional status
+    FUNC_STAT = '7021'.freeze
+
+    # Revision status N4+X..20 (FNC1)
+    REV_STAT = '7022'.freeze
+
+    # Global Individual Asset Identifier (GIAI) of an assembly
+    GIAI_ASSEMBLY = '7023'.freeze
+
+    # Number of processor with ISO Country Code N4+N3+X..27 (FNC1)
+    PROCESSOR = '703'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 8
+
+    # Roll products (width, length, core diameter, direction, splices)
+    DIMENSIONS = '8001'.freeze
+
+    # Cellular mobile telephone identifier
+    CMT_NO = '8002'.freeze
+
+    # Global Returnable Asset Identifier (GRAI)
+    GRAI = '8003'.freeze
+
+    # Global Individual Asset Identifier (GIAI)
+    GIAI = '8004'.freeze
+
+    # Price per unit of measure
+    PRICE_PER_UNIT = '8005'.freeze
+
+    # Identification of the components of a trade item
+    GCTIN = '8006'.freeze
+
+    # International Bank Account Number (IBAN)
+    IBAN = '8007'.freeze
+
+    # Date and time of production
+    PROD_TIME = '8008'.freeze
+
+    # Component / Part Identifier (CPID)
+    CPID = '8010'.freeze
+
+    # Component / Part Identifier serial number (CPID SERIAL)
+    CPID_SERIAL = '8011'.freeze
+
+    # Software version
+    VERSION = '8012'.freeze
+
+    # Global Model Number
+    GMN = '8013'.freeze
+
+    # Global Service Relation Number to identify the relationship between an organisation offering
+    # services and the provider of services
+    GSRN_PROVIDER = '8017'.freeze
+
+    # Global Service Relation Number to identify the relationship between an organisation offering
+    # services and the recipient of services
+    GSRN_RECIPIENT = '8018'.freeze
+
+    # Service Relation Instance Number (SRIN)
+    SRIN = '8019'.freeze
+
+    # Payment slip reference number
+    REF_NO = '8020'.freeze
+
+    # Coupon code identification for use in North America
+    COUPON_CODE = '8110'.freeze
+
+    # Loyalty points of a coupon
+    POINTS = '8111'.freeze
+
+    # Extended Packaging URL
+    PRODUCT_URL = '8200'.freeze
+
+    #
+    # GS1 Application Identifiers starting with digit 9
+
+    # Information mutually agreed between trading partners
+    INTERNAL = '90'.freeze
+
+    # Company internal information
+    INTERNAL1 = '91'.freeze
+
+    # Company internal information
+    INTERNAL2 = '92'.freeze
+
+    # Company internal information
+    INTERNAL3 = '93'.freeze
+
+    # Company internal information
+    INTERNAL4 = '94'.freeze
+
+    # Company internal information
+    INTERNAL5 = '95'.freeze
+
+    # Company internal information
+    INTERNAL6 = '96'.freeze
+
+    # Company internal information
+    INTERNAL7 = '97'.freeze
+
+    # Company internal information
+    INTERNAL8 = '98'.freeze
+
+    # Company internal information
+    INTERNAL9 = '99'.freeze
+  end
+end

data/lib/gs1/barcode/base.rb

@@ -0,0 +1,83 @@
+module GS1
+  module Barcode
+    # Base class for a barcode.
+    #
+    class Base
+      include Definitions
+
+      class UnknownRecordError < StandardError; end
+
+      attr_reader :errors
+
+      def initialize(options = {})
+        self.class.records.each do |record|
+          data = options.fetch(record.underscore_name, nil)
+
+          instance_variable_set("@#{record.underscore_name}", record.new(data))
+        end
+
+        @errors = []
+      end
+
+      class << self
+        def from_scan(barcode, separator: "\u001E")
+          new(scan_to_params(barcode, separator: separator))
+        end
+
+        def scan_to_params(barcode, separator: "\u001E")
+          data = barcode.chars
+
+          {}.tap do |params|
+            params.merge!(scan_to_param(data, separator)) until data.empty?
+          end
+        end
+
+        private
+
+        def scan_to_param(data, separator)
+          record = record_from_data(data)
+
+          { record.underscore_name => shift_length(data, record, separator) }
+        end
+
+        # Fetch the two first characters (interpreted as AI) from the remaining
+        # data and try to find record class. If no record class was found, fetch
+        # a third character and try again, and then finally a forth, as no AI
+        # currently have more then 4 characters.
+        def record_from_data(data)
+          ai_variants = []
+
+          record = process_ai_variants(ai_variants, data, 2) ||
+                   process_ai_variants(ai_variants, data, 1) ||
+                   process_ai_variants(ai_variants, data, 1)
+
+          return record if record
+
+          raise UnknownRecordError, "Unable to retrieve record from application identifier(s) #{ai_variants.join(', ')}"
+        end
+
+        def process_ai_variants(ai_variants, data, shifts)
+          ai_variants << ai_variants.last.to_s + data.shift(shifts).join
+
+          AI_CLASSES[ai_variants.last]
+        end
+
+        def shift_length(data, record, separator)
+          return data.shift(record.barcode_length).join if record.barcode_length
+
+          if data.find_index(separator) && data.find_index(separator) < record.barcode_max_length
+            shift_variable_length(data, separator)
+          else
+            data.shift(record.barcode_max_length).join
+          end
+        end
+
+        def shift_variable_length(data, separator)
+          data.shift(data.find_index(separator)).join.tap do
+            data.shift unless data.empty? # Shift separator character
+          end
+        end
+      end
+    end
+  end
+end