right_support 2.8.12 → 2.8.15

data/lib/right_support/log/mixin.rb

@@ -25,6 +25,7 @@ module RightSupport::Log
   #
   # === Basic Usage
   # Your class must opt into logging by including the mixin:
+  #
   #   class AwesomenessProcessor
   #     include RightSupport::Log::Mixin
   #
@@ -36,7 +37,7 @@ module RightSupport::Log
   #   end
   #
   #   def process_awesomeness(input)
-  #     input = self.class.prepare_awesomeness(input)
+  #     input = self.class.prepare_awesomeness_for_processing(input)
   #     logger.info "Processing #{input.size} units of awesomeness"
   #   end
   #
@@ -66,7 +67,13 @@ module RightSupport::Log
     # Class methods that become available to classes that include Mixin.
     module ClassMethods
       def logger
-        @logger || RightSupport::Log::Mixin.default_logger
+        if @logger
+          @logger
+        elsif superclass.respond_to?(:logger) && superclass.logger
+          superclass.logger
+        else
+          RightSupport::Log::Mixin.default_logger
+        end
       end
 
       def logger=(logger)

data/lib/right_support/rack/request_logger.rb

@@ -23,6 +23,7 @@
 require 'logger'
 
 module RightSupport::Rack
+
   # A Rack middleware that logs information about every HTTP request received and
   # every exception raised while processing a request.
   #
@@ -32,31 +33,36 @@ module RightSupport::Rack
   # RequestLogger can be used standalone to fulfill all logging needs, or combined
   # with Rack::Logger or another middleware that provides logging services.
   class RequestLogger
+
     # Initialize an instance of the middleware.
     #
-    # === Parameters
-    # app(Object):: the inner application or middleware layer; must respond to #call
+    # @param [Object] app inner application or middleware layer; must respond to #call
     #
-    def initialize(app)
+    # @option options [Array] :only log for these path Regexps unless in debug mode
+    # @option options [Array] :except log except for these path Regexps unless in debug mode
+    def initialize(app, options = {})
       @app = app
+      @only = options[:only]
+      @except = options[:except]
     end
 
     # Add a logger to the Rack environment and call the next middleware.
+    # Set "rack.logging.enabled" in Rack environment to indicate whether logging
+    # is enabled for this request for use by other middleware in the call chain.
     #
-    # === Parameters
-    # env(Hash):: the Rack environment
+    # @param [Hash] env Rack environment
     #
-    # === Return
-    # always returns whatever value is returned by the next layer of middleware
+    # @return [Object] always returns whatever value is returned by the next layer of middleware
     def call(env)
       logger = env["rack.logger"]
+      env["rack.logging.enabled"] = enabled = logging_enabled?(logger, env)
 
       began_at = Time.now
 
-      log_request_begin(logger, env)
+      log_request_begin(logger, env) if enabled
       status, header, body = @app.call(env)
       log_exception(logger, env['sinatra.error']) if env['sinatra.error']
-      log_request_end(logger, status, header, began_at)
+      log_request_end(logger, status, header, began_at) if enabled
 
       return [status, header, body]
     rescue Exception => e
@@ -66,14 +72,25 @@ module RightSupport::Rack
 
     private
 
+    # Determine whether logging enabled for given request
+    #
+    # @param [Object] logger for Rack
+    # @param [Hash] env Rack environment
+    #
+    # @return [Boolean] enabled or not
+    def logging_enabled?(logger, env)
+      path = env["PATH_INFO"]
+      env["HTTP_X_DEBUG"] || [Logger::DEBUG, :debug].include?(logger.level) ||
+          @only && @only.any? { |o| o.is_a?(Regexp) ? (path =~ o) : (path == o) } ||
+          @except && @except.none? { |e| e.is_a?(Regexp) ? (path =~ e) : (path == e) }
+    end
+
     # Log beginning of request
     #
-    # === Parameters
-    # logger(Object):: the Rack logger
-    # env(Hash):: the Rack environment
+    # @param [Object] logger for Rack
+    # @param [Hash] env Rack environment
     #
-    # === Return
-    # always returns true
+    # @return [TrueClass] always true
     def log_request_begin(logger, env)
       # Assuming remote addresses are IPv4, make them all align to the same width
       remote_addr = env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"
@@ -114,14 +131,12 @@ module RightSupport::Rack
 
     # Log end of request
     #
