smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/lib/smartystreets_ruby_sdk/custom_header_sender.rb

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

data/lib/smartystreets_ruby_sdk/errors.rb

@@ -1,25 +1,27 @@
-BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
+module SmartyStreets
+  BAD_CREDENTIALS = 'Unauthorized: The credentials were provided incorrectly or did not match any existing,
  active credentials.'.freeze
 
-PAYMENT_REQUIRED = 'Payment Required: There is no active subscription
+  PAYMENT_REQUIRED = 'Payment Required: There is no active subscription
  for the account associated with the credentials submitted with the request.'.freeze
 
-FORBIDDEN = 'Because the international service is currently in a limited release phase, only approved accounts' \
+  FORBIDDEN = 'Because the international service is currently in a limited release phase, only approved accounts' \
             ' may access the service.'.freeze
 
-REQUEST_ENTITY_TOO_LARGE = 'Request Entity Too Large: The request body has exceeded the maximum size.'.freeze
+  REQUEST_ENTITY_TOO_LARGE = 'Request Entity Too Large: The request body has exceeded the maximum size.'.freeze
 
-BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
+  BAD_REQUEST = 'Bad Request (Malformed Payload): A GET request lacked a street field or the request body of a
  POST request contained malformed JSON.'.freeze
 
-UNPROCESSABLE_ENTITY = 'GET request lacked required fields.'.freeze
+  UNPROCESSABLE_ENTITY = 'GET request lacked required fields.'.freeze
 
-TOO_MANY_REQUESTS = 'When using public "website key" authentication,
+  TOO_MANY_REQUESTS = 'When using public "website key" authentication,
 we restrict the number of requests coming from a given source over too short of a time.'.freeze
 
-INTERNAL_SERVER_ERROR = 'Internal Server Error.'.freeze
+  INTERNAL_SERVER_ERROR = 'Internal Server Error.'.freeze
 
-SERVICE_UNAVAILABLE = 'Service Unavailable. Try again later.'.freeze
+  SERVICE_UNAVAILABLE = 'Service Unavailable. Try again later.'.freeze
 
-GATEWAY_TIMEOUT = 'The upstream data provider did not respond in a timely fashion and the request failed. ' \
-                  'A serious, yet rare occurrence indeed.'.freeze
+  GATEWAY_TIMEOUT = 'The upstream data provider did not respond in a timely fashion and the request failed. ' \
+                  'A serious, yet rare occurrence indeed.'.freeze
+end

data/lib/smartystreets_ruby_sdk/exceptions.rb

@@ -1,35 +1,39 @@
-class SmartyException < Exception
-end
+module SmartyStreets
 
-class BadCredentialsError < SmartyException
-end
+  class SmartyError < StandardError
+  end
 
-class ForbiddenError < SmartyException
-end
+  class BadCredentialsError < SmartyError
+  end
 
-class PaymentRequiredError < SmartyException
-end
+  class ForbiddenError < SmartyError
+  end
 
-class RequestEntityTooLargeError < SmartyException
-end
+  class PaymentRequiredError < SmartyError
+  end
 
-class BadRequestError < SmartyException
-end
+  class RequestEntityTooLargeError < SmartyError
+  end
 
-class UnprocessableEntityError < SmartyException
-end
+  class BadRequestError < SmartyError
+  end
 
-class TooManyRequestsError < SmartyException
-end
+  class UnprocessableEntityError < SmartyError
+  end
 
-class InternalServerError < SmartyException
-end
+  class TooManyRequestsError < SmartyError
+  end
 
-class ServiceUnavailableError < SmartyException
-end
+  class InternalServerError < SmartyError
+  end
 
-class GatewayTimeoutError < SmartyException
-end
+  class ServiceUnavailableError < SmartyError
+  end
+
+  class GatewayTimeoutError < SmartyError
+  end
+
+  class BatchFullError < SmartyError
+  end
 
-class BatchFullError < SmartyException
 end

data/lib/smartystreets_ruby_sdk/international_street.rb

