vysion 2.0.2__tar.gz → 2.0.4__tar.gz

{vysion-2.0.2 → vysion-2.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vysion
-Version: 2.0.2
+Version: 2.0.4
 Summary: The official Python client library for Vysion
 Home-page: https://vysion.ai
 License: Apache-2.0
@@ -29,7 +29,7 @@ Welcome to the PyPi webpage for Vysion, our implementation as a Python library t
 
 You can request a demo for the web app or an API-key to use in this library at [vysion.ai](https://vysion.ai).
 
-Latest version: [2.0.2](https://pypi.org/project/vysion/)
+Latest version: [2.0.4](https://pypi.org/project/vysion/)
 
 You can visit [the documentation](https://developers.vysion.ai/?python) for more information on the searches and requests performed with the library or directly on the API.
 

{vysion-2.0.2 → vysion-2.0.4}/README.md

@@ -4,7 +4,7 @@ Welcome to the PyPi webpage for Vysion, our implementation as a Python library t
 
 You can request a demo for the web app or an API-key to use in this library at [vysion.ai](https://vysion.ai).
 
-Latest version: [2.0.2](https://pypi.org/project/vysion/)
+Latest version: [2.0.4](https://pypi.org/project/vysion/)
 
 You can visit [the documentation](https://developers.vysion.ai/?python) for more information on the searches and requests performed with the library or directly on the API.
 

{vysion-2.0.2 → vysion-2.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vysion"
-version = "2.0.2"
+version = "2.0.4"
 description = "The official Python client library for Vysion"
 homepage = "https://vysion.ai"
 repository = "https://gitlab.com/byronlabs/vysion/vysion-py"
@@ -36,6 +36,7 @@ black = "^24.3.0"
 
 [tool.poetry.group.dev.dependencies]
 ruff = "^0.5.2"
+pytest = "^8.3.2"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{vysion-2.0.2 → vysion-2.0.4}/vysion/client/client.py

@@ -26,9 +26,19 @@ from urllib.parse import quote, urlencode, urljoin
 # from pydantic import validate_arguments
 import requests
 
-import vysion.dto as dto
 from vysion.client.error import APIError
-from vysion.dto import Error
+from vysion.dto import (
+    Error,
+    DocumentHit,
+    VysionResponse,
+    RansomwareHit,
+    Stat,
+    Network,
+    Language,
+    ImChannelHit,
+    ImMessageHit,
+    ImProfileHit,
+)
 from vysion.version import __version__ as vysion_version
 
 # All API endpoints start with this prefix, you don't need to include the
@@ -106,9 +116,8 @@ class BaseClient:
         query = "?" + urlencode(query_params_initialzed)
         return urljoin(base, query)
 
-    def _make_request(self, url: str) -> dto.VysionResponse:
+    def _make_request(self, url: str) -> VysionResponse:
         session = self.__get_session__()
-        print(url)
         r = session.get(url)
 
         # TODO Improve this
@@ -123,14 +132,12 @@ class BaseClient:
 
             raise APIError(code, message)
 
-        payload = r.json()
-
-        result = dto.VysionResponse.model_validate(payload)
+        result = r.json()
 
         return result
 
 
-def vysion_error_manager(method) -> Union[dto.VysionResponse, Error]:
+def vysion_error_manager(method) -> Union[VysionResponse, Error]:
     def manage(*args, **kwargs):
         try:
             result = method(*args, **kwargs)
@@ -162,11 +169,11 @@ class Client(BaseClient):
         gte: datetime = None,
         page: int = 1,
         page_size: int = 10,
-        network: dto.Network = None,
-        language: dto.Language = None,
+        network: Network = None,
+        language: Language = None,
         include_tag: str = None,
         exclude_tag: str = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/search",
             q=q,
@@ -180,14 +187,14 @@ class Client(BaseClient):
             exclude_tag=exclude_tag,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_document(self, document_id: str) -> dto.VysionResponse:
+    def get_document(self, document_id: str) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document", document_id)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -197,28 +204,28 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document/url", url, page=page, lte=lte, gte=gte)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_tag(self, tag: str) -> dto.VysionResponse:
+    def get_tag(self, tag: str) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__("document/tag", tag)
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def find_email(
         self, email: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/email", email, page=page, lte=lte, gte=gte
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -229,7 +236,7 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/phone",
             country_code + "/" + phone_number,
@@ -238,7 +245,7 @@ class Client(BaseClient):
             gte=gte,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -249,12 +256,12 @@ class Client(BaseClient):
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.VysionResponse:
+    ) -> VysionResponse[DocumentHit]:
         url = self._build_api_url__(
             "document/wallet", chain + "/" + address, page=page, lte=lte, gte=gte
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[DocumentHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -277,10 +284,10 @@ class Client(BaseClient):
         gte: datetime = None,
         page: int = 1,
         page_size: int = 10,
-        network: dto.Network = None,
+        network: Network = None,
         country: str = None,
-        language: dto.Language = None,
-    ) -> dto.VysionResponse:
+        language: Language = None,
+    ) -> VysionResponse[RansomwareHit]:
         url = self._build_api_url__(
             "victim/search",
             q=q,
@@ -293,14 +300,14 @@ class Client(BaseClient):
             language=language,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[RansomwareHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
-    def get_ransomware_victim(self, document_id: str) -> dto.VysionResponse:
+    def get_ransomware_victim(self, document_id: str) -> VysionResponse[RansomwareHit]:
         url = self._build_api_url__("victim", document_id)
 
-        result = self._make_request(url)
+        result = VysionResponse[RansomwareHit].model_validate(self._make_request(url))
         return result.data
 
     #
@@ -313,10 +320,12 @@ class Client(BaseClient):
         countries: str = None,
         gte: datetime = None,
         lte: datetime = None,
-    ) -> dto.VysionResponse[dto.Stat]:
-        url = self._build_api_url__("stats/countries", countries=countries, gte=gte, lte=lte)
+    ) -> VysionResponse[Stat]:
+        url = self._build_api_url__(
+            "stats/countries", countries=countries, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[Stat].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
@@ -325,10 +334,12 @@ class Client(BaseClient):
         countries: str = None,
         gte: datetime = None,
         lte: datetime = None,
-    ) -> dto.VysionResponse[dto.Stat]:
-        url = self._build_api_url__("stats/groups", countries=countries, gte=gte, lte=lte)
+    ) -> VysionResponse[Stat]:
+        url = self._build_api_url__(
+            "stats/groups", countries=countries, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[Stat].model_validate(self._make_request(url))
         return result.data
 
     #
@@ -344,7 +355,7 @@ class Client(BaseClient):
         lte: datetime = None,
         page: int = 1,
         username: str = None,
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
+    ) -> VysionResponse[ImMessageHit]:
         url = self._build_api_url__(
             "im/" + platform + "/search",
             q=q,
@@ -354,43 +365,45 @@ class Client(BaseClient):
             username=username,
         )
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_chat(
         self, platform: str, channelId: str, gte: datetime = None, lte: datetime = None
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
-        url = self._build_api_url__("im/" + platform + "/chat/" + channelId, gte=gte, lte=lte)
+    ) -> VysionResponse[ImMessageHit]:
+        url = self._build_api_url__(
+            "im/" + platform + "/chat/" + channelId, gte=gte, lte=lte
+        )
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_profile(
         self, platform: str, userId: str
-    ) -> dto.VysionResponse[dto.ImProfileHit]:
+    ) -> VysionResponse[ImProfileHit]:
         url = self._build_api_url__("im/" + platform + "/profile/", userId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImProfileHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_message(
         self, platform: str, messageId: str
-    ) -> dto.VysionResponse[dto.ImMessageHit]:
+    ) -> VysionResponse[ImMessageHit]:
         url = self._build_api_url__("im/" + platform + "/message/", messageId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImMessageHit].model_validate(self._make_request(url))
         return result.data
 
     @vysion_error_manager
     def get_im_channel(
         self, platform: str, channelId: str
-    ) -> dto.VysionResponse[dto.ImChannelHit]:
+    ) -> VysionResponse[ImChannelHit]:
         url = self._build_api_url__("im/" + platform + "/channel/", channelId)
 
-        result = self._make_request(url)
+        result = VysionResponse[ImChannelHit].model_validate(self._make_request(url))
         return result.data
 
     #

{vysion-2.0.2 → vysion-2.0.4}/vysion/dto/dto.py

@@ -399,8 +399,7 @@ T = TypeVar("T")
 
 class Result(BaseModel, Generic[T]):
     total: int = 0
-    hits: Union[List[DocumentHit],List[Stat],List[ImChannelHit],List[ImMessageHit],
-                List[ImProfileHit]] = Field(default_factory=lambda: [])
+    hits: List[T] = Field(default_factory=lambda: [])
     
     def __init__(self, **kwargs):
         super().__init__(**kwargs)

{vysion-2.0.2 → vysion-2.0.4}/vysion/dto/tag.py

@@ -58,4 +58,4 @@ class Tag(BaseModel):
         return f"Tag<{self}>"
 
     def __str__(self):
-        return f'''{self.namespace}:{self.predicate}:"{self.value}"'''
+        return f'''{self.namespace}:{self.predicate}="{self.value}"'''

{vysion-2.0.2 → vysion-2.0.4}/vysion/dto/util.py

@@ -111,7 +111,7 @@ class MISPProcessor:
 
         self.misp_event.add_object(misp_object)
 
-    def process(self, result: dto.Result, **kwargs) -> MISPEvent:
+    def process(self, result: dto.Result[DocumentHit|RansomFeedHit], **kwargs) -> MISPEvent:
         
         processor = {
             DocumentHit: self.parse_hit,

{vysion-2.0.2 → vysion-2.0.4}/vysion/version.py

@@ -15,4 +15,4 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
-__version__ = "2.0.2"
+__version__ = "2.0.4"