isbn13 1.0

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile
+.DS_Store
+*.swp
+*.gem

data/README.md

@@ -0,0 +1,54 @@
+# ISBN13
+
+Validation and correct formatting of an ISBN13 number.
+
+## Usage
+
+    require 'isbn13'
+
+    ISBN13.format('9789873303111') # => '978-987-33-0311-1'
+
+    ISBN13.valid?('978-987-33-0311-1') # => true
+    ISBN13.valid?('9789873303111') # => true
+
+
+## Formatting
+
+A formatted ISBN13 number is on the form: GS1-GROUP-PUBLISHER-ITEM_NUMBER-CHECKSUM. The problem is, only GS1 and CHECKSUM has fixed lengths. The other components lengths vary according to the ranges assigned by the international/national ISBN agencies.
+
+So, how can an ISBN13 be properly hyphenated? I've found RangeMessage.xml at http://www.isbn-international.org/page/ranges containing a list of UCC / Groups prefixes which I've used initially for formatting, but later found some errors hyphenating some isbns from Uruguay.
+
+Later I've found a [ISBN10 to ISBN13 converter](http://www.isbn-international.org/ia/isbncvt) which have all the ranges defined as arrays in Javascript. And that's the data I've used to hyphenate the isbns. There's a bin/make_isbn_ranges.rb which downloads/parses the page and creates a new data file to be used by the gem.
+
+## Installation
+
+    gem install isbn13
+
+## Author
+
+[Luis Parravicini](mailto:lparravi@gmail.com)
+
+## Changelog
+
+* 2012-01-27 - Initial release
+
+## License
+
+Copyright (c) 2012 Luis Parravicini
+
+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/Rakefile

@@ -0,0 +1,13 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs    = ['lib']
+  t.verbose = false
+  t.pattern = 'test/test_*.rb'
+end
+
+task :gem do
+  %x{gem build isbn13.gemspec}
+end

data/bin/make_isbn_ranges.rb

@@ -0,0 +1,53 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'isbn13'
+require 'mechanize'
+
+# reading from a file is only intended for dev/test purposes
+content = if File.exists?('isbncvt')
+  puts 'reading ranges from local file'
+  IO.read('isbncvt')
+else
+  puts 'downloading ranges from isbn-international.org'
+  agent = Mechanize.new
+  agent.user_agent_alias = 'Mac Safari'
+
+  doc = agent.get('http://www.isbn-international.org/ia/isbncvt')
+
+  doc.at('div#wrapper script').inner_html
+end
+
+
+puts 'parsing'
+ranges = Hash.new
+# ranges are defined in javascript as:
+# ranges['xxx'][y][z] = 'first_value';
+# ranges['xxx'][y][z+1] = 'last_value';
+first = nil
+content.each_line do |line|
+  next unless line =~ /^\s*ranges\['(\d+)'\]\[\d+\]\[(\d+)\]*\s*=\s*'(\d+)'/
+  data = [$1.to_i, $2, $3]
+
+  if data[1] == '0'
+    raise "first should be nil" unless first.nil?
+    first = data.last
+  else
+    raise "first shouldnt be nil" if first.nil?
+
+    ranges[data.first] ||= { :ranges => []}
+    ranges[data.first][:ranges] << [first, data.last]
+    first = nil
+  end
+end
+
+ranges.values.each do |data|
+  data[:min], data[:max] = data[:ranges].flatten.map(&:size).minmax
+
+  data[:ranges].map! { |x| x.map!(&:to_i); Range.new(x.first, x.last) }
+end
+
+
+path = File.basename(ISBN13.ranges_path)
+puts "creating " + path
+ISBN13.save(ranges, path)
+
+puts "\nyou must replace the file #{ISBN13.ranges_path} (inside the gem) with this new file"

data/isbn13.gemspec

@@ -0,0 +1,14 @@
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = "isbn13"
+  s.version       = ISBN13::VERSION
+  s.authors       = ["Luis Parravicini"]
+  s.email         = ["lparravi@gmail.com"]
+  s.homepage      = "http://github.com/luisparravicini/isbn13"
+  s.summary       = "A library for validating and properly formatting ISBN13 numbers"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.description   = "Provides validation and proper formatting for ISBN13 numbers."
+end

data/lib/isbn13.rb

