smartystreets_ruby_sdk 3.1.0 → 4.0.0

data/lib/smartystreets_ruby_sdk/us_extract/client.rb

@@ -2,45 +2,47 @@ require_relative '../request'
 require_relative '../exceptions'
 require_relative 'result'
 
-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 SmartyException, 'Client.send() requires a Lookup with the "text" field set'
+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
 
-      request = build_request(lookup)
-      response = @sender.send(request)
-      result = Result.new(@serializer.deserialize(response.payload))
+      # 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
 
-      lookup.result = result
-    end
+        request = build_request(lookup)
+        response = @sender.send(request)
+        result = USExtract::Result.new(@serializer.deserialize(response.payload))
 
-    def build_request(lookup)
-      request = Request.new
-      request.content_type = 'text/plain'
-      request.payload = lookup.text
+        lookup.result = result
+      end
 
-      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)
+      def build_request(lookup)
+        request = Request.new
+        request.content_type = 'text/plain'
+        request.payload = lookup.text
 
-      request
-    end
+        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
+      def add_parameter(request, key, value)
+        if value and not value.empty?
+          request.parameters[key] = value
+        end
       end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_extract/lookup.rb

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

@@ -1,15 +1,17 @@
-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
+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']
+      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

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

data/lib/smartystreets_ruby_sdk/us_street.rb

@@ -6,5 +6,7 @@ require_relative './us_street/lookup'
 require_relative './us_street/metadata'
 require_relative './us_street/match_type'
 
-module USStreet
-end
+module SmartyStreets
+  module USStreet
+  end
+end

data/lib/smartystreets_ruby_sdk/us_street/analysis.rb

@@ -1,20 +1,22 @@
-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
+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
 
-    def initialize(obj)
-      @dpv_match_code = obj['dpv_match_code']
-      @dpv_footnotes = obj['dpv_footnotes']
-      @cmra = obj['dpv_cmra']
-      @vacant = obj['dpv_vacant']
-      @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']
+      def initialize(obj)
+        @dpv_match_code = obj['dpv_match_code']
+        @dpv_footnotes = obj['dpv_footnotes']
+        @cmra = obj['dpv_cmra']
+        @vacant = obj['dpv_vacant']
+        @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']
+      end
     end
   end
-end
+end

data/lib/smartystreets_ruby_sdk/us_street/candidate.rb

@@ -2,23 +2,25 @@ require_relative 'components'
 require_relative 'metadata'
 require_relative 'analysis'
 
-module USStreet
-  # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
-  class Candidate
-    attr_reader :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
-                :last_line, :metadata, :components, :analysis
+module SmartyStreets
+  module USStreet
+    # See "https://smartystreets.com/docs/cloud/us-street-api#metadata"
+    class Candidate
+      attr_reader :input_index, :candidate_index, :addressee, :delivery_line_1, :delivery_line_2, :delivery_point_barcode,
+                  :last_line, :metadata, :components, :analysis
 
-    def initialize(obj)
-      @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', {}))
+      def initialize(obj)
+        @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
+end

data/lib/smartystreets_ruby_sdk/us_street/client.rb

@@ -2,68 +2,70 @@ require_relative '../batch'
 require_relative '../request'
 require_relative 'candidate'
 
-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
+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 = Batch.new
-      batch.add(lookup)
-      send_batch(batch)
-    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
+      # 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?
+        return if batch.empty?
 
-      converted_lookups = remap_keys(batch.all_lookups)
-      smarty_request.payload = @serializer.serialize(converted_lookups)
+        converted_lookups = remap_keys(batch.all_lookups)
+        smarty_request.payload = @serializer.serialize(converted_lookups)
 
-      response = @sender.send(smarty_request)
+        response = @sender.send(smarty_request)
 
-      raise response.error if response.error
+        raise response.error if response.error
 
-      candidates = @serializer.deserialize(response.payload)
-      candidates = [] if candidates == nil
+        candidates = @serializer.deserialize(response.payload)
+        candidates = [] if candidates == nil
 
-      assign_candidates_to_lookups(batch, candidates)
-    end
+        assign_candidates_to_lookups(batch, candidates)
+      end
 
-    def remap_keys(obj)
-      converted_obj = []
-      obj.each do |lookup|
-        converted_lookup = {}
+      def remap_keys(obj)
+        converted_obj = []
+        obj.each do |lookup|
+          converted_lookup = {}
 
-        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_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)
+          converted_obj.push(converted_lookup)
+        end
+        converted_obj
       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)
+      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
+end

data/lib/smartystreets_ruby_sdk/us_street/components.rb

@@ -1,33 +1,35 @@
-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
+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']
+      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
+end