python-ring-doorbell · sdb9696 · Sep 25, 2024 · Sep 25, 2024 · Sep 25, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -50,7 +50,7 @@ jobs:
           uv run make -C docs html
 
   tests:
-    name: Tests - Python ${{ matrix.python-version}} on ${{ matrix.os }}${{ fromJSON('[" (listen)", ""]')[matrix.extras == ''] }}
+    name: Tests - Python ${{ matrix.python-version}} on ${{ matrix.os }}
     needs: linting
     runs-on: ubuntu-latest
     strategy:
@@ -83,7 +83,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           uv-version: ${{ env.UV_VERSION }}
-          uv-install-options: ${{ matrix.extras == true && '--extra listen' || '' }}
       - name: Run tests
         run: >
           uv run pytest tests/

diff --git a/README.rst b/README.rst
@@ -44,16 +44,6 @@ Installation
     $ pip install \
         git+https://github.com/python-ring-doorbell/python-ring-doorbell@master
 
-Event Listener
-++++++++++++++
-
-If you want the ring api to listen for push events from ring.com for dings and motion you
-will need to install with the `listen` extra::
-
-    $ pip install ring_doorbell[listen]
-
-The api will then start listening for push events after you have first called `update_dings()`
-or `update_data()` but only if there is a running `asyncio <https://docs.python.org/3/library/asyncio.html>`_ event loop (which there will be if using the CLI)
 
 Using the CLI
 -------------
