googlestaticmap 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c66d6cc90b1b8cbb408d7a861a9fabf014ddeaf
-  data.tar.gz: 90bb8443774c7d043c93b427422116b91944a3eb
+  metadata.gz: ad36a4237b16d0a78f5275fef2732de1fa38c8d3
+  data.tar.gz: 76f929f6ea26f88b05628e85fb5059baca039a5d
 SHA512:
-  metadata.gz: 3757500c3b674623028915da6cd3c6ee10d492f84737bb9074091ec3dcb8af8fe62fa4d12d26078ab16efe04867d145ceb2583c14e05f6519dfa2d90e96b489c
-  data.tar.gz: 7d8fc8956939a7892a9ea93c66cbe354ec048f20046b3749c20caa44a7c0f903593d79fca3b0e8a42827e59893833517d549e99f9ce61ee514aab8861c818691
+  metadata.gz: b21ce6e938e92acf3dff7bd4c481d7830aea9450eb143193356cec28964bde44e15d42295335399ca08039c00174897aacd09d0051aacb0720c4d479aaae6a98
+  data.tar.gz: 6b1304bf3165f499139823589681a35c67ef79e76a78411b7edf6551c4e3a54affa2d5e1995e9fba096588b5a36cddf4aad6491c91d4081a6dbb17048f0de0c2

data/History.txt

@@ -1,3 +1,6 @@
+== 1.2.3 / 2017-01-12
+* Signature is now sent when using an API key (thanks mauu-alpha!)
+
 == 1.2.2 / 2014-03-08
 * Added channel parameter for tracking (thanks dfenniak!)
 

data/README.md

@@ -27,6 +27,10 @@ this URL as the src of an img element on an HTML page
     map = GoogleStaticMap.new(: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:
+
+    image_url = map.url('http')
+    
 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
@@ -74,7 +78,7 @@ You can also specify a channel for better tracking if you are a Maps For Busines
 
 ## 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.
+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.
 
 ## Author
 

data/lib/googlestaticmap.rb

@@ -64,14 +64,19 @@ 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
+  # API Key - see https://developers.google.com/maps/documentation/static-maps/get-api-key#key for details
+  # Note that if this is set, you cannot provide a client ID
   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
+  # ClientId for business customers -
+  # see https://developers.google.com/maps/documentation/static-maps/get-api-key#key for details
+  # Note that if this is set, you cannot provide an API key.
   attr_accessor :client_id
+
+  # The private key, also known as the URL signing secret, is used to to generate the signature parameter
+  # in the URL. This is required if you are using a client ID, or a premium API key, and is optional
+  # if you are using a standard API key.  See 
+  # https://developers.google.com/maps/documentation/static-maps/get-api-key for more details
   attr_accessor :private_key
 
   # Channel - identifier channel for tracking API source in enterprise tools
@@ -100,6 +105,12 @@ class GoogleStaticMap
     unless @center || @markers.length > 0 || @paths.length > 0
       raise Exception.new("Need to specify either a center, markers, 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")
+    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 = protocol == :auto ? '' : protocol + ":"
@@ -115,9 +126,9 @@ class GoogleStaticMap
     @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?
+    attrs << ["client", @client_id] if !@client_id.nil?
     path << attrs.sort_by {|k,v| k}.collect {|attr| "#{attr[0]}=#{attr[1]}"}.join("&")
-    if @api_key.nil? && !@client_id.nil? && !@private_key.nil?
+    if (!@api_key.nil? || !@client_id.nil?) && !@private_key.nil?
       signature = GoogleStaticMapHelpers.sign(path, @private_key)
       path << "&signature=" << signature
     end

data/test/tc_google_static_map.rb

@@ -119,6 +119,18 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert !u.include?("signature"), u
   end
 
+  def test_url_api_key_with_private_key
+    g = default_map
+    g.api_key = "asdfapikey"
+    g.private_key = "vNIXE0xscrmjlyV-12Nj_BvUPaw="
+    u = nil
+    assert_nothing_raised { u = g.url }
+    assert_equal 9, 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"
@@ -131,15 +143,20 @@ class GoogleStaticMapTest < Test::Unit::TestCase #:nodoc: all
     assert !u.include?("key="), u
   end
 
-  def test_url_for_business_no_key
+  def test_url_for_business_no_private_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=")
+    assert_raise { u = g.url }
+  end
+
+  def test_url_for_business_with_api_key
+    g = default_map
+    g.client_id = "asdfclientid"
+    g.private_key = "vNIXE0xscrmjlyV-12Nj_BvUPaw="
+    g.api_key = "asdfapikey"
+    u = nil
+    assert_raise { u = g.url }
   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.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Brent Sowers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.3
 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
@@ -78,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Class for retrieving maps from the Google Maps Static API service