connectator 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,43 @@
+connectator
+===========
+
+Multi-Connection proxy for DBI
+
+== Notes
+
+*This gem is currently using the older DBI gem.*
+https://github.com/erikh/ruby-dbi
+
+This will at some point in the future change to use the new rdbi gem.
+https://github.com/RDBI/rdbi
+
+=== Oracle
+
+* Uses the ruby-oci8 gem directly
+* Note that this gem does not directly require the ruby-oci8 gem.  If you need
+to use Oracle, include the ruby-oci8 gem in your project.
+
+=== Sql Server/Sybase
+
+* Uses DBI:ODBC
+* In order to use SQL Server/Sybase with Connectator, you will need to set up
+Unix ODBC and FreeTDS.  Unix ODBC will need to reference FreeTDS as one of its
+drivers.
+
+=== MySQL
+
+* Uses DBI:ODBC
+* In order to use MySQL with Connectator, you will need to set up Unix ODBC and
+the MySQL client. Unix ODBC will need to reference the MySQL driver as one of
+its drivers.
+
+=== DB2
+
+* Uses DBI:DB2
+* In order to use DB2 with Connectator, you will need to set up Unix ODBC and
+the DB2 client. Unix ODBC will need to reference the DB2 driver as one of its
+drivers.
+
+== UNIX ODBC
+
+See example_odbcinst.ini for a sample of what the /etc/odbcinst.ini should look like.

data/example_odbcinst.ini

@@ -0,0 +1,19 @@
+[FreeTDS]
+Description     = TDS driver (Sybase/MS SQL)
+Driver          = /usr/lib/odbc/libtdsodbc.so
+Setup           = /usr/lib/odbc/libtdsS.so
+CPTimeout       =
+CPReuse         =
+FileUsage       = 1
+
+[MySQL]
+Description     = MySQL
+Driver          = /usr/lib64/libmyodbc5.so
+Setup           = /usr/lib64/libodbcmyS.so
+FileUsage       = 1
+
+[DB2]
+Description     = DB2 DRIVER (DB2)
+Driver          = /path/to/your/clidriver/lib/libdb2o.so
+FileUsage       = 1
+DontDLClose     = 1

data/lib/connectator.rb

@@ -1,5 +1,6 @@
 require 'connectator/base/connection'
 require 'connectator/db2/connection'
+require 'connectator/mysql/connection'
 require 'connectator/oracle/connection'
 require 'connectator/sql/connection'
 require 'connectator/sql/connection/server_instance_string'

data/lib/connectator/base/connection.rb

@@ -19,16 +19,17 @@ module Connectator
         @connection_params ||= OpenStruct.new
       end
 
-      def dbi
-        @dbi ||= open
+      def system_connection
+        @system_connection ||= DBIProxy.new(open)
       end
       
-      def close
-        dbi.disconnect
+      # proxies all other method calls to the DBIProxy
+      def method_missing(method, *args, &blk)
+        system_connection.send(method, *args, &blk)
       end
 
       def valid?
-        ping? && valid_dbi?
+        ping? && valid_system_connection?
       end
 
       def ping?
@@ -40,18 +41,13 @@ module Connectator
         end
       end
 
-      def valid_dbi?
-        dbi
+      def valid_system_connection?
+        system_connection.connection
         true
-      rescue DBI::DatabaseError => e
+      rescue => e
         @connection_error = e.message
         false
       end
-
-      def method_missing(method, *args, &blk)
-        puts method
-        dbi.send(method, *args, &blk)
-      end
       
       def connection_string
         raise 'Abstract Method'

data/lib/connectator/base/dbi_proxy.rb

@@ -0,0 +1,33 @@
+module Connectator
+  module Base
+    class DBIProxy
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def connection
+        @connection
+      end
+
+      def close
+        connection.disconnect
+      end
+
+      # Do not use this method on queries that return lots of data
+      # because it would use a lot of memory.
+      def select_all_to_hash(query)
+        result = []
+        sth = connection.execute(query)
+        sth.fetch_hash do |row|
+          result << row
+        end
+        result
+      end
+
+      def method_missing(method, *args, &blk)
+        connection.send(method, *args, &blk)
+      end
+    end
+  end
+end

data/lib/connectator/mysql/connection.rb

@@ -0,0 +1,32 @@
+module Connectator
+  module Mysql 
+    class Connection < Base::Connection
+
+      def initialize(opts = {})
+        connection_params.driver   = 'MySQL'
+        connection_params.option   = opts[:option]   || '3'
+        connection_params.port     = opts[:port]     || '3306'
+        connection_params.database = opts[:database] || ''
+        super(opts)
+      end
+      
+      def connection_string
+        "DBI:ODBC:#{connection_params_list}"
+      end
+
+      private
+     
+      def connection_params_hash
+        {
+         "DRIVER"      => connection_params.driver,
+         "Server"      => connection_params.server,
+         "Port"        => connection_params.port,
+         "Database"    => connection_params.database,
+         "User"        => connection_params.username,
+         "Password"    => connection_params.password,
+         "Option"      => connection_params.option
+        }
+      end
+    end
+  end
+end