@@ -6,5 +6,7 @@ require_relative './international_street/candidate'
 require_relative './international_street/client'
 require_relative './international_street/language_mode'
 
-module InternationalStreet
+module SmartyStreets
+  module InternationalStreet
+  end
 end

data/lib/smartystreets_ruby_sdk/international_street/analysis.rb

@@ -1,13 +1,15 @@
-module InternationalStreet
-  # See "https://smartystreets.com/docs/cloud/international-street-api#analysis"
-  class Analysis
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#analysis"
+    class Analysis
 
-    attr_reader :max_address_precision, :verification_status, :address_precision
+      attr_reader :max_address_precision, :verification_status, :address_precision
 
-    def initialize(obj)
-      @verification_status = obj.fetch('verification_status', nil)
-      @address_precision = obj.fetch('address_precision', nil)
-      @max_address_precision = obj.fetch('max_address_precision', nil)
+      def initialize(obj)
+        @verification_status = obj.fetch('verification_status', nil)
+        @address_precision = obj.fetch('address_precision', nil)
+        @max_address_precision = obj.fetch('max_address_precision', nil)
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/international_street/candidate.rb

@@ -2,32 +2,34 @@ require_relative 'components'
 require_relative 'metadata'
 require_relative 'analysis'
 
-module InternationalStreet
-  # A candidate is a possible match for an address that was submitted. A lookup can have multiple
-  # candidates if the address was ambiguous.
-  #
-  # See "https://smartystreets.com/docs/cloud/international-street-api#root"
-  class Candidate
-    attr_reader :metadata, :address3, :address11, :address2, :address12, :address1, :address10,
-                :address9, :address8, :address7, :organization, :address6, :address5, :address4, :components, :analysis
+module SmartyStreets
+  module InternationalStreet
+    # A candidate is a possible match for an address that was submitted. A lookup can have multiple
+    # candidates if the address was ambiguous.
+    #
+    # See "https://smartystreets.com/docs/cloud/international-street-api#root"
+    class Candidate
+      attr_reader :metadata, :address3, :address11, :address2, :address12, :address1, :address10,
+                  :address9, :address8, :address7, :organization, :address6, :address5, :address4, :components, :analysis
 
-    def initialize(obj)
-      @organization = obj.fetch('organization', nil)
-      @address1 = obj.fetch('address1', nil)
-      @address2 = obj.fetch('address2', nil)
-      @address3 = obj.fetch('address3', nil)
-      @address4 = obj.fetch('address4', nil)
-      @address5 = obj.fetch('address5', nil)
-      @address6 = obj.fetch('address6', nil)
-      @address7 = obj.fetch('address7', nil)
-      @address8 = obj.fetch('address8', nil)
-      @address9 = obj.fetch('address9', nil)
-      @address10 = obj.fetch('address10', nil)
-      @address11 = obj.fetch('address11', nil)
-      @address12 = obj.fetch('address12', nil)
-      @components = Components.new(obj.fetch('components', {}))
-      @metadata = Metadata.new(obj.fetch('metadata', {}))
-      @analysis = Analysis.new(obj.fetch('analysis', {}))
+      def initialize(obj)
+        @organization = obj.fetch('organization', nil)
+        @address1 = obj.fetch('address1', nil)
+        @address2 = obj.fetch('address2', nil)
+        @address3 = obj.fetch('address3', nil)
+        @address4 = obj.fetch('address4', nil)
+        @address5 = obj.fetch('address5', nil)
+        @address6 = obj.fetch('address6', nil)
+        @address7 = obj.fetch('address7', nil)
+        @address8 = obj.fetch('address8', nil)
+        @address9 = obj.fetch('address9', nil)
+        @address10 = obj.fetch('address10', nil)
+        @address11 = obj.fetch('address11', nil)
+        @address12 = obj.fetch('address12', nil)
+        @components = Components.new(obj.fetch('components', {}))
+        @metadata = Metadata.new(obj.fetch('metadata', {}))
+        @analysis = Analysis.new(obj.fetch('analysis', {}))
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/international_street/client.rb

