google_static_maps_helper 1.3.2 → 1.3.7

data/lib/google_static_maps_helper/location.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 module GoogleStaticMapsHelper
   #
   # Represents a location with lat and lng values.

data/lib/google_static_maps_helper/map.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 module GoogleStaticMapsHelper
   #
   # The Map keeps track of the state of which we want to build a URL for.
@@ -6,16 +7,16 @@ module GoogleStaticMapsHelper
   #
   class Map
     include Enumerable
-    
+
     MAX_WIDTH = 640
     MAX_HEIGHT = 640
 
     VALID_FORMATS = %w{png png8 png32 gif jpg jpg-basedline}
     VALID_MAP_TYPES = %w{roadmap satellite terrain hybrid}
 
-    REQUIRED_OPTIONS = [:key, :size, :sensor]
-    OPTIONAL_OPTIONS = [:center, :zoom, :format, :maptype, :mobile, :language]
-    
+    REQUIRED_OPTIONS = [:size, :sensor]
+    OPTIONAL_OPTIONS = [:key, :center, :zoom, :format, :maptype, :mobile, :language]
+
     attr_accessor *(REQUIRED_OPTIONS + OPTIONAL_OPTIONS)
     attr_accessor :width, :height
 
@@ -25,7 +26,6 @@ module GoogleStaticMapsHelper
     # <tt>:options</tt>::   The options available are the same as described in
     #                       Google's API documentation[http://code.google.com/apis/maps/documentation/staticmaps/#Usage].
     #                       In short, valid options are:
-    #                       <tt>:key</tt>::       Your Google maps API key
     #                       <tt>:size</tt>::      The size of the map. Can be a "wxh", [w,h] or {:width => x, :height => y}
     #                       <tt>:sensor</tt>::    Set to true if your application is using a sensor. See the API doc.
     #                       <tt>:center</tt>::    The center point of your map. Optional if you add markers or path to the map
@@ -35,7 +35,7 @@ module GoogleStaticMapsHelper
     #                       <tt>:mobile</tt>::    Returns map tiles better suited for mobile devices with small screens.
     #                       <tt>:language</tt>::  The language used in the map
     #
-    def initialize(options)
+    def initialize(options = {})
       inject_defaults_from_module_class_attribute!(options)
       validate_required_options(options)
       validate_options(options)
@@ -49,13 +49,13 @@ module GoogleStaticMapsHelper
     #
     def url
       raise BuildDataMissing, "We have to have markers, paths or center and zoom set when url is called!" unless can_build?
-      
+
       out = "#{API_URL}?"
 
       params = []
       (REQUIRED_OPTIONS + OPTIONAL_OPTIONS).each do |key|
         value = send(key)
-        params << "#{key}=#{URI.escape(value.to_s)}" unless value.nil?
+        params << "#{key}=#{URI::DEFAULT_PARSER.escape(value.to_s)}" unless value.nil?
       end
       out += params.join('&')
 
@@ -65,7 +65,7 @@ module GoogleStaticMapsHelper
         params << "markers=#{marker_options_as_url_params}|#{markers_locations}"
       end
       out += "&#{params.join('&')}" unless params.empty?
-      
+
       params = []
       paths.each {|path| params << path.url_params}
       out += "&#{params.join('&')}" unless params.empty?
@@ -93,13 +93,13 @@ module GoogleStaticMapsHelper
       end
     end
 
-    # 
+    #
     # Returns all the paths which this map holds
     #
     def paths
       @map_enteties.select {|e| e.is_a? Path}
     end
-    
+
     #
     # Pushes either a Marker or a Path on to the map
     #
@@ -135,7 +135,7 @@ module GoogleStaticMapsHelper
     def path(*args) # :nodoc:
       self << Path.new(*args)
     end
-    
+
     #
     # Sets the size of the map
     #
@@ -159,14 +159,14 @@ module GoogleStaticMapsHelper
         self.height = height if height
       end
     end
-    
+
     #
     # Returns size as a string, "wxh"
     #
     def size
       [@width, @height].join('x')
     end
-    
+
     #
     # Defines width and height setter methods
     #
@@ -202,6 +202,26 @@ module GoogleStaticMapsHelper
       raise UnsupportedMaptype unless VALID_MAP_TYPES.include? @maptype
     end
 
+    #
+    # Google static maps does no longer use key when a map is requested,
+    # thus this is deprecated.
+    #
+    def key=(key)# :nodoc:
+      warn "[DEPRECATION] 'key' is deprecated. Key is no longer used when require a static map. Key will be removed from this gem soon!"
+      @key = key
+    end
+
+    #
+    # Just a setter method for key which sets it without warning
+    # to be called from rspec so all tests still passes without
+    # warnings.
+    #
+    # It's just a couple of places we still test that key is working
+    # as it should.
+    #
+    def key_without_warning=(key)# :nodoc:
+      @key = key
+    end
 
     private
     #

data/lib/google_static_maps_helper/marker.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 module GoogleStaticMapsHelper
   #
   # A marker object is representing a marker with a customizable label, color and size.
@@ -6,7 +7,9 @@ module GoogleStaticMapsHelper
     DEFAULT_OPTIONS = {
       :color => 'red',
       :size => 'mid',
-      :label => nil
+      :label => nil,
+      :icon => nil,
+      :shadow => nil
     }
 
     attr_accessor :location, *DEFAULT_OPTIONS.keys
@@ -29,7 +32,7 @@ module GoogleStaticMapsHelper
     #
     #   # Sets location via object which responds to lng and lat
     #   GoogleStaticMapsHelper::Marker.new(location {:label => :a})
-    #   
+    #
     #   # ..or include the lng and lat in the option hash
     #   GoogleStaticMapsHelper::Marker.new(:lng => 1, :lat => 2, :label => :a)
     #
@@ -41,27 +44,30 @@ module GoogleStaticMapsHelper
       options.each_pair { |k, v| send("#{k}=", v) }
     end
 
-    # 
+    #
     # Returns a string representing this marker
     # Used by the Map when building url.
     #
     def options_to_url_params # :nodoc:
       params = DEFAULT_OPTIONS.keys.map(&:to_s).sort.inject([]) do |params, attr|
-        value = send(attr)
-        params << "#{attr}:#{URI.escape(value)}" unless value.nil?
+        primary_getter = "#{attr}_to_be_used_in_param"
+        secondary_getter = attr
+
+        value = send(primary_getter) rescue send(secondary_getter)
+        params << "#{attr}:#{URI::DEFAULT_PARSER.escape(value.to_s)}" unless value.nil?
         params
       end
 
       params.join('|')
     end
 
-    # 
+    #
     # Concatenation of lat and lng value. Used when building URLs and returns them in correct order
     #
     def location_to_url # :nodoc:
       @location.to_url
     end
-    
+
     def label # :nodoc:
       @label.to_s.upcase if @label
     end
@@ -70,6 +76,10 @@ module GoogleStaticMapsHelper
       @color.downcase if @color
     end
 
+    def has_icon?
+      !!@icon
+    end
+
 
     #
     # Proxies calls to the internal object which keeps track of this marker's location.
@@ -90,5 +100,18 @@ module GoogleStaticMapsHelper
       invalid_options = options.keys - DEFAULT_OPTIONS.keys
       raise OptionNotExist, "The following options does not exist: #{invalid_options.join(', ')}" unless invalid_options.empty?
     end
+
+    # Some attributes should be nil when a marker has icon
+    [:color, :label, :size].each do |getter|
+      define_method "#{getter}_to_be_used_in_param" do
+        return nil if has_icon?
+        send(getter)
+      end
+    end
+
+    def shadow_to_be_used_in_param
+      return nil unless has_icon?
+      shadow
+    end
   end
 end

data/lib/google_static_maps_helper/path.rb

@@ -1,3 +1,4 @@
+# -*- encoding: utf-8 -*-
 module GoogleStaticMapsHelper
   #
   # A Path is used to draw things in the map, either lines or Polygons.
@@ -8,12 +9,12 @@ module GoogleStaticMapsHelper
 
     OPTIONAL_OPTIONS = [:weight, :color, :fillcolor]
 
-    attr_accessor :points, *OPTIONAL_OPTIONS
+    attr_accessor :encode_points, :points, *OPTIONAL_OPTIONS
 
     #
     # Creates a new Path which you can push points on to to make up lines or polygons
     #
-    # The following options are available, for more information see the 
+    # The following options are available, for more information see the
     # Google API documentation[http://code.google.com/apis/maps/documentation/staticmaps/#Paths].
     #
     # <tt>:weight</tt>::    The weight is the thickness of the line, defaults to 5
@@ -24,10 +25,12 @@ module GoogleStaticMapsHelper
     #                       as described in the <tt>:color</tt>. When used, the static map will automatically create
     #                       a closed shape.
     # <tt>:points</tt>::    An array of points. You can mix objects responding to lng and lat, and a Hash with lng and lat keys.
+    # <tt>:encode_points::  A flag which tells us if we should encode the points in this path or not. Defaults to <tt>true</tt>
     #
     def initialize(*args)
       @points = []
-    
+      @encode_points = true
+
       extract_options!(args)
       add_points(args)
     end
@@ -39,24 +42,24 @@ module GoogleStaticMapsHelper
     def url_params # :nodoc:
       raise BuildDataMissing, "Need at least 2 points to create a path!" unless can_build?
       out = 'path='
-     
+
       path_params = OPTIONAL_OPTIONS.inject([]) do |path_params, attribute|
         value = send(attribute)
-        path_params << "#{attribute}:#{URI.escape(value.to_s)}" unless value.nil?
+        path_params << "#{attribute}:#{URI::DEFAULT_PARSER.escape(value.to_s)}" unless value.nil?
         path_params
       end.join('|')
 
       out += "#{path_params}|" unless path_params.empty?
 
-      out += inject([]) do |point_params, point|
-        point_params << point.to_url
-      end.join('|')
+      out += encoded_url_points if encoding_points?
+      out += unencoded_url_points unless encoding_points?
+      out
     end
 
-  
+
     #
     # Sets the points of this Path.
-    # 
+    #
     # *WARNING* Using this method will clear out any points which might be set.
     #
     def points=(array)
@@ -77,6 +80,10 @@ module GoogleStaticMapsHelper
       length == 0
     end
 
+    def clear
+      @points = []
+    end
+
     #
     # Pushes a new point into the Path
     #
@@ -90,6 +97,14 @@ module GoogleStaticMapsHelper
       self
     end
 
+    #
+    # Will answer the question if we are encoding the points or not when
+    # building the image URL.
+    #
+    def encoding_points?
+      return !!@encode_points
+    end
+
 
     private
     #
@@ -100,8 +115,8 @@ module GoogleStaticMapsHelper
       return point if point.instance_of? Location
       Location.new(point)
     end
-    
-    # 
+
+    #
     # Do we have enough points to build a path?
     #
     def can_build?
@@ -116,5 +131,19 @@ module GoogleStaticMapsHelper
     def add_points(points)
       points.each {|point| self << point}
     end
+
+    def encoded_url_points
+      encoder = GMapPolylineEncoder.new
+      points_as_array = points.map { |location| [location.lat, location.lng]}
+      result = encoder.encode(points_as_array)
+
+      "enc:#{result[:points]}"
+    end
+
+    def unencoded_url_points
+      inject([]) do |point_params, point|
+        point_params << point.to_url
+      end.join('|')
+    end
   end
 end

data/lib/google_static_maps_helper/version.rb

@@ -0,0 +1,3 @@
+module GoogleStaticMapsHelper
+  VERSION = "1.3.7"
+end

metadata

@@ -1,88 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: google_static_maps_helper
-version: !ruby/object:Gem::Version 
-  version: 1.3.2
+version: !ruby/object:Gem::Version
+  version: 1.3.7
 platform: ruby
-authors: 
-- "Thorbj\xC3\xB8rn Hermansen"
+authors:
+- Thorbjørn Hermansen
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-
-date: 2009-11-01 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2020-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem provides a simple interface to the Google Static Maps V2 API.
-email: thhermansen@gmail.com
+email:
+- thhermansen@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- .gitignore
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
-- VERSION
 - changelog.txt
 - google_static_maps_helper.gemspec
 - lib/google_static_maps_helper.rb
+- lib/google_static_maps_helper/gmap_polyline_encoder.rb
 - lib/google_static_maps_helper/location.rb
 - lib/google_static_maps_helper/map.rb
 - lib/google_static_maps_helper/marker.rb
 - lib/google_static_maps_helper/path.rb
-- spec/google_static_maps_helper_spec.rb
-- spec/location_spec.rb
-- spec/map_spec.rb
-- spec/marker_spec.rb
-- spec/path_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
+- lib/google_static_maps_helper/version.rb
 homepage: http://github.com/thhermansen/google_static_maps_helper
-licenses: []
-
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/thhermansen/google_static_maps_helper
+  source_code_uri: http://github.com/thhermansen/google_static_maps_helper
+  changelog_uri: https://github.com/thhermansen/google_static_maps_helper/blob/master/changelog.txt
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 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/location_spec.rb
-- spec/map_spec.rb
-- spec/path_spec.rb
+test_files: []