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

{glpi-api-0.3.5 → glpi-api-0.5.0}/PKG-INFO

@@ -1,16 +1,17 @@
 Metadata-Version: 2.1
 Name: glpi-api
-Version: 0.3.5
+Version: 0.5.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+)
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
+Requires-Dist: requests
 
 ********
 glpi-api

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

@@ -1,16 +1,17 @@
 Metadata-Version: 2.1
 Name: glpi-api
-Version: 0.3.5
+Version: 0.5.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+)
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Programming Language :: Python :: 3
 License-File: LICENSE
+Requires-Dist: requests
 
 ********
 glpi-api

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

@@ -435,6 +435,17 @@ class GLPI:
             404: lambda r: None
         }.get(response.status_code, _unknown_error)(response)
 
+    def _add_searchtext(self, searchText):
+        '''
+        Generate searchText parameter.
+        '''
+        if not isinstance(searchText, dict):
+            raise GLPIError(
+                'search text should be a dict, found: {:s}'.format(str(type(searchText)))
+            )
+
+        return {'searchText[{:s}]'.format(k): v for k, v in searchText.items()}
+
     @_catch_errors
     def get_all_items(self, itemtype, **kwargs):
         """`API documentation
@@ -454,7 +465,11 @@ class GLPI:
             # Retrieve deleted computers.
             >>> glpi.get_all_items('Computer', is_deleted=True)
             []
+            # Using searchText.
+            >>> glpi.get_all_items('Computer', searchText={'name':'server'})
+            []
         """
+        kwargs.update(self._add_searchtext(kwargs.pop('searchText', {})))
         response = self.session.get(self._set_method(itemtype),
                                     params=_convert_bools(kwargs))
         return {
@@ -713,6 +728,35 @@ 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
+        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):
@@ -734,10 +778,41 @@ 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):
@@ -768,6 +843,37 @@ 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 
+        <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):

{glpi-api-0.3.5 → glpi-api-0.5.0}/setup.py

@@ -4,9 +4,9 @@ from setuptools import setup
 
 setup(
     name='glpi-api',
-    version='0.3.5',
+    version='0.5.0',
     author='François Ménabé',
-    author_email='francois.menabe@unistra.fr',
+    author_email='francois.menabe@gmail.fr',
     url='https://github.com/unistra/python-glpi-api',
     license='GPLv3+',
     description='Wrap calls to GLPI REST API.',