glpi-api 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

{glpi_api-0.4.0.dist-info → glpi_api-0.6.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: glpi-api
-Version: 0.4.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é
-Author-email: francois.menabe@unistra.fr
+Author-email: francois.menabe@gmail.fr
 License: GPLv3+
 Keywords: rest,api,glpi
 Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
@@ -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.6.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+glpi_api.py,sha256=I2q6ISLNib_--WiRaqx1ASfvcnrDU8JBLHlut6IW7fY,36794
+glpi_api-0.6.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+glpi_api-0.6.0.dist-info/METADATA,sha256=7wZFajZbtznfwvAQPz5wtNkYToHdSiR4fFNosp5E-gQ,833
+glpi_api-0.6.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+glpi_api-0.6.0.dist-info/top_level.txt,sha256=YOkX5fKd6VWRx_-iMUfVJN15Xobw1VQ-mUF8HKWK2l0,9
+glpi_api-0.6.0.dist-info/RECORD,,

{glpi_api-0.4.0.dist-info → glpi_api-0.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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)):
@@ -729,6 +736,35 @@ class GLPI:
             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
+        Same method used as get-sub-items, same parameter
+        <https://github.com/glpi-project/glpi/blob/master/apirest.md#get-sub-items>`__
+
+        Add a collection of rows of the ``sub_itemtype`` for the identified
+        item of type ``itemtype`` and id ``item_id``. ``kwargs`` contains
+        additional parameters allowed by the API.
+
+        .. code::
+
+            # Add a operatingsystem of a computer.
+            >>> In [241]: glpi.add_sub_items('Computer',1,'Item_OperatingSystem',{'items_id': 1 ,'itemtype':'Computer','operatingsystems_id':1 })
+            [{'id': 261,
+              'itemtype': 'Computer',
+              'items_id': 1,
+            ...
+        """
+        url = self._set_method(itemtype, item_id, sub_itemtype)
+        response = self.session.post(url,
+                                    json={'input': items})
+        return {
+            201: lambda r: r.json(),
+            207: lambda r: r.json()[1],
+            400: _glpi_error,
+            401: _glpi_error
+        }.get(response.status_code, _unknown_error)(response)
+
     @_catch_errors
     def update(self, itemtype, *items):
         """`API documentation
@@ -749,11 +785,42 @@ class GLPI:
                                     json={'input': items})
         return {
             200: lambda r: r.json(),
+            201: lambda r: r.json(),
             207: lambda r: r.json()[1],
             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
+        <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
+        item of type ``itemtype`` and id ``item_id``. ``kwargs`` contains
+        additional parameters allowed by the API.
+
+        .. code::
+
+            # update the operatingsystem a computer.
+            >>> In [241]: glpi.update_sub_items('Computer',1,'Item_OperatingSystem' {'id': 1 ,'itemtype':'Computer','operatingsystem_id':1 })
+            [{'id': 261,
+              'itemtype': 'Computer',
+              'items_id': 1,
+            ...
+        """
+        url = self._set_method(itemtype, item_id, sub_itemtype)
+        response = self.session.put(url,
+                                    json={'input': items})
+        return {
+            200: lambda r: r.json(),
+            201: lambda r: r.json(),
+            207: lambda r: r.json(),
+            400: _glpi_error,
+            401: _glpi_error
+        }.get(response.status_code, _unknown_error)(response)
+
     @_catch_errors
     def delete(self, itemtype, *items, **kwargs):
         """`API documentation <https://github.com
@@ -784,6 +851,37 @@ class GLPI:
             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
+        <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
+        item of type ``itemtype`` and id ``item_id``. ``kwargs`` contains
+        additional parameters allowed by the API.
+
+        .. code::
+
+            # delete the operatingsystem a computer.
+            >>> In [241]: glpi.delete_sub_items('Computer',1,'Item_OperatingSystem' {'id': 1 ,'itemtype':'Computer','operatingsystem_id':1 })
+            [{'id': 261,
+              'itemtype': 'Computer',
+              'items_id': 1,
+            ...
+        """
+        url = self._set_method(itemtype, item_id, sub_itemtype)
+        response = self.session.delete(url,
+                                    json={'input': items})
+        return {
+            200: lambda r: r.json(),
+            204: lambda r: r.json(),
+            207: lambda r: r.json()[1],
+            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 upload_document(self, name, filepath):
         """`API documentation

glpi_api-0.4.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-glpi_api.py,sha256=uVAwXRbXFF1rAH4DSppBS-wTorKQor7bjEDHbCLmcDg,32766
-glpi_api-0.4.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-glpi_api-0.4.0.dist-info/METADATA,sha256=UmfIPEK9-3GWhUGqOdRDm86imuwe-4HTfJVwIyTooGY,662
-glpi_api-0.4.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-glpi_api-0.4.0.dist-info/top_level.txt,sha256=YOkX5fKd6VWRx_-iMUfVJN15Xobw1VQ-mUF8HKWK2l0,9
-glpi_api-0.4.0.dist-info/RECORD,,