trinidad_mysql_dbpool_extension 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,13 @@
+== 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.rdoc

@@ -1,45 +1,84 @@
 = trinidad-dbpool
 
-Trinidad extensions to support database connection pools configured into the Apache Tomcat
-container.
+Trinidad extensions to support database connection pooling on top of the 
+underlying Apache Tomcat container.
 
-== Pools supported
+Please note, that such pools are usually configured as "global" and thus 
+shareable by multiple applications deployed on to of Trinidad server.
 
-* MySql (trinidad_mysql_dbpool_extension)
+== Available Pools
+
+* MySQL (trinidad_mysql_dbpool_extension)
 * PostgreSQL (trinidad_postgresql_dbpool_extension)
-* Mssql (trinidad_mssql_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 extension gem, ie: jruby -S gem install trinidad_mysql_dbpool_extension
-* Configure the pool into the trinidad's configuration file, ie:
+* Install the gem e.g. `jruby -S gem install trinidad_mysql_dbpool_extension`
+* Configure the pool with Trinidad's configuration file e.g. :
 
-  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:
+    web_apps:
+      default:
+        extensions:
+          mysql_dbpool:                        # EXTENSION NAME AS KEY
+            jndi: 'jdbc/TestDB'                # JNDI name
+            username: 'root'                   # database username
+            password: 'root'                   # database password
+            url: 'localhost:3306/javatest'     # database URL (or full jdbc: 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 supported configuration options might 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
+* 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 here
+
+== 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 :
+
+    ---
+      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 it's on class-path
+          driverName: com.ibm.db2.jcc.DB2Driver  # might resolve from driverPath
+
+Beyond standard configuration options there's 2 specific options here :
+
+* _driverPath_ should be a path to your JDBC driver archive, if you're using a
+  --libs jar folder with trinidad, might leave that out but make sure it's on 
+  the class-path for each and every deployed application that requires it.
+
+  Also in case driverPath: is ommited you'll need to specify a driverName: !
 
-  production:
-    adapter: jdbc
-    jndi: java:/comp/env/jdbc/TestDB
-    driver: com.mysql.jdbc.Driver     # jdbc driver is mandatory
+* _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
 
 == Note on Patches/Pull Requests
  
@@ -47,10 +86,9 @@ http://commons.apache.org/dbcp/configuration.html
 * 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.
+Copyright (c) 2012 [Team Trinidad](https://github.com/trinidad). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/Rakefile

@@ -31,7 +31,14 @@ def release(gem, version = nil)
   sh "gem push #{gem_file}"
 end
 
-all_gems = %W{ dbpool mysql_dbpool_extension postgresql_dbpool_extension mssql_dbpool_extension oracle_dbpool_extension }
+all_gems = %W{ 
+  dbpool 
+  generic_dbpool_extension 
+  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

data/lib/trinidad_mysql_dbpool_extension.rb

@@ -1,3 +1,3 @@
 require 'trinidad_dbpool'
-require File.expand_path('../../trinidad-libs/mysql-connector-java-5.1.20-bin', __FILE__)
+load File.expand_path('../../trinidad-libs/mysql-connector-java-5.1.22.jar', __FILE__)
 require 'trinidad_mysql_dbpool_extension/mysql_webapp_extension'

metadata

@@ -2,7 +2,7 @@
 name: trinidad_mysql_dbpool_extension
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-31 00:00:00 Z
+date: 2012-11-29 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad_dbpool
@@ -57,7 +57,7 @@ extra_rdoc_files:
 files: 
   - lib/trinidad_mysql_dbpool_extension.rb
   - lib/trinidad_mysql_dbpool_extension/mysql_webapp_extension.rb
-  - trinidad-libs/mysql-connector-java-5.1.20-bin.jar
+  - trinidad-libs/mysql-connector-java-5.1.22.jar
   - History.txt
   - LICENSE
   - README.rdoc
@@ -85,7 +85,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 MySQL database pools in Trinidad