@@ -0,0 +1,90 @@
+require 'version'
+
+class ISBNError < StandardError
+end
+
+module ISBN13
+  # based on ruby example on http://en.wikipedia.org/wiki/International_Standard_Book_Number#ISBN-13
+  def self.valid?(isbn)
+    return false if isbn.nil?
+
+    isbn = isbn.gsub(/-/, '')
+    return false unless valid_form?(isbn)
+
+    sum = 0
+    13.times { |i| sum += i.modulo(2)==0 ? isbn[i].to_i : isbn[i].to_i*3 }
+    0 == sum.modulo(10)
+  end
+
+  def self.format(isbn)
+    raise ISBNError.new("#{isbn} is not a proper ISBN13 number") unless valid_form?(isbn)
+    load
+
+    breaks = [3]
+    found = false
+    size = nil
+    @ranges.keys.max.to_s.size.downto(3) do |x|
+      found = @ranges.has_key?(isbn[0, x].to_i)
+      size = x
+      break if found
+    end
+    raise ISBNError.new("group not found") unless found
+    breaks << size - breaks.first
+
+    data = @ranges[isbn[0, size].to_i]
+    pub_size = nil
+    found = false
+    data[:min].upto(isbn.size - breaks.last) do |x|
+      found = data[:ranges].any? { |range| range.cover?(isbn[size, x].to_i) }
+      pub_size = x
+      break if found
+    end
+    raise ISBNError.new("publisher not found") unless found
+    breaks << pub_size
+
+    breaks << isbn.size - breaks.reduce(&:+) - 1
+    breaks << 1
+
+    result = []
+    idx = 0
+    breaks.each do |x|
+      result << isbn[idx, x]
+      idx += x
+    end
+
+    result.join('-')
+  end
+
+  def self.ranges_path
+    File.join(File.dirname(__FILE__), 'ranges.bin')
+  end
+
+  private
+
+  def self.valid_form?(x); x =~ /^\d{13}$/; end
+
+  def self.save(ranges, path=ranges_path)
+    File.open(path, 'w') { |io| io.write Marshal.dump(ranges) }
+  end
+
+  def self.load
+    return unless @ranges.nil?
+
+    if File.exist?(ranges_path)
+      @ranges = File.open(ranges_path) { |io| Marshal.restore(io) }
+    else
+      raise "#{ranges_path} not found, run make_ranges.rb"
+    end
+  end
+end
+
+
+if $0 == __FILE__
+  isbn = ARGV.shift
+  if isbn.nil?
+    puts "usage: #{$0} <isbn>"
+    exit 1
+  end
+  puts ISBN13.format(isbn)
+end
+

data/lib/version.rb

@@ -0,0 +1,5 @@
+module ISBN13
+  VERSION = '1.0'
+end
+
+

data/test/test_isbn.rb

@@ -0,0 +1,70 @@
+require 'isbn13'
+require 'test/unit'
+
+class ISBN13Test < Test::Unit::TestCase
+  def test_format_1
+    assert_isbn '978-9974-95-536-3'
+  end
+
+  def test_format_2
+    assert_isbn '978-9974-95-519-6'
+  end
+
+  def test_format_3
+    assert_isbn '978-950-07-3803-3'
+  end
+
+  def test_format_4
+    assert_isbn '978-950-644-238-5'
+  end
+
+  def test_format_5
+    assert_isbn '978-987-33-0311-1'
+  end
+
+  def test_format_6
+    assert_isbn '978-84-323-1145-1'
+  end
+
+  def test_format_7
+    assert_isbn '978-9974-1-0026-8'
+  end
+
+  def test_format_8
+    assert_isbn '978-9974-32-269-1'
+  end
+
+  def test_invalid_format
+    assert_raise(ISBNError) { ISBN13.format('sdlkasjdlka') }
+  end
+
+  def test_valid
+    assert_true ISBN13.valid?('9789974100268')
+  end
+
+  def test_valid_hyphens
+    assert_true ISBN13.valid?('978-9974-32-269-1')
+  end
+
+  def test_invalid
+    assert_false ISBN13.valid?('9999999999999')
+  end
+
+  def test_nil
+    assert_false ISBN13.valid?(nil)
+  end
+
+  private
+
+  def assert_isbn(isbn)
+    assert_equal isbn, ISBN13.format(isbn.gsub('-', ''))
+  end
+
+  def assert_true(x)
+    assert_equal true, x
+  end
+
+  def assert_false(x)
+    assert_equal false, x
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: isbn13
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Luis Parravicini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-27 00:00:00.000000000 -03:00
+default_executable: 
+dependencies: []
+description: Provides validation and proper formatting for ISBN13 numbers.
+email:
+- lparravi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- bin/make_isbn_ranges.rb
+- isbn13.gemspec
+- lib/isbn13.rb
+- lib/ranges.bin
+- lib/version.rb
+- test/test_isbn.rb
+has_rdoc: true
+homepage: http://github.com/luisparravicini/isbn13
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A library for validating and properly formatting ISBN13 numbers
+test_files: []