googlestaticmap 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b5b6fcba846462e64275c8edcedc7e4b42d85de
-  data.tar.gz: 1d921c206a737b39936ce5668767a939e228e019
+  metadata.gz: 6dc261d1cb824be2c2acf1cc600b8d03c9332882
+  data.tar.gz: ec31683c4c3e972035b13f60d92746e4b29116ac
 SHA512:
-  metadata.gz: 3a93b1e16dc3779d1465f43ec6d79c76dcdf0ed4a51eaca0a7c5a8d35a434c944e602bbd5be6b80fab97a63e7b136d238cedcf2010bd498f003a909c8f833f56
-  data.tar.gz: f7aa37ed92164ea33e8be0437d817c3908d7250c0358dedc4b30b16dddc8986558a6998e6655a72fa105d4147a227d044087907b8177f095e4ccb61472b499f5
+  metadata.gz: 779b4a497a77ab34c9e528495b37809639fc703210f6370715aff3ef606f5492a9b6fe168ef5e9df3d800b43f8d68316b403478d92a33ffef5e734c2d0ba9526
+  data.tar.gz: 62590db99bc0e285cf2bf6efb1cbc67cc97c72cbb9726a195a1fd4b05909dd845f2f939a7dce7d9ac49f67039729e25bbddf8f331b93b7626127f628887a6eba

data/History.txt

@@ -1,3 +1,10 @@
+== 1.2.6 / 2018-12-08
+* Added the visible property to set map locations that will be visible (thanks luca!)
+* Changed default protocol to https
+* Updated example script to ask for an API key
+* Forced specification of an API key or client ID/private key, since Google now requires this
+* Updated documentation to specify that an API key or client ID/private key is required
+
 == 1.2.5 / 2018-05-07
 * Added styles, plain_string options to GoogleStaticMap (thanks anplug!)
 * Added anchor option to MapMarker (thanks anplug!)

data/README.md

@@ -11,20 +11,26 @@ URL to download the map from.  You can also call get_map to actually
 download the map from Google, return the bytes, and optionally write the
 image to a file.
 
+You must have an API key from Google for personal use, or if you have a business
+account, a client ID and private key from Google. If you do not have a key, you 
+can obtain one from https://developers.google.com/maps/documentation/javascript/get-api-key
+
 ## Examples:
 
 Get a simple static map centered at Washington, DC, with the default size
 (500 x 350), zoomed to level 11.  image will be the binary data of the map
 
     require 'googlestaticmap'
-    map = GoogleStaticMap.new(:zoom => 11, :center => MapLocation.new(:address => "Washington, DC"))
+    map = GoogleStaticMap.new(:api_key => "your API key", :zoom => 11, 
+                              :center => MapLocation.new(:address => "Washington, DC"))
     image = map.get_map
 
 Get the URL of the image described in the previous example, so you can insert
 this URL as the src of an img element on an HTML page
 
     require 'googlestaticmap'
-    map = GoogleStaticMap.new(:zoom => 11, :center => MapLocation.new(:address => "Washington, DC"))
+    map = GoogleStaticMap.new(:api_key => "your API key", :zoom => 11, 
+                              :center => MapLocation.new(:address => "Washington, DC"))
     image_url = map.url(:auto)
 
 When using the url function you can force the final url to use http or https:
@@ -37,6 +43,7 @@ size.  image will be the binary data of the map
 
     require 'googlestaticmap'
     map = GoogleStaticMap.new
+    map.api_key = "your API key"
     map.markers << MapMarker.new(:color => "blue", :location => MapLocation.new(:address => "1600 Pennsylvania Ave., Washington, DC"))
     map.markers << MapMarker.new(:color => "blue", :location => MapLocation.new(:address => "1 1st Street Northeast, Washington, DC"))
     image = map.get_map
@@ -47,7 +54,8 @@ outline solid, centered at the middle of the box, written out to the file
 map.gif:
 
     require 'googlestaticmap'
