esv_api 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+*~
+.bundle
+.DS_Store
+.rvmrc
+.yardoc
+coverage/*
+doc/*
+Gemfile.lock
+log/*
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+# ESV_API
+
+An API Wrapper for the ESV API
+
+# Limitations
+
+Currently only supports `passage_query`
+
+# Installation
+
+```ruby
+
+    gem 'esv_api'
+
+```
+
+```ruby
+
+    # Create an initializer:
+	
+	ESV.configure do |config|
+	  config.api_key = YOUR_API_KEY
+	end
+```
+
+```ruby
+
+    @esv_text = ESV.passage_query( params[:passage] || "John 1", { 'include-footnotes' => 'false', 'include-headings' => 'false', 'include-subheadings' => 'false', 'include-audio-link' => 'false' } )
+```
+
+
+# Credits
+
+With love to the Twitter Gem, from which I borrowed heavily.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the esv_api gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/esv_api.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.add_dependency 'httparty'
+  
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'esv_api'
+  s.version     = '0.0.1'
+  s.authors     = ["Jeff McFadden"]
+  s.email       = ["jeff@forgeapps.com"]
+  s.homepage    = "http://github.com/jeffmcfadden/esv_api"
+  s.summary     = "ESV API Wrapper."
+  s.description = "ESV API Wrapper."
+  
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+end

data/lib/esv_api/client.rb

@@ -0,0 +1,36 @@
+require 'esv_api/config'
+
+require 'httparty'
+
+module ESV
+  # Wrapper for the ESV API
+  #
+  class Client
+    include HTTParty
+    format :html
+    
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    # Initializes a new API object
+    #
+    # @param attrs [Hash]
+    # @return [ESV::Client]
+    def initialize(attrs={})
+      attrs = ESV.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+    
+    def passage_query(passage, options={})
+      query = {
+          'key' => self.api_key,
+          'passage' => passage
+      }
+      
+      query = options.merge( query )
+      
+      ESV::Client.get( self.endpoint + '/passageQuery', { :query => query } )
+    end
+  end
+end

data/lib/esv_api/config.rb

@@ -0,0 +1,52 @@
+require 'esv_api/version'
+
+module ESV
+  # Defines constants and methods related to configuration
+  module Config
+
+    # The API Key if none is set
+    DEFAULT_API_KEY = nil
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'http://www.esvapi.org/v2/rest/'
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "esv_api Ruby Gem #{ESV::Version}"
+
+    # An array of valid keys in the options hash when configuring a {Twitter::Client}
+    VALID_OPTIONS_KEYS = [
+      :api_key,
+      :endpoint,
+      :user_agent
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.api_key            = DEFAULT_API_KEY
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+
+  end
+end

data/lib/esv_api/version.rb

@@ -0,0 +1,30 @@
+module ESV
+  class Version
+
+    # @return [Integer]
+    def self.major
+      0
+    end
+
+    # @return [Integer]
+    def self.minor
+      0
+    end
+
+    # @return [Integer]
+    def self.patch
+      1
+    end
+
+    # @return [String, NilClass]
+    def self.pre
+      nil
+    end
+
+    # @return [String]
+    def self.to_s
+      [major, minor, patch, pre].compact.join('.')
+    end
+
+  end
+end

data/lib/esv_api.rb

@@ -0,0 +1,24 @@
+require 'esv_api/client'
+require 'esv_api/config'
+
+module ESV
+  extend Config
+  class << self
+    # Alias for ESV::Client.new
+    #
+    # @return [ESV::Client]
+    def new(options={})
+      ESV::Client.new(options)
+    end
+
+    # Delegate to ESV::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: esv_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff McFadden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70296141623180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70296141623180
+description: ESV API Wrapper.
+email:
+- jeff@forgeapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- esv_api.gemspec
+- lib/esv_api.rb
+- lib/esv_api/client.rb
+- lib/esv_api/config.rb
+- lib/esv_api/version.rb
+homepage: http://github.com/jeffmcfadden/esv_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: ESV API Wrapper.
+test_files: []