googlestaticmap 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2ebb1801c05d4809f1747c82f079cbed2b7ccc
-  data.tar.gz: 042aaceadc71f079c683b3d4cbb7fd3dc8c9db01
+  metadata.gz: 1ddc7e2e770498a9ac12d73e0d79cf954b4333c9
+  data.tar.gz: 6e9dfcd215d46cb14de2708959e0caa5fba8e194
 SHA512:
-  metadata.gz: 2d4be157dc6dd3058897e5c1b5c51fb2ec8991dd8fadfcdcc30c38141a402286f76cb540643ca085eeda6bfb309c793b1f2edc570105a96842269029f439cd12
-  data.tar.gz: 56d3a7f1461f6186321ba86e29497f883eb398017076e8202c6584d53d05b5ce2a10a7797b72ccfda692d14b7c439353da6d5ad3d07df3a6b45a172dffd31179
+  metadata.gz: 2aa7f214d79aa9c8d0b0042b5169ee964b1a34b5310e09c018c6d887af82885252a11634ec89cc71be1c1490c92228b6bf7df431887e6de85552e654bcbfc328
+  data.tar.gz: b4ec9c02c81f05483bab97f3e066e877dfcb2d73f9b83dfd3dd139a39b5a1d23377cdad69c939139da20cff40fd0576698ea666ebc7671caf94483b8cf2c8519

data/History.txt

@@ -1,3 +1,8 @@
+== 1.2.0 / 2014-03-03
+* Added support for setting an API key for monitoring, and a client ID/private key for business customers (thanks forrest!)
+* Changed to use maps.googleapis.com instead of maps.google.com (thanks nathany!)
+* Explicitly added MIT licensing
+
 == 1.1.4 / 2013-07-04
 * Properly URL encoding the URLs, caused an issue when using URI.parse on generated URLs (thanks nathany!)
 

data/README.md

@@ -0,0 +1,85 @@
+# googlestaticmap gem
+
+This gem is on Rubygems, simply type "gem install googlestaticmap" to install it.
+
+Available on github at http://github.com/brentsowers1/googlestaticmap
+
+Class for generating URLs for and downloading static maps from the Google Maps
+Static API service.  GoogleStaticMap is the main class to use, instantiate it,
+set the attributes to what you want, and call url on the instance to get the
+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.
+
+## 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"))
+    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"))
+    image_url = map.url(:auto)
+
+Get a map with blue markers at the White House and the Supreme Court, zoomed
+the closest that the map can be with both markers visible, at the default
+size.  image will be the binary data of the map
+
+    require 'googlestaticmap'
+    map = GoogleStaticMap.new
+    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
+
+Get a GIF satellite map, with a size of 640 x 480, with a
+semi transparent green box drawn around a set of 4 coordinates, with the box
+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)
+    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)
+    poly.points << MapLocation.new(:latitude => 39.2, :longitude => -76.9)
+    poly.points << MapLocation.new(:latitude => 39.2, :longitude => -77.5)
+    poly.points << MapLocation.new(:latitude => 38.8, :longitude => -77.5)
+    map.paths << poly
+    map.get_map("map.gif")
+
+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):
+
+    map = GoogleStaticMap.new(:client_id => "my_client_id", :private_key => "my_private_key")
+
+## Compatibility
+
+This has been tested and is working with Ruby 1.8.7, 1.9.3, 2.0.0, and 2.1.1, and JRuby 1.7.11.
+
+## Author
+
+Brent Sowers (mailto:brent@coordinatecommons.com)
+
+## Feedback
+
+To post comments about this gem, go to my blog posting at http://www.brentsowers.com/2010/08/gem-for-getting-google-static-maps.html. Contributions are also welcome! Fork the repo and issue a pull request, and I'll review it.
+
+## License
+
+googlestaticmap is released under the [MIT License](http://www.opensource.org/licenses/MIT). You're free to do whatever you want with this.
+
+

data/lib/googlestaticmap.rb

@@ -1,61 +1,9 @@
-# = googlestaticmap gem
-#
-# This gem is on Rubygems, simply type "gem install googlestaticmap" to install it.
-#
-# Available on github at http://github.com/brentsowers1/googlestaticmap
-#
-# Class for generating URLs for and downloading static maps from the Google Maps
-# Static API service.  GoogleStaticMap is the main class to use, instantiate it,
-# set the attributes to what you want, and call full_url on the instance to get
-# the 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.
-#
-# Examples:
-#
-# Get a simple static map centered at Washington, DC, with the default size
-# (500 x 350), zoomed to level 11
-#   map = GoogleStaticMap.new(: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"))
-#  image_url = map.url(:auto)
-#
-# Get a map with blue markers at the White House and the Supreme Court, zoomed
-# the closest that the map can be with both markers visible, at the default
-# size.
-#   map = GoogleStaticMap.new
-#   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
-#
-# Get a GIF satellite map, with a size of 640 x 480, with a
-# semi transparent green box drawn around a set of 4 coordinates, with the box
-# outline solid, centered at the middle of the box, written out to the file
-# map.gif:
-#   map = GoogleStaticMap.new(: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)
-#   poly.points << MapLocation.new(:latitude => 39.2, :longitude => -76.9)
-#   poly.points << MapLocation.new(:latitude => 39.2, :longitude => -77.5)
-#   poly.points << MapLocation.new(:latitude => 38.8, :longitude => -77.5)
-#   map.paths << poly
-#   map.get_map("map.gif")
-#
-# 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)
-#
-# Author:: Brent Sowers (mailto:brent@coordinatecommons.com)
-# License:: You're free to do whatever you want with this
-#
-# To post comments about this gem, go to my blog posting at
-# http://www.brentsowers.com/2010/08/gem-for-getting-google-static-maps.html
+# Main file for the googlestaticmap gem.  See README.md for a full desciption with examples, licensing, contact
+# info, etc.
 
 require 'cgi'
+require 'base64'
+require 'openssl'
 require 'net/http'
 require 'net/https' if RUBY_VERSION < "1.9"
 require File.dirname(__FILE__) +  '/googlestaticmap_helper'
@@ -118,11 +66,22 @@ class GoogleStaticMap
   # If proxy_address is set, set this to the port of the proxy server
   attr_accessor :proxy_port
 
+  # API Key - see https://developers.google.com/maps/documentation/staticmaps/#api_key for details
+  # Note that if this is set, the client ID and private key will be ignored if set
+  attr_accessor :api_key
+
+  # ClientId/PrivateKey for business customers -
+  # see https://developers.google.com/maps/documentation/business/webservices/auth#generating_valid_signatures for details
+  # These will be ignored if api_key is set
+  attr_accessor :client_id
+  attr_accessor :private_key
+
   # Takes an optional hash of attributes
   def initialize(attrs={})
     defaults = {:width => 500, :height => 350, :markers => [],
                 :sensor => false, :maptype => "roadmap", :paths => [],
-                :proxy_port => nil, :proxy_address => nil,}
+                :proxy_port => nil, :proxy_address => nil, :api_key => nil,
+                :client_id => nil, :private_key => nil}
 
     attributes = defaults.merge(attrs)
     attributes.each {|k,v| self.send("#{k}=".to_sym,v)}
@@ -130,9 +89,9 @@ 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.google.com/maps/api/staticmap?params..."
+  # Example - "http://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.google.com/..."), allowing the browser to
+  #   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')
@@ -142,22 +101,30 @@ class GoogleStaticMap
     protocol = 'http' unless protocol == 'http' || protocol == 'https' ||
                              protocol == :auto
     protocol = protocol == :auto ? '' : protocol + ":"
-    u = "#{protocol}//maps.google.com/maps/api/staticmap?"
+    base = "#{protocol}//maps.googleapis.com"
+    path = "/maps/api/staticmap?"
     attrs = GoogleStaticMapHelpers.safe_instance_variables(self,
               ["markers", "paths", "width", "height", "center",
-               "proxy_address", "proxy_port"],
+               "proxy_address", "proxy_port", "api_key", "client_id",
+               "private_key"],
               :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 << ["center", center.to_s] if !center.nil?
-    u << attrs.collect {|attr| "#{attr[0]}=#{attr[1]}"}.join("&")
+    @markers.each {|m| attrs << ["markers",m.to_s] }
+    @paths.each {|p| attrs << ["path",p.to_s] }
+    attrs << ["center", @center.to_s] if !@center.nil?
+    attrs << ["key", @api_key] if !@api_key.nil?
+    attrs << ["client", @client_id] if @api_key.nil? && !@client_id.nil? && !@private_key.nil?
+    path << attrs.collect {|attr| "#{attr[0]}=#{attr[1]}"}.join("&")
+    if @api_key.nil? && !@client_id.nil? && !@private_key.nil?
+      path << "&signature=" << sign(path)
+    end
+    base + path
   end
 
-  # Returns the URL to retrieve the map, relative to http://maps.google.com
+  # Returns the URL to retrieve the map, relative to http://maps.googleapis.com
   # Example - "/maps/api/staticmap?params..."
   def relative_url(protocol='http')
-    url(protocol).gsub(/[^\/]*\/\/maps\.google\.com/, "")
+    url(protocol).gsub(/[^\/]*\/\/maps\.googleapis\.com/, "")
   end
 
 
@@ -172,7 +139,7 @@ class GoogleStaticMap
   def get_map(output_file=nil, protocol='http')
     protocol = 'http' unless protocol == 'http' || protocol == 'https'
     port = protocol == 'https' ? 443 : 80
-    http = Net::HTTP.Proxy(@proxy_address,@proxy_port).new("maps.google.com", port)
+    http = Net::HTTP.Proxy(@proxy_address,@proxy_port).new("maps.googleapis.com", port)
     http.use_ssl = protocol == 'https'
 
     resp = http.get2(relative_url(protocol))
@@ -189,6 +156,25 @@ class GoogleStaticMap
       end
     end
   end
+
+  private
+
+  # signing code is grabbed from https://github.com/alexreisner/geocoder
+  def sign(path)
+    raw_private_key = url_safe_base64_decode(@private_key)
+    digest = OpenSSL::Digest.new('sha1')
+    raw_signature = OpenSSL::HMAC.digest(digest, raw_private_key, path)
+    url_safe_base64_encode(raw_signature)
+  end
+
+  def url_safe_base64_decode(base64_string)
+    Base64.decode64(base64_string.tr('-_', '+/'))
+  end
+
+  def url_safe_base64_encode(raw)
+    Base64.encode64(raw).tr('+/', '-_').strip
+  end
+
 end
 
 # Container class for a location on the map.  Set either a latitude and

data/test/tc_google_static_map.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'test/unit'
 require 'cgi'
 require 'net/http'
-require 'mocha'
+require 'mocha/setup'
 require File.dirname(__FILE__) +  '/../lib/googlestaticmap'
 
 class MockSuccess < Net::HTTPSuccess #:nodoc: all
@@ -67,13 +67,17 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert u.include?("maptype=hybrid")
     assert u.include?("scale=2")
     assert u.include?("asdf")
-    assert u.include?("http://maps.google.com")
-    assert u.include?("color:0x00FF00FF#{MAP_SEPARATOR}fillcolor:0x00FF0060#{MAP_SEPARATOR}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"
+    assert u.include?("http://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?("Washington%2C+DC")
+    assert !u.include?("key"), "API included when it shouldn't be"
+    assert !u.include?("client"), "Client included when it shouldn't be"
 
     f = nil
     assert_nothing_raised {f = g.relative_url}
-    assert !f.include?("http://maps.google.com")
+    assert !f.include?("http://maps.googleapis.com")
   end
 
   def test_url_auto
@@ -81,10 +85,10 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     u = nil
     assert_nothing_raised { u = g.url(:auto) }
     assert_equal 7, u.split("&").length, u
-    assert u =~ /^\/\/maps.google.com/, u
+    assert u =~ /^\/\/maps.googleapis.com/, u
     f = nil
     assert_nothing_raised {f = g.relative_url}
-    assert_no_match /^\/\/maps.google.com/, f
+    assert_no_match /^\/\/maps.googleapis.com/, f
   end
 
   def test_url_https
@@ -92,10 +96,44 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     u = nil
     assert_nothing_raised { u = g.url('https') }
     assert_equal 7, u.split("&").length, u
-    assert u =~ /^https:\/\/maps.google.com/
+    assert u =~ /^https:\/\/maps.googleapis.com/
     f = nil
     assert_nothing_raised {f = g.relative_url}
-    assert_no_match /^https:\/\/maps.google.com/, f
+    assert_no_match /^https:\/\/maps.googleapis.com/, f
+  end
+
+  def test_url_api_key
+    g = default_map
+    g.api_key = "asdfapikey"
+    u = nil
+    assert_nothing_raised { u = g.url }
+    assert_equal 8, u.split("&").length, u
+    assert u.include?("key=asdfapikey"), u
+    assert !u.include?("client"), u
+    assert !u.include?("signature"), u
+  end
+
+  def test_url_for_business
+    g = default_map
+    g.client_id = "asdfclientid"
+    g.private_key = "asdfprivatekey"
+    u = nil
+    assert_nothing_raised { u = g.url }
+    assert_equal 9, u.split("&").length, u
+    assert u.include?("signature="), u
+    assert u.include?("client=asdfclientid"), u
+    assert !u.include?("key="), u
+  end
+
+  def test_url_for_business_no_key
+    g = default_map
+    g.client_id = "asdfclientid"
+    u = nil
+    assert_nothing_raised { u = g.url }
+    assert_equal 7, u.split("&").length, u
+    assert !u.include?("signature=")
+    assert !u.include?("client=asdfclientid")
+    assert !u.include?("key=")
   end
 
   def test_get_map_success_no_file_http

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: googlestaticmap
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Brent Sowers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-04 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies: []
 description: Easily retrieve single PNG, GIF, or JPG map images from Google with your
   own custom markers and paths using the Static Maps API service with this gem.  Simply
@@ -18,20 +18,21 @@ email: brent@coordinatecommons.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 - History.txt
 files:
+- History.txt
+- README.md
 - lib/googlestaticmap.rb
 - lib/googlestaticmap_helper.rb
-- test/tc_map_path_and_polygon.rb
-- test/tc_map_location.rb
 - test/tc_google_static_map.rb
 - test/tc_helper.rb
+- test/tc_map_location.rb
 - test/tc_map_marker.rb
-- README
-- History.txt
+- test/tc_map_path_and_polygon.rb
 homepage: http://www.coordinatecommons.com/googlestaticmap/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -39,17 +40,17 @@ require_paths:
 - lib
 required_ruby_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'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Class for retrieving maps from the Google Maps Static API service

data/README

@@ -1,60 +0,0 @@
-= googlestaticmap gem
-
-This gem is on Rubygems, simply type "gem install googlestaticmap" to install it.
-
-Available on github at http://github.com/brentsowers1/googlestaticmap
-
-Class for generating URLs for and downloading static maps from the Google Maps
-Static API service.  GoogleStaticMap is the main class to use, instantiate it,
-set the attributes to what you want, and call url on the instance to get the
-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.
-
-== 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"))
-  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"))
-  image_url = map.url(:auto)
-
-Get a map with blue markers at the White House and the Supreme Court, zoomed
-the closest that the map can be with both markers visible, at the default
-size.  image will be the binary data of the map
-  require 'googlestaticmap'
-  map = GoogleStaticMap.new
-  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
-
-Get a GIF satellite map, with a size of 640 x 480, with a
-semi transparent green box drawn around a set of 4 coordinates, with the box
-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)
-  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)
-  poly.points << MapLocation.new(:latitude => 39.2, :longitude => -76.9)
-  poly.points << MapLocation.new(:latitude => 39.2, :longitude => -77.5)
-  poly.points << MapLocation.new(:latitude => 38.8, :longitude => -77.5)
-  map.paths << poly
-  map.get_map("map.gif")
-
-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)
-
-
-Author:: Brent Sowers (mailto:brent@coordinatecommons.com)
-License:: You're free to do whatever you want with this
-
-To post comments about this gem, go to my blog posting at
-http://www.brentsowers.com/2010/08/gem-for-getting-google-static-maps.html