glpi-api 0.5.0__tar.gz → 0.6.0__tar.gz

{glpi-api-0.5.0 → glpi_api-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: glpi-api
-Version: 0.5.0
+Version: 0.6.0
 Summary: Wrap calls to GLPI REST API.
 Home-page: https://github.com/unistra/python-glpi-api
 Author: François Ménabé
@@ -12,6 +12,15 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
 Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 ********
 glpi-api

{glpi-api-0.5.0 → glpi_api-0.6.0}/glpi_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: glpi-api
-Version: 0.5.0
+Version: 0.6.0
 Summary: Wrap calls to GLPI REST API.
 Home-page: https://github.com/unistra/python-glpi-api
 Author: François Ménabé
@@ -12,6 +12,15 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
 Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
 
 ********
 glpi-api

{glpi-api-0.5.0 → glpi_api-0.6.0}/glpi_api.py

@@ -33,7 +33,7 @@ class GLPIError(Exception):
     """Exception raised by this module."""
 
 @contextmanager
-def connect(url, apptoken, auth, verify_certs=True, use_headers=True):
+def connect(url, apptoken, auth, verify_certs=True, use_headers=True, user_agent=None):
     """Context manager that authenticate to GLPI when enter and kill application
     session in GLPI when leaving:
 
@@ -127,7 +127,8 @@ class GLPI:
     SSL certificates and passing authentication parameters as GET parameters
     (instead of headers).
     """
-    def __init__(self, url, apptoken, auth, verify_certs=True, use_headers=True):
+    def __init__(self, url, apptoken, auth, verify_certs=True, use_headers=True,
+                 user_agent=None):
         """Connect to GLPI and retrieve session token which is put in a
         ``requests`` session as attribute.
         """
@@ -141,14 +142,18 @@ class GLPI:
             self.session.verify = False
 
         # Connect and retrieve token.
-        session_token = self._init_session(apptoken, auth, use_headers=use_headers)
+        session_token = self._init_session(apptoken, auth, user_agent,
+                                           use_headers=use_headers)
 
         # Set required headers.
-        self.session.headers = {
+        headers = {
             'Content-Type': 'application/json',
             'Session-Token': session_token,
             'App-Token': apptoken
         }
+        if user_agent:
+            headers['User-Agent'] = user_agent
+        self.session.headers = headers
 
         # Use for caching field id/uid map.
         self._fields = {}
@@ -158,7 +163,7 @@ class GLPI:
         return '/'.join(str(part) for part in [self.url.strip('/'), *endpoints])
 
     @_catch_errors
-    def _init_session(self, apptoken, auth, use_headers=True):
+    def _init_session(self, apptoken, auth, user_agent, use_headers=True):
         """API documentation
         <https://github.com/glpi-project/glpi/blob/master/apirest.md#init-session>`__
 
@@ -170,6 +175,8 @@ class GLPI:
             'Content-Type': 'application/json',
             'App-Token': apptoken
         }
+        if user_agent:
+            init_headers['User-Agent'] = user_agent
         params = {}
 
         if isinstance(auth, (list, tuple)):
@@ -728,7 +735,7 @@ class GLPI:
             400: _glpi_error,
             401: _glpi_error
         }.get(response.status_code, _unknown_error)(response)
-    
+
     @_catch_errors
     def add_sub_items(self, itemtype, item_id, sub_itemtype, *items):
         """`API documentation
@@ -783,11 +790,11 @@ class GLPI:
             400: _glpi_error,
             401: _glpi_error
         }.get(response.status_code, _unknown_error)(response)
-    
+
     @_catch_errors
     def update_sub_items(self, itemtype, item_id, sub_itemtype, *items):
         """`API documentation
-        Same method used as get-sub-items, same parameters 
+        Same method used as get-sub-items, same parameters
         <https://github.com/glpi-project/glpi/blob/master/apirest.md#get-sub-items>`__
 
         Updates a collection of rows of the ``sub_itemtype`` for the identified
@@ -843,11 +850,11 @@ class GLPI:
             400: lambda r: _glpi_error(r) if r.json()[0] != 'ERROR_GLPI_DELETE' else r.json()[1],
             401: _glpi_error
         }.get(response.status_code, _unknown_error)(response)
-    
+
     @_catch_errors
     def delete_sub_items(self, itemtype, item_id, sub_itemtype, *items):
         """`API documentation
-        Same method used as get-sub-items, same parameters 
+        Same method used as get-sub-items, same parameters
         <https://github.com/glpi-project/glpi/blob/master/apirest.md#get-sub-items>`__
 
         deletes a collection of rows of the ``sub_itemtype`` for the identified

{glpi-api-0.5.0 → glpi_api-0.6.0}/setup.py

@@ -4,7 +4,7 @@ from setuptools import setup
 
 setup(
     name='glpi-api',
-    version='0.5.0',
+    version='0.6.0',
     author='François Ménabé',
     author_email='francois.menabe@gmail.fr',
     url='https://github.com/unistra/python-glpi-api',