-    # === Parameters
-    # logger(Object):: the Rack logger
-    # env(Hash):: the Rack environment
-    # status(Fixnum):: status of the Rack request
-    # began_at(Time):: time of the Rack request begging
+    # @param [Object] logger for Rack
+    # @param [Hash] env Rack environment
+    # @param [Fixnum] status of the Rack request
+    # @param [Time] began_at time of the Rack request beginning
     #
-    # === Return
-    # always returns true
+    # @return [TrueClass] always true
     def log_request_end(logger, status, headers, began_at)
       duration = (Time.now - began_at) * 1000
 
@@ -142,14 +157,12 @@ module RightSupport::Rack
 
     # Log exception
     #
-    # === Parameters
-    # logger(Object):: the Rack logger
-    # e(Exception):: Exception to be logged
+    # @param [Object] logger for Rack
+    # @param [Exception] exception to be logged
     #
-    # === Return
-    # always returns true
-    def log_exception(logger, e)
-      msg = ["#{e.class} - #{e.message}", *e.backtrace].join("\n")
+    # @return [TrueClass] always true
+    def log_exception(logger, exception)
+      msg = ["#{exception.class} - #{exception.message}", *exception.backtrace].join("\n")
       logger.error(msg)
     rescue
       #no-op, something is seriously messed up by this point...

