geocodio 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f07d6a0f3badaba67e890b973573eacb03e8af1
-  data.tar.gz: d2f2a3b90df9b526199348811d266b8dbf682b8c
+  metadata.gz: 6e41eb68631540823c0d3087613a9f93449bfd6c
+  data.tar.gz: 8fac1f8f09a1079ae0708fc5b73eed400968f85b
 SHA512:
-  metadata.gz: 5eac91722f01e44514b3c668c16ddc0e36575c545b5658cd58892024ee4a5ceb42af4ef4f4f7d97393941ddf4712aa5201fef901cab7647d69146fe181426cd0
-  data.tar.gz: 74d43b2b707b96fcf9d73dc0e65ed4956e07e260e951d7051a9f0b0c7370cb69edcbd1ca0a331f682038514ef88de212249630d5091c17567f36e80c2cac866f
+  metadata.gz: 3ab47ef498df83514389dd82e9bf4dcfa6d01c0b85520e82dfd680b78e06dc9031b4bcd2cdedb2383dfc6f8e7274195f6dad3f3ee462bc310c1b07743af10c76
+  data.tar.gz: e56d5f65d3ef2e7e3d6a1ba35297305f49eb130e7341f6f510f408d30692d8c96bf0804c38ca6c52a158732786931dcfc320f97d3e272b161cdf4bb5911582c7

data/lib/geocodio/address.rb

@@ -91,5 +91,11 @@ module Geocodio
 
       @timezone = Timezone.new(timezone)
     end
+
+    def <=>(address)
+      return -1 if self.accuracy <  address.accuracy
+      return  0 if self.accuracy == address.accuracy
+      return  1 if self.accuracy >  address.accuracy
+    end
   end
 end

data/lib/geocodio/address_set.rb

@@ -33,5 +33,12 @@ module Geocodio
     def size
       @addresses.size
     end
+
+    # Returns whether or not there are any addresses in this result set.
+    #
+    # @return [Boolean] if there were any results returned by Geocodio
+    def empty?
+      @addresses.empty?
+    end
   end
 end

data/lib/geocodio/client.rb

@@ -72,8 +72,11 @@ module Geocodio
     #
     # @param address [String] the full or partial address to parse
     # @return [Geocodio::Address] a parsed and formatted Address
-    def parse(address)
-      Address.new get('/parse', q: address).body
+    def parse(address, options = {})
+      params, options = normalize_params_and_options(options)
+      params[:q] = address
+
+      Address.new get('/parse', params, options).body
     end
 
     private
@@ -85,39 +88,40 @@ module Geocodio
       end
 
       def geocode_single(address, options = {})
-        params = { q: address }
-        params[:fields] = options[:fields].join(',') if options[:fields]
+        params, options = normalize_params_and_options(options)
+        params[:q] = address
 
-        response  = get '/geocode', params
+        response  = get '/geocode', params, options
         addresses = parse_results(response)
 
         AddressSet.new(address, *addresses)
       end
 
       def reverse_geocode_single(pair, options = {})
+        params, options = normalize_params_and_options(options)
         pair = normalize_coordinates(pair)
-        params = { q: pair }
-        params[:fields] = options[:fields].join(',') if options[:fields]
+        params[:q] = pair
 
-        response  = get '/reverse', params
+        response  = get '/reverse', params, options
         addresses = parse_results(response)
 
         AddressSet.new(pair, *addresses)
       end
 
       def geocode_batch(addresses, options = {})
-        options[:fields] = options[:fields].join(',') if options[:fields]
+        params, options = normalize_params_and_options(options)
+        options[:body] = addresses
 
-        response = post '/geocode', options, body: addresses
+        response = post '/geocode', params, options
 
         parse_nested_results(response)
       end
 
       def reverse_geocode_batch(pairs, options = {})
-        pairs.map! { |pair| normalize_coordinates(pair) }
-        options[:fields] = options[:fields].join(',') if options[:fields]
+        params, options = normalize_params_and_options(options)
+        options[:body] = pairs.map { |pair| normalize_coordinates(pair) }
 
-        response = post '/reverse', options, body: pairs
+        response = post '/reverse', params, options
 
         parse_nested_results(response)
       end
@@ -138,6 +142,7 @@ module Geocodio
         end
 
         http = Net::HTTP.new HOST, PORT
+        http.read_timeout = options[:timeout] if options[:timeout]
         res  = http.start { http.request(req) }
 
         case res

data/lib/geocodio/utils.rb

@@ -9,8 +9,8 @@ module Geocodio
       results = response.body['results']
 
       results.map do |result_set|
-        results   = result_set['response']['results']
-        addresses = results.map { |result| Address.new(result) }
+        addresses = Array(result_set['response']['results'])
+        addresses.map! { |result| Address.new(result) }
 
         query = result_set['query']
 
@@ -22,5 +22,20 @@ module Geocodio
       return coordinates unless coordinates.is_a?(Hash)
       coordinates.sort.map { |p| p[1] }.join(',')
     end
+
+    def normalize_params_and_options(hash)
+      hash = Hash[hash.map { |k, v| [k.to_sym, v] }]
+
+      # The only supported parameter is fields
+      params = hash.select { |k, _| [:fields].include?(k) }
+
+      # Normalize this particular parameter to be a comma-separated string
+      params[:fields] = params[:fields].join(',') if params[:fields]
+
+      # The only supported option is `timeout`
+      options = hash.select { |k, _| [:timeout].include?(k) }
+
+      [params, options]
+    end
   end
 end

data/lib/geocodio/version.rb

@@ -2,7 +2,7 @@ module Geocodio
   class Version
     MAJOR = 2
     MINOR = 0
-    PATCH = 0
+    PATCH = 1
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/client_spec.rb

@@ -19,6 +19,11 @@ describe Geocodio::Client do
     end
   end
 
+  it 'sets the read_timeout on the underlying Net::HTTP request if passed an option' do
+    expect_any_instance_of(Net::HTTP).to receive(:read_timeout=).with(60 * 5)
+    VCR.use_cassette('geocode') { geocodio.geocode([address], timeout: 60 * 5) }
+  end
+
   describe '#geocode' do
     it 'geocodes a single address' do
       VCR.use_cassette('geocode') do
@@ -38,6 +43,12 @@ describe Geocodio::Client do
       end
     end
 
+    it 'raises a client error when geocoding a bad address' do
+      VCR.use_cassette('geocode_bad_address') do
+        expect { geocodio.geocode([' , , ']) }.to raise_error(Geocodio::Client::Error)
+      end
+    end
+
     it 'geocodes multiple addresses' do
       VCR.use_cassette('batch_geocode') do
         addresses = [
@@ -53,6 +64,19 @@ describe Geocodio::Client do
       end
     end
 
+    it 'will return empty AddressSets for bad addresses in a batch geocode' do
+      VCR.use_cassette('batch_geocode_with_bad_address') do
+        addresses = [
+          '1 Infinite Loop Cupertino CA 95014',
+          ' , , '
+        ]
+
+        addresses = geocodio.geocode(addresses)
+
+        expect(addresses.last).to be_empty
+      end
+    end
+
     it 'geocodes multiple addresses with an options hash' do
       VCR.use_cassette('batch_geocode_with_fields') do
         addresses = [

data/spec/vcr_cassettes/batch_geocode_with_bad_address.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.geocod.io/v1/geocode?api_key=secret_api_key
+    body:
+      encoding: UTF-8
+      string: '["1 Infinite Loop Cupertino CA 95014"," , , "]'
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.2.1
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Date:
+      - Thu, 10 Apr 2014 15:55:59 GMT
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"results":[{"query":"1 Infinite Loop Cupertino CA 95014","response":{"input":{"address_components":{"number":"1","street":"Infinite","suffix":"Loop","city":"Cupertino","state":"CA","zip":"95014"},"formatted_address":"1
+        Infinite Loop, Cupertino, CA 95014"},"results":[{"address_components":{"number":"1","street":"Infinite","suffix":"Loop","city":"Cupertino","county":"Santa
+        Clara County","state":"CA","zip":"95014"},"formatted_address":"1 Infinite
+        Loop, Cupertino, CA 95014","location":{"lat":37.331669,"lng":-122.03074},"accuracy":1}]}},{"query":"
+        , , ","response":{"error":"Could not parse address"}}]}'
+    http_version: 
+  recorded_at: Thu, 10 Apr 2014 15:55:59 GMT
+recorded_with: VCR 2.8.0

data/spec/vcr_cassettes/geocode_bad_address.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.geocod.io/v1/geocode?api_key=secret_api_key&q=%20,%20,%20
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 422
+      message: Unprocessable Entity
+    headers:
+      Server:
+      - nginx/1.2.1
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - no-cache
+      Date:
+      - Thu, 10 Apr 2014 15:54:12 GMT
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"error":"Could not parse address"}'
+    http_version: 
+  recorded_at: Thu, 10 Apr 2014 15:54:12 GMT
+recorded_with: VCR 2.8.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geocodio
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - David Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -110,10 +110,12 @@ files:
 - spec/state_legislative_district_spec.rb
 - spec/timezone_spec.rb
 - spec/vcr_cassettes/batch_geocode.yml
+- spec/vcr_cassettes/batch_geocode_with_bad_address.yml
 - spec/vcr_cassettes/batch_geocode_with_fields.yml
 - spec/vcr_cassettes/batch_reverse.yml
 - spec/vcr_cassettes/batch_reverse_with_fields.yml
 - spec/vcr_cassettes/geocode.yml
+- spec/vcr_cassettes/geocode_bad_address.yml
 - spec/vcr_cassettes/geocode_with_fields.yml
 - spec/vcr_cassettes/invalid_key.yml
 - spec/vcr_cassettes/parse.yml
@@ -153,10 +155,12 @@ test_files:
 - spec/state_legislative_district_spec.rb
 - spec/timezone_spec.rb
 - spec/vcr_cassettes/batch_geocode.yml
+- spec/vcr_cassettes/batch_geocode_with_bad_address.yml
 - spec/vcr_cassettes/batch_geocode_with_fields.yml
 - spec/vcr_cassettes/batch_reverse.yml
 - spec/vcr_cassettes/batch_reverse_with_fields.yml
 - spec/vcr_cassettes/geocode.yml
+- spec/vcr_cassettes/geocode_bad_address.yml
 - spec/vcr_cassettes/geocode_with_fields.yml
 - spec/vcr_cassettes/invalid_key.yml
 - spec/vcr_cassettes/parse.yml