google_maps 0.1.1 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/google_maps.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "google_maps"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tushar Ranka"]
-  s.date = "2012-05-11"
+  s.date = "2012-05-15"
   s.description = "General Purpose Library to interact with Google Maps v3 api. Geocoder. "
   s.email = "tusharranka@gmail.com"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "lib/google_maps/geocoder/location.rb",
     "lib/google_maps/geocoder/result.rb",
     "test/google_maps/geocoder_test.rb",
+    "test/google_maps_test.rb",
     "test/test_helper.rb"
   ]
   s.homepage = "http://github.com/appfolio/geocode"

data/lib/google_maps/geocoder/location.rb

@@ -3,7 +3,35 @@ module GoogleMaps
     class Location
 
       LOCATION_TYPES      = [ "ROOFTOP", "RANGE_INTERPOLATED", "GEOMETRIC_CENTER", "APPROXIMATE"]
+      TYPES = [
+        "street_address",               # indicates a precise street address.
+        "route",                        # indicates a named route (such as "US 101").
+        "intersection",                 # indicates a major intersection, usually of two major roads.
+        "political",                    # indicates a political entity. Usually, this type indicates a polygon of some civil administration.
+        "country",                      # indicates the national political entity, and is typically the highest order type returned by the Geocoder.
+        "administrative_area_level_1",  # indicates a first-order civil entity below the country level. Within the United States, these administrative levels are states. Not all nations exhibit these administrative levels.
+        "administrative_area_level_2",  # indicates a second-order civil entity below the country level. Within the United States, these administrative levels are counties. Not all nations exhibit these administrative levels.
+        "administrative_area_level_3",  # indicates a third-order civil entity below the country level. This type indicates a minor civil division. Not all nations exhibit these administrative levels.
+        "colloquial_area",              # indicates a commonly-used alternative name for the entity.
+        "locality",                     # indicates an incorporated city or town political entity.
+        "sublocality",                  # indicates an first-order civil entity below a locality
+        "neighborhood",                 # indicates a named neighborhood
+        "premise",                      # indicates a named location, usually a building or collection of buildings with a common name
+        "subpremise",                   # indicates a first-order entity below a named location, usually a singular building within a collection of buildings with a common name
+        "postal_code",                  # indicates a postal code as used to address postal mail within the country.
+        "natural_feature",              # indicates a prominent natural feature.
+        "airport",                      # indicates an airport.
+        "park",                         # indicates a named park.
+        "point_of_interest",            # indicates a named point of interest. Typically, these "POI"s are prominent local entities that don't easily fit in another category such as "Empire State Building" or "Statue of Liberty."
+        "post_box",                     # indicates a specific postal box.
+        "street_number",                # indicates the precise street number.
+        "floor",                        # indicates the floor of a building address.
+        "room",                         # indicates the room of a building address.
+      ]
+
       ACCURATE_TYPES      = [ "street_address", "premise", "subpremise" ]
+      
+      
 
       attr_accessor :formatted_address, :location_type, :latitude, :longitude, :types
 

data/lib/google_maps/geocoder.rb

@@ -2,26 +2,33 @@ require 'google_maps/geocoder/result'
 require 'google_maps/geocoder/location'
 
 module GoogleMaps
+  class GeocodeFailed < StandardError
+    def initialize(location, original_error)
+      super "Failed while geocoding '#{location}': #{original_error.class.name}: #{original_error.message}"
+    end
+  end
+  
   module Geocoder
 
     URI_BASE = "maps.googleapis.com/maps/api/geocode/json"
 
     def self.locate!(address, options = { })
       options = {
-        :ssl    => false,
+        :ssl     => false,
         :address => address,
-        :sensor => false
+        :sensor  => false
       }.merge(options)
 
       json = ActiveSupport::JSON.decode RestClient.get(url(options))
-
       Geocoder::Result.new(json)
+    rescue => e
+      raise GeocodeFailed.new(address, e)
     end
 
     def self.url(options)
       ssl = options.delete(:ssl)
 
-      if !options[:clientId] && ::GoogleMaps.enterprise_account
+      if !options[:clientId] && ::GoogleMaps.enterprise_account?
         options.merge!(::GoogleMaps.geocoder_key_name => ::GoogleMaps.key)
       end
 
@@ -36,6 +43,5 @@ module GoogleMaps
       protocol = options[:ssl] ? "https" : "http"
       "#{protocol}://#{URI_BASE}"
     end
-
   end
 end

data/lib/google_maps.rb

@@ -4,13 +4,38 @@ require 'active_support/all'
 require 'google_maps/geocoder'
 
 module GoogleMaps
-  mattr_accessor :key, :enterprise_account
+  @@enterprise_account = false
+  @@key = nil
+  
+  def self.configure(&block)
+    block.call(self)
+  end
+  
+  def self.key(*args)
+    if args.present?
+      @@key = args.first
+    else
+      @@key
+    end
+  end
+  
+  def self.use_enterprise_account(*args)
+    if args.first.present? && args.first == false
+      @@enterprise_account = false
+    else
+      @@enterprise_account = true
+    end
+  end
+  
+  def self.enterprise_account?
+    @@enterprise_account || false
+  end
 
   def self.key_name
-    enterprise_account ? "client" : "key"
+    enterprise_account? ? :client : :key
   end
 
   def self.geocoder_key_name
-    "clientId" if enterprise_account
+    :clientId if enterprise_account?
   end
 end

data/test/google_maps/geocoder_test.rb

@@ -1,5 +1,4 @@
 require 'test_helper'
-require 'mocha'
 
 class GoogleMaps::GeocoderTest < ActiveSupport::TestCase
 
@@ -44,8 +43,25 @@ class GoogleMaps::GeocoderTest < ActiveSupport::TestCase
     assert !manhattan_ny.location_type.rooftop?
     assert manhattan_ny.location_type.approximate?
     assert_equal ["sublocality", "political"], manhattan_ny.types
-
   end
+  
+  def test_locate__error
+    error = StandardError.new("there was an error doing that")
+    
+    GoogleMaps::Geocoder.expects(:url).returns(:url)
+    RestClient.expects(:get).with(:url).raises(error)
+    error_raised = false
+    begin
+      GoogleMaps::Geocoder.locate!("New York")
+    rescue => e
+      error_raised = true
+      assert e.is_a?(GoogleMaps::GeocodeFailed), e.class.name
+      assert_equal "Failed while geocoding 'New York': StandardError: there was an error doing that", e.message
+    end
+    
+    assert error_raised
+  end
+  
 
   def test_url_base_path
     assert_equal "http://#{GoogleMaps::Geocoder::URI_BASE}", GoogleMaps::Geocoder.uri_base_path
@@ -59,12 +75,10 @@ class GoogleMaps::GeocoderTest < ActiveSupport::TestCase
   end
 
   def test_url__with_client_id
-    GoogleMaps.key = "bar"
-    GoogleMaps.enterprise_account = true
+    GoogleMaps.key "bar"
+    GoogleMaps.use_enterprise_account
     assert_url_parts expected_url("address=A&sensor=false&clientId=foo"), GoogleMaps::Geocoder.url(ordered_hash(:sensor => false, :address => "A", :clientId => 'foo'))
     assert_url_parts expected_url("address=A&sensor=false&clientId=bar"), GoogleMaps::Geocoder.url(ordered_hash(:sensor => false, :address => "A"))
-    #assert_equal expected_url("address=A&sensor=false&clientId=foo"), GoogleMaps::Geocoder.url(ordered_hash(:sensor => false, :address => "A", :clientId => 'foo'))
-    #
   end
 
   private

data/test/google_maps_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+class GoogleMaps::GeocoderTest < ActiveSupport::TestCase
+  def test_configure__free_key
+    GoogleMaps.configure do |maps|
+      maps.key "foobar"
+    end
+    
+    assert_equal "foobar", GoogleMaps.key
+    assert_equal false, GoogleMaps.enterprise_account?
+    assert_equal :key, GoogleMaps.key_name
+    assert_equal nil, GoogleMaps.geocoder_key_name
+  end
+  
+  def test_configure__enterprise_key
+    GoogleMaps.configure do |maps|
+      maps.key "foobarenterprise"
+      maps.use_enterprise_account
+    end
+    
+    assert_equal "foobarenterprise", GoogleMaps.key
+    assert GoogleMaps.enterprise_account?
+    assert_equal :client, GoogleMaps.key_name
+    assert_equal :clientId, GoogleMaps.geocoder_key_name
+  end
+  
+  
+end

data/test/test_helper.rb

@@ -15,14 +15,15 @@ require 'test/unit'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'google_maps'
+require 'mocha'
 
 class ActiveSupport::TestCase
 
   setup :clear_configuration
 
   def clear_configuration
-    GoogleMaps.enterprise_account = nil
-    GoogleMaps.key = nil
+    GoogleMaps.send :class_variable_set, :@@key, nil
+    GoogleMaps.send :class_variable_set, :@@enterprise_account, false
   end
 
   def castilian_json

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: google_maps
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tushar Ranka
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-11 00:00:00 Z
+date: 2012-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime
@@ -115,6 +115,7 @@ files:
 - lib/google_maps/geocoder/location.rb
 - lib/google_maps/geocoder/result.rb
 - test/google_maps/geocoder_test.rb
+- test/google_maps_test.rb
 - test/test_helper.rb
 homepage: http://github.com/appfolio/geocode
 licenses: