smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/lib/smartystreets_ruby_sdk/shared_credentials.rb

@@ -1,11 +1,13 @@
-class SharedCredentials
-  def initialize(id, host_name)
-    @id = id
-    @host_name = host_name
-  end
+module SmartyStreets
+  class SharedCredentials
+    def initialize(id, host_name)
+      @id = id
+      @host_name = host_name
+    end
 
-  def sign(request)
-    request.parameters['auth-id'] = @id
-    request.referer = @host_name
+    def sign(request)
+      request.parameters['auth-id'] = @id
+      request.referer = @host_name
+    end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/signing_sender.rb

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

data/lib/smartystreets_ruby_sdk/sleeper.rb

@@ -1,4 +1,4 @@
-module SmartystreetsRubySdk
+module SmartyStreets
   class Sleeper
     def sleep(seconds)
       Kernel::sleep(seconds)

data/lib/smartystreets_ruby_sdk/static_credentials.rb

@@ -1,11 +1,13 @@
-class StaticCredentials
-  def initialize(auth_id, auth_token)
-    @auth_id = auth_id
-    @auth_token = auth_token
-  end
+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
+    def sign(request)
+      request.parameters['auth-id'] = @auth_id
+      request.parameters['auth-token'] = @auth_token
+    end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/status_code_sender.rb

@@ -1,37 +1,39 @@
 require_relative 'exceptions'
 require_relative 'errors'
 
-class StatusCodeSender
-  def initialize(inner)
-    @inner = inner
-  end
+module SmartyStreets
+  class StatusCodeSender
+    def initialize(inner)
+      @inner = inner
+    end
 
-  def send(request)
-    response  = @inner.send(request)
+    def send(request)
+      response = @inner.send(request)
 
-    assign_exception(response) if response.error == nil
+      assign_exception(response) if response.error == nil
 
-    response
-  end
+      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 '429'
-                         TooManyRequestsError.new(TOO_MANY_REQUESTS)
-                       when '500'
-                         InternalServerError.new(INTERNAL_SERVER_ERROR)
-                       when '503'
-                         ServiceUnavailableError.new(SERVICE_UNAVAILABLE)
-                       else
-                         nil
-                     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 '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
+end

data/lib/smartystreets_ruby_sdk/url_prefix_sender.rb

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

data/lib/smartystreets_ruby_sdk/us_autocomplete.rb

@@ -3,5 +3,7 @@ require_relative './us_autocomplete/geolocation_type'
 require_relative './us_autocomplete/suggestion'
 require_relative './us_autocomplete/client'
 
-module USAutocomplete
+module SmartyStreets
+  module USAutocomplete
+  end
 end

data/lib/smartystreets_ruby_sdk/us_autocomplete/client.rb

@@ -3,64 +3,66 @@ require_relative '../exceptions'
 require_relative 'geolocation_type'
 require_relative 'suggestion'
 
-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 SmartyException, 'Send() must be passed a Lookup with the prefix field set.'
+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
 
-      request = build_request(lookup)
+      # 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
 
-      response = @sender.send(request)
+        request = build_request(lookup)
+
+        response = @sender.send(request)
+
+        result = @serializer.deserialize(response.payload)
+        suggestions = convert_suggestions(result.fetch('suggestions', []))
+        lookup.result = suggestions
+      end
 
-      result = @serializer.deserialize(response.payload)
-      suggestions = convert_suggestions(result.fetch('suggestions', []))
-      lookup.result = suggestions
-    end
 
+      def build_request(lookup)
+        request = Request.new
 
-    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))
+        if lookup.geolocate_type != GeolocationType::NONE
+          request.parameters['geolocate'] = 'true'
+          request.parameters['geolocate_precision'] = lookup.geolocate_type
+        else
+          request.parameters['geolocate'] = 'false'
+        end
 
-      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))
-      if lookup.geolocate_type != GeolocationType::NONE
-        request.parameters['geolocate'] = 'true'
-        request.parameters['geolocate_precision'] = lookup.geolocate_type
-      else
-        request.parameters['geolocate'] = 'false'
+        request
       end
 
-      request
-    end
+      def build_filter_string(filter_list)
+        filter_list ? filter_list.join(',') : nil
+      end
 
-    def build_filter_string(filter_list)
-      filter_list ? filter_list.join(',') : nil
-    end
+      def convert_suggestions(suggestion_hashes)
+        converted_suggestions = []
 
-    def convert_suggestions(suggestion_hashes)
-      converted_suggestions = []
+        suggestion_hashes.each do |suggestion|
+          converted_suggestions.push(USAutocomplete::Suggestion.new(suggestion))
+        end
 
-      suggestion_hashes.each do |suggestion|
-        converted_suggestions.push(USAutocomplete::Suggestion.new(suggestion))
+        converted_suggestions
       end
 
-      converted_suggestions
-    end
-
-    def add_parameter(request, key, value)
-      request.parameters[key] = value unless value.nil? or value.empty?
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_autocomplete/geolocation_type.rb

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

data/lib/smartystreets_ruby_sdk/us_autocomplete/lookup.rb

@@ -1,34 +1,36 @@
 require_relative '../json_able'
 
-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
+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, :max_suggestions, :geolocate_type, :city_filter
+      attr_accessor :result, :prefix, :state_filter, :prefer, :max_suggestions, :geolocate_type, :city_filter
 
-    def initialize(prefix=nil, suggestions=nil, city_filter=nil, state_filter=nil, prefer=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 : []
-      @geolocate_type = geolocate_type
-    end
+      def initialize(prefix=nil, suggestions=nil, city_filter=nil, state_filter=nil, prefer=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 : []
+        @geolocate_type = geolocate_type
+      end
 
-    def add_city_filter(city)
-      @city_filter.push(city)
-    end
+      def add_city_filter(city)
+        @city_filter.push(city)
+      end
 
-    def add_state_filter(state)
-      @state_filter.push(state)
-    end
+      def add_state_filter(state)
+        @state_filter.push(state)
+      end
 
-    def add_prefer(prefer)
-      @prefer.push(prefer)
+      def add_prefer(prefer)
+        @prefer.push(prefer)
+      end
     end
   end
 end

data/lib/smartystreets_ruby_sdk/us_autocomplete/suggestion.rb

@@ -1,14 +1,16 @@
-module USAutocomplete
-  # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-response"
-  class Suggestion
+module SmartyStreets
+  module USAutocomplete
+    # See "https://smartystreets.com/docs/cloud/us-autocomplete-api#http-response"
+    class Suggestion
 
-    attr_reader :text, :street_line, :state, :city
+      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)
+      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_extract.rb

@@ -4,5 +4,7 @@ require_relative './us_extract/metadata'
 require_relative './us_extract/result'
 require_relative './us_extract/client'
 
-module USExtract
-end
+module SmartyStreets
+  module USExtract
+  end
+end

data/lib/smartystreets_ruby_sdk/us_extract/address.rb

@@ -1,22 +1,24 @@
 require_relative '../us_street/candidate'
 
-module USExtract
-# See "https://smartystreets.com/docs/cloud/us-extract-api#http-response-status"
-  class Address
-    attr_reader :text, :start, :verified, :end, :line, :candidates
+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 = []
+      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))
-      }
+        candidates.each {|candidate|
+          @candidates.push(USStreet::Candidate.new(candidate))
+        }
+      end
     end
   end
-end
+end