Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dannyben/apicake
Build Dynamic API Wrappers
https://github.com/dannyben/apicake
api api-wrapper gem ruby
Last synced: 3 months ago
JSON representation
Build Dynamic API Wrappers
- Host: GitHub
- URL: https://github.com/dannyben/apicake
- Owner: DannyBen
- License: mit
- Created: 2017-02-13T21:10:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-23T13:05:58.000Z (10 months ago)
- Last Synced: 2024-05-01T14:12:04.588Z (8 months ago)
- Topics: api, api-wrapper, gem, ruby
- Language: Ruby
- Size: 72.3 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# API Cake - Build Dynamic API Wrappers
[](https://badge.fury.io/rb/apicake)
[](https://github.com/DannyBen/apicake/actions?query=workflow%3ATest)
[](https://codeclimate.com/github/DannyBen/apicake/maintainability)
---
This gem allows you to easily build rich API wrappers with minimal code.
It is HTTParty with a Cake.
---
## Install
```
$ gem install apicake
```
Or with bundler:
```ruby
gem 'apicake'
```
## TL;DR
Turn this hypothetical API URL:
```
http://api.recipes.com/cakes?layers=3
```
To this:
```ruby
recipes = Recipes.new
recipes.cakes layers:3
```
Using this code only:
```ruby
class Recipes < APICake::Base
base_uri 'api.recipes.com'
end
```
## Features
- Uses HTTParty
- Built in caching
- Built in save to file
- Built in response parsing (part of HTTParty)
- Built in convert and save to CSV
- Designed for GET-only APIs (e.g., data services)
## Usage
Create a class and inherit from `APICake::Base`.
This class automatically includes HTTParty, so you can do whatever you do in
HTTParty. In addition, the `APICake::Base` class defines a `method_missing`
method, so any call to an undefined method, will simply be converted to a
URL.
For example:
```ruby
class Recipes << APICake::Base
base_uri 'api.recipes.com/v1'
end
recipes = Recipes.new
# This will access http://api.recipes.com/v1/cakes
recipes.cakes
# This will access http://api.recipes.com/v1/cakes/chocolate
recipes.cakes 'chocolate'
# This will access http://api.recipes.com/v1/cakes/chocolate?layers=3
recipes.cakes 'chocolate', layers: 3
```
See the [Examples folder][1] for more examples.
## Caching
APICake uses [Lightly][2] for caching. By default, cached objects are stored
in the `./cache` directory for 3600 seconds.
See the [caching example][3].
## Method Reference
For a detailed explanation of the services and methods you get when inheriting
from `APICake::Base`, see the [class documentation][4].
## Real World Examples
These gems use APICake:
- [Fredric][5] - API wrapper for the FRED database ([go straight to API class][8])
- [Intrinio][6] - API wrapper for the Intrinio data service ([go straight to API class][9])
- [Quata][7] - API wrapper for the Quandl data service ([go straight to API class][10])
- [EOD Historical Data][11] - API wrapper for the EOD Historical Data service ([go straight to API class][12])
- [Nasdaq][13] - API wrapper for the Nasdaq Data Link API ([go straight to API class][14])
---
[1]: https://github.com/DannyBen/apicake/tree/master/examples
[2]: https://github.com/DannyBen/lightly
[3]: https://github.com/DannyBen/apicake/blob/master/examples/04-caching.rb
[4]: http://www.rubydoc.info/gems/apicake/0.1.1/APICake/Base
[5]: https://github.com/DannyBen/fredric
[6]: https://github.com/DannyBen/intrinio
[7]: https://github.com/DannyBen/quata
[8]: https://github.com/DannyBen/fredric/blob/master/lib/fredric/api.rb
[9]: https://github.com/DannyBen/intrinio/blob/master/lib/intrinio/api.rb
[10]: https://github.com/DannyBen/quata/blob/master/lib/quata/api.rb
[11]: https://github.com/DannyBen/eod
[12]: https://github.com/DannyBen/eod/blob/master/lib/eod/api.rb
[13]: https://github.com/dannyben/nasdaq
[14]: https://github.com/dannyben/nasdaqblob/master/lib/nasdaq/api.rb