-    map = GoogleStaticMap.new(:maptype => "satellite", :format => "gif", :width => 640, :height => 480)
+    map = GoogleStaticMap.new(:api_key => "your API key", :maptype => "satellite", 
+                              :format => "gif", :width => 640, :height => 480)
     poly = MapPolygon.new(:color => "0x00FF00FF", :fillcolor => "0x00FF0060")
     poly.points << MapLocation.new(:latitude => 38.8, :longitude => -77.5)
     poly.points << MapLocation.new(:latitude => 38.8, :longitude => -76.9)
@@ -61,10 +69,6 @@ If you're working behind a proxy, create the map object this way:
 
     map = GoogleStaticMap.new(:proxy_address=>'my.proxy.host', :proxy_port=>8080, :width => 640, :height => 480)
 
-If you have a public API key for tracking usage (https://developers.google.com/maps/documentation/staticmaps/#api_key):
-
-    map = GoogleStaticMap.new(:api_key => "my_api_key")
-
 If you are a Maps For Businesses customer with a client ID and private key (https://developers.google.com/maps/documentation/business/webservices/#client_id)
 (note that you cannot set an api_key if you want to use client_id and private_key):
 
@@ -74,11 +78,13 @@ You can also specify a channel for better tracking if you are a Maps For Busines
 
     map.channel = "Tracking channel"
 
+There are many other properties on the map that you can set. See https://github.com/brentsowers1/googlestaticmap/blob/master/lib/googlestaticmap.rb for all parameters.
+
 
 
 ## Compatibility
 
-This has been tested and is working with Ruby 1.9.3, 2.0.0, 2.1.1, 2.1.10, 2.2.6, 2.3.3, 2.4.0, and the latest JRuby.
+This has been tested and is working with Ruby 1.9.3, 2.0.0, 2.1.1, 2.1.10, 2.2.6, 2.3.7, 2.4.4, 2.5.1, and the latest JRuby.
 
 ## Author
 

data/lib/googlestaticmap.rb

@@ -22,6 +22,9 @@ class GoogleStaticMap
   # An optional array of MapMarker instances
   attr_accessor :markers
 
+  # An optional array of MapLocation instances that should remain visible on the map, though no markers or other indicators will be displayed
+  attr_accessor :visible
+
   # An optional array of MapPath instances and/or MapPolygon instances to draw
   attr_accessor :paths
 
@@ -99,7 +102,7 @@ class GoogleStaticMap
 
   # Takes an optional hash of attributes
   def initialize(attrs={})
-    defaults = {:width => 500, :height => 350, :markers => [],
+    defaults = {:width => 500, :height => 350, :markers => [], :visible => [],
                 :sensor => false, :maptype => "roadmap", :paths => [],
                 :proxy_port => nil, :proxy_address => nil, :api_key => nil,
                 :client_id => nil, :private_key => nil, :language => nil}
@@ -110,34 +113,38 @@ class GoogleStaticMap
 
   # Returns the full URL to retrieve this static map.  You can use this as the
   # src for an img to display an image directly on a web page
-  # Example - "http://maps.googleapis.com/maps/api/staticmap?params..."
+  # Example - "https://maps.googleapis.com/maps/api/staticmap?params..."
   # +protocol+ can be 'http', 'https' or :auto. Specifying :auto will not return
   #   a protocol in the URL ("//maps.googleapis.com/..."), allowing the browser to
   #   select the appropriate protocol (if the page is loaded with https, it will
-  #   use https). Defaults to http
-  def url(protocol='http')
-    unless @center || @markers.length > 0 || @paths.length > 0
-      raise Exception.new("Need to specify either a center, markers, or a path")
+  #   use https). Defaults to https
+  def url(protocol='https')
+    unless @center || @markers.length > 0 || @paths.length > 0 || @visible.length > 0
+      raise Exception.new("Need to specify either a center, markers, visible points, or a path")
     end
     if !@api_key.nil? && !@client_id.nil?
-      rasise Exception.new("You cannot specify both an API key and a client ID, only specify one")
+      raise Exception.new("You cannot specify both an API key and a client ID, only specify one")
+    end
+    if @api_key.nil? && @client_id.nil?
+      raise Exception.new("You must specify either an API key, or a client ID/private key. Google requires this and the calls to Google will fail without one of these.")
     end
     if !@client_id.nil? && @private_key.nil?
       raise Exception.new("private_key must be specified if using a client ID")
     end
-    protocol = 'http' unless protocol == 'http' || protocol == 'https' ||
-                             protocol == :auto
+    protocol = 'https' unless protocol == 'http' || protocol == 'https' ||
+                              protocol == :auto
     protocol = protocol == :auto ? '' : protocol + ":"
     base = "#{protocol}//maps.googleapis.com"
     path = "/maps/api/staticmap?"
     attrs = GoogleStaticMapHelpers.safe_instance_variables(self,
-              ["markers", "paths", "width", "height", "center",
+              ["markers", "visible", "paths", "width", "height", "center",
                "proxy_address", "proxy_port", "api_key", "client_id",
                "private_key", "styles", "plain_string"],
               :cgi_escape_values => true).to_a
     attrs << ["size", "#{@width}x#{@height}"] if @width && @height
     @markers.each {|m| attrs << ["markers",m.to_s] }
     @paths.each {|p| attrs << ["path",p.to_s] }
+    attrs << ["visible", @visible.join(MAP_SEPARATOR)] if !@visible.nil? && @visible.any?
     attrs << ["center", @center.to_s] if !@center.nil?
     attrs << ["key", @api_key] if !@api_key.nil?
     attrs << ["client", @client_id] if !@client_id.nil?
@@ -151,9 +158,9 @@ class GoogleStaticMap
     base + path
   end
 
-  # Returns the URL to retrieve the map, relative to http://maps.googleapis.com
+  # Returns the URL to retrieve the map, relative to https://maps.googleapis.com
   # Example - "/maps/api/staticmap?params..."
-  def relative_url(protocol='http')
+  def relative_url(protocol='https')
     url(protocol).gsub(/[^\/]*\/\/maps\.googleapis\.com/, "")
   end
 
@@ -166,8 +173,8 @@ class GoogleStaticMap
   # +protocol+ - specify http or https here for the protocol to retrieve the
   #              map with. Defaults to http
   # return value - the binary data for the map
-  def get_map(output_file=nil, protocol='http')
-    protocol = 'http' unless protocol == 'http' || protocol == 'https'
+  def get_map(output_file=nil, protocol='https')
+    protocol = 'https' unless protocol == 'http' || protocol == 'https'
     port = protocol == 'https' ? 443 : 80
     http = Net::HTTP.Proxy(@proxy_address,@proxy_port).new("maps.googleapis.com", port)
     http.use_ssl = protocol == 'https'

data/test/tc_google_static_map.rb

@@ -56,23 +56,26 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert_equal 600, g.width
     assert_equal "hybrid", g.maptype
     assert_equal 1, g.markers.length
+    assert_equal 0, g.visible.length
   end
 
   def test_url
     g = default_map
+    g.visible = [MapLocation.new(:latitude => 43.71, :longitude => 10.41), MapLocation.new(:latitude => 44.16, :longitude => 11.62)]
     u = nil
     assert_nothing_raised { u = g.url }
-    assert_equal 7, u.split("&").length, u
+    assert_equal 9, u.split("&").length, u
     assert u.include?("size=600x400"), "width and height did not get converted in to a size"
     assert u.include?("maptype=hybrid")
     assert u.include?("scale=2")
     assert u.include?("asdf")
-    assert u.include?("http://maps.googleapis.com")
+    assert u.include?("https://maps.googleapis.com")
     assert u.include?("color:0x00FF00FF")
     assert u.include?("fillcolor:0x00FF0060")
     assert u.include?("38.8,-77.5#{MAP_SEPARATOR}38.8,-76.9#{MAP_SEPARATOR}39.2,-76.9#{MAP_SEPARATOR}39.2,-77.5#{MAP_SEPARATOR}38.8,-77.5"), "Polygon not in URL - #{u}"
+    assert u.include?("43.71,10.41#{MAP_SEPARATOR}44.16,11.62"), "Visible locations not in URL - #{u}"
     assert u.include?("Washington%2C+DC")
-    assert !u.include?("key"), "API included when it shouldn't be"
+    assert u.include?("key=asdf")
     assert !u.include?("client"), "Client included when it shouldn't be"
 
     f = nil
@@ -90,7 +93,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     g = default_map
     u = nil
     assert_nothing_raised { u = g.url(:auto) }
-    assert_equal 7, u.split("&").length, u
+    assert_equal 8, u.split("&").length, u
     assert u =~ /^\/\/maps.googleapis.com/, u
     f = nil
     assert_nothing_raised {f = g.relative_url}
@@ -105,12 +108,11 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert g.url.include?("language=jp")
   end
 
-
   def test_url_https
     g = default_map
     u = nil
     assert_nothing_raised { u = g.url('https') }
-    assert_equal 7, u.split("&").length, u
+    assert_equal 8, u.split("&").length, u
     assert u =~ /^https:\/\/maps.googleapis.com/
     f = nil
     assert_nothing_raised {f = g.relative_url}
@@ -128,7 +130,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     u = nil
 
     assert_nothing_raised { u = g.url }
-    assert_equal 11, u.split("&").length, u
+    assert_equal 12, u.split("&").length, u
     assert !u.include?("styles"), "styles have to be convered to array of 'style'"
     assert u.include?('style=feature:road.local%7Celement:geometry%7Ccolor:0x00ff00'), u
     assert u.include?('style=feature:landscape%7Celement:geometry.fill%7Ccolor:0x000000'), u
@@ -143,7 +145,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     u = nil
 
     assert_nothing_raised { u = g.url }
-    assert_equal 9, u.split("&").length, u
+    assert_equal 10, u.split("&").length, u
     assert !u.include?("plain_string")
     assert u.include?('&style=feature:road.local%7Celement:geometry%7Ccolor:0x00ff00&style=feature:landscape%7Celement:geometry.fill%7Ccolor:0x000000')
 
@@ -175,6 +177,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
 
   def test_url_for_business
     g = default_map
+    g.api_key = nil
     g.client_id = "asdfclientid"
     g.private_key = "vNIXE0xscrmjlyV-12Nj_BvUPaw="
     u = nil
@@ -185,8 +188,16 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert !u.include?("key="), u
   end
 
+  def test_no_api_key_or_client_id
+    g = default_map
+    g.api_key = nil
+    u = nil
+    assert_raise { u = g.url }
+  end
+
   def test_url_for_business_no_private_key
     g = default_map
+    g.api_key = nil
     g.client_id = "asdfclientid"
     u = nil
     assert_raise { u = g.url }
@@ -204,7 +215,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
   def test_get_map_success_no_file_http
     test_data = "asdf"
     MockHttp.any_instance.expects(:get2).returns(MockSuccess.new(test_data))
-    MockHttp.any_instance.expects(:"use_ssl=").with(false).returns(false)
+    MockHttp.any_instance.expects(:"use_ssl=").with(true).returns(true)
     Net::HTTP.expects(:new).returns(MockHttp.new)
 
     g = default_map
@@ -294,6 +305,7 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
                         :center => MapLocation.new(:address => "Washington, DC"),
                         :paths => [poly],
                         :scale => 2,
-                        :maptype => "hybrid")
+                        :maptype => "hybrid",
+                        :api_key => "asdf")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googlestaticmap
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Brent Sowers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-21 00:00:00.000000000 Z
+date: 2018-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake