Skip to content
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.

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

Update HIBP sensor to use API v3 and API Key #25699

Merged
merged 3 commits into from Aug 9, 2019

Conversation

@aetaric
Copy link
Contributor

commented Aug 5, 2019

Breaking Change:

HaveIBeenPwned API now requires an API key. Said key has a USD$3.50 monthly charge associated.

Description:

HaveIBeenPwned api v2 is being deprecated and API keys are now required. For more info on this: https://www.troyhunt.com/authentication-and-the-have-i-been-pwned-api/
This PR moves the sensor to use V3 and to use the user provided API key.

Related issue (if applicable): fixes #25388

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#9977

Example entry for configuration.yaml (if applicable):

sensor:
  - platform: haveibeenpwned
    email:
      - your_email1@domain.com
      - your_email2@domain.com
    api_key: apikeygoeshere

Checklist:

  • The code change is tested and works locally.
  • Local tests pass with tox. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist

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

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

  • The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

If the code does not interact with devices:

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

This comment has been minimized.

Copy link
Contributor Author

commented Aug 5, 2019

See #25495

@MartinHjelmare

This comment has been minimized.

Copy link
Member

commented Aug 7, 2019

Please run black code formatter.

@MartinHjelmare
Copy link
Member

left a comment

See above.

Dev automation moved this from Needs review to Review in progress Aug 7, 2019

@MartinHjelmare
Copy link
Member

left a comment

Thanks!

Dev automation moved this from Review in progress to Reviewer approved Aug 8, 2019

@MartinHjelmare

This comment has been minimized.

Copy link
Member

commented Aug 8, 2019

@balloob Do we need to release this in a patch release to avoid passing the deadline of 18 August when the old APIs are disabled?

@balloob

This comment has been minimized.

Copy link
Member

commented Aug 9, 2019

Yeah, that sounds right. I will update the release blog post.

@balloob balloob added this to the 0.97.1 milestone Aug 9, 2019

@balloob balloob merged commit a0494e4 into home-assistant:dev Aug 9, 2019

11 checks passed

CI Build #20190808.5 succeeded
Details
CI (FullCheck Mypy) FullCheck Mypy succeeded
Details
CI (FullCheck Pylint) FullCheck Pylint succeeded
Details
CI (Overview CheckFormat) Overview CheckFormat succeeded
Details
CI (Overview Lint) Overview Lint succeeded
Details
CI (Overview Validate) Overview Validate succeeded
Details
CI (Tests PyTest Python36) Tests PyTest Python36 succeeded
Details
CI (Tests PyTest Python37) Tests PyTest Python37 succeeded
Details
cla-bot Everyone involved has signed the CLA
codecov/patch Coverage not affected when comparing 0a87a4b...beb8aa0
Details
codecov/project 94% (target 90%)
Details

Dev automation moved this from Reviewer approved to Done Aug 9, 2019

balloob added a commit that referenced this pull request Aug 9, 2019

Update HIBP sensor to use API v3 and API Key (#25699)
* Update HIBP sensor to use API v3 and API Key

* ran black code formatter

* fixed stray , that was invalid in multiple json formatters
@balloob balloob referenced this pull request Aug 9, 2019

@lock lock bot locked and limited conversation to collaborators Aug 10, 2019

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
4 participants
You can’t perform that action at this time.