smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/lib/smartystreets_ruby_sdk/international_street/lookup.rb

@@ -1,80 +1,82 @@
-module InternationalStreet
-  # 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/international-street-api#http-input-fields"
-  #
-  # @geocode:: Disabled by default. Set to true to enable.
-  # @language:: When not set, the output language will match the language of the input values.
-  #     When set to language_mode.NATIVE, the results will always be in the language of the output country.
-  #     When set to language_mode.LATIN, the results will always be provided using a Latin character set.
-  class Lookup
+module SmartyStreets
+  module InternationalStreet
+    # 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/international-street-api#http-input-fields"
+    #
+    # @geocode:: Disabled by default. Set to true to enable.
+    # @language:: When not set, the output language will match the language of the input values.
+    #     When set to language_mode.NATIVE, the results will always be in the language of the output country.
+    #     When set to language_mode.LATIN, the results will always be provided using a Latin character set.
+    class Lookup
 
-    attr_accessor :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
-                  :geocode, :administrative_area, :country, :organization, :language, :address4, :result
+      attr_accessor :freeform, :locality, :postal_code, :address3, :address2, :inputId, :address1,
+                    :geocode, :administrative_area, :country, :organization, :language, :address4, :result
 
-    def initialize(freeform=nil, country=nil)
-      @result = []
+      def initialize(freeform=nil, country=nil)
+        @result = []
 
-      @inputId = nil
-      @country = country
-      @geocode = nil
-      @language = nil
-      @freeform = freeform
-      @address1 = nil
-      @address2 = nil
-      @address3 = nil
-      @address4 = nil
-      @organization = nil
-      @locality = nil
-      @administrative_area = nil
-      @postal_code = nil
-    end
+        @inputId = nil
+        @country = country
+        @geocode = nil
+        @language = nil
+        @freeform = freeform
+        @address1 = nil
+        @address2 = nil
+        @address3 = nil
+        @address4 = nil
+        @organization = nil
+        @locality = nil
+        @administrative_area = nil
+        @postal_code = nil
+      end
 
-    def missing_country
-      field_is_missing(@country)
-    end
+      def missing_country
+        field_is_missing(@country)
+      end
 
-    def has_freeform
-      field_is_set(@freeform)
-    end
+      def has_freeform
+        field_is_set(@freeform)
+      end
 
-    def missing_address1
-      field_is_missing(@address1)
-    end
+      def missing_address1
+        field_is_missing(@address1)
+      end
 
-    def has_postal_code
-      field_is_set(@postal_code)
-    end
+      def has_postal_code
+        field_is_set(@postal_code)
+      end
 
-    def missing_locality_or_administrative_area
-      field_is_missing(@locality) or field_is_missing(@administrative_area)
-    end
+      def missing_locality_or_administrative_area
+        field_is_missing(@locality) or field_is_missing(@administrative_area)
+      end
 
-    def field_is_missing(field)
-      field.nil? or field.empty?
-    end
+      def field_is_missing(field)
+        field.nil? or field.empty?
+      end
 
-    def field_is_set(field)
-      not field_is_missing(field)
-    end
+      def field_is_set(field)
+        not field_is_missing(field)
+      end
 
-    def ensure_enough_info
-      raise UnprocessableEntityError, 'Country field is required.' if missing_country
+      def ensure_enough_info
+        raise UnprocessableEntityError, 'Country field is required.' if missing_country
 
-      return true if has_freeform
+        return true if has_freeform
 
-      raise UnprocessableEntityError, 'Either freeform or address1 is required.' if missing_address1
+        raise UnprocessableEntityError, 'Either freeform or address1 is required.' if missing_address1
 
-      return true if has_postal_code
+        return true if has_postal_code
 
-      if missing_locality_or_administrative_area
-        raise UnprocessableEntityError, 'Insufficient information:'\
+        if missing_locality_or_administrative_area
+          raise UnprocessableEntityError, 'Insufficient information:'\
               'One or more required fields were not set on the lookup.'
+        end
       end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/international_street/metadata.rb

@@ -1,14 +1,16 @@
-module InternationalStreet
-  # See "https://smartystreets.com/docs/cloud/international-street-api#metadata"
-  class Metadata
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#metadata"
+    class Metadata
 
-    attr_reader :longitude, :geocode_precision, :max_geocode_precision, :latitude
+      attr_reader :longitude, :geocode_precision, :max_geocode_precision, :latitude
 
-    def initialize(obj)
-      @latitude = obj.fetch('latitude', nil)
-      @longitude = obj.fetch('longitude', nil)
-      @geocode_precision = obj.fetch('geocode_precision', nil)
-      @max_geocode_precision = obj.fetch('max_geocode_precision', nil)
+      def initialize(obj)
+        @latitude = obj.fetch('latitude', nil)
+        @longitude = obj.fetch('longitude', nil)
+        @geocode_precision = obj.fetch('geocode_precision', nil)
+        @max_geocode_precision = obj.fetch('max_geocode_precision', nil)
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/json_able.rb

@@ -1,17 +1,19 @@
 require 'json'
 
-class JSONAble
-  def to_json(options={})
-    hash = {}
-    instance_variables.each do |var|
-      hash[var.to_s.delete('@')] = instance_variable_get var
+module SmartyStreets
+  class JSONAble
+    def to_json(options={})
+      hash = {}
+      instance_variables.each do |var|
+        hash[var.to_s.delete('@')] = instance_variable_get var
+      end
+      hash.to_json
     end
-    hash.to_json
-  end
 
-  def from_json!(string)
-    JSON.load(string).each do |var, val|
-      instance_variable_set var, val
+    def from_json!(string)
+      JSON.load(string).each do |var, val|
+        instance_variable_set var, val
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/logger.rb

@@ -1,7 +1,7 @@
-module SmartystreetsRubySdk
+module SmartyStreets
   class Logger
     def log(message)
       puts message
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/native_sender.rb

@@ -2,81 +2,83 @@ require 'net/http'
 require_relative 'version'
 require_relative 'response'
 
-class NativeSender
-  def initialize(max_timeout = 10_000, proxy = nil)
-    @max_timeout = max_timeout
-    @proxy = proxy
-  end
+module SmartyStreets
+  class NativeSender
+    def initialize(max_timeout = 10_000, proxy = nil)
+      @max_timeout = max_timeout
+      @proxy = proxy
+    end
 
-  def send(smarty_request)
-    request = self.class.build_request(smarty_request)
+    def send(smarty_request)
+      request = self.class.build_request(smarty_request)
 
-    begin
-      http = build_http(request)
-      http.use_ssl = true
-      http.ssl_version = :TLSv1_2
-      http.read_timeout = @max_timeout
+      begin
+        http = build_http(request)
+        http.use_ssl = true
+        http.ssl_version = :TLSv1_2
+        http.read_timeout = @max_timeout
 
-      response = http.request(request)
+        response = http.request(request)
+
+        http.finish if http.started?
+      rescue StandardError => err
+        return Response.new(nil, nil, err)
+      end
 
-      http.finish if http.started?
-    rescue StandardError => err
-      return Response.new(nil, nil, err)
+      build_smarty_response(response)
     end
 
-    build_smarty_response(response)
-  end
+    def self.build_request(smarty_request)
+      query = create_query(smarty_request)
 
-  def self.build_request(smarty_request)
-    query = create_query(smarty_request)
+      if smarty_request.payload.nil?
+        request = Net::HTTP::Get.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
+      else
+        request = Net::HTTP::Post.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
+      end
 
-    if smarty_request.payload.nil?
-      request = Net::HTTP::Get.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
-    else
-      request = Net::HTTP::Post.new(URI.parse("#{smarty_request.url_prefix}?#{query}"))
+      request.content_type = 'application/json'
+      request.body = smarty_request.payload
+      request['User-Agent'] = "smartystreets (sdk:ruby@#{SmartyStreets::VERSION})"
+      request['Referer'] = smarty_request.referer unless smarty_request.referer.nil?
+      set_custom_headers(smarty_request.headers, request)
+      request
     end
 
-    request.content_type = 'application/json'
-    request.body = smarty_request.payload
-    request['User-Agent'] = "smartystreets (sdk:ruby@#{SmartystreetsRubySdk::VERSION})"
-    request['Referer'] = smarty_request.referer unless smarty_request.referer.nil?
-    set_custom_headers(smarty_request.headers, request)
-    request
-  end
+    def build_smarty_response(native_response)
+      Response.new(native_response.body, native_response.code)
+    end
 
-  def build_smarty_response(native_response)
-    Response.new(native_response.body, native_response.code)
-  end
+    def build_http(request)
+      uri = request.uri
 
-  def build_http(request)
-    uri = request.uri
+      if @proxy.nil?
+        http = Net::HTTP.new(uri.hostname, uri.port)
+      else
+        http = Net::HTTP.new(uri.hostname, uri.port, @proxy.host,
+                             @proxy.port, @proxy.username, @proxy.password)
+      end
 
-    if @proxy.nil?
-      http = Net::HTTP.new(uri.hostname, uri.port)
-    else
-      http = Net::HTTP.new(uri.hostname, uri.port, @proxy.host,
-                           @proxy.port, @proxy.username, @proxy.password)
+      http
     end
 
-    http
-  end
+    def self.create_query(smarty_request)
+      query_string = ''
 
-  def self.create_query(smarty_request)
-    query_string = ''
+      smarty_request.parameters.each do |key, value|
+        query_string.concat("&#{key}=#{value}")
+      end
 
-    smarty_request.parameters.each do |key, value|
-      query_string.concat("&#{key}=#{value}")
+      query_string[0] = ''
+      query_string
     end
 
-    query_string[0] = ''
-    query_string
-  end
-
-  def self.set_custom_headers(smarty_headers, request)
-    smarty_headers.each do |key, values|
-      values.each do |value|
-        request.add_field(key, value)
+    def self.set_custom_headers(smarty_headers, request)
+      smarty_headers.each do |key, values|
+        values.each do |value|
+          request.add_field(key, value)
+        end
       end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/native_serializer.rb

@@ -1,11 +1,13 @@
 require 'json'
 
-class NativeSerializer
-  def serialize(obj)
-    obj.to_json
-  end
+module SmartyStreets
+  class NativeSerializer
+    def serialize(obj)
+      obj.to_json
+    end
 
-  def deserialize(payload)
-    JSON.load(payload)
+    def deserialize(payload)
+      JSON.load(payload)
+    end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/proxy.rb

@@ -1,4 +1,4 @@
-module SmartystreetsRubySdk
+module SmartyStreets
   # Contains information about the proxy through which all requests will be sent.
   #
   # host should not include a scheme
@@ -13,4 +13,4 @@ module SmartystreetsRubySdk
       @password = password
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/request.rb

@@ -1,12 +1,14 @@
-class Request
-  attr_accessor :parameters, :payload, :url_prefix, :referer, :headers, :content_type
+module SmartyStreets
+  class Request
+    attr_accessor :parameters, :payload, :url_prefix, :referer, :headers, :content_type
 
-  def initialize
-    @parameters = {}
-    @payload = nil
-    @url_prefix = nil
-    @referer = nil
-    @headers = {}
-    @content_type = 'application/json'
+    def initialize
+      @parameters = {}
+      @payload = nil
+      @url_prefix = nil
+      @referer = nil
+      @headers = {}
+      @content_type = 'application/json'
+    end
   end
 end

data/lib/smartystreets_ruby_sdk/response.rb

@@ -1,9 +1,11 @@
-class Response
-  attr_accessor :payload, :status_code, :error
+module SmartyStreets
+  class Response
+    attr_accessor :payload, :status_code, :error
 
-  def initialize(payload, status_code, error=nil)
-    @payload = payload
-    @status_code = status_code
-    @error = error
+    def initialize(payload, status_code, error = nil)
+      @payload = payload
+      @status_code = status_code
+      @error = error
+    end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/retry_sender.rb

@@ -1,32 +1,34 @@
-class RetrySender
-  MAX_BACKOFF_DURATION = 10
-  STATUS_OK = '200'.freeze
-
-  def initialize(max_retries, inner, sleeper, logger)
-    @max_retries = max_retries
-    @inner = inner
-    @sleeper = sleeper
-    @logger = logger
-  end
+module SmartyStreets
+  class RetrySender
+    MAX_BACKOFF_DURATION = 10
+    STATUS_OK = '200'.freeze
+
+    def initialize(max_retries, inner, sleeper, logger)
+      @max_retries = max_retries
+      @inner = inner
+      @sleeper = sleeper
+      @logger = logger
+    end
 
-  def send(request)
-    response = @inner.send(request)
+    def send(request)
+      response = @inner.send(request)
 
-    (0..@max_retries-1).each do |i|
-      break if response.status_code == STATUS_OK
+      (0..@max_retries-1).each do |i|
+        break if response.status_code == STATUS_OK
 
-      backoff(i)
+        backoff(i)
 
-      response = @inner.send(request)
-    end
+        response = @inner.send(request)
+      end
 
-    response
-  end
+      response
+    end
 
-  def backoff(attempt)
-    backoff_duration = [attempt, MAX_BACKOFF_DURATION].min
+    def backoff(attempt)
+      backoff_duration = [attempt, MAX_BACKOFF_DURATION].min
 
-    @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
-    @sleeper.sleep(backoff_duration)
+      @logger.log("There was an error processing the request. Retrying in #{backoff_duration} seconds...")
+      @sleeper.sleep(backoff_duration)
+    end
   end
-end
+end