RTC 386 (#15)

* Add handle_json

* Added usage of webhook_notifier in test_notifier

* Update poetry.lock

* Move linter to test_commands

* Add type_hint in handle_json

* Add step for checking formatting to CI

* Fix lint issues

* Changes after code review

* Fix issues with betterproto

* Return to static IP in docker-compose

* Run formatter (#16)

* Remove static IP from docker-compose

* Fix tests

* Improve poetry commands

* Fix lint and formatter issues

Author: Rados13

.circleci/config.yml

@@ -16,10 +16,13 @@ jobs:
       - checkout
       - run:
           name: Install project dependencies
-          command: poetry install --no-ansi
+          command: poetry install --no-ansi --with=dev
       - run:
           name: Lint
-          command: ./pylint.sh
+          command: poetry run lint
+      - run:
+          name: Check code formatting
+          command: poetry run check_format
       - persist_to_workspace:
           root: ~/project
           paths:
@@ -29,7 +32,7 @@ jobs:
     executor: machine_executor_amd64
     steps:
       - checkout
-      - run: docker compose -f docker-compose-test.yaml run test
+      - run: docker compose -f docker-compose-test.yaml up test --exit-code-from test
 
 
 workflows:

README.md

@@ -91,16 +91,20 @@ asyncio.run(test_notifier())
 
 ## Testing
 
-You can test the SDK against a local instance of Jellyfish by running
+You can test the SDK by running
 ```console
-pytest
+poetry run ci_test
 ```
 
-Make sure to use the default configuration for Jellyfish
-
-Alternatively you can test using Docker
+## Format&Lint
+You can format code by running
 ```console
-docker-compose -f docker-compose-test.yaml run test
+poetry run format
+```
+
+You can check linter by running
+```
+poetry run lint
 ```
 
 ## Copyright and License

docker-compose-test.yaml

@@ -25,25 +25,17 @@ services:
       - "5002:5002"
       - "49999:49999"
       - "50000-50050:50000-50050/udp"
-    networks:
-      - network
 
   test:
+    container_name: test
     image: cimg/python:3.8
-    command: sh -c "cd /app && \
-      poetry config virtualenvs.in-project false && \
-      poetry install --no-ansi && \
-      poetry run pytest -s"
+    command: sh -c "cd /app && \ poetry config virtualenvs.in-project false && \ poetry install --no-ansi && \ poetry run pytest -s"
     environment:
       DOCKER_TEST: "TRUE"
+    ports:
+      - "5000:5000"
     volumes:
       - .:/app
-    networks:
-      - network
     depends_on:
       jellyfish:
         condition: service_healthy
-
-networks:
-  network:
-    driver: bridge

jellyfish/__init__.py

@@ -8,25 +8,52 @@
 
 # API
 from jellyfish._room_api import RoomApi
-from jellyfish._notifier import Notifier
+from jellyfish._ws_notifier import Notifier
+from jellyfish._webhook_notifier import receive_json
 
 # Models
 from jellyfish._openapi_client import (
-    Room, RoomConfig, Peer, Component, ComponentHLS, ComponentRTSP, ComponentOptions,
-    ComponentOptionsRTSP, ComponentOptionsHLS, PeerOptionsWebRTC)
+    Room,
+    RoomConfig,
+    Peer,
+    Component,
+    ComponentHLS,
+    ComponentRTSP,
+    ComponentOptions,
+    ComponentOptionsRTSP,
+    ComponentOptionsHLS,
+    PeerOptionsWebRTC,
+)
 
 # Server Messages
 from jellyfish import events
 
 # Exceptions
 from jellyfish._openapi_client.exceptions import (
-    UnauthorizedException, NotFoundException, BadRequestException)
+    UnauthorizedException,
+    NotFoundException,
+    BadRequestException,
+)
 
 
 __all__ = [
-    'RoomApi', 'Notifier', 'Room', 'Peer', 'Component', 'ComponentHLS', 'ComponentRTSP',
-    'ComponentOptionsHLS', 'RoomConfig', 'ComponentOptions', 'ComponentOptionsRTSP',
-    'PeerOptionsWebRTC', 'events', 'UnauthorizedException', 'NotFoundException',
-    'BadRequestException']
+    "RoomApi",
+    "Notifier",
+    "receive_json",
+    "Room",
+    "Peer",
+    "Component",
+    "ComponentHLS",
+    "ComponentRTSP",
+    "ComponentOptionsHLS",
+    "RoomConfig",
+    "ComponentOptions",
+    "ComponentOptionsRTSP",
+    "PeerOptionsWebRTC",
+    "events",
+    "UnauthorizedException",
+    "NotFoundException",
+    "BadRequestException",
+]
 
 __docformat__ = "restructuredtext"

jellyfish/_openapi_client/__init__.py

@@ -33,7 +33,9 @@
 from jellyfish._openapi_client.models.add_component_request import AddComponentRequest
 from jellyfish._openapi_client.models.add_peer_request import AddPeerRequest
 from jellyfish._openapi_client.models.component import Component
-from jellyfish._openapi_client.models.component_details_response import ComponentDetailsResponse
+from jellyfish._openapi_client.models.component_details_response import (
+    ComponentDetailsResponse,
+)
 from jellyfish._openapi_client.models.component_hls import ComponentHLS
 from jellyfish._openapi_client.models.component_metadata_hls import ComponentMetadataHLS
 from jellyfish._openapi_client.models.component_options import ComponentOptions
@@ -44,13 +46,19 @@
 from jellyfish._openapi_client.models.hls_skip import HlsSkip
 from jellyfish._openapi_client.models.peer import Peer
 from jellyfish._openapi_client.models.peer_details_response import PeerDetailsResponse
-from jellyfish._openapi_client.models.peer_details_response_data import PeerDetailsResponseData
+from jellyfish._openapi_client.models.peer_details_response_data import (
+    PeerDetailsResponseData,
+)
 from jellyfish._openapi_client.models.peer_options import PeerOptions
 from jellyfish._openapi_client.models.peer_options_web_rtc import PeerOptionsWebRTC
 from jellyfish._openapi_client.models.peer_status import PeerStatus
 from jellyfish._openapi_client.models.room import Room
 from jellyfish._openapi_client.models.room_config import RoomConfig
-from jellyfish._openapi_client.models.room_create_details_response import RoomCreateDetailsResponse
-from jellyfish._openapi_client.models.room_create_details_response_data import RoomCreateDetailsResponseData
+from jellyfish._openapi_client.models.room_create_details_response import (
+    RoomCreateDetailsResponse,
+)
+from jellyfish._openapi_client.models.room_create_details_response_data import (
+    RoomCreateDetailsResponseData,
+)
 from jellyfish._openapi_client.models.room_details_response import RoomDetailsResponse
 from jellyfish._openapi_client.models.rooms_listing_response import RoomsListingResponse

jellyfish/_openapi_client/api/__init__.py

@@ -3,4 +3,3 @@
 # import apis into api package
 from jellyfish._openapi_client.api.default_api import DefaultApi
 from jellyfish._openapi_client.api.room_api import RoomApi
-