right_support 0.9.4 → 0.9.8

data/lib/right_support/cassandra_model.rb

@@ -0,0 +1,3 @@
+module RightSupport
+  CassandraModel = RightSupport::DB::CassandraModel
+end

data/lib/right_support/db/cassandra_model.rb

@@ -0,0 +1,129 @@
+module RightSupport::DB
+  class CassandraModel
+    DEFAULT_TIMEOUT = 10
+    class << self
+      @@logger=nil
+      @@conn = nil
+      
+      attr_accessor :column_family
+      attr_writer :keyspace
+
+      def config
+        @@config
+      end
+      
+      def config=(value)
+        @@config = value
+      end
+      
+      def logger=(l)
+        @@logger=l
+      end
+      
+      def logger
+        @@logger 
+      end
+    
+      def keyspace
+        @keyspace + "_" + (ENV['RACK_ENV'] || 'development')
+      end
+
+      def conn
+        return @@conn if @@conn
+
+        config = @@config[ENV["RACK_ENV"]]
+        @@conn = Cassandra.new(keyspace, config["server"],{:timeout => RightSupport::CassandraModel::DEFAULT_TIMEOUT})
+        @@conn.disable_node_auto_discovery!
+        @@conn
+      end
+
+      def all(k,opt={})
+        list = real_get(k,opt)  
+      end
+      
+      def get(key)
+        if (hash = real_get(key)).empty?
+          nil
+        else
+          new(key, hash)
+        end
+      end
+
+      def real_get(k,opt={})
+        if k.is_a?(Array)
+          do_op(:multi_get, column_family, k, opt)
+        else      
+          do_op(:get, column_family, k, opt)
+        end
+      end
+
+      def insert(key, values,opt={})
+        do_op(:insert, column_family, key, values,opt)
+      end
+
+      def remove(*args)
+        do_op(:remove, column_family, *args)
+      end
+
+      def batch(*args,&block)
+        raise "Block required!" unless block_given?
+        do_op(:batch,*args, &block)
+      end
+      
+      def do_op(meth, *args, &block)
+        conn.send(meth, *args, &block)
+      rescue IOError
+        reconnect
+        retry
+      end
+
+      def reconnect
+        config = @@config[ENV["RACK_ENV"]]
+        @@conn = Cassandra.new(keyspace, config["server"],{:timeout => RightSupport::CassandraModel::DEFAULT_TIMEOUT})
+        @@conn.disable_node_auto_discovery!
+      end
+
+      def ring
+        conn.ring
+      end
+    end
+
+    attr_accessor :key, :attributes
+
+    def initialize(key, attrs={})
+      self.key = key
+      self.attributes = attrs
+    end
+
+    def save
+      self.class.insert(key, attributes)
+      true
+    end
+    
+    def reload
+      self.class.get(key)
+    end
+
+    def reload!
+      self.attributes = self.class.real_get(key)
+      self
+    end
+
+    def [](key)
+      ret = attributes[key]
+      return ret if ret
+      if key.kind_of? Integer
+        return attributes[Cassandra::Long.new(key)]
+      end
+    end
+
+    def []=(key, value)
+      attributes[key] = value
+    end
+
+    def destroy
+      self.class.remove(key)
+    end
+
+  end
+end

data/lib/right_support/db.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  #
+  # A namespace for database classes and helper modules.
+  #
+  module DB
+
+  end
+end
+
+Dir[File.expand_path('../db/*.rb', __FILE__)].each do |filename|
+  require filename
+end

data/lib/right_support/filter_logger.rb

@@ -1,122 +1,3 @@
-#
-# Copyright (c) 2011 RightScale Inc
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-require 'logger'
-
 module RightSupport
-  # A logger than encapsulates an underlying Logger object and filters log entries
-  # before they are passed to the underlying Logger. Can be used to for various log-
-  # processing tasks such as filtering sensitive data or tagging log lines with a
-  # context marker.
-  class FilterLogger < Logger
-    # Initialize a new instance of this class.
-    #
-    # === Parameters
-    # actual_logger(Logger):: The actual, underlying Logger object
-    #
-    def initialize(actual_logger)
-      @actual_logger = actual_logger
-
-    end
-
-    # Add a log line, filtering the severity and message before calling through
-    # to the underlying logger's #add method.
-    #
-    # === Parameters
-    # severity(Integer):: one of the Logger severity constants
-    # message(String):: the message to log, or nil
-    # progname(String):: the program name, or nil
-    #
-    # === Block
-    # If message == nil and a block is given, yields to the block in order to
-    # capture the log message. This matches the behavior of Logger, but ensures
-    # the severity and message are still filtered.
-    #
-    # === Return
-    # the result of the underlying logger's #add
-    def add(severity, message = nil, progname = nil, &block)
-      severity ||= UNKNOWN
-      return true if severity < level
-
-      if message.nil?
-        if block_given?
-          message = yield
-        else
-          message = progname
-        end
-      end
-
-      severity, message = filter(severity, message)
-      return @actual_logger.add(severity, message) if message
-    end
-
-    # Proxies to the encapsulated Logger object. See Logger#<< for info.
-    def <<(msg)
-      @actual_logger << msg
-    end
-
-    # Proxies to the encapsulated Logger object. See Logger#close for info.
-    def close
-      @actual_logger.close
-    end
-
-    # Proxies to the encapsulated Logger object. See Logger#level for info.
-    def level
-      @actual_logger.level
-    end
-
-    # Proxies to the encapsulated Logger object. See Logger#level= for info.
-    def level=(new_level)
-      @actual_logger.level = new_level
-    end
-
-    # Proxies to the encapsulated Logger object. See Logger#debug? for info.
-    def debug?; @actual_logger.debug?; end
-
-    # Proxies to the encapsulated Logger object. See Logger#info? for info.
-    def info?; @actual_logger.info?; end
-
-    # Proxies to the encapsulated Logger object. See Logger#warn? for info.
-    def warn?; @actual_logger.warn?; end
-
-    # Proxies to the encapsulated Logger object. See Logger#error? for info.
-    def error?; @actual_logger.error?; end
-
-    # Proxies to the encapsulated Logger object. See Logger#fatal? for info.
-    def fatal?; @actual_logger.fatal?; end
-
-    protected
-
-    # Filter a log line, transforming its severity and/or message before it is
-    # passed to the underlying logger.
-    #
-    # === Parameters
-    # severity(Integer):: one of the severity constants defined by Logger
-    # messgae(String):: the log message
-    #
-    # === Return
-    # Returns a pair consisting of the filtered [severity, message].
-    def filter(severity, message)
-      return [severity, message]
-    end
-  end
+  FilterLogger = RightSupport::Log::FilterLogger
 end

data/lib/right_support/log/filter_logger.rb

@@ -0,0 +1,122 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'logger'
+
+module RightSupport::Log
+  # A logger than encapsulates an underlying Logger object and filters log entries
+  # before they are passed to the underlying Logger. Can be used to for various log-
+  # processing tasks such as filtering sensitive data or tagging log lines with a
+  # context marker.
+  class FilterLogger < Logger
+    # Initialize a new instance of this class.
+    #
+    # === Parameters
+    # actual_logger(Logger):: The actual, underlying Logger object
+    #
+    def initialize(actual_logger)
+      @actual_logger = actual_logger
+
+    end
+
+    # Add a log line, filtering the severity and message before calling through
+    # to the underlying logger's #add method.
+    #
+    # === Parameters
+    # severity(Integer):: one of the Logger severity constants
+    # message(String):: the message to log, or nil
+    # progname(String):: the program name, or nil
+    #
+    # === Block
+    # If message == nil and a block is given, yields to the block in order to
+    # capture the log message. This matches the behavior of Logger, but ensures
+    # the severity and message are still filtered.
+    #
+    # === Return
+    # the result of the underlying logger's #add
+    def add(severity, message = nil, progname = nil, &block)
+      severity ||= UNKNOWN
+      return true if severity < level
+
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+        end
+      end
+
+      severity, message = filter(severity, message)
+      return @actual_logger.add(severity, message) if message
+    end
+
+    # Proxies to the encapsulated Logger object. See Logger#<< for info.
+    def <<(msg)
+      @actual_logger << msg
+    end
+
+    # Proxies to the encapsulated Logger object. See Logger#close for info.
+    def close
+      @actual_logger.close
+    end
+
+    # Proxies to the encapsulated Logger object. See Logger#level for info.
+    def level
+      @actual_logger.level
+    end
+
+    # Proxies to the encapsulated Logger object. See Logger#level= for info.
+    def level=(new_level)
+      @actual_logger.level = new_level
+    end
+
+    # Proxies to the encapsulated Logger object. See Logger#debug? for info.
+    def debug?; @actual_logger.debug?; end
+
+    # Proxies to the encapsulated Logger object. See Logger#info? for info.
+    def info?; @actual_logger.info?; end
+
+    # Proxies to the encapsulated Logger object. See Logger#warn? for info.
+    def warn?; @actual_logger.warn?; end
+
+    # Proxies to the encapsulated Logger object. See Logger#error? for info.
+    def error?; @actual_logger.error?; end
+
+    # Proxies to the encapsulated Logger object. See Logger#fatal? for info.
+    def fatal?; @actual_logger.fatal?; end
+
+    protected
+
+    # Filter a log line, transforming its severity and/or message before it is
+    # passed to the underlying logger.
+    #
+    # === Parameters
+    # severity(Integer):: one of the severity constants defined by Logger
+    # messgae(String):: the log message
+    #
+    # === Return
+    # Returns a pair consisting of the filtered [severity, message].
+    def filter(severity, message)
+      return [severity, message]
+    end
+  end
+end

data/lib/right_support/log/system_logger.rb

@@ -0,0 +1,176 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'logger'
+
+module RightSupport::Log
+  if_require_succeeds('syslog') do
+    # A logger that forwards log entries to the Unix syslog facility, but complies
+    # with the interface of the Ruby Logger object and faithfully translates log
+    # severities and other concepts. Provides optional cleanup/filtering in order
+    # to keep the syslog from having weird characters or being susceptible to log
+    # forgery.
+    class SystemLogger < Logger
+      LOGGER_LEVELS = {
+        UNKNOWN => :alert,
+        FATAL   => :err,
+        ERROR   => :warning,
+        WARN    => :notice,
+        INFO    => :info,
+        DEBUG   => :debug
+      }
+
+      SYSLOG_LEVELS = LOGGER_LEVELS.invert
+      DEFAULT_SYSLOG_LEVEL = :alert
+
+      DEFAULT_OPTIONS = {:split=>false, :color=>false}
+
+      @@syslog = nil
+
+      # Initialize this process's syslog facilities and construct a new syslog
+      # logger object.
+      #
+      # === Parameters
+      # program_name(String):: the syslog program name, 'ruby' by default
+      # options(Hash):: (optional) configuration options to use, see below
+      #
+      # === Options
+      # facility:: the syslog facility to use for messages, 'local0' by default
+      # split(true|false):: if true, splits multi-line messages into separate syslog entries
+      # color(true|false):: if true, passes ANSI escape sequences through to syslog
+      #
+      def initialize(program_name='ruby', options={})
+        @options = DEFAULT_OPTIONS.merge(options)
+        @level = Logger::DEBUG
+
+        facility = options[:facility] || 'local0'
+        fac_map = {'user'=>8}
+        (0..7).each { |i| fac_map['local'+i.to_s] = 128+8*i }
+
+        @@syslog ||= Syslog.open(program_name, nil, fac_map[facility.to_s])
+      end
+
+      # Log a message if the given severity is high enough.  This is the generic
+      # logging method.  Users will be more inclined to use #debug, #info, #warn,
+      # #error, and #fatal.
+      #
+      # === Parameters
+      # severity(Integer):: one of the severity constants defined by Logger
+      # message(Object):: the message to be logged
+      # progname(String):: ignored, the program name is fixed at initialization
+      #
+      # === Block
+      # If message is nil and a block is supplied, this method will yield to
+      # obtain the log message.
+      #
+      # === Return
+      # true:: always returns true
+      #
+      def add(severity, message = nil, progname = nil, &block)
+        severity ||= UNKNOWN
+        if @@syslog.nil? or severity < @level
+          return true
+        end
+
+        progname ||= @progname
+
+        if message.nil?
+          if block_given?
+            message = yield
+          else
+            message = progname
+            progname = @progname
+          end
+        end
+
+        parts = clean(message)
+        parts.each { |part| emit_syslog(severity, part) }
+        return true
+      end
+
+      # Emit a log entry at INFO severity.
+      #
+      # === Parameters
+      # msg(Object):: the message to log
+      #
+      # === Return
+      # true:: always returns true
+      #
+      def <<(msg)
+        info(msg)
+      end
+
+      # Do nothing. This method is provided for Logger interface compatibility.
+      #
+      # === Return
+      # true:: always returns true
+      #
+      def close
+        return true
+      end
+
+      private
+
+      # Call the syslog function to emit a syslog entry.
+      #
+      # === Parameters
+      # severity(Integer):: one of the Logger severity constants
+      # message(String):: the log message
+      #
+      # === Return
+      # true:: always returns true
+      def emit_syslog(severity, message)
+        level = SYSLOG_LEVELS[severity] || DEFAULT_SYSLOG_LEVEL
+        @@syslog.send(level, message)
+        return true
+      end
+
+      # Perform cleanup, output escaping and splitting on message.
+      # The operations that it performs can vary, depending on the
+      # options that were passed to this logger at initialization
+      # time.
+      #
+      # === Parameters
+      # message(String):: raw log message
+      #
+      # === Return
+      # log_lines([String]):: an array of String messages that should be logged separately to syslog
+      def clean(message)
+        message = message.to_s.dup
+        message.strip!
+        message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
+
+        unless @options[:color]
+          message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
+        end
+
+        if @options[:split]
+          bits = message.split(/[\n\r]+/)
+        else
+          bits = [message]
+        end
+
+        return bits
+      end  
+    end
+  end
+end

