smartystreets_api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f25c553f3c60e7dc68b8d55783342d343304f28
-  data.tar.gz: 21fdcdc401a24a6001804159fa11f16703e9ee57
+  metadata.gz: b973ffd95180ed1525bf06779e749cb979bb10b4
+  data.tar.gz: 9bbcb1c2d13deb48c17335494114bc203b58f48d
 SHA512:
-  metadata.gz: 9e8929c3e343d5789170217bb63dd2bb7024c2f902d20d82d393ba0a8888639011c1e08c449d30a20b5bf04e894f07b9d6ba414bd71ecb81bd5819616ea3b646
-  data.tar.gz: 2e26a7e7623c47dbc95c20106335102ad5d7f026e2134932cbace55f77eac16bcd3fb080e99915ec3256a9b5565af663cecf19be0aa1b0f5c15e746400760f4c
+  metadata.gz: d84d3339812023dad016acac091b8929f034e312b9a4381a7a0734ab9dce0fa6299994fe1026a9dcca2d7bbd8a406c8fabd460e8c8b51792444d2d5334319ba4
+  data.tar.gz: a7acbbc26742bb3be1843ca8e8748abcf68f7d7d32f54d48863abca1e938f77e0b011f7620e7fb4faac965ef8f9221d86821d5d9442dac7538a97c3ce4930d27

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.2.0] - 2017-01-04
+### Added
+- Support for the International Street Address API
+
+### Changed
+- Fix the comparison of the response HTTP code to pass the proper error message to the SevereApiError.
+
 ## [0.1.2] - 2017-01-02
 ### Changed
 - Fix the comparison of the response HTTP code to pass the proper error message to the SevereApiError.

data/lib/smartystreets_api.rb

@@ -24,7 +24,7 @@ module SmartyStreetsApi
     def initialize
       @auth_id = "AUTH-ID"
       @auth_token = "AUTH-TOKEN"
-      @base_url = "https://api.smartystreets.com"
+      @base_url = "api.smartystreets.com"
     end
 
     def auth_args
@@ -38,5 +38,10 @@ end
 
 require "smartystreets_api/monkey_patches"
 require "smartystreets_api/exceptions"
+require "smartystreets_api/decorators/base_decorator"
 require "smartystreets_api/decorators/us_format"
+require "smartystreets_api/decorators/international_format"
+require "smartystreets_api/decorators/international_format_2_lines"
+require "smartystreets_api/api_client"
 require "smartystreets_api/us_street_address"
+require "smartystreets_api/international_street_address"

data/lib/smartystreets_api/api_client.rb

@@ -0,0 +1,72 @@
+class SmartyStreetsApi::ApiClient
+  def self.get_single(options)
+    uri = URI(endpoint)
+
+    args = options.select do |name, value|
+      whitelisted_input_fields.include?(name.to_s)
+    end.merge!(auth_args)
+
+    uri.query = URI.encode_www_form(args)
+
+    response = Net::HTTP.get_response(uri)
+
+    raise_error!(response.code) if severe_error?(response.code)
+
+    parse(response)
+  end
+
+  private
+
+  def self.parse(response)
+    parsed_response = JSON.parse(response.body)
+
+    parse_response(parsed_response)
+  end
+
+  def self.parse_response(response)
+    response.map do |address|
+      {
+        lines: address_lines(address).symbolize_keys!,
+        indexes: address_indexes(address).symbolize_keys!,
+        components: address["components"].symbolize_keys!,
+        metadata: address["metadata"].symbolize_keys!,
+        analysis: address["analysis"].symbolize_keys!
+      }
+    end
+  end
+
+  def self.address_lines(address)
+    address.select { |field| output_address_lines_fields.include?(field) }.symbolize_keys!
+  end
+
+  def self.address_indexes(address)
+    address.select { |field| output_address_indexes_fields.include?(field) }.symbolize_keys!
+  end
+
+  def self.severe_error?(response_status_code)
+    response_status_code.to_i != 200
+  end
+
+  def self.raise_error!(response_status_code)
+    reason = case response_status_code.to_i
+    when 401
+      "Unauthorized"
+    when 402
+      "Payment Required"
+    when 413
+      "Request Entity Too Large"
+    when 400
+      "Bad Request (Malformed Payload)"
+    when 429
+      "Too Many Requests"
+    else
+      "Unknown error: #{response_status_code}"
+    end
+
+    raise SmartyStreetsApi::Exceptions::SevereApiError.new(reason)
+  end
+
+  def self.auth_args
+    SmartyStreetsApi.configuration.auth_args
+  end
+end

data/lib/smartystreets_api/decorators/base_decorator.rb