@@ -1,56 +1,58 @@
 require_relative '../request'
 require_relative 'candidate'
 
-module InternationalStreet
-  # It is recommended to instantiate this class using ClientBuilder.build_international_street_api_client()
-  class Client
-    def initialize(sender, serializer)
-      @sender = sender
-      @serializer = serializer
-    end
+module SmartyStreets
+  module InternationalStreet
+    # It is recommended to instantiate this class using ClientBuilder.build_international_street_api_client()
+    class Client
+      def initialize(sender, serializer)
+        @sender = sender
+        @serializer = serializer
+      end
 
-    # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
-    def send(lookup)
-      lookup.ensure_enough_info
-      request = build_request(lookup)
+      # Sends a Lookup object to the International Street API and stores the result in the Lookup's result field.
+      def send(lookup)
+        lookup.ensure_enough_info
+        request = build_request(lookup)
 
-      response = @sender.send(request)
+        response = @sender.send(request)
 
-      candidates = convert_candidates(@serializer.deserialize(response.payload))
-      lookup.result = candidates
-    end
+        candidates = convert_candidates(@serializer.deserialize(response.payload))
+        lookup.result = candidates
+      end
 
-    def build_request(lookup)
-      request = Request.new
-
-      add_parameter(request, 'country', lookup.country)
-      add_parameter(request, 'geocode', lookup.geocode.to_s)
-      add_parameter(request, 'language', lookup.language)
-      add_parameter(request, 'freeform', lookup.freeform)
-      add_parameter(request, 'address1', lookup.address1)
-      add_parameter(request, 'address2', lookup.address2)
-      add_parameter(request, 'address3', lookup.address3)
-      add_parameter(request, 'address4', lookup.address4)
-      add_parameter(request, 'organization', lookup.organization)
-      add_parameter(request, 'locality', lookup.locality)
-      add_parameter(request, 'administrative_area', lookup.administrative_area)
-      add_parameter(request, 'postal_code', lookup.postal_code)
-
-      request
-    end
+      def build_request(lookup)
+        request = SmartyStreets::Request.new
+
+        add_parameter(request, 'country', lookup.country)
+        add_parameter(request, 'geocode', lookup.geocode.to_s)
+        add_parameter(request, 'language', lookup.language)
+        add_parameter(request, 'freeform', lookup.freeform)
+        add_parameter(request, 'address1', lookup.address1)
+        add_parameter(request, 'address2', lookup.address2)
+        add_parameter(request, 'address3', lookup.address3)
+        add_parameter(request, 'address4', lookup.address4)
+        add_parameter(request, 'organization', lookup.organization)
+        add_parameter(request, 'locality', lookup.locality)
+        add_parameter(request, 'administrative_area', lookup.administrative_area)
+        add_parameter(request, 'postal_code', lookup.postal_code)
+
+        request
+      end
 
-    def add_parameter(request, key, value)
-      request.parameters[key] = value unless value.nil? or value.empty?
-    end
+      def add_parameter(request, key, value)
+        request.parameters[key] = value unless value.nil? or value.empty?
+      end
 
-    def convert_candidates(raw_candidates)
-      candidates = []
+      def convert_candidates(raw_candidates)
+        candidates = []
 
-      raw_candidates.each do |candidate|
-        candidates.push(Candidate.new(candidate))
-      end
+        raw_candidates.each do |candidate|
+          candidates.push(Candidate.new(candidate))
+        end
 
-      candidates
+        candidates
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/international_street/components.rb

