Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lindseyb/tarot-api
A simple tarot API
https://github.com/lindseyb/tarot-api
api ruby sinatra tarot tarot-cards tarot-readings
Last synced: 3 months ago
JSON representation
A simple tarot API
- Host: GitHub
- URL: https://github.com/lindseyb/tarot-api
- Owner: LindseyB
- License: mit
- Created: 2021-06-10T02:15:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T16:20:29.000Z (4 months ago)
- Last Synced: 2024-10-11T15:16:56.878Z (3 months ago)
- Topics: api, ruby, sinatra, tarot, tarot-cards, tarot-readings
- Language: Ruby
- Homepage: https://tarot-api.com
- Size: 20.5 MB
- Stars: 42
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Tarot Api
## Requests
`GET /` [[run]](https://tarot-api.com)
Returns an array of every card
`GET /cards` [[run]](https://tarot-api.com/cards)
Returns an array of every card
`GET /cards/[suit]/[rank]` [[run]](https://tarot-api.com/cards/swords/10)
| argument | values | required |
|----------|-----------------------------------------------------------------------------|----------|
| suit | one of: swords, wands, cups, coins, or major | yes |
| rank | one of: king, queen, 1-10 for swords/wands/cups/pentacles or 0-21 for major | yes |
Returns a single card in the form of
| field | type | description |
|----------------------|------------------|---------------------------------------------------------------------------------------------|
| meanings | hash | |
| meanings["upright"] | array of strings | meanings for this card in the upright position |
| meanings["reversed"] | array of strings | meanings for this card in the reverse position |
| name | string | the name of the card written out in words |
| rank | string or int | rank of the card in the suit up to 21 for major arcana, king through 10 for all other suits |
| suit | string | major, wands, cups, swords, or pentacles |
| planet | string | planet associated with this card |
| signs | array of strings | astrological sign(s) associated with this card |
| element | string | element associated with this card |
### Example
`GET /cards/swords/10`
returns the following JSON
```JSON
{
"name": "Ten of Swords",
"rank": 10,
"suit": "swords",
"planet": null,
"element": "air",
"sign": [
"gemini",
"libra",
"aquarius"
],
"meanings": {
"upright": [
"failure",
"defeat",
"deep wounds",
"loss",
"crisis",
"betrayal"
],
"reversed": [
"recovery",
"rebirth",
"moving on",
"restoration"
]
}
}
```
`GET /draw/[n]` [[run]](https://tarot-api.com/draw/3)
Returns n randomly selected cards
| argument | values | required |
|----------|--------------|----------|
| n | positive int | yes |
`GET /find/[name]` [[run]](https://tarot-api.com/find/The%20Magician)
Returns the card by the specified name. Note that the numbers will be spelled out
| argument | values | required |
|----------|--------------------------------------------|----------|
| name | string name of the card (eg: The Magician) | yes |
`GET /suits` [[run]](https://tarot-api.com/suits)
Returns an array of all the suits of the tarot with key information
`GET /suits/[suit]/cards` [[run]](https://tarot-api.com/suits/cups/cards)
Returns an array of all the cards in a given suit
| argument | values | required |
|----------|--------------------------------------------|----------|
| suit | string name of the suit (eg: cups ) | yes |
`GET /suits/[suit]` [[run]](https://tarot-api.com/suits/cups)
| argument | values | required |
|----------|--------------------------------------------|----------|
| suit | string name of the suit (eg: cups ) | yes |
Returns a single suit in the form of
| field | type | description |
|----------------------|------------------|---------------------------------------------------------------------------------------------|
| name | string | the name of the tarot suit |
| element | string | the element associated with this tarot suit |
| direction | string | the cardinal direction associated with this tarot suit |
| season | string | the season associated with this tarot suit |
| time | string | the time of day associated with this tarot suit |
| signs | array of strings | astrological signs associated with this suit |
| keywords | array of strings | words associated with this suit |
## Testing
```bash
bundle exec rake test
```
## Getting Started
```bash
bundle install
bundle exec rackup
```
## Deploying
```bash
gcloud config set project tarot-api-316423 # set the correct project
gcloud app deploy # deploy the app
gcloud app logs tail -s default # tail the logs to make sure things are gucci
```
🍦
## Thanks
* Sinatra API template https://github.com/noplay/sinatra-api-template
* Initial tarot corpus https://github.com/dariusk/corpora
* Rider-Waite tarot images https://luciellaes.itch.io/rider-waite-smith-tarot-cards-cc0