Skip to content

Fix method to enable in-home doorbell chime #419

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdb9696 merged 8 commits into from
Sep 2, 2024
Merged

Fix method to enable in-home doorbell chime #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
82088d9
Changing existing_doorbell_type_enabled from bool to int
briangoldstein Aug 30, 2024
bd37102
Merge branch 'tchellomello:master' into master
briangoldstein Aug 30, 2024
2d5d4cc
replacing with latest const.py from main repo
briangoldstein Aug 30, 2024
ea3fb07
Update const.py
briangoldstein Aug 30, 2024
7cd4a0c
Update doorbot.py
briangoldstein Aug 30, 2024
1591eb1
Switching back to bool and converting to int in the function
briangoldstein Aug 30, 2024
548af2d
Adding test for async_set_existing_doorbell_type_enabled
briangoldstein Sep 2, 2024
4706f9e
Add asserts and extra test steps
sdb9696 Sep 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions ring_doorbell/doorbot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,11 +221,14 @@ async def async_set_existing_doorbell_type_enabled(self, value: bool) -> None:
raise RingError(MSG_BOOLEAN_REQUIRED)

if self.existing_doorbell_type == DOORBELL_EXISTING_TYPE[2]:
return
msg = "In-Home chime is not present."
raise RingError(msg)

int_value = int(value)

params = {
"doorbot[description]": self.name,
"doorbot[settings][chime_settings][enable]": value,
"doorbot[settings][chime_settings][enable]": int_value,
}
url = DOORBELLS_ENDPOINT.format(self.device_api_id)
await self._ring.async_query(url, extra_params=params, method="PUT")
Expand Down
61 changes: 60 additions & 1 deletion tests/test_ring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import pytest
from freezegun.api import FrozenDateTimeFactory
from ring_doorbell import Auth, Ring, RingError
from ring_doorbell.const import USER_AGENT
from ring_doorbell.const import MSG_EXISTING_TYPE, USER_AGENT
from ring_doorbell.util import parse_datetime

from .conftest import json_request_kwargs, load_fixture_as_dict, nojson_request_kwargs
Expand Down Expand Up @@ -289,3 +289,62 @@ def test_sync_queries_with_no_event_loop():

with pytest.deprecated_call():
auth.close()


async def test_set_existing_doorbell_type(ring, aioresponses_mock):
data = ring.devices()
dev = data["doorbots"][0]
assert dev.existing_doorbell_type == "Mechanical"

kwargs = nojson_request_kwargs()

aioresponses_mock.requests.clear()
# Attempting to turn off the in-home chime
await dev.async_set_existing_doorbell_type_enabled(value=False)
kwargs["params"] = {
"doorbot[description]": dev.name,
"doorbot[settings][chime_settings][enable]": 0,
}
aioresponses_mock.assert_called_with(
url="https://api.ring.com/clients_api/doorbots/987652",
method="PUT",
**kwargs,
)

aioresponses_mock.requests.clear()
# Attempting to turn on the in-home chime
await dev.async_set_existing_doorbell_type_enabled(value=True)
kwargs["params"] = {
"doorbot[description]": dev.name,
"doorbot[settings][chime_settings][enable]": 1,
}
aioresponses_mock.assert_called_with(
url="https://api.ring.com/clients_api/doorbots/987652",
method="PUT",
**kwargs,
)

aioresponses_mock.requests.clear()
# Attempting to set the doorbell type
await dev.async_set_existing_doorbell_type(2)
kwargs["params"] = {
"doorbot[description]": dev.name,
"doorbot[settings][chime_settings][type]": 2,
}
aioresponses_mock.assert_called_with(
url="https://api.ring.com/clients_api/doorbots/987652",
method="PUT",
**kwargs,
)

# Attempting to enable when no chime present
settings = dev._attrs["settings"]["chime_settings"]
settings["type"] = 2
assert dev.existing_doorbell_type == "Not Present"

with pytest.raises(RingError, match="In-Home chime is not present."):
await dev.async_set_existing_doorbell_type_enabled(value=True)

# Attempting to set the doorbell type to an invalid value
with pytest.raises(RingError, match=f"value must be in {MSG_EXISTING_TYPE}"):
await dev.async_set_existing_doorbell_type(4)