Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goldenm-software/flespi-ruby
Flespi REST API for Ruby language
https://github.com/goldenm-software/flespi-ruby
Last synced: 9 days ago
JSON representation
Flespi REST API for Ruby language
- Host: GitHub
- URL: https://github.com/goldenm-software/flespi-ruby
- Owner: goldenm-software
- License: mit
- Created: 2024-02-15T07:25:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-15T07:26:57.000Z (11 months ago)
- Last Synced: 2024-04-24T13:55:47.503Z (9 months ago)
- Language: Ruby
- Size: 1.95 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flespi-ruby
flespi-ruby is a flespi Remote API Wrapper for ruby language.
## Installation
Use the package manager [bundler](https://bundler.io/) to install flespi-ruby.
```bash
gem install flespi
```
OR
```ruby
gem 'flespi'
```
and execute a `bundle install`
## Usage
```ruby
require 'flespi'
# Initialize flespi instance
debug = true
flespi = Flespi.new("YourTokenHere", deubg)
# Login with API Token
flespi.get('/gw/devices/all')
# Logout
flespi.logout
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)