abn_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e4fc93db90a95fde368d005a98e1bf5b4603dcc
+  data.tar.gz: 7ab0a73690b83bae2788fe67024060c1ed5ab336
+SHA512:
+  metadata.gz: 37871307c5109b26b1d535ae2f56ac4984328ecf606ba1b3ea7846bc26de248290d7deb1030650910c9893ace42a13b15e047108d81cd7a8111028e7e32d8c17
+  data.tar.gz: 145a0a33a037795e505b03fedec38927c1b7ef16a3a489c1e6b9c997a646bb3bbdfc0f14a2e7006749fb60f19d652d463143f563692e2a10a3fd8669f9eed955

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rob McFadzean
+
+MIT License
+
+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,49 @@
+AbnValidator
+============
+
+Super simple Rails validator for checking the validity of ABNs
+
+[Format of the ABN | Australian Taxation Office](https://www.ato.gov.au/Business/Australian-business-number/In-detail/Introduction/Format-of-the-ABN/)
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```
+gem 'abn_validator'
+```
+
+```
+$ bundle
+```
+
+Usage
+-----
+
+### With ActiveRecord
+
+```
+class Business < ActiveRecord::Base
+  validates :abn, abn: true
+end
+```
+
+### i18n
+
+```
+en:
+  errors:
+    messages:
+      invalid_abn: 'Invalid ABN'
+      invalid_abn_length: 'Invalid ABN Length'
+```
+
+Contributing
+------------
+
+1. Fork it ( https://github.com/wonderbread/abn_validator/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+task default: :test

data/abn_validator.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abn_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'abn_validator'
+  spec.version       = AbnValidator::VERSION
+  spec.authors       = ['Rob McFadzean']
+  spec.email         = ['root@sphericalcube.net']
+  spec.summary       = %q{Rails validator for ABNs}
+  spec.description   = %q{Rails validator for Australian Business Numbers}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_runtime_dependency 'activemodel'
+end

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  errors:
+    messages:
+      invalid_abn: 'Invalid ABN'
+      invalid_abn_length: 'Invalid ABN Length'

data/lib/abn_validator.rb

@@ -0,0 +1,7 @@
+require 'active_model/validations/abn_validator'
+require 'active_support/i18n'
+I18n.load_path += Dir.glob(File.expand_path('../../config/locales/**/*',__FILE__))
+
+
+module AbnValidator
+end

data/lib/abn_validator/version.rb

@@ -0,0 +1,3 @@
+module AbnValidator
+  VERSION = '0.1.0'
+end

data/lib/active_model/validations/abn_validator.rb

@@ -0,0 +1,35 @@
+require 'active_model'
+
+module ActiveModel
+  module Validations
+    class AbnValidator < ActiveModel::EachValidator
+
+      ABN_WEIGHTS = [10, 1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
+
+      def validate_each(record, attribute, value)
+
+        return if value.nil? || value == ''
+
+        abn = value.delete(' ').split('').map(&:to_i)
+
+        if abn.length != 11
+          record.errors.add attribute, :invalid_abn_length, value: value
+          return
+        end
+
+        abn[0] = abn[0] - 1
+        record.errors.add attribute, :invalid_abn, value: value unless abn.zip(ABN_WEIGHTS).map{|a,w|a*w}.inject(:+)/89.00 % 1 == 0
+
+      end
+    end
+
+
+    module HelperMethods
+
+      def validates_abn(*attr_names)
+        validates_with AbnValidator, _merge_attributes(attr_names)
+      end
+
+    end
+  end
+end

data/spec/abn_validator_spec.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+describe AbnValidator do
+
+  subject { TestBusiness.new }
+
+  it 'should be ok with nil ABNs' do
+    expect(subject.valid?).to be(true)
+  end
+
+  it 'should invalidate invalid ABNs' do
+    INVALID_ABNS.each do |abn|
+      subject.abn = abn
+      expect(subject.valid?).to be(false)
+    end
+  end
+
+  it 'should be ok with valid ABNs' do
+    VALID_ABNS.each do |abn|
+      subject.abn = abn
+      expect(subject.valid?).to be(true)
+    end
+  end
+
+end

data/spec/helper.rb

@@ -0,0 +1,20 @@
+require 'abn_validator'
+
+INVALID_ABNS = [
+  'AB CDE FGH JKI',
+  '11 111 111 111',
+  '53 004 085 615'
+]
+
+VALID_ABNS = [
+  '53 004 085 616',
+  '34000908716'
+]
+
+class TestBusiness
+
+  include ActiveModel::Validations
+  attr_accessor :abn
+  validates :abn, abn: true
+
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: abn_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob McFadzean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails validator for Australian Business Numbers
+email:
+- root@sphericalcube.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- abn_validator.gemspec
+- config/locales/en.yml
+- lib/abn_validator.rb
+- lib/abn_validator/version.rb
+- lib/active_model/validations/abn_validator.rb
+- spec/abn_validator_spec.rb
+- spec/helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails validator for ABNs
+test_files:
+- spec/abn_validator_spec.rb
+- spec/helper.rb