https://github.com/mdwagner/bamboozled-cr
Crystal port of the Ruby bamboozled wrapper for the BambooHR API.
https://github.com/mdwagner/bamboozled-cr
Last synced: 2 months ago
JSON representation
Crystal port of the Ruby bamboozled wrapper for the BambooHR API.
- Host: GitHub
- URL: https://github.com/mdwagner/bamboozled-cr
- Owner: mdwagner
- License: mit
- Created: 2021-01-17T21:44:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-28T01:02:04.000Z (over 2 years ago)
- Last Synced: 2025-01-25T19:30:33.623Z (4 months ago)
- Language: Crystal
- Homepage: https://mdwagner.github.io/bamboozled-cr/
- Size: 146 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bamboozled-cr
Bamboozled-cr is a Crystal port of the Ruby wrapper [Bamboozled](https://github.com/method-inc/bamboozled).
Both are an HTTP Client library for the [BambooHR API](https://documentation.bamboohr.com/docs).
## Installation
1. Add the dependency to your `shard.yml`:
```yml
dependencies:
bamboozled:
github: mdwagner/bamboozled-cr
```
2. Run `shards install`
## Usage
```crystal
require "bamboozled"
client = Bamboozled.client("my-subdomain", "my-api-key")
client.employee.photo_url("[email protected]")
# => http://my-subdomain.bamboohr.com/employees/photos?h=ba9bb45673e99e6fad7251bf8ea40f89
```
Please checkout the `spec/bamboozled/api` directory for more examples.
Also, checkout the [Ruby wrapper usage](https://github.com/Skookum/bamboozled#usage) as well.
## Documentation
Every push to `master` deploys the latest documentation to [GitHub Pages](https://mdwagner.github.io/bamboozled-cr/)
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Michael Wagner](https://github.com/mdwagner) - creator and maintainer