Integrated the business_name input field (#82)

Author: mae-smarty

Makefile

@@ -37,7 +37,7 @@ us_autocomplete_pro_api:
 	cd examples && ruby us_autocomplete_pro_example.rb
 
 us_enrichment_api:
-	cd examples && ruby us_enrichment_example.rb && ruby us_enrichment_business_example.rb && ruby us_enrichment_etag_example.rb
+	cd examples && ruby us_enrichment_example.rb && ruby us_enrichment_business_example.rb && ruby us_enrichment_etag_example.rb && ruby us_enrichment_business_name_search_example.rb
 
 us_extract_api:
 	cd examples && ruby us_extract_example.rb

examples/us_enrichment_business_name_search_example.rb

@@ -0,0 +1,76 @@
+require '../lib/smartystreets_ruby_sdk/static_credentials'
+require '../lib/smartystreets_ruby_sdk/shared_credentials'
+require '../lib/smartystreets_ruby_sdk/basic_auth_credentials'
+require '../lib/smartystreets_ruby_sdk/client_builder'
+require '../lib/smartystreets_ruby_sdk/us_enrichment/lookup'
+
+class USEnrichmentBusinessNameSearchExample
+  def run
+    id = ENV['SMARTY_AUTH_ID']
+    token = ENV['SMARTY_AUTH_TOKEN']
+    credentials = SmartyStreets::BasicAuthCredentials.new(id, token)
+
+    client = SmartyStreets::ClientBuilder.new(credentials).build_us_enrichment_api_client
+
+    business_name = "delta air"
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.business_name = business_name
+    lookup.city = "atlanta"
+
+    begin
+      summary_results = client.send_business_lookup(lookup)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if summary_results.nil? || summary_results.empty?
+      puts "No response returned for business-name search"
+      return
+    end
+
+    summary = summary_results[0]
+    if summary.businesses.nil? || summary.businesses.empty?
+      puts "No businesses found for this business name search"
+      return
+    end
+
+    puts "Summary results for BusinessName: #{business_name}"
+    summary.businesses.each do |biz|
+      puts "  - #{biz.company_name} (ID: #{biz.business_id})"
+    end
+
+    first = summary.businesses[0]
+    puts
+    puts "Fetching details for business: #{first.company_name} (ID: #{first.business_id})"
+
+    begin
+      detail_result = client.send_business_detail_lookup(first.business_id)
+    rescue SmartyStreets::SmartyError => err
+      puts err
+      return
+    end
+
+    if detail_result.nil?
+      puts "No detail result returned"
+      return
+    end
+
+    puts
+    puts "Detail result:"
+    puts "  smarty_key: #{detail_result.smarty_key}"
+    puts "  data_set_name: #{detail_result.data_set_name}"
+    puts "  business_id: #{detail_result.business_id}"
+    attrs = detail_result.attributes
+    return if attrs.nil?
+    attrs.instance_variables.each do |var|
+      value = attrs.instance_variable_get(var)
+      next if value.nil?
+      puts "  #{var.to_s.delete('@')}: #{value}"
+    end
+  end
+end
+
+example = USEnrichmentBusinessNameSearchExample.new
+example.run

examples/us_enrichment_example.rb

@@ -154,7 +154,7 @@ def print_object(label, obj)
   end
 
   def one_liner(obj)
-    obj.instance_variables.filter_map do |var|
+    obj.instance_variables.filter do |var|
       value = obj.instance_variable_get(var)
       "#{var.to_s.delete('@')}=#{value}" unless value.nil?
     end.join(' ')

lib/smartystreets_ruby_sdk/us_enrichment/client.rb

@@ -114,8 +114,8 @@ def send_generic_lookup(lookup, data_set, data_sub_set = nil)
             private
 
             def __send(lookup)
-                if lookup.nil? || (blank?(lookup.smarty_key) && blank?(lookup.street) && blank?(lookup.freeform))
-                    raise SmartyError.new("Lookup requires one of 'smartykey', 'street', or 'freeform' to be set")
+                if lookup.nil? || (blank?(lookup.smarty_key) && blank?(lookup.street) && blank?(lookup.freeform) && blank?(lookup.business_name))
+                    raise SmartyError.new("Lookup requires one of 'smarty_key', 'street', 'freeform', or 'business_name' to be set")
                 end
 
                 smarty_request = Request.new
@@ -135,6 +135,7 @@ def __send(lookup)
                     add_parameter(smarty_request, 'city', lookup.city)
                     add_parameter(smarty_request, 'state', lookup.state)
                     add_parameter(smarty_request, 'zipcode', lookup.zipcode)
+                    add_parameter(smarty_request, 'business_name', lookup.business_name)
                 else
                     if (lookup.data_sub_set.nil?)
                         smarty_request.url_components = '/' + lookup.smarty_key + '/' + lookup.data_set

lib/smartystreets_ruby_sdk/us_enrichment/lookup.rb

@@ -28,9 +28,9 @@ def add_exclude_attribute(attribute)
     end
 
     class Lookup < LookupBase
-      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode
+      attr_accessor :smarty_key, :data_set, :data_sub_set, :freeform, :street, :city, :state, :zipcode, :business_name
 
-      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, request_etag=nil, features=nil)
+      def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, street=nil, city=nil, state=nil, zipcode=nil, request_etag=nil, features=nil, business_name=nil)
         super()
         @smarty_key = smarty_key
         @data_set = data_set
@@ -42,6 +42,7 @@ def initialize(smarty_key=nil, data_set=nil, data_sub_set=nil, freeform=nil, str
         @zipcode = zipcode
         @request_etag = request_etag
         @features = features
+        @business_name = business_name
       end
     end
 

test/smartystreets_ruby_sdk/us_enrichment/test_business_summary.rb

@@ -44,6 +44,46 @@ def test_business_summary_lookup_with_freeform_builds_url
     assert_equal("street city state zipcode", sender.request.parameters["freeform"])
   end
 
+  def test_business_summary_lookup_with_business_name_search
+    sender = RequestCapturingSender.new
+    client = SmartyStreets::USEnrichment::Client.new(sender, FakeDeserializer.new(nil))
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.freeform = "1600 Amphitheatre Pkwy, Mountain View, CA"
+    lookup.business_name = "Google"
+    lookup.city = "Mountain View"
+
+    client.send_business_lookup(lookup)
+    assert_equal("/search/business", sender.request.url_components)
+    assert_equal("1600 Amphitheatre Pkwy, Mountain View, CA", sender.request.parameters["freeform"])
+    assert_equal("Google", sender.request.parameters["business_name"])
+    assert_equal("Mountain View", sender.request.parameters["city"])
+  end
+
+  def test_business_summary_lookup_without_business_name_omits_param
+    sender = RequestCapturingSender.new
+    client = SmartyStreets::USEnrichment::Client.new(sender, FakeDeserializer.new(nil))
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.freeform = "1600 Amphitheatre Pkwy, Mountain View, CA"
+
+    client.send_business_lookup(lookup)
+    assert_equal("/search/business", sender.request.url_components)
+    assert_nil(sender.request.parameters["business_name"])
+  end
+
+  def test_business_summary_lookup_with_business_name_only
+    sender = RequestCapturingSender.new
+    client = SmartyStreets::USEnrichment::Client.new(sender, FakeDeserializer.new(nil))
+
+    lookup = SmartyStreets::USEnrichment::Lookup.new
+    lookup.business_name = "Style Studio"
+
+    client.send_business_lookup(lookup)
+    assert_equal("/search/business", sender.request.url_components)
+    assert_equal("Style Studio", sender.request.parameters["business_name"])
+  end
+
   def test_business_summary_response_wraps_businesses
     obj = {
       'smarty_key' => 'key-1',