smartystreets_ruby_sdk 0.0.0

data/lib/smartystreets_ruby_sdk/us_reverse_geo/lookup.rb

@@ -0,0 +1,21 @@
+module SmartyStreets
+  module USReverseGeo
+    # 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.
+    #
+    # Note: Lookups must have certain required fields set with non-blank values.
+    # These can be found at the URL below.
+    #
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#http-request-input-fields"
+
+    class Lookup
+
+      attr_accessor :latitude, :longitude, :response
+
+      def initialize(latitude, longitude)
+        @latitude = sprintf('%.8f', latitude)
+        @longitude = sprintf('%.8f', longitude)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/result.rb

@@ -0,0 +1,20 @@
+require_relative 'coordinate'
+require_relative 'address'
+
+module SmartyStreets
+  module USReverseGeo
+    # A result is a possible match for an geocode that was submitted. A lookup can have multiple results.
+    #
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#result"
+    class Result
+      attr_reader :address, :coordinate, :distance
+
+      def initialize(obj)
+        @address = Address.new(obj.fetch('address', {}))
+        @coordinate = Coordinate.new(obj.fetch('coordinate', {}))
+        @distance = obj['distance']
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/us_reverse_geo_response.rb

@@ -0,0 +1,17 @@
+require_relative 'result'
+
+module SmartyStreets
+  module USReverseGeo
+    class Response
+      attr_reader :results
+
+      def initialize(obj)
+        @results = []
+
+        obj['results'].each do |result|
+          @results.push(Result.new(result))
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo.rb

@@ -0,0 +1,12 @@
+require_relative './us_reverse_geo/address'
+require_relative './us_reverse_geo/client'
+require_relative './us_reverse_geo/coordinate'
+require_relative './us_reverse_geo/lookup'
+require_relative './us_reverse_geo/result'
+require_relative './us_reverse_geo/us_reverse_geo_response'
+
+module SmartyStreets
+  module USReverseGeo
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_street/analysis.rb

@@ -0,0 +1,24 @@
+module SmartyStreets
+  module USStreet
+    # See "https://smartystreets.com/docs/cloud/us-street-api#analysis"
+    class Analysis
+      attr_reader :lacs_link_code, :active, :footnotes, :lacs_link_indicator, :dpv_match_code, :is_suite_link_match,
+                  :is_ews_match, :dpv_footnotes, :cmra, :vacant, :no_stat, :enhanced_match
+
+      def initialize(obj)
+        @dpv_match_code = obj['dpv_match_code']
+        @dpv_footnotes = obj['dpv_footnotes']
+        @cmra = obj['dpv_cmra']
+        @vacant = obj['dpv_vacant']
+        @no_stat = obj['dpv_no_stat']
+        @active = obj['active']
+        @is_ews_match = obj['ews_match']
+        @footnotes = obj['footnotes']
+        @lacs_link_code = obj['lacslink_code']
+        @lacs_link_indicator = obj['lacslink_indicator']
+        @is_suite_link_match = obj['suitelink_match']
+        @enhanced_match = obj['enhanced_match']
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/candidate.rb

@@ -0,0 +1,27 @@
+require_relative 'components'
+require_relative 'metadata'
+require_relative 'analysis'
+
+module SmartyStreets
+  module USStreet
+    # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
+    class Candidate
+      attr_reader :input_id, :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
+                  :last_line, :metadata, :components, :analysis
+
+      def initialize(obj)
+        @input_id = obj['input_id']
+        @input_index = obj['input_index']
+        @candidate_index = obj['candidate_index']
+        @addressee = obj['addressee']
+        @delivery_line_1 = obj['delivery_line_1']
+        @delivery_line_2 = obj['delivery_line_2']
+        @last_line = obj['last_line']
+        @delivery_point_barcode = obj['delivery_point_barcode']
+        @components = Components.new(obj.fetch('components', {}))
+        @metadata = Metadata.new(obj.fetch('metadata', {}))
+        @analysis = Analysis.new(obj.fetch('analysis', {}))
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -0,0 +1,78 @@
+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
+
+      # 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
+
+        return if batch.empty?
+
+        converted_lookups = remap_keys(batch.all_lookups)
+
+        if batch.size > 1
+          smarty_request.payload = @serializer.serialize(converted_lookups)
+        else
+          smarty_request.parameters = converted_lookups[0]
+        end
+
+        response = @sender.send(smarty_request)
+
+        raise response.error if response.error
+
+        candidates = @serializer.deserialize(response.payload)
+        candidates = [] if candidates.nil?
+
+        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
+
+          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_obj.push(converted_lookup)
+        end
+        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
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/components.rb

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

