abn_search 0.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    abnsearch (0.0.1)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    nokogiri (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abnsearch!

data/README.rdoc

@@ -0,0 +1,37 @@
+A simple ABN search library for validating and obtaining ABN details from the Australian Business Register.
+
+PLEASE NOTE: You will need a GUID to be able to use the ABR business lookup API. You can obtain one at the following link;
+http://www.abr.business.gov.au/Register.aspx
+
+= Rails 3 Installation
+
+Simply add the following line to your Gemfile and run bundle install.
+
+  gem 'abnsearch'
+    
+= Usage
+
+  require 'abnsearch'
+
+  abn = Abnsearch.new("34355893198")
+  => #<Abnsearch:0x0000010109bc38 @errors=[], @abn="34355893198", @WSDL_URL="http://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx/ABRSearchByABN?", @ABN_LOOKUP_GUID="ac60a98a-fe5e-4a4a-bfcc-bcf30a51e1a9", @name="sony", @entity_type="IND Individual/Sole Trader"> 
+  
+  puts abn.name
+   => "sony"
+       
+  puts abn.entity_type
+  => "IND Individual/Sole Trader"  
+    
+  abn.valid?
+  => true
+
+= Errors
+If an ABN is missing, invalid or expired - check the errors attribute.
+
+  a.errors
+  => ["Business ABN 89107860122 has expired."]
+
+= Notes
+- Australian Business Register: http://www.abr.business.gov.au/
+- XML API: http://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx
+- GUID Registration link: http://www.abr.business.gov.au/Register.aspx

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/abn_search.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "abn_search"
+  s.version     = '0.0.1'
+  s.authors     = ["James Martin"]
+  s.email       = ["james@visualconnect.net"]
+  s.homepage    = "https://github.com/jamsi"
+  s.summary     = "ABNSearch library for Australian businesses."
+  s.description = "A simple ABN search library for validating and obtaining ABN details from the Australian Business Register."
+  s.rubyforge_project = "abn_search"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("nokogiri")
+end

data/lib/abn_search.rb

@@ -0,0 +1,61 @@
+require 'nokogiri'
+require 'open-uri'
+
+class ABNSearch
+  
+  module Version
+    VERSION = "0.0.1"
+  end
+  
+  attr_accessor :name, :abn, :entity_type, :errors, :guid
+  
+  def initialize(abn=nil, guid=nil)
+    self.errors = []
+    self.abn = abn unless abn.nil?
+    self.guid = abn unless guid.nil?
+    self.search
+  end
+
+  def search    
+    self.errors << "No ABN provided." && return if self.abn.nil?
+    self.errors << "No GUID provided. Please obtain one at - http://www.abr.business.gov.au/Webservices.aspx" && return if self.guid.nil?
+  
+    @WSDL_URL = 'http://abr.business.gov.au/ABRXMLSearch/AbrXmlSearch.asmx/ABRSearchByABN?'    
+    url = @WSDL_URL + "searchString=#{self.abn}&includeHistoricalDetails=n&authenticationGuid=#{self.guid}"
+    doc = Nokogiri::HTML(open(url))
+  
+    # Fetch attributes we require
+    base_path = '//html/body/abrpayloadsearchresults/response/businessentity'
+    entity_type = doc.xpath(base_path + '/entitytype')
+    abn = doc.xpath(base_path + '/abn/identifiervalue')
+    trading_name = doc.xpath(base_path + '/maintradingname/organisationname')
+    main_name = doc.xpath(base_path + '/mainname/organisationname')
+    expires = doc.xpath(base_path + '/entitystatus/entitystatuscode')
+  
+    # Did we find a valid ABN?
+    if abn[0].nil?
+      self.errors << "Invalid ABN number."
+      return
+    end
+  
+    # Is the busines still valid?
+    if expires && expires[0].content.include?("Cancelled")
+      self.errors << "Business ABN #{self.abn} has expired."
+      return
+    end
+  
+    # Set ABN business attributes
+    self.entity_type = entity_type[0].content unless entity_type[0].nil?
+  
+    # Set the business name. Sometimes there's no trading name .. but a "main name".
+    if trading_name[0].nil?
+      self.name = main_name[0].content
+    else 
+      self.name = trading_name[0].content
+    end
+  end
+  
+  def valid?
+    self.errors.size == 0
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: abn_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-11 00:00:00.000000000 +11:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153090920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153090920
+description: A simple ABN search library for validating and obtaining ABN details
+  from the Australian Business Register.
+email:
+- james@visualconnect.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- abn_search.gemspec
+- lib/abn_search.rb
+- pkg/abn_search-0.0.1.gem
+has_rdoc: true
+homepage: https://github.com/jamsi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: abn_search
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ABNSearch library for Australian businesses.
+test_files: []