static-gmaps 0.0.1 → 0.0.2

data/History.txt

@@ -1,5 +1,11 @@
+=== 0.0.2 / 2008-02-25
+
+* 1 Major Enhancement:
+  * Now supports Markers!
+* 1 Minor Enhancement:
+  * Removed StaticGmaps::Map.to_blob
+
 === 0.0.1 / 2008-02-25
 
 * 1 major enhancement
   * Birthday!
-

data/Manifest.txt

@@ -5,4 +5,3 @@ README.txt
 Rakefile
 lib/static_gmaps.rb
 spec/static_gmaps_spec.rb
-spec/test_image.gif

data/README.txt

@@ -8,7 +8,7 @@ Provides an interface to the Google Static Maps API.
 
 == FEATURES/PROBLEMS:
 
-* See SYNOPSIS.
+* Provides an interface to the Google Static Maps API.
 
 == SYNOPSIS:
 
@@ -16,12 +16,15 @@ Provides an interface to the Google Static Maps API.
 	GOOGLE_MAPS_API_KEY = ''
 
   map = StaticGmaps::Map.new :center   => [ 40.714728, -73.998672 ],
-                             :zoom     => 12,
+                             :zoom     => 5,
                              :size     => [ 500, 400 ],
                              :map_type => :roadmap,
                              :key      => GOOGLE_MAPS_API_KEY
-  map.url => 'http://maps.google.com/staticmap?center=40.714728,-73.998672&zoom=12&size=500x400&map_type=roadmap&key=KEY
-  map.to_blob => GIF Data
+  map.markers << StaticGmaps::Marker.new(:latitude => 40,
+                                         :longitude => -73,
+                                         :color => :blue,
+                                         :alpha_character => :b)
+  map.url => 'http://maps.google.com/staticmap?center=40.714728,-73.998672&key=GOOGLE_MAPS_API_KEY&map_type=roadmap&markers=40,-73,blueb&size=500x400&zoom=5'
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -39,6 +39,7 @@ Hoe.new('static-gmaps', StaticGmaps::VERSION) do |p|
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
   p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
 end
 
 desc "Run all examples"

data/lib/static_gmaps.rb

@@ -23,7 +23,7 @@
 require 'net/http'
 
 module StaticGmaps 
-  VERSION = '0.0.1' 
+  VERSION = '0.0.2' 
 
   class Map
     DEFAULT_CENTER   = [ 0, 0 ]
@@ -31,12 +31,14 @@ module StaticGmaps
     DEFAULT_SIZE     = [ 500, 400 ]
     DEFAULT_MAP_TYPE = :roadmap
     DEFAULT_KEY      = 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA'
+    DEFAULT_MARKERS  = [ ]
 
     attr_accessor :center,
                   :zoom,
                   :size,
                   :map_type,
-                  :key
+                  :key,
+                  :markers
 
     def initialize(options = {})
       self.center   = options[:center]   || DEFAULT_CENTER
@@ -44,6 +46,7 @@ module StaticGmaps
       self.size     = options[:size]     || DEFAULT_SIZE
       self.map_type = options[:map_type] || DEFAULT_MAP_TYPE
       self.key      = options[:key]      || DEFAULT_KEY
+      self.markers  = options[:markers]  || DEFAULT_MARKERS
     end
 
     def width
@@ -54,8 +57,33 @@ module StaticGmaps
       size[1]
     end
 
+    # http://code.google.com/apis/maps/documentation/staticmaps/index.html#URL_Parameters
     def url
-      return "http://maps.google.com/staticmap?center=#{center[0]},#{center[1]}&zoom=#{zoom}&size=#{size[0]}x#{size[1]}&map_type=#{map_type}&key=#{key}"
+      raise MissingArgument.new("Size must be set before a url can be generated for Map.") if !size || !size[0] || !size[1]
+      raise MissingArgument.new("Key must be set before a url can be generated for Map.") if !key
+      if !(markers && markers.size > 1)
+        raise MissingArgument.new("Center must be set before a url can be generated for Map (or multiple markers can be specified).") if !center
+        raise MissingArgument.new("Zoom must be set before a url can be generated for Map (or multiple markers can be specified).") if !zoom
+      end
+      parameters = {}
+      parameters[:size]     = "#{size[0]}x#{size[1]}"
+      parameters[:key]      = "#{key}"
+      parameters[:map_type] = "#{map_type}"               if map_type
+      parameters[:center]   = "#{center[0]},#{center[1]}" if center
+      parameters[:zoom]     = "#{zoom}"                   if zoom
+      parameters[:markers]  = "#{markers_url_fragment}"   if markers_url_fragment
+      parameters = parameters.to_a.sort { |a, b| a[0].to_s <=> b[0].to_s }
+      parameters = parameters.collect { |parameter| "#{parameter[0]}=#{parameter[1]}" }
+      parameters = parameters.join '&'
+      return "http://maps.google.com/staticmap?#{parameters}"
+    end
+    
+    def markers_url_fragment
+      if markers && markers.any?
+        return markers.collect{|marker| marker.url_fragment }.join('|')
+      else
+        return nil
+      end
     end
 
     def to_blob
@@ -74,4 +102,55 @@ module StaticGmaps
         end
       end
   end
+  
+  # http://code.google.com/apis/maps/documentation/staticmaps/index.html#Markers
+  class Marker
+    DEFAULT_LATITUDE        = nil
+    DEFAULT_LONGITUDE       = nil
+    DEFAULT_COLOR           = nil
+    DEFAULT_ALPHA_CHARACTER = nil
+    VALID_COLORS            = [ :red, :green, :blue ]
+    VALID_ALPHA_CHARACTERS  = [ :a, :b, :c, :d, :e, :f, :g, :h, :i, :j, :k, :l, :m, :n, :o, :p, :q, :r, :s, :t, :u, :v, :w, :x, :y, :z ]
+    
+    attr_accessor :latitude,
+                  :longitude,
+                  :color,
+                  :alpha_character
+    
+    def initialize(options = {})
+      self.latitude        = options[:latitude]        || DEFAULT_LATITUDE
+      self.longitude       = options[:longitude]       || DEFAULT_LONGITUDE
+      self.color           = options[:color]           || DEFAULT_COLOR
+      self.alpha_character = options[:alpha_character] || DEFAULT_ALPHA_CHARACTER
+    end
+    
+    def color=(value)
+      if value
+        value = value.to_s.downcase.to_sym
+        if !VALID_COLORS.include?(value)
+          raise ArgumentError.new("#{value} is not a supported color.  Supported colors are #{VALID_COLORS.join(', ')}.")
+        end
+      end
+      @color = value
+    end
+    
+    def alpha_character=(value)
+      if value
+        value = value.to_s.downcase.to_sym
+        if !VALID_ALPHA_CHARACTERS.include?(value)
+          raise ArgumentError.new("#{value} is not a supported alpha_character.  Supported colors are #{VALID_ALPHA_CHARACTERS.join(', ')}.")
+        end
+      end
+      @alpha_character = value
+    end
+    
+    def url_fragment
+      raise MissingArgument.new("Latitude must be set before a url_fragment can be generated for Marker.") if !latitude
+      raise MissingArgument.new("Longitude must be set before a url_fragment can be generated for Marker.") if !longitude
+      x  = "#{latitude},#{longitude}"
+      x += ",#{color}" if color
+      x += "#{alpha_character}" if alpha_character
+      return x
+    end
+  end
 end

data/spec/static_gmaps_spec.rb

@@ -1,40 +1,81 @@
 require 'rubygems'
 require 'spec'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'static_gmaps')
+include StaticGmaps
 
 STATIC_GOOGLE_MAP_DEFAULT_PARAMETERS_TEST_IMAGE_PATH = File.join File.dirname(__FILE__), 'test_image.gif'
 
-describe StaticGmaps::Map, 'with no attributes set' do
-  before(:each) do @static_google_map = StaticGmaps::Map.new end
+describe StaticGmaps do
+  describe Map, 'initialize with no attributes' do
+    before(:each) do @map = StaticGmaps::Map.new end
+    
+    it 'should set center to default'   do @map.center.should   == StaticGmaps::Map::DEFAULT_CENTER end
+    it 'should set zoom to default'     do @map.zoom.should     == StaticGmaps::Map::DEFAULT_ZOOM end
+    it 'should set size to default'     do @map.size.should     == StaticGmaps::Map::DEFAULT_SIZE end
+    it 'should set map_type to default' do @map.map_type.should == StaticGmaps::Map::DEFAULT_MAP_TYPE end
+    it 'should set key to default'      do @map.key.should      == StaticGmaps::Map::DEFAULT_KEY end
+    it 'should set its markers default' do @map.markers.should  == StaticGmaps::Map::DEFAULT_MARKERS end
+  end
   
-  it 'should have a center set to default'   do @static_google_map.center.should   == StaticGmaps::Map::DEFAULT_CENTER end
-  it 'should have a zoom set to default'     do @static_google_map.zoom.should     == StaticGmaps::Map::DEFAULT_ZOOM end
-  it 'should have a size set to default'     do @static_google_map.size.should     == StaticGmaps::Map::DEFAULT_SIZE end
-  it 'should have a map_type set to default' do @static_google_map.map_type.should == StaticGmaps::Map::DEFAULT_MAP_TYPE end
-  it 'should have a key set to default'      do @static_google_map.key.should      == StaticGmaps::Map::DEFAULT_KEY end
-end
-
-describe StaticGmaps::Map, 'with all attributes set' do
-  before(:each) do
-    @static_google_map = StaticGmaps::Map.new :center   => [ 40.714728, -73.998672 ],
-                                              :zoom     => 12,
-                                              :size     => [ 500, 400 ],
-                                              :map_type => :roadmap,
-                                              :key      => 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA'
+  describe Map, 'initialize with all attributes' do
+    before(:each) do
+      @marker = StaticGmaps::Marker.new :latitude => 0, :longitude => 0
+      @map = StaticGmaps::Map.new :center   => [ 40.714728, -73.998672 ],
+                                  :zoom     => 12,
+                                  :size     => [ 500, 400 ],
+                                  :map_type => :roadmap,
+                                  :key      => 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA',
+                                  :markers  => [ @marker ]
+    end
+    
+    it 'should set center'   do @map.center.should   == [ 40.714728, -73.998672 ] end
+    it 'should set zoom'     do @map.zoom.should     == 12 end
+    it 'should set size'     do @map.size.should     == [ 500, 400 ] end
+    it 'should set map_type' do @map.map_type.should == :roadmap end
+    it 'should set key'      do @map.key.should      == 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA' end
+    it 'should set markers'  do @map.markers.should  == [ @marker ] end
   end
   
