trinidad_dbpool 0.4.0 → 0.4.2

data/History.txt

@@ -1,3 +1,27 @@
+== 0.4.2 (2012-12-22)
+
+ * updated tomcat-dbcp.jar to 7.0.32
+ * support multiple jar files (and globbing) with driver path
+ * trinidad_mssql_dbpool_extension jTDS jar updated to 1.3.0
+
+== 0.4.1 (2012-11-29)
+
+* updated driver jars for following :
+  - trinidad_mysql_dbpool_extension
+  - trinidad_postgresql_dbpool_extension
+  - trinidad_mssql_dbpool_extension
+* added trinidad_sqlite_dbpool_extension
+
+== 0.4.0 (2012-05-31)
+
+* revised trinidad_generic_dbpool_extension :
+  - driver configuration option aliased as driverName
+  - new driverPath option for specifying driver jar in configuration
+  - allow driverName to be auto resolved when driverPath specified
+* trinidad_postgresql_dbpool_extension with driver updated to 9.1-902
+* trinidad_mysql_dbpool_extension with mysql-connector-j 5.1.20
+* code cleanup, get rid of jeweler, update tomcat-dbcp.jar for trinidad_dbpool
+
 == 0.3.0 (2011-07-01)
 
 * Oracle connection pool extension

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2012 David Calavera
+Copyright (c) 2012 Team Trinidad and contributors http://github.com/trinidad
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,3 +18,8 @@ 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.
+
+== JDBC Driver
+
+Included JDBC drivers are most likely distributed under different terms than 
+those above, please make sure you understand your driver's license terms.

data/README.md

@@ -0,0 +1,114 @@
+# Trinidad Database Pool
+
+A bunch of Trinidad extensions to support database connection pooling on top of 
+the underlying Apache Tomcat container (using Tomcat's JDBC Connection Pool).
+
+Please note, that such pools are usually configured as "global" and thus 
+shareable by multiple applications deployed on to of the Trinidad server.
+
+Also most Java issues caused by JDBC drivers packaged with the application (e.g.
+`java.lang.UnsatisfiedLinkError` with SQLite3's JDBC driver) that JRuby inherits
+should go away when database connections are managed externally.
+
+http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html
+
+## Available Pools
+
+* MySQL (trinidad_mysql_dbpool_extension)
+* PostgreSQL (trinidad_postgresql_dbpool_extension)
+* SQLite (trinidad_sqlite_dbpool_extension)
+* MS-SQL (trinidad_mssql_dbpool_extension) using (unofficial) jTDS driver
+* Oracle (trinidad_oracle_dbpool_extension)
+* Generic (trinidad_generic_dbpool_extension) in case your DB ain't supported
+
+## Usage
+
+* Install the gem e.g. `jruby -S gem install trinidad_mysql_dbpool_extension`
+* Configure the pool with Trinidad's configuration file e.g. :
+
+```yml
+  web_apps:
+    default:
+      extensions:
+        mysql_dbpool:                    # EXTENSION NAME AS KEY
+          jndi: 'jdbc/TestDB'            # name (linked with database.yml)
+          url: 'localhost:3306/javatest' # database URL (or full jdbc: URL)
+          username: 'root'               # database username
+          password: 'root'               # database password
+          maxActive: 100                 # max nodes actives
+          maxIdle: 30                    # max nodes idles
+          maxWait: 10000                 # max nodes waiting
+```
+
+**jndi**, **url** are mandatory (as well **username** and **password** if your
+database server + driver requires authentication), while other supported 
+configuration options might be found here in Tomcat's "datasource" how-to:
+
+http://tomcat.apache.org/tomcat-7.0-doc/jndi-datasource-examples-howto.html
+
+http://commons.apache.org/dbcp/configuration.html
+
+If you happen to be using *SQLite* on production you'll need an absolute path :
+
+```yml
+  extensions:
+    sqlite_dbpool:
+      jndi: jdbc/FileDB
+      url: <%= File.expand_path('db/production.db') %>
+```
+
+* Configure the (Rails) application to use JNDI with *config/database.yml*
+
+```yml
+production:
+  adapter: jdbc # it will detect the adapter spec e.g. `ArJdbc::MySQL`
+  jndi: java:/comp/env/jdbc/TestDB
+  # (Java) JDBC driver class name is detected for built-in adapters that
+  # activerecord-jdbc-adapter supports, specify for a "generic" adapter
+  #driver: com.mysql.jdbc.Driver
+```
+
+do not forget to delete **pool** setup part since there's no need for it ...
+
+## Generic Pool
+
+If there's no "official" pool for your database, or would like to use a 
+different version of a JDBC driver for a supported Trinidad pool, this allows
+you to completely customize a pool.
+
+NOTE: You will need a JDBC driver for your database, check the driver DB if 
+unsure about how to get one http://developers.sun.com/product/jdbc/drivers
+
+Sample configuration for a DB2 database :
+
+```yml
+---
+  extensions:
+    generic_dbpool:                          # EXTENSION NAME AS KEY
+      jndi: 'jdbc/MyDB'                      # JNDI name
+      url: 'jdbc:db2://127.0.0.1:50000/MYDB' # specify full jdbc: URL
+      username: 'mydb'                       # database username
+      password: 'pass'                       # database password
+      driverPath: '/opt/IBM/DB2/db2jcc4.jar' # leave out if on class-path
+      driverName: com.ibm.db2.jcc.DB2Driver  # resolved from driverPath jar
+```
+
+Beyond standard configuration options there's 2 specific options here :
+
+* **driverPath** should be a path to your JDBC driver archive, might leave that
+  out but make sure it's on the (shared) class-path for each and every deployed 
+  application that requires it. You might specify multiple jars using the 
+  `Dir.glob` syntax or by separating paths using the `:` separator.
+
+  Also in case *driverPath* is omitted you'll need to specify a *driverName* !
+
+* **driverName** the class name implementing the JDBC driver interface, if 
+  you're not sure check the .jar for a META-INF/services/java.sql.Driver file.
+  If present that file contains the class-name and you might leave *driverName*
+  blank if you specified the jar path using *driverPath* but you're going still
+  going to need the driver name in your *database.yml*
+
+## Copyright
+
+Copyright (c) 2012 [Team Trinidad](https://github.com/trinidad). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -1,68 +1,107 @@
-require 'rubygems'
-require 'rake'
+begin
+  require 'bundler/gem_helper'
+rescue LoadError => e
+  require('rubygems') && retry
+  raise e
+end
+
+task :default => :spec
 
-def build(gem)
-  mkdir_p 'pkg'
-  sh "gem build #{gem}.gemspec"
-  mv Dir["#{gem}*.gem"].last, 'pkg'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', "--format documentation"]
 end
 
-def release(gem, version = nil)
-  unless `git branch` =~ /^\* master$/
-    raise "must be on master to release !"
+desc "Clear out all built (pkg/* and *.gem) artifacts"
+task :clear do
+  rm Dir["*.gem"]
+  rm_r Dir["pkg/*"] if File.exist?("pkg")
+end
+task :clean => :clear
+
+all_gems = %W{ 
+  dbpool
+  generic_dbpool_extension
+  mysql_dbpool_extension
+  postgresql_dbpool_extension
+  sqlite_dbpool_extension
+  mssql_dbpool_extension
+  oracle_dbpool_extension
+}.map { |gem| "trinidad_#{gem}" }
+
+all_gems.each do |gem_name|
+  
+  gem_helper = Bundler::GemHelper.new(Dir.pwd, gem_name)
+  def gem_helper.version_tag
+    "#{name}-#{version}" # override "v#{version}"
   end
+  version = gem_helper.send(:version)
+  version_tag = gem_helper.version_tag
   
-  if version
-    unless gem_file = Dir.glob("pkg/#{gem}-#{version}.gem").first
-      raise "#{gem}-#{version}.gem not build !"
-    end
-  else
-    unless gem_file = Dir.glob("pkg/#{gem}*").sort.last
-      raise "#{gem}*.gem not build !"
-    end
-    unless match = gem_file.match(/.*?\-(\d\.\d\.\d)\.gem/)
-      raise "version number not matched from: #{gem_file}"
-    end
-    version = match[1]
+  namespace gem_name do
+    desc "Build #{gem_name}-#{version}.gem into the pkg directory"
+    task('build') { gem_helper.build_gem }
+
+    desc "Build and install #{gem_name}-#{version}.gem into system gems"
+    task('install') { gem_helper.install_gem }
+
+    desc "Create tag #{version_tag} and build and push #{gem_name}-#{version}.gem to Rubygems"
+    task('release') { gem_helper.release_gem }
   end
   
-  sh "git tag #{gem}-#{version}"
-  sh "git push origin master --tags"
-  sh "gem push #{gem_file}"
 end
 
-all_gems = %W{ dbpool mysql_dbpool_extension postgresql_dbpool_extension mssql_dbpool_extension oracle_dbpool_extension }
-all_gems.map! { |gem| "trinidad_#{gem}" }
-all_gems.each do |gem_name|
-  namespace gem_name do
-    desc "Build the #{gem_name} gem"
-    task :build do
-      build(gem_name)
+namespace :all do
+  desc "Build all gems into the pkg directory"
+  task 'build' => all_gems.map { |gem_name| "#{gem_name}:build" }
+
+  desc "Build and install all gems into system gems"
+  task 'install' => all_gems.map { |gem_name| "#{gem_name}:install" }
+end
+
+namespace :'tomcat-dbcp' do
+  
+  TOMCAT_MAVEN_REPO = 'http://repo2.maven.org/maven2/org/apache/tomcat'
+
+  TRINIDAD_LIBS = File.expand_path('./trinidad-libs', File.dirname(__FILE__))
+
+  dbcp_jar = "tomcat-dbcp.jar"
+  
+  task :download, :version do |_, args|
+    version = [ args[:version] ]
+    
+    dbcp_uri = "#{TOMCAT_MAVEN_REPO}/tomcat-dbcp/#{version}/tomcat-dbcp-#{version}.jar"
+    
+    require 'open-uri'; require 'tmpdir'
+
+    temp_dir = File.join(Dir.tmpdir, (Time.now.to_f * 1000).to_i.to_s)
+    FileUtils.mkdir temp_dir
+
+    downloads = Hash.new
+    downloads[dbcp_jar] = dbcp_uri
+
+    Dir.chdir(temp_dir) do
+      FileUtils.mkdir TRINIDAD_LIBS unless File.exist?(TRINIDAD_LIBS)
+      downloads.each do |jar, uri|
+        puts "downloading #{uri}"
+        file = open(uri)
+        FileUtils.cp file.path, File.join(TRINIDAD_LIBS, jar)
+      end
     end
-    desc "Release the #{gem_name} gem"
-    task :release => :build do
-      release(gem_name)
+
+    FileUtils.rm_r temp_dir
+  end
+  
+  task :check do
+    jar_path = File.join(TRINIDAD_LIBS, dbcp_jar)
+    unless File.exist?(jar_path)
+      Rake::Task['tomcat-jndi:download'].invoke
     end
   end
-end
 
-{
-  :build => 'Build all connection pool gems', 
-  :release => 'Release all connection pool gems'
-}.each do |t, d|
-  desc d
-  task t => all_gems.map { |name| "#{name}:#{t}" } # e.g. mysql_dbpool:build
-end
+  task :clear do
+    jar_path = File.join(TRINIDAD_LIBS, dbcp_jar)
+    rm jar_path if File.exist?(jar_path)
+  end
 
-desc "Clear out all built .gem files"
-task :clear do
-  FileUtils.rm Dir["*.gem"]
-  FileUtils.rm_r Dir["pkg/*"] if File.exist?("pkg")
 end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ['--color', "--format documentation"]
-end
-
-task :default => :spec

data/lib/trinidad_dbpool.rb

@@ -2,6 +2,6 @@ require 'java'
 
 require 'trinidad'
 require 'trinidad/jars'
-require File.expand_path('../../trinidad-libs/tomcat-dbcp', __FILE__)
+load File.expand_path('../../trinidad-libs/tomcat-dbcp.jar', __FILE__)
 
 require 'trinidad_dbpool/webapp_extension'

data/lib/trinidad_dbpool/webapp_extension.rb

@@ -10,21 +10,29 @@ module Trinidad
         end
       end
       
-      private
-      def create_resource tomcat, app_context, opts
-        jndi, url = opts.delete(:jndi), opts.delete(:url)
+      protected
+      def create_resource tomcat, app_context, options
+        jndi, url = options.delete(:jndi), options.delete(:url)
         url = protocol + url unless %r{^#{protocol}} =~ url
-        opts[:url] = url
-                
-        driver_name = opts.delete(:driver) || self.driver_name
+        options[:url] = url
         
+        driver_name = options.delete(:driver) || options.delete(:driverName) || 
+                      self.driver_name
+                    
+        # <Resource name="jdbc/MyDB" 
+        #           auth="Container" 
+        #           type="javax.sql.DataSource"
+        #           url="jdbc:mysql://localhost:3306/mydb"
+        #           driverClassName="com.mysql.jdbc.Driver"
+        #           maxActive="100" maxIdle="30" maxWait="10000"
+        #           username="root" password="secret" />
         resource = Trinidad::Tomcat::ContextResource.new
-        resource.set_auth(opts.delete(:auth)) if opts.has_key?(:auth)
-        resource.set_description(opts.delete(:description)) if opts.has_key?(:description)
+        resource.set_auth(options.delete(:auth)) if options.has_key?(:auth)
+        resource.set_description(options.delete(:description)) if options.has_key?(:description)
         resource.set_name(jndi)
         resource.set_type('javax.sql.DataSource')
 
-        opts.each { |key, value| resource.set_property(key.to_s, value.to_s) }
+        options.each { |key, value| resource.set_property(key.to_s, value.to_s) }
         resource.set_property('driverClassName', driver_name)
 
         app_context.naming_resources.add_resource(resource)

metadata

@@ -2,7 +2,7 @@
 name: trinidad_dbpool
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-31 00:00:00 Z
+date: 2012-12-22 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad_jars
@@ -52,15 +52,17 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+  - README.md
+  - History.txt
   - LICENSE
-  - README.rdoc
+  - Rakefile
 files: 
   - lib/trinidad_dbpool.rb
   - lib/trinidad_dbpool/webapp_extension.rb
   - trinidad-libs/tomcat-dbcp.jar
+  - README.md
   - History.txt
   - LICENSE
-  - README.rdoc
   - Rakefile
 homepage: http://github.com/trinidad/trinidad_dbpool_extension
 licenses: []
@@ -85,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Addon to support database pools in Trinidad

data/README.rdoc

@@ -1,56 +0,0 @@
-= trinidad-dbpool
-
-Trinidad extensions to support database connection pools configured into the Apache Tomcat
-container.
-
-== Pools supported
-
-* MySql (trinidad_mysql_dbpool_extension)
-* PostgreSQL (trinidad_postgresql_dbpool_extension)
-* Mssql (trinidad_mssql_dbpool_extension)
-* Oracle (trinidad_oracle_dbpool_extension)
-
-== Usage
-
-* Install the extension gem, ie: jruby -S gem install trinidad_mysql_dbpool_extension
-* Configure the pool into the trinidad's configuration file, ie:
-
-  web_apps:
-    default:
-      extensions:
-        mysql_dbpool:                                   # EXTENSION NAME AS KEY
-          jndi: 'jdbc/TestDB'                           # jndi name
-          username: 'root'                              # database username
-          password: 'root'                              # database password
-          url: 'jdbc:mysql://localhost:3306/javatest'   # database url
-          maxActive: 100                                # max nodes actives
-          maxIdle: 30                                   # max nodes idles
-          maxWait: 10000                                # max nodes waiting
-
-_jndi_, _username_, _password_ and _url_ are mandatory, while other
-configuration options can be found here:
-
-http://tomcat.apache.org/tomcat-6.0-doc/jndi-datasource-examples-howto.html
-
-http://commons.apache.org/dbcp/configuration.html
-
-* Configure your rails application to use jndi into the config/database.yml
-
-  production:
-    adapter: jdbc
-    jndi: java:/comp/env/jdbc/TestDB
-    driver: com.mysql.jdbc.Driver     # jdbc driver is mandatory
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 David Calavera. See LICENSE for details.