Adding USCIS component by meauxt · Pull Request #13764 · home-assistant/core

meauxt · 2018-04-08T18:07:54Z

Description:

This component will fetch the lastest status on case from USCIS on daily basis

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#5138>

Example entry for `configuration.yaml` (if applicable):

sensor:
  - platform: uscis
    case_id: case_number
    friendly_name: optionalname

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

New dependencies have been added to the REQUIREMENTS variable (example).
- New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New dependencies are only imported inside functions that use them (example).
New files were added to .coveragerc.

If the code does not interact with devices:

Tests have been added to verify that the new code works.

balloob · 2018-04-09T01:58:40Z

+    APP_RECEIPT_NUM = "appReceiptNum"
+    INIT_CASE_SEARCH = "initCaseSearch"
+    CASE_STATUS = "CHECK STATUS"
+    UPDATE_TEXT_XPATH = "/html/body/div[2]/form/div/div[1]" \


This is too much protocol specific information and should be extracted into an external package.

balloob · 2018-04-09T02:00:09Z

Did you know that you can signup for a USCIS account and get notified by email/text of changes to your case?

Also, we should check in the terms of the USCIS if they allow being scraped. If not, we should not merge this.

meauxt · 2018-04-09T05:13:26Z

@balloob I updated the component to use uscisstatus package.. also we check did check about the USCIS website term "Information presented on this WWW site is considered public information and may be distributed or copied. ".. i think it should be ready to merge

balloob · 2018-04-09T15:10:09Z

+    else:
+        _LOGGER.error("Setup USCIS Sensor Fail"
+                      " check if your Case ID is Valid")
+    return


Unnecessary return.

balloob · 2018-04-09T15:10:52Z

+        """Using Request to access USCIS website and fetch data."""
+        import uscisstatus
+        try:
+            status, date = uscisstatus.get_case_status(self._case_id)


It's fine because it's a first version, but generally speaking returning a tuple will suck if you want to extend the returned data in the future. Namedtuples are your friend.

balloob · 2018-04-09T15:11:19Z

+            status, date = uscisstatus.get_case_status(self._case_id)
+            self._attributes = {
+                self.CURRENT_STATUS: status,
+                self.LAST_CASE_UPDATE: date


This is already stored as state so shouldn't be an attribute.

meauxt · 2018-04-09T23:00:26Z

@balloob changes has been made

syssi · 2018-04-10T06:17:01Z

+        """Return the state attributes."""
+        return self._attributes
+
+    @Throttle(HOURS_TO_UPDATE)


Could you call the const MIN_TIME_BETWEEN_UPDATES and move the declaration to the top of the component? Just to be in sync with other sensors.

I did name it like this because timedelta has hour=24so i thought would be better to have it as HOUR_TO_UPDATE instead but if you still think it's better to rename it just let me know @syssi

@meauxt We use MIN_TIME_BETWEEN_UPDATES everywhere and that can accommodate any time units (hours, minutes, seconds). It may be better, for the sake of consistency, to use the same label.

@syssi @arsaboo I did update the name of the the variable, Thank you!

syssi · 2018-04-10T06:21:25Z

+            self._attributes = {
+                self.CURRENT_STATUS: status['status']
+            }
+            self._state = status['date']


Why do you return the date as state? The status looks like more important to me. I don't know USCIS. ;-) Could you provide some example output here?

@syssi The date indicates last update. The actual status is quite verbose and beyond the 255 chars limit. More importantly, the status update text may not be very useful for automation. Here's an example of a status message:
On March 8, 2018, we accepted the fingerprint fee for your Form I-485, Application to Register Permanent Residence or Adjust Status, Receipt Number SRCxyz. Our Texas Service Center location is working on your case. We mailed you a notice describing how we will process your case. Please follow the instructions in the notice. If you move, go to USCIS website to give us your new mailing address.

Adding USCIS component

610b329

homeassistant added new-platform platform: sensor.uscis cla-signed labels Apr 8, 2018

meauxt mentioned this pull request Apr 8, 2018

Adding markdown and imagie for USCIS sensor home-assistant/home-assistant.io#5138

Merged

2 tasks

Adding Line after the class DOC

b4d376c

balloob reviewed Apr 9, 2018

View reviewed changes

meauxt added 2 commits April 9, 2018 01:10

Update : Extract USCIS logic code to Component

1ef3fb2

Update : Extract USCIS logic code to Component

edf34b4

Adding CURRENT_STATUS

a01695e

homeassistant added the cla-signed label Apr 9, 2018

balloob reviewed Apr 9, 2018

View reviewed changes

meauxt added 2 commits April 9, 2018 18:07

Change Error handling, remove date from attributes

74d077e

Update the Version for USCIS

5199964

syssi reviewed Apr 10, 2018

View reviewed changes

syssi approved these changes Apr 10, 2018

View reviewed changes

Update uscis.py

ee480aa

homeassistant added the cla-signed label Apr 11, 2018

balloob approved these changes Apr 14, 2018

View reviewed changes

balloob merged commit 99ded8a into home-assistant:dev Apr 14, 2018

balloob mentioned this pull request Apr 27, 2018

0.68 #14124

Merged

home-assistant locked and limited conversation to collaborators Jul 26, 2018

ghost removed the platform: sensor.uscis label Mar 21, 2019

ghost added the integration: uscis label Mar 21, 2019

Uh oh!

Conversation

meauxt commented Apr 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

balloob commented Apr 9, 2018

Uh oh!

meauxt commented Apr 9, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

meauxt commented Apr 9, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arsaboo Apr 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

meauxt commented Apr 8, 2018 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):

arsaboo Apr 10, 2018 •

edited

Loading