rumx 0.0.8 → 0.1.0

data/History.md

@@ -1,6 +1,34 @@
 Rumx Changelog
 =====================
 
+0.1.0
+
+ - Removed the following methods and the equivalient writers and accessors to hopefully make the commands more consistent:
+
+   OLD: bean_list_reader :foo, :string, 'Description'
+   NEW: bean_reader :foo, :list, 'Description', :list_type => :string
+
+   OLD: bean_list_attr_reader :foo, :string, 'Description'
+   NEW: bean_attr_reader :foo, :list, 'Description', :list_type => :string, :allow_write => true #Use allow_write if the accessing of list elements is different from the list.
+
+   OLD: bean_embed :foo, 'Description'
+   NEW: bean_reader :foo, :bean, 'Description'
+
+   OLD: bean_attr_embed :foo, 'Description'
+   NEW: bean_attr_reader :foo, :bean, 'Description'
+
+   OLD: bean_embed_list :foo, 'Description'
+   NEW: bean_reader :foo, :list, 'Description', :list_type => :bean
+
+   OLD: bean_attr_embed_list :foo, 'Description'
+   NEW: bean_attr_reader :foo, :list, 'Description', :list_type => :bean
+
+ - Added Hash type
+
+ - A lot of restructuring of the code so it isn't quite as repetitive for the bean iteration and such.
+
+ - Added example/monitor_script for an example script that could be used with a tool like munin or hyperic.
+
 0.0.8
 
  - Added /attributes query which can retrieve attributes for multiple beans in one call.

data/README.md

@@ -6,7 +6,9 @@ http://github.com/ClarityServices/rumx
 
 Ruby Management Extensions
 
-Allows you to easily implement management interfaces for your Ruby application.
+Allows you to easily implement management interfaces for your Ruby application by adding
+Rumx beans.  A Rumx bean is an object that allows external access to specified attributes
+and operations.  It is basically equivalent to a JMX MBean.
 
 ## Install:
 
@@ -51,8 +53,8 @@ Note that all Rumx::Bean public methods are prefixed with "bean_" to help avoid
 You create a tree of beans under Rumx::Bean.root.  For instance, you might create a tree for the bean above with the following commands:
 
     my_folder = Rumx::Beans::Folder.new
-    Rumx::Bean.root.bean_add_child(:my_folder, my_folder)
-    my_folder.bean_add_child(:my_bean, MyBean.new)
+    Rumx::Bean.root.bean_add_child(:MyFolder, my_folder)
+    my_folder.bean_add_child(:MyBean, MyBean.new)
 
 Rumx includes a Sinatra server app called Rumx::Server.  You could startup a server by creating the following config.ru and running "rackup -p 4567"
 
@@ -87,8 +89,10 @@ Refer to the timer example for more information.
 
 ## TODO
 
+I'm rewriting the list logic.  List stuff will soon be deprecated.
+
 Figure out the "NameError - uninitialized constant Rack::File:" error that occurs frequently on startup and seems related
-to the tree not displaying correctly.  Works okay with refresh.
+to the tree not displaying correctly.  Works okay with refresh.  (Current workaround is to require 'rack/file in server.rb)
 
 Api doc non-existent.
 
@@ -103,8 +107,6 @@ Allow validations in attribute declarations?
 
 New types :date and :datetime?
 
-Build in optional authentication or just let user extend Rumx::Server?
-
 Railtie it?
 
 ## Author

data/examples/bean_hash/README

@@ -0,0 +1,2 @@
+1) Execute 'rackup -p 4567'
+2) Browse to http://localhost:4567, expand the tree and view/update the attributes and operations

data/examples/bean_hash/config.ru

@@ -0,0 +1,9 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubygems'
+require 'rumx'
+require 'my_bean'
+
+Rumx::Bean.root.bean_add_child(:MyBean, MyBean.new)
+run Rumx::Server

data/examples/bean_hash/my_bean.rb

