scriptura 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f281b8747bc911a6013b3b7abcec0b46c8a28ae6
+  data.tar.gz: 0d0ebdf115e31328e1f327e4af1e4e4078ea1931
+SHA512:
+  metadata.gz: 622eef7218c890b1c8c362dd4a7ae6d64f0ae681e4f26ae32169923b44a525d20fd00bf467a33e25b27d4cb2daf59f07a8da222a08b566203796099de2789bf1
+  data.tar.gz: b1a43e4321ebeb165606c33c4ffc14486042a51b2964c66d79c22e453452e047c2729aa824e984d3432919b5960aab1224d416d3990b4af4310787b6c19a9916

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gagan Awhad
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, 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.

data/README.md

@@ -0,0 +1,73 @@
+[![Build Status](https://travis-ci.org/gaganawhad/scriptura.png)](https://travis-ci.org/gaganawahd/scriptura)
+[![Code Climate](https://codeclimate.com/github/gaganawhad/scriptura.png)](https://codeclimate.com/github/gaganawhad/scriptura)
+
+This is a ruby library that provides operations related with meta information about the Bible
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scriptura'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scriptura
+
+## Usage
+
+There are four main classes in this library: 
+  - ScriptureMeta
+  - ScriptureBook
+  - ScriptureChapter
+  - ScriptureVerse
+  - ScriptureReference
+
+###ScriptureMeta
+
+The way it is written, this is actually a module that encapsulates methods that scope the entire bible
+```ruby
+> ScriptureMeta.book_names
+ => ["Genesis", "Exodus", "Leviticus", ... , "Revelation"]
+
+ ```
+###ScriptureBook
+
+This is a ruby class that gets initialized by passing in the book number. You can also `find_by_name` the book or `find` it by its 'string_id'
+
+Note: Books with no chapters are considered to be books with one chapter
+
+```ruby
+> sb = ScriptureBook.new(1)
+ => #<ScriptureBook:0x007fcb1b80f7f8 @number=1> 
+> sb.name
+  => "Genesis" 
+> ScriptureBook.find_by_name("1 Corinthians")
+ => #<ScriptureBook:0x007fa194831e80 @number=46> 
+> ScriptureBook.find_by_name("1 Corinthians").number
+ => 46 
+> ScriptureBook.find("1-corinthians")
+ => #<ScriptureBook:0x007fa195866378 @number=46> 
+> ScriptureBook.find("1-corinthians").number
+ => 46 
+> ScriptureBook.find("1-corinthians").number_of_chapters
+ => 16 
+```
+
+It raises an error when trying to initalize a scripture book that doesn't exist
+
+```ruby
+> ScriptureBook.new(67)
+RuntimeError: book number should be within 1-66
+.
+.
+
+```
+
+Feel free to browse the code / test to get a sense of the API
+
+
+