Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/seven1m/bible_api

Ruby web app that serves JSON API for open and public domain bibles
https://github.com/seven1m/bible_api

bible bible-api json ruby

Last synced: 16 days ago
JSON representation

Ruby web app that serves JSON API for open and public domain bibles

Host: GitHub
URL: https://github.com/seven1m/bible_api
Owner: seven1m
License: mit
Created: 2014-07-07T02:40:38.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-09-20T14:56:02.000Z (about 2 months ago)
Last Synced: 2024-10-03T19:40:28.587Z (about 1 month ago)
Topics: bible, bible-api, json, ruby
Language: Ruby
Homepage: https://bible-api.com
Size: 3.02 MB
Stars: 567
Watchers: 24
Forks: 104
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# bible\_api

This is a Ruby web app that serves a JSON API for public domain and open bible translations.

## Using It

This app is served from [bible-api.com](https://bible-api.com/), which anyone can use.

### With Curl and JQ

```sh
→ curl -s https://bible-api.com/John+3:16 | jq
{
"reference": "John 3:16",
"verses": [
{
"book_id": "JHN",
"book_name": "John",
"chapter": 3,
"verse": 16,
"text": "\nFor God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n\n"
}
],
"text": "\nFor God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n\n",
"translation_id": "web",
"translation_name": "World English Bible",
"translation_note": "Public Domain"
}
```

### With Ruby

```sh
→ ruby -r open-uri -r json -r pp -e "pp JSON.parse(URI.open('https://bible-api.com/John+3:16').read)"
{"reference"=>"John 3:16",
"verses"=>
[{"book_id"=>"JHN",
"book_name"=>"John",
"chapter"=>3,
"verse"=>16,
"text"=>
"\n" +
"For God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n" +
"\n"}],
"text"=>
"\n" +
"For God so loved the world, that he gave his one and only Son, that whoever believes in him should not perish, but have eternal life.\n" +
"\n",
"translation_id"=>"web",
"translation_name"=>"World English Bible",
"translation_note"=>"Public Domain"}
```

## Hosting it Yourself

If you want to host this application yourself, you'll need a Linux server with Ruby, Redis, and MySQL (or MariaDB) installed. Follow the steps below:

1. Clone the repo:

```
git clone https://github.com/seven1m/bible_api
cd bible_api
git submodule update --init
```

2. Install the dependencies:

```
gem install bundler
bundle config --local deployment true # optional, but prefered on a server
bundle install
```

3. Create the database and import the translations:

```
mysql -uroot -e "create database bible_api; grant all on bible_api.* to user@localhost identified by 'password';"
export DATABASE_URL="mysql2://user:password@localhost/bible_api"
export REDIS_URL="redis://localhost:6379"
bundle exec ruby import.rb
```

4. Host the app with [Passenger](https://www.phusionpassenger.com/docs/advanced_guides/install_and_upgrade/standalone/install/)

... or run `bundle exec ruby app.rb` if you are just testing.