@@ -0,0 +1,44 @@
+require 'rumx'
+
+class MyEntryBean
+  include Rumx::Bean
+
+  bean_attr_accessor :my_int,    :integer, 'My integer'
+  bean_attr_reader   :my_string, :string,  'My string'
+
+  def initialize(my_int, my_string)
+    @my_int, @my_string = my_int, my_string
+  end
+end
+
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_reader :entries,  :hash,   'My entries', :hash_type => :bean
+
+  bean_operation   :put_entry, :void, 'Put entry into hash', [
+      [ :key,       :symbol,  'Hash key'],
+      [ :my_int,    :integer, 'An integer argument' ],
+      [ :my_string, :string,  'A string argument' ]
+  ]
+
+  bean_operation   :remove_entry, :void, 'Remove entry from hash', [
+      [ :key,       :symbol,  'Hash key']
+  ]
+
+  def initialize
+    @entries = {:foo => MyEntryBean.new(1, '#1')}
+  end
+
+  def put_entry(key, my_int, my_string)
+    @entries[key] = MyEntryBean.new(my_int, my_string)
+    return my_string
+  end
+
+  def remove_entry(key)
+    removed = @entries.delete(key)
+    return 'None' unless removed
+    return removed.my_string
+  end
+end
+

data/examples/bean_list/my_bean.rb

@@ -14,9 +14,9 @@ end
 class MyBean
   include Rumx::Bean
 
-  bean_attr_reader     :greeting, :string, 'My greeting'
-
-  bean_attr_embed_list :entries,           'My entries'
+  bean_attr_reader :greeting, :string, 'My greeting'
+  # old bean_attr_embed_list :entries,           'My entries'
+  bean_attr_reader :entries,  :list,   'My entries', :list_type => :bean
 
   bean_operation   :push_entry, :void, 'Push entry onto entry list', [
       [ :my_int,    :integer, 'An integer argument' ],

data/examples/embedded/my_bean.rb

@@ -4,8 +4,9 @@ require 'my_embedded_bean'
 class MyBean
   include Rumx::Bean
 
-  bean_attr_accessor :greeting, :string,  'My greeting'
-  bean_attr_embed    :embedded,           'My embedded bean'
+  bean_attr_accessor :greeting, :string, 'My greeting'
+  #old bean_attr_embed    :embedded,           'My embedded bean'
+  bean_attr_reader   :embedded, :bean,   'My embedded bean'
 
   bean_operation     :my_operation,       :string,  'My operation', [
       [ :arg_int,    :integer, 'An int argument'   ]

data/examples/hash/README

@@ -0,0 +1,2 @@
+1) Execute 'rackup -p 4567'
+2) Browse to http://localhost:4567, expand the tree and view/update the attributes and operations

data/examples/hash/config.ru

@@ -0,0 +1,9 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubygems'
+require 'rumx'
+require 'my_bean'
+
+Rumx::Bean.root.bean_add_child(:MyBean, MyBean.new)
+run Rumx::Server

data/examples/hash/my_bean.rb

@@ -0,0 +1,30 @@
+require 'rumx'
+
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_reader :messages, :hash,    'Message', :hash_type => :string, :allow_write => true
+
+  bean_operation   :put_message, :string, 'Put message onto message hash', [
+      [ :key,     :symbol, 'The hash key'],
+      [ :message, :string, 'The message' ]
+  ]
+
+  bean_operation   :remove_message, :string, 'Remove message from message hash', [
+      [ :key,     :symbol, 'The hash key']
+  ]
+
+  def initialize
+    @messages = {:foo => 'Foo message', :bar => 'Bar message'}
+  end
+
+  def put_message(key, message)
+    @messages[key] = message
+    return message
+  end
+
+  def remove_message(key)
+    @messages.delete(key)
+  end
+end
+

data/examples/list/my_bean.rb

@@ -3,8 +3,11 @@ require 'rumx'
 class MyBean
   include Rumx::Bean
 
