gmapper 0.1.0 → 0.2.0

data/Manifest

@@ -1,8 +1,14 @@
 README.rdoc
 Rakefile
-gmapper.gemspec
+lib/autoload.rb
+lib/exceptions.rb
 lib/gmapper.rb
-lib/google/autoload.rb
+lib/google/maps/static/items/base.rb
 lib/google/maps/static/map.rb
-lib/google/maps/static/marker.rb
+lib/google/maps/static/markers.rb
+lib/google/maps/static/path.rb
+lib/google/maps/static/visible.rb
+spec/gmapper/map_spec.rb
+spec/matchers.rb
+spec/spec_helper.rb
 Manifest

data/README.rdoc

@@ -1,6 +1,6 @@
 = GMapper
 
-A version agnostic library for the Google Maps API.
+A (mostly) version agnostic, dependency free Ruby library for the Google Maps API.
 
 Currently only supports Google Static Maps.
 
@@ -10,11 +10,6 @@ Currently only supports Google Static Maps.
   gem install gmapper
 
 
-== Dependancies
-
-  active_support/inflector
-
-
 == Usage
 
 To create a map of a location, say the Googleplex:
@@ -23,7 +18,7 @@ To create a map of a location, say the Googleplex:
 
 Then, lets say we want to add a marker to point out where it is:
 
-  map.markers << Google::Maps::Static::Marker.new [37.422, 122.084], :color => :blue, :label => 'G'
+  map << Google::Maps::Static::Marker.new([37.422, 122.084], :color => :blue, :label => 'G')
 
 To save the map to your local disk:
 
@@ -32,8 +27,7 @@ To save the map to your local disk:
 
 == Todo
 
-* I still need to add some tests
-* There are a few other API's that I have to refactor before I add
+* There are a few other classes that I have to refactor before I add
 
 
 == Lisence

data/Rakefile

@@ -1,14 +1,35 @@
 require 'rubygems'
 require 'rake'
+require 'rake/rdoctask'
 require 'echoe'
+require 'spec/rake/spectask'
 
-Echoe.new( 'gmapper', '0.1.0' ) do |p|
-  p.description     = "A version agnostic library for the Google Maps API."
-  p.url             = "http://github.com/tpeden/gmapper"
+Echoe.new( 'gmapper', '0.2.0' ) do |p|
   p.author          = "TJ Peden"
   p.email           = "tj.peden@tj-coding.com"
+  p.summary         = "A version agnostic, dependency free Ruby library for the Google Maps API."
+  p.description     = <<-EOS
+A (mostly) version agnostic, dependency free Ruby library for the Google Maps API.
+
+Currently only supports Google Static Maps.
+EOS
+  p.url             = "http://github.com/tpeden/gmapper"
   p.ignore_pattern  = ["tmp/*", "script/*"]
   p.development_dependencies = []
 end
 
+Spec::Rake::SpecTask.new(:html) do |t|
+  t.warning = true
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(--format html:doc/reports/tools/failing_examples.html)
+  t.fail_on_error = false
+end
+
+Spec::Rake::SpecTask.new(:nested) do |t|
+  # t.warning = true
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w{--backtrace --format nested --color}
+  t.fail_on_error = false
+end
+
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/gmapper.gemspec

