CU-3ebk1pj - Add an API to get scripts.

Author: fred-yu-2013

docs/source/index.rst

@@ -20,7 +20,7 @@ Summary
     database.get_collections, database.create_collection, database.delete_collection, database.insert_or_count,
     database.update, database.delete, database.find, database.query,
     files.reading_operation, files.writing_operation, files.move_file, files.delete_file,
-    scripting.register_script, scripting.call_script, scripting.call_script_url,
+    scripting.register_script, scripting.get_scripts, scripting.call_script, scripting.call_script_url,
     scripting.unregister_script, scripting.upload_file, scripting.download_file,
     backup.state, backup.backup_restore, backup.server_promotion,
     payment.version, payment.place_order, payment.settle_order, payment.orders, payment.receipts,
@@ -229,6 +229,13 @@ register script
   :undoc-static:
   :endpoints: scripting.register_script
 
+get scripts
+-----------
+
+.. autoflask:: src:get_docs_app()
+  :undoc-static:
+  :endpoints: scripting.get_scripts
+
 call script
 -----------
 

src/modules/scripting/scripting.py

@@ -446,3 +446,30 @@ def parse_transaction_id(transaction_id):
             raise InvalidParameterException(f"Invalid transaction id '{transaction_id}': {[row_id, target_did, target_app_did]}.")
 
         return row_id, target_did, target_app_did
+
+    def get_scripts(self, skip, limit, name):
+        """ :v2 API: """
+        self.vault_manager.get_vault(g.usr_did).check_write_permission()
+
+        if name:
+            self.check_internal_script(name)
+            filter_ = {'name': name}
+        else:
+            filter_ = {'name': {'$ne': SCRIPT_ANONYMOUS_FILE}}
+
+        options = {}
+        if skip:
+            options['skip'] = skip
+        if limit:
+            options['limit'] = limit
+
+        docs = self.mcli.get_user_collection(g.usr_did, g.app_did, SCRIPTING_SCRIPT_COLLECTION).find_many(filter_, **options)
+        if not docs:
+            raise ScriptNotFoundException()
+
+        for d in docs:
+            del d['_id']
+            fix_dollar_keys_recursively(d, is_save=False)
+        return {
+            "scripts": docs
+        }

src/view/__init__.py

@@ -45,6 +45,7 @@ def init_app(api: Api):
     api.add_resource(files.DeleteFile, '/vault/files/<path:path>', endpoint='files.delete_file')
 
     # scripting service
+    api.add_resource(scripting.GetScripts, '/vault/scripting/scripts', endpoint='scripting.get_scripts')
     api.add_resource(scripting.RegisterScript, '/vault/scripting/<script_name>', endpoint='scripting.register_script')
     api.add_resource(scripting.CallScript, '/vault/scripting/<script_name>', endpoint='scripting.call_script')
     api.add_resource(scripting.CallScriptUrl, '/vault/scripting/<script_name>/<context_str>/<params>', endpoint='scripting.call_script_url')

src/view/scripting.py

@@ -9,6 +9,7 @@
 
 from src.modules.scripting.scripting import Scripting
 from src.utils.http_exception import InvalidParameterException
+from src.utils.http_request import RV
 from src.utils.http_response import response_stream
 
 
@@ -179,6 +180,68 @@ def put(self, script_name):
         return self.scripting.register_script(script_name)
 
 
+class GetScripts(Resource):
+    def __init__(self):
+        self.scripting = Scripting()
+
+    def get(self):
+        """ Get the scripts which user already registered.
+
+        .. :quickref: 05 Scripting; Get Scripts
+
+        **Request**:
+
+        **URL Parameters**:
+
+        .. sourcecode:: http
+
+            <skip>  # optional, default is 0
+            <limit> # optional, default is 0 ()
+            <name>  # the script name.
+
+        **Response OK**:
+
+        .. sourcecode:: http
+
+            HTTP/1.1 200 OK
+
+        .. code-block:: json
+
+            {
+                "scripts": [{ # the content of every script.
+                    "context": {...},
+                    "executable": {...},
+                    "allowAnonymousUser": false,
+                    "allowAnonymousApp": false
+                }]
+            }
+
+        **Response Error**:
+
+        .. sourcecode:: http
+
+            HTTP/1.1 401 Unauthorized
+
+        .. sourcecode:: http
+
+            HTTP/1.1 400 Bad Request
+
+        .. sourcecode:: http
+
+            HTTP/1.1 403 Forbidden
+
+        .. sourcecode:: http
+
+            HTTP/1.1 404 Not Found
+
+        """
+        skip = RV.get_args().get_opt('skip', int, None)
+        limit = RV.get_args().get_opt('limit', int, None)
+        name = RV.get_args().get_opt('name', str, None)
+
+        return self.scripting.get_scripts(skip, limit, name)
+
+
 class UnregisterScript(Resource):
     def __init__(self):
         self.scripting = Scripting()

tests/scripting_test.py

@@ -263,6 +263,38 @@ def execute_once(content, words_count):
         execute_once('message6', 60000)
         execute_once('message8', 80000)
 
+    def test02_get_scripts(self):
+        script_name, executable_name = 'ipfs_database_count', 'database_count'
+        script_body = {'condition': {
+            'name': 'verify_user_permission',
+            'type': 'queryHasResults',
+            'body': {
+                'collection': self.collection_name,
+                'filter': {'author': '$params.condition_author'}
+            }
+        }, 'executable': {
+            'name': executable_name,
+            'type': 'count',
+            'body': {
+                'collection': self.collection_name,
+                'filter': {'author': '$params.author'}
+            }
+        }}
+        self.__register_script(script_name, script_body)
+
+        # the check for 'get scripts'.
+        response = self.cli.get(f'/scripting/scripts')
+        RA(response).assert_status(200)
+        scripts = RA(response).body().get('scripts', list)
+        self.assertEqual(len(scripts), 1)
+        script = DictAsserter(**scripts[0])
+        script.get('executable', dict).assert_equal('name', executable_name)
+        script.get('executable', dict).assert_equal('type', 'count')
+        script.get('executable', dict).get('body').assert_equal('collection', self.collection_name)
+        script.get('executable', dict).get('body', dict).get('filter', dict).assert_equal('author', '$params.author')
+
+        self.delete_script(script_name)
+
     def test02_count(self):
         script_name, executable_name = 'ipfs_database_count', 'database_count'
         script_body = {'executable': {