connectator 0.0.7 → 0.0.8

data/README.md

@@ -1,20 +1,75 @@
 # Connectator [![Build Status](https://travis-ci.org/jamin4jc/connectator.png?branch=master)](https://travis-ci.org/jamin4jc/connectator)
  
-Multi-Connection proxy for DBI
+Multi-System Connection Proxy Mutator
 
-## Notes
+## Setup/Installation
 
-*This gem is currently using the older DBI gem.*
-https://github.com/erikh/ruby-dbi
+* Connect to any system (at least theoretically).  This gem is a multi-system
+connection proxy.  Right now the gem only supports database connections through
+a fork of the ruby-dbi gem by Erik Hollensbe called connectator-dbi.  This gem
+is only intended to be used on UNIX/Linux type systems.
 
-This will at some point in the future change to use the new rdbi gem.
-https://github.com/RDBI/rdbi
+In addition to the gem, your system needs to have unixODBC for most of the
+database connections except for Oracle.  FreeTDS is required for SQL Server
+and Sybase.  If you want to use MySQL, you will need to set up the MySQL ODBC
+client.  The same goes for DB2
+
+### System Software
+
+#### unixODBC (http://www.unixodbc.org)
+
+    sudo apt-get install unixodbc
+
+After installing unixODBC, you will need to set up your unixodbc.ini.  This
+gem expects that to use DSN-less (unnamed) configurations for systems as
+opposed to specifying each system in your unixodbc.ini.  There is an
+example_odbcinst.ini in this project.  Some of the syntax is very important.
+For instance the names of each section needs to be exactly as specified,
+but the location of the Driver and Setup files should match your system.
+Other settings are per your discretion.
+
+This file is generally located on your system at /etc/odbcinst.ini.
+
+#### FreeTDS (http://freetds.schemamania.org)
+
+FreeTDS is used as the driver for the SQL Server and Sybase Connectator.
+
+Install the FreeTDS package if you want to use SQL Server or Syabase.
+On Ubuntu this would equate to:
+
+    sudo apt-get install freetds
+
+#### MySQL Client for ODBC
+
+Install the MySQL client for ODBC if you want to use the MySQL Connectator.
+On Ubuntu this would equate to:
+
+    sudo apt-get install libmyodbc
+
+#### Oracle Client
+
+Install an Oracle Client if you want to use the Oracle Connectator
+
+To use the Oracle Connectator you will need to install some kind of Oracle
+client, either the instant client or full client. There are plenty of
+instructions online for setting this up, so I will not elaborate here.
+
+#### DB2 Client
+
+Install the DB2 client if you want to use the DB2 Connectator
+
+### Gem Installation
+
+    gem install connectator
+    gem install ruby-oci8   # optionally if you want to use Oracle
+
+## Connectator Systems
 
 ### 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.
+* Uses the ruby-oci8 gem directly.  Note that this gem does not directly
+require the ruby-oci8 gem.  If you need to use Oracle you should include the
+ruby-oci8 gem in your project.
 
 ### Sql Server/Sybase
 
@@ -38,11 +93,6 @@ its drivers.
 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.
-
-
 ## Usage
     
     # Initiate the connection object
@@ -56,4 +106,4 @@ See example_odbcinst.ini for a sample of what the /etc/odbcinst.ini should look
     # if there was an error, you can inspect
     c.error
     # run a select statement against the database
