right_support 0.9.4 → 0.9.8

data/lib/right_support/net/address_helper.rb

@@ -0,0 +1,125 @@
+# Copyright (c) 2009-2011 RightScale, Inc, All Rights Reserved Worldwide.
+#
+# THIS PROGRAM IS CONFIDENTIAL AND PROPRIETARY TO RIGHTSCALE
+# AND CONSTITUTES A VALUABLE TRADE SECRET.  Any unauthorized use,
+# reproduction, modification, or disclosure of this program is
+# strictly prohibited.  Any use of this program by an authorized
+# licensee is strictly subject to the terms and conditions,
+# including confidentiality obligations, set forth in the applicable
+# License Agreement between RightScale.com, Inc. and the licensee.
+
+require 'socket'
+
+module RightSupport::Net
+  # A helper module that provides some useful methods for querying the local machine about its network
+  # addresses.
+  #
+  # This module is automatically included into the eigenclass of RightSupport::Net for convenience. Any
+  # of the methods available in this module can be called as RightSupport::Net.foo without needing to
+  # include this module.
+  module AddressHelper
+    class NoSuitableInterface < RuntimeError; end
+
+    PRIVATE_IP_REGEX  = /^(10\.|192\.168\.|172\.(1[6789]|2[0-9]|3[01]))/
+    LOOPBACK_IP_REGEX = /^(127\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})/
+
+    # Determine the network address of some local interface that has a route to the public Internet.
+    #
+    # On some systems, Socket.getaddrinfo(Socket.gethostname, ...) does not return any IP addresses,
+    # for instance because the local hostname cannot be resolved by DNS. This method can be used to
+    # detect "my IP address" in such cases.
+    #
+    # This code does NOT make a connection or send any packets (to 64.233.187.99 which is google).
+    # Since UDP is a stateless protocol, connect() merely makes a system call which figures out how
+    # to route the packets based on the address and what interface (and therefore IP address) it
+    # should bind to. addr() returns an array containing the family (AF_INET), local port, and
+    # local address (which is what we want) of the socket.
+    #
+    # === Parameters
+    # address_family(Integer):: Socket::AF_INET or Socket::AF_INET6
+    #
+    # === Return
+    # address(String):: a single IP address in dotted-quad notation
+    def local_routable_address(address_family)
+      case address_family
+        when Socket::AF_INET
+          remote_address = '64.233.187.99'
+        when Socket::AF_INET6
+          remote_address = '2607:f8b0:4003:c00::68'
+        else
+          raise ArgumentError, "Routable address discovery only works for AF_INET or AF_INET6"
+      end
+
+      # turn off reverse DNS resolution temporarily
+      orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true
+      UDPSocket.open(address_family) do |s|
+        s.connect remote_address, 1
+        s.addr.last
+      end
+    ensure
+      Socket.do_not_reverse_lookup = orig
+    end
+
+    # Determine all network addresses of the local machine that are resolvable using either the machine's
+    # hostname or "localhost". Typically this allows us to discover the local IP addresses of
+    # "interesting" network interfaces without relying on OS-specific tools such as ifconfig/ipconfig.
+    #
+    # === Parameters
+    # address_family(Integer):: Socket::AF_INET or Socket::AF_INET6
+    #
+    # === Return
+    # addresses(Array):: a list of IP addresses in dotted-quad notation
+    def local_hostname_addresses(address_family)
+      loopback = Socket.getaddrinfo('localhost', 1,
+                   address_family, Socket::SOCK_STREAM,
+                   nil, nil).collect { |x| x[3] }
+
+      real = Socket.getaddrinfo(Socket.gethostname, 1,
+               address_family, Socket::SOCK_STREAM,
+               nil, nil).collect { |x| x[3] }
+      (loopback + real).uniq
+    end
+
+    # Determine all IPv4 addresses of the local machine that fall into the given range of IP address space
+    # (public, private or loopback).
+    #
+    # === Parameters
+    # flavor(Symbol):: One of :public, :private or :loopback
+    #
+    # === Return
+    # addresses(Array):: a list of IP addresses in dotted-quad notation
+    def my_ipv4_addresses(flavor=:private)
+      all = local_hostname_addresses(Socket::AF_INET)
+      all << local_routable_address(Socket::AF_INET)
+      all.uniq!
+
+      case flavor
+        when :public
+          return all.select { |ip| ip !~ PRIVATE_IP_REGEX && ip !~ LOOPBACK_IP_REGEX }
+        when :private
+          return all.select { |ip| ip =~ PRIVATE_IP_REGEX }
+        when :loopback
+          return all.select { |ip| ip =~ LOOPBACK_IP_REGEX }
+        else
+          raise ArgumentError, "flavor must be :public, :private or :loopback"
+      end
+    end
+
+    # Determine an IPv4 address of the local machine that falls into the given range of IP address space
+    # (public, private or loopback). If multiple suitable addresses are found, the same address will be
+    # consistently returned but there is no way to influence _which_ address that will be.
+    #
+    # === Parameters
+    # flavor(Symbol):: One of :public, :private or :loopback
+    #
+    # === Return
+    # addresses(Array):: a list of IP addresses in dotted-quad notation
+    def my_ipv4_address(flavor=:private)
+      candidates = my_ipv4_addresses(flavor)
+      raise NoSuitableInterface, "No interface had a #{flavor} IPv4 address" if candidates.empty?
+
+      #Ensure we consistently the same interface by doing a lexical sort
+      return candidates.sort.first
+    end
+  end
+end