data/lib/connectator/sql/connection.rb

@@ -3,9 +3,9 @@ module Connectator
     class Connection < Base::Connection
     
       def initialize(opts = {})
-        connection_params.tds_version = '8.0'
-        connection_params.database    = 'master' 
         connection_params.driver      = 'FreeTDS' 
+        connection_params.tds_version = opts[:tds_version] || '8.0'
+        connection_params.database    = opts[:database]    || 'master' 
         super(opts)
       end
       

data/lib/connectator/sybase/connection.rb

@@ -3,9 +3,9 @@ module Connectator
     class Connection < Base::Connection
 
       def initialize(opts = {})
-        connection_params.tds_version = '5.0'
-        connection_params.database    = 'master'
         connection_params.driver      = 'FreeTDS' 
+        connection_params.tds_version = opts[:tds_version] || '5.0'
+        connection_params.database    = opts[:database]    || 'master'
         super(opts)
       end
       

data/spec/connectator/base/connection_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Connectator::Base::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::Sql::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::Base::Connection.new(:server    => 'Server',
+                                        :port      => 'Port',
+                                        :username  => 'User',
+                                        :password  => 'Pass',
+                                        :instance  => 'Instance')
+    }                                    
+    
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+
+    Then { lambda { connection.connection_string }.should raise_error /Abstract Method/  }
+    Then { lambda { connection.send :connection_params_hash }.should raise_error /Abstract Method/  }
+  end
+
+  describe "initalized with a valid server" do
+    Given(:connection) {
+      Connectator::Base::Connection.new(:server    => 'localhost')
+    }                                    
+    Then { connection.connection_params.server.should       == 'localhost' }
+    Then { connection.ping?.should be_true }
+
+    describe "initalized with a valid system connection" do
+      Given { connection.stub(:valid_system_connection?).and_return(true) }
+      Then { connection.valid?.should be_true }
+    end
+  end
+  
+  describe "initalized with a valid dbi connection" do
+    Given(:connection) {
+      Connectator::Base::Connection.new(:server => 'localhost')
+    }                                    
+    Then { connection.connection_params.server.should       == 'localhost' }
+    Then { connection.ping?.should be_true }
+  end
+
+end

data/spec/connectator/db2/connection_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Connectator::DB2::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::DB2::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::DB2::Connection.new(:server    => 'Server',
+                                       :port      => 'Port',
+                                       :username  => 'User',
+                                       :password  => 'Pass',
+                                       :instance  => 'Instance',
+                                       :database  => 'ABCDEFG')
+    }                                    
+    
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+    Then { connection.connection_params.protocol.should     == 'TCPIP'    }
+    Then { connection.connection_params.driver.should       == 'DB2'      }
+    Then { connection.connection_params.database.should     == 'ABCDEFG'  }
+
+    Then { connection.connection_string.should == 
+           'DBI:ODBC:DRIVER=DB2;PROTOCOL=TCPIP;HOSTNAME=Server;Port=Port;DATABASE=ABCDEFG;UID=User;PWD=Pass' }
+  end
+end

data/spec/connectator/mysql/connection_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Connectator::Mysql::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::Mysql::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::Mysql::Connection.new(:server    => 'Server',
+                                         :port      => 'Port',
+                                         :username  => 'User',
+                                         :password  => 'Pass',
+                                         :instance  => 'Instance')
+    }                                    
+    
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+    Then { connection.connection_params.database.should     == ''         }
+    Then { connection.connection_params.option.should       == '3'        }
+
+    Then { connection.connection_string.should ==
+          "DBI:ODBC:DRIVER=MySQL;Server=Server;Port=Port;Database=;User=User;Password=Pass;Option=3"  }
+
+    Then { connection.send(:connection_params_hash).should == 
+      {
+       "DRIVER"      => 'MySQL',
+       "Server"      => 'Server',
+       "Port"        => 'Port',
+       "Database"    => '',
+       "User"        => 'User',
+       "Password"    => 'Pass',
+       "Option"      => '3'
+      }
+    }
+  end
+end
+

data/spec/connectator/oracle/connection_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Connectator::Oracle::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::Oracle::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::Oracle::Connection.new(:server    => 'Server',
+                                          :port      => 'Port',
+                                          :username  => 'User',
+                                          :password  => 'Pass',
+                                          :instance  => 'Instance')
+    }                                    
+
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+    
+    Then { connection.connection_string.should == 'DBI:OCI8://Server:Port/Instance' }
+  end
+end

data/spec/connectator/pinger_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Connectator::Pinger do
+  
+  Then { Connectator::Pinger.ping?('localhost').should be_true }
+  Then { Connectator::Pinger.ping?('iamnotahostname').should be_false }
+
+  describe "worse than the allowable timeout" do
+    Given { Connectator::Pinger.stub(:system_ping_command).and_return("sleep 1.000001") }
+    Then { Connectator::Pinger.ping?('localhost', 1).should be_false }
+  end
+  
+  describe "better than the allowable timeout" do
+    Given { Connectator::Pinger.stub(:system_ping_command).and_return("sleep 0.01") }
+    Then { Connectator::Pinger.ping?('localhost', 1).should be_true }
+  end
+end

data/spec/connectator/sql/connection_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Connectator::Sql::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::Sql::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::Sql::Connection.new(:server    => 'Server',
+                                       :port      => 'Port',
+                                       :username  => 'User',
+                                       :password  => 'Pass',
+                                       :instance  => 'Instance')
+    }                                    
+
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+    Then { connection.connection_params.tds_version.should  == '8.0'      }
+    Then { connection.connection_params.database.should     == 'master'   }
+
+    Then { connection.connection_string.should ==
+          "DBI:ODBC:DRIVER=FreeTDS;TDS_Version=8.0;SERVER=Server;Port=Port;DATABASE=master;UID=User;PWD=Pass"  }
+    Then { connection.send(:connection_params_hash).should == 
+      {
+       "DRIVER"      => 'FreeTDS',
+       "TDS_Version" => '8.0',
+       "SERVER"      => 'Server',
+       "Port"        => 'Port',
+       "DATABASE"    => 'master',
+       "UID"         => 'User',
+       "PWD"         => 'Pass'
+      }
+    }
+  end
+
+  describe "with no instance" do
+    Given(:connection) { Connectator::Sql::Connection.new(:server    => 'Server',
+                                                          :instance  => nil) }                                    
+    Then { connection.send(:server_instance_string).should == 'Server' }
+  end
+
+  describe "with an instance of format X\Y" do
+    Given(:connection) { Connectator::Sql::Connection.new(:server    => 'Server',
+                                                          :instance  => 'Host\Instance') }                                    
+    Then { connection.send(:server_instance_string).should == 'Server\Instance' }
+  end
+  
+  describe "with an instance of format X\Y$Z" do
+    Given(:connection) { Connectator::Sql::Connection.new(:server    => 'Server',
+                                                          :instance  => 'Host\Instance$Foo') }                                    
+    Then { connection.send(:server_instance_string).should == 'Server\Instance$Foo' }
+  end
+  
+  describe "with an instance of format X\Y_Z" do
+    Given(:connection) { Connectator::Sql::Connection.new(:server    => 'Server',
+                                                          :instance  => 'Host\Instance_Foo') }                                    
+    Then { connection.send(:server_instance_string).should == 'Server\Instance_Foo' }
+  end
+end

data/spec/connectator/sybase/connection_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Connectator::Sybase::Connection do
+
+  describe "initalized with no params" do
+    Then { lambda { Connectator::Sybase::Connection.new() }.should raise_error /Connection Options are required/  }
+  end
+  
+  describe "initalized with basic params" do
+    Given(:connection) {
+      Connectator::Sybase::Connection.new(:server    => 'Server',
+                                          :port      => 'Port',
+                                          :username  => 'User',
+                                          :password  => 'Pass',
+                                          :instance  => 'Instance')
+    }                                    
+    
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.username.should     == 'User'     }
+    Then { connection.connection_params.password.should     == 'Pass'     }
+    Then { connection.connection_params.instance.should     == 'Instance' }
+    Then { connection.connection_params.tds_version.should  == '5.0'      }
+    Then { connection.connection_params.database.should     == 'master'   }
+
+    Then { connection.connection_string.should ==
+          "DBI:ODBC:DRIVER=FreeTDS;TDS_Version=5.0;SERVER=Server;Port=Port;DATABASE=master;UID=User;PWD=Pass"  }
+
+    Then { connection.send(:connection_params_hash).should == 
+      {
+       "DRIVER"      => 'FreeTDS',
+       "TDS_Version" => '5.0',
+       "SERVER"      => 'Server',
+       "Port"        => 'Port',
+       "DATABASE"    => 'master',
+       "UID"         => 'User',
+       "PWD"         => 'Pass'
+      }
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'rspec/given'
+
+require 'connectator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connectator
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dbi
@@ -118,12 +118,24 @@ files:
 - lib/connectator/factory.rb
 - lib/connectator/oracle/connection.rb
 - lib/connectator/base/connection.rb
+- lib/connectator/base/dbi_proxy.rb
 - lib/connectator/pinger.rb
 - lib/connectator/db2/connection.rb
 - lib/connectator/sybase/connection.rb
+- lib/connectator/mysql/connection.rb
 - lib/connectator/sql/connection.rb
 - lib/connectator/sql/connection/server_instance_string.rb
-homepage: http://rubygems.org/gems/connectator
+- spec/spec_helper.rb
+- spec/connectator/oracle/connection_spec.rb
+- spec/connectator/pinger_spec.rb
+- spec/connectator/base/connection_spec.rb
+- spec/connectator/db2/connection_spec.rb
+- spec/connectator/sybase/connection_spec.rb
+- spec/connectator/mysql/connection_spec.rb
+- spec/connectator/sql/connection_spec.rb
+- README.md
+- example_odbcinst.ini
+homepage: https://github.com/jamin4jc/connectator
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -137,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2689105201860434706
+      hash: 4345797816152053971
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: