ym4r 0.0.1 → 0.1.2

data/README

@@ -1,13 +1,20 @@
 =YM4R
-The goal of YM4R is to ease the use of all the Yahoo! Maps API's (including the Geocoding, Map Image, Traffic and Local Search API's) from Ruby and Rails.
+This is YM4R 0.1.2. The goal of YM4R (YM4R Maps For Ruby) is to ease the use of the Google Maps and Yahoo! Maps API's (including the Geocoding, Map Image, Traffic and Local Search API's) from Ruby and Rails.
 
 ===Operations
-At this time, only the Building Block API's (Geocoding, Map Image, Traffic and Local Search) are supported. You have to pass to the +get+ method of the module a hash whose keys are a rubyfied version of the request parameters. You get back a ruby object, with accessors that let you get the returned data in a easy way. You get an exception if not all the parameters have been passed, if the connection to the service could not be made or if the parameters you have passed are of the incorrect value.
+====Google Maps
+You can use the library to display maps easily from your rails application. Update through RJS is possible. Check out the tutorial at http://thepochisuperstarmegashow.com/2006/06/02/ym4r-georuby-spatial-adapter-demo/
 
-To know what parameters to pass to the +get+ methods and what results you should expect, you should consult the documentation for the building block API's on YahoooOooOoooOoo!'s website : http://developer.yahoo.com/maps/index.html#mapsBuildingBlocks . 
+====Yahoo Maps
+There is at the moment preliminary support for the JS-Flash Yahoo! Maps API, although it is not very polished. Check back next version!
+
+====Yahoo Maps Building Block API
+Building Block API's (Geocoding, Map Image, Traffic and Local Search) are supported. You have to pass to the +get+ method of the module a hash whose keys are a rubyfied version of the request parameters. You get back a ruby object, with accessors that let you get the returned data in a easy way. You get an exception if not all the parameters have been passed, if the connection to the service could not be made or if the parameters you have passed are of the incorrect value.
+
+To know what parameters to pass to the +get+ methods and what results you should expect, you should consult the documentation for the building block API's on Yahoo!'s website : http://developer.yahoo.com/maps/index.html#mapsBuildingBlocks . 
 
 Here are some examples and notes about using the different Building Block API's.
-====Geocoding
+=====Geocoding
 Here is an example of request:
 	require 'ym4r'
 	include Ym4r::BuildingBlock
@@ -17,7 +24,7 @@ Here is an example of request:
                                   :zip => "95014")
 +results+ is an array of Geocoding::Result objects. The API can return up to 50 results for one request. Read the documentation page of the Geocoding::Result class to know how to access the data.
 
-====Map Image
+=====Map Image
 Here is an example of request:
 	require 'ym4r'
 	include Ym4r::BuildingBlock
@@ -28,7 +35,7 @@ Here is an example of request:
                                :image_type => "png")
 +result+ is a MapImage::Result object contains the URL for the requested image. You can download this image to a file by calling +download_to+ and passing a path.
 
-====Traffic
+=====Traffic
 Here is an example of request:
 	require 'ym4r'
 	include Ym4r::BuildingBlock
@@ -39,7 +46,7 @@ Here is an example of request:
                                :include_map => true)
 +results+ is a Traffic::ResultSet object (subclass of +Array+), containing Traffic::Result objects, each containing information about one traffic incident.
 
-====Local Search 
+=====Local Search 
 Here is an example of request:
 	require 'ym4r'
 	include Ym4r::BuildingBlock
@@ -50,8 +57,17 @@ Here is an example of request:
                                    :query => "chinese")
 +results+ is a LocalSearch::ResultSet object (subclass of +Array+), containing LocalSearch::Result objects, each containing information about one hit on the Yahoo! local search.
 
+===Changes since last version
+- Addition of support for the Google Maps API
+- Addition of preliminary support for the Yahoo! Maps JS-Flash API
+
+===TODO
+- Documentation! Documentation! Documentation!
+- Tutorials
+- Finish the support for the Yahoo! Maps JS-Flash API
+
 ===Disclaimer
-This software is not endorsed in any way by Yahoo!.
+This software is not endorsed in any way by Yahoo! or Google.
 
 ===License
 YM4R is released under the MIT license.

data/lib/ym4r.rb

@@ -1,4 +1,3 @@
-require 'ym4r/building_block/geocoding'
-require 'ym4r/building_block/map_image'
-require 'ym4r/building_block/traffic'
-require 'ym4r/building_block/local_search'
+require 'ym4r/yahoo_maps'
+require 'ym4r/google_maps'
+

data/lib/ym4r/google_maps.rb

@@ -0,0 +1,7 @@
+require 'ym4r/google_maps/mapping'
+require 'ym4r/google_maps/map'
+require 'ym4r/google_maps/control'
+require 'ym4r/google_maps/overlay'
+require 'ym4r/google_maps/point'
+require 'ym4r/google_maps/api_key'
+require 'ym4r/google_maps/helper'

data/lib/ym4r/google_maps/api_key.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+
+module Ym4r
+  module GoogleMaps
+    API_KEY = YAML::load_file(File.dirname(__FILE__) + '/config/config.yml')
+  end
+end
+  
+
+    

data/lib/ym4r/google_maps/config/config.yml

@@ -0,0 +1 @@
+ABQIAAAAzMUFFnT9uH0xq39J0Y4kbhTJQa0g3IQ9GZqIMmInSLzwtGDKaBR6j135zrztfTGVOm2QlWnkaidDIQ

data/lib/ym4r/google_maps/control.rb

@@ -0,0 +1,59 @@
+require 'ym4r/google_maps/mapping'
+
+module Ym4r
+  module GoogleMaps
+    class GSmallMapControl
+      include MappingObject
+      def create
+        "new GSmallMapControl()"
+      end
+    end
+    class GLargeMapControl
+      include MappingObject
+      def create
+        "new GLargeMapControl()"
+      end
+    end
+    class GSmallZoomControl
+      include MappingObject
+      def create
+        "new GSmallZoomControl()"
+      end
+    end
+    class GScaleControl
+      include MappingObject
+      def create
+        "new GScaleControl()"
+      end
+    end
+    class GMapTypeControl
+      include MappingObject
+      def create
+        "new GMapTypeControl()"
+      end
+    end
+    class GOverviewMapControl
+      include MappingObject
+      def create
+        "new GOverviewMapControl()"
+      end
+    end
+
+    #The first argument of the constructor is oneof the following : :top_right, :top_left, :bottom_right, :bottom_left
+    class GControlPosition < Struct.new(:anchor,:offset)
+      include MappingObject
+      def create
+        js_anchor = if anchor == :top_right
+                      "G_ANCHOR_TOP_RIGHT"
+                    elsif anchor == :top_left
+                      "G_ANCHOR_TOP_LEFT"
+                    elsif anchor == :bottom_right
+                      "G_ANCHOR_BOTTOM_RIGHT"
+                    else
+                      "G_ANCHOR_BOTTOM_LEFT"
+                    end
+        "new GControlPosition(#{js_anchor},#{offset})"
+      end
+    end
+  end
+end

data/lib/ym4r/google_maps/helper.rb

@@ -0,0 +1,19 @@
+
+Ym4r::GoogleMaps::GPolyline.class_eval do
+  def self.from_georuby(line_string,color = nil,weight = nil,opacity = nil)
+    GPolyline.new(line_string.points.collect { |point| GLatLng.new([point.y,point.x])},color,weight,opacity)
+  end
+end
+
+Ym4r::GoogleMaps::GMarker.class_eval do
+  def self.from_georuby(point,options = {})
+    GMarker.new([point.y,point.x],options)
+  end
+end
+
+Ym4r::GoogleMaps::GLatLng.class_eval do
+  def self.from_georuby(point,unbounded = nil)
+    GLatLng.new([point.y,point.x],unbounded)
+  end
+end
+

data/lib/ym4r/google_maps/map.rb

