[#550] Add support for client hints

Author: stsnel

README.md

@@ -1606,6 +1606,16 @@ If you want to create a user in a federated zone, use:
 >>> session.users.create('user', 'rodsuser', 'OtherZone', auth_str)
 ```
 
+Showing client hints
+--------------
+
+You can get a list of available microservices, rules, etc. using the `client_hints`
+attribute of the session.
+
+```python
+>>> session.client_hints
+```
+
 And more ...
 ------------
 

irods/api_number.py

@@ -176,6 +176,7 @@
     # 1100 - 1200 - SSL API calls
     "SSL_START_AN": 1100,
     "SSL_END_AN": 1101,
+    "CLIENT_HINTS_AN": 10215,
     "GET_RESOURCE_INFO_FOR_OPERATION_AN": 10220,
     "ATOMIC_APPLY_METADATA_OPERATIONS_APN": 20002,
     "GET_FILE_DESCRIPTOR_INFO_APN": 20000,

irods/session.py

@@ -11,13 +11,15 @@
 from irods.query import Query
 from irods.pool import Pool
 from irods.account import iRODSAccount
+from irods.api_number import api_number
 from irods.manager.collection_manager import CollectionManager
 from irods.manager.data_object_manager import DataObjectManager
 from irods.manager.metadata_manager import MetadataManager
 from irods.manager.access_manager import AccessManager
 from irods.manager.user_manager import UserManager, GroupManager
 from irods.manager.resource_manager import ResourceManager
 from irods.manager.zone_manager import ZoneManager
+from irods.message import iRODSMessage
 from irods.exception import NetworkException
 from irods.password_obfuscation import decode
 from irods import NATIVE_AUTH_SCHEME, PAM_AUTH_SCHEMES
@@ -301,6 +303,14 @@ def __server_version(self):
             conn.release()
             return version
 
+    @property
+    def client_hints(self):
+        message = iRODSMessage('RODS_API_REQ', int_info=api_number['CLIENT_HINTS_AN'])
+        with self.pool.get_connection() as conn:
+            conn.send(message)
+            response = conn.recv()
+        return response.get_json_encoded_struct()
+
     @property
     def pam_pw_negotiated(self):
             self.pool.account.store_pw = []

irods/test/client_hints_test.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python
+from __future__ import absolute_import
+import os
+import sys
+import unittest
+
+import irods.test.helpers as helpers
+
+class TestClientHints(unittest.TestCase):
+
+    def setUp(self):
+        self.sess = helpers.make_session()
+
+    def tearDown(self):
+        """Close connections."""
+        self.sess.cleanup()
+
+    def test_client_hints(self):
+        client_hints = self.sess.client_hints
+
+        self.assertIn("specific_queries", client_hints)
+        self.assertIn("rules", client_hints)
+        self.assertIn("plugins", client_hints)
+        self.assertIn("hash_scheme", client_hints)
+        self.assertIn("match_hash_policy", client_hints)
+
+
+if __name__ == '__main__':
+    # let the tests find the parent irods lib
+    sys.path.insert(0, os.path.abspath('../..'))
+    unittest.main()