ean 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 0.1.0 / 2008-02-23
+
+* First release
+  * validates 8. 12. 13. 14 GTIN/UPC/EAN identifiers
+  * generates 8. 12. 13. 14 GTIN/UPC/EAN identifiers
+

data/Licence.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008 Pascal Belloncle (http://blog.nanorails.com)
+
+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/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Licence.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO
+bin/ean
+lib/ean.rb
+lib/ean/ean.rb
+lib/ean/tasks.rb
+lib/ean/upcdatabase.rb
+lib/ean/version.rb
+spec/ean_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.txt

@@ -0,0 +1,35 @@
+= ean
+
+* http://blog.nanorails.com/ean-upc
+* http://rubyforge.org/projects/ean/
+
+== DESCRIPTION:
+
+Provide validation/generation for UPC/EAN/GTIN numbers
+
+== FEATURES/PROBLEMS:
+
+* Validate UPC/EAN/GTIN identifiers
+
+* Generate check number for UPC/EAN/GTIN identifiers
+
+== SYNOPSIS:
+
+  require "rubygems"
+  require "ean"
+
+  "1234567890128".to_gtin
+  
+  "1-234567-890128".ean?
+
+  "1234567890128".to_gtin.ean?
+
+  "784794001602".generate_check_digit
+
+== REQUIREMENTS:
+
+* hoe 1.5 (to rebuild)
+
+== INSTALL:
+
+* sudo gem install ean

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ean.rb'
+require './lib/ean/tasks'
+
+Hoe.new('ean', EAN::VERSION::STRING) do |p|
+  p.rubyforge_name = 'ean'
+  p.author = 'Pascal Belloncle (nano RAILS)'
+  p.email = 'psq@nanorails.com'
+  # p.extra_deps << ['main', '>= 2.8.0']
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  # p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+end
+
+# vim: syntax=Ruby

data/TODO

@@ -0,0 +1,3 @@
+* Integration with upcdatabase.com (either via XML-RPC or downloaded filed, need to decide what's needed first)
+
+* Support more formats.  Which one is the real question.  Will take contributions (with specs!)

data/lib/ean.rb

@@ -0,0 +1,5 @@
+$:.unshift File.dirname(__FILE__)
+
+require "ean/version"
+
+require "ean/ean"

data/lib/ean/ean.rb

@@ -0,0 +1,77 @@
+# UPC-A
+# 12 numeric values
+# GTIN-12
+
+# EAN-13
+# 13 numeric values
+# GTIN-13
+
+# UPC-E
+# 12 numeric values, suppressed 0s 
+# GTIN-12
+
+# EAN-8
+# 8 numeric values
+
+module EAN
+  def generate_check_digit
+    numbers = self.to_s.gsub(/[\D]+/, "").split(//)
+
+    checksum = 0
+    case numbers.length
+    when 7
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 11
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 12
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * (i%2*3 +(i-1)%2) end
+    when 13
+      0.upto(numbers.length-1) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    else
+      0
+    end
+
+    return ((10 - checksum % 10)%10).to_s
+  end
+
+  def ean?
+    numbers = self.to_s.gsub(/[\D]+/, "").split(//)
+
+    checksum = 0
+    case numbers.length
+    when 8
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 12
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    when 13
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * (i%2*3 +(i-1)%2) end
+    when 14
+      0.upto(numbers.length-2) do |i| checksum += numbers[i].to_i * ((i-1)%2*3 +i%2) end
+    else
+      0
+    end
+
+    return numbers[-1].to_i == (10 - checksum % 10)%10
+  end
+
+  def to_gtin
+    numbers = self.to_s.gsub(/[\D]+/, "")
+    case numbers.length
+    when 8
+      '000000'+numbers
+    when 12
+      '00'+numbers
+    when 13
+      '0'+numbers
+    when 14
+      numbers
+    else
+      '00000000000000'
+    end
+  end
+
+end
+
+class String
+  include EAN
+end

data/lib/ean/tasks.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__), %w[.. .. tasks], '**/*.rake')].each { |rake| load rake }

data/lib/ean/upcdatabase.rb

@@ -0,0 +1,11 @@
+#nothing useful here yet.  For future version
+require 'xmlrpc/client'
+
+server = XMLRPC::Client.new2('http://www.upcdatabase.com/rpc')
+@item = server.call('lookupUPC', '720642442524')
+
+# puts @item
+# => {"issuerCountry"=>"United States", "message"=>"Database entry found", "size"=>"CD", "pendingUpdates"=>0, "lastModified"=>"2001-06-24 15:17:47", "found"=>true, "mfr_comment"=>"Manufacturer is not known", "issuerCountryCode"=>"us", "description"=>"Nirvana - Nevermind", "ean"=>"0720642442524", "upc"=>"720642442524", "isCoupon"=>false}
+
+# puts "Description :: " + @item["description"]
+# puts "Type        :: " + @item["size"]

data/lib/ean/version.rb

@@ -0,0 +1,9 @@
+module EAN #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/spec/ean_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "EAN::Ean" do
+  include EAN::SpecHelpers
+  
+  before(:each) do
+  end
+  
+  after(:each) do
+  end
+
+  it "should generate for all zeros" do
+    '0-00000-00000'.generate_check_digit.should == '0'
+  end
+
+  it "should generate for single 1s" do
+    '1-00000-00000'.generate_check_digit.should == '7'
+    '0-10000-00000'.generate_check_digit.should == '9'
+    '0-01000-00000'.generate_check_digit.should == '7'
+    '0-00100-00000'.generate_check_digit.should == '9'
+    '0-00010-00000'.generate_check_digit.should == '7'
+    '0-00001-00000'.generate_check_digit.should == '9'
+    '0-00000-10000'.generate_check_digit.should == '7'
+    '0-00000-01000'.generate_check_digit.should == '9'
+    '0-00000-00100'.generate_check_digit.should == '7'
+    '0-00000-00010'.generate_check_digit.should == '9'
+    '0-00000-00001'.generate_check_digit.should == '7'
+  end
+
+  it "should generate for real numbers" do
+    samples_values.each do |value|
+      (value.chop+value.chop.generate_check_digit).should == value
+    end
+  end
+
+  it "should validate for GTIN-8" do
+    "1234555".generate_check_digit.should == "7"
+  end
+
+  it "should generate for GTIN-13" do
+    "123456789012".generate_check_digit.should == "8"
+  end
+
+  it "should generate for GTIN-14" do
+    "1234567890123".generate_check_digit.should == "1"
+  end
+
+  it "should ignore non numbers" do
+    "7sdasdasda8sdsa47asdsa9asda4as0adsa0asda1adsa60asdasdas!${%^&*}2".ean?.should == true
+  end
+
+  it "should validate for all zeros" do
+    '0-00000-00000-0'.generate_check_digit.should == '0'
+  end
+
+  it "should validate for single 1s" do
+    '1-00000-00000-7'.ean?.should == true
+    '0-10000-00000-9'.ean?.should == true
+    '0-01000-00000-7'.ean?.should == true
+    '0-00100-00000-9'.ean?.should == true
+    '0-00010-00000-7'.ean?.should == true
+    '0-00001-00000-9'.ean?.should == true
+    '0-00000-10000-7'.ean?.should == true
+    '0-00000-01000-9'.ean?.should == true
+    '0-00000-00100-7'.ean?.should == true
+    '0-00000-00010-9'.ean?.should == true
+    '0-00000-00001-7'.ean?.should == true
+  end
+
+  it "should validate for real numbers" do
+    samples_values.each do |value|
+      value.ean?.should == true
+    end
+  end
+  
+  it "should validate for GTIN-8" do
+    "12345557".ean?.should == true
+  end
+
+  it "should validate for GTIN-13" do
+    "1234567890128".ean?.should == true
+  end
+
+  it "should validate for GTIN-14" do
+    "12345678901231".ean?.should == true
+  end
+
+  it "should convert all 4 cases to gtin" do
+    "12345557".to_gtin.should == "00000012345557"
+    "784794001602".to_gtin.should == "00784794001602"
+    "1234567890128".to_gtin.should == "01234567890128"
+    "12345678901231".to_gtin.should == "12345678901231"
+  end
+
+  it "should validate converted gtin-14" do
+    "12345557".to_gtin.ean?.should == true
+    "784794001602".to_gtin.ean?.should == true
+    "1234567890128".to_gtin.ean?.should == true
+    "12345678901231".to_gtin.ean?.should == true
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format specdoc
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,118 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+
+dir = File.dirname(__FILE__)
+lib_path = File.expand_path("#{dir}/../lib")
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'ean'
+
+require "logger"
+require "fileutils"
+
+$logger = Logger.new($stderr)
+$logger.level = Logger::INFO unless $DEBUG
+
+module EAN
+  module SpecHelpers
+    def logger
+      $logger
+    end
+
+    # 0-98893-01020-3  6?
+    # 0-87396-9943107
+    # 0-867850-78133-4
+    # 7-55517-20042-5 8?
+    # 0-80887-49478-2 9?
+    
+    
+    def samples_values
+      %w(
+      7-84794-00160-2
+      0-85798-02872-6
+      8-92675-00010-8
+      0-97546-10200-8
+      7-29469-63104-3
+      7-26299-10020-6
+      0-87447-21872-4
+      0-88593-12002-2
+      0-80696-09642-6
+      7-33952-99710-3
+      0-87110-31277-3
+      0-13357-80199-2
+      6-64228-48662-8
+      0-29679-36042-0
+      0-83085-30096-8
+      0-85000-01163-8
+      7-26299-10020-6
+      8-53739-00002-1
+      6-52935-10001-2
+      0-83085-90701-3
+      0-89819-79688-5
+      0-10986-00303-2
+      0-85000-01213-0
+      8-43700-203230
+      1-88985-00013-7
+      8-437004-998163
+      0-87396-00410-2
+      8-435053-384036
+      0-82896-78040-2
+      0-89636-46000-6
+      0-85000-01211-6
+      0-18138-20902-8
+      0-87512-92005-7
+      0-80887-49374-4
+      0-80732-24701-0
+      0-85000-01054-9
+      0-83300-09551-8
+      0-85000-0103702
+      0-88534-00143-4
+      0-81308-83747-5
+      0-31259-01849-2
+      8-92186-00025-3
+      0-88593-10005-5
+      8-51718-00002-4
+      0-83837-00616-2
+      0-83085-20022-0
+      0-40426-99251-0
+      8-53763-00102-5
+      0-88553-09349-6
+      0-96619-66555-6
+      7-26319-10001-8
+      0-87356-40512-3
+      0-00579-00005-0
+      0-71570-02009-5
+      0-81753-05020-7
+      0-85155-00003-7
+      7-28691-44674-6
+      0-21130-51506-6
+      0-87512-92005-7
+      0-12894-84511-7
+      7-15126-00001-7
+      0-18138-20902-8
+      0-80887-49385-0
+      0-12354-08770-5
+      0-12354-08765-1
+      7-24826-02125-3
+      0-89121-18852-1
+      0-80696-05750-2
+      0-98652-90000-7
+      8-58517-00043-9
+      8-58517-00048-4
+      0-18138-20903-5
+      7-18742-00005-8
+      0-00579-00005-0
+      0-88232-00261-0
+      0-99988-07109-6
+      0-88534-00143-4
+      8-19960-00021-6
+      7-17888-79112-7
+      
+      )
+    end
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb','spec/commands/*_spec.rb']
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: ean
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pascal Belloncle (nano RAILS)
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDMDCCAhigAwIBAgIBADANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANwc3Ex
+  GTAXBgoJkiaJk/IsZAEZFgluYW5vcmFpbHMxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMDgwMjA0MDgzOTU3WhcNMDkwMjAzMDgzOTU3WjA+MQwwCgYDVQQDDANwc3Ex
+  GTAXBgoJkiaJk/IsZAEZFgluYW5vcmFpbHMxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9ArQhN6DW+QBDgRR4dYn1
+  F6Y4O4Gmetew3JHLuNHPuTHZxYoallfj+Kq/9GBh+gaxCWECem621M4DcHug2qzR
+  y28ojmdCwIs3vVp8HSVpPgsTCYU1hTazcf6m1n1GJzK7/Cn5tVpKtmpggMg3KRet
+  B/gLZ7V+Wmobwc9hMOq7M1EJWGGu6RO4O3AVATJbhJJrxik7fudIIxVsQXHXfSbM
+  4I+ckDg8rXQFLT05ZaeXluykbgpaBbqukEkmXdcRq7r+xHQiifyukW91/hOcI0VI
+  uymCxquaoBe6BbJyCGAqS/LAx9ghUeauiupXk7MQ2SJZR52EsAgsLwk6S6sdnmVl
+  AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBQqXXgt
+  NiMYFw60w5BVh9ZfZ35vYzANBgkqhkiG9w0BAQUFAAOCAQEABp1bJbQA89xE2eUQ
+  P70MsQxPARP9WDZ3K8/U3iwWxFBwqBkN3rA1huu9ffDSGKuReLt1peHrITUuTGwX
+  XH1kvHzCs+GMxWYvvz07NNhM+Y+mAgqpKrZnLhoWrrQyz0TEUpCmoUgDzc1evn6V
+  1pyu7zUQ6TFX20kYzOupVAwLfhaUv9Smj1YI/YI8lkqNJqpJLbm6Ib0Gr/sLkY/E
+  o1mnIpaqkxNMBS+u8/ToejKdRYOtoXb5134I8WSbkVH2mTHlVgLPVRR2uqxxyQTD
+  bYaWAJcLlC+oPUfD5uc2DkmnjUyAWSIEVQcL20dwU8WbYWp/oFmiRpvgYk4LLFs2
+  TCvXyw==
+  -----END CERTIFICATE-----
+
+date: 2008-02-23 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+description: Provide validation/generation for UPC/EAN/GTIN numbers
+email: psq@nanorails.com
+executables: 
+- ean
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Licence.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Licence.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO
+- bin/ean
+- lib/ean.rb
+- lib/ean/ean.rb
+- lib/ean/tasks.rb
+- lib/ean/upcdatabase.rb
+- lib/ean/version.rb
+- spec/ean_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://blog.nanorails.com/ean-upc
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: ean
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: Provide validation/generation for UPC/EAN/GTIN numbers
+test_files: []
+