abn_lookup 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297535cb3f55808625b9ed723d9e122a77f3d0019310e9f5d42500b39c5a95a0
-  data.tar.gz: 6996911798a81c9d4d4069dc988dfbe096bc5fcb83b0916349980186999879bf
+  metadata.gz: 17c443ef9e5e1f5a64ceb9f5023c6b63c7d5a8e9ac961ce036f69437e121c610
+  data.tar.gz: a0a8d4179f01dc7334d109f9369205e60933dbaa35c7cab65f67ad93383a8a01
 SHA512:
-  metadata.gz: 3bf0ff6407bcc51d224c5923177d7c77358134b042bad00a782505ecf7e747b11f2d07b1dba9736c0dc6571adfb1e8a1ad778a4687663c4c33c4a69483bd47e8
-  data.tar.gz: 7908f8607bf11ba12e5f1ef6952b07638ac6456afd799925a2e5adba7b805e11482aefe78dde62a7b08bc98a61ef70399da27b322145645cf67381b3924f43e3
+  metadata.gz: d82d72f531b739b24c986bde8c2917ebe1415253410f8144ac765af36bc3a1ce011dd992f8956b0b4461f84c869c0683969bc7309ae465c0d31eb3924d3c8cfb
+  data.tar.gz: b8b2bff6356f5e9cf3843b894b51892e181d4fb940ba90e5f562f6a911e10a9eddafef1e7bf08f172330824034ccbeb4dd10bb2fd4a00bebdcfb5043cc083ef7

data/README.md

@@ -1,8 +1,8 @@
 # AbnLookup
 