-  it 'should have a center'                  do @static_google_map.center.should   == [ 40.714728, -73.998672 ] end
-  it 'should have a zoom'                    do @static_google_map.zoom.should     == 12 end
-  it 'should have a size'                    do @static_google_map.size.should     == [ 500, 400 ] end
-  it 'should have a map_type'                do @static_google_map.map_type.should == :roadmap end
-  it 'should have a key'                     do @static_google_map.key.should      == 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA' end
-end
-
-describe StaticGmaps::Map do
-  before(:each) do @static_google_map = StaticGmaps::Map.new end
+  describe Map, 'with default attributes' do
+    before(:each) do @map = StaticGmaps::Map.new end
+    
+    it 'should have a url'    do @map.url.should      == 'http://maps.google.com/staticmap?center=0,0&key=ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA&map_type=roadmap&size=500x400&zoom=1' end
+    it 'should have a width'  do @map.width.should    == 500 end
+    it 'should have a height' do @map.height.should   == 400 end
+    #it 'should respond to to_blob with an image' do @map.to_blob.should  == File.read(STATIC_GOOGLE_MAP_DEFAULT_PARAMETERS_TEST_IMAGE_PATH) end
+  end
   
-  it 'should have a url'                     do @static_google_map.url.should      == 'http://maps.google.com/staticmap?center=0,0&zoom=1&size=500x400&map_type=roadmap&key=ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA' end
-  it 'should have a width'                   do @static_google_map.width.should    == 500 end
-  it 'should have a height'                  do @static_google_map.height.should   == 400 end
-  #it 'should respond to to_blob with an image' do @static_google_map.to_blob.should  == File.read(STATIC_GOOGLE_MAP_DEFAULT_PARAMETERS_TEST_IMAGE_PATH) end
+  describe Map, 'with default attributes and markers' do
+    before(:each) do
+      @marker_1 = StaticGmaps::Marker.new :latitude => 10, :longitude => 20, :color => 'green', :alpha_character => 'A'
+      @marker_2 = StaticGmaps::Marker.new :latitude => 15, :longitude => 25, :color => 'blue', :alpha_character => 'B'
+      @map = StaticGmaps::Map.new :markers  => [ @marker_1, @marker_2 ]
+    end
+    
+    it 'should have a markers_url_fragment'              do @map.markers_url_fragment.should == '10,20,greena|15,25,blueb' end
+    it 'should include the markers_url_fragment its url' do @map.url.should include(@map.markers_url_fragment) end
+  end
+    
+  describe Marker, 'initialize with no attributes' do
+    before(:each) do @marker = StaticGmaps::Marker.new end
+  
+    it 'should set latitude to default'        do @marker.latitude.should        == StaticGmaps::Marker::DEFAULT_LATITUDE end
+    it 'should set longitude to default'       do @marker.longitude.should       == StaticGmaps::Marker::DEFAULT_LONGITUDE end
+    it 'should set color to default'           do @marker.color.should           == StaticGmaps::Marker::DEFAULT_COLOR end
+    it 'should set alpha_character to default' do @marker.alpha_character.should == StaticGmaps::Marker::DEFAULT_ALPHA_CHARACTER end
+  end
+  
+  describe Marker, 'initialize with all attributes' do
+    before(:each) do
+      @marker = StaticGmaps::Marker.new :latitude => 12,
+                                        :longitude => 34,
+                                        :color => 'red',
+                                        :alpha_character => 'z'
+    end
+    
+    it 'should set latitude'        do @marker.latitude.should        == 12 end
+    it 'should set longitude'       do @marker.longitude.should       == 34 end
+    it 'should set color'           do @marker.color.should           == :red end
+    it 'should set alpha_character' do @marker.alpha_character.should == :z end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: static-gmaps
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - John Wulff
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.0
     version: 
-description: "== DESCRIPTION:  Provides an interface to the Google Static Maps API.  == FEATURES/PROBLEMS:  * See SYNOPSIS."
+description: "== DESCRIPTION:  Provides an interface to the Google Static Maps API.  == FEATURES/PROBLEMS:  * Provides an interface to the Google Static Maps API."
 email: johnwulff@gmail.com
 executables: []
 
@@ -40,7 +40,6 @@ files:
 - Rakefile
 - lib/static_gmaps.rb
 - spec/static_gmaps_spec.rb
-- spec/test_image.gif
 has_rdoc: true
 homepage: 
 post_install_message: