vysion 1.0.15__tar.gz → 2.0.0__tar.gz

{vysion-1.0.15 → vysion-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vysion
-Version: 1.0.15
+Version: 2.0.0
 Summary: The official Python client library for Vysion
 Home-page: https://vysion.ai
 License: Apache-2.0
@@ -29,9 +29,9 @@ 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: [1.0.15](https://pypi.org/project/vysion/)
+Latest version: [2.0.0](https://pypi.org/project/vysion/)
 
-You can visit [the documentation](https://developers.vysion.ai/?python) or our [repository] (https://github.com/ByronLabs/vysion-py/tree/main) for more information on the searches and requests performed with the library or directly on the API.
+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.
 
 ### Taxonomy
 

{vysion-1.0.15 → vysion-2.0.0}/README.md

@@ -4,9 +4,9 @@ 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: [1.0.15](https://pypi.org/project/vysion/)
+Latest version: [2.0.0](https://pypi.org/project/vysion/)
 
-You can visit [the documentation](https://developers.vysion.ai/?python) or our [repository] (https://github.com/ByronLabs/vysion-py/tree/main) for more information on the searches and requests performed with the library or directly on the API.
+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.
 
 ### Taxonomy
 

{vysion-1.0.15 → vysion-2.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "vysion"
-version = "1.0.15"
+version = "2.0.0"
 description = "The official Python client library for Vysion"
 homepage = "https://vysion.ai"
 repository = "https://gitlab.com/byronlabs/vysion/vysion-py"
@@ -32,7 +32,10 @@ python-dotenv = "0.19.2"
 flake8 = "4.0.1"
 pyflakes = "2.4.0"
 mypy = "^0.961"
-black = "^22.6.0"
+black = "^24.3.0"
+
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.5.2"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{vysion-1.0.15 → vysion-2.0.0}/vysion/client/client.py

@@ -18,23 +18,22 @@ limitations under the License.
 # TODO Referenciar vt-py
 
 import logging
+import os
 from datetime import datetime, timedelta
 from typing import Union
-from urllib.parse import urlencode, urljoin, quote
+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 VysionError
+from vysion.dto import Error
 from vysion.version import __version__ as vysion_version
 
-import os
-
 # All API endpoints start with this prefix, you don't need to include the
 # prefix in the paths you request as it's prepended automatically.
-_ENDPOINT_PREFIX = "/api/v1/"
+_ENDPOINT_PREFIX = "/api/v2/"
 
 LOGGER = logging.getLogger("vysion-py")
 LOGGER.setLevel(logging.INFO)
@@ -43,12 +42,10 @@ LOGGER.setLevel(logging.INFO)
 
 
 class BaseClient:
-
     # __attrs__ = []
 
     # @validate_arguments #
     def __init__(self, api_key: str = None, headers: dict = dict(), proxy: dict = None):
-
         assert api_key is not None, "API key MUST be provided"
         assert isinstance(api_key, str), "API key MUST be a string"
 
@@ -57,14 +54,12 @@ class BaseClient:
         self.headers = headers
 
     def __get_session__(self) -> requests.Session:
-
         # TODO Configure proxy
 
         # If session is undefined
         try:
             self._session
         except (NameError, AttributeError):
-
             headers = self.headers.copy()
             headers.update(
                 {
@@ -80,7 +75,6 @@ class BaseClient:
         return self._session
 
     def _get_api_host(self):
-
         if os.getenv("API_HOST") is not None:
             api_host = os.getenv("API_HOST")
 
@@ -88,14 +82,15 @@ class BaseClient:
             api_host = "https://api.vysion.ai"
 
         return api_host
-    
 
-    def _build_api_url__(self, endpoint, param, **query_params):
-
-        param = quote(param, safe='')
+    def _build_api_url__(self, endpoint, param=None, **query_params):
         _API_HOST = self._get_api_host()
         _BASE_API = urljoin(_API_HOST, _ENDPOINT_PREFIX)
-        base = urljoin(_BASE_API, f"{endpoint}/{param}")
+        base = urljoin(_BASE_API, endpoint)
+
+        if param is not None:
+            param = quote(param, safe="")
+            base = urljoin(_BASE_API, f"{endpoint}/{param}")
 
         query_params_initialzed = query_params.copy()
 
@@ -103,19 +98,17 @@ class BaseClient:
         keys.sort()
 
         for i in keys:
-
             v = query_params[i]
 
             if v is None:
                 del query_params_initialzed[i]
 
         query = "?" + urlencode(query_params_initialzed)
-
         return urljoin(base, query)
 
     def _make_request(self, url: str) -> dto.VysionResponse:
-
         session = self.__get_session__()
+        print(url)
         r = session.get(url)
 
         # TODO Improve this
@@ -137,251 +130,255 @@ class BaseClient:
         return result
 
 
-def vysion_error_manager(method) -> Union[dto.Result, VysionError]:
+def vysion_error_manager(method) -> Union[dto.VysionResponse, Error]:
     def manage(*args, **kwargs):
         try:
             result = method(*args, **kwargs)
             return result
         except APIError as e:
-            return VysionError(code=e.code, message=e.message)
+            return Error(code=e.code, message=e.message)
         except Exception as e:
             LOGGER.error(e)
-            return VysionError()
+            return Error()
 
     return manage
 
 
 class Client(BaseClient):
-
-    # def add_url(self, url:str, type:VysionURL.Type):
-    #     """Add a Tor URL to be analyzed by PARCHE.
-
-    #     :param url: URL to be scanned.
-    #     :param type: Instance of :class:`VysionURL.Type`
-    #     :returns: An instance of :class:`VysionResponse`
-    #     """
-    #     pass
-
-    # def find_onion(self):
-    #   pass
-
-    # def add_onion(self):
-    #   pass
-
-    # def consume_feed(self):
-    #   pass
-
     @vysion_error_manager
     def status(self):
         # TODO Check API status
         pass
 
+    #
+    # Darknet document search
+    #
+
     @vysion_error_manager
     def search(
         self,
-        query: str,
-        tag: str = None,
-        notTag: str = None,
-        exact: bool = False,
-        network: dto.Network = None,
-        language: dto.Language = None,
-        page: int = 1,
+        q: str,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.Result:
-
+        page: int = 1,
+        page_size: int = 10,
+        network: dto.Network = None,
+        language: dto.Language = None,
+        include_tag: str = None,
+        exclude_tag: str = None,
+    ) -> dto.VysionResponse:
         url = self._build_api_url__(
-            "search",
-            query,
-            tag=tag,
-            notTag=notTag,
-            exact=exact,
-            network=network,
-            language=language,
-            page=page,
+            "document/search",
+            q=q,
             lte=lte,
             gte=gte,
+            page=page,
+            page_size=page_size,
+            network=network,
+            language=language,
+            include_tag=include_tag,
+            exclude_tag=exclude_tag,
         )
 
         result = self._make_request(url)
         return result.data
-    
-    @vysion_error_manager
-    def search_telegram(
-        self,
-        query: str,
-        username: str = None,
-        page: int = 1,
-        lte: datetime = None,
-        gte: datetime = None,
-    ) -> dto.Result:
 
-        url = self._build_api_url__(
-            "search-telegram",
-            query,
-            username=username,
-            page=page,
-            lte=lte,
-            gte=gte,
-        )
+    @vysion_error_manager
+    def get_document(self, document_id: str) -> dto.VysionResponse:
+        url = self._build_api_url__("document", document_id)
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def fuzzy_search(
+    def find_url(
         self,
-        query: str,
-        tag: str = None,
-        notTag: str = None,
-        network: dto.Network = None,
-        language: dto.Language = None,
+        url: str,
         page: int = 1,
         lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.Result:
-
-        url = self._build_api_url__(
-            "fuzzy",
-            query,
-            tag=tag,
-            notTag=notTag,
-            network=network,
-            language=language,
-            page=page,
-            lte=lte,
-            gte=gte,
-        )
+    ) -> dto.VysionResponse:
+        url = self._build_api_url__("document/url", url, page=page, lte=lte, gte=gte)
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def find_btc(
-        self, btc: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
-
-        url = self._build_api_url__("btc", btc, page=page, lte=lte, gte=gte)
+    def get_tag(self, tag: str) -> dto.VysionResponse:
+        url = self._build_api_url__("document/tag", tag)
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def find_eth(
-        self, eth: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
-
-        url = self._build_api_url__("eth", eth, page=page, lte=lte, gte=gte)
+    def find_email(
+        self, email: str, page: int = 1, lte: datetime = None, gte: datetime = None
+    ) -> dto.VysionResponse:
+        url = self._build_api_url__(
+            "document/email", email, page=page, lte=lte, gte=gte
+        )
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def find_dot(
-        self, dot: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
-
-        url = self._build_api_url__("dot", dot, page=page, lte=lte, gte=gte)
+    def find_wallet(
+        self,
+        chain: str,
+        address: str,
+        page: int = 1,
+        lte: datetime = None,
+        gte: datetime = None,
+    ) -> dto.VysionResponse:
+        url = self._build_api_url__(
+            "document/wallet", chain + "/" + address, page=page, lte=lte, gte=gte
+        )
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def find_xrp(
-        self, xrp: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
+    def get_document_html(self, document_id: str) -> str:
+        url = self._build_api_url__("html", document_id)
 
-        url = self._build_api_url__("xrp", xrp, page=page, lte=lte, gte=gte)
+        result = requests.get(url)
+
+        return result.text
+
+    #
+    # Ransowmare Victims Search
+    #
+
+    @vysion_error_manager
+    def search_ransomware_victim(
+        self,
+        q: str,
+        lte: datetime = None,
+        gte: datetime = None,
+        page: int = 1,
+        page_size: int = 10,
+        network: dto.Network = None,
+        country: str = None,
+        language: dto.Language = None,
+    ) -> dto.VysionResponse:
+        url = self._build_api_url__(
+            "victim/search",
+            q=q,
+            lte=lte,
+            gte=gte,
+            page=page,
+            page_size=page_size,
+            network=network,
+            country=country,
+            language=language,
+        )
 
         result = self._make_request(url)
         return result.data
 
-    @vysion_error_manager
-    def find_xmr(
-        self, xmr: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
+    #
+    # Ransomware Stats
+    #
 
-        url = self._build_api_url__("xmr", xmr, page=page, lte=lte, gte=gte)
+    @vysion_error_manager
+    def ransomware_countries_stats(
+        self,
+        gte: datetime = None,
+        lte: datetime = None,
+    ) -> dto.VysionResponse[dto.Stat]:
+        url = self._build_api_url__("stats/countries", gte=gte, lte=lte)
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def find_zec(
-        self, zec: str, page: int = 1, lte: datetime = None, gte: datetime = None
-    ) -> dto.Result:
-
-        url = self._build_api_url__("zec", zec, page=page, lte=lte, gte=gte)
+    def ransomware_groups_stats(
+        self,
+        gte: datetime = None,
+        lte: datetime = None,
+    ) -> dto.VysionResponse[dto.Stat]:
+        url = self._build_api_url__("stats/groups", gte=gte, lte=lte)
 
         result = self._make_request(url)
         return result.data
 
-    # TODO find_domain?
     @vysion_error_manager
-    def find_url(
+    def ransomware_attacks_stats(
         self,
-        query_url: str,
-        page: int = 1,
-        lte: datetime = None,
         gte: datetime = None,
-    ) -> dto.Result:
-
-        url = self._build_api_url__("url", query_url, page=page, lte=lte, gte=gte)
+        lte: datetime = None,
+    ) -> dto.VysionResponse[dto.Stat]:
+        url = self._build_api_url__("stats/attacks", gte=gte, lte=lte)
 
         result = 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.Result:
+    #
+    # IM Search
+    #
 
-        url = self._build_api_url__("email", email, page=page, lte=lte, gte=gte)
+    @vysion_error_manager
+    def search_im(
+        self,
+        platform: str,
+        q: str,
+        gte: datetime = None,
+        lte: datetime = None,
+        page: int = 1,
+        username: str = None,
+    ) -> dto.VysionResponse[dto.ImMessageHit]:
+        url = self._build_api_url__(
+            "im/" + platform + "/search",
+            q=q,
+            gte=gte,
+            lte=lte,
+            page=page,
+            username=username,
+        )
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def get_document(self, document_id: str) -> dto.Result:
-
-        url = self._build_api_url__("document", document_id)
+    def get_im_chat(
+        self, platform: str, channelId: str
+    ) -> dto.VysionResponse[dto.ImMessageHit]:
+        url = self._build_api_url__("im/" + platform + "/chat/", channelId)
 
         result = self._make_request(url)
         return result.data
 
     @vysion_error_manager
-    def get_tag(self, tag: str) -> dto.Result:
-
-        url = self._build_api_url__("tag", tag)
+    def get_im_profile(
+        self, platform: str, userId: str
+    ) -> dto.VysionResponse[dto.ImProfileHit]:
+        url = self._build_api_url__("im/" + platform + "/profile/", userId)
 
         result = self._make_request(url)
         return result.data
-    
-    @vysion_error_manager
-    def get_chat_telegram(
-        self, 
-        channelId: str, 
-        lte:datetime = None,
-        gte: datetime = None, 
-    ) -> dto.Result:
 
-        url = self._build_api_url__("telegram/chat", channelId, lte=lte, gte=gte)
+    @vysion_error_manager
+    def get_im_message(
+        self, platform: str, messageId: str
+    ) -> dto.VysionResponse[dto.ImMessageHit]:
+        url = self._build_api_url__("im/" + platform + "/message/", messageId)
 
         result = self._make_request(url)
         return result.data
-    
-    @vysion_error_manager
-    def get_message_telegram(
-        self, 
-        id: str,
-    ) -> dto.Result:
 
-        url = self._build_api_url__("telegram/message", id)
+    @vysion_error_manager
+    def get_im_channel(
+        self, platform: str, channelId: str
+    ) -> dto.VysionResponse[dto.ImChannelHit]:
+        url = self._build_api_url__("im/" + platform + "/channel/", channelId)
 
         result = self._make_request(url)
         return result.data
 
+    #
     # FEEDS
+    #
+
     @vysion_error_manager
     def consume_feed_ransomware(self, batch_day: datetime = datetime.today()):
         pass
@@ -401,7 +398,6 @@ class DaylyFeed(Client):
 
 class RansomwareFeed(DaylyFeed):
     def _consume_batch(self, start_time, end_time):
-
         days = (datetime.now() - start_time).days
         pages = (end_time - start_time).days
 
@@ -410,4 +406,4 @@ class RansomwareFeed(DaylyFeed):
             yield self._make_request(url)
 
 
-# TODO /api/v1/feeds
+# TODO /api/v1/feeds

{vysion-1.0.15 → vysion-2.0.0}/vysion/client/error.py

@@ -14,7 +14,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 """
-from vysion.dto import VysionError
+from vysion.dto import Error
 
 
 class APIError(Exception):
@@ -28,8 +28,8 @@ class APIError(Exception):
 
         super().__init__()
 
-        if code not in [i.value for i in VysionError.StatusCode]:
-            self.code = VysionError.StatusCode.UNK
+        if code not in [i.value for i in Error.StatusCode]:
+            self.code = Error.StatusCode.UNK
             self.message = f"{message} (Original code: {code})"
         else:
             self.code = code