-TODO: Delete this and the text below, and describe your gem
+ABN Lookup is the free public view of the Australian Business Register (ABR). It provides access to publicly available information supplied by businesses when they register for an Australian Business Number (ABN).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/abn_lookup`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provide a easy way to consume the JSON api.
 
 ## Installation
 
@@ -16,8 +16,129 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
-
+First step is configure you GUID key. You can request a GUID key [here](https://abr.business.gov.au/Tools/WebServices) in contact us session
+
+```ruby
+AbnLookup.guid = "your_GUID_key"
+```
+
+This is a global configuration, all api calls will use this configuration.
+
+If you are using Ruby On Rails you can put this in initializer folder.
+### Search by ABN
+
+```ruby
+AbnLookup.search_by_abn("26008672179")
+
+=> {"Abn"=>"26008672179",
+ "AbnStatus"=>"Active",
+ "AbnStatusEffectiveFrom"=>"1999-11-01",
+ "Acn"=>"008672179",
+ "AddressDate"=>"2022-01-13",
+ "AddressPostcode"=>"3121",
+ "AddressState"=>"VIC",
+ "BusinessName"=>
+  ["Dynamic Pods",
+   "Dynamic Steel Frame",
+   "TOOL KIT DEPOT",
+   "CRAFTRIGHT",
+   "ONYA PRO",
+   "PROJECT GEAR",
+   "PROJECT TOOLS",
+   "Benchmark Tools",
+   "ONYA Tools",
+   "GARDENBASICS",
+   "ADELAIDE TOOLS",
+   "Adelaide Trade Tools",
+   "Discount Power Tools (S.A.)",
+   "Electric Power Tool Services",
+   "Oaklands Mower Centre",
+   "Oaklands Road Mower Centre",
+   "Tools not Toys",
+   "CLEVER LIVING CO",
+   "BUNNINGS KITCHEN COLLECTIVE",
+   "THE KITCHEN COLLECTIVE CO",
+   "home@gladesville",
+   "Gladesville Homemaker Centre",
+   "Bunnings Outdoors",
+   "big prawn",
+   "BUNNINGS TRADE",
+   "BUNNINGS",
+   "NARELLAN HOMEMAKER CENTRE",
+   "BUNNINGS WAREHOUSE",
+   "HARDWARE CAFE"],
+ "EntityName"=>"BUNNINGS GROUP LIMITED",
+ "EntityTypeCode"=>"PUB",
+ "EntityTypeName"=>"Australian Public Company",
+ "Gst"=>"2000-07-01",
+ "Message"=>""}
+```
+### Search by ACN
+
+```ruby
+AbnLookup.search_by_acn("008672179")
+
+=> {"Abn"=>"26008672179",
+ "AbnStatus"=>"Active",
+ "AbnStatusEffectiveFrom"=>"1999-11-01",
+ "Acn"=>"008672179",
+ "AddressDate"=>"2022-01-13",
+ "AddressPostcode"=>"3121",
+ "AddressState"=>"VIC",
+ "BusinessName"=>
+  ["Dynamic Pods",
+   "Dynamic Steel Frame",
+   "TOOL KIT DEPOT",
+   "CRAFTRIGHT",
+   "ONYA PRO",
+   "PROJECT GEAR",
+   "PROJECT TOOLS",
+   "Benchmark Tools",
+   "ONYA Tools",
+   "GARDENBASICS",
+   "ADELAIDE TOOLS",
+   "Adelaide Trade Tools",
+   "Discount Power Tools (S.A.)",
+   "Electric Power Tool Services",
+   "Oaklands Mower Centre",
+   "Oaklands Road Mower Centre",
+   "Tools not Toys",
+   "CLEVER LIVING CO",
+   "BUNNINGS KITCHEN COLLECTIVE",
+   "THE KITCHEN COLLECTIVE CO",
+   "home@gladesville",
+   "Gladesville Homemaker Centre",
+   "Bunnings Outdoors",
+   "big prawn",
+   "BUNNINGS TRADE",
+   "BUNNINGS",
+   "NARELLAN HOMEMAKER CENTRE",
+   "BUNNINGS WAREHOUSE",
+   "HARDWARE CAFE"],
+ "EntityName"=>"BUNNINGS GROUP LIMITED",
+ "EntityTypeCode"=>"PUB",
+ "EntityTypeName"=>"Australian Public Company",
+ "Gst"=>"2000-07-01",
+ "Message"=>""}
+```
+### Search by Name
+
+```ruby
+AbnLookup.search_by_name("Dynamic Pods", max_result = 10)
+
+=> {"Message"=>"",
+ "Names"=>
+  [{"Abn"=>"89619123287", "AbnStatus"=>"0000000001", "IsCurrent"=>true, "Name"=>"Dynamic Pods", "NameType"=>"Business Name", "Postcode"=>"3111", "Score"=>100, "State"=>"VIC"},
+   {"Abn"=>"26008672179", "AbnStatus"=>"0000000001", "IsCurrent"=>true, "Name"=>"Dynamic Pods", "NameType"=>"Business Name", "Postcode"=>"3121", "Score"=>100, "State"=>"VIC"},
+   {"Abn"=>"89619123287", "AbnStatus"=>"0000000001", "IsCurrent"=>true, "Name"=>"DYNAMIC PODS PTY LTD", "NameType"=>"Entity Name", "Postcode"=>"3111", "Score"=>99, "State"=>"VIC"},
+   {"Abn"=>"47051861468", "AbnStatus"=>"0000000002", "IsCurrent"=>true, "Name"=>"@ DYNAMIC PTY LTD", "NameType"=>"Entity Name", "Postcode"=>"2000", "Score"=>94, "State"=>"NSW"},
+   {"Abn"=>"91451385418", "AbnStatus"=>"0000000002", "IsCurrent"=>true, "Name"=>"DYNAMIC", "NameType"=>"Trading Name", "Postcode"=>"4105", "Score"=>94, "State"=>"QLD"},
+   {"Abn"=>"55666163917", "AbnStatus"=>"0000000001", "IsCurrent"=>true, "Name"=>"DYNAMIC CO PTY LTD", "NameType"=>"Entity Name", "Postcode"=>"4035", "Score"=>94, "State"=>"QLD"},
+   {"Abn"=>"47294848908", "AbnStatus"=>"0000000002", "IsCurrent"=>true, "Name"=>"DYNAMIC PTY LTD", "NameType"=>"Trading Name", "Postcode"=>"3204", "Score"=>94, "State"=>"VIC"},
+   {"Abn"=>"63006924349", "AbnStatus"=>"0000000002", "IsCurrent"=>true, "Name"=>"DYNAMIC PTY. LTD.", "NameType"=>"Entity Name", "Postcode"=>"3059", "Score"=>94, "State"=>"VIC"},
+   {"Abn"=>"84622042537", "AbnStatus"=>"0000000002", "IsCurrent"=>true, "Name"=>"DYnamic", "NameType"=>"Trading Name", "Postcode"=>"2000", "Score"=>94, "State"=>"NSW"},
+   {"Abn"=>"55274753082", "AbnStatus"=>"0000000001", "IsCurrent"=>true, "Name"=>"Dynamic", "NameType"=>"Other Name", "Postcode"=>"5085", "Score"=>94, "State"=>"SA"}]}
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/abn_lookup/abn_formatter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module AbnLookup
+  class AbnFormatter
+    def self.formatter(body)
+      hash = {
+        abn: body["Abn"],
+        abn_status: body["AbnStatus"],
+        abn_status_effective_from: body["AbnStatusEffectiveFrom"],
+        acn: body["Acn"],
+        address_date: body["AddressDate"],
+        address_postcode: body["AddressPostcode"],
+        address_state: body["AddressState"],
+        business_name: body["BusinessName"],
+        entity_name: body["EntityName"],
+        entity_type_code: body["EntityTypeCode"],
+        entity_type_name: body["EntityTypeName"],
+        gst: body["Gst"],
+        message: body["Message"]
+      }
+
+      # build Struct
+      abn = Struct.new(*hash.keys)
+
+      # converting hash to struct
+      abn.new(*hash.values)
+    end
+  end
+end

