san 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Peter Yandell
+
+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.rdoc

@@ -0,0 +1,21 @@
+A small class for generating and validating Standard Address Numbers (SAN),
+a unique global identifier used in the book and publishing industries.
+
+= Usage
+
+  SAN.new("9013725").valid?
+  => true
+
+  SAN.valid_san?("9013725")
+  => true
+
+  SAN.valid_san?("9013726")
+  => false
+
+  SAN.check_digit?("901372")
+  => 5
+
+= Further Reader
+
+- http://www.bowker.com/index.php/component/content/article/3
+- http://www.thorpe.com.au/services/services_san.htm

data/lib/san.rb

@@ -0,0 +1,39 @@
+class SAN
+
+  class Version #:nodoc:
+    Major = 1
+    Minor = 0
+    Tiny  = 0
+    
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+  def initialize(num)
+    @number = str.to_s
+  end
+
+  def valid?
+    SAN.valid? @number
+  end
+
+  def self.valid?(san)
+    san = san.to_s
+    san.length == 7 && san == SAN.complete(san[0,6])
+  end
+  
+  # Purely for generating new SAN numbers
+  def self.complete(six_digit_san)
+    six_digit_san = six_digit_san.to_s
+    return nil unless six_digit_san.length == 6 && six_digit_san.match(/\d{6}/)
+    
+    #sum = (0..5).to_a.sum { |i| six_digit_san[i,1].to_i * (7-i) }
+    arr = (0..5).to_a.collect { |i| six_digit_san[i,1].to_i * (7-i) }
+    sum = arr.inject { |sum, n| sum + n }
+    check = 11 - (sum % 11)
+    
+    check = 0   if check == 11
+    check = 'X' if check == 10
+    
+    six_digit_san + check.to_s
+  end
+end

data/spec/san_spec.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+
+require 'spec'
+require 'san'
+
+describe "The SAN class" do
+  it "should identify a valid SAN" do
+    SAN.valid?("9013725").should be_true
+    SAN.valid?(9013725).should   be_true
+    SAN.valid?("902865X").should be_true
+  end
+  
+  it "should identify an invalid SAN" do
+    SAN.valid?(nil).should       be_false
+    SAN.valid?("902865").should  be_false
+    SAN.valid?(Array).should     be_false
+    SAN.valid?(Array.new).should be_false
+  end
+
+  it "should calculate a SAN check digit correctly" do
+    SAN.complete("901372").should eql("9013725")
+    SAN.complete(901372).should  eql("9013725")
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: san
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- James Healy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-16 00:00:00 +10:00
+default_executable: 
+dependencies: []
+
+description: a (very) small library for working with Standard Address Numbers.
+email: jimmy@deefa.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/san.rb
+- MIT-LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/yob/san/tree/master
+post_install_message: 
+rdoc_options: 
+- --title
+- SAN
+- --line-numbers
+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: san
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: a (very) small library for working with Standard Address Numbers.
+test_files: 
+- spec/san_spec.rb