data/right_support.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "right_support"
-  s.version = "2.8.12"
+  s.version = "2.8.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tony Spataro", "Sergey Sergyenko", "Ryan Williamson", "Lee Kirchhoff", "Alexey Karpik", "Scott Messier"]
-  s.date = "2014-01-22"
+  s.date = "2014-02-26"
   s.description = "A toolkit of useful, reusable foundation code created by RightScale."
   s.email = "support@rightscale.com"
   s.extra_rdoc_files = [
@@ -27,12 +27,10 @@ Gem::Specification.new do |s|
     "VERSION",
     "features/balancer_error_handling.feature",
     "features/balancer_health_check.feature",
-    "features/continuous_integration.feature",
-    "features/continuous_integration_cucumber.feature",
-    "features/continuous_integration_rspec1.feature",
-    "features/continuous_integration_rspec2.feature",
+    "features/hash_tools.feature",
     "features/http_client_timeout.feature",
     "features/serialization.feature",
+    "features/step_definitions/hash_tools_steps.rb",
     "features/step_definitions/http_client_steps.rb",
     "features/step_definitions/request_balancer_steps.rb",
     "features/step_definitions/ruby_steps.rb",
@@ -139,43 +137,28 @@ Gem::Specification.new do |s|
   s.homepage = "https://github.com/rightscale/right_support"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
+  s.rubygems_version = "1.8.28"
   s.summary = "Reusable foundation code."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, ["~> 0.9"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<right_develop>, ["~> 1.0"])
-      s.add_development_dependency(%q<ruby-debug>, [">= 0.10"])
-      s.add_development_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_development_dependency(%q<flexmock>, ["~> 1.0"])
-      s.add_development_dependency(%q<syntax>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<nokogiri>, ["~> 1.5"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_development_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
     else
-      s.add_dependency(%q<rake>, ["~> 0.9"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<right_develop>, ["~> 1.0"])
-      s.add_dependency(%q<ruby-debug>, [">= 0.10"])
-      s.add_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0"])
       s.add_dependency(%q<flexmock>, ["~> 1.0"])
-      s.add_dependency(%q<syntax>, ["~> 1.0.0"])
-      s.add_dependency(%q<nokogiri>, ["~> 1.5"])
+      s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+      s.add_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
     end
   else
-    s.add_dependency(%q<rake>, ["~> 0.9"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<right_develop>, ["~> 1.0"])
-    s.add_dependency(%q<ruby-debug>, [">= 0.10"])
-    s.add_dependency(%q<ruby-debug19>, [">= 0.11.6"])
-    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0"])
     s.add_dependency(%q<flexmock>, ["~> 1.0"])
-    s.add_dependency(%q<syntax>, ["~> 1.0.0"])
-    s.add_dependency(%q<nokogiri>, ["~> 1.5"])
+    s.add_dependency(%q<rspec>, ["~> 2.13.0"])
+    s.add_dependency(%q<cucumber>, ["< 1.3.3", "~> 1.0"])
   end
 end
 

data/right_support.rconf

@@ -1,7 +1,9 @@
 ruby do
-  version  'ree-1.8.7-2012.02'
+  version  '2.1.0'
+#  version  'ree-1.8.7-2012.02'
+#  version  'ruby-1.9.3-p484'
   gemset   'right_support'
 end
 bundler do
-  version     '1.2.5'
+  version     '1.5.3'
 end

data/spec/db/cassandra_model_part1_spec.rb

@@ -65,7 +65,7 @@ describe RightSupport::DB::CassandraModel do
         begin
           ENV['RACK_ENV'] = env
 
-          flexmock(Cassandra).should_receive(:new).with(/#{default_keyspace}_#{env}/, congig_test , {:timeout=>10, :server_retry_period=>nil}).and_return(default_keyspace_connection)
+          flexmock(Cassandra).should_receive(:new).with(/#{default_keyspace}_#{env}/, congig_test , {:timeout=>20, :server_retry_period=>nil}).and_return(default_keyspace_connection)
           default_keyspace_connection.should_receive(:disable_node_auto_discovery!).and_return(true)
         
 

data/spec/db/cassandra_model_spec.rb

@@ -43,8 +43,8 @@ describe RightSupport::DB::CassandraModel do
         default_keyspace_connection.should_receive(:disable_node_auto_discovery!).and_return(true)
         default_keyspace_connection.should_receive(:name).and_return('connection2')
 
-        flexmock(Cassandra).should_receive(:new).with(keyspace + '_' + (ENV['RACK_ENV'] || 'development') + "_testns", "localhost:9160", {:timeout=>10, :server_retry_period=>nil}).and_return(current_keyspace_connection)
-        flexmock(Cassandra).should_receive(:new).with(default_keyspace + '_' + (ENV['RACK_ENV'] || 'development') + "_testns", "localhost:9160", {:timeout=>10, :server_retry_period=>nil}).and_return(default_keyspace_connection)
+        flexmock(Cassandra).should_receive(:new).with(keyspace + '_' + (ENV['RACK_ENV'] || 'development') + "_testns", "localhost:9160", {:timeout=>20, :server_retry_period=>nil}).and_return(current_keyspace_connection)
+        flexmock(Cassandra).should_receive(:new).with(default_keyspace + '_' + (ENV['RACK_ENV'] || 'development') + "_testns", "localhost:9160", {:timeout=>20, :server_retry_period=>nil}).and_return(default_keyspace_connection)
       end
 
       it 'raises a meaningful exception when a config stanza is missing' do

data/spec/log/mixin_spec.rb

@@ -4,6 +4,9 @@ class InnocentVictim
   include RightSupport::Log::Mixin
 end
 
+class Bystander < InnocentVictim
+end
+
 describe RightSupport::Log::Mixin do
   context 'when mixed into a base class' do
     before(:each) do
@@ -59,4 +62,30 @@ describe RightSupport::Log::Mixin do
       end
     end
   end
+
+  context 'when inherited from a base class' do
+    let(:base_logger) { flexmock('base-class logger') }
+    let(:subclass_logger) { flexmock('derived-class logger') }
+
+    after(:each) do
+      InnocentVictim.logger = nil
+      Bystander.logger = nil
+    end
+
+    it 'delegates to base class' do
+      InnocentVictim.logger = base_logger
+      base_logger.should_receive(:error).with('foo').once
+
+      Bystander.logger.error('foo')
+    end
+
+    it 'allows override in child class' do
+      InnocentVictim.logger = base_logger
+      Bystander.logger = subclass_logger
+      base_logger.should_receive(:error).never
+      subclass_logger.should_receive(:error).with('foo').once
+
+      Bystander.logger.error('foo')
+    end
+  end
 end

data/spec/net/request_balancer_spec.rb

@@ -316,7 +316,6 @@ describe RightSupport::Net::RequestBalancer do
       it 're-raises reasonable default fatal errors' do
         test_raise(nil, ArgumentError, [ArgumentError, 1])
         test_raise(nil, MockResourceNotFound, [MockResourceNotFound, 1])
-        test_raise(nil, RSpec::Expectations::ExpectationNotMetError, [RSpec::Expectations::ExpectationNotMetError, 1])
       end
 
       it 'swallows StandardError and friends' do

data/spec/rack/request_logger_spec.rb

@@ -47,6 +47,45 @@ describe RightSupport::Rack::RequestLogger do
       end
     end
 
+    context 'when limit logging extent' do
+      before(:each) do
+        @options = {:except => [/bar/]}
+        @env.merge!('PATH_INFO' => '/foo/bar')
+        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+        @logger.should_receive(:level).and_return(Logger::INFO).by_default
+      end
+
+      it 'does not limit if logger in debug mode' do
+        @logger.should_receive(:level).and_return(Logger::DEBUG)
+        @logger.should_receive(:info)
+        @middleware.call(@env)
+      end
+
+      it 'does not limit if HTTP_X_DEBUG set' do
+        @logger.should_receive(:info)
+        @middleware.call(@env.merge('HTTP_X_DEBUG' => true))
+      end
+
+      it 'does not log for paths matching :except option' do
+        @logger.should_receive(:info).never
+        @middleware.call(@env)
+      end
+
+      it 'does log for paths matching :only option' do
+        @options = {:only => [/bar/]}
+        @middleware = RightSupport::Rack::RequestLogger.new(@app, @options)
+        @logger.should_receive(:info)
+        @middleware.call(@env)
+      end
+
+      it 'sets rack.logging.enabled in Rack environment' do
+        @logger.should_receive(:info)
+        @env.merge!('PATH_INFO' => '/my/app')
+        @middleware.call(@env)
+        @env['rack.logging.enabled'].should be_true
+      end
+    end
+
     context 'Shard ID logging' do
       before(:each) do
         @logger = mock_logger

data/spec/spec_helper.rb

@@ -22,9 +22,6 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'flexmock'
-require 'ruby-debug'
-require 'syntax'
-require 'right_develop'
 
 $:.unshift(File.expand_path('../../../lib', __FILE__)) #ensure we load THIS project's code, not an installed gem
 require 'right_support'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: right_support
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 49
   prerelease: 
   segments: 
   - 2
   - 8
-  - 12
-  version: 2.8.12
+  - 15
+  version: 2.8.15
 platform: ruby
 authors: 
 - Tony Spataro
@@ -20,41 +20,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-22 00:00:00 Z
+date: 2014-02-27 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
+  type: :development
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 3
         segments: 
+        - 2
         - 0
-        - 9
-        version: "0.9"
-  type: :development
-  requirement: *id001
-  prerelease: false
-  name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 1
-        - 8
-        - 3
-        version: 1.8.3
-  type: :development
-  requirement: *id002
+        version: "2.0"
   prerelease: false
+  requirement: *id001
   name: jeweler
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -64,103 +50,48 @@ dependencies:
         - 1
         - 0
         version: "1.0"
-  type: :development
-  requirement: *id003
   prerelease: false
-  name: right_develop
+  requirement: *id002
+  name: flexmock
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 10
-        version: "0.10"
   type: :development
-  requirement: *id004
-  prerelease: false
-  name: ruby-debug
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 63
+        hash: 59
         segments: 
+        - 2
+        - 13
         - 0
-        - 11
-        - 6
-        version: 0.11.6
-  type: :development
-  requirement: *id005
+        version: 2.13.0
   prerelease: false
-  name: ruby-debug19
+  requirement: *id003
+  name: rspec
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 4
-        - 2
-        version: 2.4.2
   type: :development
-  requirement: *id006
-  prerelease: false
-  name: rdoc
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - <
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 29
         segments: 
         - 1
-        - 0
-        version: "1.0"
-  type: :development
-  requirement: *id007
-  prerelease: false
-  name: flexmock
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+        - 3
+        - 3
+        version: 1.3.3
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 15
         segments: 
         - 1
         - 0
-        - 0
-        version: 1.0.0
-  type: :development
-  requirement: *id008
-  prerelease: false
-  name: syntax
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 1
-        - 5
-        version: "1.5"
-  type: :development
-  requirement: *id009
+        version: "1.0"
   prerelease: false
-  name: nokogiri
+  requirement: *id004
+  name: cucumber
 description: A toolkit of useful, reusable foundation code created by RightScale.
 email: support@rightscale.com
 executables: []
@@ -181,12 +112,10 @@ files:
 - VERSION
 - features/balancer_error_handling.feature
 - features/balancer_health_check.feature
-- features/continuous_integration.feature
-- features/continuous_integration_cucumber.feature
-- features/continuous_integration_rspec1.feature
-- features/continuous_integration_rspec2.feature
+- features/hash_tools.feature
 - features/http_client_timeout.feature
 - features/serialization.feature
+- features/step_definitions/hash_tools_steps.rb
 - features/step_definitions/http_client_steps.rb
 - features/step_definitions/request_balancer_steps.rb
 - features/step_definitions/ruby_steps.rb
@@ -289,6 +218,7 @@ files:
 - spec/stats/helpers_spec.rb
 - spec/validation/openssl_spec.rb
 - spec/validation/ssh_spec.rb
+has_rdoc: true
 homepage: https://github.com/rightscale/right_support
 licenses: 
 - MIT
@@ -318,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Reusable foundation code.