@@ -2,21 +2,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gmapper}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Peden"]
-  s.date = %q{2010-09-01}
-  s.description = %q{A version agnostic library for the Google Maps API.}
+  s.date = %q{2010-09-02}
+  s.description = %q{A (mostly) version agnostic, dependency free Ruby library for the Google Maps API.
+
+Currently only supports Google Static Maps.
+}
   s.email = %q{tj.peden@tj-coding.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/gmapper.rb", "lib/google/autoload.rb", "lib/google/maps/static/map.rb", "lib/google/maps/static/marker.rb"]
-  s.files = ["README.rdoc", "Rakefile", "gmapper.gemspec", "lib/gmapper.rb", "lib/google/autoload.rb", "lib/google/maps/static/map.rb", "lib/google/maps/static/marker.rb", "Manifest"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/autoload.rb", "lib/exceptions.rb", "lib/gmapper.rb", "lib/google/maps/static/items/base.rb", "lib/google/maps/static/map.rb", "lib/google/maps/static/markers.rb", "lib/google/maps/static/path.rb", "lib/google/maps/static/visible.rb"]
+  s.files = ["README.rdoc", "Rakefile", "lib/autoload.rb", "lib/exceptions.rb", "lib/gmapper.rb", "lib/google/maps/static/items/base.rb", "lib/google/maps/static/map.rb", "lib/google/maps/static/markers.rb", "lib/google/maps/static/path.rb", "lib/google/maps/static/visible.rb", "spec/gmapper/map_spec.rb", "spec/matchers.rb", "spec/spec_helper.rb", "Manifest", "gmapper.gemspec"]
   s.homepage = %q{http://github.com/tpeden/gmapper}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gmapper", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{gmapper}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A version agnostic library for the Google Maps API.}
+  s.summary = %q{A version agnostic, dependency free Ruby library for the Google Maps API.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/autoload.rb

@@ -0,0 +1,26 @@
+module GMapper
+  
+  module Autoload
+    
+    def autoload( const_name, path = nil )
+      full_name = [self.name, const_name.to_s, path].compact.join('::')
+      location = path || underscore( full_name )
+      
+      super const_name, location
+    end
+    
+    # I take no credit for this, it's obviously ActiveSupport
+    # code, just don't need the depenancy
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+    
+  end
+  
+end

data/lib/exceptions.rb

@@ -0,0 +1,5 @@
+module GMapper
+  
+  class Error < StandardError; end
+  
+end

data/lib/gmapper.rb

@@ -1,6 +1,7 @@
 require 'uri'
 require 'net/http'
-require 'google/autoload'
+require 'autoload'
+require 'exceptions'
 
 unless [].respond_to? :extract_options!
   class Array
@@ -15,13 +16,22 @@ module Google
   module Maps
     
     module Static
-      extend Google::Autoload
+      extend GMapper::Autoload
       
       autoload :Map
-      autoload :Marker
+      autoload :Markers
+      autoload :Path
+      autoload :Visible
+      
+      module Items
+        extend GMapper::Autoload # Again?
+        
+        autoload :Base
+        
+      end
       
     end # => Static
     
   end # => Maps
   
-end # => Static
+end # => Google

data/lib/google/maps/static/items/base.rb

@@ -0,0 +1,41 @@
+module Google
+  
+  module Maps
+      
+    module Static
+      
+      module Items
+        
+        class Base
+          
+          def initialize *args
+            @options = args.extract_options!
+            
+            raise GMapper::Error, "One or more locations is required for the feature." if args.empty?
+            @locations = args
+            @item = self.class.name.split('::').last.downcase
+          end
+          
+          def to_s
+            raise GMapper::Error, "@item cannot be nil!" if @item.nil?
+            
+            result = @options.map do |key, value|
+              "#{key.to_s}:#{value.to_s}|"
+            end.join
+            
+            result += @locations.map do |loc|
+              loc.is_a?(Array) ? loc.join(',') : loc.to_s
+            end.join('|')
+            
+            "#{@item}=#{result}"
+          end
+          
+        end # => Google::Maps::Static::Items::Base
+          
+      end # => Google::Maps::Static::Items
+        
+    end # => Google::Maps::Static
+      
+  end # => Google::Maps
+    
+end # => Google

data/lib/google/maps/static/map.rb

@@ -5,24 +5,56 @@ module Google
     module Static
       
       class Map
-        attr_reader :markers
-        
         def initialize *args
           @base = "http://maps.google.com/maps/api/staticmap"
           
-          @options = args.extract_options!
-          @options[:sensor] = false unless @options.key?(:sensor)
+          @options = {
+            # :zoom   => 12,
+            :size   => [400, 400],
+            :sensor => false
+          }
+          @options.merge! args.extract_options!
           
-          @markers = []
+          @items = args.select { |item| item.is_a?(Items::Base) }.map(&:to_s)
+        end
+        
+        def []= key, value
+          @options[key] = value
+          @url = nil if @url # Object has become dirty, url should be regenerated
         end
         
+        def << item
+          raise GMapper::Error, "Please only use Items::Base decendants." unless item.is_a?(Items::Base)
+          @items << item.to_s
+          @url = nil if @url # Object has become dirty, url should be regenerated
+        end
+        alias_method :add_item, :<<
+        
         def save file
-          response = ::Net::HTTP.get( ::URI.parse( url ) )
+          response = ::Net::HTTP.get( ::URI.parse( url._encode ) )
           File.open( file, 'wb' ) { |f| f.write response }
         end
         
         def url
-          @url ||= "#{@base}?#{parameters}"
+          unless @options.key?(:center) || !@items.empty?
+            raise GMapper::Error, "Must specify the center location unless you add one or more map items."
+          end
+          
+          unless @options.key?(:zoom) || !@items.empty?
+            raise GMapper::Error, "Must specify the zoom level unless you add one or more map items."
+          end
+          
+          if @url.nil?
+            url = "#{@base}?#{parameters}"
+            
+            def url._encode
+              gsub(/\|/, '%7C')
+            end
+            
+            @url = url
+          end
+          
+          @url
         end
         alias_method :to_s, :url
         
@@ -37,10 +69,12 @@ module Google
               else object.to_s
               end
               
-              "#{::URI.escape( key.to_s )}=#{::URI.escape( value )}"
+              "#{key.to_s}=#{value}"
             end.join('&')
             
-            result += '&' + @markers.map(&:to_s).join('&') unless @markers.empty?
+            result += '&' + @items.join('&') unless @items.empty?
+            
+            result.gsub!(/\s/, '+')
             
             result
           end

data/lib/google/maps/static/markers.rb

@@ -0,0 +1,13 @@
+module Google
+  
+  module Maps
+    
+    module Static
+      
+      class Markers < Items::Base; end
+      
+    end # => Google::Maps::Static
+    
+  end # => Google::Maps
+  
+end # => Google

data/lib/google/maps/static/path.rb

@@ -0,0 +1,13 @@
+module Google
+  
+  module Maps
+    
+    module Static
+      
+      class Path < Items::Base; end
+      
+    end # => Google::Maps::Static
+    
+  end # => Google::Maps
+  
+end # => Google

data/lib/google/maps/static/visible.rb

@@ -0,0 +1,13 @@
+module Google
+  
+  module Maps
+    
+    module Static
+      
+      class Visible < Items::Base; end
+      
+    end # => Google::Maps::Static
+    
+  end # => Google::Maps
+  
+end # => Google

data/spec/gmapper/map_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Google::Maps::Static::Map do
+  it "should be able to create a proper url for a given coordinates" do
+    map = Google::Maps::Static::Map.new :center => [40.714728, -73.998672], :zoom => 12
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=40.714728,-73.998672&zoom=12&size=400x400&sensor=false")
+  end
+  
+  it "should be able to create a proper url for a given city and state" do
+    options = {
+      :center => "Berkeley,CA",
+      :zoom => 14
+    }
+    
+    map = Google::Maps::Static::Map.new options
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=Berkeley,CA&zoom=14&size=400x400&sensor=false")
+  end
+  
+  it "should be able to create a proper url given a location with markers" do
+    options = {
+      :center => "Brooklyn Bridge,New York,NY",
+      :zoom => 14,
+      :size => [512, 512],
+      :maptype => :roadmap
+    }
+    
+    map = Google::Maps::Static::Map.new options
+    map << Google::Maps::Static::Markers.new( [40.702147, -74.015794], :color => :blue, :label => 'S' )
+    map << Google::Maps::Static::Markers.new( [40.711614, -74.012318], :color => :green, :label => 'G' )
+    map << Google::Maps::Static::Markers.new( [40.718217, -73.998284], :color => :red, :label => 'C' )
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=Brooklyn+Bridge,New+York,NY&zoom=14&size=512x512&maptype=roadmap&markers=color:blue|label:S|40.702147,-74.015794&markers=color:green|label:G|40.711614,-74.012318&markers=color:red|label:C|40.718217,-73.998284&sensor=false")
+  end
+  
+  it "should be able to create a proper url given a location with multiple marker of the same style" do
+    map = Google::Maps::Static::Map.new
+    map[:center] = "Williamsburg,Brooklyn,NY"
+    map[:zoom] = 13
+    map << Google::Maps::Static::Markers.new( '11211', '11206', '11222', :color => :blue, :label => 'S' )
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=Williamsburg,Brooklyn,NY&zoom=13&size=400x400&markers=color:blue|label:S|11211|11206|11222&sensor=false")
+  end
+  
+  it "should be able to create a proper url given a location with a path" do
+    locations = [ [40.737102,-73.990318], [40.749825,-73.987963], [40.752946,-73.987384], [40.755823,-73.986397] ]
+    map = Google::Maps::Static::Map.new
+    map[:size] = [512, 512]
+    map << Google::Maps::Static::Path.new( *locations, :color => '0x0000ff', :weight => 5 )
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?path=color:0x0000ff|weight:5|40.737102,-73.990318|40.749825,-73.987963|40.752946,-73.987384|40.755823,-73.986397&size=512x512&sensor=false")
+  end
+  
+  it "should be able to create a proper url given a viewport (visible)" do
+    locations = %w{77+Massachusetts+Ave,Cambridge,MA Harvard+Square,Cambridge,MA}
+    map = Google::Maps::Static::Map.new
+    map[:size] = [512, 512]
+    map << Google::Maps::Static::Visible.new( *locations )
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?visible=77+Massachusetts+Ave,Cambridge,MA|Harvard+Square,Cambridge,MA&size=512x512&sensor=false")
+  end
+  
+  it "should be able to set parameters in the Map#[]= method" do
+    map = Google::Maps::Static::Map.new
+    map[:center] = "Berkeley,CA"
+    map[:zoom] = 14
+    
+    map.url.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=Berkeley,CA&zoom=14&size=400x400&sensor=false")
+  end
+  
+  it "should be able to encode the url for use with URI#parse (in Map#save)" do
+    map = Google::Maps::Static::Map.new
+    map[:center] = "Williamsburg,Brooklyn,NY"
+    map[:zoom] = 13
+    map << Google::Maps::Static::Markers.new( '11211', '11206', '11222', :color => :blue, :label => 'S' )
+    
+    map.url._encode.should orderlessly_match("http://maps.google.com/maps/api/staticmap?center=Williamsburg,Brooklyn,NY&zoom=13&size=400x400&markers=color:blue%7Clabel:S%7C11211%7C11206%7C11222&sensor=false")
+  end
+  
+  it "should not be able to create a url without the :center parameter" do
+    map = Google::Maps::Static::Map.new
+    
+    lambda do
+      map.url
+    end.should raise_error( GMapper::Error, "Must specify the center location unless you add one or more map items." )
+  end
+end

data/spec/matchers.rb

@@ -0,0 +1,14 @@
+Spec::Matchers.define :orderlessly_match do |original_string|
+  regex = /[\?\|&]/
+  match do |given_string|
+    original_string.split(regex).sort == given_string.split(regex).sort
+  end
+
+  failure_message_for_should do |given_string|
+    "expected\n#{given_string.split(regex).sort.inspect}\nto have the same parameters as\n#{original_string.split(regex).sort.inspect}"
+  end
+
+  failure_message_for_should_not do |given_string|
+    "expected\n#{given_string.split(regex).sort.inspect}\nnot to have the same parameters as\n#{original_string.split(regex).sort.inspect}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'spec'
+require 'matchers'
+require 'gmapper'
+
+Spec::Runner.configure do |config|
+  # Nothing so far
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - TJ Peden
@@ -14,11 +14,15 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 -04:00
+date: 2010-09-02 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: A version agnostic library for the Google Maps API.
+description: |
+  A (mostly) version agnostic, dependency free Ruby library for the Google Maps API.
+  
+  Currently only supports Google Static Maps.
+
 email: tj.peden@tj-coding.com
 executables: []
 
@@ -26,19 +30,30 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- lib/autoload.rb
+- lib/exceptions.rb
 - lib/gmapper.rb
-- lib/google/autoload.rb
+- lib/google/maps/static/items/base.rb
 - lib/google/maps/static/map.rb
-- lib/google/maps/static/marker.rb
+- lib/google/maps/static/markers.rb
+- lib/google/maps/static/path.rb
+- lib/google/maps/static/visible.rb
 files: 
 - README.rdoc
 - Rakefile
-- gmapper.gemspec
+- lib/autoload.rb
+- lib/exceptions.rb
 - lib/gmapper.rb
-- lib/google/autoload.rb
+- lib/google/maps/static/items/base.rb
 - lib/google/maps/static/map.rb
-- lib/google/maps/static/marker.rb
+- lib/google/maps/static/markers.rb
+- lib/google/maps/static/path.rb
+- lib/google/maps/static/visible.rb
+- spec/gmapper/map_spec.rb
+- spec/matchers.rb
+- spec/spec_helper.rb
 - Manifest
+- gmapper.gemspec
 has_rdoc: true
 homepage: http://github.com/tpeden/gmapper
 licenses: []
@@ -76,6 +91,6 @@ rubyforge_project: gmapper
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A version agnostic library for the Google Maps API.
+summary: A version agnostic, dependency free Ruby library for the Google Maps API.
 test_files: []
 

data/lib/google/autoload.rb

@@ -1,16 +0,0 @@
-require 'active_support/inflector'
-
-module Google
-  
-  module Autoload
-    
-    def autoload( const_name, path = nil )
-      full_name = [self.name, const_name.to_s, path].compact.join('::')
-      location = path || ActiveSupport::Inflector.underscore( full_name )
-      
-      super const_name, location
-    end
-    
-  end
-  
-end

data/lib/google/maps/static/marker.rb

@@ -1,37 +0,0 @@
-module Google
-  
-  module Maps
-    
-    module Static
-      
-      class Marker
-        
-        def initialize *args
-          @options = args.extract_options!
-          
-          raise "Must specify one or more points to place markers" if args.empty?
-          
-          @locations = args
-        end
-        
-        def to_s
-          result = "markers="
-          
-          result += @options.inject('') do |output, pair|
-            output + "#{pair.first.to_s}:#{pair.last.to_s}|"
-          end
-          
-          result += @locations.map do |loc|
-            loc.is_a?(Array) ? log.join(',') : loc.to_s
-          end.join('|')
-          
-          ::URI.encode( result )
-        end
-        
-      end # => Google::Maps::Static::Marker
-      
-    end # => Google::Maps::Static
-    
-  end # => Google::Maps
-  
-end # => Google