Merge pull request googlemaps#129 from rbouchez/add_channel

Fix: channel argument should always be allowed when there is a client_id

Author: stephenmcd

googlemaps/client.py

@@ -66,7 +66,7 @@ def __init__(self, key=None, client_id=None, client_secret=None,
         :param channel: (for Maps API for Work customers) When set, a channel
             parameter with this value will be added to the requests.
             This can be used for tracking purpose.
-            Can not be used with a Maps API key.
+            Can only be used with a Maps API client ID.
         :type channel: str
 
         :param timeout: Combined connect and read timeout for HTTP requests, in
@@ -112,9 +112,9 @@ def __init__(self, key=None, client_id=None, client_secret=None,
             raise ValueError("Invalid API key provided.")
 
         if channel:
-            if key:
-                raise ValueError("The channel argument can not be used with an "
-                             "API key")
+            if not client_id:
+                raise ValueError("The channel argument must be used with a "
+                                 "client ID")
             if not re.match("^[a-zA-Z0-9._-]*$", channel):
                 raise ValueError("The channel argument must be an ASCII "
                     "alphanumeric string. The period (.), underscore (_)"

test/test_client.py

@@ -217,31 +217,35 @@ def __call__(self, req):
 
         self.assertEqual(2, len(responses.calls))
 
-    def test_channel_with_api_key(self):
+    def test_channel_without_client_id(self):
         with self.assertRaises(ValueError):
             client = googlemaps.Client(key="AIzaasdf", channel="mychannel")
 
     def test_invalid_channel(self):
+        # Cf. limitations here:
+        # https://developers.google.com/maps/premium/reports
+        # /usage-reports#channels
         with self.assertRaises(ValueError):
-            client = googlemaps.Client(client_id="foo", client_secret="a2V5", channel="auieauie$? ")
-
-    @responses.activate
-    def test_channel_with_client_id(self):
-        responses.add(responses.GET,
-                      "https://maps.googleapis.com/maps/api/geocode/json",
-                      body='{"status":"OK","results":[]}',
-                      status=200,
-                      content_type="application/json")
-
-        client = googlemaps.Client(client_id="foo", client_secret="a2V5", channel="MyChannel_1")
-        client.geocode("Sesame St.")
-
-        self.assertEqual(1, len(responses.calls))
-
-        # Check ordering of parameters.
-        self.assertIn("address=Sesame+St.&channel=MyChannel_1&client=foo&signature",
-                responses.calls[0].request.url)
-        self.assertURLEqual("https://maps.googleapis.com/maps/api/geocode/json?"
-                            "address=Sesame+St.&channel=MyChannel_1&client=foo&"
-                            "signature=5s4Hw2AitGZlkipugXkjPuxhmME=",
-                            responses.calls[0].request.url)
+            client = googlemaps.Client(client_id="foo", client_secret="a2V5", 
+                                       channel="auieauie$? ")
+
+    def test_auth_url_with_channel(self):
+        client = googlemaps.Client(key="AIzaasdf", 
+                                   client_id="foo", 
+                                   client_secret="a2V5", 
+                                   channel="MyChannel_1")
+
+        # Check ordering of parameters + signature.
+        auth_url = client._generate_auth_url("/test", 
+                                             {"param": "param"}, 
+                                             accepts_clientid=True)
+        self.assertEqual(auth_url, "/test?param=param"
+                            "&channel=MyChannel_1"
+                            "&client=foo"
+                            "&signature=OH18GuQto_mEpxj99UimKskvo4k=")
+
+        # Check if added to requests to API with accepts_clientid=False
+        auth_url = client._generate_auth_url("/test", 
+                                             {"param": "param"}, 
+                                             accepts_clientid=False)
+        self.assertEqual(auth_url, "/test?param=param&key=AIzaasdf")