merge with master

Author: wip-abramson

README.md

@@ -19,7 +19,7 @@ This project is written in Python and is displayed in jupyter notebooks.
 
 You need to install:
 1. [Docker](https://docs.docker.com/get-docker/)
-1. The **source-to-image** (s2i) tool is also required to build the docker images used in the demo. S2I can be downloaded [here](https://github.com/openshift/source-to-image). The website gives instructions for installing on other platforms.
+1. The **source-to-image** (s2i) tool is also required to build the docker images used in the demo. S2I can be downloaded [here](https://github.com/openshift/source-to-image). The website gives instructions for installing on other platforms like MACOS, Linux, Windows.
 Verify that **s2i** is in your PATH.  If not, then edit your PATH and add the directory where **s2i** is installed.  The **manage** script will look for the **s2i** executable on your PATH.  If it is not found you will get a message asking you to download and set it on your PATH.
     - If you are using a Mac and have Homebrew installed, the following command will install s2i: `brew install source-to-image`
     - If you are using Linux, go to the [releases](https://github.com/openshift/source-to-image/releases/latest) page and download the correct distribution for your machine. Choose either the linux-386 or the linux-amd64 links for 32 and 64-bit, respectively. Unpack the downloaded tar with `tar -xvf "Release.tar.gz"`

libs/aries-basic-controller/README.md

@@ -4,7 +4,7 @@ A simple pip installable package for controlling aries agents through admin API
 
 # Install
 
-Current version 0.1.1
+Current version 0.2
 
 `python3 -m pip install aries_basic_controller`
 

libs/aries-basic-controller/aries_basic_controller/aries_controller.py

@@ -16,6 +16,8 @@
 from .controllers.credential import CredentialController
 from .controllers.server import ServerController
 from .controllers.oob import OOBController
+from .controllers.action_menu import ActionMenuController
+from .controllers.revocation import RevocationController
 
 import logging
 
@@ -25,8 +27,19 @@ class AriesAgentController:
 
     ## TODO rethink how to initialise. Too many args?
     ## is it important to let users config connections/issuer etc
-    def __init__(self, webhook_host: str, webhook_port: int, admin_url: str, webhook_base: str = "",
-                 connections: bool = True, messaging: bool = True, issuer: bool = True, api_key: str = None):
+    def __init__(
+        self,
+        webhook_host: str,
+        webhook_port: int,
+        admin_url: str,
+        webhook_base: str = "",
+        connections: bool = True,
+        messaging: bool = True,
+        issuer: bool = True,
+        action_menu: bool = True,
+        revocations: bool = True,
+        api_key: str = None,
+    ):
 
         self.webhook_site = None
         self.admin_url = admin_url
@@ -62,7 +75,13 @@ def __init__(self, webhook_host: str, webhook_port: int, admin_url: str, webhook
             self.issuer = IssuerController(self.admin_url, self.client_session, self.connections,
                                            self.wallet, self.definitions)
 
-
+        if action_menu:
+            self.action_menu = ActionMenuController(self.admin_url, self.client_session)
+        if revocations:
+            self.revocations = RevocationController(
+                self.admin_url,
+                self.client_session
+            )
 
     def register_listeners(self, listeners, defaults=True):
         if defaults:
@@ -73,7 +92,6 @@ def register_listeners(self, listeners, defaults=True):
             if self.proofs:
                 pub.subscribe(self.proofs.default_handler, "present_proof")
 
-
         for listener in listeners:
             pub.subscribe(listener["handler"], listener["topic"])
 
@@ -96,11 +114,7 @@ async def handle_webhook(self, topic, payload):
         pub.sendMessage(topic, payload=payload)
         return web.Response(status=200)
 
-
     async def terminate(self):
         await self.client_session.close()
         if self.webhook_site:
             await self.webhook_site.stop()
-
-
-

libs/aries-basic-controller/aries_basic_controller/controllers/action_menu.py

@@ -0,0 +1,49 @@
+from .base import BaseController
+from ..models.connection import Connection
+
+from aiohttp import (
+    ClientSession,
+)
+import logging
+import asyncio
+
+class ActionMenuController(BaseController):
+
+    def __init__(self, admin_url: str, client_session: ClientSession):
+        super().__init__(admin_url, client_session)
+
+    async def close_menu(self, connection_id: str):
+        return await self.admin_POST(f"/action-menu/{connection_id}/close")
+
+    async def get_menu(self, connection_id: str):
+        return await self.admin_POST(f"/action-menu/{connection_id}/fetch")
+
+    async def request_menu(self, connection_id: str):
+        return await self.admin_POST(f"/action-menu/{connection_id}/request")
+
+    async def perform(self, connection_id: str, menu_params,  menu_option_name):
+        body = {
+            "params": menu_params,
+            "name": menu_option_name
+        }
+
+        return await self.admin_POST(f"/action-menu/{connection_id}/perform", json_data=body)
+
+    async def send_menu(
+        self,
+        connection_id: str,
+        menu_description: str,
+        menu_errormsg: str,
+        menu_title: str,
+        menu_options,
+    ):
+        body = {
+            "menu": {
+                "description": menu_description,
+                "errormsg": menu_errormsg,
+                "title": menu_title,
+                "options": menu_options
+            }
+        }
+
+        return await self.admin_POST(f"/connections/{connection_id}/send-menu", json_data=body)

libs/aries-basic-controller/aries_basic_controller/controllers/base.py

@@ -16,6 +16,7 @@
 
 EVENT_LOGGER = logging.getLogger("event")
 
+
 class repr_json:
     def __init__(self, val):
         self.val = val
@@ -52,7 +53,6 @@ def handle_output(self, *output, source: str = None, **kwargs):
             color = None
         log_msg(*output, color=color, prefix=self.prefix_str, end=end, **kwargs)
 
-
     async def admin_request(
         self, method, path, json_data=None, text=False, params=None, data=None
     ) -> ClientResponse:
@@ -71,7 +71,6 @@ async def admin_request(
                     raise Exception(f"Error decoding JSON: {resp_text}") from e
             return resp_text
 
-
     async def admin_GET(self, path, text=False, params=None) -> ClientResponse:
         try:
             EVENT_LOGGER.debug("Controller GET %s request to Agent", path)
@@ -95,13 +94,54 @@ async def admin_POST(
             )
             response = await self.admin_request("POST", path, json_data, text, params, data)
             EVENT_LOGGER.debug(
-                "Response from POST %s received: \n%s", path, repr_json(response),
+                "Response from POST %s received: \n%s",
+                path,
+                repr_json(response),
             )
             return response
         except ClientError as e:
             self.log(f"Error during POST {path}: {str(e)}")
             raise
 
+    async def admin_PATCH(
+        self, path, json_data=None, text=False, params=None, data=None
+    ) -> ClientResponse:
+        try:
+            EVENT_LOGGER.debug(
+                "Controller PATCH %s request to Agent%s",
+                path,
+                (" with data: \n{}".format(repr_json(json_data)) if json_data else ""),
+            )
+            response = await self.admin_request("PATCH", path, json_data, text, params, data)
+            EVENT_LOGGER.debug(
+                "Response from PATCH %s received: \n%s",
+                path,
+                repr_json(response)
+            )
+            return response
+        except ClientError as e:
+            self.log(f"Error during PATCH {path}: {str(e)}")
+            raise
+
+    async def admin_PUT(
+        self, path, json_data=None, text=False, params=None, data=None
+    ) -> ClientResponse:
+        try:
+            EVENT_LOGGER.debug(
+                "Controller PUT %s request to Agent%s",
+                path,
+                (" with data: \n{}".format(repr_json(json_data)) if json_data else ""),
+            )
+            response = await self.admin_request("PUT", path, json_data, text, params, data)
+            EVENT_LOGGER.debug(
+                "Response from PUT %s received: \n%s",
+                path,
+                repr_json(response)
+            )
+            return response
+        except ClientError as e:
+            self.log(f"Error during PUT {path}: {str(e)}")
+            raise
 
     async def admin_DELETE(
             self, path, text=False, params=None

libs/aries-basic-controller/aries_basic_controller/controllers/credential.py

@@ -30,4 +30,4 @@ async def get_all(self, wql_query: str = None, count: int = None, start: int = N
         return await self.admin_GET("/credentials", params=params)
 
     async def is_revoked(self, credential_id):
-        return await self.admin_GET(f"credential/revoked/{credential_id}")
+        return await self.admin_GET(f"/credential/revoked/{credential_id}")