data/lib/abn_lookup/abn_not_found_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AbnLookup
+  class AbnNotFoundError < StandardError
+    def initialize(msg = 'ABN not found')
+      super
+    end
+  end
+end

data/lib/abn_lookup/client.rb

@@ -3,6 +3,7 @@
 require "faraday"
 require_relative "callback_parser"
 require_relative "add_parameter"
+require_relative "invalid_guid_error"
 
 module AbnLookup
   class Client
@@ -14,6 +15,8 @@ module AbnLookup
 
     def initialize(adapter: Faraday.default_adapter)
       @adapter = adapter
+
+      raise AbnLookup::InvalidGuidError, 'GUID not configued.' if AbnLookup.guid.nil?
     end
 
     def connection

data/lib/abn_lookup/invalid_guid_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module AbnLookup
+  class InvalidGuidError < StandardError
+    def initialize(msg = 'InvalidGuidError: GUID is invalid')
+      super
+    end
+  end
+end

data/lib/abn_lookup/search_by_abn.rb

@@ -3,8 +3,13 @@
 module AbnLookup
   class SearchByAbn
     def self.fetch(abn)
-      response = AbnLookup.connection.get("AbnDetails.aspx?abn=#{abn}")
-      response.body
+      response = AbnLookup.connection.get("AbnDetails.aspx?abn=#{abn.gsub(/\s/, '')}")
+      body  = response.body
+
+      raise InvalidGuidError if body["Message"] == "The GUID entered is not recognised as a Registered Party"
+      raise AbnNotFoundError if body["Abn"].empty?
+
+      AbnFormatter.formatter(body)
     end
   end
 end

data/lib/abn_lookup/search_by_acn.rb

@@ -3,8 +3,13 @@
 module AbnLookup
   class SearchByAcn
     def self.fetch(acn)
-      response = AbnLookup.connection.get("AcnDetails.aspx?acn=#{acn}")
+      response = AbnLookup.connection.get("AcnDetails.aspx?acn=#{acn.gsub(/\s/, '')}")
       response.body
+
+      raise InvalidGuidError if body["Message"] == "The GUID entered is not recognised as a Registered Party"
+      raise AbnNotFoundError if body["Abn"].empty?
+
+      AbnFormatter.formatter(body)
     end
   end
 end

data/lib/abn_lookup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbnLookup
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/abn_lookup.rb

@@ -6,6 +6,9 @@ require "abn_lookup/client"
 require "abn_lookup/search_by_abn"
 require "abn_lookup/search_by_acn"
 require "abn_lookup/search_by_name"
+require "abn_lookup/abn_formatter"
+require "abn_lookup/abn_not_found_error"
+require "abn_lookup/invalid_guid_error"
 
 require "faraday"
 require "faraday_middleware"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abn_lookup
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Lairton Mendes
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,10 +52,13 @@ files:
 - README.md
 - Rakefile
 - lib/abn_lookup.rb
+- lib/abn_lookup/abn_formatter.rb
+- lib/abn_lookup/abn_not_found_error.rb
 - lib/abn_lookup/add_parameter.rb
 - lib/abn_lookup/callback_parser.rb
 - lib/abn_lookup/client.rb
 - lib/abn_lookup/configuration.rb
+- lib/abn_lookup/invalid_guid_error.rb
 - lib/abn_lookup/search_by_abn.rb
 - lib/abn_lookup/search_by_acn.rb
 - lib/abn_lookup/search_by_name.rb