ABN Searches made easy!
Ruby
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
Gemfile
MIT-LICENSE
README.md
Rakefile
abn_search.gemspec
circle.yml

README.md

abn_search CircleCI Coverage Status

A simple ABN search library for validating and obtaining ABN details from the Australian Business Register.

Setup

Dependencies

  • Ruby 2.0 +

  • bundler

ABR GUID

You will need a GUID to be able to use the ABR business lookup API. You can obtain one at the following link; http://abr.business.gov.au/Documentation/UserGuideWebRegistration.aspx

Rails Installation

Simply add the following line to your Gemfile and run bundle install.

gem 'abn_search'

Tests

You can run the test suite with

bundle exec rake

or

bundle exec rake rspec

Please ensure that you write tests for any commits, and that tests pass locally before you submit a PR.

Usage

To start IRB with the gem

bundle exec rake console

Set up a client

client = Abn::Search.new("YOUR_GUID_HERE")

Search by ABN Number

result = client.search("59001215354")
# => {:acn=>"001215354", ":abn=>"59001215354", :entity_type=>"Australian Public Company", :status=>"Active", :main_name=>"SONY AUSTRALIA LIMITED", :trading_name=>"", :legal_name=>"", :other_trading_name=>"", :name=>"SONY AUSTRALIA LIMITED"}

puts result[:entity_type]
# => "Australian Public Company"

puts result[:status]
# => "Active"

puts result[:name]
# => "SONY AUSTRALIA LIMITED"

Search by ACN Number

result = client.search_by_acn("001215354")
# => {:acn=>"001215354", ":abn=>"59001215354", :entity_type=>"Australian Public Company", :status=>"Active", :main_name=>"SONY AUSTRALIA LIMITED", :trading_name=>"", :legal_name=>"", :other_trading_name=>"", :name=>"SONY AUSTRALIA LIMITED"}

Search by name

results = client.search_by_name("Sony", ['NSW'], '2000')
results.each do |result|
  puts result[:name]
end

Errors

If an ABN is missing, invalid or expired - check the errors attribute.

client.errors
# => ["Business ABN 89107860122 has expired."]

External Resources