abn 1.2.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,22 @@
+A small class for validating Australian Business Numbers (ABN)
+
+= Installation
+
+  gem install yob-abn --source http://gems.github.com/
+
+= Usage
+
+  require 'abn'
+
+  ABN.new("12042168743").valid?
+  => true
+
+  ABN.valid_abn?("12042168743")
+  => true
+
+  ABN.valid_abn?("12042168744")
+  => false
+
+= Further Reading
+
+- http://www.clearwater.com.au/?action=code

data/lib/abn.rb

@@ -0,0 +1,45 @@
+class ABN
+
+  module Version #:nodoc:
+    Major = 1
+    Minor = 2
+    Tiny  = 0
+    
+    String = [Major, Minor, Tiny].join('.')
+  end
+
+  # Creates an ABN object representing the ABN number passed
+  # as the only parameter.
+  def initialize(num)
+    @number = num.to_s.tr ' ',''
+  end
+
+  # Returns whether the current ABN class represents a
+  # valid ABN number according to a weighting
+  # algorithm (not checked against a datbase)
+  def valid?
+    return false unless @number.length == 11
+
+    weights = [10, 1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
+    sum = 0
+    (0..10).each do |i|
+      c = @number[i,1]
+      digit = c.to_i - (i.zero? ? 1 : 0)
+      sum += weights[i] * digit
+    end
+    
+    sum % 89 == 0 ? true : false
+  end
+
+  # Correctly formats the represented ABN if valid, else returns
+  # an empty string
+  def to_s
+    valid? ? "%s%s %s%s%s %s%s%s %s%s%s" % @number.split('') : ""
+  end
+
+  # Accepts an ABN number as a String or Bignum and returns
+  # whether or not it is valid (not checked against a database)
+  def self.valid?(abn)
+    new(abn).valid?
+  end
+end

data/spec/abn_spec.rb

@@ -0,0 +1,65 @@
+$LOAD_PATH << File.dirname(__FILE__) + "/../lib"
+
+require 'spec'
+require 'abn'
+
+def bad_parameter; (1..11).to_a; end
+
+describe "The ABN class" do
+  it "should identify a valid ABN" do
+    ABN.valid?("12042168743").should be_true
+    ABN.valid?(12042168743).should   be_true
+  end
+  
+  it "should identify a preformatted valid ABN" do 
+    ABN.valid?("12 042 168 743").should be_true
+  end
+  
+  it "should have a problem with a pre-formatted invalid ABN" do
+    ABN.valid?("12 042 168 744").should be_false
+  end
+  
+  it "should have a problem with an invalid ABN" do
+    ABN.valid?("12042168744").should be_false
+    ABN.valid?("902865").should      be_false
+  end
+  
+  it "should have a problem with invalid parameters" do
+    ABN.valid?(nil).should       be_false
+    ABN.valid?(Array).should     be_false
+    ABN.valid?(Array.new).should be_false
+  end
+  
+  it "should have a problem with invalid parameter type that has a #length of 11" do
+    bad_parameter.length.should eql(11)
+    ABN.valid?(bad_parameter).should be_false
+  end
+
+  it "should be able to format a valid ABN" do
+    ABN.new("12042168743").to_s.should eql("12 042 168 743")
+  end
+  
+  it "should be able to return a pre-formatted ABN" do
+    ABN.new("12 042 168 743").to_s.should eql("12 042 168 743")
+  end
+  
+  it "should not format invalid parameter" do
+    ABN.new(nil).to_s.should       eql("")
+    ABN.new(Array).to_s.should     eql("")
+    ABN.new(Array.new).to_s.should eql("")
+  end
+  
+  it "should not format an invalid parameter type that has a #length of 11" do
+    bad_parameter.length.should eql(11)
+    ABN.new(bad_parameter).to_s.should eql("")
+  end
+  
+  it "should not format an invalid ABN" do
+    ABN.new("12042168744").to_s.should eql("")
+    ABN.new("902865").to_s.should eql("")
+  end
+
+  it "should not format an pre-formatted invalid ABN" do
+    ABN.new("12 042 168 744").to_s.should eql("")
+  end
+end

metadata

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