evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #10079 from home-assistant/scrape-auth

Browse source 
Add support for HTTP Basic/Digest authentication
This commit is contained in:
Pascal Vizeli 2017-10-24 12:21:44 +02:00 • committed by GitHub
commit 179655b6b0
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
homeassistant/components/sensor/scrape.py
View file

@ -7,12 +7,15 @@ https://home-assistant.io/components/sensor.scrape/
import logging import logging
import voluptuous as vol import voluptuous as vol
from requests.auth import HTTPBasicAuth, HTTPDigestAuth
from homeassistant.components.sensor import PLATFORM_SCHEMA from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.components.sensor.rest import RestData from homeassistant.components.sensor.rest import RestData
from homeassistant.const import ( from homeassistant.const import (
CONF_NAME, CONF_RESOURCE, CONF_UNIT_OF_MEASUREMENT, STATE_UNKNOWN, CONF_NAME, CONF_RESOURCE, CONF_UNIT_OF_MEASUREMENT, STATE_UNKNOWN,
CONF_VALUE_TEMPLATE, CONF_VERIFY_SSL) CONF_VALUE_TEMPLATE, CONF_VERIFY_SSL, CONF_USERNAME,
CONF_PASSWORD, CONF_AUTHENTICATION, HTTP_BASIC_AUTHENTICATION,
HTTP_DIGEST_AUTHENTICATION)
from homeassistant.helpers.entity import Entity from homeassistant.helpers.entity import Entity
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
@ -30,8 +33,12 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_RESOURCE): cv.string, vol.Required(CONF_RESOURCE): cv.string,
vol.Required(CONF_SELECT): cv.string, vol.Required(CONF_SELECT): cv.string,
vol.Optional(CONF_ATTR): cv.string, vol.Optional(CONF_ATTR): cv.string,
vol.Optional(CONF_AUTHENTICATION):
vol.In([HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]),
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_PASSWORD): cv.string,
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string, vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
vol.Optional(CONF_USERNAME): cv.string,
vol.Optional(CONF_VALUE_TEMPLATE): cv.template, vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean, vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
}) })
@ -42,15 +49,24 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
name = config.get(CONF_NAME) name = config.get(CONF_NAME)
resource = config.get(CONF_RESOURCE) resource = config.get(CONF_RESOURCE)
method = 'GET' method = 'GET'
payload = auth = headers = None payload = headers = None
verify_ssl = config.get(CONF_VERIFY_SSL) verify_ssl = config.get(CONF_VERIFY_SSL)
select = config.get(CONF_SELECT) select = config.get(CONF_SELECT)
attr = config.get(CONF_ATTR) attr = config.get(CONF_ATTR)
unit = config.get(CONF_UNIT_OF_MEASUREMENT) unit = config.get(CONF_UNIT_OF_MEASUREMENT)
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
value_template = config.get(CONF_VALUE_TEMPLATE) value_template = config.get(CONF_VALUE_TEMPLATE)
if value_template is not None: if value_template is not None:
value_template.hass = hass value_template.hass = hass
if username and password:
if config.get(CONF_AUTHENTICATION) == HTTP_DIGEST_AUTHENTICATION:
auth = HTTPDigestAuth(username, password)
else:
auth = HTTPBasicAuth(username, password)
else:
auth = None
rest = RestData(method, resource, auth, headers, payload, verify_ssl) rest = RestData(method, resource, auth, headers, payload, verify_ssl)
rest.update() rest.update()
@ -59,14 +75,13 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
return False return False
add_devices([ add_devices([
ScrapeSensor(hass, rest, name, select, attr, value_template, unit) ScrapeSensor(rest, name, select, attr, value_template, unit)], True)
], True)
class ScrapeSensor(Entity): class ScrapeSensor(Entity):
"""Representation of a web scrape sensor.""" """Representation of a web scrape sensor."""
def __init__(self, hass, rest, name, select, attr, value_template, unit): def __init__(self, rest, name, select, attr, value_template, unit):
"""Initialize a web scrape sensor.""" """Initialize a web scrape sensor."""
self.rest = rest self.rest = rest
self._name = name self._name = name