google_static_maps_helper 1.3.4 → 1.3.5

data/README.rdoc

@@ -4,10 +4,6 @@ This gem provides a simple interface to the Google Static Maps V2 API (http://co
 
 
 = Installation
-If you haven't already, add gemcutter as a gem source
-  [sudo] gem sources --add http://gemcutter.org
-
-Then install this gem
   [sudo] gem install google_static_maps_helper
 
 
@@ -18,15 +14,14 @@ Then install this gem
     marker :lng => 3, :lat => 4
   end
 
-This will return the URL for a map with these markers. Please note that if you do use this approach you have to set key, size and sensor setting.
+This will return the URL for a map with these markers. Please note that if you do use this approach you have to set size and sensor setting.
 You do this by:
-  GoogleStaticMapsHelper.key = 'your google key'
   GoogleStaticMapsHelper.size = '300x600'
   GoogleStaticMapsHelper.sensor = false
 
-If you are on Rails you can put it in your environment configuration file and while you are there you can add the following line inside the configuration block:
+If you are on Rails (2.3.x) you can put it in your environment configuration file and while you are there you can add the following line inside the configuration block:
   Rails::Initializer.run do |config|
-    config.gem 'google_static_maps_helper', :source => 'http://gemcutter.org'
+    config.gem 'google_static_maps_helper'
     ...
   end
 
@@ -56,24 +51,24 @@ You uild a marker by simply sending in an object which responds to lng and lat,
   marker = GoogleStaticMapsHelper::Marker.new(location)
   marker = GoogleStaticMapsHelper::Marker.new(:lng => 1, :lat => 2)
 
-Google's static maps supports some options on markers. You can change the color, the label and the size.
+Google's static maps supports some options on markers. You can change the color, the label and the size or you can send in your own icon.
 (http://code.google.com/apis/maps/documentation/staticmaps/#MarkerStyles). You send in options as a second
 parameter to the new method if you gave a location object, or include it in the hash where lng and lat is.
   marker = GoogleStaticMapsHelper::Marker.new(location, :color => 'blue')
   marker = GoogleStaticMapsHelper::Marker.new(:lng => 1, :lat => 2, :color => 'blue')
+  marker = GoogleStaticMapsHelper::Marker.new(:lng => 1, :lat => 2, :icon => 'http://www.domain.com/icon.png')
 
 
 == Map
-A Map holds many markers, paths, pluss some additional options like the size of the static map, Google key, what zoom level and center point it should be fixed to
+A Map holds many markers, paths, pluss some additional options like the size of the static map, what zoom level and center point it should be fixed to
 etc. If no zoom or center point is give it will calculate the map view based on the markers or paths. You can leave markers and paths out, but then you have to supply
 zoom and center. More info can be found here: http://code.google.com/apis/maps/documentation/staticmaps/#URL_Parameters.
 
 === How to build a map?
-When building a map object you have to supply key, sensor and size. Other options are optional.
-  map = GoogleStaticMapsHelper::Map.new(:key => YOUR_GOOGLE_KEY, :sensor => false, :size => '200x300')
+When building a map object you have to supply sensor and size. Other options are optional.
+  map = GoogleStaticMapsHelper::Map.new(:sensor => false, :size => '200x300')
 
 Or, if you have set default options on GoogleStaticMapsHelper, you can skip the required keys when creating a map
-  GoogleStaticMapsHelper.key = 'your google key'
   GoogleStaticMapsHelper.size = '300x600'
   GoogleStaticMapsHelper.sensor = false
   map = GoogleStaticMapsHelper::Map.new
@@ -88,8 +83,7 @@ We can now ask the map for it's URL to where we'll get the map from. This URL ca
   map.url
 
 Another thing you might want to do is to override the center point and zoom level. This is done during map construction
-  map = GoogleStaticMapsHelper::Map.new(:key => YOUR_GOOGLE_KEY,
-                                        :sensor => false,
+  map = GoogleStaticMapsHelper::Map.new(:sensor => false,
                                         :size => '200x300',
                                         :center => '1,2',
                                         :zoom => 4)

data/VERSION

@@ -1 +1 @@
-1.3.4
+1.3.5

data/changelog.txt

@@ -1,3 +1,7 @@
+= v.1.3.5
+* Added support for icon on markers.
+* DEPRECATED Google API key as its no longer required when requesting a static map (will be removed from this gem in upcoming versions).
+
 = v.1.3.4
 * Paths are now as default encoding it's points with Google's encoding algorithm. Thanks to Joel Rosenberg for providing an easy class to use.
 This will cut the length of the generated URL quite a bit; down to between 1/3 and 1/2 of the old size.

data/google_static_maps_helper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{google_static_maps_helper}
-  s.version = "1.3.4"
+  s.version = "1.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Thorbjørn Hermansen"]
-  s.date = %q{2009-12-03}
+  s.authors = ["Thorbj\303\270rn Hermansen"]
+  s.date = %q{2010-03-08}
   s.description = %q{This gem provides a simple interface to the Google Static Maps V2 API.}
   s.email = %q{thhermansen@gmail.com}
   s.extra_rdoc_files = [
@@ -44,12 +44,12 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{This gem provides a simple interface to the Google Static Maps V2 API}
   s.test_files = [
-    "spec/marker_spec.rb",
+    "spec/path_spec.rb",
+     "spec/marker_spec.rb",
      "spec/map_spec.rb",
-     "spec/spec_helper.rb",
      "spec/location_spec.rb",
-     "spec/path_spec.rb",
-     "spec/google_static_maps_helper_spec.rb"
+     "spec/google_static_maps_helper_spec.rb",
+     "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/google_static_maps_helper.rb

@@ -64,5 +64,11 @@ module GoogleStaticMapsHelper
       block.arity < 1 ? map.instance_eval(&block) : block.call(map)
       map.url
     end
+
+
+    def key=(key)# :nodoc:
+      warn "[DEPRECATION] 'key' is deprecated. Key is no longer used when require a static map. Key will be removed from this gem soon!"
+      @key = key
+    end
   end
 end

data/lib/google_static_maps_helper/map.rb

@@ -14,8 +14,8 @@ module GoogleStaticMapsHelper
     VALID_FORMATS = %w{png png8 png32 gif jpg jpg-basedline}
     VALID_MAP_TYPES = %w{roadmap satellite terrain hybrid}
 
-    REQUIRED_OPTIONS = [:key, :size, :sensor]
-    OPTIONAL_OPTIONS = [:center, :zoom, :format, :maptype, :mobile, :language]
+    REQUIRED_OPTIONS = [:size, :sensor]
+    OPTIONAL_OPTIONS = [:key, :center, :zoom, :format, :maptype, :mobile, :language]
     
     attr_accessor *(REQUIRED_OPTIONS + OPTIONAL_OPTIONS)
     attr_accessor :width, :height
@@ -26,7 +26,6 @@ module GoogleStaticMapsHelper
     # <tt>:options</tt>::   The options available are the same as described in
     #                       Google's API documentation[http://code.google.com/apis/maps/documentation/staticmaps/#Usage].
     #                       In short, valid options are:
-    #                       <tt>:key</tt>::       Your Google maps API key
     #                       <tt>:size</tt>::      The size of the map. Can be a "wxh", [w,h] or {:width => x, :height => y}
     #                       <tt>:sensor</tt>::    Set to true if your application is using a sensor. See the API doc.
     #                       <tt>:center</tt>::    The center point of your map. Optional if you add markers or path to the map
@@ -203,6 +202,26 @@ module GoogleStaticMapsHelper
       raise UnsupportedMaptype unless VALID_MAP_TYPES.include? @maptype
     end
 
+    #
+    # Google static maps does no longer use key when a map is requested,
+    # thus this is deprecated.
+    #
+    def key=(key)# :nodoc:
+      warn "[DEPRECATION] 'key' is deprecated. Key is no longer used when require a static map. Key will be removed from this gem soon!"
+      @key = key
+    end
+
+    #
+    # Just a setter method for key which sets it without warning
+    # to be called from rspec so all tests still passes without
+    # warnings.
+    #
+    # It's just a couple of places we still test that key is working
+    # as it should.
+    #
+    def key_without_warning=(key)# :nodoc:
+      @key = key
+    end
 
     private
     #

data/lib/google_static_maps_helper/marker.rb

@@ -7,7 +7,9 @@ module GoogleStaticMapsHelper
     DEFAULT_OPTIONS = {
       :color => 'red',
       :size => 'mid',
-      :label => nil
+      :label => nil,
+      :icon => nil,
+      :shadow => nil
     }
 
     attr_accessor :location, *DEFAULT_OPTIONS.keys
@@ -48,8 +50,11 @@ module GoogleStaticMapsHelper
     #
     def options_to_url_params # :nodoc:
       params = DEFAULT_OPTIONS.keys.map(&:to_s).sort.inject([]) do |params, attr|
-        value = send(attr)
-        params << "#{attr}:#{URI.escape(value)}" unless value.nil?
+        primary_getter = "#{attr}_to_be_used_in_param"
+        secondary_getter = attr
+
+        value = send(primary_getter) rescue send(secondary_getter)
+        params << "#{attr}:#{URI.escape(value.to_s)}" unless value.nil?
         params
       end
 
@@ -71,6 +76,10 @@ module GoogleStaticMapsHelper
       @color.downcase if @color
     end
 
+    def has_icon?
+      !!@icon
+    end
+
 
     #
     # Proxies calls to the internal object which keeps track of this marker's location.
@@ -91,5 +100,18 @@ module GoogleStaticMapsHelper
       invalid_options = options.keys - DEFAULT_OPTIONS.keys
       raise OptionNotExist, "The following options does not exist: #{invalid_options.join(', ')}" unless invalid_options.empty?
     end
+
+    # Some attributes should be nil when a marker has icon
+    [:color, :label, :size].each do |getter|
+      define_method "#{getter}_to_be_used_in_param" do
+        return nil if has_icon? 
+        send(getter)
+      end
+    end
+
+    def shadow_to_be_used_in_param
+      return nil unless has_icon? 
+      shadow
+    end
   end
 end

data/spec/google_static_maps_helper_spec.rb

@@ -5,7 +5,6 @@ describe GoogleStaticMapsHelper do
   describe "Friendly DSL API" do
     describe "url_for" do
       before do
-        GoogleStaticMapsHelper.key = 'my_key'
         GoogleStaticMapsHelper.size = '300x500'
         GoogleStaticMapsHelper.sensor = false
       end

data/spec/map_spec.rb

@@ -4,7 +4,6 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe GoogleStaticMapsHelper::Map do
   reguire_options = {
     :size => '600x400',
-    :key => 'MY_GOOGLE_KEY',
     :sensor => false
   }
 
@@ -84,7 +83,7 @@ describe GoogleStaticMapsHelper::Map do
 
       @marker2  = GoogleStaticMapsHelper::Marker.new(:lng => 5, :lat => 6, :color => 'green')
       @marker22 = GoogleStaticMapsHelper::Marker.new(:lng => 7, :lat => 8, :color => 'green')
-      @map = GoogleStaticMapsHelper::Map.new(:key => @key, :size => @size, :sensor => @sensor)
+      @map = GoogleStaticMapsHelper::Map.new(:size => @size, :sensor => @sensor)
     end
 
     it "should return options_to_url_params as key, array with markers as value" do
@@ -222,16 +221,19 @@ describe GoogleStaticMapsHelper::Map do
 
   describe "URL" do
     before :each do
-      @key = 'MY_GOOGLE_KEY'
+      @key = 
       @size = '400x600'
       @sensor = false
-      @map = GoogleStaticMapsHelper::Map.new(:key => @key, :size => @size, :sensor => @sensor)
+      @map = GoogleStaticMapsHelper::Map.new(:size => @size, :sensor => @sensor)
       
       @marker1  = GoogleStaticMapsHelper::Marker.new(:lng => 1, :lat => 2)
       @marker11 = GoogleStaticMapsHelper::Marker.new(:lng => 3, :lat => 4)
 
       @marker2  = GoogleStaticMapsHelper::Marker.new(:lng => 5, :lat => 6, :color => 'green')
       @marker22 = GoogleStaticMapsHelper::Marker.new(:lng => 7, :lat => 8, :color => 'green')
+
+      @marker3 = GoogleStaticMapsHelper::Marker.new(:lng => 9, :lat => 10, :icon => 'http://image.com/')
+      @marker33 = GoogleStaticMapsHelper::Marker.new(:lng => 11, :lat => 12, :icon => 'http://image.com/')
     end
 
     describe "valid state to run URL" do
@@ -262,7 +264,13 @@ describe GoogleStaticMapsHelper::Map do
       end
 
       it "should include the key" do
-        @map.url.should include("key=#{@key}")
+        @map.key_without_warning = 'MY_GOOGLE_KEY'
+        @map.url.should include("key=MY_GOOGLE_KEY")
+      end
+
+      it "should not include key if it's nil" do
+        @map.key_without_warning = nil
+        @map.url.should_not include("key=")
       end
       
       it "should include the size" do
@@ -316,16 +324,16 @@ describe GoogleStaticMapsHelper::Map do
       before :each do
         @map << @marker1
         @map << @marker2
+        @map << @marker3
       end
       
       [
-        ['key', 'MY_GOOGLE_KEY'],
         ['sensor', 'false'],
         ['size', '400x600'],
         ['markers', 'color:green|size:mid|6,5'],
-        ['markers', 'color:red|size:mid|2,1']
-      ].each do |pair|
-        key, value = pair
+        ['markers', 'color:red|size:mid|2,1'],
+        ['markers', 'icon:http://image.com/|10,9']
+      ].each do |(key, value)|
         it "should have key: #{key} and value: #{value}" do
           @map.url.should include("#{key}=#{value}")
         end
@@ -339,16 +347,17 @@ describe GoogleStaticMapsHelper::Map do
         @map << @marker11
         @map << @marker2
         @map << @marker22
+        @map << @marker3
+        @map << @marker33
       end
 
       [
-        ['key', 'MY_GOOGLE_KEY'],
         ['sensor', 'true'],
         ['size', '400x600'],
         ['markers', 'color:green|size:mid|6,5|8,7'],
-        ['markers', 'color:red|size:mid|2,1|4,3']
-      ].each do |pair|
-        key, value = pair
+        ['markers', 'color:red|size:mid|2,1|4,3'],
+        ['markers', 'icon:http://image.com/|10,9|12,11']
+      ].each do |(key, value)|
         it "should have key: #{key} and value: #{value}" do
           @map.url.should include("#{key}=#{value}")
         end
@@ -375,7 +384,6 @@ describe GoogleStaticMapsHelper::Map do
       end
 
       [
-        ['key', 'MY_GOOGLE_KEY'],
         ['sensor', 'false'],
         ['size', '400x600'],
         ['path', 'weight:5|1,2|3,4'],

data/spec/marker_spec.rb

@@ -49,24 +49,39 @@ describe GoogleStaticMapsHelper::Marker do
 
     describe "options" do
       describe "defaults" do
+        before do
+          @marker = GoogleStaticMapsHelper::Marker.new(@location_object)
+        end
+
         it "should have a predefined color which location should use" do
-          marker = GoogleStaticMapsHelper::Marker.new(@location_object)
-          marker.color.should == 'red'
+          @marker.color.should == 'red'
         end
 
         it "should have a predefined size" do
-          marker = GoogleStaticMapsHelper::Marker.new(@location_object)
-          marker.size.should == 'mid'
+          @marker.size.should == 'mid'
         end
 
         it "should have a predefined label which should be nil" do
-          marker = GoogleStaticMapsHelper::Marker.new(@location_object)
-          marker.label.should be_nil
+          @marker.label.should be_nil
+        end
+
+        it "should have an icon predefined to nil" do
+          @marker.icon.should be_nil
+        end
+
+        it "should have an shadow predefined to nil" do
+          @marker.shadow.should be_nil
         end
       end
 
       describe "override options as second parameters, location given as object as first param" do
-        {:color => 'blue', :size => 'small', :label => 'A'}.each_pair do |key, value|
+        { 
+          :color => 'blue',
+          :size => 'small',
+          :label => 'A',
+          :icon => 'http://www.url.to/img.png',
+          :shadow => 'true'
+        }.each_pair do |key, value|
           it "should be possible to override #{key} to #{value}" do
             marker = GoogleStaticMapsHelper::Marker.new(@location_object, {key => value})
             marker.send(key).should == value
@@ -75,7 +90,13 @@ describe GoogleStaticMapsHelper::Marker do
       end
 
       describe "override options as first parameter, location mixed into the same hash" do
-        {:color => 'blue', :size => 'small', :label => 'A'}.each_pair do |key, value|
+        { 
+          :color => 'blue',
+          :size => 'small',
+          :label => 'A',
+          :icon => 'http://www.url.to/img.png',
+          :shadow => 'true'
+        }.each_pair do |key, value|
           it "should be possible to override #{key} to #{value}" do
             marker = GoogleStaticMapsHelper::Marker.new(@location_hash.merge({key => value}))
             marker.send(key).should == value
@@ -99,6 +120,14 @@ describe GoogleStaticMapsHelper::Marker do
     GoogleStaticMapsHelper::Marker.new(@location_hash.merge(:color => 'Green')).color.should == 'green'
   end
 
+  it "should answer false when asked if it has an icon when it doesn't" do
+    GoogleStaticMapsHelper::Marker.new(@location_hash).should_not have_icon
+  end
+
+  it "should answer true when asked if it has an icon when it does" do
+    GoogleStaticMapsHelper::Marker.new(@location_hash.merge(:icon => 'http://icon.com/')).should have_icon
+  end
+
 
   describe "generating url parameters" do
     before :each do
@@ -126,5 +155,37 @@ describe GoogleStaticMapsHelper::Marker do
     it "should build location_to_url" do
       @marker.location_to_url.should == '1,2'
     end
+
+    describe "icon and shadow" do
+      before do
+        @marker.icon = 'http://www.icon.com/'
+        @marker.shadow = false
+      end
+
+      it "should contain the icon param" do
+        @marker.options_to_url_params.should include('icon:http://www.icon.com/')
+      end
+
+      it "should URL encode the URL" do
+        @marker.icon = 'http://www.icon.com/foo bar/'
+        @marker.options_to_url_params.should include('icon:http://www.icon.com/foo%20bar/')
+      end
+
+      it "should contain the shadow param" do
+        @marker.options_to_url_params.should include('shadow:false')
+      end
+
+      [:color, :label, :size].each do |property|
+        it "should not contain #{property} when icon is set" do
+          @marker.options_to_url_params.should_not include(property.to_s)
+        end
+      end
+
+      it "should not include shadow if it hasn't an icon" do
+        @marker.shadow = true
+        @marker.icon = nil
+        @marker.options_to_url_params.should_not include('shadow:true')
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: google_static_maps_helper
 version: !ruby/object:Gem::Version 
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors: 
 - "Thorbj\xC3\xB8rn Hermansen"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-03 00:00:00 +01:00
+date: 2010-03-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,9 +81,9 @@ signing_key:
 specification_version: 3
 summary: This gem provides a simple interface to the Google Static Maps V2 API
 test_files: 
+- spec/path_spec.rb
 - spec/marker_spec.rb
 - spec/map_spec.rb
-- spec/spec_helper.rb
 - spec/location_spec.rb
-- spec/path_spec.rb
 - spec/google_static_maps_helper_spec.rb
+- spec/spec_helper.rb