salsify-gtin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a8c676f5728c7d682a37f142e9c33bb315d85513eb1a5638fe51a5c072c2e0a
+  data.tar.gz: ffb738ff12692ab87efe8763e1869eeafcdde038d22942026f3c546bd585e252
+SHA512:
+  metadata.gz: '09f94b7bac8f4c3bba93150bb2dcf4f09550578ce1556713b0ba835678b3706aadb5529f74228b16833817c620cdc57d134a5d0a7fa8d86c43f66b3ae793b707'
+  data.tar.gz: 7f2bc78e96b9cd8e9680eb5ecd890706394123571ea10da790003514de77eb808b9fddf6d9c5e531805b639fc48f5a05e49fdbd8085fec070b0402d86f3a4021

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+AllCops:
+  Exclude:
+  - 'vendor/**/*'
+  - 'gemfiles/vendor/**/*'
+
+Style/WordArray:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.12.4
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+
+## Unreleased
+
+## 0.1.0 - 2019-01-30
+### Added
+- Initial version

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in gtin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Salsify, Inc
+
+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,63 @@
+# GTIN
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gtin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gtin
+
+## Usage
+
+This gem is all about validating GTIN-compatible identifiers and converting
+them to a standardized GTIN-14 representation. Supported input types include
+GTIN, EAN-13, UPC-A, UPC-E, ISBN-10, ISBN-13, and ISSN. Inputs must be strings
+containing only digits and include the check digit (see examples below).
+
+### Examples:
+
+```
+# UPC-A
+GTIN.to_gtin('UPC', '123412341230') => '00123412341230'
+
+# UPC-E
+GTIN.to_gtin('UPC', '1236432') => '00012300000642'
+
+# ISBN-10
+GTIN.to_gtin('ISBN', '0306406152') => '09780306406157'
+
+# ISBN-13 with an incorrect check digit
+GTIN.to_gtin('ISBN', '9780306406150') => GtinValidationError (invalid checksum)
+```
+
+## 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/salsify/gtin.## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+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 'gtin'
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update
+
+overcommit --install

data/gtin.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gtin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'salsify-gtin'
+  spec.version       = GTIN::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Validates and converts GTIN variants to standardized GTIN-14 representation'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/gtin'
+
+  spec.license       = 'MIT'
+
+
+  # Set 'allowed_push_post' to control where this gem can be published.
+  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
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'overcommit'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.52.1'
+end

data/lib/gtin.rb

@@ -0,0 +1,2 @@
+require 'gtin/version'
+require 'gtin/gtin'

data/lib/gtin/gtin.rb

@@ -0,0 +1,116 @@
+module GTIN
+  extend self
+
+  Converter = Struct.new(:standardizer, :checksum_computer)
+
+  GtinConverter = Converter.new(:standardize_gtin, :compute_checksum_gtin)
+  UpcEConverter = Converter.new(:standardize_upce, :compute_checksum_upce)
+  IsbnConverter = Converter.new(:standardize_isbn10, :compute_checksum_isbn10)
+  IssnConverter = Converter.new(:standardize_issn8, :compute_checksum_issn8)
+
+  CONVERTER_MAP = {
+    [/(GTIN|EAN)(-8)?/i, 8] => GtinConverter,
+    [/(GTIN|EAN)(-12)?/i, 12] => GtinConverter,
+    [/(GTIN|EAN|ISBN|ISSN)(-13)?/i, 13] => GtinConverter,
+    [/(GTIN|EAN)(-14)?/i, 14] => GtinConverter,
+    [/UPC(-A)?/i, 12] => GtinConverter,
+    [/UPC(-E)?/i, 7] => UpcEConverter,
+    [/ISBN(-10)?/i, 10] => IsbnConverter,
+    [/ISSN(-8)?/i, 8] => IssnConverter
+  }.freeze
+
+  GTIN_COMPATIBLE_ID_TYPES = %w(UPC GTIN EAN ISSN ISBN).freeze
+
+  GtinValidationError = Class.new(StandardError)
+
+  # raises GtinValidationError if the provided value has an invalid checksum
+  def to_gtin(id_type, value)
+    zero_pad(standardize(id_type, value))
+  end
+
+  def zero_pad(gtin)
+    gtin.rjust(14, '0')
+  end
+
+  def standardize(id_type, value, validate_checksum: true)
+    fail_on_invalid_checksum(id_type, value) if validate_checksum
+    converter = get_converter(id_type, value.length)
+    send(converter.standardizer, value)
+  end
+
+  def get_converter(id_type, value_length)
+    CONVERTER_MAP.each do |(type_matcher, length), converter|
+      return converter if type_matcher.match?(id_type) && value_length == length
+    end
+
+    raise GtinValidationError.new("No gtin converter found for #{id_type} with length #{value_length}")
+  end
+
+  def standardize_gtin(gtin)
+    gtin
+  end
+
+  def standardize_upce(upce)
+    # http://www.taltech.com/barcodesoftware/symbologies/upc
+    case upce[5]
+    when '0', '1', '2'
+      with_checksum('0' + upce.slice(0, 2) + upce[5] + '0000' + upce.slice(2, 3))
+    when '3'
+      with_checksum('0' + upce.slice(0, 3) + '00000' + upce.slice(3, 2))
+    when '4'
+      with_checksum('0' + upce.slice(0, 4) + '00000' + upce[4])
+    else
+      with_checksum('0' + upce.slice(0, 5) + '0000' + upce[5])
+    end
+  end
+
+  def standardize_issn8(issn)
+    with_checksum('977' + issn[0..-2] + '00')
+  end
+
+  def standardize_isbn10(isbn)
+    with_checksum('978' + isbn[0..-2])
+  end
+
+  def with_checksum(unchecked)
+    unchecked + compute_checksum_gtin(unchecked)
+  end
+
+  def valid_checksum?(id_type, identifier)
+    converter = get_converter(id_type, identifier.length)
+    expected_checksum = send(converter.checksum_computer, identifier[0..-2])
+    identifier[-1] == expected_checksum
+  end
+
+  def fail_on_invalid_checksum(id_type, identifier)
+    converter = get_converter(id_type, identifier.length)
+    expected_checksum = send(converter.checksum_computer, identifier[0..-2])
+    actual_checksum = identifier[-1]
+    return if actual_checksum == expected_checksum
+
+    raise GtinValidationError.new("#{id_type} #{identifier} has invalid checksum #{actual_checksum} -- expected #{expected_checksum}")
+  end
+
+  def compute_checksum_gtin(unchecked)
+    reversed_digits = unchecked.reverse.chars.map(&:to_i)
+    sum = reversed_digits.each_with_index.sum { |digit, idx| digit * (idx.odd? ? 1 : 3) }
+    ((10 - sum) % 10).to_s
+  end
+
+  def compute_checksum_isbn10(unchecked_isbn)
+    digits = unchecked_isbn.chars.map(&:to_i)
+    sum = digits.each_with_index.sum { |digit, idx| digit * (idx + 1) }
+    (sum % 11).to_s
+  end
+
+  def compute_checksum_issn8(unchecked_issn)
+    reversed_digits = unchecked_issn.reverse.chars.map(&:to_i)
+    sum = reversed_digits.each_with_index.sum { |digit, idx| digit * (idx + 2) }
+    ((11 - sum) % 11).to_s
+  end
+
+  # can't be done directly; convert to upc-a first
+  def compute_checksum_upce(unchecked_upce)
+    standardize('UPC', unchecked_upce + '0', validate_checksum: false)[-1]
+  end
+end

data/lib/gtin/version.rb

@@ -0,0 +1,3 @@
+module GTIN
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: salsify-gtin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+description: Validates and converts GTIN variants to standardized GTIN-14 representation
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".init"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gtin.gemspec
+- lib/gtin.rb
+- lib/gtin/gtin.rb
+- lib/gtin/version.rb
+homepage: https://github.com/salsify/gtin
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Validates and converts GTIN variants to standardized GTIN-14 representation
+test_files: []