data/lib/right_support/log/tag_logger.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'logger'
+
+module RightSupport::Log
+  # A logger that prepends a tag to every message that is emitted. Can be used to
+  # correlate logs with a Web session ID, transaction ID or other context.
+  #
+  # The user of this logger is responsible for calling #tag= to set the tag as
+  # appropriate, e.g. in a Web request around-filter.
+  #
+  # This logger uses thread-local storage (TLS) to provide tagging on a per-thread
+  # basis; however, it does not account for EventMachine, neverblock, the use of
+  # Ruby fibers, or any other phenomenon that can "hijack" a thread's call stack.
+  #
+  class TagLogger < FilterLogger
+    # Prepend the current tag to the log message; return the same severity and
+    # the modified message.
+    #
+    # === Parameters
+    # severity(Integer):: one of the severity constants defined by Logger
+    # messgae(String):: the log message
+    #
+    # === Return
+    # Returns a pair consisting of the filtered [severity, message].
+    #
+    def filter(severity, message)
+      @tls_id ||= "tag_logger_#{self.object_id}"
+      tag = Thread.current[@tls_id] || ''
+      if tag
+        return [severity, tag + message]
+      else
+        return [severity, message]
+      end
+    end
+
+    attr_reader :tag
+    
+    # Set the tag for this logger.
+    #
+    # === Parameters
+    # tag(String|nil):: the new tag, or nil to remove the tag
+    #
+    # === Return
+    # String:: returns the new tag
+    def tag=(tag)
+      @tag = tag
+      @tls_id ||= "tag_logger_#{self.object_id}"
+      Thread.current[@tls_id] = @tag
+    end
+  end
+end

data/lib/right_support/log.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (c) 2011 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport
+  #
+  # A namespace for logging functionality.
+  #
+  module Log
+
+  end
+end
+
+require 'right_support/log/system_logger'
+require 'right_support/log/filter_logger'
+require 'right_support/log/tag_logger'