rsconn 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c30c89eb0d8df0325b2e030f9456e007b73bd91
-  data.tar.gz: f92be0b7307b051a9ae335b9b23d2d5428bd730a
+  metadata.gz: 4c73efb8028b4d0dff9f7eb0a69c9ebded1bf2da
+  data.tar.gz: c81d08bff44458589a05d2969b7125b4c3f3043a
 SHA512:
-  metadata.gz: 974295630b65b75e56c3c46540fa4201b158dbd2b1abd1e0f78fecf0d45bd06e4adff49bb1c9ed636e00e875c9d51535cd821622028540e0d336fffa27cffa5c
-  data.tar.gz: 17a74642754c11403981bb81105c1fa1a6877914fead77a2c0c71f39a3107cdff04cbd35d3997693cb340a4b0424fcd3fff0aa52c2d4f57989795f3f31ea7a70
+  metadata.gz: 0e6875b2bb4e679d072ea8c50daa57153468748b0c2399f80772146b4280e5d74c777c8ac46fdadeb579e2090659cdd14a130fd3e651338616c5e0b9b7ee9613
+  data.tar.gz: f243366883222b1b1afac47dbee1742e407ecc3964566b324d39f5040697f38a06b84e4877400e3f2a91bac92c71cd3049e1dd4efaa88f9094ed4be17b298df4

data/README.md

@@ -1,6 +1,6 @@
 # rsconn
 
-TODO: Write a gem description
+A convenience wrapper to make interaction with a Redshift cluster easier.
 
 ## Installation
 
@@ -18,7 +18,32 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This is an example of connecting to and using a Redshift database using a JDBC URL.
+
+    require 'rsconn'
+
+    url = Rsconn::JdbcUrl.new(ENV['RSCONN_JDBC_URL'])
+
+    db_conn = Rsconn::Redshift.new(
+      url.host,
+      url.port,
+      url.database,
+      ENV['RSCONN_USER'],
+      ENV['RSCONN_PASSWORD'],
+    )
+
+    # For updates, inserts, deletes, etc., use #execute.
+    db_conn.execute('CREATE TABLE reg.students (id integer, name varchar(100))')
+    db_conn.execute("INSERT INTO reg.students VALUES (1, 'Dean')")
+
+    # Queries return an easy to use data structure - there's no need to manually
+    # create and iterate through cursors
+    rows = db_conn.query('SELECT * FROM reg.students WHERE id = 1')
+
+    puts "Use the column name: #{rows.first['name']}"
+    puts "Or use the column index: {rows.first[1]}"
+
+    # To run non-query SQL statements from a script, use #execute_script
 
 ## Contributing
 
@@ -27,3 +52,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Running tests
+
+The tests need to connect to a Redshift cluster. Set the environment variables `RSCONN_JDBC_URL`, `RSCONN_USER`, `RSCONN_PASSWORD` and make sure the cluster has a `test` schema.

data/lib/rsconn.rb

@@ -5,7 +5,7 @@ module Rsconn
   class Redshift < Postgres
     attr_reader :query_group, :query_slot_count
 
-    def initialize(jdbc_url, user, password, options={})
+    def initialize(host, port, database, user, password, options={})
       super
       @query_group = options.fetch(:query_group, nil)
       @query_slot_count = options.fetch(:query_slot_count, nil)

data/lib/rsconn/jdbc_url.rb

@@ -6,7 +6,7 @@ module Rsconn
       @url = url
       @host = @url.split('//').last.split(':').first
       @port = @url.split(':').last.split('/').first.to_i
-      @database = @url.split('/').last
+      @database = @url.split('/').last.split('?').first
 
       db_type = @url.split(':')[1]
 

data/lib/rsconn/postgres.rb

@@ -14,15 +14,17 @@ module Rsconn
   class Postgres
     attr_reader :conn
 
-    def initialize(jdbc_url, user, password, options={})
-      fail_if_invalid_connection_credentials(jdbc_url, user, password)
+    def initialize(host, port, database, user, password, options={})
+      fail_if_invalid_connection_credentials(host, port, database, user, password)
 
+      @host = host
+      @port = port
+      @database = database
+      @user = user
+      @password = password
       @abort_on_error = options.fetch(:abort_on_error, true)
       @max_retries = options.fetch(:max_retries, 3)
       @quiet = options.fetch(:quiet, false)
-      @jdbc_url = JdbcUrl.new(jdbc_url)
-      @user = user
-      @password = password
       @error_occurred = false
       @retry_count = 0
 
@@ -94,18 +96,20 @@ module Rsconn
 
     private
 
-    def fail_if_invalid_connection_credentials(jdbc_url, user, password)
-      fail ArgumentError, 'jdbc_url needs to be a string' unless jdbc_url.is_a?(String)
+    def fail_if_invalid_connection_credentials(host, port, database, user, password)
+      fail ArgumentError, 'host needs to be a string' unless host.is_a?(String)
+      fail ArgumentError, 'database needs to be a string' unless database.is_a?(String)
       fail ArgumentError, 'user needs to be a string' unless user.is_a?(String)
       fail ArgumentError, 'password needs to be a string' unless password.is_a?(String)
+      fail ArgumentError, 'port needs to be a integer' unless port.to_s =~ /\A\d+\z/
     end
 
     def init_connection
       with_error_handling do
         @conn = PGconn.open(
-          :host => @jdbc_url.host,
-          :port => @jdbc_url.port,
-          :dbname => @jdbc_url.database,
+          :host => @host,
+          :port => @port,
+          :dbname => @database,
           :user => @user,
           :password => @password,
         )

data/lib/rsconn/version.rb

@@ -1,3 +1,3 @@
 module Rsconn
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/dev_redshift.rb

@@ -5,8 +5,17 @@ module Rsconn
   class DevRedshift < Redshift
 
     def initialize(options={})
+      unless ENV['RSCONN_JDBC_URL'] && ENV['RSCONN_USER'] && ENV['RSCONN_PASSWORD']
+        fail 'The environment variables RSCONN_JDBC_URL, RSCONN_USER, and ' +
+             'RSCONN_PASSWORD must be set to run the tests'
+      end
+
+      url = JdbcUrl.new(ENV['RSCONN_JDBC_URL'])
+
       super(
-        ENV['RSCONN_JDBC_URL'],
+        url.host,
+        url.port,
+        url.database,
         ENV['RSCONN_USER'],
         ENV['RSCONN_PASSWORD'],
         options

data/spec/jdbc_url_spec.rb

@@ -7,7 +7,8 @@ module Rsconn
     HOST = 'host.redshift.amazonaws.com'
     PORT = 5439
     DATABASE = 'dbname'
-    JDBC_URL = "jdbc:postgresql://#{HOST}:#{PORT}/#{DATABASE}"
+    OPTIONS = 'tcpKeepAlive=true'
+    JDBC_URL = "jdbc:postgresql://#{HOST}:#{PORT}/#{DATABASE}?#{OPTIONS}"
     MYSQL_URL = "jdbc:mysql://#{HOST}:#{PORT}/#{DATABASE}"
 
     describe '#new' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsconn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dean Morin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-13 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg