googlestaticmap 1.1.0 → 1.1.2

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.1.2 / 2012-04-27
+* Fixed bug from 1.1.1 when specifying https when calling get_map (thanks aduncan for catching it!)
+
+=== 1.1.1 / 2012-04-22
+* Added support for specifying the protocol to use (thanks andruby!)
+
 === 1.1.0 / 2011-10-18
 * Added an option to make requests through a proxy server (thanks bardsley!)
 

data/README

@@ -1,6 +1,6 @@
 = googlestaticmap gem
 
-This gem is on Gemcutter, simply type "gem install googlestaticmap" to install it.
+This gem is on Rubygems, simply type "gem install googlestaticmap" to install it.
 
 Available on github at http://github.com/brentsowers1/googlestaticmap
 
@@ -14,14 +14,20 @@ 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
+(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.
+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"))
@@ -51,4 +57,4 @@ 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://rails.brentsowers.com/2010/08/gem-for-getting-google-static-maps.html
+http://www.brentsowers.com/2010/08/gem-for-getting-google-static-maps.html

data/lib/googlestaticmap.rb

@@ -1,6 +1,6 @@
 # = googlestaticmap gem
 #
-# This gem is on Gemcutter, simply type "gem install googlestaticmap" to install it.
+# This gem is on Rubygems, simply type "gem install googlestaticmap" to install it.
 #
 # Available on github at http://github.com/brentsowers1/googlestaticmap
 #
@@ -18,6 +18,12 @@
 #   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.
@@ -45,6 +51,9 @@
 #
 # 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
 
 require 'cgi'
 require 'net/http'
@@ -119,11 +128,18 @@ 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..."
-  def url
+  # +protocol+ can be 'http', 'https' or :auto. Specifying :auto will not return
+  #   a protocol in the URL ("//maps.google.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")
     end
-    u = "http://maps.google.com/maps/api/staticmap?"
+    protocol = 'http' unless protocol == 'http' || protocol == 'https' ||
+                             protocol == :auto
+    protocol = protocol == :auto ? '' : protocol + ":"
+    u = "#{protocol}//maps.google.com/maps/api/staticmap?"
     attrs = GoogleStaticMapHelpers.safe_instance_variables(self,
               ["markers", "paths", "width", "height", "center",
                "proxy_address", "proxy_port"],
@@ -137,16 +153,26 @@ class GoogleStaticMap
 
   # Returns the URL to retrieve the map, relative to http://maps.google.com
   # Example - "/maps/api/staticmap?params..."
-  def relative_url
-    url.gsub(/http\:\/\/maps\.google\.com/, "")
+  def relative_url(protocol='http')
+    url(protocol).gsub(/[^\/]*\/\/maps\.google\.com/, "")
   end
 
+
   # Connects to Google, retrieves the map, and returns the bytes for the image.
   # Optionally, pass it an output name and the contents will get written to
   # this file name
-  def get_map(output_file=nil)
-    http = Net::HTTP.Proxy(@proxy_address,@proxy_port).new("maps.google.com", 80)
-    resp, data = http.get2(relative_url)
+  # +output_file+ - optionally give the name of a file to write the output to.
+  #                 Pass nil to not write the output to a file
+  # +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'
+    port = protocol == 'https' ? 443 : 80
+    http = Net::HTTP.Proxy(@proxy_address,@proxy_port).new("maps.google.com", port)
+    http.use_ssl = protocol == 'https'
+
+    resp, data = http.get2(relative_url(protocol))
     if resp && resp.is_a?(Net::HTTPSuccess)
       if output_file
         File.open(output_file, "wb") {|f| f << data }

data/test/tc_google_static_map.rb

@@ -24,6 +24,9 @@ end
 class MockHttp #:nodoc: all
   def initialize
   end
+  def use_ssl=(value)
+    true
+  end
 end
 
 class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
@@ -68,9 +71,32 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert !f.include?("http://maps.google.com")
   end
 
-  def test_get_map_success_no_file
+  def test_url_auto
+    g = default_map
+    u = nil
+    assert_nothing_raised { u = g.url(:auto) }
+    assert_equal 7, u.split("&").length, u
+    assert u =~ /^\/\/maps.google.com/, u
+    f = nil
+    assert_nothing_raised {f = g.relative_url}
+    assert_no_match /^\/\/maps.google.com/, f
+  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 u =~ /^https:\/\/maps.google.com/
+    f = nil
+    assert_nothing_raised {f = g.relative_url}
+    assert_no_match /^https:\/\/maps.google.com/, f
+  end
+
+  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)
     Net::HTTP.expects(:new).returns(MockHttp.new)
 
     g = default_map
@@ -79,6 +105,18 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert_equal r, test_data
   end
 
+  def test_get_map_success_no_file_https
+    test_data = "asdf"
+    MockHttp.any_instance.expects(:get2).returns([MockSuccess.new,test_data])
+    MockHttp.any_instance.expects(:"use_ssl=").with(true).returns(true)
+    Net::HTTP.expects(:new).returns(MockHttp.new)
+
+    g = default_map
+    r = nil
+    assert_nothing_raised {r = g.get_map(nil, 'https')}
+    assert_equal r, test_data
+  end
+
   def test_get_map_success_write_file
     test_data = "asdf"
     MockHttp.any_instance.expects(:get2).returns([MockSuccess.new,test_data])
@@ -97,6 +135,24 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert_equal file_data, test_data
   end
 
+  def test_get_map_success_check_url
+    test_data = "asdf"
+    MockHttp.any_instance.expects(:get2).returns([MockSuccess.new,test_data])
+    Net::HTTP.expects(:new).returns(MockHttp.new)
+    file_data = ""
+    file_name = "testdata.png"
+    # File.open should be called, with the name of the file and write binary
+    # passed in.  The object passed to the yield should be a file object that
+    # gets the test data appended to it.  If we sub out a string for the
+    # file object we can later check the contents
+    File.expects(:open).with(file_name, "wb").yields(file_data)
+    g = default_map
+    r = nil
+    assert_nothing_raised {r = g.get_map(file_name)}
+    assert_equal r, test_data
+    assert_equal file_data, test_data
+  end
+
 
   def test_get_map_failure
     MockHttp.any_instance.expects(:get2).returns([MockFailure.new,""])

metadata

@@ -2,7 +2,7 @@
 name: googlestaticmap
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors: 
 - Brent Sowers
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-18 00:00:00 Z
+date: 2012-04-27 00:00:00 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 set the attributes you want for your map and GoogleStaticMap will take care of getting the map for you, or giving your the URL to retrieve the map.