smartystreets_ruby_sdk 0.0.0

data/lib/smartystreets_ruby_sdk/signing_sender.rb

@@ -0,0 +1,13 @@
+module SmartyStreets
+  class SigningSender
+    def initialize(signer, inner)
+      @signer = signer
+      @inner = inner
+    end
+
+    def send(request)
+      @signer.sign(request)
+      @inner.send(request)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/sleeper.rb

@@ -0,0 +1,7 @@
+module SmartyStreets
+  class Sleeper
+    def sleep(seconds)
+      Kernel::sleep(seconds)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/static_credentials.rb

@@ -0,0 +1,13 @@
+module SmartyStreets
+  class StaticCredentials
+    def initialize(auth_id, auth_token)
+      @auth_id = auth_id
+      @auth_token = auth_token
+    end
+
+    def sign(request)
+      request.parameters['auth-id'] = @auth_id
+      request.parameters['auth-token'] = @auth_token
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -0,0 +1,41 @@
+require_relative 'exceptions'
+require_relative 'errors'
+
+module SmartyStreets
+  class StatusCodeSender
+    def initialize(inner)
+      @inner = inner
+    end
+
+    def send(request)
+      response = @inner.send(request)
+
+      assign_exception(response) if response.error == nil
+
+      response
+    end
+
+    def assign_exception(response)
+      response.error = case response.status_code
+                         when '401'
+                           BadCredentialsError.new(BAD_CREDENTIALS)
+                         when '402'
+                           PaymentRequiredError.new(PAYMENT_REQUIRED)
+                         when '413'
+                           RequestEntityTooLargeError.new(REQUEST_ENTITY_TOO_LARGE)
+                         when '400'
+                           BadRequestError.new(BAD_REQUEST)
+                         when '422'
+                           UnprocessableEntityError.new(UNPROCESSABLE_ENTITY)
+                         when '429'
+                           TooManyRequestsError.new(TOO_MANY_REQUESTS)
+                         when '500'
+                           InternalServerError.new(INTERNAL_SERVER_ERROR)
+                         when '503'
+                           ServiceUnavailableError.new(SERVICE_UNAVAILABLE)
+                         else
+                           nil
+                       end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/url_prefix_sender.rb

@@ -0,0 +1,14 @@
+module SmartyStreets
+  class URLPrefixSender
+    def initialize(url_prefix, inner)
+      @url_prefix = url_prefix
+      @inner = inner
+    end
+
+    def send(request)
+      request.url_prefix = @url_prefix
+
+      @inner.send(request)
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete/client.rb

@@ -0,0 +1,72 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'geolocation_type'
+require_relative 'suggestion'
+
+module SmartyStreets
+  module USAutocomplete
+    # It is recommended to instantiate this class using ClientBuilder.build_us_autocomplete_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Autocomplete API and stores the result in the Lookup's result field.
+      def send(lookup)
+        if not lookup or not lookup.prefix
+          raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup with the prefix field set.'
+        end
+
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        result = @serializer.deserialize(response.payload)
+        suggestions = convert_suggestions(result.fetch('suggestions', []))
+        lookup.result = suggestions
+      end
+
+
+      def build_request(lookup)
+        request = Request.new
+
+        add_parameter(request, 'prefix', lookup.prefix)
+        add_parameter(request, 'suggestions', lookup.max_suggestions.to_s)
+        add_parameter(request, 'city_filter', build_filter_string(lookup.city_filter))
+        add_parameter(request, 'state_filter', build_filter_string(lookup.state_filter))
+        add_parameter(request, 'prefer', build_filter_string(lookup.prefer))
+        add_parameter(request, 'prefer_ratio', lookup.prefer_ratio.to_s)
+        if lookup.geolocate_type != GeolocationType::NONE
+          request.parameters['geolocate'] = 'true'
+          request.parameters['geolocate_precision'] = lookup.geolocate_type
+        else
+          request.parameters['geolocate'] = 'false'
+        end
+
+        request
+      end
+
+      def build_filter_string(filter_list)
+        filter_list ? filter_list.join(',') : nil
+      end
+
+      def convert_suggestions(suggestion_hashes)
+        converted_suggestions = []
+        return converted_suggestions if suggestion_hashes.nil?
+
+        suggestion_hashes.each do |suggestion|
+          converted_suggestions.push(USAutocomplete::Suggestion.new(suggestion))
+        end
+
+        converted_suggestions
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete/geolocation_type.rb

@@ -0,0 +1,9 @@
+module SmartyStreets
+  module USAutocomplete
+    module GeolocationType
+      CITY = 'city'
+      STATE = 'state'
+      NONE = 'null'
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete/lookup.rb

@@ -0,0 +1,38 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module USAutocomplete
+    # 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-autocomplete-api#http-request-input-fields"
+    class Lookup < JSONAble
+
+      attr_accessor :result, :prefix, :state_filter, :prefer, :prefer_ratio, :max_suggestions, :geolocate_type, :city_filter
+
+      def initialize(prefix=nil, suggestions=nil, city_filter=nil, state_filter=nil,
+                     prefer=nil, prefer_ratio=nil, geolocate_type=nil)
+        @result = []
+        @prefix = prefix
+        @max_suggestions = suggestions
+        @city_filter = city_filter ? city_filter : []
+        @state_filter = state_filter ? state_filter : []
+        @prefer = prefer ? prefer : []
+        @prefer_ratio = prefer_ratio
+        @geolocate_type = geolocate_type
+      end
+
+      def add_city_filter(city)
+        @city_filter.push(city)
+      end
+
+      def add_state_filter(state)
+        @state_filter.push(state)
+      end
+
+      def add_prefer(prefer)
+        @prefer.push(prefer)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete/suggestion.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USAutocomplete
+    # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-response"
+    class Suggestion
+
+      attr_reader :text, :street_line, :state, :city
+
+      def initialize(obj)
+        @text = obj.fetch('text', nil)
+        @street_line = obj.fetch('street_line', nil)
+        @city = obj.fetch('city', nil)
+        @state = obj.fetch('state', nil)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete.rb

@@ -0,0 +1,9 @@
+require_relative './us_autocomplete/lookup'
+require_relative './us_autocomplete/geolocation_type'
+require_relative './us_autocomplete/suggestion'
+require_relative './us_autocomplete/client'
+
+module SmartyStreets
+  module USAutocomplete
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/client.rb

@@ -0,0 +1,78 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'geolocation_type'
+require_relative 'suggestion'
+
+module SmartyStreets
+  module USAutocompletePro
+    # It is recommended to instantiate this class using ClientBuilder.build_us_autocomplete_pro_api_client
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Autocomplete Pro API and stores the result in the Lookup's result field.
+      def send(lookup)
+        if not lookup or not lookup.search
+          raise SmartyStreets::SmartyError, 'Send() must be passed a Lookup with the prefix field set.'
+        end
+
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        result = @serializer.deserialize(response.payload)
+        suggestions = convert_suggestions(result.fetch('suggestions', []))
+        lookup.result = suggestions
+      end
+
+
+      def build_request(lookup)
+        request = Request.new
+
+        add_parameter(request, 'search', lookup.search)
+        add_parameter(request, 'max_results', lookup.max_results.to_s)
+        add_parameter(request, 'include_only_cities', build_filter_string(lookup.city_filter))
+        add_parameter(request, 'include_only_states', build_filter_string(lookup.state_filter))
+        add_parameter(request, 'include_only_zip_codes', build_filter_string(lookup.zip_filter))
+        add_parameter(request, 'exclude_states', build_filter_string(lookup.exclude_states))
+        add_parameter(request, 'prefer_cities', build_filter_string(lookup.prefer_cities))
+        add_parameter(request, 'prefer_states', build_filter_string(lookup.prefer_states))
+        add_parameter(request, 'prefer_zip_codes', build_filter_string(lookup.prefer_zip_codes))
+        add_parameter(request, 'prefer_ratio', lookup.prefer_ratio.to_s)
+        add_parameter(request, 'source', lookup.source)
+        if lookup.prefer_zip_codes or lookup.zip_filter
+          request.parameters['prefer_geolocation'] = GeolocationType::NONE
+        else
+          add_parameter(request, 'prefer_geolocation', lookup.prefer_geolocation)
+        end
+        add_parameter(request, 'selected', lookup.selected)
+
+        request
+      end
+
+      def build_filter_string(filter_list)
+        filter_list ? filter_list.join(';') : nil
+      end
+
+      def convert_suggestions(suggestion_hashes)
+        converted_suggestions = []
+        return converted_suggestions if suggestion_hashes.nil?
+
+        suggestion_hashes.each do |suggestion|
+          converted_suggestions.push(USAutocompletePro::Suggestion.new(suggestion))
+        end
+
+        converted_suggestions
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/geolocation_type.rb

@@ -0,0 +1,8 @@
+module SmartyStreets
+  module USAutocompletePro
+    module GeolocationType
+      CITY = 'city'
+      NONE = 'none'
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/lookup.rb

