smarty_streets 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec8c43504668fd90dff720a7fee5f3f798d02ad6
-  data.tar.gz: 017240974ec6aa6dda3c5398e14e1169c0a32a6e
+  metadata.gz: bed58a4493bc3453d5068e5d6583b7bb62fe5c56
+  data.tar.gz: ef2a974bd5cf84dbb63cdf7fa6f126d4d97d2a9a
 SHA512:
-  metadata.gz: 589dba931bfaeb21335064f071d62d29b1615ae12f359a06bb9eacd00fbde89c398c616cf81994165da1a0bc8f196ec0b9b2e4c0d7c92cfaaca92a910d0504c5
-  data.tar.gz: cea6b100483a9335fe7c5412701f340059b3a6ba0d70b3661184e34dac268957cce9c5656e412d93b60cdfd7d48a3f90daf962665e7f0c3bc18c44766a9ec82c
+  metadata.gz: 8af3ba8d72a9b5ef60ec6b591d45eab28b79e53fc1f01044a9d47b4af2691d1ca79d8e1ce67c72cb8125f229025aff87a09bf0fe27833504c616365e6e8ca2c2
+  data.tar.gz: 1bd2ea27c0a246d3c322ee53ecdbb0d9b7986c502c849476ee59c8de3357c6a322ba11d5c26f7915631dc741403e4eb707f827f16a1075b22c20c19e93d052c2

data/README.md

@@ -24,17 +24,17 @@ You must have valid tokens from http://www.smartystreets.com
 SmartyStreets.configure do |c|
   c.auth_id = 'MY-AUTH-ID'
   c.auth_token = 'MY-AUTH-TOKEN'
-  c.number_of_candidates = 5
+  c.candidates = 5
 end
 
 locations = SmartyStreets.standardize do |location|
   location.street = '1 infinite loop'
   location.city = 'cupertino'
   location.state = 'california'
-  location.zip_code = '95014'
+  location.zipcode = '95014'
 end
 
-# #<SmartyStreets::Location:0x007fb4bbb507d0 @street="1 Infinite Loop", @city="Cupertino", @state="CA", @zip_code="95014-2083", @delivery_point_barcode="950142083017", @components={"primary_number"=>"1", "street_name"=>"Infinite", "street_suffix"=>"Loop", "city_name"=>"Cupertino", "state_abbreviation"=>"CA", "zipcode"=>"95014", "plus4_code"=>"2083", "delivery_point"=>"01", "delivery_point_check_digit"=>"7"}, @meta_data={"record_type"=>"S", "county_fips"=>"06085", "county_name"=>"Santa Clara", "carrier_route"=>"C067", "congressional_district"=>"18", "rdi"=>"Commercial", "elot_sequence"=>"0031", "elot_sort"=>"A", "latitude"=>37.33118, "longitude"=>-122.03062, "precision"=>"Zip9"}>
+# #<SmartyStreets::Location:0x007fb4bbb507d0 @street="1 Infinite Loop", @city="Cupertino", @state="CA", @zipcode="95014-2083", @delivery_point_barcode="950142083017", @components={"primary_number"=>"1", "street_name"=>"Infinite", "street_suffix"=>"Loop", "city_name"=>"Cupertino", "state_abbreviation"=>"CA", "zipcode"=>"95014", "plus4_code"=>"2083", "delivery_point"=>"01", "delivery_point_check_digit"=>"7"}, @metadata={"record_type"=>"S", "county_fips"=>"06085", "county_name"=>"Santa Clara", "carrier_route"=>"C067", "congressional_district"=>"18", "rdi"=>"Commercial", "elot_sequence"=>"0031", "elot_sort"=>"A", "latitude"=>37.33118, "longitude"=>-122.03062, "precision"=>"Zip9"}>
 ```
 
 ## Contributing

data/lib/smarty_streets.rb

@@ -15,7 +15,7 @@ module SmartyStreets
     #   SmartyStreets.configure do |config|
     #     config.auth_id = 'AUTHID'
     #     config.auth_token = 'AUTHTOKEN'
-    #     config.number_of_candidates = 1
+    #     config.candidates = 1
     #   end
     def configure
       self.configuration = Configuration.new

data/lib/smarty_streets/configuration.rb

@@ -10,11 +10,11 @@ module SmartyStreets
     attr_accessor :auth_token
 
     # Number of candidates to provide when making a request.
-    attr_accessor :number_of_candidates
+    attr_accessor :candidates
 
     def initialize
       @api_url = 'api.smartystreets.com'
-      @number_of_candidates = 1
+      @candidates = 1
     end
 
     # Returns a hash of all configurable options

data/lib/smarty_streets/location.rb

@@ -1,8 +1,15 @@
 module SmartyStreets
   class Location
+    # Request & Response fields
+    attr_accessor :input_id
     attr_accessor :street, :street2, :secondary
-    attr_accessor :city, :state, :zip_code
-    attr_accessor :last_line, :addressee, :urbanization
-    attr_accessor :delivery_point_barcode, :components, :meta_data, :analysis
+    attr_accessor :city, :state, :zipcode
+    attr_accessor :lastline, :addressee, :urbanization
+    attr_accessor :candidates
+
+    # Response only fields
+    attr_accessor :input_index, :candidate_index
+    attr_accessor :delivery_line_1, :delivery_line_2, :delivery_point_barcode
+    attr_accessor :components, :metadata, :analysis
   end
 end

data/lib/smarty_streets/request.rb

@@ -21,21 +21,21 @@ module SmartyStreets
 
     def handle_response(response)
       raise InvalidCredentials if response.code == 401
-      raise MalformedData if response.code == 400
-      raise PaymentRequired if response.code == 402
-      raise RemoteServerError if response.code == 500
-      raise NoValidCandidates if response.body.nil?
+      raise MalformedData      if response.code == 400
+      raise PaymentRequired    if response.code == 402
+      raise RemoteServerError  if response.code == 500
+      raise NoValidCandidates  if response.body.nil?
 
       JSON.parse(response.body).collect do |l|
         location = Location.new
-        location.street = l['delivery_line_1']
-        location.city = l['components']['city_name']
-        location.state = l['components']['state_abbreviation']
-        location.zip_code = l['components']['zipcode'] + '-' + l['components']['plus4_code']
+        location.street                 = l['delivery_line_1']
+        location.city                   = l['components']['city_name']
+        location.state                  = l['components']['state_abbreviation']
+        location.zipcode                = l['components']['zipcode'] + '-' + l['components']['plus4_code']
         location.delivery_point_barcode = l['delivery_point_barcode']
-        location.components = l['components']
-        location.meta_data = l['metadata']
-        location.analysis = l['analysis']
+        location.components             = l['components']
+        location.metadata               = l['metadata']
+        location.analysis               = l['analysis']
         location
       end
     end
@@ -46,26 +46,26 @@ module SmartyStreets
 
     def build_request_url(location)
       parameters = {
+        input_id: location.input_id,
         street: location.street,
         street2: location.street2,
         secondary: location.secondary,
         city: location.city,
         state: location.state,
-        zip_code: location.zip_code,
-        last_line: location.last_line,
+        zipcode: location.zipcode,
+        lastline: location.lastline,
         addressee: location.addressee,
         urbanization: location.urbanization,
-        candidates: SmartyStreets.configuration.number_of_candidates,
-        auth_id: SmartyStreets.configuration.auth_id,
-        auth_token: SmartyStreets.configuration.auth_token
+        candidates: location.candidates || SmartyStreets.configuration.candidates,
+        "auth-id" => SmartyStreets.configuration.auth_id,
+        "auth-token" => SmartyStreets.configuration.auth_token
       }
 
       parameter_string = parameters.collect { |k,v|
-        "#{k.to_s.gsub('_', '-')}=#{CGI.escape(v.to_s)}"
+        "#{k.to_s}=#{CGI.escape(v.to_s)}"
       }.join('&')
 
-      'http://' + SmartyStreets.configuration.api_url +
-      '/street-address/?' + parameter_string
+      'https://' + SmartyStreets.configuration.api_url + '/street-address/?' + parameter_string
     end
   end
 end

data/lib/smarty_streets/version.rb

@@ -1,3 +1,3 @@
 module SmartyStreets
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@ describe SmartyStreets::Configuration do
       c.api_url = 'apiurl'
       c.auth_id = 'MYAUTHID'
       c.auth_token = 'MYAUTHTOKEN'
-      c.number_of_candidates = 1
+      c.candidates = 1
     end
   end
 
@@ -22,7 +22,7 @@ describe SmartyStreets::Configuration do
     expect(SmartyStreets.configuration.auth_token).to eq 'MYAUTHTOKEN'
   end
 
-  it 'sets the number_of_candidates' do
-    expect(SmartyStreets.configuration.number_of_candidates).to eq 1
+  it 'sets the candidates' do
+    expect(SmartyStreets.configuration.candidates).to eq 1
   end
 end

data/spec/smarty_streets_spec.rb

@@ -1,171 +1,96 @@
 require 'spec_helper'
 
 describe SmartyStreets do
+  let(:auth_id) { 'MYAUTHID' }
+  let(:auth_token) { 'MYAUTHTOKEN' }
+  let(:candidates) { 1 }
+  let(:response) { double(:response, code: response_code, body: response_body) }
+  let(:response_code) { }
+  let(:response_body) { }
+
+
   before do
+    SmartyStreets.configure do |c|
+      c.auth_id    = auth_id
+      c.auth_token = auth_token
+      c.candidates = candidates
+    end
+
+    allow(HTTParty).to receive(:get).and_return(response)
   end
 
   context SmartyStreets::Request do
     context 'unauthorized request' do
-      let(:unauthorized_request) do
-        double(:response, code: 401)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'ERROR'
-          c.auth_token = 'ERROR'
-        end
-        HTTParty.stub(:get).and_return(unauthorized_request)
-      end
+      let(:response_code) { 401 }
 
       specify 'raises an InvalidCredentials error' do
         expect {
-          locations = SmartyStreets.standardize do |location|
-            location.street = '1 infinite loop'
-            location.city = 'cupertino'
-            location.state = 'california'
-            location.zip_code = '95014'
-          end
+          locations = SmartyStreets.standardize {}
         }.to raise_error SmartyStreets::Request::InvalidCredentials
       end
     end
 
     context 'malformed data' do
-      let(:malformed_data_request) do
-        double(:response, code: 400)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'ERROR'
-          c.auth_token = 'ERROR'
-        end
-        HTTParty.stub(:get).and_return(malformed_data_request)
-      end
+      let(:response_code) { 400 }
 
       specify 'raises an InvalidCredentials error' do
         expect {
-          locations = SmartyStreets.standardize do |location|
-            location.street = '1 infinite loop'
-            location.city = 'cupertino'
-            location.state = 'california'
-            location.zip_code = '95014'
-          end
+          SmartyStreets.standardize {}
         }.to raise_error SmartyStreets::Request::MalformedData
       end
     end
 
     context 'payment required' do
-      let(:payment_required_request) do
-        double(:response, code: 402)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'ERROR'
-          c.auth_token = 'ERROR'
-        end
-        HTTParty.stub(:get).and_return(payment_required_request)
-      end
+      let(:response_code) { 402 }
 
       specify 'raises an InvalidCredentials error' do
         expect {
-          locations = SmartyStreets.standardize do |location|
-            location.street = '1 infinite loop'
-            location.city = 'cupertino'
-            location.state = 'california'
-            location.zip_code = '95014'
-          end
+          SmartyStreets.standardize {}
         }.to raise_error SmartyStreets::Request::PaymentRequired
       end
     end
 
     context 'remote server error' do
-      let(:remote_server_error_request) do
-        double(:response, code: 500)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'ERROR'
-          c.auth_token = 'ERROR'
-        end
-        HTTParty.stub(:get).and_return(remote_server_error_request)
-      end
+      let(:response_code) { 500 }
 
       specify 'raises an InvalidCredentials error' do
         expect {
-          locations = SmartyStreets.standardize do |location|
-            location.street = '1 infinite loop'
-            location.city = 'cupertino'
-            location.state = 'california'
-            location.zip_code = '95014'
-          end
+          SmartyStreets.standardize {}
         }.to raise_error SmartyStreets::Request::RemoteServerError
       end
     end
 
     context 'successful request' do
-      let(:successful_response) do
-        double(:response, code: 200, body: successful_response_data)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'MYAUTHID'
-          c.auth_token = 'MYAUTHTOKEN'
-          c.number_of_candidates = 5
-        end
-        HTTParty.stub(:get).and_return(successful_response)
-      end
+      let(:response_code) { 200 }
+      let(:response_body) { successful_response_data }
+      let(:candidates) { 5 }
+      let(:successful_response_data) { '[{"input_index":0,"candidate_index":0,"delivery_line_1":"1 Infinite Loop","lastline":"Cupertino CA 95014-2083","delivery_point_barcode":"950142083017","components":{"primary_number":"1","street_name":"Infinite","street_suffix":"Loop","city_name":"Cupertino","state_abbreviation":"CA","zipcode":"95014","plus4_code":"2083","delivery_point":"01","delivery_point_check_digit":"7"},"metadata":{"record_type":"S","county_fips":"06085","county_name":"Santa Clara","carrier_route":"C067","congressional_district":"18","rdi":"Commercial","elot_sequence":"0031","elot_sort":"A","latitude":37.33118,"longitude":-122.03062,"precision":"Zip9"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}},{"input_index":0,"candidate_index":1,"addressee":"Apple Computer","delivery_line_1":"1 Infinite Loop","lastline":"Cupertino CA 95014-2084","delivery_point_barcode":"950142084016","components":{"primary_number":"1","street_name":"Infinite","street_suffix":"Loop","city_name":"Cupertino","state_abbreviation":"CA","zipcode":"95014","plus4_code":"2084","delivery_point":"01","delivery_point_check_digit":"6"},"metadata":{"record_type":"F","county_fips":"06085","county_name":"Santa Clara","carrier_route":"C067","congressional_district":"18","rdi":"Commercial","elot_sequence":"0032","elot_sort":"A","latitude":37.33118,"longitude":-122.03062,"precision":"Zip9"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}}]' }
 
       specify 'makes a request for a standardized address' do
         locations = SmartyStreets.standardize do |location|
           location.street = '1 infinite loop'
           location.city = 'cupertino'
           location.state = 'calforna'
-          location.zip_code = '95014'
+          location.zipcode = '95014'
         end
 
-        expect(locations.first.street).to eq '1 Infinite Loop'
-        expect(locations.first.city).to eq 'Cupertino'
-        expect(locations.first.state).to eq 'CA'
-        expect(locations.first.zip_code).to eq '95014-2083'
+        expect(locations.first.street).to  eq '1 Infinite Loop'
+        expect(locations.first.city).to    eq 'Cupertino'
+        expect(locations.first.state).to   eq 'CA'
+        expect(locations.first.zipcode).to eq '95014-2083'
       end
     end
 
     context 'address with no candidates' do
-      let(:unsuccessful_response) do
-        double(:response, code: 200, body: unsuccessful_response_data)
-      end
-
-      before do
-        SmartyStreets.configure do |c|
-          c.auth_id = 'MYAUTHID'
-          c.auth_token = 'MYAUTHTOKEN'
-          c.number_of_candidates = 5
-        end
-        HTTParty.stub(:get).and_return(unsuccessful_response)
-      end
+      let(:response_code) { 200 }
+      let(:candidates) { 5 }
 
       specify 'makes a request for a standardized address' do
         expect {
-          locations = SmartyStreets.standardize do |location|
-            location.street = '1234 Unicorn Lane'
-            location.city = 'earth'
-            location.state = 'galaxy'
-            location.zip_code = '1234923'
-          end
+          locations = SmartyStreets.standardize {}
         }.to raise_error SmartyStreets::Request::NoValidCandidates
       end
     end
   end
 
-  def successful_response_data
-    '[{"input_index":0,"candidate_index":0,"delivery_line_1":"1 Infinite Loop","last_line":"Cupertino CA 95014-2083","delivery_point_barcode":"950142083017","components":{"primary_number":"1","street_name":"Infinite","street_suffix":"Loop","city_name":"Cupertino","state_abbreviation":"CA","zipcode":"95014","plus4_code":"2083","delivery_point":"01","delivery_point_check_digit":"7"},"metadata":{"record_type":"S","county_fips":"06085","county_name":"Santa Clara","carrier_route":"C067","congressional_district":"18","rdi":"Commercial","elot_sequence":"0031","elot_sort":"A","latitude":37.33118,"longitude":-122.03062,"precision":"Zip9"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}},{"input_index":0,"candidate_index":1,"addressee":"Apple Computer","delivery_line_1":"1 Infinite Loop","last_line":"Cupertino CA 95014-2084","delivery_point_barcode":"950142084016","components":{"primary_number":"1","street_name":"Infinite","street_suffix":"Loop","city_name":"Cupertino","state_abbreviation":"CA","zipcode":"95014","plus4_code":"2084","delivery_point":"01","delivery_point_check_digit":"6"},"metadata":{"record_type":"F","county_fips":"06085","county_name":"Santa Clara","carrier_route":"C067","congressional_district":"18","rdi":"Commercial","elot_sequence":"0032","elot_sort":"A","latitude":37.33118,"longitude":-122.03062,"precision":"Zip9"},"analysis":{"dpv_match_code":"Y","dpv_footnotes":"AABB","dpv_cmra":"N","dpv_vacant":"N","active":"Y"}}]'
-  end
-
-  def unsuccessful_response_data
-    nil
-  end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarty_streets
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Russ Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: A ruby gem to integrate with http://www.smartystreets.com