cequel 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9085a953689716b573953d289758730b72c6952
-  data.tar.gz: 5c96c40d2b735f0075c6685ad5e52e45ba6a7054
+  metadata.gz: 32765637991b209fa0eda38cae999ce92e03d9de
+  data.tar.gz: 5b0f247d96c436fa9947d14162e91b648cc29929
 SHA512:
-  metadata.gz: 213f188002f5b59514955bc2474a22a7427b748dc3e34c8eee7b9e23f1ed539e58e216ff6c9cf425971d57f342365deed664bdd8af42ec381496eb8cb6bdeb01
-  data.tar.gz: b15c63da92f2231b0ec30b9a6851a0a1bd5ffaa256c24ce4d09b96029ef0dccc00c53670d3bd349c0a52d8448a11cee060e8c7c2e42f54f1420d49e810a9260c
+  metadata.gz: 7739409b3a223c117e17673d769b04b8382de1638c40262e72a68527bf75b87fd66c850681401fd652f998e59ab272d430379d611da2069ac316e9c7a0eb00b0
+  data.tar.gz: 1dc7c4ff48b96d2b6f4716fce64faad2569580a73c54446499809eb2f8947c3bf304da5a4082ae8d14f65da331f0b9ba8266daee99dcadc783bc3b47130a4c58

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 1.1.2
+
+* Simplify logging implementation
+* Support Cassandra authentication
+
 ## 1.1.1
 
 * Specify NewRelicInstrumentation with full namespace

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 group :debug do
   gem 'debugger', :platforms => :mri_19
-  gem 'byebug', :platforms => :mri_20
+  gem 'byebug', :platforms => [:mri_20, :mri_21]
   gem 'pry'
 end
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cequel (1.1.1)
+    cequel (1.1.2)
       activemodel (>= 3.1)
       cql-rb
 

data/lib/cequel/metal/keyspace.rb

@@ -24,6 +24,8 @@ module Cequel
       # @return [Symbol] the default consistency for queries in this keyspace
       # @since 1.1.0
       attr_writer :default_consistency
+      # @return [Hash] credentials for connect to cassandra
+      attr_reader :credentials
 
       #
       # @!method write(statement, *bind_vars)
@@ -92,16 +94,17 @@ module Cequel
       # Configure this keyspace from a hash of options
       #
       # @param configuration [Options] configuration options
-      # @option configuration [String] :host ('127.0.0.1:9042') host/port of
+      # @option configuration [String] :host ('127.0.0.1') hostname of
       #   single Cassandra instance to connect to
+      # @option configuration [Integer] :port (9042) port on which to connect
+      #   to all specified hosts
       # @option configuration [Array<String>] :hosts list of Cassandra
-      #   instances to connect to
-      # @option configuration [Hash] :thrift Thrift options to be passed
-      #   directly to Thrift client
+      #   instances to connect to (hostnames only)
+      # @option configuration [String] :username user to auth with (leave blank
+      #   for no auth)
+      # @option configuration [String] :password password to auth with (leave
+      #   blank for no auth)
       # @option configuration [String] :keyspace name of keyspace to connect to
-      # @option configuration [Integer] :pool (1) size of connection pool
-      # @option configuration [Integer] :pool_timeout (0) timeout when
-      #   attempting to check out connection from pool
       # @return [void]
       #
       def configure(configuration = {})
@@ -112,6 +115,7 @@ module Cequel
         @configuration = configuration
 
         @hosts, @port = extract_hosts_and_port(configuration)
+        @credentials = extract_credentials(configuration)
 
         @name = configuration[:keyspace]
         # reset the connections
@@ -202,7 +206,10 @@ module Cequel
       private :lock
 
       def build_client
-        Cql::Client.connect(hosts: hosts, port: port).tap do |client|
+        client_options = {hosts: hosts, port: port}.tap do |options|
+          options[:credentials] = credentials if credentials
+        end
+        Cql::Client.connect(client_options).tap do |client|
           client.use(name) if name
         end
       end
@@ -238,6 +245,10 @@ module Cequel
 
         [hosts, ports.first || 9042]
       end
+
+      def extract_credentials(configuration)
+        configuration.slice(:username, :password).presence
+      end
     end
   end
 end

data/lib/cequel/metal/logging.rb

@@ -5,44 +5,27 @@ module Cequel
     # Methods to handle logging for {Keyspace} instances
     #
     module Logging
-      def logger=(logger)
-        loggers << Logger.new(logger, ::Logger::DEBUG)
-        self.exception_logger = ExceptionLogger.new(logger, ::Logger::ERROR)
-      end
+      extend Forwardable
+      def_delegators :request_logger, :logger, :logger=, :slowlog_threshold,
+                     :slowlog_threshold=
 
+      #
+      # @deprecated
+      #
       def slowlog=(slowlog)
-        warn "#slowlog= is deprecated and will be removed from a future " \
-             "version"
-        loggers << @slowlog = Logger.new(slowlog, ::Logger::WARN, 2000)
-      end
-
-      def slowlog_threshold=(threshold)
-        @slowlog.threshold = threshold
+        warn "#slowlog= is deprecated and ignored"
       end
 
       protected
 
-      attr_accessor :exception_logger
+      attr_writer :request_logger
 
-      private
-
-      def log(label, statement, *bind_vars)
-        response = nil
-        begin
-          time = Benchmark.ms { response = yield }
-          loggers.each do |logger|
-            logger.log(label, time, statement, bind_vars)
-          end
-        rescue Exception => e
-          exception_logger.log(label, statement, bind_vars) if exception_logger
-          raise
-        end
-        response
+      def request_logger
+        @request_logger ||= RequestLogger.new
       end
 