@@ -1,55 +1,57 @@
-module InternationalStreet
-  # See "https://smartystreets.com/docs/cloud/international-street-api#components"
-  class Components
-    attr_reader :premise, :thoroughfare_trailing_type, :sub_building, :locality, :post_box_number,
-                :thoroughfare_name, :thoroughfare_postdirection, :dependent_thoroughfare,
-                :thoroughfare, :dependent_thoroughfare_name, :postal_code_short, :dependent_thoroughfare_trailing_type,
-                :administrative_area, :post_box, :building_leading_type, :dependent_locality_name, :thoroughfare_type,
-                :dependent_thoroughfare_postdirection, :double_dependent_locality, :premise_number,
-                :dependent_thoroughfare_type, :post_box_type, :building, :sub_administrative_area, :postal_code_extra,
-                :sub_building_name, :postal_code, :dependent_locality, :premise_type, :sub_building_number,
-                :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
-                :building_trailing_type, :thoroughfare_predirection, :building_name, :country_iso_3, :sub_building_type
+module SmartyStreets
+  module InternationalStreet
+    # See "https://smartystreets.com/docs/cloud/international-street-api#components"
+    class Components
+      attr_reader :premise, :thoroughfare_trailing_type, :sub_building, :locality, :post_box_number,
+                  :thoroughfare_name, :thoroughfare_postdirection, :dependent_thoroughfare,
+                  :thoroughfare, :dependent_thoroughfare_name, :postal_code_short, :dependent_thoroughfare_trailing_type,
+                  :administrative_area, :post_box, :building_leading_type, :dependent_locality_name, :thoroughfare_type,
+                  :dependent_thoroughfare_postdirection, :double_dependent_locality, :premise_number,
+                  :dependent_thoroughfare_type, :post_box_type, :building, :sub_administrative_area, :postal_code_extra,
+                  :sub_building_name, :postal_code, :dependent_locality, :premise_type, :sub_building_number,
+                  :super_administrative_area, :premise_extra, :dependent_thoroughfare_predirection,
+                  :building_trailing_type, :thoroughfare_predirection, :building_name, :country_iso_3, :sub_building_type
 
