Skip to content

Add initial rest query params #42198

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
bdraco merged 12 commits into from
Nov 11, 2020
Merged

Add initial rest query params #42198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a26009b
add initial rest query params
Oct 22, 2020
c1af025
of course I didn't run black
Oct 22, 2020
c215bd8
fix tests
Oct 22, 2020
a1fb885
merge
Oct 22, 2020
8f3c0f5
fix tests
Oct 22, 2020
e4c14ea
add test
Oct 22, 2020
53dbe70
reformat
Oct 22, 2020
912f274
add binary sensor test
Oct 22, 2020
c31cdb2
fix tests
Oct 22, 2020
e300851
add one more test and fix switch
Oct 22, 2020
d005616
should not have touched that
Oct 22, 2020
fb4654c
if you don't pay attention once
Oct 22, 2020
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
2 changes: 1 addition & 1 deletion homeassistant/components/pvoutput/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
verify_ssl = DEFAULT_VERIFY_SSL
headers = {"X-Pvoutput-Apikey": api_key, "X-Pvoutput-SystemId": system_id}

rest = RestData(method, _ENDPOINT, auth, headers, payload, verify_ssl)
rest = RestData(method, _ENDPOINT, auth, headers, None, payload, verify_ssl)
await rest.async_update()

if rest.data is None:
Expand Down
7 changes: 6 additions & 1 deletion homeassistant/components/rest/binary_sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
CONF_HEADERS,
CONF_METHOD,
CONF_NAME,
CONF_PARAMS,
CONF_PASSWORD,
CONF_PAYLOAD,
CONF_RESOURCE,
Expand Down Expand Up @@ -45,6 +46,7 @@
[HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]
),
vol.Optional(CONF_HEADERS): {cv.string: cv.string},
vol.Optional(CONF_PARAMS): {cv.string: cv.string},
vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(["POST", "GET"]),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_PASSWORD): cv.string,
Expand Down Expand Up @@ -78,6 +80,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
headers = config.get(CONF_HEADERS)
params = config.get(CONF_PARAMS)
device_class = config.get(CONF_DEVICE_CLASS)
value_template = config.get(CONF_VALUE_TEMPLATE)
force_update = config.get(CONF_FORCE_UPDATE)
Expand All @@ -97,7 +100,9 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
else:
auth = None

