Use get authed_url, add url_signed test

Author: marcinmilewski1

aiogmaps/client.py

@@ -1,9 +1,10 @@
 import asyncio
 import logging
+import re
 
 import aiohttp
 import googlemaps
-from googlemaps.client import urlencode_params, sign_hmac
+from googlemaps import client as gmaps_client
 from yarl import URL
 
 from . import __version__
@@ -27,7 +28,7 @@
 class Client:
     def __init__(self, key=None, client_id=None, client_secret=None,
                  session=None, close_session=False, verify_ssl=True,
-                 request_timeout=10, loop=None):
+                 request_timeout=10, channel=None, loop=None):
         if loop is None:
             loop = asyncio.get_event_loop()
 
@@ -45,6 +46,16 @@ def __init__(self, key=None, client_id=None, client_secret=None,
         self.client_secret = client_secret
         self.request_timeout = request_timeout
 
+        if channel:
+            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 (_)"
+                                 "and hyphen (-) characters are allowed.")
+        self.channel = channel
+
         self.close_session = close_session
         self.verify_ssl = verify_ssl
 
@@ -62,7 +73,7 @@ def __init__(self, key=None, client_id=None, client_secret=None,
 
         self.session = session
 
-        self.base_url = URL('https://maps.googleapis.com/')
+        self.base_url = URL('https://maps.googleapis.com')
         self._user_agent = 'AsyncGoogleGeoApiClientPython/{}'.format(
             __version__)
         self._headers = {
@@ -72,20 +83,6 @@ def __init__(self, key=None, client_id=None, client_secret=None,
     def __getitem__(self, name):
         return getattr(self, name)
 
-    def _get_params(self, path, params, accepts_clientid):
-        params = sorted(dict(params).items())
-        if self.key is not None:
-            if isinstance(params, (list, tuple)):
-                params.append(('key', self.key))
-
-        if accepts_clientid and self.client_id and self.client_secret:
-            params.append(("client", self.client_id))
-            path = "?".join([str(path), urlencode_params(params)])
-            sig = sign_hmac(self.client_secret, path)
-            params.append(("signature", sig))
-
-        return params
-
     async def _request(
         self,
         url,
@@ -106,22 +103,12 @@ async def _request(
             base_url = self.base_url
 
         base_url = URL(base_url)
-        params = self._get_params(
-            path='/' + url.lstrip('/'),
-            params=params,
-            accepts_clientid=accepts_clientid
-        )
+        authed_url = gmaps_client.Client._generate_auth_url(self, '/' + url.lstrip('/'), params, accepts_clientid)
 
         if aiohttp3:
             # https://docs.aiohttp.org/en/stable/client_reference.html#aiohttp.ClientSession.request
             kwargs.update({'ssl': self.verify_ssl})
-
-        combined_url = URL(
-            "?".join([str(base_url / url.lstrip('/')),
-                      urlencode_params(params)]),
-            encoded=True
-        )
-
+        combined_url = URL(str(base_url) + authed_url, encoded=True)
         if post_json is not None:
             method = 'POST'
             data = post_json

tests/test_client.py

@@ -0,0 +1,30 @@
+from aiohttp import web
+from googlemaps.client import sign_hmac, urlencode_params
+
+import aiogmaps
+
+
+async def test_url_signed(aresponses):
+    client_id = "foo"
+    client_secret = "test"
+    address = "Test St."
+    client = aiogmaps.Client(client_id=client_id, client_secret=client_secret)
+    params = {
+        'address': address,
+        'client': client_id
+    }
+    path = "?".join(['/maps/api/geocode/json', urlencode_params(params.items())])
+    expected_signature = sign_hmac(client_secret, path)
+    aresponses.add(
+        'maps.googleapis.com',
+        path + '{}{}'.format('&signature=', expected_signature),
+        'get',
+        aresponses.Response(
+            body='{"status": "OK", "results": ["foo"]}',
+            status=web.HTTPOk.status_code,
+            content_type='application/json',
+        ),
+        match_querystring=True,
+    )
+    resp = await client.geocode(address)
+    assert resp == ['foo']

tests/test_places.py

@@ -11,8 +11,8 @@ async def test_place(aresponses, client, api_key):
     patched_url = URL.build(
         path='/maps/api/place/details/json',
         query={
-            'key': api_key,
             'placeid': place_id,
+            'key': api_key
         },
     )
 
@@ -36,13 +36,12 @@ async def test_places(aresponses, client, api_key):
     patched_url = URL.build(
         path='/maps/api/place/textsearch/json',
         query={
-            'key': api_key,
-            'minprice': 0,
             'maxprice': 4,
+            'minprice': 0,
             'query': 'Google',
+            'key': api_key
         },
     )
-
     aresponses.add(
         'maps.googleapis.com',
         patched_url.human_repr(),
@@ -115,8 +114,8 @@ async def test_autocomplete(aresponses, client, api_key, query_type, handler):
     patched_url = URL.build(
         path=f'/maps/api/place/{query_type}autocomplete/json',
         query={
-            'key': api_key,
             'input': 'Google',
+            'key': api_key
         },
     )
 

tests/test_timezone.py

@@ -8,9 +8,9 @@ async def test_timezone(aresponses, client, api_key):
     patched_path = URL.build(
         path='/maps/api/timezone/json',
         query={
-            'key': api_key,
             'location': '{},{}'.format(*location),
             'timestamp': timestamp,
+            'key': api_key
         },
     )