calvinf / bible-api-thing Goto Github PK

Accept a bible_key option in the BibleApi class's constructor rather than loading key from a file. This will allow users of the BibleApi class to more easily set their own key and store it via whatever means they like (class, environment variable, etc) and make this more easy to reuse.

As a user, I want to be able to retrieve and store translation (version) information in a database for retrieval and usage in a website, mobile app, or other Bible-related software.

Setup a module to allow me to query the ABS versions API and store the info in a database.

Versions API docs

Currently, ActiveRecord initialization in https://github.com/calvinf/Bible-API-Thing/tree/activerecord is hard-coded to use SQLite and a specific database name. Allow the user of the BibleApi class to determine what database to use.

Specifically, I want this to be flexible enough to handle SQLite, MySQL, or Postgres depending on the user's needs (and potentially different databases for development and production).

Merge activerecord changes to mainline.

At present, cache keys for certain translations can be incompatible with other translations. For instance, eng-KJV and eng-ESV have a different title for the following verse: "Psalm 119:9-11" v. "Psalms 119:9-11". The same issue pops up for other translations with different book titles. For instance, hwc-HWCNT ("Da Jesus Book" / Hawai'i Creole Pidgin) has the title "Fo Da Galatia Peopo" for the book of Galatians.

The differences in book title cause the cache_key for different translations not to match leading scripts using the BibleApi class not looking in the correct place for previously cached versions of specific verses -- and for any consumers of the Mongo data generated by this don't have one unique global identifier per verse or passage that can be reliably used across translations.

I believe the solution here will be providing a mapping from our original verse/passage references such as "2 Corinthians 5:17" to the "start_verse" and "end_verse" values in the ABS Bible API. This could be put in Mongo or somewhere in the code.