redshift-client 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e6fbf69de3d525922584318839428a561a0f6b
-  data.tar.gz: f66fd482e6d7f9c6edce75a631797e5fd18164b6
+  metadata.gz: 07134341d34da433891d4a6fabe9c092d09973a1
+  data.tar.gz: 1fffad0d484638978060447997fdc977d0cb2aa3
 SHA512:
-  metadata.gz: 83b406edb33a22f17bd980c97261aea3b6a7e0a4ee28c48c888f4ca2418b04952e986a11b5874b5cf0fe9fb2259755e4e4cd77c4a03d7be281a799b6a1a0236f
-  data.tar.gz: abbe01a0b47e299370ffd150d9fd02c788bfe78a01a1b1ab17769644e80f3c232501a81c0bba784301ca0e190e49e3e3f116736e2432c7dc29c6a99b1a985b77
+  metadata.gz: 6c4f6be049d2d7d848367c892624fa67dc64e63f725186a9005dea738d63d7ca5ab2d4f73957ee3f13ea24654b4bfafc9368414b70900c6d86fd11593e8ca983
+  data.tar.gz: 1266a3424362a90776b32832de19008f8be05b161bd5205e43ab28f4adab02dd0599e527d1c09d476c98b2f743700bbe754b9ca1891eb83d65066cecb7c0a117

data/README.md

@@ -1,6 +1,6 @@
 # Redshift::Client [![Build Status](https://travis-ci.org/dakatsuka/redshift-client.svg)](https://travis-ci.org/dakatsuka/redshift-client) [![Gem Version](https://badge.fury.io/rb/redshift-client.svg)](https://badge.fury.io/rb/redshift-client)
 
-The ruby client for AWS Redshift.
+This gem provides a way to connect to AWS Redshift using the [ruby-pg](https://github.com/ged/ruby-pg).
 
 ## Installation
 
@@ -12,7 +12,7 @@ gem 'redshift-client'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,19 +20,27 @@ Or install it yourself as:
 
 ## Usage
 
-Please set `REDSHIFT_URL` Env.
+### Using with your application
+
+```ruby
+require 'rubygems'
+require 'redshift/client'
+```
+
+After that you configure the url of Redshift:
 
 ```
 $ export REDSHIFT_URL="redshift://user:password@*****.region.redshift.amazonaws.com:5439/dbname"
 ```
 
-```ruby
-require 'redshift/client'
+Please refer to the following code:
 
+```ruby
 Redshift::Client.establish_connection
-Redshift::Client.connection # instance of PG::Connection
 
-Redshift::Client.connection.exec("SELECT GETDATE()").first # => {"getdate"=>"2015-10-08 05:17:40"}
+Redshift::Client.connection
+Redshift::Client.connection.exec("SELECT GETDATE()").first # delegate to PG::Connection
+# => {"getdate"=>"2015-10-08 05:17:40"}
 ```
 
 ## Development
@@ -43,7 +51,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/redshift-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dakatsuka/redshift-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/redshift/client.rb

@@ -1,6 +1,7 @@
 require "redshift/client/version"
 require "redshift/client/errors"
 require "redshift/client/configuration"
+require "redshift/client/connection"
 require "redshift/client/connection_handling"
 
 module Redshift

data/lib/redshift/client/configuration.rb

@@ -1,9 +1,11 @@
+require 'uri'
+
 module Redshift
   module Client
     class Configuration
       attr_reader :host, :port, :user, :password, :dbname
 
-      def self.parse(config)
+      def self.resolve(config = {})
         if config.empty?
           url = URI.parse(ENV["REDSHIFT_URL"])
           self.new(url.host, url.port, url.user, url.password, url.path[1..-1])
@@ -22,7 +24,7 @@ module Redshift
         @dbname = dbname
       end
 
-      def to_hash
+      def params
         {
           host: @host,
           port: @port,

data/lib/redshift/client/connection.rb

@@ -0,0 +1,23 @@
+require 'pg'
+require 'active_support/core_ext/module'
+
+module Redshift
+  module Client
+    class Connection
+      attr_reader :original
+
+      def initialize(configuration)
+        @original = PG.connect(configuration.params)
+      end
+
+      delegate \
+        :exec,
+        :exec_params,
+        :escape,
+        :escape_string,
+        :escape_literal,
+        :close,
+        to: :original
+    end
+  end
+end

data/lib/redshift/client/connection_handling.rb

@@ -1,61 +1,54 @@
-require 'pg'
-require 'uri'
+require 'thread'
 require 'active_support/lazy_load_hooks'
 
 module Redshift
   module Client
     module ConnectionHandling
-      def establish_connection(config = {})
-        disconnect
-        initialize_thread!
-        configure!(config)
+      def establish_connection(config= {})
+        clear_connection!
+        clear_thread!
+
+        current[:configuration] = Configuration.resolve(config)
       end
 
-      def disconnect
-        if connected?
-          connection.finish
-          cleanup!
-        end
+      def connection
+        return current[:connection] if connected?
+
+        ActiveSupport.run_load_hooks :redshift_client_connection
+
+        check_established!
+        current[:connection] = Connection.new(current[:configuration])
+        current[:connection]
       end
 
-      def connected?
-        !!(thread && thread[:connection])
+      def disconnect
+        clear_connection!
       end
 
       def established?
-        !!(thread && thread[:configurations])
+        !! current[:configuration]
       end
 
-      def connection
-        ActiveSupport.run_load_hooks :redshift_client_connection unless established?
-
-        if connected?
-          thread[:connection]
-        else
-          connect!
-        end
+      def connected?
+        !! current[:connection]
       end
 
       private
-      def initialize_thread!
-        Thread.current[:redshift] = {}
-      end
-
-      def cleanup!
-        Thread.current[:redshift][:connection] = nil
+      def check_established!
+        raise ConnectionNotEstablished.new unless established?
       end
 
-      def thread
-        Thread.current[:redshift]
+      def clear_connection!
+        current[:connection] && current[:connection].close
+        current[:connection] = nil
       end
 
-      def connect!
-        raise ConnectionNotEstablished.new unless established?
-        thread[:connection] = PG.connect(thread[:configurations].to_hash)
+      def clear_thread!
+        Thread.current[:redshift] = nil
       end
 
-      def configure!(config)
-        thread[:configurations] = Configuration.parse(config)
+      def current
+        Thread.current[:redshift] ||= {}
       end
     end
   end

data/lib/redshift/client/version.rb

@@ -1,5 +1,5 @@
 module Redshift
   module Client
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end

data/redshift-client.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["d.akatsuka@gmail.com"]
 
   spec.summary       = %q{The ruby client for AWS Redshift.}
-  spec.description   = %q{The ruby client for AWS Redshift.}
+  spec.description   = %q{This gem provides a way to connect to AWS Redshift using the ruby-pg.}
   spec.homepage      = "https://github.com/dakatsuka/redshift-client"
   spec.license       = "MIT"
 

data/spec/redshift/client_spec.rb

@@ -59,8 +59,8 @@ describe Redshift::Client do
         Redshift::Client.establish_connection
       end
 
-      it "returns PG::Connection" do
-        expect(Redshift::Client.connection).to be_instance_of PG::Connection
+      it "returns an instance of connection" do
+        expect(Redshift::Client.connection).to be_instance_of Redshift::Client::Connection
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redshift-client
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dai Akatsuka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: The ruby client for AWS Redshift.
+description: This gem provides a way to connect to AWS Redshift using the ruby-pg.
 email:
 - d.akatsuka@gmail.com
 executables: []
@@ -98,6 +98,7 @@ files:
 - bin/setup
 - lib/redshift/client.rb
 - lib/redshift/client/configuration.rb
+- lib/redshift/client/connection.rb
 - lib/redshift/client/connection_handling.rb
 - lib/redshift/client/errors.rb
 - lib/redshift/client/version.rb