fiveruns-dash-ruby 0.7.6 → 0.8.0

data/README.rdoc

@@ -8,11 +8,11 @@ You'll need a Dash account before using this library.
 
 This library is released as a gem from the official repository at http://github.com/fiveruns/dash-ruby
 
-  sudo gem install fiveruns-dash-ruby --source 'http://gems.github.com'
+  sudo gem install fiveruns-dash-ruby --source http://gems.github.com
 
 == Usage
 
-See the Ruby Language Guide http://dash.fiveruns.com/help/ruby.html for information on how to use this library. 
+See the Ruby support pages, http://support.fiveruns.com/faqs/dash/ruby, for information on how to use this library. 
 
 == Authors
 
@@ -38,7 +38,7 @@ The best way to contribute is by sending pull requests via GitHub.  The official
 
 Please join the dash-users Google group, http://groups.google.com/group/dash-users
 
-You can also contact us via Twitter, Campfire, or email; see the main help page, http://dash.fiveruns.com/help, for details.
+You can also contact us via Twitter, Campfire, or email; see the main help page, http://support.fiveruns.com, for details.
 
 == License
 

data/lib/fiveruns/dash/configuration.rb

@@ -4,7 +4,9 @@ module Fiveruns::Dash
     
     class ConflictError < ::ArgumentError; end
     
-    delegate :each, :to => :metrics
+    def each(&block)
+      metrics.each(&block)
+    end
     
     def self.default_options
       ::Fiveruns::Dash.logger.info "CWD::#{Dir.pwd.inspect}"

data/lib/fiveruns/dash/exception_recorder.rb

@@ -77,9 +77,9 @@ module Fiveruns
     end
     
     def data
-      returning exceptions.dup do
-        reset
-      end
+      duped = exceptions.dup
+      reset
+      duped
     end
 
     def reset

data/lib/fiveruns/dash/instrument.rb

@@ -20,9 +20,9 @@ module Fiveruns::Dash
         begin
           obj, meth = case raw_target
           when /^(.+)#(.+)$/
-            [$1.constantize, $2]
+            [Fiveruns::Dash::Util.constantize($1), $2]
           when /^(.+)(?:\.|::)(.+)$/
-            [(class << $1.constantize; self; end), $2]
+            [(class << Fiveruns::Dash::Util.constantize($1); self; end), $2]
           else
             raise Error, "Bad target format: #{raw_target}"
           end
@@ -129,7 +129,7 @@ module Fiveruns::Dash
             #{yield(format % :without)}
           end
         end
