Merge pull request #217 from HubSpot/feature/add_missing_param_to_get_auth_url

add missing query param

Author: alzheltkovskiy-hubspot

Diff for: hubspot/utils/oauth.py

@@ -6,19 +6,21 @@
 def get_auth_url(
     client_id: str,
     redirect_uri: str,
-    scopes: tuple = None,
-    optional_scopes: tuple = None,
-):
+    scope: tuple = None,
+    optional_scope: tuple = None,
+    state: str = None
+) -> str:
     query_params = {
         "client_id": client_id,
-        "redirect_uri": redirect_uri,
+        "redirect_uri": redirect_uri
     }
 
-    if scopes:
-        query_params["scope"] = ' '.join(scopes)
-
-    if optional_scopes:
-        query_params["optional_scope"] = ' '.join(optional_scopes)
+    if scope:
+        query_params["scope"] = " ".join(scope)
+    if optional_scope:
+        query_params["optional_scope"] = " ".join(optional_scope)
+    if state:
+        query_params.setdefault("state", state)
 
     params = urllib.parse.urlencode(
         query_params,

Diff for: tests/spec/utils/test_get_auth_url.py

@@ -13,10 +13,11 @@
 
 def test_get_auth_url__empty_scope():
     params = {
-        'client_id': DATA["client_id"],
-        'redirect_uri': DATA["redirect_uri"],
+        "client_id": DATA["client_id"],
+        "redirect_uri": DATA["redirect_uri"],
+
     }
-    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='',quote_via=urllib.parse.quote,)}"
+    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='',quote_via=urllib.parse.quote)}"
 
     result = get_auth_url(
         DATA["client_id"],
@@ -28,11 +29,11 @@ def test_get_auth_url__empty_scope():
 
 def test_get_auth_url__scope():
     params = {
-        'client_id': DATA["client_id"],
-        'redirect_uri': DATA["redirect_uri"],
-        'scope': ' '.join(DATA["scope"]),
+        "client_id": DATA["client_id"],
+        "redirect_uri": DATA["redirect_uri"],
+        "scope": " ".join(DATA["scope"]),
     }
-    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='', quote_via=urllib.parse.quote,)}"
+    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='', quote_via=urllib.parse.quote)}"
 
     result = get_auth_url(
         DATA["client_id"],
@@ -45,16 +46,38 @@ def test_get_auth_url__scope():
 
 def test_get_auth_url__optional_scope():
     params = {
-        'client_id': DATA["client_id"],
-        'redirect_uri': DATA["redirect_uri"],
-        'optional_scope': ' '.join(DATA["optional_scope"]),
+        "client_id": DATA["client_id"],
+        "redirect_uri": DATA["redirect_uri"],
+        "optional_scope": " ".join(DATA["optional_scope"]),
+    }
+    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='', quote_via=urllib.parse.quote)}"
+
+    result = get_auth_url(
+        DATA["client_id"],
+        DATA["redirect_uri"],
+        optional_scope=DATA["optional_scope"]
+    )
+
+    assert result == expected_url
+
+
+def test_get_auth_url__state():
+
+    params = {
+        "client_id": DATA["client_id"],
+        "redirect_uri": DATA["redirect_uri"],
+        "scope": " ".join(DATA["scope"]),
+        "optional_scope": " ".join(DATA["optional_scope"]),
+        "state": "test_state"
     }
-    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='', quote_via=urllib.parse.quote, )}"
+    expected_url = f"{AUTHORIZE_URL}?{urllib.parse.urlencode(params, safe='', quote_via=urllib.parse.quote)}"
 
     result = get_auth_url(
         DATA["client_id"],
         DATA["redirect_uri"],
-        optional_scopes=DATA["optional_scope"]
+        DATA["scope"],
+        DATA["optional_scope"],
+        state=params["state"]
     )
 
     assert result == expected_url