Skip to content

Changed API for Ukraine Alarm#71754

Merged
balloob merged 4 commits intohome-assistant:devfrom
PaulAnnekov:ukraine_alarm_change_backend
May 12, 2022
Merged

Changed API for Ukraine Alarm#71754
balloob merged 4 commits intohome-assistant:devfrom
PaulAnnekov:ukraine_alarm_change_backend

Conversation

@PaulAnnekov
Copy link
Copy Markdown
Contributor

@PaulAnnekov PaulAnnekov commented May 12, 2022

Breaking change

Proposed change

Several users complained that Ukraine Alarm team didn't send API keys to them after more than 2 days passed (1, 2 and direct email). I think there was a miscommunication between me and Ukraine Alarm when I told them I want to develop a HA integration and make end users request API keys. They don't expect end users to request API keys. They want developers to build a derived service. So end users use the new service and new service is using their API under the hood.

So I've created a public API wrapper around api.ukrainealarm.com – siren.pp.ua. It doesn't require API key, but it has a request limit (enough to query 5 regions each 10 seconds). Also, published a new library in pypi – uasiren.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

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.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 🥈 Silver
  • 🥇 Gold
  • 🏆 Platinum

To help with the load of incoming pull requests:

@balloob balloob added this to the 2022.5.4 milestone May 12, 2022
@balloob balloob merged commit d76ff7d into home-assistant:dev May 12, 2022
balloob pushed a commit that referenced this pull request May 12, 2022
@balloob balloob mentioned this pull request May 13, 2022
@PaulAnnekov PaulAnnekov deleted the ukraine_alarm_change_backend branch May 13, 2022 16:38
@github-actions github-actions bot locked and limited conversation to collaborators May 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants