Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/statuscakedev/statuscake-rb
StatusCake Ruby SDK (Alpha)
https://github.com/statuscakedev/statuscake-rb
api-client statuscake
Last synced: about 2 months ago
JSON representation
StatusCake Ruby SDK (Alpha)
- Host: GitHub
- URL: https://github.com/statuscakedev/statuscake-rb
- Owner: StatusCakeDev
- License: mit
- Created: 2022-07-19T22:14:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T13:08:05.000Z (5 months ago)
- Last Synced: 2024-08-07T15:52:58.245Z (5 months ago)
- Topics: api-client, statuscake
- Language: Ruby
- Homepage: https://developers.statuscake.com
- Size: 98.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# statuscake-rb 
**NOTE**: This library is in alpha and not production ready. Whilst it can be
used we will not offer support until it is generally available.
The [Ruby](https://www.ruby-lang.org/en/) implementation of the [StatusCake
API](https://www.statuscake.com/api/v1) client. Documentation for this library
can be found [here](https://www.statuscake.com/api/v1).
## Prerequisites
You will need the following things properly installed on your computer:
- [Ruby](https://www.ruby-lang.org/en/): any one of the **three latest major**
[releases](https://www.ruby-lang.org/en/downloads/)
## Installation
### RubyGems
Using [RubyGems](https://rubygems.org/gems/statuscake-rb), add the following to
`Gemfile`:
```ruby
gem 'statuscake-rb'
```
And then execute:
```bash
bundle install
```
Or install it yourself:
```bash
gem install statuscake-rb
```
### GitHub
Installing the latest version from GitHub:
```bash
git clone https://github.com/StatusCakeDev/statuscake-rb
cd statuscake-rb
bundle install
bundle exec rake install
```
## Usage
Import the gem from any Ruby file, instantiate an API client and execute a
request:
```ruby
require 'statuscake'
client = StatusCake::ApiClient.new
# Constructing these options is a temporary fix until a client wide
# authentication mechanism has been realised.
opts = { header_params: { 'Authorization' => "Bearer #{api_token}" } }
service = StatusCake::UptimeApi.new(client)
service.list_uptime_tests(opts)
```
## License
This project is licensed under the [MIT License](LICENSE).