Add useragent in login queries (#891)

* Update OAuth2 test to expect MissingTokenError

Changed the OAuth2 login test to assert that MissingTokenError is raised instead of LoginError, reflecting the expected exception from oauthlib when credentials are invalid.

* Add useragent in login query

Author: LeMyst

test/test_wbi_login.py

@@ -3,6 +3,7 @@
 import unittest
 
 import pytest
+from oauthlib.oauth2 import MissingTokenError
 
 from wikibaseintegrator import wbi_login
 from wikibaseintegrator.wbi_helpers import mediawiki_api_call_helper
@@ -61,7 +62,7 @@ def test_oauth1_access():
 
 
 def test_oauth2():
-    with unittest.TestCase().assertRaises(LoginError):
+    with pytest.raises((MissingTokenError, LoginError)):
         login = wbi_login.OAuth2(consumer_token='wrong', consumer_secret='wrong')
         login.generate_edit_credentials()
 

wikibaseintegrator/datatypes/string.py

@@ -24,7 +24,7 @@ def set_value(self, value: Optional[str] = None):
         assert isinstance(value, str) or value is None, f"Expected str, found {type(value)} ({value})"
 
         if value and ('\n' in value or '\r' in value):
-            raise ValueError("String value must not contain new ine character")
+            raise ValueError("String value must not contain new line character")
 
         if value:
             self.mainsnak.datavalue = {

wikibaseintegrator/wbi_login.py

@@ -211,6 +211,7 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
         """
 
         mediawiki_api_url = str(mediawiki_api_url or config['MEDIAWIKI_API_URL'])
+        user_agent = user_agent or (str(config['USER_AGENT']) if config['USER_AGENT'] is not None else None)
         session = Session()
 
         params_login = {
@@ -220,8 +221,12 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
             'format': 'json'
         }
 
+        headers = {
+            'User-Agent': get_user_agent(user_agent)
+        }
+
         # get login token
-        login_token = session.post(mediawiki_api_url, data=params_login).json()['query']['tokens']['logintoken']
+        login_token = session.post(mediawiki_api_url, data=params_login, headers=headers).json()['query']['tokens']['logintoken']
 
         params = {
             'action': 'login',
@@ -231,7 +236,7 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
             'format': 'json'
         }
 
-        login_result = session.post(mediawiki_api_url, data=params).json()
+        login_result = session.post(mediawiki_api_url, data=params, headers=headers).json()
 
         if 'login' in login_result and login_result['login']['result'] == 'Success':
             log.info("Successfully logged in as %s", login_result['login']['lgusername'])
@@ -260,6 +265,7 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
         """
 
         mediawiki_api_url = str(mediawiki_api_url or config['MEDIAWIKI_API_URL'])
+        user_agent = user_agent or (str(config['USER_AGENT']) if config['USER_AGENT'] is not None else None)
         session = Session()
 
         params_login = {
@@ -269,8 +275,12 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
             'format': 'json'
         }
 
+        headers = {
+            'User-Agent': get_user_agent(user_agent)
+        }
+
         # get login token
-        login_token = session.post(mediawiki_api_url, data=params_login).json()['query']['tokens']['logintoken']
+        login_token = session.post(mediawiki_api_url, data=params_login, headers=headers).json()['query']['tokens']['logintoken']
 
         params = {
             'action': 'clientlogin',
@@ -281,7 +291,7 @@ def __init__(self, user: Optional[str] = None, password: Optional[str] = None, m
             'format': 'json'
         }
 
-        login_result = session.post(mediawiki_api_url, data=params).json()
+        login_result = session.post(mediawiki_api_url, data=params, headers=headers).json()
 
         log.debug(login_result)