valabn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db647378c9fb65082c6840ec5023b510b71188f0
+  data.tar.gz: adfc86a26ce3245596f1fef4fdfffa379f1ae903
+SHA512:
+  metadata.gz: 2156818e94a3fa57e2471e4f62ef5a891621fbb051f42ccf7654a80f7d9329737032acb4b2510c894cdf68da230c75531ff2c7b277d1e0a1d29af7466bbc8071
+  data.tar.gz: d1a971e9374c1b76e8488c6db4c57843cb3c9281ee07852109196e55f080bf167fcb62ed3818e148c3a86ca26c9ece0fc46852a39ed887fca39ea7423b5f9425

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vidadelaempresa@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in valabn.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 xxswingxx
+
+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,73 @@
+# Valabn
+
+Valabn (read *valaban*) is a simple Australian Business Number (ABN) validator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valabn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install valabn
+
+## Usage
+
+If you just need to check the format of the ABN, just use:
+
+```ruby
+Valabn::Utils.validate_format(number) #=> Boolean
+```
+
+In order to lookup real ABN, you'll need to get a GUID (`https://abr.business.gov.au/RegisterAgreement.aspx`). Once you've got one initialize the gem like this:
+
+```ruby
+require 'valabn'
+
+Valabn::Lookup.configure do |config|
+  config.guid = APP_GUID # Your assigned GUID
+  config.cache_host = 'localhost' # (optional) The host of the redis server
+  config.cache_port = '6379' # (optional) The port of the redis server
+end
+
+```
+
+`cache_host` and `cache_port` are optional configuration attributes in order to keep a cache on a redis database. The current cache configuration lives up to two hours.
+
+After that, you invoke
+
+```ruby
+Valabn::Lookup.validate(abn) #=> Hash
+
+number = Valabn.new(abn)
+number.exists? #=> Boolean
+```
+
+## TODO:
+
+* Allow custom expiration time on the cache.
+* Integrate with `Activerecord`/`ActiveModel` as validator.
+* Add specs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/valabn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "valabn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/valabn.rb

@@ -0,0 +1,18 @@
+require 'valabn/lookup'
+
+class Valabn
+  # Instance methods
+  def initialize(number)
+    @number = number.to_s.gsub(/\W/, '')
+  end
+
+  def exists?(options = {})
+    res = Valabn::Lookup.validate(@number, options)
+
+    if res.any?
+      res[:search_by_ab_nv201408_response][:abr_payload_search_results][:response].keys.include?(:business_entity201408)
+    else
+      false
+    end
+  end
+end

data/lib/valabn/lookup.rb

@@ -0,0 +1,64 @@
+require 'savon'
+require 'json'
+require 'redis-namespace'
+require_relative 'utils'
+
+class Valabn
+  class Lookup
+
+    WSDL = 'http://www.abn.business.gov.au/abrxmlsearch/ABRXMLSearch.asmx?WSDL'
+    @@cache_host = nil
+    @@cache_port = nil
+    @@guid = nil
+
+    def self.guid=(value)
+      @@guid = value
+    end
+
+    def self.cache_host=(value)
+      @@cache_host = value
+    end
+
+    def self.cache_port=(value)
+      @@cache_port = value
+    end
+
+    def self.configure
+      yield self
+    end
+
+    def self.validate(number, options = {})
+      number = number.to_s.gsub(/\W/, '')
+
+      if Valabn::Utils.valid_format?(number)
+        cache = if @@cache_port && @@cache_host
+          redis_client = Redis.new(host: @@cache_host, port: @@cache_port, db: 15)
+          namespaced_redis = Redis::Namespace.new(:valabn_cache, redis: redis_client)
+
+          JSON.parse(namespaced_redis.get(number) || '{}', symbolize_names: true)
+        else
+          {}
+        end
+
+        if cache.any? && Time.at(cache[:expires_at]) > Time.now
+          cache
+        else
+          options[:includeHistoricalDetails] ||= 'n'
+          options[:searchString] = number
+          options[:authenticationGuid] = options[:guid] || @@guid
+
+          client = Savon.client(wsdl: WSDL)
+
+          response = JSON.parse(client.call(:search_by_ab_nv201408, message: options).body.to_json, symbolize_names: true)
+          response[:expires_at] = (Time.now + 7200).to_i
+
+          namespaced_redis.set(number, response.to_json) if @@cache_port && @@cache_host
+
+          response
+        end
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/valabn/utils.rb

@@ -0,0 +1,22 @@
+class Valabn
+  class Utils
+    def self.valid_format?(number)
+      number = number.to_s.gsub(/\W/, '')
+
+      if !!( number =~ /\A\d+{11}\z/)
+        weights = [10, 1, 3, 5, 7, 9, 11, 13, 15, 17, 19]
+        sum = 0
+
+        numbers = number.split('').map(&:to_i)
+        numbers[0] = numbers[0] - 1
+
+        numbers = numbers.zip(weights).map { |x, y| x * y }
+        sum = numbers.inject(0, :+)
+
+        (sum % 89).zero?
+      else
+        false
+      end
+    end
+  end
+end

data/lib/valabn/version.rb

@@ -0,0 +1,3 @@
+class Valabn
+  VERSION = "0.1.0"
+end

data/valabn.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'valabn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "valabn"
+  spec.version       = Valabn::VERSION
+  spec.authors       = ["xxswingxx"]
+  spec.email         = ["vidadelaempresa@gmail.com"]
+
+  spec.summary       = %q{A wrapper for validating ABN.}
+  spec.description   = %q{Validate the format and lookup ABN by using the ABN web services.}
+  spec.homepage      = "https://github.com/xxswingxx/valabn"
+  spec.license       =
+   "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "savon"
+  spec.add_development_dependency "redis"
+  spec.add_development_dependency "redis-namespace"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: valabn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- xxswingxx
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  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: redis
+  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: redis-namespace
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Validate the format and lookup ABN by using the ABN web services.
+email:
+- vidadelaempresa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/valabn.rb
+- lib/valabn/lookup.rb
+- lib/valabn/utils.rb
+- lib/valabn/version.rb
+- valabn.gemspec
+homepage: https://github.com/xxswingxx/valabn
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A wrapper for validating ABN.
+test_files: []