-  bean_attr_accessor      :max_messages, :integer, 'The maximum number of messages to keep'
-  bean_list_attr_accessor :messages,     :string,  'Message', :max_size => :max_messages
+  # old bean_attr_accessor      :max_messages, :integer, 'The maximum number of messages to keep'
+  bean_attr_accessor :max_messages, :integer, 'The maximum number of messages to keep'
+  # old bean_list_attr_accessor :messages,     :string,  'Message', :max_size => :max_messages
+  # Uncomment allow_write part to allow write access to individual messages
+  bean_attr_reader :messages,     :list,    'Message', :list_type => :string, :max_size => :max_messages#, :allow_write => true
 
   bean_operation   :push_message, :string, 'Push message onto message list', [
       [ :message, :string, 'A string argument' ]

data/examples/monitor_script/README

@@ -0,0 +1,8 @@
+Startup example/simple and try the following:
+
+./rumx_attributes MyFolder/MyBean
+./rumx_attributes MyFolder/MyBean MyFolder/MyOtherBean
+./rumx_attributes bean=MyFolder/MyBean other=MyFolder/MyOtherBean
+# Query params for GETs won't show until the next time you query
+./rumx_attributes bean=MyFolder/MyBean?my_accessor=42\&my_writer=123.45 other=MyFolder/MyOtherBean
+./rumx_attributes bean=MyFolder/MyBean other=MyFolder/MyOtherBean

data/examples/monitor_script/rumx_attributes

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'net/http'
+require 'optparse'
+require 'cgi'
+
+class MyOptions < Hash
+  def initialize(argv)
+    super
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 [options]"
+
+      # Default values
+      self[:host]     = 'localhost'
+      self[:port]     = 4567
+      self[:username] = nil
+      self[:password] = nil
+      self[:format]   = 'properties'
+      self[:mount]    = nil
+
+      opts.on('-H', '--host [HOST]', "host to hit (defaults to #{self[:host]})") do |val|
+        self[:host] = val
+      end
+
+      opts.on('-P', '--port [PORT]', Integer, "port number to hit (defaults to #{self[:port]})") do |val|
+        self[:port] = val
+      end
+
+      opts.on('-u', '--username [USERNAME]', "username for basic authentication") do |val|
+        self[:username] = val
+      end
+
+      opts.on('-p', '--password [PASSWORD]', "password for basic authentication") do |val|
+        self[:password] = val
+      end
+
+      opts.on('-f', '--format [FORMAT]', "format of the returned data (json or properties, defaults to #{self[:format]}") do |val|
+        self[:format] = val
+      end
+
+      opts.on('-m', '--mount [PATH]', "path where the Rumx app is mounted") do |val|
+        self[:format] = val
+      end
+    end
+
+    opts.parse!(argv)
+  end
+end
+
+options = MyOptions.new(ARGV)
+
+# Args can be of the form Myfolder/Subfolder/Foo?reset=true which will expand to <mount>/attributes.<format>?query0=Myfolder/Subfolder/Foo/attributes?reset=true&query1=etc
+path = "/attributes.#{options[:format]}?"
+path = options[:mount] + path if options[:mount]
+ARGV.each_with_index do |query, index|
+  path += '&' if index > 0
+  path += "query_#{index}=#{CGI.escape(query)}"
+end
+
+req = Net::HTTP::Get.new(path)
+req.basic_auth(options[:username], options[:password]) if options[:username]
+res = Net::HTTP.start(options[:host], options[:port]) { |http| http.request(req) }
+if res.kind_of?(Net::HTTPSuccess)
+  puts res.body
+end

data/examples/simple/config.ru

@@ -3,9 +3,11 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
 
 require 'rubygems'
 require 'rumx'
-require 'my_bean'
+require './my_bean'
+require './my_other_bean'
 
 my_folder = Rumx::Beans::Folder.new
 Rumx::Bean.root.bean_add_child(:MyFolder, my_folder)
 my_folder.bean_add_child(:MyBean, MyBean.new)
+my_folder.bean_add_child(:MyOtherBean, MyOtherBean.new)
 run Rumx::Server

data/examples/simple/my_other_bean.rb

@@ -0,0 +1,11 @@
+require 'rumx'
+
+class MyOtherBean
+  include Rumx::Bean
+
+  bean_attr_accessor :message, :string, 'A message'
+
+  def initialize
+    @message = "I'm just here to put another bean in the mix"
+  end
+end

data/examples/timer/README

@@ -1,7 +1,7 @@
 1) Execute 'rackup -p 4567'
 2) Browse to http://localhost:4567, expand the tree and view/update the attributes and operations
 3) Browse to http://localhost:4567/MyBean/timer/attributes.json and refresh the screen every so often.
-4) Browse to http://localhost:4567/MyBean/timer/attributes.json?reset=true and refresh the screen every so often.
+4) Browse to http://localhost:4567/MyBean/timer/attributes.properties?reset=true and refresh the screen every so often.
    Note that a tool like munin, nagios, or hyperic could poll this url to monitor the timer and graph the results
    or create alerts based on exceeding some threshold.
 

data/examples/timer/my_bean.rb

