hdx-python-api 6.4.1__tar.gz → 6.4.2__tar.gz

{hdx_python_api-6.4.1 → hdx_python_api-6.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hdx-python-api
-Version: 6.4.1
+Version: 6.4.2
 Summary: HDX Python API for interacting with the Humanitarian Data Exchange
 Project-URL: Homepage, https://github.com/OCHA-DAP/hdx-python-api
 Author: Michael Rans

{hdx_python_api-6.4.1 → hdx_python_api-6.4.2}/src/hdx/api/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '6.4.1'
-__version_tuple__ = version_tuple = (6, 4, 1)
+__version__ = version = '6.4.2'
+__version_tuple__ = version_tuple = (6, 4, 2)

{hdx_python_api-6.4.1 → hdx_python_api-6.4.2}/src/hdx/data/user.py

@@ -311,7 +311,7 @@ class User(HDXObject):
         Returns:
             bool: True if the logged in user is a member of the organization.
         """
-        for organization_dict in self.get_organization_dicts(permission=permission):
+        for organization_dict in self.get_organization_dicts(permission):
             if organization_dict["id"] == organization:
                 return True
             if organization_dict["name"] == organization:
@@ -367,19 +367,23 @@ class User(HDXObject):
 
     @classmethod
     def check_current_user_organization_access(
-        cls, organization: str, permission: str = "read"
+        cls,
+        organization: str,
+        permission: str = "read",
+        configuration: Optional[Configuration] = None,
     ) -> bool:
         """Check logged in user is a member of a given organization.
 
         Args:
             organization (str): Organization id or name.
             permission (str): Permission to check for. Defaults to 'read'.
+            configuration (Optional[Configuration]): HDX configuration. Defaults to global configuration.
 
         Returns:
             bool: True if the logged in user is a member of the organization.
         """
         for organization_dict in cls.get_current_user_organization_dicts(
-            permission=permission
+            permission, configuration
         ):
             if organization_dict["id"] == organization:
                 return True
@@ -389,32 +393,47 @@ class User(HDXObject):
 
     @classmethod
     def check_current_user_write_access(
-        cls, organization: str, permission: str = "create_dataset"
+        cls,
+        organization: str,
+        permission: str = "create_dataset",
+        configuration: Optional[Configuration] = None,
     ) -> "User":
         """Check logged in user has write access to a given organization. Raises
-        PermissionError if teh user does not have access otherwise logs and returns the
+        PermissionError if the user does not have access otherwise logs and returns the
         current username.
 
         Args:
             organization (str): Organization id or name.
             permission (str): Permission to check for. Defaults to 'create_dataset'.
+            configuration (Optional[Configuration]): HDX configuration. Defaults to global configuration.
 
         Returns:
             str: Username of current user
         """
+        if configuration is None:
+            configuration = Configuration.read()
+        hdx_key = configuration.hdx_key
+        if not hdx_key:
+            raise PermissionError(
+                "There is no logged in user. API token is missing or blank!"
+            )
+        logger.info(f"API token is {len(hdx_key)} characters long")
         try:
-            current_user = cls.get_current_user()
+            current_user = cls.get_current_user(configuration)
         except HDXError:
             raise PermissionError(
-                "There is no logged in user (missing or invalid API token)!"
+                "There appears to be no logged in user. API token may be invalid!"
             )
         username = current_user["name"]
-        if not cls.check_current_user_organization_access(organization, permission):
+        logger.info(f'Current user is "{username}"')
+        if not cls.check_current_user_organization_access(
+            organization, permission, configuration
+        ):
             raise PermissionError(
-                f'Current user "{username}" does not have "{permission}" access to "{organization}" organization!'
+                f'Current user does not have "{permission}" access to "{organization}" organization!'
             )
         logger.info(
-            f'Current user "{username}" has "{permission}" access to "{organization}" organization'
+            f'Current user has "{permission}" access to "{organization}" organization'
         )
         return username
 

{hdx_python_api-6.4.1 → hdx_python_api-6.4.2}/tests/hdx/data/test_user.py

@@ -332,6 +332,13 @@ class TestUser:
                 datadict = json.loads(decodedata)
                 if "user" in url:
                     if "show" in url:
+                        configuration = Configuration.read()
+                        hdx_key = configuration.hdx_key
+                        if hdx_key == "fail":
+                            return MockResponse(
+                                404,
+                                '{"success": false, "error": {"message": "Not found", "__type": "Not Found Error"}, "help": "http://test-data.humdata.org/api/3/action/help_show?name=user_show"}',
+                            )
                         result = json.dumps(resultdict)
                         return MockResponse(
                             200,
@@ -706,6 +713,18 @@ Content-Transfer-Encoding: 7bit
         assert username == "MyUser1"
         with pytest.raises(PermissionError):
             User.check_current_user_write_access("lala")
+        with pytest.raises(PermissionError):
+            configuration = Configuration.read()
+            hdx_key = configuration.hdx_key
+            configuration.hdx_key = "fail"
+            User.check_current_user_write_access("b67e6c74-c185-4f43-b561-0e114a736f19")
+            configuration.hdx_key = hdx_key
+        with pytest.raises(PermissionError):
+            configuration = Configuration.read()
+            hdx_key = configuration.hdx_key
+            configuration.hdx_key = None
+            User.check_current_user_write_access("acled", configuration=configuration)
+            configuration.hdx_key = hdx_key
 
     def test_get_token_list(self, configuration, post_tokenlist):
         user = User.read_from_hdx("9f3e9973-7dbe-4c65-8820-f48578e3ffea")