rest = RestData(method, resource, auth, headers, payload, verify_ssl, timeout)
rest = RestData(
method, resource, auth, headers, params, payload, verify_ssl, timeout
)
await rest.async_update()
if rest.data is None:
raise PlatformNotReady
Expand Down
3 changes: 3 additions & 0 deletions homeassistant/components/rest/data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ def __init__(
resource,
auth,
headers,
params,
data,
verify_ssl,
timeout=DEFAULT_TIMEOUT,
Expand All @@ -26,6 +27,7 @@ def __init__(
self._resource = resource
self._auth = auth
self._headers = headers
self._params = params
self._request_data = data
self._timeout = timeout
self._verify_ssl = verify_ssl
Expand Down Expand Up @@ -53,6 +55,7 @@ async def async_update(self):
self._method,
self._resource,
headers=self._headers,
params=self._params,
auth=self._auth,
data=self._request_data,
timeout=self._timeout,
Expand Down
10 changes: 9 additions & 1 deletion homeassistant/components/rest/notify.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
CONF_HEADERS,
CONF_METHOD,
CONF_NAME,
CONF_PARAMS,
CONF_PASSWORD,
CONF_RESOURCE,
CONF_USERNAME,
Expand Down Expand Up @@ -51,6 +52,7 @@
["POST", "GET", "POST_JSON"]
),
vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}),
vol.Optional(CONF_PARAMS): vol.Schema({cv.string: cv.string}),
vol.Optional(CONF_NAME): cv.string,
vol.Optional(CONF_TARGET_PARAMETER_NAME): cv.string,
vol.Optional(CONF_TITLE_PARAMETER_NAME): cv.string,
Expand All @@ -75,6 +77,7 @@ def get_service(hass, config, discovery_info=None):
resource = config.get(CONF_RESOURCE)
method = config.get(CONF_METHOD)
headers = config.get(CONF_HEADERS)
params = config.get(CONF_PARAMS)
message_param_name = config.get(CONF_MESSAGE_PARAMETER_NAME)
title_param_name = config.get(CONF_TITLE_PARAMETER_NAME)
target_param_name = config.get(CONF_TARGET_PARAMETER_NAME)
Expand All @@ -97,6 +100,7 @@ def get_service(hass, config, discovery_info=None):
resource,
method,
headers,
params,
message_param_name,
title_param_name,
target_param_name,
Expand All @@ -116,6 +120,7 @@ def __init__(
resource,
method,
headers,
params,
message_param_name,
title_param_name,
target_param_name,
Expand All @@ -129,6 +134,7 @@ def __init__(
self._hass = hass
self._method = method.upper()
self._headers = headers
self._params = params
self._message_param_name = message_param_name
self._title_param_name = title_param_name
self._target_param_name = target_param_name
Expand Down Expand Up @@ -171,6 +177,7 @@ def _data_template_creator(value):
response = requests.post(
self._resource,
headers=self._headers,
params=self._params,
data=data,
timeout=10,
auth=self._auth,
Expand All @@ -180,6 +187,7 @@ def _data_template_creator(value):
response = requests.post(
self._resource,
headers=self._headers,
params=self._params,
json=data,
timeout=10,
auth=self._auth,
Expand All @@ -189,7 +197,7 @@ def _data_template_creator(value):
response = requests.get(
self._resource,
headers=self._headers,
params=data,
params=self._params.update(data),
timeout=10,
auth=self._auth,
verify=self._verify_ssl,
Expand Down
7 changes: 6 additions & 1 deletion homeassistant/components/rest/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
CONF_HEADERS,
CONF_METHOD,
CONF_NAME,
CONF_PARAMS,
CONF_PASSWORD,
CONF_PAYLOAD,
CONF_RESOURCE,
Expand Down Expand Up @@ -56,6 +57,7 @@
[HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]
),
vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}),
vol.Optional(CONF_PARAMS): vol.Schema({cv.string: cv.string}),
vol.Optional(CONF_JSON_ATTRS, default=[]): cv.ensure_list_csv,
vol.Optional(CONF_METHOD, default=DEFAULT_METHOD): vol.In(METHODS),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
Expand Down Expand Up @@ -90,6 +92,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
headers = config.get(CONF_HEADERS)
params = config.get(CONF_PARAMS)
unit = config.get(CONF_UNIT_OF_MEASUREMENT)
device_class = config.get(CONF_DEVICE_CLASS)
value_template = config.get(CONF_VALUE_TEMPLATE)
Expand All @@ -112,7 +115,9 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
auth = (username, password)
else:
auth = None
rest = RestData(method, resource, auth, headers, payload, verify_ssl, timeout)
rest = RestData(
method, resource, auth, headers, params, payload, verify_ssl, timeout
)
await rest.async_update()

if rest.data is None:
Expand Down
12 changes: 11 additions & 1 deletion homeassistant/components/rest/switch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
CONF_HEADERS,
CONF_METHOD,
CONF_NAME,
CONF_PARAMS,
CONF_PASSWORD,
CONF_RESOURCE,
CONF_TIMEOUT,
Expand Down Expand Up @@ -46,6 +47,7 @@
vol.Required(CONF_RESOURCE): cv.url,
vol.Optional(CONF_STATE_RESOURCE): cv.url,
vol.Optional(CONF_HEADERS): {cv.string: cv.string},
vol.Optional(CONF_PARAMS): {cv.string: cv.string},
vol.Optional(CONF_BODY_OFF, default=DEFAULT_BODY_OFF): cv.template,
vol.Optional(CONF_BODY_ON, default=DEFAULT_BODY_ON): cv.template,
vol.Optional(CONF_IS_ON_TEMPLATE): cv.template,
Expand All @@ -71,6 +73,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
is_on_template = config.get(CONF_IS_ON_TEMPLATE)
method = config.get(CONF_METHOD)
headers = config.get(CONF_HEADERS)
params = config.get(CONF_PARAMS)
name = config.get(CONF_NAME)
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
Expand All @@ -97,6 +100,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
state_resource,
method,
headers,
params,
auth,
body_on,
body_off,
Expand Down Expand Up @@ -129,6 +133,7 @@ def __init__(
state_resource,
method,
headers,
params,
auth,
body_on,
body_off,
Expand All @@ -143,6 +148,7 @@ def __init__(
self._state_resource = state_resource
self._method = method
self._headers = headers
self._params = params
self._auth = auth
self._body_on = body_on
self._body_off = body_off
Expand Down Expand Up @@ -201,6 +207,7 @@ async def set_device_state(self, body):
auth=self._auth,
data=bytes(body, "utf-8"),
headers=self._headers,
params=self._params,
)
return req

Expand All @@ -219,7 +226,10 @@ async def get_device_state(self, hass):

with async_timeout.timeout(self._timeout):
req = await websession.get(
self._state_resource, auth=self._auth, headers=self._headers
self._state_resource,
auth=self._auth,
headers=self._headers,
params=self._params,
)
text = await req.text()

Expand Down
2 changes: 1 addition & 1 deletion homeassistant/components/scrape/sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ async def async_setup_platform(hass, config, async_add_entities, discovery_info=
auth = HTTPBasicAuth(username, password)
else:
auth = None
rest = RestData(method, resource, auth, headers, payload, verify_ssl)
rest = RestData(method, resource, auth, headers, None, payload, verify_ssl)
await rest.async_update()

if rest.data is None:
Expand Down
1 change: 1 addition & 0 deletions homeassistant/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@
CONF_OFFSET = "offset"
CONF_OPTIMISTIC = "optimistic"
CONF_PACKAGES = "packages"
CONF_PARAMS = "params"
Copy link
Copy Markdown
Member

@fabaff fabaff Oct 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be parameters.

Suggested change
CONF_PARAMS = "params"
CONF_PARAMETERS = "parameters"

Copy link
Copy Markdown
Contributor Author

@boxcee boxcee Oct 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naming is directly taken from httpx. requests uses the same naming.

Copy link
Copy Markdown
Contributor Author

@boxcee boxcee Oct 30, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fabaff

CONF_PASSWORD = "password"
CONF_PATH = "path"
CONF_PAYLOAD = "payload"
Expand Down
23 changes: 23 additions & 0 deletions tests/components/rest/test_binary_sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,5 +377,28 @@ async def test_reload(hass):
assert hass.states.get("binary_sensor.rollout")


@respx.mock
async def test_setup_query_params(hass):
"""Test setup with query params."""
respx.get(
"http://localhost?search=something",
status_code=200,
)
assert await async_setup_component(
hass,
binary_sensor.DOMAIN,
{
"binary_sensor": {
"platform": "rest",
"resource": "http://localhost",
"method": "GET",
"params": {"search": "something"},
}
},
)
await hass.async_block_till_done()
assert len(hass.states.async_all()) == 1


def _get_fixtures_base_path():
return path.dirname(path.dirname(path.dirname(__file__)))
23 changes: 23 additions & 0 deletions tests/components/rest/test_sensor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,29 @@ async def test_setup_get_xml(hass):
assert state.attributes[ATTR_UNIT_OF_MEASUREMENT] == DATA_MEGABYTES


@respx.mock
async def test_setup_query_params(hass):
"""Test setup with query params."""
respx.get(
"http://localhost?search=something",
status_code=200,
)
assert await async_setup_component(
hass,
sensor.DOMAIN,
{
"sensor": {
"platform": "rest",
"resource": "http://localhost",
"method": "GET",
"params": {"search": "something"},
}
},
)
await hass.async_block_till_done()
assert len(hass.states.async_all()) == 1


@respx.mock
async def test_update_with_json_attrs(hass):
"""Test attributes get extracted from a JSON result."""
Expand Down
22 changes: 22 additions & 0 deletions tests/components/rest/test_switch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
from homeassistant.const import (
CONF_HEADERS,
CONF_NAME,
CONF_PARAMS,
CONF_PLATFORM,
CONF_RESOURCE,
CONTENT_TYPE_JSON,
Expand All @@ -28,6 +29,7 @@
STATE_RESOURCE = RESOURCE
HEADERS = {"Content-type": CONTENT_TYPE_JSON}
AUTH = None
PARAMS = None


async def test_setup_missing_config(hass):
Expand Down Expand Up @@ -81,6 +83,25 @@ async def test_setup_minimum(hass, aioclient_mock):
assert aioclient_mock.call_count == 1


async def test_setup_query_params(hass, aioclient_mock):
"""Test setup with query params."""
aioclient_mock.get("http://localhost/?search=something", status=HTTP_OK)
with assert_setup_component(1, SWITCH_DOMAIN):
assert await async_setup_component(
hass,
SWITCH_DOMAIN,
{
SWITCH_DOMAIN: {
CONF_PLATFORM: rest.DOMAIN,
CONF_RESOURCE: "http://localhost",
CONF_PARAMS: {"search": "something"},
}
},
)
print(aioclient_mock)
assert aioclient_mock.call_count == 1


async def test_setup(hass, aioclient_mock):
"""Test setup with valid configuration."""
aioclient_mock.get("http://localhost", status=HTTP_OK)
Expand Down Expand Up @@ -137,6 +158,7 @@ def _setup_test_switch(hass):
STATE_RESOURCE,
METHOD,
HEADERS,
PARAMS,
AUTH,
body_on,
body_off,
Expand Down