@@ -3,13 +3,14 @@ class MyBean
 
   bean_attr_accessor :sleep_time,      :float,   'Amount of time in seconds my measured block sleeps'
   bean_attr_accessor :percent_failure, :integer, 'Percentage of time the measured block will fail'
-  bean_attr_embed    :timer,                     'Timer for our sleep action'
 
   def initialize
     @sleep_time      = 0.5
     @percent_failure = 10
     @timer           = Rumx::Beans::TimerAndError.new(:max_errors => 5)
 
+    bean_add_child(:timer, @timer)
+
     Thread.new do
       while true
         begin

data/examples/timer_hash/README

@@ -0,0 +1,2 @@
+1) Execute 'rackup -p 4567'
+2) Browse to http://localhost:4567, expand the tree and view/update the attributes and operations

data/examples/timer_hash/config.ru

@@ -0,0 +1,9 @@
+# Allow examples to be run in-place without requiring a gem install
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+
+require 'rubygems'
+require 'rumx'
+require 'my_bean'
+
+Rumx::Bean.root.bean_add_child(:MyBean, MyBean.new)
+run Rumx::Server

data/examples/timer_hash/my_bean.rb

@@ -0,0 +1,29 @@
+require 'rumx'
+
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_accessor :sleep1, :float, 'Amount of time sleep1 sleeps'
+  bean_attr_accessor :sleep2, :float, 'Amount of time sleep2 sleeps'
+  bean_attr_accessor :sleep3, :float, 'Amount of time sleep3 sleeps'
+
+  def initialize
+    @sleep1 = 1
+    @sleep2 = 2
+    @sleep3 = 3
+    @timers = Rumx::Beans::TimerHash.new
+    bean_add_child(:timers, @timers)
+    100.times do
+      Thread.new do
+        while true
+          @timers[:overall].measure do
+            @timers[:sleep1].measure { sleep @sleep1 }
+            @timers[:sleep2].measure { sleep @sleep2 }
+            @timers[:sleep3].measure { sleep @sleep3 }
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/rumx.rb

@@ -1,7 +1,12 @@
 require 'rumx/argument'
 require 'rumx/attribute'
+require 'rumx/attribute_info'
+require 'rumx/list_attribute'
+require 'rumx/hash_attribute'
 require 'rumx/operation'
 require 'rumx/bean'
+require 'rumx/list_bean'
+require 'rumx/hash_bean'
 require 'rumx/type'
 require 'rumx/server'
 require 'rumx/beans'

data/lib/rumx/attribute.rb

@@ -2,37 +2,46 @@ module Rumx
   class Attribute
     attr_reader :name, :type, :description, :allow_read, :allow_write
 
-    def initialize(name, type_name, description, allow_read, allow_write, options)
+    def initialize(name, type, description, allow_read, allow_write, options)
       @name        = name.to_sym
-      @type        = Type.find(type_name)
+      @type        = type
       @description = description
-      @allow_read  = allow_read
-      @allow_write = allow_write
+      # List and hash attributes might set up the object for reading but the individual elements for writing
+      @allow_read  = options[:allow_read] || allow_read
+      @allow_write = options[:allow_write] || allow_write
       @options     = options
     end
 
     def get_value(bean)
-      return nil unless @allow_read
-      bean.send(self.name)
+      @allow_read ? bean.send(@name) : nil
     end
 
-    def set_value(bean, value)
-      raise 'Illegal set_value' unless @allow_write
-      bean.send(self.name.to_s+'=', type.string_to_value(value))
+    def each_attribute_info(bean, ancestry, &block)
+      yield AttributeInfo.new(self, bean, ancestry+[@name], get_value(bean))
     end
 
-    def get_index_value(obj, index)
-      return nil unless @allow_read
-      return obj[index]
-    end
-
-    def set_index_value(obj, index, value)
-      raise 'Illegal set_index_value' unless @allow_write
-      obj[index] = type.string_to_value(value)
+    def write?(bean, params)
+      if @allow_write
+        param_value(params) do |value|
+          bean.send(@name.to_s+'=', @type.string_to_value(value))
+          return true
+        end
+      end
+      return false
     end
 
     def [](key)
       @options[key]
     end
+
+    protected
+
+    def param_value(params, &block)
+      if params.has_key?(@name)
+        yield params[@name]
+      elsif params.has_key?(@name.to_s)
+        yield params[@name.to_s]
+      end
+    end
   end
 end