dmattes-static-gmaps 0.0.4

data/History.txt

@@ -0,0 +1,26 @@
+=== 0.0.4 / 2009-02-18 by daniel.mattes@gmx.de
+
+* No Map::default_center, because of auto centering through google when markers.count > 1
+* If no option[:markers] are given, they will be set to []. Otherwise the constant markers array will grow to unlimited.
+* Setting constants like geokit do it.
+  In initializers you can overwrite it like
+  StaticGmaps::default_size = [ 170, 200 ]
+* Now on http://github.com/dmattes/static-gmaps/
+
+=== 0.0.3 / 2008-02-26
+
+* 2 Minor Enhancement:
+  * Now raises exception when there are too many markers.
+  * Now raises exception when the url becomes too long.
+
+=== 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 John Wulff <johnwulff@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/static_gmaps.rb
+spec/static_gmaps_spec.rb

data/Rakefile

@@ -0,0 +1,52 @@
+# The MIT License
+# 
+# Copyright (c) 2008 John Wulff <johnwulff@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'rubygems'
+require 'hoe'
+require './lib/static_gmaps.rb'
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts 'To use rspec for testing you must install rspec gem:'
+  puts '$ sudo gem install rspec'
+  exit
+end
+
+Hoe.new('static-gmaps', StaticGmaps::version) do |p|
+  p.rubyforge_name = 'static-gmaps'
+  p.author = 'Daniel Mattes'
+  p.email = 'daniel.mattes@gmx.de'
+  p.summary = 'Provides an interface to the Google Static Maps API.'
+  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"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/*.rb']
+end
+
+task :default => :spec
+
+# vim: syntax=Ruby

data/lib/static_gmaps.rb

@@ -0,0 +1,185 @@
+# The MIT License
+# 
+# Copyright (c) 2008 John Wulff <johnwulff@gmail.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'net/http'
+
+module StaticGmaps 
+  @@version = '0.0.4' 
+  
+  #map  
+  @@maximum_url_size = 1978
+  @@maximum_markers  = 50
+  @@default_center   = [ 0, 0 ]
+  @@default_zoom     = 1
+  @@default_size     = [ 500, 400 ]
+  @@default_map_type = :roadmap
+  @@default_key      = 'ABQIAAAAzr2EBOXUKnm_jVnk0OJI7xSosDVG8KKPE1-m51RBrvYughuyMxQ-i1QfUnH94QxWIa6N4U6MouMmBA'
+  
+
+  
+  #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 ]    
+  
+  [:version, :maximum_url_size, :maximum_markers, :default_center, :default_zoom, :default_size, :default_map_type, :default_key,
+  :default_latitude, :default_longitude, :default_color, :default_alpha_character, :valid_colors, :valid_alpha_characters].each do |sym|
+    class_eval <<-EOS
+      def self.#{sym}
+        @@#{sym}
+      end
+
+      def self.#{sym}=(obj)
+        @@#{sym} = obj
+      end
+    EOS
+  end  
+      
+  class Map
+
+
+    attr_accessor :center,
+                  :zoom,
+                  :size,
+                  :map_type,
+                  :key,
+                  :markers
+
+    def initialize(options = {})
+      self.center   = options[:center]
+      self.zoom     = options[:zoom]     || StaticGmaps::default_zoom
+      self.size     = options[:size]     || StaticGmaps::default_size
+      self.map_type = options[:map_type] || StaticGmaps::default_map_type
+      self.key      = options[:key]      || StaticGmaps::default_key
+      self.markers  = options[:markers]  || [ ]
+    end
+
+    def width
+      size[0]
+    end
+
+    def height
+      size[1]
+    end
+
+    # http://code.google.com/apis/maps/documentation/staticmaps/index.html#URL_Parameters
+    def url
+      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(!self.center && !(markers && markers.size >= 1))
+        self.center = StaticGmaps::default_center
+      end
+      
+      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
+      raise "Google will not display more than #{StaticGmaps::maximum_markers} markers." if markers && markers.size > StaticGmaps::maximum_markers
+      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 '&'
+      x = "http://maps.google.com/staticmap?#{parameters}"
+      raise "Google doesn't like the url to be longer than #{StaticGmaps::maximum_url_size} characters.  Try fewer or less precise markers." if x.size > StaticGmaps::maximum_url_size
+      return x
+    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
+      fetch
+      return @blob
+    end
+
+    private
+      def fetch
+        if !@last_fetched_url || @last_fetched_url != url || !@blob
+          uri = URI.parse url
+          request = Net::HTTP::Get.new uri.path
+          response = Net::HTTP.start(uri.host, uri.port) { |http| http.request request }
+          @blob = response.body
+          @last_fetched_url = url
+        end
+      end
+  end
+
+  # http://code.google.com/apis/maps/documentation/staticmaps/index.html#Markers
+  class Marker
+    
+    attr_accessor :latitude,
+                  :longitude,
+                  :color,
+                  :alpha_character
+    
+    def initialize(options = {})
+      self.latitude        = options[:latitude]        || StaticGmaps::default_latitude
+      self.longitude       = options[:longitude]       || StaticGmaps::default_longitude
+      self.color           = options[:color]           || StaticGmaps::default_color
+      self.alpha_character = options[:alpha_character] || StaticGmaps::default_alpha_character
+    end
+    
+    def color=(value)
+      if value
+        value = value.to_s.downcase.to_sym
+        if !StaticGmaps::valid_colors.include?(value)
+          raise ArgumentError.new("#{value} is not a supported color.  Supported colors are #{StaticGmaps::valid_colors.join(', ')}.")
+        end
+      end
+      @color = value
+    end
+    
+    def alpha_character=(value)
+      if value
+        value = value.to_s.downcase.to_sym
+        if !StaticGmaps::valid_alpha_characters.include?(value)
+          raise ArgumentError.new("#{value} is not a supported alpha_character.  Supported colors are #{StaticGmaps::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/readme.txt

@@ -0,0 +1,64 @@
+= StaticGmaps
+
+* http://github.com/dmattes/static-gmaps/
+
+== DESCRIPTION:
+
+Provides an interface to the Google Static Maps API.
+Original Version from John Wulff, modified by Daniel Mattes
+
+== FEATURES/PROBLEMS:
+
+* Provides an interface to the Google Static Maps API.
+
+== SYNOPSIS:
+
+  # In environment.rb or initializers you can set default values, for example
+  StaticGmaps::default_size = [ 170, 200 ]
+
+	# Get from http://code.google.com/apis/maps/signup.html
+	GOOGLE_MAPS_API_KEY = ''
+
+  map = StaticGmaps::Map.new :center   => [ 40.714728, -73.998672 ],
+                             :zoom     => 5,
+                             :size     => [ 500, 400 ],
+                             :map_type => :roadmap,
+                             :key      => GOOGLE_MAPS_API_KEY
+  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:
+
+* None.
+
+== INSTALL:
+
+* sudo gem install static-gmaps
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 John Wulff <johnwulff@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/spec/static_gmaps_spec.rb

@@ -0,0 +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 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::default_center end
+    # no default center, because of auto adjustment
+    it 'should set zoom to default'     do @map.zoom.should     == StaticGmaps::default_zoom end
+    it 'should set size to default'     do @map.size.should     == StaticGmaps::default_size end
+    it 'should set map_type to default' do @map.map_type.should == StaticGmaps::default_map_type end
+    it 'should set key to default'      do @map.key.should      == StaticGmaps::default_key end
+  end
+  
+  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
+  
+  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
+  
+  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::default_latitude end
+    it 'should set longitude to default'       do @marker.longitude.should       == StaticGmaps::default_longitude end
+    it 'should set color to default'           do @marker.color.should           == StaticGmaps::default_color end
+    it 'should set alpha_character to default' do @marker.alpha_character.should == StaticGmaps::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

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: dmattes-static-gmaps
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Daniel Mattes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+    version: 
+description: |-
+  == DESCRIPTION:  Provides an interface to the Google Static Maps API. Original Version from John Wulff, modified by Daniel Mattes
+    == FEATURES/PROBLEMS:  * Provides an interface to the Google Static Maps API.
+email: daniel.mattes@gmx.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- readme.txt
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- readme.txt
+- Rakefile
+- lib/static_gmaps.rb
+- spec/static_gmaps_spec.rb
+has_rdoc: true
+homepage: http://github.com/dmattes/static-gmaps/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- readme.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dmattes-static-gmaps
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Provides an interface to the Google Static Maps API.
+test_files: []
+