{"id":13834439,"url":"https://github.com/ioki-mobility/thingsboard-ruby","last_synced_at":"2025-04-13T01:20:44.205Z","repository":{"id":50149576,"uuid":"518552615","full_name":"ioki-mobility/thingsboard-ruby","owner":"ioki-mobility","description":"A Thingsboard client for ruby","archived":false,"fork":false,"pushed_at":"2024-06-10T16:40:29.000Z","size":59,"stargazers_count":4,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T19:11:18.092Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/ioki-mobility.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-27T17:28:32.000Z","updated_at":"2023-11-23T15:01:53.000Z","dependencies_parsed_at":"2024-01-15T18:46:43.037Z","dependency_job_id":"a3ce8351-c73b-422a-af1b-4b62ea115027","html_url":"https://github.com/ioki-mobility/thingsboard-ruby","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fthingsboard-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fthingsboard-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fthingsboard-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ioki-mobility%2Fthingsboard-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ioki-mobility","download_url":"https://codeload.github.com/ioki-mobility/thingsboard-ruby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248651087,"owners_count":21139742,"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","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":[],"created_at":"2024-08-04T14:00:34.599Z","updated_at":"2025-04-13T01:20:44.184Z","avatar_url":"https://github.com/ioki-mobility.png","language":"Ruby","readme":"# thingsboard-ruby [![CI Status](https://github.com/ioki-mobility/thingsboard-ruby/actions/workflows/main.yml/badge.svg)](https://github.com/ioki-mobility/thingsboard-ruby/actions/workflows/main.yml)\n\nThis library helps to integrate the Thingsboard's API's with following feature-primitives:\n* [Administration REST API](https://thingsboard.io/docs/reference/rest-api/)\n    * [Login](https://demo.thingsboard.io/swagger-ui/#/login-endpoint/loginPost)\n    * [create Asset](https://demo.thingsboard.io/swagger-ui/#/asset-controller/saveAssetUsingPOST)\n    * [create Device](https://demo.thingsboard.io/swagger-ui/#/device-controller/saveDeviceUsingPOST)\n    * [create Relation](https://demo.thingsboard.io/swagger-ui/#/entity-relation-controller/saveRelationUsingPOST)\n* [HTTP Device API](https://thingsboard.io/docs/reference/http-api/)\n    * [create Telemetries](https://thingsboard.io/docs/reference/http-api/)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'thingsboard-ruby'\n```\n\nAnd then execute:\n\n    $ bundle install\n\nOr install it yourself as:\n\n    $ gem install thingsboard-ruby\n\n## Usage\nTo load this gem run:\n```ruby\nrequire 'thingsboard'\n```\n\nTo perform any Api call:\n```ruby\nThingsboard::Api::CreateAsset.call(\n  token: '***SECRET_THINGSBOARD_TOKEN***',\n  name:  'Bathroom',\n  type:  'room',\n  label: 'The bathroom next to the entry'\n)\n```\n\nThe response of an Api call usually returns an json-string of the response-body:\n\n```json\n      {\n        \"id\": {\n            \"entityType\": \"ASSET\",\n            \"id\": \"332090a0-0737-11eb-b3f7-4dbfb57ed205\"\n        },\n        \"createdTime\": 1601921922730,\n        \"additionalInfo\": null,\n        \"tenantId\": {\n            \"entityType\": \"TENANT\",\n            \"id\": \"8e71f160-db9a-88ea-95d6-fd59fd7ffce1\"\n        },\n        \"customerId\": {\n            \"entityType\": \"CUSTOMER\",\n            \"id\": \"13814000-1dd2-11b2-8080-808080808080\"\n        },\n        \"name\": \"Bathroom\",\n        \"type\": \"room\",\n        \"label\": \"The bathroom next to the entry\"\n      }\n```\n\nAny request that results in an unexpected error (meaning all response https-status-codes except `2**`) will raise an `Thingsboard::Api::Error`. Depending on the exact kind  of error it will raise different subclasses of `Thingsboard::Api::Error`:\n\n* `Thingsboard::Api::Unauthorized` if http-status is `401`\n* `Thingsboard::Api::Forbidden` if http-status is `403`\n* `Thingsboard::Api::UnexpectedResponseCode` for any other kind of error (like http-stauts `500`)\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 the created tag, 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/ioki-mobility/thingsboard-ruby.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","funding_links":[],"categories":["SDKs and REST clients"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fioki-mobility%2Fthingsboard-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fioki-mobility%2Fthingsboard-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fioki-mobility%2Fthingsboard-ruby/lists"}