https://github.com/thiagokimo/bible_service
A simple bible content provider
https://github.com/thiagokimo/bible_service
Last synced: 11 months ago
JSON representation
A simple bible content provider
- Host: GitHub
- URL: https://github.com/thiagokimo/bible_service
- Owner: thiagokimo
- Created: 2012-11-07T00:15:44.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-08-13T12:02:18.000Z (almost 13 years ago)
- Last Synced: 2023-04-01T12:04:27.112Z (over 3 years ago)
- Language: Ruby
- Homepage: http://thiagokimo.github.com/bible_service/
- Size: 996 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#Bible Service
=============
#Description
A RoR application that provides content from the bible. The content collected was the Nova Versão Internacional bible
in brazilian portuguese. It was scrapped from http://www.bible.com/.
##Setup
Assuming that you have Ruby, Rails and MySQL properly installed and configured in your machine:
1. Clone this repository to your machine:
> `git clone https://github.com/thiagokimo/bible_service.git`
2. Inside the project directory:
> `bundle install`
3. Create and migrate the databases:
> `rake db:create`
> `rake db:migrate`
4. In order to populate the database, run the following task:
> `rake bible:get_bible`
##How it works
There are 3 main entities:
* Book - Stores the book's name and link.
* Chapter - Stores the chapter's number and link.
* Verse - Stores the verses' number and its content.
The application has a crawler that populates the database parsing each html page, scrapping the content related to each
entitie. All scrap processes were built as rake tasks and can be triggered anytime. More information in `lib/tasks/bible.com.rake`
The service exports the information as json by HTTP requests. All routes are nested as Book, Chapter and Verse
respectively. The regular expressions to retrieve each entitie information corresponds to its own rake route:
* Book: - "/books"
* Chapter: - "books/book_id/chapters"
* Verse: - "books/book_id/chapters/chapter_id/verses"
##Usage
To get the information, access the URL's according to its entitie.
Inside the project's folder, start the server with
> `rails s`
and try the following examples:
* Whole bible: - http://localhost:3000/books.json
* All chapters from the book Exodus - http://localhost:3000/books/2/chapters.json
* All verses from the first chapter of Genesis: - http://localhost:3000/books/1/chapters/1/verses.json
## Future ideas and "to do"s'
1. Create tasks to collect information from other bibles
2. Change from Rails to Sinatra because its lightier ;)
3. Separate the crawler as a GEM, which will allow us to integrate our bible in other frameworks.
4. Start writting the commit messages in English, LOL
##How to contribute
Please ensure that you provide appropriate test coverage and ensure the documentation is up-to-date. It is encouraged that you perform changes in a clean topic branch rather than a master and that you create a pull request for them. This will facilitate discussion and revision.
Please be clean, keep your commits atomic and with the smallest possible logical change. This will increase the likelihood of your submission to be used.
###Bug reports
If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us fixing the possible bug.
https://github.com/thiagokimo/bible_service/issues
##License
Copyright (c) 2012 Thiago Moreira Rocha.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to use, copy and modify copies of the Software, subject
to the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.