abn_lookup 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17c443ef9e5e1f5a64ceb9f5023c6b63c7d5a8e9ac961ce036f69437e121c610
-  data.tar.gz: a0a8d4179f01dc7334d109f9369205e60933dbaa35c7cab65f67ad93383a8a01
+  metadata.gz: 2433d9b12d5cabd5307e7232ec143f466c0e5113e23ed588e9ccc66ccc5ccfe3
+  data.tar.gz: 873a9755fc6cbb0d3f0085e59f66896fd3fdc28a1d22b2c1ddb00894bbdd4a05
 SHA512:
-  metadata.gz: d82d72f531b739b24c986bde8c2917ebe1415253410f8144ac765af36bc3a1ce011dd992f8956b0b4461f84c869c0683969bc7309ae465c0d31eb3924d3c8cfb
-  data.tar.gz: b8b2bff6356f5e9cf3843b894b51892e181d4fb940ba90e5f562f6a911e10a9eddafef1e7bf08f172330824034ccbeb4dd10bb2fd4a00bebdcfb5043cc083ef7
+  metadata.gz: fd2a23982b225238acafe47f68d220e0bbc004205e5dc4e828e9389325d87376753b1f6069e813a82e1f6dae1456be9e6319590a0e50ee7b70435ebc9d2cb091
+  data.tar.gz: 18f28222b17398787ce99cf2765e0f67cff0429160cb9cac853b8e6fdf73f8ce1c561a9e3f71a27ec56d2cc6fcd873a0e349379cc765a46547d257e26217ac5a

data/README.md

@@ -16,7 +16,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-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
+First step is configure your 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"
@@ -30,13 +30,13 @@ If you are using Ruby On Rails you can put this in initializer folder.
 ```ruby
 AbnLookup.search_by_abn("26008672179")
 
-=> {"Abn"=>"26008672179",
- "AbnStatus"=>"Active",
- "AbnStatusEffectiveFrom"=>"1999-11-01",
- "Acn"=>"008672179",
- "AddressDate"=>"2022-01-13",
- "AddressPostcode"=>"3121",
- "AddressState"=>"VIC",
+=> {"Abn" => "26008672179",
+ "AbnStatus" => "Active",
+ "AbnStatusEffectiveFrom" => "1999-11-01",
+ "Acn" => "008672179",
+ "AddressDate" => "2022-01-13",
+ "AddressPostcode" => "3121",
+ "AddressState" => "VIC",
  "BusinessName"=>
   ["Dynamic Pods",
    "Dynamic Steel Frame",
@@ -67,24 +67,24 @@ AbnLookup.search_by_abn("26008672179")
    "NARELLAN HOMEMAKER CENTRE",
    "BUNNINGS WAREHOUSE",
    "HARDWARE CAFE"],
- "EntityName"=>"BUNNINGS GROUP LIMITED",
- "EntityTypeCode"=>"PUB",
- "EntityTypeName"=>"Australian Public Company",
- "Gst"=>"2000-07-01",
- "Message"=>""}
+ "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",
+=> {"Abn" => "26008672179",
+ "AbnStatus" => "Active",
+ "AbnStatusEffectiveFrom" => "1999-11-01",
+ "Acn" => "008672179",
+ "AddressDate" => "2022-01-13",
+ "AddressPostcode" => "3121",
+ "AddressState" => "VIC",
  "BusinessName"=>
   ["Dynamic Pods",
    "Dynamic Steel Frame",
@@ -115,30 +115,108 @@ AbnLookup.search_by_acn("008672179")
    "NARELLAN HOMEMAKER CENTRE",
    "BUNNINGS WAREHOUSE",
    "HARDWARE CAFE"],
- "EntityName"=>"BUNNINGS GROUP LIMITED",
- "EntityTypeCode"=>"PUB",
- "EntityTypeName"=>"Australian Public Company",
- "Gst"=>"2000-07-01",
- "Message"=>""}
+ "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"=>"",
+=> {"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"}]}
+  [{"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"}]}
 ```
+
+## Testing
+When writing tests for an app using AbnLookup  may be is a good ideia to avoid network calls and have return consistent, configurable results. To do this:
+
+
+**Adding a stub to search_by_abn:**
+
+```ruby
+
+AbnLookup::Test.stub_search_by_abn("26008672179",
+  AbnLookup::Abn.parse(
+    {
+      "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",
+      ],
+      "EntityName" => "BUNNINGS GROUP LIMITED",
+      "EntityTypeCode" => "PUB",
+      "EntityTypeName" => "Australian Public Company",
+      "Gst" => "2000-07-01",
+      "Message" => ""
+    }
+  )
+)
+
+AbnLookup.search_by_abn("26008672179")
+
+=> #<AbnLookup::Abn:0x3570940 @abn="26008672179" @acn="008672179" @active="true" @gst="2000-07-01" @entity_name="BUNNINGS GROUP LIMITED">
+
+
+```
+
+
+**Adding a stub to search_by_acn:**
+
+
+
+```ruby
+
+AbnLookup::Test.stub_search_by_acn("008672179",
+  AbnLookup::Abn.parse(
+    {
+      "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"
+      ],
+      "EntityName" => "BUNNINGS GROUP LIMITED",
+      "EntityTypeCode" => "PUB",
+      "EntityTypeName" => "Australian Public Company",
+      "Gst" => "2000-07-01",
+      "Message" => ""
+    }
+  )
+)
+
+AbnLookup.search_by_acn("008672179")
+
+=> #<AbnLookup::Abn:0x3570940 @abn="26008672179" @acn="008672179" @active="true" @gst="2000-07-01" @entity_name="BUNNINGS GROUP LIMITED">
+
+
+```
+
 ## 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.rb

@@ -0,0 +1,31 @@
+module AbnLookup
+  class Abn
+    attr_accessor :abn, :abn_status, :abn_status_effective_from, :acn, :address_date,
+                  :address_postcode, :address_state, :business_name, :entity_name,
+                  :entity_type_code, :entity_type_name, :gst, :message
+
+    def active?
+      abn_status == "Active"
+    end
+
+    def inspect
+      "#<#{self.class.name}:0x#{object_id} @abn=\"#{abn}\" @acn=\"#{acn}\" @active=#{active?} @gst=\"#{gst}\" @entity_name=\"#{entity_name}\">"
+    end
+
+    def self.parse(data)
+      abn = Abn.new
+
+      # Transforming PascalCase to snake_case
+      snake_case = data.each_with_object({}) do |(key, value), new_hash|
+        new_key = key.to_s.gsub(/([A-Z])/, '_\1').downcase
+        new_hash[new_key.sub(/^_/, '').to_sym] = value
+      end
+
+      snake_case.each do |key, value|
+        abn.send("#{key}=", value) if abn.respond_to?("#{key}=")
+      end
+
+      abn
+    end
+  end
+end

data/lib/abn_lookup/search_by_abn.rb

@@ -2,14 +2,24 @@
 
 module AbnLookup
   class SearchByAbn
-    def self.fetch(abn)
-      response = AbnLookup.connection.get("AbnDetails.aspx?abn=#{abn.gsub(/\s/, '')}")
-      body  = response.body
+    class << self
+      attr_accessor :stubs, :default_stub
 
-      raise InvalidGuidError if body["Message"] == "The GUID entered is not recognised as a Registered Party"
-      raise AbnNotFoundError if body["Abn"].empty?
+      def fetch(abn)
+        stub = stubs[abn] || default_stub
+        return stub if stub
 
-      AbnFormatter.formatter(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?
+
+        Abn.parse(body)
+      end
     end
+
+    @stubs = {}
+    @default_stub = nil
   end
 end

data/lib/abn_lookup/search_by_acn.rb

@@ -2,14 +2,24 @@
 
 module AbnLookup
   class SearchByAcn
-    def self.fetch(acn)
-      response = AbnLookup.connection.get("AcnDetails.aspx?acn=#{acn.gsub(/\s/, '')}")
-      response.body
+    class << self
+      attr_accessor :stubs, :default_stub
 
-      raise InvalidGuidError if body["Message"] == "The GUID entered is not recognised as a Registered Party"
-      raise AbnNotFoundError if body["Abn"].empty?
+      def fetch(acn)
+        stub = stubs[acn] || default_stub
+        return stub if stub
 
-      AbnFormatter.formatter(body)
+        response = AbnLookup.connection.get("AcnDetails.aspx?acn=#{acn.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?
+
+        Abn.parse(body)
+      end
     end
+
+    @stubs = {}
+    @default_stub = nil
   end
 end

data/lib/abn_lookup/test.rb

@@ -0,0 +1,27 @@
+module AbnLookup
+  module Test
+    def self.stub_search_by_abn(abn, result)
+      SearchByAbn.stubs[abn] = result
+    end
+
+    def self.stub_search_by_acn(acn, result)
+      SearchByAcn.stubs[acn] = result
+    end
+
+    def self.stub_search_by_name(name, result)
+      SearchByName.stubs[name] = result
+    end
+
+    def self.clear_stubs
+      SearchByAbn.stubs.clear
+      SearchByAcn.stubs.clear
+      SearchByName.stubs.clear
+    end
+
+    def self.set_default_stub(result)
+      SearchByAbn.default_stub = result
+      SearchByAcn.default_stub = result
+      SearchByName.default_stub = result
+    end
+  end
+end

data/lib/abn_lookup/version.rb

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

data/lib/abn_lookup.rb

@@ -6,9 +6,10 @@ 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"
 require "abn_lookup/abn_not_found_error"
 require "abn_lookup/invalid_guid_error"
+require "abn_lookup/test"
 
 require "faraday"
 require "faraday_middleware"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abn_lookup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Lairton Mendes
@@ -52,7 +52,7 @@ files:
 - README.md
 - Rakefile
 - lib/abn_lookup.rb
-- lib/abn_lookup/abn_formatter.rb
+- lib/abn_lookup/abn.rb
 - lib/abn_lookup/abn_not_found_error.rb
 - lib/abn_lookup/add_parameter.rb
 - lib/abn_lookup/callback_parser.rb
@@ -62,6 +62,7 @@ files:
 - lib/abn_lookup/search_by_abn.rb
 - lib/abn_lookup/search_by_acn.rb
 - lib/abn_lookup/search_by_name.rb
+- lib/abn_lookup/test.rb
 - lib/abn_lookup/version.rb
 - sig/abn_lookup.rbs
 homepage:

data/lib/abn_lookup/abn_formatter.rb

@@ -1,29 +0,0 @@
-# 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