-      def loggers
-        @loggers ||= []
-      end
+      def_delegator :request_logger, :log
+      protected :log
     end
   end
 end

data/lib/cequel/metal/request_logger.rb

@@ -0,0 +1,61 @@
+# -*- encoding : utf-8 -*-
+module Cequel
+  module Metal
+    #
+    # The Logger class encapsulates logging functionality for {Keyspace}.
+    #
+    # @api private
+    #
+    class RequestLogger
+      extend Forwardable
+      # @return [::Logger] An instance of Logger that responds to methods for
+      #   standard severity levels
+      attr_accessor :logger
+      # @return [Integer] Only log queries that take longer than threshold ms
+      attr_accessor :slowlog_threshold
+
+      def initialize
+        self.slowlog_threshold = 2000
+      end
+
+      #
+      # Log a CQL statement
+      #
+      # @param label [String] a logical label for this statement
+      # @param statement [String] the CQL statement to log
+      # @param bind_vars bind variables for the CQL statement
+      # @return [void]
+      #
+      def log(label, statement, *bind_vars)
+        return yield if logger.nil?
+
+        response = nil
+        begin
+          time = Benchmark.ms { response = yield }
+          generate_message = lambda do
+            format_for_log(label, "#{time.round.to_i}ms", statement, bind_vars)
+          end
+
+          if time >= slowlog_threshold
+            logger.warn(&generate_message)
+          else
+            logger.debug(&generate_message)
+          end
+        rescue Exception => e
+          logger.error { format_for_log(label, 'ERROR', statement, bind_vars) }
+          raise
+        end
+        response
+      end
+
+      private
+
+      def format_for_log(label, timing, statement, bind_vars)
+        format('%s (%s) %s', label, timing, sanitize(statement, bind_vars))
+      end
+
+      def_delegator 'Cequel::Metal::Keyspace', :sanitize
+      private :sanitize
+    end
+  end
+end

data/lib/cequel/metal.rb

@@ -5,7 +5,7 @@ require 'cequel/metal/cql_row_specification'
 require 'cequel/metal/data_set'
 require 'cequel/metal/logging'
 require 'cequel/metal/keyspace'
-require 'cequel/metal/logger'
+require 'cequel/metal/request_logger'
 require 'cequel/metal/row'
 require 'cequel/metal/row_specification'
 require 'cequel/metal/statement'

data/lib/cequel/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Cequel
   # The current version of the library
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/templates/config/cequel.yml

@@ -16,3 +16,5 @@ production:
     - 'cass3.<%= app_name %>.biz'
   port: 9042
   keyspace: <%= app_name %>_production
+  username: 'myappuser'
+  password: 'password1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cequel
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Mat Brown
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -188,9 +188,9 @@ files:
 - lib/cequel/metal/incrementer.rb
 - lib/cequel/metal/inserter.rb
 - lib/cequel/metal/keyspace.rb
-- lib/cequel/metal/logger.rb
 - lib/cequel/metal/logging.rb
 - lib/cequel/metal/new_relic_instrumentation.rb
+- lib/cequel/metal/request_logger.rb
 - lib/cequel/metal/row.rb
 - lib/cequel/metal/row_specification.rb
 - lib/cequel/metal/statement.rb

data/lib/cequel/metal/logger.rb

@@ -1,72 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Cequel
-  module Metal
-    #
-    # The Logger class encapsulates logging functionality for {Keyspace}.
-    #
-    # @api private
-    #
-    class Logger
-      extend Forwardable
-      # @return [::Logger] An instance of Logger from the standard library
-      attr_reader :out
-      # @return [Integer] The severity level for this logger
-      attr_reader :severity
-      # @return [Integer] Only log queries that take longer than threshold ms
-      attr_accessor :threshold
-
-      #
-      # @param out [::Logger] An instance of Logger from the standard library
-      # @param severity [Integer] The severity level for this logger
-      # @param threshold [Integer] Only log queries that take longer than
-      #   `threshold` ms
-      #
-      def initialize(out, severity, threshold = 0)
-        @out, @severity, @threshold = out, severity, threshold
-      end
-
-      #
-      # Log a CQL statement
-      #
-      # @param label [String] a logical label for this statement
-      # @param timing [Integer] how long this statement took in ms
-      # @param statement [String] the CQL statement to log
-      # @param bind_vars [Array] bind variables for the CQL statement
-      # @return [void]
-      #
-      def log(label, timing, statement, bind_vars)
-        if timing >= threshold
-          out.add(severity) do
-            format(
-              '%s (%dms) %s',
-              label, timing, sanitize(statement, bind_vars)
-            )
-          end
-        end
-      end
-
-      private
-
-      def_delegator 'Cequel::Metal::Keyspace', :sanitize
-    end
-
-    #
-    # Logger for queries that resulted in an exception
-    #
-    class ExceptionLogger < Logger
-      #
-      # Log a CQL statement that resulted in an exception
-      #
-      # @param label [String] a logical label for this statement
-      # @param statement [String] the CQL statement to log
-      # @param bind_vars [Array] bind variables for the CQL statement
-      # @return [void]
-      #
-      def log(label, statement, bind_vars)
-        out.add(severity) do
-          format('%s (ERROR) %s', label, sanitize(statement, bind_vars))
-        end
-      end
-    end
-  end
-end