@@ -0,0 +1,94 @@
+module Ym4r
+  module GoogleMaps 
+    class GMap
+      include MappingObject
+      
+      VML_NAMESPACE = "xmlns:v=\"urn:schemas-microsoft-com:vml\""
+      
+      attr_reader :container
+      
+      def initialize(container, variable = "map")
+        @container = container
+        @variable = variable
+        @init = ""
+        @global_init = ""
+      end
+
+      def header(with_vml = true)
+        a = "<script src=\"http://maps.google.com/maps?file=api&v=2&key=#{API_KEY}\" type=\"text/javascript\"></script>\n"
+        a << "<style type=\"text/css\">\n v\:* { behavior:url(#default#VML);}\n</style>" if with_vml
+        a
+      end
+
+      def header_width_height(width,height)
+        "<style type=\"text/css\">\n##{@container} { height: #{height}px;\n  width: #{width}px;\n}\n</style>"
+      end
+
+      def record_init(code)
+        @init << code
+      end
+
+      def control_init(controls = {})
+        @init << add_control(GSmallMapControl.new) if controls[:small_map]
+        @init << add_control(GLargeMapControl.new) if controls[:large_map]
+        @init << add_control(GSmallZoomControl.new) if controls[:small_zoom]
+        @init << add_control(GScaleControl.new) if controls[:scale]
+        @init << add_control(GMapTypeControl.new) if controls[:map_type]
+        @init << add_control(GOverviewMapControl.new) if controls[:overview_map]
+      end
+
+      def center_zoom_init(center, zoom)
+        if center.is_a?(GLatLng)
+          @init << set_center(center,zoom)
+        else
+          @init << set_center(GLatLng.new(center),zoom)
+        end
+      end
+
+      def record_global_init(code)
+        @global_init << code
+      end
+      
+      def icon_init(icon , variable)
+        @global_init << icon.declare(variable)
+      end
+      
+      #allow :script, :no_script and :load in the method parameter. If the :load parameter has been chose, the load_method parameter must be filled too.
+      def to_html(options = {})
+        no_load = options[:no_load]
+        load_method = options[:load_method] || "load"
+        no_script_tag = options[:no_script_tag]
+        no_declare = options[:no_declare]
+        no_global = options[:no_global]
+        
+        html = ""
+        html << "<script type=\"text/javascript\">\n" if !no_script_tag
+        html << "function addInfoWindowToMarker(marker,info){\nGEvent.addListener(marker, \"click\", function() {\nmarker.openInfoWindowHtml(info);\n});\nreturn marker;\n}\n"
+        html << "function addInfoWindowTabsToMarker(marker,info){\nGEvent.addListener(marker, \"click\", function() {\nmarker.openInfoWindowTabsHtml(info);\n});\nreturn marker;\n}\n"
+        html << @global_init
+        html << "var #{@variable};\n" if !no_declare and !no_global
+        html << "function #{load_method}() {\nif (GBrowserIsCompatible()) {\n" if !no_load
+        if !no_declare and no_global 
+          html << declare(@variable)
+        else
+          html << assign_to(@variable)
+        end
+        html << @init
+        html << "}\n}\n" if !no_load
+        html << "</script>" if !no_script_tag
+        html
+      end
+      
+      def create
+        "new GMap2(document.getElementById(\"#{@container}\"))"
+      end
+    end
+
+    module GMapType
+      G_NORMAL_MAP = Variable.new("GMapType.G_NORMAL_MAP")
+      G_SATELLITE_MAP = Variable.new("GMapType.G_SATELLITE_MAP")
+      G_HYBRID_MAP = Variable.new("GMapType.G_HYBRID_MAP")
+    end
+  end
+end
+

data/lib/ym4r/google_maps/mapping.rb

@@ -0,0 +1,70 @@
+module Ym4r
+  module GoogleMaps
+    module MappingObject
+      attr_reader :variable
+      
+      #creates javascript code for missing methods
+      def method_missing(name,*args)
+        args.collect! do |arg|
+          javascriptify_variable(arg)
+        end
+        "#{to_javascript}.#{javascriptify_method(name.to_s)}(#{args.join(",")});\n"
+      end
+
+      def javascriptify_variable(arg)
+        if arg.is_a?(MappingObject)
+          arg.to_javascript
+        elsif arg.is_a?(String)
+          "\"#{escape_javascript(arg)}\""
+        else
+          arg.to_s
+        end
+      end
+      
+      #lifted from rails
+      def escape_javascript(javascript)
+        javascript.gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" }
+      end
+      
+      #transform a ruby-type method name (like qsd_fghj) to a Yahoo! Map style one (like qsdFghj)
+      def javascriptify_method(method_name)
+        method_name.gsub(/_(\w)/){|s| $1.upcase}
+      end
+      
+      #Declare Mapping Object (Map, Tool, Marker,...) of name variable
+      def declare(variable)
+        @variable = variable
+        "var #{variable} = #{create};\n"
+      end
+      
+      def assign_to(variable)
+        @variable = variable
+        "#{variable} = #{create};\n"
+      end
+      
+      #Returns a Javascript script representing the object
+      def to_javascript
+        unless @variable.nil?
+          @variable
+        else
+          create
+        end
+      end
+      
+      #Creates a Mapping Object in Javascript
+      #To be implemented by subclasses if needed
+      def create
+      end
+    end
+
+
+    class Variable
+      include MappingObject
+        
+      def initialize(variable)
+        @variable = variable
+      end
+    end
+  end
+end
+

data/lib/ym4r/google_maps/overlay.rb

@@ -0,0 +1,125 @@
+require 'ym4r/google_maps/mapping'
+
+module Ym4r
+  module GoogleMaps
+    class GMarker
+      include MappingObject
+      attr_accessor :point, :options, :info_window, :info_window_tabs
+      #options keys can be : :icon, :clickable and :title: Defaults to G_DEFAULT_ICON, true and empty. :info_window can also be input. However in order to be taken into account, the marker has to be declared at some point
+      def initialize(point, options = {})
+        if point.is_a?(Array)
+          @point = GLatLng.new(point)
+        else
+          @point = point
+        end
+        @info_window = options.delete(:info_window)
+        @tab_info_window = options.delete(:info_window_tabs)
+        @options = options
+      end
+      def create
+        if @options.empty?
+          creation = "new GMarker(#{@point.to_javascript})"
+        else
+          options = "{"
+          options << @options.to_a.collect do |v|
+            "#{v[0].to_s} : #{javascriptify_variable(v[1])}"
+          end.join(",")
+          options << "}"
+          creation = "new GMarker(#{@point.to_javascript},#{options})"
+        end
+        if @info_window
+          "addInfoWindowToMarker(#{creation},#{javascriptify_variable(@info_window)})"
+        elsif @tab_info_window
+          "addInfoWindowTabsToMarker(#{creation},[#{@tab_info_window.collect{ |tab| tab.to_javascript}.join(",")}])"
+        else
+          creation
+        end
+      end
+    end
+    
+    class GInfoWindowTab < Struct.new(:tab,:content)
+      include MappingObject
+      def create
+        "new GInfoWindowTab(#{javascriptify_variable(tab)},#{javascriptify_variable(content)})"
+      end
+    end
+        
+    #Icon class. You can pass rubyfied versions of the attributes detailed in the Google Maps API documentation. You can initialize global icons to be used in the application by passing a icon object, along with a variable name, to GMap#icon_init. If you want to declare an icon outside this, you will need to declare it first. 
+    class GIcon
+      include MappingObject
+      DEFAULT = Variable.new("G_DEFAULT_ICON")
+      attr_accessor :options, :copy_base
+
+      #Options can contain all the attributes (in rubifiedformat) of an GIconobject (see Google's doc) + :copy_base, which indicates if the icon is copied from another one
+      def initialize(options = {})
+        @copy_base = options.delete(:copy_base)
+        @options = options
+      end
+      def create
+        if @copy_base
+          "new GIcon(#{@copy_base.to_javascript})"
+        else
+          "new GIcon()"
+        end
+      end
+      def declare(variable)
+        decl = super(variable)
+        @options.each do |key,value|
+          decl << "#{variable}.#{javascriptify_method(key.to_s)} = #{javascriptify_variable(value)};\n"
+        end
+        decl
+      end
+    end
+     
+    #A polyline. Can take an array of GLatLng or an array of 2D arrays. A method to build a polyline from a GeoRuby linestring is provided in the helper.rb file.
+    class GPolyline
+      include MappingObject
+      attr_accessor :points,:color,:weight,:opacity
+      def initialize(points,color = nil,weight = nil,opacity = nil)
+        if !points.empty? and points[0].is_a?(Array)
+          @points = points.collect { |pt| GLatLng.new(pt) }
+        else
+          @points = points
+        end
+        @color = color
+        @weight = weight
+        @opacity = opacity
+      end
+      def create
+        a = "new GPolyline([#{@points.collect{|pt| pt.to_javascript}.join(",")}]"
+        a << ",#{javascriptify_variable(@color)}" if @color
+        a << ",#{javascriptify_variable(@weight)}" if @weight
+        a << ",#{javascriptify_variable(@opacity)}" if @opacity
+        a << ")"
+      end
+      
+    end
+
+    #A basic Latitude/longitude point.
+    class GLatLng 
+      include MappingObject
+      attr_accessor :lat,:lng,:unbounded
+      
+      def initialize(latlng,unbounded = nil)
+        @lat = latlng[0]
+        @lng = latlng[1]
+        @unbounded = unbounded
+      end
+      def create
+        unless @unbounded
+          "new GLatLng(#{@lat},#{@lng})"
+        else
+          "new GLatLng(#{@lat},#{@lng},#{@unbounded})"
+        end
+      end
+    end
+    
+    class GLatLngBounds < Struct.new(:sw,:ne)
+      include MappingObject
+      def create
+        "new GLatLngBounds(#{sw},#{ne})"
+      end
+    end
+
+  end
+end