smartystreets_ruby_sdk 0.0.0 → 1.0.0

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -2,77 +2,64 @@ require_relative '../batch'
 require_relative '../request'
 require_relative 'candidate'
 
-module SmartyStreets
-  module USStreet
-    # It is recommended to instantiate this class using ClientBuilder.build_us_street_api_client
-    class Client
-      def initialize(sender, serializer)
-        @sender = sender
-        @serializer = serializer
-      end
-
-      # Sends a Lookup object to the US Street API and stores the result in the Lookup's result field.
-      def send_lookup(lookup)
-        batch = SmartyStreets::Batch.new
-        batch.add(lookup)
-        send_batch(batch)
-      end
+module USStreet
+  class Client
+    def initialize(sender, serializer)
+      @sender = sender
+      @serializer = serializer
+    end
 
-      # Sends a Batch object containing no more than 100 Lookup objects to the US Street API and stores the
-      # results in the result field of the Lookup object.
-      def send_batch(batch)
-        smarty_request = Request.new
+    def send_lookup(lookup)
+      batch = Batch.new
+      batch.add(lookup)
+      send_batch(batch)
+    end
 
-        return if batch.empty?
+    def send_batch(batch)
+      smarty_request = Request.new
 
-        converted_lookups = remap_keys(batch.all_lookups)
+      return if batch.size == 0
 
-        if batch.size > 1
-          smarty_request.payload = @serializer.serialize(converted_lookups)
-        else
-          smarty_request.parameters = converted_lookups[0]
-        end
+      converted_lookups = remap_keys(batch.all_lookups)
+      smarty_request.payload = @serializer.serialize(converted_lookups)
 
-        response = @sender.send(smarty_request)
+      response = @sender.send(smarty_request)
 
-        raise response.error if response.error
+      raise response.error if response.error
 
-        candidates = @serializer.deserialize(response.payload)
-        candidates = [] if candidates.nil?
+      candidates = @serializer.deserialize(response.payload)
+      candidates = [] if candidates == nil
 
-        assign_candidates_to_lookups(batch, candidates)
-      end
+      assign_candidates_to_lookups(batch, candidates)
+    end
 
-      def remap_keys(obj)
-        converted_obj = []
-        obj.each do |lookup|
-          converted_lookup = {}
-          lookup.candidates = 5 if lookup.match == "enhanced" && lookup.candidates == 0
+    def remap_keys(obj)
+      converted_obj = []
+      obj.each { |lookup|
+        converted_lookup = {}
 
-          converted_lookup['input_id'] = lookup.input_id
-          converted_lookup['street'] = lookup.street
-          converted_lookup['street2'] = lookup.street2
-          converted_lookup['secondary'] = lookup.secondary
-          converted_lookup['city'] = lookup.city
-          converted_lookup['state'] = lookup.state
-          converted_lookup['zipcode'] = lookup.zipcode
-          converted_lookup['lastline'] = lookup.lastline
-          converted_lookup['addressee'] = lookup.addressee
-          converted_lookup['urbanization'] = lookup.urbanization
-          converted_lookup['match'] = lookup.match
-          converted_lookup['candidates'] = lookup.candidates
+        converted_lookup['street'] = lookup.street
+        converted_lookup['street2'] = lookup.street2
+        converted_lookup['secondary'] = lookup.secondary
+        converted_lookup['city'] = lookup.city
+        converted_lookup['state'] = lookup.state
+        converted_lookup['zipcode'] = lookup.zipcode
+        converted_lookup['lastline'] = lookup.lastline
+        converted_lookup['addressee'] = lookup.addressee
+        converted_lookup['urbanization'] = lookup.urbanization
+        converted_lookup['match'] = lookup.match
+        converted_lookup['candidates'] = lookup.candidates
 
-          converted_obj.push(converted_lookup)
-        end
-        converted_obj
-      end
+        converted_obj.push(converted_lookup)
+      }
+      converted_obj
+    end
 
-      def assign_candidates_to_lookups(batch, candidates)
-        candidates.each do |raw_candidate|
-          candidate = Candidate.new(raw_candidate)
-          batch[candidate.input_index].result.push(candidate)
-        end
-      end
+    def assign_candidates_to_lookups(batch, candidates)
+      candidates.each { |raw_candidate|
+        candidate = Candidate.new(raw_candidate)
+        batch[candidate.input_index].result.push(candidate)
+      }
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_street/client_builder.rb

@@ -0,0 +1,15 @@
+require_relative '../core_client_builder'
+require_relative 'client'
+
+module USStreet
+  class ClientBuilder < CoreClientBuilder
+    def initialize(signer)
+      super(signer)
+      @url_prefix = 'https://us-street.api.smartystreets.com/street-address'
+    end
+
+    def build
+      Client.new(build_sender, @serializer)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/components.rb

@@ -1,35 +1,30 @@
-module SmartyStreets
-  module USStreet
-    # This class contains the matched address broken down into its fundamental pieces.
-    #
-    # See "https://smartystreets.com/docs/cloud/us-street-api#components"
-    class Components
-      attr_reader :street_postdirection, :delivery_point_check_digit, :secondary_designator, :secondary_number, :zipcode,
-                  :pmb_number, :state_abbreviation, :extra_secondary_designator, :urbanization, :street_name, :city_name,
-                  :default_city_name, :street_suffix, :primary_number, :plus4_code, :street_predirection, :pmb_designator,
-                  :extra_secondary_number, :delivery_point
+module USStreet
+  class Components
+    attr_reader :street_postdirection, :delivery_point_check_digit, :secondary_designator, :secondary_number, :zipcode,
+                :pmb_number, :state_abbreviation, :extra_secondary_designator, :urbanization, :street_name, :city_name,
+                :default_city_name, :street_suffix, :primary_number, :plus4_code, :street_predirection, :pmb_designator,
+                :extra_secondary_number, :delivery_point
 
-      def initialize(obj)
-        @urbanization = obj['urbanization']
-        @primary_number = obj['primary_number']
-        @street_name = obj['street_name']
-        @street_predirection = obj['street_predirection']
-        @street_postdirection = obj['street_postdirection']
-        @street_suffix = obj['street_suffix']
-        @secondary_number = obj['secondary_number']
-        @secondary_designator = obj['secondary_designator']
-        @extra_secondary_number = obj['extra_secondary_number']
-        @extra_secondary_designator = obj['extra_secondary_designator']
-        @pmb_designator = obj['pmb_designator']
-        @pmb_number = obj['pmb_number']
-        @city_name = obj['city_name']
-        @default_city_name = obj['default_city_name']
-        @state_abbreviation = obj['state_abbreviation']
-        @zipcode = obj['zipcode']
-        @plus4_code = obj['plus4_code']
-        @delivery_point = obj['delivery_point']
-        @delivery_point_check_digit = obj['delivery_point_check_digit']
-      end
+    def initialize(obj)
+      @urbanization = obj['urbanization']
+      @primary_number = obj['primary_number']
+      @street_name = obj['street_name']
+      @street_predirection = obj['street_predirection']
+      @street_postdirection = obj['street_postdirection']
+      @street_suffix = obj['street_suffix']
+      @secondary_number = obj['secondary_number']
+      @secondary_designator = obj['secondary_designator']
+      @extra_secondary_number = obj['extra_secondary_number']
+      @extra_secondary_designator = obj['extra_secondary_designator']
+      @pmb_designator = obj['pmb_designator']
+      @pmb_number = obj['pmb_number']
+      @city_name = obj['city_name']
+      @default_city_name = obj['default_city_name']
+      @state_abbreviation = obj['state_abbreviation']
+      @zipcode = obj['zipcode']
+      @plus4_code = obj['plus4_code']
+      @delivery_point = obj['delivery_point']
+      @delivery_point_check_digit = obj['delivery_point_check_digit']
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_street/lookup.rb

@@ -1,32 +1,25 @@
 require_relative '../json_able'
-module SmartyStreets
-  module USStreet
-    # In addition to holding all of the input data for this lookup, this class also will contain
-    # the result of the lookup after it comes back from the API.
-    #
-    # See "https://smartystreets.com/docs/cloud/us-street-api#input-fields"
-    #
-    # @match:: Must be set to 'strict', 'range', or 'invalid'. Constants for these are in match_type.rb
-    class Lookup < JSONAble
-      attr_accessor :input_id, :street, :street2, :secondary, :city, :state, :zipcode, :lastline, :addressee, :urbanization,
-                    :match, :candidates, :result
 
-      def initialize(street=nil, street2=nil, secondary=nil, city=nil, state=nil, zipcode=nil, lastline=nil,
-                     addressee=nil, urbanization=nil, match=nil, candidates=0, input_id=nil)
-        @input_id = input_id
-        @street = street
-        @street2 = street2
-        @secondary = secondary
-        @city = city
-        @state = state
-        @zipcode = zipcode
-        @lastline = lastline
-        @addressee = addressee
-        @urbanization = urbanization
-        @match = match
-        @candidates = candidates
-        @result = []
-      end
+module USStreet
+  class Lookup < JSONAble
+    attr_accessor :input_id, :street, :street2, :secondary, :city, :state, :zipcode, :lastline, :addressee, :urbanization,
+                  :match, :candidates, :result
+
+    def initialize(street=nil, street2=nil, secondary=nil, city=nil, state=nil, zipcode=nil, lastline=nil,
+                   addressee=nil, urbanization=nil, match=nil, candidates=1, input_id=nil)
+      @input_id = input_id
+      @street = street
+      @street2 = street2
+      @secondary = secondary
+      @city = city
+      @state = state
+      @zipcode = zipcode
+      @lastline = lastline
+      @addressee = addressee
+      @urbanization = urbanization
+      @match = match
+      @candidates = candidates
+      @result = []
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_street/metadata.rb

@@ -1,30 +1,26 @@
-module SmartyStreets
-  module USStreet
-    # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
-    class Metadata
-      attr_reader :elot_sort, :longitude, :elot_sequence, :county_fips, :building_default_indicator, :rdi,
-                  :congressional_district, :latitude, :precision, :time_zone, :zip_type, :county_name, :utc_offset,
-                  :record_type, :carrier_route, :obeys_dst, :is_an_ews_match
+module USStreet
+  class Metadata
+    attr_reader :elot_sort, :longitude, :elot_sequence, :county_fips, :building_default_indicator, :rdi,
+                :congressional_district, :latitude, :precision, :time_zone, :zip_type, :county_name, :utc_offset,
+                :record_type, :carrier_route, :obeys_dst
 
-      def initialize(obj)
-        @record_type = obj['record_type']
-        @zip_type = obj['zip_type']
-        @county_fips = obj['county_fips']
-        @county_name = obj['county_name']
-        @carrier_route = obj['carrier_route']
-        @congressional_district = obj['congressional_district']
-        @building_default_indicator = obj['building_default_indicator']
-        @rdi = obj['rdi']
-        @elot_sequence = obj['elot_sequence']
-        @elot_sort = obj['elot_sort']
-        @latitude = obj['latitude']
-        @longitude = obj['longitude']
-        @precision = obj['precision']
-        @time_zone = obj['time_zone']
-        @utc_offset = obj['utc_offset']
-        @obeys_dst = obj['dst']
-        @is_an_ews_match = obj['ews_match']
-      end
+    def initialize(obj)
+      @record_type = obj['record_type']
+      @zip_type = obj['zip_type']
+      @county_fips = obj['county_fips']
+      @county_name = obj['county_name']
+      @carrier_route = obj['carrier_route']
+      @congressional_district = obj['congressional_district']
+      @building_default_indicator = obj['building_default_indicator']
+      @rdi = obj['rdi']
+      @elot_sequence = obj['elot_sequence']
+      @elot_sort = obj['elot_sort']
+      @latitude = obj['latitude']
+      @longitude = obj['longitude']
+      @precision = obj['precision']
+      @time_zone = obj['time_zone']
+      @utc_offset = obj['utc_offset']
+      @obeys_dst = obj['dst']
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_street.rb

@@ -1,12 +1,10 @@
 require_relative './us_street/analysis'
 require_relative './us_street/candidate'
 require_relative './us_street/client'
+require_relative './us_street/client_builder'
 require_relative './us_street/components'
 require_relative './us_street/lookup'
 require_relative './us_street/metadata'
-require_relative './us_street/match_type'
 
-module SmartyStreets
-  module USStreet
-  end
-end
+module USStreet
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/city.rb

@@ -1,16 +1,10 @@
-module SmartyStreets
-  module USZipcode
-    # Known in the SmartyStreets US ZIP Code API documentation as a city_state
-    # See "https://smartystreets.com/docs/cloud/us-zipcode-api#cities"
-    class City
-      attr_reader :mailable_city, :state_abbreviation, :state, :city
+class City
+  attr_reader :mailable_city, :state_abbreviation, :state, :city
 
-      def initialize(obj)
-        @city = obj['city']
-        @mailable_city = obj['mailable_city']
-        @state_abbreviation = obj['state_abbreviation']
-        @state = obj['state']
-      end
-    end
+  def initialize(obj)
+    @city = obj['city']
+    @mailable_city = obj['mailable_city']
+    @state_abbreviation = obj['state_abbreviation']
+    @state = obj['state']
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb

@@ -2,71 +2,56 @@ require_relative 'result'
 require_relative '../batch'
 require_relative '../request'
 
-module SmartyStreets
-  module USZipcode
-    # It is recommended to instantiate this class using ClientBuilder.build_us_zipcode_api_client.
-    class Client
-      def initialize(sender, serializer)
-        @sender = sender
-        @serializer = serializer
-      end
-
-      # Sends a Lookup object to the US ZIP Code API and stores the result in the Lookup's result field.
-      def send_lookup(lookup)
-        batch = Batch.new
-        batch.add(lookup)
-        send_batch(batch)
-      end
+module USZipcode
+  class Client
+    def initialize(sender, serializer)
+      @sender = sender
+      @serializer = serializer
+    end
 
-      # Sends a Batch object containing no more than 100 Lookup objects to the US ZIP Code API and stores the
-      # results in the result field of the Lookup object.
-      def send_batch(batch)
-        smarty_request = Request.new
+    def send_lookup(lookup)
+      batch = Batch.new
+      batch.add(lookup)
+      send_batch(batch)
+    end
 
-        return if batch.empty?
+    def send_batch(batch)
+      smarty_request = Request.new
 
-        converted_lookups = remap_keys(batch.all_lookups)
+      return if batch.size == 0
 
-        if batch.size > 1
-          smarty_request.payload = @serializer.serialize(converted_lookups)
-        else
-          smarty_request.parameters = converted_lookups[0]
-        end
+      converted_lookups = remap_keys(batch.all_lookups)
+      smarty_request.payload = @serializer.serialize(converted_lookups)
 
-        response = @sender.send(smarty_request)
+      response = @sender.send(smarty_request)
 
-        raise response.error if response.error
+      raise response.error if response.error
 
-        results = @serializer.deserialize(response.payload)
-        results = [] if results.nil?
-        assign_results_to_lookups(batch, results)
-      end
+      results = @serializer.deserialize(response.payload)
+      results = [] if results == nil
+      assign_results_to_lookups(batch, results)
+    end
 
-      def assign_results_to_lookups(batch, results)
-        results.each do |raw_result|
-          result = Result.new(raw_result)
-          batch[result.input_index].result = result
-        end
+    def assign_results_to_lookups(batch, results)
+      results.each do |raw_result|
+        result = Result.new(raw_result)
+        batch[result.input_index].result = result
       end
+    end
 
-      def remap_keys(obj)
-        converted_obj = []
-        obj.each do |lookup|
-          converted_lookup = {}
-
-          add_field(converted_lookup, 'city', lookup.city)
-          add_field(converted_lookup, 'state', lookup.state)
-          add_field(converted_lookup, 'zipcode', lookup.zipcode)
+    def remap_keys(obj)
+      converted_obj = []
+      obj.each do |lookup|
+        converted_lookup = {}
 
-          converted_obj.push(converted_lookup)
-        end
+        converted_lookup['city'] = lookup.city
+        converted_lookup['state'] = lookup.state
+        converted_lookup['zipcode'] = lookup.zipcode
 
-        converted_obj
+        converted_obj.push(converted_lookup)
       end
 
-      def add_field(converted_lookup, key, value)
-        converted_lookup[key] = value unless value.nil? or value.empty?
-      end
+      converted_obj
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_zipcode/client_builder.rb

@@ -0,0 +1,15 @@
+require_relative '../core_client_builder'
+require_relative 'client'
+
+module USZipcode
+  class ClientBuilder < CoreClientBuilder
+    def initialize(signer)
+      super(signer)
+      @url_prefix = 'https://us-zipcode.api.smartystreets.com/lookup'
+    end
+
+    def build
+      Client.new(build_sender, @serializer)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/lookup.rb

@@ -1,21 +1,14 @@
 require_relative '../json_able'
+module USZipcode
+  class Lookup < JSONAble
+    attr_accessor :result, :state, :zipcode, :input_id, :city
 
-module SmartyStreets
-  module USZipcode
-    # In addition to holding all of the input data for this lookup, this class also
-    #   will contain the result of the lookup after it comes back from the API.
-    #
-    #   See "https://smartystreets.com/docs/cloud/us-zipcode-api#http-request-input-fields"
-    class Lookup < JSONAble
-      attr_accessor :result, :state, :zipcode, :input_id, :city
-
-      def initialize(city=nil, state=nil, zipcode=nil, input_id=nil)
-        @result = nil
-        @input_id = input_id
-        @city = city
-        @state = state
-        @zipcode = zipcode
-      end
+    def initialize(city=nil, state=nil, zipcode=nil, input_id=nil)
+      @result = nil
+      @input_id = input_id
+      @city = city
+      @state = state
+      @zipcode = zipcode
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_zipcode/result.rb

@@ -1,47 +1,43 @@
 require_relative 'city'
 require_relative 'zip_code'
 
-module SmartyStreets
-  module USZipcode
-    # See "https://smartystreets.com/docs/cloud/us-zipcode-api#root"
-    class Result
-      attr_reader :reason, :input_id, :input_index, :cities, :zipcodes, :status
-
-      def initialize(obj)
-        @status = obj['status']
-        @reason = obj['reason']
-        @input_id = obj['input_id']
-        @input_index = obj['input_index']
-        @cities = obj.fetch('city_states', [])
-        @zipcodes = obj.fetch('zipcodes', [])
-
-        @cities = convert_cities
-        @zipcodes = convert_zipcodes
-      end
-
-      def valid?
-        @status.nil? and @reason.nil?
-      end
+module USZipcode
+  class Result
+    attr_reader :reason, :input_index, :cities, :zipcodes, :status
+
+    def initialize(obj)
+      @status = obj['status']
+      @reason = obj['reason']
+      @input_index = obj['input_index']
+      @cities = obj.fetch('city_states', [])
+      @zipcodes = obj.fetch('zipcodes', [])
+
+      @cities = convert_cities
+      @zipcodes = convert_zipcodes
+    end
 
-      def convert_cities
-        converted_cities = []
+    def is_valid?
+      @status == nil and @reason == nil
+    end
 
-        @cities.each do |city|
-          converted_cities.push(City.new(city))
-        end
+    def convert_cities
+      converted_cities = []
 
-        converted_cities
+      @cities.each do |city|
+        converted_cities.push(City.new(city))
       end
 
-      def convert_zipcodes
-        converted_zipcodes = []
+      converted_cities
+    end
 
-        @zipcodes.each do |zipcode|
-          converted_zipcodes.push(ZipCode.new(zipcode))
-        end
+    def convert_zipcodes
+      converted_zipcodes = []
 
-        converted_zipcodes
+      @zipcodes.each do |zipcode|
+        converted_zipcodes.push(ZipCode.new(zipcode))
       end
+
+      converted_zipcodes
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/zip_code.rb

@@ -1,33 +1,15 @@
-require_relative 'alternate_county'
-
-module SmartyStreets
-  module USZipcode
-    # See "https://smartystreets.com/docs/cloud/us-zipcode-api#zipcodes"
-    class ZipCode
-      attr_reader :longitude, :county_name, :zipcode, :zipcode_type, :county_fips,
-                  :latitude, :precision, :default_city, :alternate_counties,
-                  :state_abbreviation, :state
-
-      def initialize(obj)
-        @zipcode = obj['zipcode']
-        @zipcode_type = obj['zipcode_type']
-        @default_city = obj['default_city']
-        @county_fips = obj['county_fips']
-        @county_name = obj['county_name']
-        @latitude = obj['latitude']
-        @longitude = obj['longitude']
-        @precision = obj['precision']
-        @state = obj['state']
-        @state_abbreviation = obj['state_abbreviation']
-        alternate_counties = obj.fetch('alternate_counties', [])
-
-        @alternate_counties = []
-
-        alternate_counties.each do |county|
-          @alternate_counties.push(USZipcode::AlternateCounty.new(county))
-        end
-      end
-    end
+class ZipCode
+  attr_reader :longitude, :county_name, :zipcode, :zipcode_type, :county_fips, :latitude, :precision, :default_city, :alternate_counties
+
+  def initialize(obj)
+    @zipcode = obj['zipcode']
+    @zipcode_type = obj['zipcode_type']
+    @default_city = obj['default_city']
+    @county_fips = obj['county_fips']
+    @county_name = obj['county_name']
+    @latitude = obj['latitude']
+    @longitude = obj['longitude']
+    @precision = obj['precision']
+    @alternate_counties = obj.fetch('alternate_counties', [])
   end
-end
-
+end