@@ -0,0 +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
+
+      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
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/match_type.rb

@@ -0,0 +1,10 @@
+module SmartyStreets
+  module USStreet
+    module MatchType
+      STRICT = 'strict'.freeze
+      RANGE = 'range'.freeze # Deprecated
+      INVALID = 'invalid'.freeze
+      ENHANCED = 'enhanced'.freeze
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/metadata.rb

@@ -0,0 +1,30 @@
+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
+
+      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
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street.rb

@@ -0,0 +1,12 @@
+require_relative './us_street/analysis'
+require_relative './us_street/candidate'
+require_relative './us_street/client'
+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

data/lib/smartystreets_ruby_sdk/us_zipcode/alternate_county.rb

@@ -0,0 +1,15 @@
+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)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/city.rb

@@ -0,0 +1,16 @@
+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']
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_zipcode/client.rb

@@ -0,0 +1,72 @@
+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
+
+      # 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?
+
+        converted_lookups = remap_keys(batch.all_lookups)
+
+        if batch.size > 1
+          smarty_request.payload = @serializer.serialize(converted_lookups)
+        else
+          smarty_request.parameters = converted_lookups[0]
+        end
+
+        response = @sender.send(smarty_request)
+
+        raise response.error if response.error
+
+        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
+      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)
+
+          converted_obj.push(converted_lookup)
+        end
+
+        converted_obj
+      end
+
+      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

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

@@ -0,0 +1,47 @@
+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
+
+      def convert_cities
+        converted_cities = []
+
+        @cities.each do |city|
+          converted_cities.push(City.new(city))
+        end
+
+        converted_cities
+      end
+
+      def convert_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

@@ -0,0 +1,33 @@
+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
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_zipcode.rb

@@ -0,0 +1,11 @@
+require_relative './us_zipcode/city'
+require_relative './us_zipcode/client'
+require_relative './us_zipcode/lookup'
+require_relative './us_zipcode/result'
+require_relative './us_zipcode/zip_code'
+require_relative './us_zipcode/alternate_county'
+
+module SmartyStreets
+  module USZipcode
+  end
+end

data/lib/smartystreets_ruby_sdk/version.rb

@@ -0,0 +1,3 @@
+module SmartyStreets
+  VERSION = '0.0.0' # DO NOT EDIT (this is updated by a build job when a new release is published)
+end

data/lib/smartystreets_ruby_sdk.rb

@@ -0,0 +1,33 @@
+require 'smartystreets_ruby_sdk/version'
+require 'smartystreets_ruby_sdk/logger'
+require 'smartystreets_ruby_sdk/sleeper'
+
+require 'smartystreets_ruby_sdk/batch'
+require 'smartystreets_ruby_sdk/client_builder'
+require 'smartystreets_ruby_sdk/custom_header_sender'
+require 'smartystreets_ruby_sdk/errors'
+require 'smartystreets_ruby_sdk/exceptions'
+require 'smartystreets_ruby_sdk/json_able'
+require 'smartystreets_ruby_sdk/logger'
+require 'smartystreets_ruby_sdk/native_sender'
+require 'smartystreets_ruby_sdk/native_serializer'
+require 'smartystreets_ruby_sdk/request'
+require 'smartystreets_ruby_sdk/response'
+require 'smartystreets_ruby_sdk/retry_sender'
+require 'smartystreets_ruby_sdk/license_sender'
+require 'smartystreets_ruby_sdk/shared_credentials'
+require 'smartystreets_ruby_sdk/signing_sender'
+require 'smartystreets_ruby_sdk/static_credentials'
+require 'smartystreets_ruby_sdk/status_code_sender'
+require 'smartystreets_ruby_sdk/url_prefix_sender'
+
+require 'smartystreets_ruby_sdk/us_extract'
+require 'smartystreets_ruby_sdk/us_street'
+require 'smartystreets_ruby_sdk/us_zipcode'
+require 'smartystreets_ruby_sdk/us_autocomplete'
+require 'smartystreets_ruby_sdk/us_autocomplete_pro'
+require 'smartystreets_ruby_sdk/international_street'
+require 'smartystreets_ruby_sdk/us_reverse_geo'
+
+module SmartyStreets
+end