From 64cb65a04edd3467ba02b0a19b961b447f9f25e2 Mon Sep 17 00:00:00 2001
From: happyleavesaoc <happyleaves.tfr@gmail.com>
Date: Sun, 12 Feb 2017 15:47:27 -0500
Subject: [PATCH] fedex sensor (#5891)
* fedex sensor
* fix fedex requirement
---
.coveragerc | 1 +
homeassistant/components/sensor/fedex.py | 105 +++++++++++++++++++++++
requirements_all.txt | 3 +
3 files changed, 109 insertions(+)
create mode 100644 homeassistant/components/sensor/fedex.py
diff --git a/.coveragerc b/.coveragerc
index 72acf1b91a1..771cdcfe85b 100644
--- a/.coveragerc
+++ b/.coveragerc
@@ -303,6 +303,7 @@ omit =
homeassistant/components/sensor/eliqonline.py
homeassistant/components/sensor/emoncms.py
homeassistant/components/sensor/fastdotcom.py
+ homeassistant/components/sensor/fedex.py
homeassistant/components/sensor/fitbit.py
homeassistant/components/sensor/fixer.py
homeassistant/components/sensor/fritzbox_callmonitor.py
diff --git a/homeassistant/components/sensor/fedex.py b/homeassistant/components/sensor/fedex.py
new file mode 100644
index 00000000000..a0b5bbf5a0a
--- /dev/null
+++ b/homeassistant/components/sensor/fedex.py
@@ -0,0 +1,105 @@
+"""
+Sensor for Fedex packages.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.usps/
+"""
+from collections import defaultdict
+import logging
+from datetime import timedelta
+
+import voluptuous as vol
+
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import (CONF_NAME, CONF_USERNAME, CONF_PASSWORD,
+ ATTR_ATTRIBUTION)
+from homeassistant.helpers.entity import Entity
+from homeassistant.util import slugify
+from homeassistant.util import Throttle
+from homeassistant.util.dt import now, parse_date
+import homeassistant.helpers.config_validation as cv
+
+REQUIREMENTS = ['fedexdeliverymanager==1.0.1']
+
+_LOGGER = logging.getLogger(__name__)
+
+DOMAIN = 'fedex'
+COOKIE = 'fedexdeliverymanager_cookies.pickle'
+CONF_UPDATE_INTERVAL = 'update_interval'
+ICON = 'mdi:package-variant-closed'
+STATUS_DELIVERED = 'delivered'
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+ vol.Required(CONF_USERNAME): cv.string,
+ vol.Required(CONF_PASSWORD): cv.string,
+ vol.Optional(CONF_NAME): cv.string,
+ vol.Optional(CONF_UPDATE_INTERVAL, default=timedelta(seconds=1800)): (
+ vol.All(cv.time_period, cv.positive_timedelta)),
+})
+
+
+# pylint: disable=unused-argument
+def setup_platform(hass, config, add_devices, discovery_info=None):
+ """Setup the Fedex platform."""
+ import fedexdeliverymanager
+ try:
+ cookie = hass.config.path(COOKIE)
+ session = fedexdeliverymanager.get_session(config.get(CONF_USERNAME),
+ config.get(CONF_PASSWORD),
+ cookie_path=cookie)
+ except fedexdeliverymanager.FedexError:
+ _LOGGER.exception('Could not connect to Fedex Delivery Manager')
+ return False
+
+ add_devices([FedexSensor(session, config.get(CONF_NAME),
+ config.get(CONF_UPDATE_INTERVAL))])
+
+
+class FedexSensor(Entity):
+ """Fedex Sensor."""
+
+ def __init__(self, session, name, interval):
+ """Initialize the sensor."""
+ self._session = session
+ self._name = name
+ self._attributes = None
+ self._state = None
+ self.update = Throttle(interval)(self._update)
+ self.update()
+
+ @property
+ def name(self):
+ """Return the name of the sensor."""
+ return self._name or DOMAIN
+
+ @property
+ def state(self):
+ """Return the state of the sensor."""
+ return self._state
+
+ def _update(self):
+ """Update device state."""
+ import fedexdeliverymanager
+ status_counts = defaultdict(int)
+ for package in fedexdeliverymanager.get_packages(self._session):
+ status = slugify(package['primary_status'])
+ skip = status == STATUS_DELIVERED and \
+ parse_date(package['delivery_date']) < now().date()
+ if skip:
+ continue
+ status_counts[status] += 1
+ self._attributes = {
+ ATTR_ATTRIBUTION: fedexdeliverymanager.ATTRIBUTION
+ }
+ self._attributes.update(status_counts)
+ self._state = sum(status_counts.values())
+
+ @property
+ def device_state_attributes(self):
+ """Return the state attributes."""
+ return self._attributes
+
+ @property
+ def icon(self):
+ """Icon to use in the frontend."""
+ return ICON
diff --git a/requirements_all.txt b/requirements_all.txt
index 36a6a978231..b80726e5e3a 100755
--- a/requirements_all.txt
+++ b/requirements_all.txt
@@ -137,6 +137,9 @@ evohomeclient==0.2.5
# homeassistant.components.sensor.fastdotcom
fastdotcom==0.0.1
+# homeassistant.components.sensor.fedex
+fedexdeliverymanager==1.0.1
+
# homeassistant.components.feedreader
feedparser==5.2.1
--
GitLab