-    c.select_all('select * from 'foo.bar')
+    c.select_all('select * from foo.bar')

data/lib/connectator/db2/connection.rb

@@ -4,10 +4,10 @@ module Connectator
       include UsingDBIProxy
       
       def initialize(opts = {})
+        super(opts)
         connection_params.driver   = 'DB2' 
         connection_params.protocol = 'TCPIP'
         connection_params.database = opts[:database]
-        super(opts)
       end
       
       def connection_string

data/lib/connectator/factory.rb

@@ -24,17 +24,38 @@ module Connectator
     end
 
     def connection_class
-      "Connectator::#{connectator_params.kind}::Connection".constantize
+      case connectator_symbol
+      when :db2              then Connectator::DB2::Connection
+      when :mysql            then Connectator::MySQL::Connection
+      when :oracle           then Connectator::Oracle::Connection
+      when :sql, :sql_server then Connectator::SQL::Connection
+      when :sybase           then Connectator::Sybase::Connection
+      else                        raise "Connectator class was not found"
+      end
     end
 
     def extract_connectator_params
       {
-       :server   => connectator_params.server,
-       :instance => connectator_params.instance,
-       :port     => connectator_params.port,
-       :username => connectator_params.username,
-       :password => connectator_params.password
+       :server   => rescue_as_nil { connectator_params.server   },
+       :instance => rescue_as_nil { connectator_params.instance },
+       :database => rescue_as_nil { connectator_params.database },
+       :port     => rescue_as_nil { connectator_params.port     },
+       :option   => rescue_as_nil { connectator_params.option   },
+       :username => rescue_as_nil { connectator_params.username },
+       :password => rescue_as_nil { connectator_params.password }
       }
     end
+
+    private
+    
+    def connectator_symbol      
+	    rescue_as_nil { connectator_params.kind.to_s.downcase.gsub(' ','_').intern }
+    end
+
+    def rescue_as_nil
+      yield
+    rescue
+      nil
+    end
   end
 end

data/lib/connectator/mysql/connection.rb

@@ -1,15 +1,16 @@
 module Connectator
-  module Mysql 
+  module MySQL 
     class Connection < Base::Connection
       include UsingDBIProxy
 
       def initialize(opts = {})
+        super(opts)
         connection_params.driver   = 'MySQL'
         # See this url for options flags
         # http://dev.mysql.com/doc/refman/5.0/en/connector-odbc-configuration-connection-parameters.html#codbc-dsn-option-flags
+        connection_params.port     ||= '3306'
         connection_params.option   = opts[:option]   || '3'
-        connection_params.database = opts[:database] || nil
-        super(opts)
+        connection_params.database = opts[:database]
       end
       
       def connection_string

data/lib/connectator/sql/connection.rb

@@ -1,13 +1,13 @@
 module Connectator
-  module Sql
+  module SQL
     class Connection < Base::Connection
       include UsingDBIProxy
     
       def initialize(opts = {})
+        super(opts)
         connection_params.driver      = 'FreeTDS' 
         connection_params.tds_version = opts[:tds_version] || '8.0'
         connection_params.database    = opts[:database]    || 'master' 
-        super(opts)
       end
       
       def connection_string

data/lib/connectator/sql/connection/server_instance_string.rb

@@ -1,5 +1,5 @@
 module Connectator
-  module Sql
+  module SQL
     class Connection < Base::Connection
       class ServerInstanceString
         def self.build(server, instance)

data/spec/connectator/base/connection_spec.rb

@@ -3,7 +3,7 @@ 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/  }
+    Then { lambda { Connectator::SQL::Connection.new() }.should raise_error /Connection Options are required/  }
   end
   
   describe "initalized with basic params" do

data/spec/connectator/factory_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Connectator::Factory do
+
+  describe "a params object with an undefined kind" do
+    Given(:connection_params_object) { Object.new }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+    Then { lambda { factory.connection_class }.should raise_error /not found/ }
+  end
+ 
+  describe "DB2" do 
+    Given(:connection_params_object) { OpenStruct.new(:kind => kind) }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+
+    describe "'DB2'" do
+      Given(:kind) { 'DB2' }
+      Then { factory.connection_class.should == Connectator::DB2::Connection }
+    end
+    
+    describe "'db2'" do
+      Given(:kind) { 'db2' }
+      Then { factory.connection_class.should == Connectator::DB2::Connection }
+    end
+    
+    describe ":db2" do
+      Given(:kind) { :db2 }
+      Then { factory.connection_class.should == Connectator::DB2::Connection }
+    end
+  end
+  
+  describe "MySQL" do 
+    Given(:connection_params_object) { OpenStruct.new(:kind => kind) }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+
+    describe "'MySQL'" do
+      Given(:kind) { 'MySQL' }
+      Then { factory.connection_class.should == Connectator::MySQL::Connection }
+    end
+    
+    describe "'mysql'" do
+      Given(:kind) { 'mysql' }
+      Then { factory.connection_class.should == Connectator::MySQL::Connection }
+    end
+    
+    describe ":mysql" do
+      Given(:kind) { :mysql }
+      Then { factory.connection_class.should == Connectator::MySQL::Connection }
+    end
+  end
+  
+  describe "Oracle" do 
+    Given(:connection_params_object) { OpenStruct.new(:kind => kind) }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+
+    describe "'Oracle'" do
+      Given(:kind) { 'Oracle' }
+      Then { factory.connection_class.should == Connectator::Oracle::Connection }
+    end
+    
+    describe "'oracle'" do
+      Given(:kind) { 'oracle' }
+      Then { factory.connection_class.should == Connectator::Oracle::Connection }
+    end
+    
+    describe ":oracle" do
+      Given(:kind) { :oracle }
+      Then { factory.connection_class.should == Connectator::Oracle::Connection }
+    end
+  end
+
+  describe "SQL Server" do 
+    Given(:connection_params_object) { OpenStruct.new(:kind => kind) }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+
+    describe "'SQL'" do
+      Given(:kind) { 'SQL' }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+    
+    describe "'SQL Server'" do
+      Given(:kind) { 'SQL Server' }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+    
+    describe "'Sql'" do
+      Given(:kind) { 'Sql' }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+    
+    describe "'sql'" do
+      Given(:kind) { 'sql' }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+    
+    describe ":sql" do
+      Given(:kind) { :sql }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+    
+    describe ":sql_server" do
+      Given(:kind) { :sql_server }
+      Then { factory.connection_class.should == Connectator::SQL::Connection }
+    end
+  end
+
+  describe "Sybase" do 
+    Given(:connection_params_object) { OpenStruct.new(:kind => kind) }
+    When(:factory) { Connectator::Factory.new(connection_params_object) }
+
+    describe "'Sybase'" do
+      Given(:kind) { 'Sybase' }
+      Then { factory.connection_class.should == Connectator::Sybase::Connection }
+    end
+    
+    describe "'sybase'" do
+      Given(:kind) { 'sybase' }
+      Then { factory.connection_class.should == Connectator::Sybase::Connection }
+    end
+    
+    describe ":sybase" do
+      Given(:kind) { :sybase }
+      Then { factory.connection_class.should == Connectator::Sybase::Connection }
+    end
+  end
+end

data/spec/connectator/mysql/connection_spec.rb

@@ -1,22 +1,56 @@
 require 'spec_helper'
 
-describe Connectator::Mysql::Connection do
+describe Connectator::MySQL::Connection do
 
   describe "initalized with no params" do
-    Then { lambda { Connectator::Mysql::Connection.new() }.should raise_error /Connection Options are required/  }
+    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',
+      Connectator::MySQL::Connection.new(:server    => 'Server',
                                          :username  => 'User',
                                          :password  => 'Pass',
-                                         :instance  => 'Instance')
+					 :port      => '4040',
+                                         :instance  => 'Instance',
+					 :database  => 'meh',
+					 :option    => '42')
     }                                    
     
     Then { connection.connection_params.server.should       == 'Server'   }
-    Then { connection.connection_params.port.should         == 'Port'     }
+    Then { connection.connection_params.port.should         == '4040'     }
+    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     == 'meh'      }
+    Then { connection.connection_params.option.should       == '42'       }
+
+    Then { connection.connection_string.should ==
+          "DBI:ODBC:DRIVER=MySQL;SERVER=Server;PORT=4040;DATABASE=meh;UID=User;PWD=Pass;OPTION=42"  }
+
+    Then { connection.send(:connection_params_hash).should == 
+      {
+       "DRIVER"      => 'MySQL',
+       "SERVER"      => 'Server',
+       "PORT"        => '4040',
+       "DATABASE"    => 'meh',
+       "UID"         => 'User',
+       "PWD"         => 'Pass',
+       "OPTION"      => '42'
+      }
+    }
+  end
+
+  describe "initalized with missing optional params" do
+    Given(:connection) {
+      Connectator::MySQL::Connection.new(:server    => 'Server',
+					 :username  => 'User',
+					 :password  => 'Pass',
+					 :instance  => 'Instance')
+    }                                    
+    
+    Then { connection.connection_params.server.should       == 'Server'   }
+    Then { connection.connection_params.port.should         == '3306'     }
     Then { connection.connection_params.username.should     == 'User'     }
     Then { connection.connection_params.password.should     == 'Pass'     }
     Then { connection.connection_params.instance.should     == 'Instance' }
@@ -24,13 +58,13 @@ describe Connectator::Mysql::Connection do
     Then { connection.connection_params.option.should       == '3'        }
 
     Then { connection.connection_string.should ==
-          "DBI:ODBC:DRIVER=MySQL;SERVER=Server;PORT=Port;UID=User;PWD=Pass;OPTION=3"  }
+	  "DBI:ODBC:DRIVER=MySQL;SERVER=Server;PORT=3306;UID=User;PWD=Pass;OPTION=3"  }
 
     Then { connection.send(:connection_params_hash).should == 
       {
        "DRIVER"      => 'MySQL',
        "SERVER"      => 'Server',
-       "PORT"        => 'Port',
+       "PORT"        => '3306',
        "DATABASE"    => nil,
        "UID"         => 'User',
        "PWD"         => 'Pass',

data/spec/connectator/sql/connection_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe Connectator::Sql::Connection do
+describe Connectator::SQL::Connection do
 
   describe "initalized with no params" do
-    Then { lambda { Connectator::Sql::Connection.new() }.should raise_error /Connection Options are required/  }
+    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',
+      Connectator::SQL::Connection.new(:server    => 'Server',
                                        :port      => 'Port',
                                        :username  => 'User',
                                        :password  => 'Pass',
@@ -40,25 +40,25 @@ describe Connectator::Sql::Connection do
   end
 
   describe "with no instance" do
-    Given(:connection) { Connectator::Sql::Connection.new(:server    => 'Server',
+    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',
+    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',
+    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',
+    Given(:connection) { Connectator::SQL::Connection.new(:server    => 'Server',
                                                           :instance  => 'Host\Instance_Foo') }                                    
     Then { connection.send(:server_instance_string).should == 'Server\Instance_Foo' }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: connectator
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dbi
@@ -131,6 +131,7 @@ files:
 - spec/connectator/pinger_spec.rb
 - spec/connectator/base/connection_spec.rb
 - spec/connectator/db2/connection_spec.rb
+- spec/connectator/factory_spec.rb
 - spec/connectator/sybase/connection_spec.rb
 - spec/connectator/mysql/connection_spec.rb
 - spec/connectator/sql/connection_spec.rb
@@ -150,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3410537790936780615
+      hash: -3195616566247278493
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: