Add methods for updating and replacing Foxx services with local files

Author: joowani

arango/foxx.py

@@ -230,7 +230,8 @@ def update_service(self,
                        dependencies=None,
                        teardown=None,
                        setup=None,
-                       legacy=None):
+                       legacy=None,
+                       force=None):
         """Update (upgrade) a service.
 
         :param mount: Service mount path (e.g "/_admin/aardvark").
@@ -247,8 +248,10 @@ def update_service(self,
         :type teardown: bool
         :param setup: Run service setup script.
         :type setup: bool
-        :param legacy: Install the service in 2.8 legacy compatibility mode.
+        :param legacy: Update the service in 2.8 legacy compatibility mode.
         :type legacy: bool
+        :param force: Force update if no service is found.
+        :type force: bool
         :return: Updated service metadata.
         :rtype: dict
         :raise arango.exceptions.FoxxServiceUpdateError: If update fails.
@@ -260,6 +263,8 @@ def update_service(self,
             params['setup'] = setup
         if legacy is not None:
             params['legacy'] = legacy
+        if force is not None:
+            params['force'] = force
 
         data = {}
         if source is not None:
@@ -283,52 +288,56 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
-    # TODO Remove once method is confirmed to be not supported
-    # def update_service_by_file(self,
-    #                            mount,
-    #                            filename=None,
-    #                            teardown=None,
-    #                            setup=None,
-    #                            legacy=None):
-    #     """Update (upgrade) a service using a javascript file or zip bundle.
-    #
-    #     :param mount: Service mount path (e.g "/_admin/aardvark").
-    #     :type mount: str | unicode
-    #     :param filename: Full path to the javascript file or zip bundle.
-    #     :type filename: str | unicode
-    #     :param teardown: Run service teardown script.
-    #     :type teardown: bool
-    #     :param setup: Run service setup script.
-    #     :type setup: bool
-    #     :param legacy: Install the service in 2.8 legacy compatibility mode.
-    #     :type legacy: bool
-    #     :return: Updated service metadata.
-    #     :rtype: dict
-    #     :raise arango.exceptions.FoxxServiceUpdateError: If update fails.
-    #     """
-    #     params = {'mount': mount}
-    #     if teardown is not None:
-    #         params['teardown'] = teardown
-    #     if setup is not None:
-    #         params['setup'] = setup
-    #     if legacy is not None:
-    #         params['legacy'] = legacy
-    #
-    #     data = self._encode_file(filename)
-    #     request = Request(
-    #         method='patch',
-    #         endpoint='/_api/foxx',
-    #         params=params,
-    #         data=data,
-    #         headers={'content-type': data.content_type}
-    #     )
-    #
-    #     def response_handler(resp):
-    #         if not resp.is_success:
-    #             raise FoxxServiceUpdateError(resp, request)
-    #         return resp.body
-    #
-    #     return self._execute(request, response_handler)
+    def update_service_with_file(self,
+                                 mount,
+                                 filename=None,
+                                 teardown=None,
+                                 setup=None,
+                                 legacy=None,
+                                 force=None):
+        """Update (upgrade) a service using a javascript file or zip bundle.
+
+        :param mount: Service mount path (e.g "/_admin/aardvark").
+        :type mount: str | unicode
+        :param filename: Full path to the javascript file or zip bundle.
+        :type filename: str | unicode
+        :param teardown: Run service teardown script.
+        :type teardown: bool
+        :param setup: Run service setup script.
+        :type setup: bool
+        :param legacy: Update the service in 2.8 legacy compatibility mode.
+        :type legacy: bool
+        :param force: Force update if no service is found.
+        :type force: bool
+        :return: Updated service metadata.
+        :rtype: dict
+        :raise arango.exceptions.FoxxServiceUpdateError: If update fails.
+        """
+        params = {'mount': mount}
+        if teardown is not None:
+            params['teardown'] = teardown
+        if setup is not None:
+            params['setup'] = setup
+        if legacy is not None:
+            params['legacy'] = legacy
+        if force is not None:
+            params['force'] = force
+
+        data = self._encode_file(filename)
+        request = Request(
+            method='patch',
+            endpoint='/_api/foxx/service',
+            params=params,
+            data=data,
+            headers={'content-type': data.content_type}
+        )
+
+        def response_handler(resp):
+            if not resp.is_success:
+                raise FoxxServiceUpdateError(resp, request)
+            return resp.body
+
+        return self._execute(request, response_handler)
 
     def replace_service(self,
                         mount,
@@ -355,7 +364,7 @@ def replace_service(self,
         :type teardown: bool
         :param setup: Run service setup script.
         :type setup: bool
-        :param legacy: Install the service in 2.8 legacy compatibility mode.
+        :param legacy: Replace the service in 2.8 legacy compatibility mode.
         :type legacy: bool
         :param force: Force install if no service is found.
         :type force: bool
@@ -395,57 +404,56 @@ def response_handler(resp):
 
         return self._execute(request, response_handler)
 
-    # TODO Remove once method is confirmed to be not supported
-    # def replace_service_by_file(self,
-    #                             mount,
-    #                             filename=None,
-    #                             teardown=None,
-    #                             setup=None,
-    #                             legacy=None,
-    #                             force=None):
-    #     """Replace a service using a javascript file or zip bundle.
-    #
-    #     :param mount: Service mount path (e.g "/_admin/aardvark").
-    #     :type mount: str | unicode
-    #     :param filename: Full path to the javascript file or zip bundle.
-    #     :type filename: str | unicode
-    #     :param teardown: Run service teardown script.
-    #     :type teardown: bool
-    #     :param setup: Run service setup script.
-    #     :type setup: bool
-    #     :param legacy: Install the service in 2.8 legacy compatibility mode.
-    #     :type legacy: bool
-    #     :param force: Force install if no service is found.
-    #     :type force: bool
-    #     :return: Replaced service metadata.
-    #     :rtype: dict
-    #     :raise arango.exceptions.FoxxServiceReplaceError: If replace fails.
-    #     """
-    #     params = {'mount': mount}
-    #     if teardown is not None:
-    #         params['teardown'] = teardown
-    #     if setup is not None:
-    #         params['setup'] = setup
-    #     if legacy is not None:
-    #         params['legacy'] = legacy
-    #     if force is not None:
-    #         params['force'] = force
-    #
-    #     data = self._encode_file(filename)
-    #     request = Request(
-    #         method='put',
-    #         endpoint='/_api/foxx',
-    #         params=params,
-    #         data=data,
-    #         headers={'content-type': data.content_type}
-    #     )
-    #
-    #     def response_handler(resp):
-    #         if not resp.is_success:
-    #             raise FoxxServiceReplaceError(resp, request)
-    #         return resp.body
-    #
-    #     return self._execute(request, response_handler)
+    def replace_service_with_file(self,
+                                  mount,
+                                  filename=None,
+                                  teardown=None,
+                                  setup=None,
+                                  legacy=None,
+                                  force=None):
+        """Replace a service using a javascript file or zip bundle.
+
+        :param mount: Service mount path (e.g "/_admin/aardvark").
+        :type mount: str | unicode
+        :param filename: Full path to the javascript file or zip bundle.
+        :type filename: str | unicode
+        :param teardown: Run service teardown script.
+        :type teardown: bool
+        :param setup: Run service setup script.
+        :type setup: bool
+        :param legacy: Replace the service in 2.8 legacy compatibility mode.
+        :type legacy: bool
+        :param force: Force install if no service is found.
+        :type force: bool
+        :return: Replaced service metadata.
+        :rtype: dict
+        :raise arango.exceptions.FoxxServiceReplaceError: If replace fails.
+        """
+        params = {'mount': mount}
+        if teardown is not None:
+            params['teardown'] = teardown
+        if setup is not None:
+            params['setup'] = setup
+        if legacy is not None:
+            params['legacy'] = legacy
+        if force is not None:
+            params['force'] = force
+
+        data = self._encode_file(filename)
+        request = Request(
+            method='put',
+            endpoint='/_api/foxx/service',
+            params=params,
+            data=data,
+            headers={'content-type': data.content_type}
+        )
+
+        def response_handler(resp):
+            if not resp.is_success:
+                raise FoxxServiceReplaceError(resp, request)
+            return resp.body
+
+        return self._execute(request, response_handler)
 
     def delete_service(self, mount, teardown=None):
         """Uninstall a service.

arango/version.py

@@ -1 +1 @@
-__version__ = '5.3.0'
+__version__ = '5.4.0'

docs/foxx.rst

@@ -91,7 +91,7 @@ information, refer to `ArangoDB manual`_.
     # Delete a service.
     foxx.delete_service(service_mount)
 
-You can also create a Foxx service by providing a file directly.
+You can also manage Foxx services by using zip or Javascript files directly:
 
 .. code-block:: python
 
@@ -112,13 +112,33 @@ You can also create a Foxx service by providing a file directly.
     # Create a service by providing a file directly.
     foxx.create_service_with_file(
         mount=service_mount,
-        source='/home/service.zip',
+        filename='/home/user/service.zip',
         development=True,
         setup=True,
         legacy=True
     )
-    foxx.enable_development(service_mount)
-    foxx.update_config(service_mount, config={})
-    foxx.update_dependencies(service_mount, dependencies={})
+
+    # Update (upgrade) a service by providing a file directly.
+    foxx.update_service_with_file(
+        mount=service_mount,
+        filename='/home/user/service.zip',
+        teardown=False,
+        setup=True,
+        legacy=True,
+        force=False
+    )
+
+    # Replace a service by providing a file directly.
+    foxx.replace_service_with_file(
+        mount=service_mount,
+        filename='/home/user/service.zip',
+        teardown=False,
+        setup=True,
+        legacy=True,
+        force=False
+    )
+
+    # Delete a service.
+    foxx.delete_service(service_mount)
 
 See :ref:`Foxx` for API specification.