@@ -0,0 +1,63 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module USAutocompletePro
+    # 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-autocomplete-api#http-request-input-fields"
+    class Lookup < JSONAble
+
+      attr_accessor :result, :search, :max_results, :city_filter, :state_filter, :zip_filter,
+                    :exclude_states, :prefer_cities, :prefer_states, :prefer_zip_codes, :prefer_ratio,
+                    :prefer_geolocation, :selected, :source
+
+      def initialize(search=nil, max_results=nil, city_filter=nil, state_filter=nil, zip_filter=nil,
+                     exclude_states=nil, prefer_cities=nil, prefer_states=nil, prefer_zips=nil, prefer_ratio=nil,
+                     prefer_geolocation=nil, selected=nil, source=nil)
+        @result = []
+        @search = search
+        @max_results = max_results
+        @city_filter = city_filter ? city_filter : []
+        @state_filter = state_filter ? state_filter : []
+        @zip_filter = zip_filter ? zip_filter : []
+        @exclude_states = exclude_states ? exclude_states : []
+        @prefer_cities = prefer_cities ? prefer_cities : []
+        @prefer_states = prefer_states ? prefer_states : []
+        @prefer_zip_codes = prefer_zips ? prefer_zips : []
+        @prefer_ratio = prefer_ratio
+        @prefer_geolocation = prefer_geolocation
+        @selected = selected
+        @source = source
+      end
+
+      def add_city_filter(city)
+        @city_filter.push(city)
+      end
+
+      def add_state_filter(state)
+        @state_filter.push(state)
+      end
+
+      def add_zip_filter(zip)
+        @zip_filter.push(zip)
+      end
+
+      def add_state_exclusion(state)
+        @exclude_states.push(state)
+      end
+
+      def add_preferred_city(city)
+        @prefer_cities.push(city)
+      end
+
+      def add_preferred_state(state)
+        @prefer_states.push(state)
+      end
+
+      def add_preferred_zip(zip)
+        @prefer_zip_codes.push(zip)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro/suggestion.rb

@@ -0,0 +1,18 @@
+module SmartyStreets
+  module USAutocompletePro
+    # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-response"
+    class Suggestion
+
+      attr_reader :street_line, :secondary, :city, :state, :zipcode, :entries
+
+      def initialize(obj)
+        @street_line = obj.fetch('street_line', nil)
+        @secondary = obj.fetch('secondary', nil)
+        @city = obj.fetch('city', nil)
+        @state = obj.fetch('state', nil)
+        @zipcode = obj.fetch('zipcode', nil)
+        @entries = obj.fetch('entries', 0)
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete_pro.rb

@@ -0,0 +1,10 @@
+require_relative './us_autocomplete_pro/lookup'
+require_relative './us_autocomplete_pro/geolocation_type'
+require_relative './us_autocomplete_pro/suggestion'
+require_relative './us_autocomplete_pro/client'
+
+module SmartyStreets
+  module USAutocompletePro
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_extract/address.rb

@@ -0,0 +1,24 @@
+require_relative '../us_street/candidate'
+
+module SmartyStreets
+  module USExtract
+    # See "https://smartystreets.com/docs/cloud/us-extract-api#http-response-status"
+    class Address
+      attr_reader :text, :start, :verified, :end, :line, :candidates
+
+      def initialize(obj)
+        @text = obj['text']
+        @verified = obj['verified']
+        @line = obj['line']
+        @start = obj['start']
+        @end = obj['end']
+        candidates = obj.fetch('api_output', [])
+        @candidates = []
+
+        candidates.each {|candidate|
+          @candidates.push(USStreet::Candidate.new(candidate))
+        }
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract/client.rb

@@ -0,0 +1,49 @@
+require_relative '../request'
+require_relative '../exceptions'
+require_relative 'result'
+
+module SmartyStreets
+  module USExtract
+    # It is recommended to instantiate this class using ClientBuilder.build_us_extract_api_client()
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Extract Code API and stores the result in the Lookup's result field.
+      # It also returns the result directly.
+      def send(lookup)
+        if lookup.nil? or lookup.text.nil? or not lookup.text.is_a? String or lookup.text.empty?
+          raise SmartyError, 'Client.send() requires a Lookup with the "text" field set'
+        end
+
+        request = build_request(lookup)
+        response = @sender.send(request)
+        raise response.error if response.error
+        result = USExtract::Result.new(@serializer.deserialize(response.payload))
+
+        lookup.result = result
+      end
+
+      def build_request(lookup)
+        request = Request.new
+        request.content_type = 'text/plain'
+        request.payload = lookup.text
+
+        add_parameter(request, 'html', lookup.html.to_s)
+        add_parameter(request, 'aggressive', lookup.aggressive.to_s)
+        add_parameter(request, 'addr_line_breaks', lookup.addresses_have_line_breaks.to_s)
+        add_parameter(request, 'addr_per_line', lookup.addresses_per_line.to_s)
+
+        request
+      end
+
+      def add_parameter(request, key, value)
+        if value and not value.empty?
+          request.parameters[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract/lookup.rb

@@ -0,0 +1,22 @@
+require_relative '../json_able'
+
+module SmartyStreets
+  module USExtract
+    # 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-extract-api#http-request-input-fields"
+    class Lookup < JSONAble
+      attr_accessor :text, :result, :aggressive, :addresses_per_line, :html, :addresses_have_line_breaks
+
+      def initialize(text=nil, html=nil, aggressive=nil, addresses_have_line_breaks=nil, addresses_per_line=nil)
+        @text = text
+        @html = html
+        @aggressive = aggressive
+        @addresses_have_line_breaks = addresses_have_line_breaks
+        @addresses_per_line = addresses_per_line
+        @result = nil
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract/metadata.rb

@@ -0,0 +1,17 @@
+module SmartyStreets
+  module USExtract
+    # See "https://smartystreets.com/docs/cloud/us-extract-api#http-response-status"
+    class Metadata
+      attr_reader :unicode, :lines, :verified_count, :character_count, :bytes, :address_count
+
+      def initialize(obj)
+        @lines = obj['lines']
+        @unicode = obj['unicode']
+        @address_count = obj['address_count']
+        @verified_count = obj['verified_count']
+        @bytes = obj['bytes']
+        @character_count = obj['character_count']
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract/result.rb

@@ -0,0 +1,21 @@
+require_relative './address'
+require_relative './metadata'
+
+module SmartyStreets
+  module USExtract
+    # See "https://smartystreets.com/docs/cloud/us-extract-api#http-response-status"
+    class Result
+      attr_reader :metadata, :addresses
+
+      def initialize(obj)
+        @metadata = USExtract::Metadata.new(obj.fetch('meta', {}))
+        addresses = obj.fetch('addresses', [])
+        @addresses = []
+
+        addresses.each {|address|
+          @addresses.push(SmartyStreets::USExtract::Address.new(address))
+        }
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract.rb

@@ -0,0 +1,10 @@
+require_relative './us_extract/lookup'
+require_relative './us_extract/address'
+require_relative './us_extract/metadata'
+require_relative './us_extract/result'
+require_relative './us_extract/client'
+
+module SmartyStreets
+  module USExtract
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/address.rb

@@ -0,0 +1,16 @@
+module SmartyStreets
+  module USReverseGeo
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#address"
+    class Address
+      attr_reader :street, :city, :state_abbreviation, :zipcode
+
+      def initialize(obj)
+        @street = obj['street']
+        @city = obj['city']
+        @state_abbreviation = obj['state_abbreviation']
+        @zipcode = obj['zipcode']
+      end
+    end
+  end
+end
+

data/lib/smartystreets_ruby_sdk/us_reverse_geo/client.rb

@@ -0,0 +1,38 @@
+require_relative '../request'
+require_relative 'us_reverse_geo_response'
+
+module SmartyStreets
+  module USReverseGeo
+    # It is recommended to instantiate this class using ClientBuilder.build_us_reverse_geo_api_client()
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
+
+      # Sends a Lookup object to the US Reverse Geo API and stores the result in the Lookup's response field.
+      def send(lookup)
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        raise response.error if response.error
+
+        lookup.response = Response.new(@serializer.deserialize(response.payload))
+      end
+
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'latitude', lookup.latitude)
+        add_parameter(request, 'longitude', lookup.longitude)
+
+        request
+      end
+
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
+    end
+  end
+end

data/lib/smartystreets_ruby_sdk/us_reverse_geo/coordinate.rb

@@ -0,0 +1,25 @@
+module SmartyStreets
+  module USReverseGeo
+    # See "https://smartystreets.com/docs/cloud/us-reverse-geo-api#coordinate"
+    class Coordinate
+      attr_reader :latitude, :longitude, :accuracy, :license
+
+      def initialize(obj)
+        @latitude = obj.fetch('latitude', nil)
+        @longitude = obj.fetch('longitude', nil)
+        @accuracy = obj.fetch('accuracy', nil)
+        @license = obj.fetch('license', nil)
+      end
+
+      def get_license()
+        case @license
+        when 1
+          return "SmartyStreets Proprietary"
+        else
+          return "SmartyStreets"
+        end
+      end
+    end
+  end
+end
+