{"id":35003236,"url":"https://github.com/robzr/ecobee","last_synced_at":"2025-12-27T04:11:50.384Z","repository":{"id":62557741,"uuid":"64729641","full_name":"robzr/ecobee","owner":"robzr","description":"Ruby Gem for Ecobee API with PIN-based token registration \u0026 renewal, persistent HTTP connections","archived":false,"fork":false,"pushed_at":"2016-09-06T00:20:02.000Z","size":48,"stargazers_count":3,"open_issues_count":0,"forks_count":10,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-12T21:09:47.736Z","etag":null,"topics":["ecobee"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robzr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-02T06:16:41.000Z","updated_at":"2025-08-02T20:25:22.000Z","dependencies_parsed_at":"2022-11-03T06:45:39.977Z","dependency_job_id":null,"html_url":"https://github.com/robzr/ecobee","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/robzr/ecobee","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robzr%2Fecobee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robzr%2Fecobee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robzr%2Fecobee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robzr%2Fecobee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robzr","download_url":"https://codeload.github.com/robzr/ecobee/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robzr%2Fecobee/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28071858,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-27T02:00:05.897Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecobee"],"created_at":"2025-12-27T04:11:48.298Z","updated_at":"2025-12-27T04:11:50.378Z","avatar_url":"https://github.com/robzr.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ecobee\n\nEcobee API Ruby Gem.  Implements: \n- OAuth PIN-based token registration \u0026 renewal\n- Persistent HTTP connection management\n- Methods for GET \u0026 POST requests w/ JSON parsing \u0026 error handling\n- Persistent storage for API key \u0026 refresh tokens\n- Storage uses iCloud Drive if available for shared computer use\n- Block/Proc hooks for token storage load/save to add app config data\n- Thermostat abstraction class for simple thermostat interaction\n- Example usage scripts (see /examples/\\*)\n\nTODO:\n- Add RDoc documentation\n- Add redirect based registration\n\n## Installation\n\nThe latest ecobee Ruby Gem is [available from Rubygems.org](https://rubygems.org/gems/ecobee).\n\nTo install from the command line, run:\n```\ngem install ecobee\n```\n\n## Usage\n\n1. Obtain an Application Key from Ecobee by [registering your project](https://www.ecobee.com/developers).\n\n2. Using Ecobee::Token, obtain an OAuth Access Token.\n  - Instantiate Ecobee::Token with the api_key and desired scope.\n  - Give user Ecobee::Token#pin and instructions to register your Application via the [Ecobee My Apps Portal](https://www.ecobee.com/consumerportal/index.html#/my-apps).\n  - You can call Ecobee::Token#wait to block until the user confirms the PIN code.\n\n3. Instantiate Ecobee::Thermostat with the token object.\n\n4. Use the simplified methods for common interactions, access the Thermostat object directly as a Hash to read values, or use the update method to post changes.\n\n5. Ecobee::Client#get or Ecobee::Client#post can be used for advanced interaction with [Ecobee's API](https://www.ecobee.com/home/developer/api/introduction/index.shtml).\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/robzr/ecobee.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobzr%2Fecobee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobzr%2Fecobee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobzr%2Fecobee/lists"}