Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webmatze/icanhazdadjoke
A simple Ruby client for the icanhazdadjoke API.
https://github.com/webmatze/icanhazdadjoke
dad-jokes dadjokes jokes jokes-api
Last synced: about 2 months ago
JSON representation
A simple Ruby client for the icanhazdadjoke API.
- Host: GitHub
- URL: https://github.com/webmatze/icanhazdadjoke
- Owner: webmatze
- Created: 2024-05-14T13:54:46.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-14T16:56:23.000Z (8 months ago)
- Last Synced: 2024-05-15T18:10:45.913Z (8 months ago)
- Topics: dad-jokes, dadjokes, jokes, jokes-api
- Language: Ruby
- Homepage: https://icanhazdadjoke.com/api
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# ICanHazDadJoke
Welcome to the `icanhazdadjoke` gem! This Ruby gem provides a simple interface to fetch jokes from the icanhazdadjoke API, which is a service for getting random dad jokes.
```bash
$ icanhazdadjoke | cowsay
________________________________________
/ I remember when I was a kid, I opened \
| my fridge and noticed one of my |
| vegetables were crying. I guess I have |
\ some emotional cabbage. /
----------------------------------------
\ ^__^
\ (oo)\_______
(__)\ )\/\
||----w |
|| ||
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'icanhazdadjoke'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install icanhazdadjoke
## Usage
### Require the gem in your code
Using the `icanhazdadjoke` gem is quite straightforward. Here's a quick example:
```ruby
require 'icanhazdadjoke'
# Fetch a random dad joke
joke = ICanHazDadJoke.fetch_joke
puts joke
```
### Use the command line tool
You can also use the command line tool to fetch a random dad joke. Here's how:
```bash
$ icanhazdadjoke
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/webmatze/icanhazdadjoke. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/webmatze/icanhazdadjoke/blob/main/CODE-OF-CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ICanHazDadJoke project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/webmatze/icanhazdadjoke/blob/main/CODE-OF-CONDUCT.md).