google_static_maps_helper 1.1.0 → 1.2.0

data/README.rdoc

@@ -2,6 +2,37 @@
 
 This gem provides a simple interface to the Google Static Maps V2 API (http://code.google.com/apis/maps/documentation/staticmaps/)
 
+
+= 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
+
+
+= The easiest way of generating a Google Static Maps URL
+
+  GoogleStaticMapsHelper.url_for do
+    marker :lng => 1, :lat => 2
+    marker :lng => 3, :lat => 4
+  end
+
+This will return the url for map with these markers. Place note that if you do use this approach you have to set key, 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:
+  Rails::Initializer.run do |config|
+    config.gem 'google_static_maps_helper', :source => 'http://gemcutter.org'
+    ...
+  end
+
+
+= A bit more "low-level" approach instantiating objects yourself
+
 == Marker
 A marker object is, not surprisingly, representing a marker in the Google static map. It is pushed into the Map object and is used
 to generate the URL for the static map. Markers which are of the same "type" (same color, label and size) are grouped together in the generated URL
@@ -45,9 +76,16 @@ Another thing you might want to do is to override the center point and zoom leve
                                         :center => '1,2',
                                         :zoom => 4)
 
+
+
 == Paths
 Paths are not yet supported.
 
+
+== TODO
+* Paths
+* Ruby 1.9 support
+
 == Copyright
 
 Copyright (c) 2009 Thorbjørn Hermansen. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

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.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thorbj\303\270rn Hermansen"]
-  s.date = %q{2009-10-13}
+  s.date = %q{2009-10-14}
   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 = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/google_static_maps_helper.rb",
      "lib/google_static_maps_helper/map.rb",
      "lib/google_static_maps_helper/marker.rb",
+     "spec/google_static_maps_helper_spec.rb",
      "spec/map_spec.rb",
      "spec/marker_spec.rb",
      "spec/spec_helper.rb"
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/spec_helper.rb",
      "spec/marker_spec.rb",
+     "spec/google_static_maps_helper_spec.rb",
      "spec/map_spec.rb"
   ]
 

data/lib/google_static_maps_helper.rb

@@ -8,4 +8,14 @@ module GoogleStaticMapsHelper
   class OptionMissing < ArgumentError; end # Raised when required options is not sent in during construction
   class OptionNotExist < ArgumentError; end # Raised when incoming options include keys which is invalid
   class BuildDataMissing < Exception; end # Raised when incoming options include keys which is invalid
+
+  class << self
+    attr_accessor :key, :size, :sensor
+
+    def url_for(map_options = {}, &block)
+      map = Map.new({:key => key, :size => size, :sensor => sensor}.merge(map_options))
+      block.arity < 1 ? map.instance_eval(&block) : block.call(map)
+      map.url
+    end
+  end
 end

data/lib/google_static_maps_helper/map.rb

@@ -68,6 +68,11 @@ module GoogleStaticMapsHelper
       @markers.length
     end
 
+    def marker(*args)
+      marker = Marker.new(*args)
+      self << marker
+    end
+
 
     private
     def can_build?

data/lib/google_static_maps_helper/marker.rb

@@ -44,9 +44,9 @@ module GoogleStaticMapsHelper
     # Returns a string wich is what Google Static map is using to
     # set the style on the marker. This ill include color, size and label
     def options_to_url_params
-      params = DEFAULT_OPTIONS.keys.inject([]) do |params, attr|
+      params = DEFAULT_OPTIONS.keys.map(&:to_s).sort.inject([]) do |params, attr|
         value = send(attr)
-        params << "#{attr}:#{value}" if value
+        params << "#{attr}:#{URI.escape(value)}" if value
         params
       end
 

data/spec/google_static_maps_helper_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+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
+
+      it "should have a responding method" do
+        GoogleStaticMapsHelper.respond_to?(:url_for).should be_true
+      end
+
+      it "should be possible to add markers to map through a b block" do
+        out = GoogleStaticMapsHelper.url_for do
+          marker :lat => 1, :lng => 2
+        end
+
+        out.should include('markers=color:red|size:mid|1,2')
+      end
+
+      it "should be possible to override the default map construction values" do
+        out = GoogleStaticMapsHelper.url_for(:size => '800x800') do
+          marker :lat => 1, :lng => 2
+        end
+
+        out.should include('size=800x800')
+      end
+
+      it "should be possible to use inside a class, using attributes of that class" do
+        class TestingClass
+          attr_reader :location
+
+          def initialize
+            @location = {:lat => 1, :lng => 5} 
+          end
+
+          def url
+            GoogleStaticMapsHelper.url_for do |map|
+              map.marker location
+            end
+          end
+        end
+
+        TestingClass.new.url.should include('markers=color:red|size:mid|1,5')
+      end
+    end
+  end
+end

data/spec/map_spec.rb

@@ -156,8 +156,8 @@ describe GoogleStaticMapsHelper::Map do
         ['key', 'MY_GOOGLE_KEY'],
         ['sensor', 'true'],
         ['size', '400x600'],
-        ['markers', 'size:mid|color:green|6,5'],
-        ['markers', 'size:mid|color:red|2,1']
+        ['markers', 'color:green|size:mid|6,5'],
+        ['markers', 'color:red|size:mid|2,1']
       ].each do |pair|
         key, value = pair
         it "should have key: #{key} and value: #{value}" do
@@ -178,8 +178,8 @@ describe GoogleStaticMapsHelper::Map do
         ['key', 'MY_GOOGLE_KEY'],
         ['sensor', 'true'],
         ['size', '400x600'],
-        ['markers', 'size:mid|color:green|6,5|8,7'],
-        ['markers', 'size:mid|color:red|2,1|4,3']
+        ['markers', 'color:green|size:mid|6,5|8,7'],
+        ['markers', 'color:red|size:mid|2,1|4,3']
       ].each do |pair|
         key, value = pair
         it "should have key: #{key} and value: #{value}" do
@@ -188,4 +188,10 @@ describe GoogleStaticMapsHelper::Map do
       end
     end
   end
+  
+  it "should provide a helper method named marker which will create a new marker and add it to the map" do
+    map = GoogleStaticMapsHelper::Map.new(@@require_options)
+    map.marker(:lat => 1, :lng => 2)
+    map.length.should eql(1)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: google_static_maps_helper
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Thorbj\xC3\xB8rn Hermansen"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-13 00:00:00 +02:00
+date: 2009-10-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,7 @@ files:
 - lib/google_static_maps_helper.rb
 - lib/google_static_maps_helper/map.rb
 - lib/google_static_maps_helper/marker.rb
+- spec/google_static_maps_helper_spec.rb
 - spec/map_spec.rb
 - spec/marker_spec.rb
 - spec/spec_helper.rb
@@ -76,4 +77,5 @@ summary: This gem provides a simple interface to the Google Static Maps V2 API
 test_files: 
 - spec/spec_helper.rb
 - spec/marker_spec.rb
+- spec/google_static_maps_helper_spec.rb
 - spec/map_spec.rb