data/lib/right_support/net/request_balancer/policy.rb

@@ -0,0 +1,14 @@
+class RightSupport::Net::RequestBalancer::Policy
+  def next_endpoint
+    raise NotImplementedError, "Subclass responsibility"
+  end
+
+  def report_success(endpoint)
+    #no-op
+  end
+
+  def report_failure(endpoint)
+    #no-op
+  end
+end
+

data/lib/right_support/net/request_balancer/round_robin.rb

@@ -0,0 +1,7 @@
+class RightSupport::Net::RequestBalancer::RoundRobin < Policy
+  def next_endpoint(endpoints)
+    result = @endpoints[ @counter % @endpoints.size ]
+    @counter += 1
+    return result
+  end
+end

data/lib/right_support/net/request_balancer.rb

@@ -91,12 +91,16 @@ module RightSupport::Net
 
       exceptions = []
       result     = nil
-      success    = false
+      complete   = false
+      n          = 0
+
+      while !complete && n < @endpoints.size
+        endpoint = next_endpoint
+        n += 1
 
-      @endpoints.each do |endpoint|
         begin
-          result  = yield(endpoint)
-          success = true
+          result   = yield(endpoint)
+          complete = true
           break
         rescue Exception => e
           if to_raise = handle_exception(endpoint, e)
@@ -107,7 +111,7 @@ module RightSupport::Net
         end
       end
 
-      return result if success
+      return result if complete
 
       exceptions = exceptions.map { |e| e.class.name }.uniq.join(', ')
       raise NoResult, "All URLs in the rotation failed! Exceptions: #{exceptions}"
@@ -142,6 +146,13 @@ module RightSupport::Net
       end
     end
 
+    def next_endpoint
+      @round_robin ||= 0
+      result = @endpoints[ @round_robin % @endpoints.size ]
+      @round_robin += 1
+      return result
+    end
+
     # Test that something is a callable (Proc, Lambda or similar) with the expected arity.
     # Used mainly by the initializer to test for correct options.
     def test_callable_arity(callable, arity, optional)

data/lib/right_support/net.rb

@@ -32,3 +32,5 @@ end
 Dir[File.expand_path('../net/*.rb', __FILE__)].each do |filename|
   require filename
 end
+
+RightSupport::Net.extend(RightSupport::Net::AddressHelper)

data/lib/right_support/rack/custom_logger.rb

@@ -22,41 +22,37 @@
 
 require 'logger'
 
-module RightSupport
-  module Rack
-    # A Rack middleware that allows an arbitrary object to be used as the Rack logger.
-    # This is more flexible than Rack's built-in Logger middleware, which always logs
-    # to a file-based Logger and doesn't allow you to control anything other than the
-    # filename.
-    class CustomLogger
-      # Initialize an instance of the middleware.
-      #
-      # === Parameters
-      # app(Object):: the inner application or middleware layer; must respond to #call
-      # level(Integer):: one of the Logger constants: DEBUG, INFO, WARN, ERROR, FATAL
-      # logger(Logger):: (optional) the Logger object to use, if other than default
-      #
-      def initialize(app, level = ::Logger::INFO, logger = nil)
-        @app, @level = app, level
+module RightSupport::Rack
+  # A Rack middleware that allows an arbitrary object to be used as the Rack logger.
+  # This is more flexible than Rack's built-in Logger middleware, which always logs
+  # to a file-based Logger and doesn't allow you to control anything other than the
+  # filename.
+  class CustomLogger
+    # Initialize an instance of the middleware.
+    #
+    # === Parameters
+    # app(Object):: the inner application or middleware layer; must respond to #call
+    # level(Integer):: one of the Logger constants: DEBUG, INFO, WARN, ERROR, FATAL
+    # logger(Logger):: (optional) the Logger object to use, if other than default
+    #
+    def initialize(app, level = ::Logger::INFO, logger = nil)
+      @app, @level = app, level
 
-        logger ||= ::Logger.new(env['rack.errors'])
-        logger.level = @level
-        @logger = logger
-      end
+      logger ||= ::Logger.new(env['rack.errors'])
+      logger.level = @level
+      @logger = logger
+    end
 
-      # Add a logger to the Rack environment and call the next middleware.
-      #
-      # === Parameters
-      # env(Hash):: the Rack environment
-      #
-      # === Return
-      # always returns whatever value is returned by the next layer of middleware
-      def call(env)
-        env['rack.logger'] = @logger
-        return @app.call(env)
-      ensure
-        @logger.close
-      end
+    # Add a logger to the Rack environment and call the next middleware.
+    #
+    # === Parameters
+    # env(Hash):: the Rack environment
+    #
+    # === Return
+    # always returns whatever value is returned by the next layer of middleware
+    def call(env)
+      env['rack.logger'] = @logger
+      return @app.call(env)
     end
   end
 end

data/lib/right_support/rack.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 Rack middleware and other enhancements.
+  #
+  module Rack
+
+  end
+end
+
+Dir[File.expand_path('../rack/*.rb', __FILE__)].each do |filename|
+  require filename
+end

data/lib/right_support/{kernel_extensions.rb → ruby/object_extensions.rb}

@@ -1,5 +1,5 @@
-module RightSupport
-  module KernelExtensions
+module RightSupport::Ruby
+  module ObjectExtensions
     # Attempt to require one or more source files; if the require succeeds (or
     # if the files have already been successfully required), yield to the block.
     #
@@ -26,5 +26,5 @@ module RightSupport
 end
 
 class Object
-  include RightSupport::KernelExtensions
+  include RightSupport::Ruby::ObjectExtensions
 end

data/lib/right_support/ruby.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 extensions to Ruby builtin classes.
+  #
+  module Ruby
+
+  end
+end
+
+Dir[File.expand_path('../ruby/*.rb', __FILE__)].each do |filename|
+  require filename
+end

data/lib/right_support/system_logger.rb

@@ -1,176 +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
-  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
+  SystemLogger = RightSupport::Log::SystemLogger
+end

data/lib/right_support/tag_logger.rb

@@ -1,72 +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 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
+  TagLogger = RightSupport::Log::TagLogger
 end

data/lib/right_support.rb

@@ -1,9 +1,13 @@
-require 'right_support/kernel_extensions'
+# Namespaces for RightSupport
+require 'right_support/ruby'
+require 'right_support/db'
+require 'right_support/log'
+require 'right_support/net'
+require 'right_support/rack'
+require 'right_support/validation'
+
+# Deprecated stubs
+require 'right_support/cassandra_model'
 require 'right_support/filter_logger'
 require 'right_support/system_logger'
 require 'right_support/tag_logger'
-require 'right_support/rack/custom_logger'
-
-require 'right_support/validation'
-
-require 'right_support/net'

data/right_support.gemspec

@@ -7,8 +7,8 @@ spec = Gem::Specification.new do |s|
   s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
 
   s.name    = 'right_support'
-  s.version = '0.9.4'
-  s.date    = '2011-05-13'
+  s.version = '0.9.8'
+  s.date    = '2011-08-13'
 
   s.authors = ['Tony Spataro']
   s.email   = 'tony@rightscale.com'