smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/lib/smartystreets_ruby_sdk/us_street/lookup.rb

@@ -1,31 +1,32 @@
 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
 
-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=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 = []
+      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
 end

data/lib/smartystreets_ruby_sdk/us_street/match_type.rb

@@ -1,5 +1,9 @@
-module MatchType
-  STRICT = 'strict'.freeze
-  RANGE = 'range'.freeze
-  INVALID = 'invalid'.freeze
-end
+module SmartyStreets
+  module USStreet
+    module MatchType
+      STRICT = 'strict'.freeze
+      RANGE = 'range'.freeze
+      INVALID = 'invalid'.freeze
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/metadata.rb

@@ -1,27 +1,29 @@
-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
+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
 
-    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']
+      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
+end

data/lib/smartystreets_ruby_sdk/us_zipcode.rb

@@ -5,5 +5,7 @@ require_relative './us_zipcode/result'
 require_relative './us_zipcode/zip_code'
 require_relative './us_zipcode/alternate_county'
 
-module USZipcode
-end
+module SmartyStreets
+  module USZipcode
+  end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/alternate_county.rb

@@ -1,13 +1,15 @@
-module USZipcode
-  # See "https://smartystreets.com/docs/cloud/us-zipcode-api#zipcodes"
-  class AlternateCounty
-    attr_reader :state_abbreviation, :state, :county_name, :county_fips
+module SmartyStreets
+  module USZipcode
+    # See "https://smartystreets.com/docs/cloud/us-zipcode-api#zipcodes"
+    class AlternateCounty
+      attr_reader :state_abbreviation, :state, :county_name, :county_fips
 
-    def initialize(obj)
-      @county_fips = obj.fetch('county_fips', nil)
-      @county_name = obj.fetch('county_name', nil)
-      @state_abbreviation = obj.fetch('state_abbreviation', nil)
-      @state = obj.fetch('state', nil)
+      def initialize(obj)
+        @county_fips = obj.fetch('county_fips', nil)
+        @county_name = obj.fetch('county_name', nil)
+        @state_abbreviation = obj.fetch('state_abbreviation', nil)
+        @state = obj.fetch('state', nil)
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/city.rb

@@ -1,14 +1,16 @@
-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
+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
 
-    def initialize(obj)
-      @city = obj['city']
-      @mailable_city = obj['mailable_city']
-      @state_abbreviation = obj['state_abbreviation']
-      @state = obj['state']
+      def initialize(obj)
+        @city = obj['city']
+        @mailable_city = obj['mailable_city']
+        @state_abbreviation = obj['state_abbreviation']
+        @state = obj['state']
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb

@@ -2,64 +2,66 @@ require_relative 'result'
 require_relative '../batch'
 require_relative '../request'
 
-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
+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
+      # 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
 
-    # 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
+      # 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
 
-      return if batch.empty?
+        return if batch.empty?
 
-      converted_lookups = remap_keys(batch.all_lookups)
-      smarty_request.payload = @serializer.serialize(converted_lookups)
+        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
+      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
-    end
 
-    def remap_keys(obj)
-      converted_obj = []
-      obj.each do |lookup|
-        converted_lookup = {}
+      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)
+          add_field(converted_lookup, 'city', lookup.city)
+          add_field(converted_lookup, 'state', lookup.state)
+          add_field(converted_lookup, 'zipcode', lookup.zipcode)
 
-        converted_obj.push(converted_lookup)
-      end
+          converted_obj.push(converted_lookup)
+        end
 
-      converted_obj
-    end
+        converted_obj
+      end
 
-    def add_field(converted_lookup, key, value)
-      converted_lookup[key] = value unless value.nil? or value.empty?
+      def add_field(converted_lookup, key, value)
+        converted_lookup[key] = value unless value.nil? or value.empty?
+      end
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_zipcode/lookup.rb

@@ -1,18 +1,21 @@
 require_relative '../json_able'
-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
+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
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_zipcode/result.rb

@@ -1,44 +1,46 @@
 require_relative 'city'
 require_relative 'zip_code'
 
-module USZipcode
-  # See "https://smartystreets.com/docs/cloud/us-zipcode-api#root"
-  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
+module SmartyStreets
+  module USZipcode
+    # See "https://smartystreets.com/docs/cloud/us-zipcode-api#root"
+    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 valid?
-      @status.nil? and @reason.nil?
-    end
+      def valid?
+        @status.nil? and @reason.nil?
+      end
 
-    def convert_cities
-      converted_cities = []
+      def convert_cities
+        converted_cities = []
 
-      @cities.each do |city|
-        converted_cities.push(City.new(city))
+        @cities.each do |city|
+          converted_cities.push(City.new(city))
+        end
+
+        converted_cities
       end
 
-      converted_cities
-    end
+      def convert_zipcodes
+        converted_zipcodes = []
 
-    def convert_zipcodes
-      converted_zipcodes = []
+        @zipcodes.each do |zipcode|
+          converted_zipcodes.push(ZipCode.new(zipcode))
+        end
 
-      @zipcodes.each do |zipcode|
-        converted_zipcodes.push(ZipCode.new(zipcode))
+        converted_zipcodes
       end
-
-      converted_zipcodes
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/zip_code.rb

@@ -1,30 +1,33 @@
 require_relative 'alternate_county'
 
-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
+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', [])
+      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 = []
 
-      alternate_counties.each do |county|
-        @alternate_counties.push(USZipcode::AlternateCounty.new(county))
+        alternate_counties.each do |county|
+          @alternate_counties.push(USZipcode::AlternateCounty.new(county))
+        end
       end
     end
   end
 end
+