digital_bible_platform 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTY4YmI3NGQyZmExNWZiZTlhZDdhNGJiNWVkZTY2NzVhMjNiOGM3Mg==
+  data.tar.gz: !binary |-
+    ZThlYTUyODlkY2U5YmZmNzkyY2JmMzEwNjg0NzM0YjljNjhhZDI0ZA==
+SHA512:
+  metadata.gz: !binary |-
+    ZWVhODRhMTdhZWFlNDZiNWY3MTliNWVjZTFjODc4NzllOTNmMDZiYzQzNTEy
+    ZDNiN2I1NTc4ZDI3ODcyN2VlM2ZjZGVkYzEyYTY5ZTNhZmY3MDlkY2UwNTAw
+    NWU1NjQzYjRjZjAxNzFmMjU0NTlmY2UxZTE0YmI4NzhiZDAwY2U=
+  data.tar.gz: !binary |-
+    MjExNDUxZWI4YTE4MDk1MDkxNTFiYjdkNjFkYTljZjVhMDZmNmU1Mzc2YTU2
+    NDBhZjk1MTQyMWE5MTVhMmJlZTYwN2VlMGZlYmQ3NTY5NTdiZGI3MjgwMThj
+    ZTc3YThkNWFiM2E3NjRhY2M4MjBhYTljMzM3NTYyZTdiZTI3OWI=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.gitignore
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in digital_bible_platform.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chip Miller
+
+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,44 @@
+# DigitalBiblePlatform
+
+A ruby wrapper for the [Digital Bible Platform](http://www.digitalbibleplatform.com/docs/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'digital_bible_platform'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install digital_bible_platform
+
+## Usage
+
+#### Get an [API Key](http://www.digitalbibleplatform.com/dev/signup/) 
+#### Initialize a Client  
+```ruby
+@client = DigitalBiblePlatform::Client.new(<your-api-key>)
+```
+
+#### Get a list of the books of the Bible  
+You will need the short\_code (dam\_id)  
+```ruby
+books = @client.books
+```
+
+#### Get the media link for a book of the bible
+```ruby
+books = @client.url_for('2Tim', 4)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/digital_bible_platform/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/digital_bible_platform.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'digital_bible_platform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "digital_bible_platform"
+  spec.version       = DigitalBiblePlatform::VERSION
+  spec.authors       = ["Chip Miller"]
+  spec.email         = ["use github"]
+  spec.summary       = %q{A Ruby client for http://www.digitalbibleplatform.com/}
+  spec.description   = %q{A Ruby client for http://www.digitalbibleplatform.com/}
+  spec.homepage      = "https://github.com/chip-miller/digital_bible_platform"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "iso-639", '~> 0.2.4'
+  spec.add_runtime_dependency 'typhoeus', '~> 0.6.8'
+  spec.add_runtime_dependency 'oj'
+  spec.add_runtime_dependency 'hashie'
+  
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

data/lib/digital_bible_platform/dam_id.rb

@@ -0,0 +1,89 @@
+require 'iso-639'
+module DigitalBiblePlatform
+  
+  class DamId
+    class << self
+    
+      # Example ENGESV
+      def partial(options={})
+        [ (Codes.language    options[:language]    ),
+          (Codes.version     options[:version]     ),
+        ].join('').upcase
+      end
+    
+      # Example ENGESVN2DA
+      def full(options={})
+        collection = if options[:book]
+          Codes.collection_from_book options[:book]
+        else
+          Codes.collection  options[:collection]
+        end
+        
+        [ (Codes.language    options[:language]    ),
+          (Codes.version     options[:version]     ),
+          (collection                              ),
+          (Codes.drama       options[:drama]       ),
+          (Codes.media       options[:media]       ),
+        ].join('').upcase
+      end
+    end
+
+    # http://www.digitalbibleplatform.com/docs/core-concepts/ 
+    class Codes
+      class << self
+        def language(name)
+          lang = ISO_639.find_by_english_name(name.to_s.capitalize)
+          raise ArgumentError.new("#{name} Not recognized as a language") unless lang
+          lang.alpha3_bibliographic.upcase
+        end
+    
+        def version(type)
+          type.upcase.to_s
+        end
+
+        def collection(type)
+          COLLECTIONS[type.to_sym]
+        end
+        
+        def collection_from_book(book_short_name)
+          return COLLECTIONS[:old_testament] if OLD_TESTAMENT_SHORT_NAMES.include? book_short_name
+          return COLLECTIONS[:new_testament] if NEW_TESTAMENT_SHORT_NAMES.include? book_short_name
+        end
+    
+        def drama(type)
+          DRAMA_TYPES[type.to_sym]
+        end
+    
+        def media(type)
+          MEDIA_TYPES[type.to_sym]
+        end
+      end
+  
+      COLLECTIONS = {
+        old_testament: "O", # Contains one or more books of the Old Testament.
+        new_testament: "N", # Contains one or more books of the New Testament.
+             complete: "C", # Contains books from both the Old and New Testament. (These volumes are used primarily for content downloads, and are not generally used by the actual reader applications).
+                story: "S", # Contains content that is not organized by books and chapters.
+              partial: "P", # Contains only partial content, such as a few chapters from one book of the Bible.
+      }
+  
+      DRAMA_TYPES = {
+            drama: 2, # Audio includes spoken text, music, and sound effects.
+        non_drama: 1, # Audio includes only spoken text.
+      }
+  
+      MEDIA_TYPES = {
+         text: "ET", # Electronic Text
+        audio: "DA", # Digital Audio
+        video: "DV", # Digital Video
+      }
+      
+      OLD_TESTAMENT = ["Genesis", "Exodus", "Leviticus", "Numbers", "Deuteronomy", "Joshua", "Judges", "Ruth", "1 Samuel", "2 Samuel", "1 Kings", "2 Kings", "1 Chronicles", "2 Chronicles", "Ezra", "Nehemiah", "Esther", "Job", "Psalms", "Proverbs", "Ecclesiastes", "Song of Solomon", "Isaiah", "Jeremiah", "Lamentations", "Ezekiel", "Daniel", "Hosea", "Joel", "Amos", "Obadiah", "Jonah", "Micah", "Nahum", "Habakkuk", "Zephaniah", "Haggai", "Zechariah", "Malachi"] 
+      NEW_TESTAMENT = ["Matthew", "Mark", "Luke", "John", "Acts", "Romans", "1 Corinthians", "2 Corinthians", "Galatians", "Ephesians", "Philippians", "Colossians", "1 Thessalonians", "2 Thessalonians", "1 Timothy", "2 Timothy", "Titus", "Philemon", "Hebrews", "James", "1 Peter", "2 Peter", "1 John", "2 John", "3 John", "Jude", "Revelation"]
+      
+      OLD_TESTAMENT_SHORT_NAMES = ["Gen", "Exod", "Lev", "Num", "Deut", "Josh", "Judg", "Ruth", "1Sam", "2Sam", "1Kgs", "2Kgs", "1Chr", "2Chr", "Ezra", "Neh", "Esth", "Job", "Ps", "Prov", "Eccl", "Song", "Isa", "Jer", "Lam", "Ezek", "Dan", "Hos", "Joel", "Amos", "Obad", "Jonah", "Mic", "Nah", "Hab", "Zeph", "Hag", "Zech", "Mal"] 
+      NEW_TESTAMENT_SHORT_NAMES = ["Matt", "Mark", "Luke", "John", "Acts", "Rom", "1Cor", "2Cor", "Gal", "Eph", "Phil", "Col", "1Thess", "2Thess", "1Tim", "2Tim", "Titus", "Phlm", "Heb", "Jas", "1Pet", "2Pet", "1John", "2John", "3John", "Jude", "Rev"]
+      
+    end
+  end
+end

data/lib/digital_bible_platform/version.rb

@@ -0,0 +1,3 @@
+module DigitalBiblePlatform
+  VERSION = "0.0.1"
+end

data/lib/digital_bible_platform.rb

@@ -0,0 +1,68 @@
+require "digital_bible_platform/version"
+require "digital_bible_platform/dam_id"
+require "typhoeus"
+require "hashie"
+require "oj"
+
+module DigitalBiblePlatform
+  class Client
+    attr_reader :api_key   #'fd82d19821647fa4829c7ca160b82e6f'
+
+    def initialize(api_key, defaults={})
+      @api_key = api_key
+      @defaults = {
+        # API Defaults
+        protocol:       'http', 
+        audio_encoding: 'mp3',
+        callback:       false,
+
+        # Media Defaults
+        language:   "English",
+        version:    :esv,
+        collection: :complete,
+        drama:      :drama,
+        media:      :audio,
+      }.merge(defaults)
+    end
+
+    
+    def url_for(book_short_name, chapter=1, overrides={})      
+      response = connect!('/audio/path', {
+        dam_id: DamId.full( @defaults.merge(overrides.merge({book:book_short_name}) )),
+        book_id:    book_short_name,
+        chapter_id: chapter,
+      })
+      file = response.find {|book| book.book_id==book_short_name}.path
+      "#{base_url}/#{file}"
+    end
+    
+    def books(overrides={})
+      options = @defaults.merge(overrides)
+      connect!('/library/book', { dam_id: DamId.partial(options) })
+    end
+    
+  private
+  
+    def connect!(path, options={})
+      request_body = {key:@api_key, v:'2'}.merge(options)
+      request_body.merge!({reply:'jsonp',callback:@defaults[:callback]}) if @defaults[:callback]
+      response = Typhoeus.get("http://dbt.io#{path}", params:request_body, followlocation: true)
+      reply = Oj.load( response.body )
+      
+      case reply
+        when Hash  then Hashie::Mash.new(reply)
+        when Array then reply.map {|hash| Hashie::Mash.new(hash)}
+      end
+    end
+    
+    def base_url
+      @cdns ||= connect!('/audio/location')
+      cdn = @cdns.sort_by(&:priority).first {|_cdn| _cdn.protocal==@defaults[:protocal]}
+      "#{cdn.protocol}://#{cdn.server}#{cdn.root_path}"
+    end
+  end
+end
+
+
+# DEV
+@client = DigitalBiblePlatform::Client.new('fd82d19821647fa4829c7ca160b82e6f')

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: digital_bible_platform
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chip Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: iso-639
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby client for http://www.digitalbibleplatform.com/
+email:
+- use github
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- digital_bible_platform.gemspec
+- lib/digital_bible_platform.rb
+- lib/digital_bible_platform/dam_id.rb
+- lib/digital_bible_platform/version.rb
+homepage: https://github.com/chip-miller/digital_bible_platform
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby client for http://www.digitalbibleplatform.com/
+test_files: []