-        alias_method_chain :#{meth}, :#{feature}
+        Fiveruns::Dash::Util.chain(self, :#{meth}, :#{feature})
       DYNAMIC
     end
       

data/lib/fiveruns/dash/metric.rb

@@ -10,8 +10,8 @@ module Fiveruns::Dash
     def initialize(name, *args, &block)
       @@warned = false
       @name = name.to_s
-      @options = args.extract_options!
-      @description = args.shift || @name.titleize
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @description = args.shift || Util.titleize(@name)
       @help_text = args.shift
       @operation = block
       @virtual = !!options[:sources]
@@ -102,17 +102,20 @@ module Fiveruns::Dash
     #######
     
     def validate!
-      raise ArgumentError, "#{name} - Virtual metrics should have source metrics" if virtual? && options[:sources].blank?
+      raise ArgumentError, "'#{name}' should be between 3 and 32 characters" unless (3..32).include?(name.size)
+      raise ArgumentError, "'#{name}' should only contain letters, numbers and underscore" if name !~ /\A\w+\Z/
+
+      raise ArgumentError, "#{name} - Virtual metrics should have source metrics" if virtual? && Util.blank?(options[:sources])
       raise ArgumentError, "#{name} - metrics should not have source metrics" if !virtual? && options[:sources]
     end
     
     def optional_info
-      returning({}) do |optional|
-        copy = optional.merge(@options[:unit] ? {:unit => @options[:unit].to_s} : {})
-        copy = copy.merge(@options[:scope] ? {:scope => @options[:scope].to_s} : {})        
-        copy = copy.merge(abstract? ? {:abstract => true} : {})
-        optional.merge!(copy)
-      end
+      optional = {}
+      copy = optional.merge(@options[:unit] ? {:unit => @options[:unit].to_s} : {})
+      copy = copy.merge(@options[:scope] ? {:scope => @options[:scope].to_s} : {})        
+      copy = copy.merge(abstract? ? {:abstract => true} : {})
+      optional.merge!(copy)
+      optional
     end
 
     def combine(source_values)
@@ -257,9 +260,9 @@ module Fiveruns::Dash
     end
     
     def value_hash
-      returning(:values => current_value) do
-        reset
-      end
+      values = {:values => current_value}
+      reset
+      values
     end
 
     def install_hook
@@ -276,22 +279,26 @@ module Fiveruns::Dash
     end
     
     def instrument_options
-      returning({}) do |options|
-        options[:reentrant_token] = self.object_id.abs if @options[:reentrant]
-        options[:only_within] = @options[:only_within] if @options[:only_within]
-        options[:mark_as] = @name if @options[:mark]
-      end
+      options = {}
+      options[:reentrant_token] = self.object_id.abs if @options[:reentrant]
+      options[:only_within] = @options[:only_within] if @options[:only_within]
+      options[:mark_as] = @name if @options[:mark]
+      options
     end
 
     def methods_to_instrument
-      @methods_to_instrument ||= Array(@options[:method]) + Array(@options[:methods])
+      @methods_to_instrument ||= begin
+        Array(@options[:method]) + Array(@options[:methods])
+      end
     end
     
     def validate!
       super
-      raise ArgumentError, "Can not set :unit for `#{@name}' time metric" if @options[:unit]
-      if methods_to_instrument.blank?
-        raise ArgumentError, "Must set :method or :methods option for `#{@name}` time metric"
+      raise ArgumentError,
+            "Can not set :unit for `#{@name}' time metric" if @options[:unit]
+      if Util.blank?(methods_to_instrument)
+        raise ArgumentError,
+              "Must set :method or :methods option for `#{@name}` time metric"
       end
     end
     
@@ -319,17 +326,18 @@ module Fiveruns::Dash
     
     def value_hash
       if incrementing_methods.any?
-        returning(:values => current_value) do
-          reset
-        end
+        values = {:values => current_value}
+        reset
+        values
       else
         super
       end
     end
     
     def install_hook
-      if incrementing_methods.blank?
-        raise RuntimeError, "Bad configuration for `#{@name}` counter metric"
+      if Util.blank?(incrementing_methods)
+        raise RuntimeError,
+              "Bad configuration for `#{@name}` counter metric"
       end
       @operation ||= lambda { nil }
       incrementing_methods.each do |meth|

data/lib/fiveruns/dash/reporter.rb

@@ -8,7 +8,7 @@ module Fiveruns::Dash
     
     attr_accessor :interval
     attr_reader :started_at
-    def initialize(session, interval = 60.seconds.to_i)
+    def initialize(session, interval = 60)
       @session = session
       @interval = interval
     end
@@ -67,6 +67,10 @@ module Fiveruns::Dash
       @thread && @thread.alive? && @thread.raise(ShutdownSignal.new)
     end
 
+    def secure!
+      @update_locations = %w(https://dash-collector.fiveruns.com https://dash-collector02.fiveruns.com)
+    end
+
     #######
     private
     #######
@@ -200,7 +204,7 @@ module Fiveruns::Dash
     end
     
     def default_update_locations
-      %w(https://dash-collector.fiveruns.com https://dash-collector02.fiveruns.com)
+      %w(http://dash-collector.fiveruns.com http://dash-collector02.fiveruns.com)
     end
 
   end

data/lib/fiveruns/dash/session.rb

@@ -52,7 +52,7 @@ module Fiveruns::Dash
     
     def reset
       exception_recorder.reset
-      configuration.metrics.each(&:reset)
+      configuration.metrics.each { |m| m.reset }
     end
     
     def data

data/lib/fiveruns/dash/store/http.rb

@@ -20,7 +20,7 @@ module Fiveruns::Dash::Store
         ip = resolved_hostnames[hostname].ip
       else
         ip = hostname == 'localhost' ? '127.0.0.1' : IPSocket.getaddress(hostname)
-        ip_struct = OpenStruct.new(:ip => ip, :next_update => Time.now + 23.hours + rand(60).minutes)
+        ip_struct = OpenStruct.new(:ip => ip, :next_update => Time.now + (23 * 60 * 60) + (rand(60) * 60))
         resolved_hostnames[hostname] = ip_struct
       end
       ip
@@ -92,23 +92,23 @@ module Fiveruns::Dash::Store
     end
     
     def add_path_to(uri)
-      returning uri.dup do |new_uri|
-        path = case payload
-        when Fiveruns::Dash::PingPayload
-          ::File.join('/apps', app_token, "ping")
-        when Fiveruns::Dash::InfoPayload
-          ::File.join('/apps', app_token, "processes.json")
-        when Fiveruns::Dash::DataPayload
-          ::File.join('/apps', app_token, "metrics.json")
-        when Fiveruns::Dash::TracePayload
-          ::File.join('/apps', app_token, "traces.json")
-        when Fiveruns::Dash::ExceptionsPayload
-          ::File.join('/apps', app_token, "exceptions.json")
-        else
-          raise ArgumentError, 'Unknown payload type: #{payload.class}'
-        end
-        new_uri.path = path
+      new_uri = uri.dup
+      path = case payload
+      when Fiveruns::Dash::PingPayload
+        ::File.join('/apps', app_token, "ping")
+      when Fiveruns::Dash::InfoPayload
+        ::File.join('/apps', app_token, "processes.json")
+      when Fiveruns::Dash::DataPayload
+        ::File.join('/apps', app_token, "metrics.json")
+      when Fiveruns::Dash::TracePayload
+        ::File.join('/apps', app_token, "traces.json")
+      when Fiveruns::Dash::ExceptionsPayload
+        ::File.join('/apps', app_token, "exceptions.json")
+      else
+        raise ArgumentError, 'Unknown payload type: #{payload.class}'
       end
+      new_uri.path = path
+      new_uri
     end
     
     def extra_params_for(payload)
@@ -121,7 +121,7 @@ module Fiveruns::Dash::Store
     end
     
     def normalize_key(key)
-      key.to_a.flatten.map(&:to_s).sort
+      key.to_a.flatten.map { |k| k.to_s }.sort
     end
     
     def app_token
@@ -130,7 +130,7 @@ module Fiveruns::Dash::Store
 
     class Multipart
 
-      BOUNDARY_ROOT = 'B0UND~F0R~UPL0AD'
+      BOUNDARY_ROOT = 'B0UND'
 
       attr_reader :file, :params
       def initialize(file, params={})

data/lib/fiveruns/dash/typable.rb

@@ -3,10 +3,13 @@ module Fiveruns::Dash
   module Typable
     
     def self.included(base)
-      name = base.name.demodulize.underscore
+      name = Fiveruns::Dash::Util.shortname(base.name)
       base.class_eval %{
         def self.#{name}_type
-          @#{name}_type ||= name.demodulize.underscore.sub(/_#{name}$/, '').to_sym
+          @#{name}_type ||= begin
+            short = Fiveruns::Dash::Util.shortname(name)
+            short.sub(/_#{name}$/, '').to_sym
+          end
         end
       }
       base.extend ClassMethods
@@ -15,7 +18,7 @@ module Fiveruns::Dash
     module ClassMethods
       
       def inherited(klass)
-        types[klass.__send__("#{name.demodulize.underscore}_type")] = klass
+        types[klass.__send__("#{Fiveruns::Dash::Util.shortname(name)}_type")] = klass
       end
 
       def types

data/lib/fiveruns/dash/update.rb

@@ -97,7 +97,12 @@ module Fiveruns::Dash
     end
     
     def uris_by_scheme(urls)
-      urls.map { |url| safe_parse(url) }.group_by(&:scheme)
+      safe = urls.map { |url| safe_parse(url) }
+      safe.inject({}) do |mapping, url|
+        mapping[url.scheme] ||= []
+        mapping[url.scheme] << url
+        mapping
+      end
     end
     
     def storage_method_for(scheme)
@@ -118,10 +123,10 @@ module Fiveruns::Dash
     end
 
     def io
-      returning StringIO.new do |io|
-        io.write compressed
-        io.rewind
-      end
+      io = StringIO.new
+      io.write compressed
+      io.rewind
+      io
     end
     
     def params

data/lib/fiveruns/dash/util.rb

@@ -0,0 +1,70 @@
+module Fiveruns::Dash
+  
+  # Utility methods, largely extracted from ActiveSupport
+  module Util
+    
+    def self.demodulize(str)
+      str.sub(/.*::/, '')
+    end
+    
+    def self.shortname(str)
+      underscore(demodulize(str))
+    end
+    
+    # Note: Doesn't do any fancy Inflector-style modifications
+    def self.titleize(str)
+      underscore(str.to_s).split(/[_]+/).map { |s| s.capitalize }.join(' ')
+    end
+
+    def self.underscore(str)
+      str.to_s.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+    
+    def self.blank?(obj)
+      obj.respond_to?(:empty?) ? obj.empty? : !self
+    end
+    
+    def self.constantize(str)
+      names = str.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+    
+    # ActiveSupport's alias_method_chain (but from outside the module)
+    # Note: We'd love to use something other than AMC, but it's the 
+    #       most consistent wrapper we know of that doesn't require
+    #       cooperation from the target.
+    def self.chain(mod, target, feature)
+      # Strip out punctuation on predicates or bang methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+
+      with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}",
+                                    "#{aliased_target}_without_#{feature}#{punctuation}"
+
+      mod.send(:alias_method, without_method, target)
+      mod.send(:alias_method, target, with_method)
+
+      case
+      when mod.public_method_defined?(without_method)
+        mod.instance_eval %(public :#{target})
+      when mod.protected_method_defined?(without_method)
+        mod.instance_eval %(protected :#{target})
+      when mod.private_method_defined?(without_method)
+        mod.instance_eval %(private :#{target})  
+      end
+    end
+    
+  end
+  
+end

data/lib/fiveruns/dash.rb

@@ -1,8 +1,7 @@
 require 'rubygems'
-# TODO remove ActiveSupport dependency
-require 'activesupport'
 require 'json'
 
+require 'pathname'
 require 'thread'
 require 'logger'
 
@@ -14,6 +13,7 @@ $:.unshift(File.dirname(__FILE__))
 module Fiveruns; end
 
 require 'dash/version'
+require 'dash/util'
 require 'dash/configuration'
 require 'dash/typable'
 require 'dash/metric'

data/test/collector_communication_test.rb

@@ -238,7 +238,7 @@ class CollectorCommunicationTest < Test::Unit::TestCase
   #######
   
   def full_urls(service)
-    full_uris(service).map(&:to_s)
+    full_uris(service).map { |u| u.to_s }
   end
   
   def full_uris(service)

data/test/configuration_test.rb

@@ -25,7 +25,7 @@ class ConfigurationTest < Test::Unit::TestCase
       setup do
         @configuration = Configuration.new do |config|
           metric_types.each do |type|
-            config.__send__(type, "Metric: #{type}") do
+            config.__send__(type, "#{type}") do
               # Empty block for metric types that require it
             end
           end
@@ -34,7 +34,7 @@ class ConfigurationTest < Test::Unit::TestCase
       should "assign all metrics" do
         assert_equal 3, @configuration.metrics.size
         types = @configuration.metrics.map { |metric| metric.class.metric_type }
-        assert_equal metric_types.map(&:to_s).sort, types.map(&:to_s).sort
+        assert_equal metric_types.map { |i| i.to_s }.sort, types.map { |i| i.to_s }.sort
       end
       should "not allow invalid types" do
         assert_raises NoMethodError do
@@ -76,7 +76,7 @@ class ConfigurationTest < Test::Unit::TestCase
       end
       should "execute if correct version" do
         assert_equal 2, @config.metrics.size
-        assert_equal %w(bar foo), @config.metrics.map(&:name).map(&:to_s).sort
+        assert_equal %w(bar foo), @config.metrics.map { |m| m.name }.map { |i| i.to_s }.sort
       end
     end
 

data/test/http_store_test.rb

@@ -42,7 +42,7 @@ class HTTPStoreTest < Test::Unit::TestCase
         new_uri = @update.resolved_hostname(uris.first.host)        
         assert_equal new_uri, "1.1.1.1"
         assert_equal @update.resolved_hostnames.keys.size, 1
-        assert @update.resolved_hostnames[uris.first.host].next_update > (Time.now + 23.hours)
+        assert @update.resolved_hostnames[uris.first.host].next_update > (Time.now + (23 * 60 * 60))
         assert_equal @update.resolved_hostname(uris.first.host), "1.1.1.1"
         junk = @update.resolved_hostname(uris.first.host)        
         
@@ -54,14 +54,14 @@ class HTTPStoreTest < Test::Unit::TestCase
         assert_equal @update.resolved_hostnames.keys.size, 0
         new_uri = @update.resolved_hostname(uris.first.host)   
         assert_equal new_uri, "1.1.1.1"
-        @update.resolved_hostnames[uris.first.host].next_update = 10.hours.ago
+        @update.resolved_hostnames[uris.first.host].next_update = Time.now - (10 * 60 * 60)
         first_expire = @update.resolved_hostnames[uris.first.host].next_update
         
         new_uri = @update.resolved_hostname(uris.first.host)   
         second_expire = @update.resolved_hostnames[uris.first.host].next_update
         assert_equal new_uri, "2.2.2.2"
-        assert second_expire < (Time.now + 25.hours)
-        assert second_expire > (Time.now + 23.hours)
+        assert second_expire < (Time.now + (25 * 60 * 60))
+        assert second_expire > (Time.now + (23 * 60 * 60))
       end
     end
     
@@ -83,9 +83,8 @@ class HTTPStoreTest < Test::Unit::TestCase
           end
         end
         should "fallback to working URL" do
-          returning @update.store_http(*uris) do |pass_uri|
-            assert_equal uris[1], pass_uri
-          end
+          pass_uri = @update.store_http(*uris)
+          assert_equal uris[1], pass_uri
         end
       end
       context "on non-201 response" do
@@ -117,9 +116,8 @@ class HTTPStoreTest < Test::Unit::TestCase
             end
           end
           should "fallback to working URL" do
-            returning @update.store_http(*uris) do |pass_uri|
-              assert_equal uris[1], pass_uri
-            end
+            pass_uri = @update.store_http(*uris)
+            assert_equal uris[1], pass_uri
           end
         end
         context "on non-201 response" do
@@ -166,9 +164,8 @@ class HTTPStoreTest < Test::Unit::TestCase
             end
           end
           should "fallback to working URL" do
-            returning @update.store_http(*uris) do |pass_uri|
-              assert_equal uris[1], pass_uri
-            end
+            pass_uri = @update.store_http(*uris)
+            assert_equal uris[1], pass_uri
           end
         end
         context "on non-201 response" do
@@ -192,7 +189,7 @@ class HTTPStoreTest < Test::Unit::TestCase
   #######
   
   def full_urls(service)
-    full_uris(service).map(&:to_s)
+    full_uris(service).map { |u| u.to_s }
   end
   
   def full_uris(service)

data/test/recipe_test.rb

@@ -136,7 +136,8 @@ class RecipeTest < Test::Unit::TestCase
   #######
   
   def assert_metrics(*names)
-    assert_equal names.sort, config.metrics.map(&:name).map(&:to_s).sort
+    assert_equal names.sort,
+                 config.metrics.map { |m| m.name }.map { |m| m.to_s }.sort
   end
   
   def recipe(name = :test, options = {:url => 'http://test.com'}, &block)

data/test/test_helper.rb

@@ -5,10 +5,15 @@ begin
   require 'shoulda'
   require 'flexmock/test_unit'
   require 'fake_web'
-rescue
+rescue LoadError
   puts "Please install the Shoulda, FakeWeb and flexmock gems to run the Dash plugin tests."
 end
 
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
 $:.unshift(File.dirname(__FILE__) << '/../lib')
 # Require library files
 require 'fiveruns/dash'

data/version.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 7
-:patch: 6
+:minor: 8
+:patch: 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors: 
 - FiveRuns Development Team
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-11 00:00:00 -08:00
+date: 2009-02-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -51,6 +52,7 @@ files:
 - lib/fiveruns/dash/trace.rb
 - lib/fiveruns/dash/typable.rb
 - lib/fiveruns/dash/update.rb
+- lib/fiveruns/dash/util.rb
 - lib/fiveruns/dash/version.rb
 - lib/fiveruns/dash.rb
 - test/collector_communication_test.rb