-    def initialize(obj)
-      @country_iso_3 = obj.fetch('country_iso_3', nil)
-      @super_administrative_area = obj.fetch('super_administrative_area', nil)
-      @administrative_area = obj.fetch('administrative_area', nil)
-      @sub_administrative_area = obj.fetch('sub_administrative_area', nil)
-      @dependent_locality= obj.fetch('dependent_locality', nil)
-      @dependent_locality_name = obj.fetch('dependent_locality_name', nil)
-      @double_dependent_locality = obj.fetch('double_dependent_locality', nil)
-      @locality = obj.fetch('locality', nil)
-      @postal_code = obj.fetch('postal_code', nil)
-      @postal_code_short = obj.fetch('postal_code_short', nil)
-      @postal_code_extra = obj.fetch('postal_code_extra', nil)
-      @premise = obj.fetch('premise', nil)
-      @premise_extra = obj.fetch('premise_extra', nil)
-      @premise_number = obj.fetch('premise_number', nil)
-      @premise_type = obj.fetch('premise_type', nil)
-      @thoroughfare = obj.fetch('thoroughfare', nil)
-      @thoroughfare_predirection = obj.fetch('thoroughfare_predirection', nil)
-      @thoroughfare_postdirection = obj.fetch('thoroughfare_postdirection', nil)
-      @thoroughfare_name = obj.fetch('thoroughfare_name', nil)
-      @thoroughfare_trailing_type = obj.fetch('thoroughfare_trailing_type', nil)
-      @thoroughfare_type = obj.fetch('thoroughfare_type', nil)
-      @dependent_thoroughfare = obj.fetch('dependent_thoroughfare', nil)
-      @dependent_thoroughfare_predirection = obj.fetch('dependent_thoroughfare_predirection', nil)
-      @dependent_thoroughfare_postdirection = obj.fetch('dependent_thoroughfare_postdirection', nil)
-      @dependent_thoroughfare_name = obj.fetch('dependent_thoroughfare_name', nil)
-      @dependent_thoroughfare_trailing_type = obj.fetch('dependent_thoroughfare_trailing_type', nil)
-      @dependent_thoroughfare_type = obj.fetch('dependent_thoroughfare_type', nil)
-      @building = obj.fetch('building', nil)
-      @building_leading_type = obj.fetch('building_leading_type', nil)
-      @building_name = obj.fetch('building_name', nil)
-      @building_trailing_type = obj.fetch('building_trailing_type', nil)
-      @sub_building_type = obj.fetch('sub_building_type', nil)
-      @sub_building_number = obj.fetch('sub_building_number', nil)
-      @sub_building_name = obj.fetch('sub_building_name', nil)
-      @sub_building = obj.fetch('sub_building', nil)
-      @post_box = obj.fetch('post_box', nil)
-      @post_box_type = obj.fetch('post_box_type', nil)
-      @post_box_number = obj.fetch('post_box_number', nil)
+      def initialize(obj)
+        @country_iso_3 = obj.fetch('country_iso_3', nil)
+        @super_administrative_area = obj.fetch('super_administrative_area', nil)
+        @administrative_area = obj.fetch('administrative_area', nil)
+        @sub_administrative_area = obj.fetch('sub_administrative_area', nil)
+        @dependent_locality= obj.fetch('dependent_locality', nil)
+        @dependent_locality_name = obj.fetch('dependent_locality_name', nil)
+        @double_dependent_locality = obj.fetch('double_dependent_locality', nil)
+        @locality = obj.fetch('locality', nil)
+        @postal_code = obj.fetch('postal_code', nil)
+        @postal_code_short = obj.fetch('postal_code_short', nil)
+        @postal_code_extra = obj.fetch('postal_code_extra', nil)
+        @premise = obj.fetch('premise', nil)
+        @premise_extra = obj.fetch('premise_extra', nil)
+        @premise_number = obj.fetch('premise_number', nil)
+        @premise_type = obj.fetch('premise_type', nil)
+        @thoroughfare = obj.fetch('thoroughfare', nil)
+        @thoroughfare_predirection = obj.fetch('thoroughfare_predirection', nil)
+        @thoroughfare_postdirection = obj.fetch('thoroughfare_postdirection', nil)
+        @thoroughfare_name = obj.fetch('thoroughfare_name', nil)
+        @thoroughfare_trailing_type = obj.fetch('thoroughfare_trailing_type', nil)
+        @thoroughfare_type = obj.fetch('thoroughfare_type', nil)
+        @dependent_thoroughfare = obj.fetch('dependent_thoroughfare', nil)
+        @dependent_thoroughfare_predirection = obj.fetch('dependent_thoroughfare_predirection', nil)
+        @dependent_thoroughfare_postdirection = obj.fetch('dependent_thoroughfare_postdirection', nil)
+        @dependent_thoroughfare_name = obj.fetch('dependent_thoroughfare_name', nil)
+        @dependent_thoroughfare_trailing_type = obj.fetch('dependent_thoroughfare_trailing_type', nil)
+        @dependent_thoroughfare_type = obj.fetch('dependent_thoroughfare_type', nil)
+        @building = obj.fetch('building', nil)
+        @building_leading_type = obj.fetch('building_leading_type', nil)
+        @building_name = obj.fetch('building_name', nil)
+        @building_trailing_type = obj.fetch('building_trailing_type', nil)
+        @sub_building_type = obj.fetch('sub_building_type', nil)
+        @sub_building_number = obj.fetch('sub_building_number', nil)
+        @sub_building_name = obj.fetch('sub_building_name', nil)
+        @sub_building = obj.fetch('sub_building', nil)
+        @post_box = obj.fetch('post_box', nil)
+        @post_box_type = obj.fetch('post_box_type', nil)
+        @post_box_number = obj.fetch('post_box_number', nil)
+      end
     end
   end
 end

data/lib/smartystreets_ruby_sdk/international_street/language_mode.rb

@@ -1,5 +1,9 @@
-module LanguageMode
-  NATIVE = 'native'.freeze
+module SmartyStreets
+  module InternationalStreet
+    module LanguageMode
+      NATIVE = 'native'.freeze
 
-  LATIN = 'latin'.freeze
+      LATIN = 'latin'.freeze
+    end
+  end
 end