@@ -0,0 +1,21 @@
+class SmartyStreetsApi::Decorators::BaseDecorator
+  def call(address_object)
+    return if !address_object || !address_object[:components]
+
+    self.class.private_instance_methods(false).inject({}) do |decorated_address, attribute|
+      components = self.send(attribute.to_sym)
+
+      array_values = components.map do |component_name|
+        if address_object[:components] && address_object[:components][component_name]
+          address_object[:components][component_name]
+        else
+          nil
+        end
+      end.compact
+
+      decorated_address[attribute] = array_values.empty? ? nil : array_values.join(" ")
+
+      decorated_address
+    end
+  end
+end

data/lib/smartystreets_api/decorators/international_format.rb

@@ -0,0 +1,62 @@
+class SmartyStreetsApi::Decorators::InternationalFormat < SmartyStreetsApi::Decorators::BaseDecorator
+  def call(address_object)
+    return unless (decorated_address = super)
+
+    decorated_address[:organization] = address_object[:lines][:organization]
+
+    unless decorated_address[:address2]
+      decorated_address[:address2] = decorated_address[:address3]
+      decorated_address[:address3] = nil
+    end
+
+    unless decorated_address[:address1]
+      decorated_address[:address1] = decorated_address[:address2]
+      decorated_address[:address2] = decorated_address[:address3]
+      decorated_address[:address3] = nil
+    end
+
+    decorated_address
+  end
+
+  private
+
+  def organization
+    [:organization]
+  end
+
+  def address1
+    [:building]
+  end
+
+  def address2
+    [
+      :premise,
+      :thoroughfare
+    ]
+  end
+
+  def address3
+    [
+      :sub_building_name,
+      :sub_building_type,
+      :sub_building_number,
+      :post_box
+    ]
+  end
+
+  def locality
+    [:locality]
+  end
+
+  def postal_code
+    [:postal_code_short]
+  end
+
+  def administrative_area
+    [:administrative_area]
+  end
+
+  def country
+    [:country_iso_3]
+  end
+end

data/lib/smartystreets_api/decorators/international_format_2_lines.rb

@@ -0,0 +1,74 @@
+class SmartyStreetsApi::Decorators::InternationalFormat2Lines < SmartyStreetsApi::Decorators::BaseDecorator
+  def call(address_object)
+    return unless (decorated_address = super)
+
+    decorated_address[:organization] = address_object[:lines][:organization]
+
+    unless decorated_address[:address1]
+      decorated_address[:address1] = decorated_address[:address_1_alternative]
+      decorated_address[:address2] = decorated_address[:address_2_alternative]
+    end
+
+    decorated_address.delete(:address_1_alternative)
+    decorated_address.delete(:address_2_alternative)
+
+    decorated_address
+  end
+
+  private
+
+  def organization
+    [:organization]
+  end
+
+  def address1
+    [:building]
+  end
+
+  def address_1_alternative
+    [
+      :premise,
+      :thoroughfare
+    ]
+  end
+
+  def address2
+    [
+      :premise,
+      :thoroughfare,
+      :sub_building_name,
+      :sub_building_type,
+      :sub_building_number,
+      :post_box
+    ]
+  end
+
+  def address_2_alternative
+    [
+      :sub_building_name,
+      :sub_building_type,
+      :sub_building_number,
+      :post_box
+    ]
+  end
+
+  def locality
+    [:locality]
+  end
+
+  def postal_code
+    [:postal_code]
+  end
+
+  def postal_code_short
+    [:postal_code_short]
+  end
+
+  def administrative_area
+    [:administrative_area]
+  end
+
+  def country
+    [:country_iso_3]
+  end
+end

data/lib/smartystreets_api/decorators/us_format.rb

@@ -1,24 +1,4 @@
-class SmartyStreetsApi::Decorators::UsFormat
-  def call(address_object)
-    return if !address_object || !address_object[:components]
-
-    self.class.private_instance_methods(false).inject({}) do |decorated_address, attribute|
-      components = self.send(attribute.to_sym)
-
-      array_values = components.map do |component_name|
-        if address_object[:components] && address_object[:components][component_name]
-          address_object[:components][component_name]
-        else
-          nil
-        end
-      end.compact
-
-      decorated_address[attribute] = array_values.empty? ? nil : array_values.join(" ")
-
-      decorated_address
-    end
-  end
-
+class SmartyStreetsApi::Decorators::UsFormat < SmartyStreetsApi::Decorators::BaseDecorator
   private
 
   def street

data/lib/smartystreets_api/international_street_address.rb

@@ -0,0 +1,45 @@
+class SmartyStreetsApi::InternationalStreetAddress < SmartyStreetsApi::ApiClient
+  def self.whitelisted_input_fields
+    %w(
+      input_id
+      country
+      geocode
+      language
+      freeform
+      address1
+      address2
+      address3
+      address4
+      organization
+      locality
+      administrative_area
+      postal_code
+    )
+  end
+
+  def self.output_address_lines_fields
+    %w(
+      organization
+      address1
+      address2
+      address3
+      address4
+      address5
+      address6
+      address7
+      address8
+      address9
+      address10
+      address11
+      address12
+    )
+  end
+
+  def self.output_address_indexes_fields
+    %w(input_id)
+  end
+
+  def self.endpoint
+    "https://international-street.#{SmartyStreetsApi.configuration.base_url}/verify"
+  end
+end

data/lib/smartystreets_api/us_street_address.rb

@@ -1,79 +1,39 @@
-class SmartyStreetsApi::UsStreetAddress
-  AUTH_ARGS = %w(auth-id auth-token)
-  INPUTS = %w(street street2 secondary city state zipcode lastline addressee urbanization candidates)
-  OUTPUT_ADDRESS_LINES = %w(addressee delivery_line_1 delivery_line_2 last_line)
-  OUTPUT_ADDRESS_INDEXES = %w(input_id input_index candidate_index delivery_point_barcode)
-
-  def self.get_single(options)
-    uri = URI("#{host}/street-address")
-
-    args = options.select { |name, value| INPUTS.include?(name.to_s) && (value && !value.empty?) }.merge!(auth_args)
-
-    uri.query = URI.encode_www_form(args)
-
-    response = Net::HTTP.get_response(uri)
-
-    raise_error!(response.code) if severe_error?(response.code)
-
-    parse(response)
-  end
-
-  private
-
-  def self.parse(response)
-    json_response = JSON.parse(response.body)
-
-    parse_response(json_response)
-  end
-
-  def self.parse_response(response)
-    response.map do |address|
-      {
-        lines: address_lines(address).symbolize_keys!,
-        indexes: address_indexes(address).symbolize_keys!,
-        components: address["components"].symbolize_keys!,
-        metadata: address["metadata"].symbolize_keys!,
-        analysis: address["analysis"].symbolize_keys!
-      }
-    end
-  end
-
-  def self.address_lines(address)
-    address.select { |field| OUTPUT_ADDRESS_LINES.include?(field) }.symbolize_keys!
-  end
-
-  def self.address_indexes(address)
-    address.select { |field| OUTPUT_ADDRESS_INDEXES.include?(field) }.symbolize_keys!
-  end
-
-  def self.severe_error?(response_status_code)
-    response_status_code.to_i != 200
-  end
-
-  def self.raise_error!(response_status_code)
-    reason = case response_status_code.to_i
-    when 401
-      "Unauthorized"
-    when 402
-      "Payment Required"
-    when 413
-      "Request Entity Too Large"
-    when 400
-      "Bad Request (Malformed Payload)"
-    when 429
-      "Too Many Requests"
-    else
-      "Unknown error: #{response_status_code}"
-    end
-
-    raise SmartyStreetsApi::Exceptions::SevereApiError.new(reason)
-  end
-
-  def self.host
-    SmartyStreetsApi.configuration.base_url
-  end
-
-  def self.auth_args
-    SmartyStreetsApi.configuration.auth_args
+class SmartyStreetsApi::UsStreetAddress < SmartyStreetsApi::ApiClient
+  def self.whitelisted_input_fields
+    %w(
+      input_id
+      street
+      street2
+      secondary
+      city
+      state
+      zipcode
+      lastline
+      addressee
+      urbanization
+      candidates
+    )
+  end
+
+  def self.output_address_lines_fields
+    %w(
+      addressee
+      delivery_line_1
+      delivery_line_2
+      last_line
+    )
+  end
+
+  def self.output_address_indexes_fields
+    %w(
+      input_id
+      input_index
+      candidate_index
+      delivery_point_barcode
+    )
+  end
+
+  def self.endpoint
+    "https://#{SmartyStreetsApi.configuration.base_url}/street-address"
   end
 end

data/lib/smartystreets_api/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreetsApi
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smartystreets_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - florrain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-02 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,8 +98,13 @@ files:
 - README.md
 - Rakefile
 - lib/smartystreets_api.rb
+- lib/smartystreets_api/api_client.rb
+- lib/smartystreets_api/decorators/base_decorator.rb
+- lib/smartystreets_api/decorators/international_format.rb
+- lib/smartystreets_api/decorators/international_format_2_lines.rb
 - lib/smartystreets_api/decorators/us_format.rb
 - lib/smartystreets_api/exceptions.rb
+- lib/smartystreets_api/international_street_address.rb
 - lib/smartystreets_api/monkey_patches.rb
 - lib/smartystreets_api/us_street_address.rb
 - lib/smartystreets_api/version.rb