@@ -180,7 +170,14 @@ For the deprecated sync example see `test_sync.py <https://github.com/python-rin
     if __name__ == "__main__":
         asyncio.run(main())
 
+Event Listener
+++++++++++++++
+
+.. code-block:: python
 
+    event_listener = RingEventListener(ring, credentials, credentials_updated_callback)
+    event_listener.add_notification_callback(_event_handler(ring).on_event)
+    await event_listener.start()
 
 Listing devices linked to your account
 ++++++++++++++++++++++++++++++++++++++

diff --git a/pyproject.toml b/pyproject.toml
@@ -14,7 +14,8 @@ dependencies = [
     "aiofiles>=23",
     "typing-extensions>=4.12.2,<5.0",
     "async-timeout>=3.0.0",
-    "websockets>=11.0.1"
+    "websockets>=11.0.1",
+    "firebase-messaging>=0.4.0",
 ]
 
 keywords = [
@@ -48,7 +49,6 @@ ring-doorbell = "ring_doorbell.cli:cli"
 
 [project.optional-dependencies]
 docs = ["sphinx<7.2.6", "sphinx-rtd-theme~=1.3", "myst-parser"]
-listen = ["firebase-messaging~=0.4"]
 
 [build-system]
 requires = ["hatchling"]

diff --git a/ring_doorbell/__init__.py b/ring_doorbell/__init__.py
@@ -17,6 +17,7 @@
 )
 from ring_doorbell.generic import RingGeneric
 from ring_doorbell.group import RingLightGroup
+from ring_doorbell.listen import RingEventListener, RingEventListenerConfig
 from ring_doorbell.other import RingOther
 from ring_doorbell.ring import Ring, RingDevices
 from ring_doorbell.stickup_cam import RingStickUpCam
@@ -33,6 +34,8 @@
     "RingDoorBell",
     "RingOther",
     "RingEvent",
+    "RingEventListener",
+    "RingEventListenerConfig",
     "RingError",
     "AuthenticationError",
     "Requires2FAError",

diff --git a/ring_doorbell/cli.py b/ring_doorbell/cli.py
@@ -35,7 +35,6 @@
     USER_AGENT,
     DOORBELL_EXISTING_TYPE,
 )
-from ring_doorbell.listen import can_listen
 
 
 def _header() -> None:
@@ -286,9 +285,9 @@ async def cli(ctx, username, password, debug, user_agent):
     log_level = logging.DEBUG if debug else logging.INFO
     logger = logging.getLogger(PACKAGE_NAME)
     logger.setLevel(log_level)
-    if can_listen:
-        logger = logging.getLogger("firebase_messaging")
-        logger.setLevel(log_level)
+
+    logger = logging.getLogger("firebase_messaging")
+    logger.setLevel(log_level)
 
     no_update_commands = ["listen"]
     no_update = ctx.invoked_subcommand in no_update_commands
@@ -873,10 +872,6 @@ async def listen(
     show_credentials,
 ) -> None:
     """Listen to push notification like the ones sent to your phone."""
-    if not can_listen:
-        echo("Ring is not configured for listening to notifications!")
-        echo("pip install ring_doorbell[listen]")
-        return
 
     from ring_doorbell.listen import (  # pylint:disable=import-outside-toplevel
         RingEventListener,

diff --git a/ring_doorbell/listen/__init__.py b/ring_doorbell/listen/__init__.py
@@ -1,12 +1,11 @@
 """Package for listener modules."""
 
-try:
-    from .eventlistener import RingEventListener
-    from .listenerconfig import RingEventListenerConfig
+from .eventlistener import RingEventListener
+from .listenerconfig import RingEventListenerConfig
 
-    can_listen = True
-except ImportError:  # pragma: no cover
-    can_listen = False  # pylint:disable=invalid-name
+# can_listen used to be checkable to see if the optional listen extra installed.
+# Now installed as default.
+can_listen = True
 
 __all__ = [
     "RingEventListener",

diff --git a/tests/conftest.py b/tests/conftest.py
@@ -12,7 +12,6 @@
 from aioresponses import CallbackResult, aioresponses
 from ring_doorbell import Auth, Ring
 from ring_doorbell.const import USER_AGENT
-from ring_doorbell.listen import can_listen
 
 
 # The kwargs below are useful for request assertions
@@ -130,7 +129,7 @@ def load_alert_v2(
 
 @pytest.fixture(autouse=True)
 def _listen_mock(mocker, request) -> None:
-    if not can_listen or "nolistenmock" in request.keywords:
+    if "nolistenmock" in request.keywords:
         return
 
     mocker.patch(

diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -24,7 +24,6 @@
     videos,
 )
 from ring_doorbell.const import GCM_TOKEN_FILE
-from ring_doorbell.listen import can_listen
 
 from tests.conftest import (
     load_alert_v1,
@@ -207,9 +206,6 @@ async def test_motion_detection(ring, aioresponses_mock, devices_fixture):
         assert expected in res.output
 
 
-@pytest.mark.skipif(
-    can_listen is False, reason="requires the extra [listen] to be installed"
-)
 @pytest.mark.nolistenmock
 async def test_listen_store_credentials(mocker, auth):
     runner = CliRunner()
@@ -247,9 +243,6 @@ async def test_listen_store_credentials(mocker, auth):
         assert firebase_messaging.FcmPushClient.start.call_count == 2
 
 
-@pytest.mark.skipif(
-    can_listen is False, reason="requires the extra [listen] to be installed"
-)
 async def test_listen_event_handler(mocker, auth):
     from ring_doorbell.listen import RingEventListener
 

diff --git a/tests/test_listen.py b/tests/test_listen.py
@@ -7,18 +7,10 @@
 from freezegun.api import FrozenDateTimeFactory
 from ring_doorbell import Ring
 from ring_doorbell.exceptions import RingError
-from ring_doorbell.listen import can_listen
+from ring_doorbell.listen import RingEventListener
 
 from tests.conftest import load_alert_v1, load_alert_v2, load_fixture
 
-# test_module.py
-pytestmark = pytest.mark.skipif(
-    can_listen is False, reason=("requires the extra [listen] to be installed")
-)
-
-if can_listen:
-    from ring_doorbell.listen import RingEventListener
-
 
 async def test_listen(auth, mocker):
     import firebase_messaging

diff --git a/uv.lock b/uv.lock