Merge pull request #93 from didx-xyz/feat/0.8.1

Feat/0.8.1

Author: ff137

README.md

@@ -47,13 +47,14 @@ Each Cloud Controller version maps to a specific ACA-Py version, which is outlin
 | 0.6.0-0.6.3                    | 0.7.4                            |
 | 0.7.0                          | 0.7.5                            |
 | 0.8.0                          | 0.8.0                            |
+| 0.8.1                          | 0.8.1                            |
 
 ## Features
 
 Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py.
 
 - Fully Typed wrapper around Aries Cloud Agent Python
-- Supports latest ACA-Py version (0.8.0)
+- Supports latest ACA-Py version (0.8.1)
 - Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases.
 - Supports multi-tenant APIs and authentication
 - Async API

aries_cloudcontroller/acapy_client.py

@@ -1,7 +1,9 @@
 from typing import Optional
+
 from aiohttp.client import ClientSession
 
 from aries_cloudcontroller.client import Client
+from aries_cloudcontroller.util.acapy_client_session import AcaPyClientSession
 from aries_cloudcontroller.util.pydantic_converter import PydanticConverter
 
 
@@ -10,30 +12,42 @@ def __init__(
         self,
         base_url: str,
         *,
+        client_session: Optional[ClientSession] = None,
         api_key: Optional[str] = None,
         admin_insecure: Optional[bool] = False,
         tenant_jwt: Optional[str] = None,
     ):
+        self.base_url = base_url
+
+        self._should_close_session = False  # only close ClientSession when created here
+        # A provided ClientSession should be closed externally.
+
+        if client_session and not api_key:
+            api_key = client_session.headers.get("x-api-key")
+
         if not api_key and not admin_insecure:
             raise Exception(
                 "api_key property is missing. Use admin_insecure=True if you want"
                 " to use the controller without authentication."
             )
 
-        headers = {}
-
-        if api_key:
-            headers["x-api-key"] = api_key
-        if tenant_jwt:
-            headers["authorization"] = f"Bearer {tenant_jwt}"
-
-        client_session = ClientSession(
-            headers=headers,
-            raise_for_status=True,
-        )
+        if not client_session:
+            self.client_session = AcaPyClientSession(
+                api_key=api_key, tenant_jwt=tenant_jwt
+            ).client_session
+            self._should_close_session = True
+        else:
+            self.client_session = client_session
 
         super().__init__(
-            base_url,
-            client=client_session,
+            self.base_url,
+            client=self.client_session,
             extra_service_params={"converter": PydanticConverter()},
         )
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc_value, traceback):
+        if self._should_close_session and not self.client_session.closed:
+            await self.client_session.close()

aries_cloudcontroller/api/action_menu.py

@@ -39,6 +39,8 @@ async def perform_action(
         self, *, conn_id: str, body: Optional[PerformRequest] = None
     ) -> Dict[str, Any]:
         """Perform an action associated with the active menu"""
+        if not body:
+            body = PerformRequest()
         return await self.__perform_action(
             conn_id=conn_id,
             body=body,
@@ -54,6 +56,8 @@ async def send_menu(
         self, *, conn_id: str, body: Optional[SendMenu] = None
     ) -> Dict[str, Any]:
         """Send an action menu to a connection"""
+        if not body:
+            body = SendMenu()
         return await self.__send_menu(
             conn_id=conn_id,
             body=body,

aries_cloudcontroller/api/basicmessage.py

@@ -25,6 +25,8 @@ async def send_message(
         self, *, conn_id: str, body: Optional[SendMessage] = None
     ) -> Dict[str, Any]:
         """Send a basic message to a connection"""
+        if not body:
+            body = SendMessage()
         return await self.__send_message(
             conn_id=conn_id,
             body=body,

aries_cloudcontroller/api/connection.py

@@ -73,6 +73,8 @@ async def create_invitation(
         body: Optional[CreateInvitationRequest] = None
     ) -> InvitationResult:
         """Create a new connection invitation"""
+        if not body:
+            body = CreateInvitationRequest()
         return await self.__create_invitation(
             alias=alias,
             auto_accept=bool_query(auto_accept),
@@ -85,6 +87,8 @@ async def create_static_connection(
         self, *, body: Optional[ConnectionStaticRequest] = None
     ) -> ConnectionStaticResult:
         """Create a new static connection"""
+        if not body:
+            body = ConnectionStaticRequest()
         return await self.__create_static_connection(
             body=body,
         )
@@ -158,6 +162,8 @@ async def receive_invitation(
         body: Optional[ReceiveInvitationRequest] = None
     ) -> ConnRecord:
         """Receive a new connection invitation"""
+        if not body:
+            body = ReceiveInvitationRequest()
         return await self.__receive_invitation(
             alias=alias,
             auto_accept=bool_query(auto_accept),
@@ -169,6 +175,8 @@ async def set_metadata(
         self, *, conn_id: str, body: Optional[ConnectionMetadataSetRequest] = None
     ) -> ConnectionMetadata:
         """Set connection metadata"""
+        if not body:
+            body = ConnectionMetadataSetRequest()
         return await self.__set_metadata(
             conn_id=conn_id,
             body=body,

aries_cloudcontroller/api/credential_definition.py

@@ -74,6 +74,8 @@ async def publish_cred_def(
         body: Optional[CredentialDefinitionSendRequest] = None
     ) -> TxnOrCredentialDefinitionSendResult:
         """Sends a credential definition to the ledger"""
+        if not body:
+            body = CredentialDefinitionSendRequest()
         return await self.__publish_cred_def(
             conn_id=conn_id,
             create_transaction_for_endorser=bool_query(create_transaction_for_endorser),

aries_cloudcontroller/api/credentials.py

@@ -100,6 +100,8 @@ async def get_w3c_credentials(
         body: Optional[W3CCredentialsListRequest] = None
     ) -> VCRecordList:
         """Fetch W3C credentials from wallet"""
+        if not body:
+            body = W3CCredentialsListRequest()
         return await self.__get_w3c_credentials(
             count=count,
             start=start,

aries_cloudcontroller/api/did_exchange.py

@@ -80,6 +80,8 @@ async def receive_request(
         body: Optional[DIDXRequest] = None
     ) -> ConnRecord:
         """Receive request against public DID's implicit invitation"""
+        if not body:
+            body = DIDXRequest()
         return await self.__receive_request(
             alias=alias,
             auto_accept=bool_query(auto_accept),

aries_cloudcontroller/api/endorse_transaction.py

@@ -39,6 +39,8 @@ async def create_request(
         body: Optional[Date] = None
     ) -> TransactionRecord:
         """For author to send a transaction request"""
+        if not body:
+            body = Date()
         return await self.__create_request(
             tran_id=tran_id,
             endorser_write_txn=bool_query(endorser_write_txn),

aries_cloudcontroller/api/issue_credential_v1_0.py

@@ -53,6 +53,8 @@ async def create_credential(
         self, *, body: Optional[V10CredentialCreate] = None
     ) -> V10CredentialExchange:
         """Create a credential record without sending (generally for use with Out-Of-Band)"""
+        if not body:
+            body = V10CredentialCreate()
         return await self.__create_credential(
             body=body,
         )
@@ -61,6 +63,8 @@ async def create_offer(
         self, *, body: Optional[V10CredentialConnFreeOfferRequest] = None
     ) -> V10CredentialExchange:
         """Create a credential offer, independent of any proposal or connection"""
+        if not body:
+            body = V10CredentialConnFreeOfferRequest()
         return await self.__create_offer(
             body=body,
         )
@@ -97,6 +101,8 @@ async def issue_credential(
         self, *, cred_ex_id: str, body: Optional[V10CredentialIssueRequest] = None
     ) -> V10CredentialExchange:
         """Send holder a credential"""
+        if not body:
+            body = V10CredentialIssueRequest()
         return await self.__issue_credential(
             cred_ex_id=cred_ex_id,
             body=body,
@@ -106,6 +112,8 @@ async def issue_credential_automated(
         self, *, body: Optional[V10CredentialProposalRequestMand] = None
     ) -> V10CredentialExchange:
         """Send holder a credential, automating entire flow"""
+        if not body:
+            body = V10CredentialProposalRequestMand()
         return await self.__issue_credential_automated(
             body=body,
         )
@@ -117,6 +125,8 @@ async def report_problem(
         body: Optional[V10CredentialProblemReportRequest] = None
     ) -> Dict[str, Any]:
         """Send a problem report for credential exchange"""
+        if not body:
+            body = V10CredentialProblemReportRequest()
         return await self.__report_problem(
             cred_ex_id=cred_ex_id,
             body=body,
@@ -126,6 +136,8 @@ async def send_offer(
         self, *, cred_ex_id: str, body: Optional[V10CredentialBoundOfferRequest] = None
     ) -> V10CredentialExchange:
         """Send holder a credential offer in reference to a proposal with preview"""
+        if not body:
+            body = V10CredentialBoundOfferRequest()
         return await self.__send_offer(
             cred_ex_id=cred_ex_id,
             body=body,
@@ -135,6 +147,8 @@ async def send_offer_free(
         self, *, body: Optional[V10CredentialFreeOfferRequest] = None
     ) -> V10CredentialExchange:
         """Send holder a credential offer, independent of any proposal"""
+        if not body:
+            body = V10CredentialFreeOfferRequest()
         return await self.__send_offer_free(
             body=body,
         )
@@ -143,6 +157,8 @@ async def send_proposal(
         self, *, body: Optional[V10CredentialProposalRequestOpt] = None
     ) -> V10CredentialExchange:
         """Send issuer a credential proposal"""
+        if not body:
+            body = V10CredentialProposalRequestOpt()
         return await self.__send_proposal(
             body=body,
         )
@@ -157,6 +173,8 @@ async def store_credential(
         self, *, cred_ex_id: str, body: Optional[V10CredentialStoreRequest] = None
     ) -> V10CredentialExchange:
         """Store a received credential"""
+        if not body:
+            body = V10CredentialStoreRequest()
         return await self.__store_credential(
             cred_ex_id=cred_ex_id,
             body=body,