rumx 0.0.1

data/History.md

@@ -0,0 +1,6 @@
+Rumx Changelog
+=====================
+
+0.0.1
+
+ - Initial release

data/LICENSE.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Clarity Services, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,107 @@
+# rumx
+
+http://github.com/ClarityServices/rumx
+
+## Description:
+
+Ruby Management Extensions
+
+Allows you to easily implement management interfaces for your Ruby application.
+
+## Install:
+
+  gem install rumx
+
+## Usage:
+
+You can easily add management interfaces to your classes by including Rumx::Bean and creating
+bean attributes and operations.  For example, you might create a class as follows:
+
+    require 'rumx'
+
+    class MyBean
+      include Rumx::Bean
+
+      bean_attr_reader   :greeting,           :string,  'My greeting'
+      bean_reader        :goodbye,            :string,  'My goodbye'
+      bean_attr_accessor :my_accessor,        :integer, 'My integer accessor'
+
+      bean_operation     :my_operation,       :string,  'My operation', [
+          [ :arg_int,    :integer, 'An int argument'   ],
+          [ :arg_float,  :float,   'A float argument'  ],
+          [ :arg_string, :string,  'A string argument' ]
+      ]
+
+      def initialize
+        @greeting    = 'Hello, Rumx'
+        @my_accessor = 4
+      end
+
+      def goodbye
+        'Goodbye, Rumx (hic)'
+      end
+
+      def my_operation(arg_int, arg_float, arg_string)
+        "arg_int class=#{arg_int.class} value=#{arg_int} arg_float class=#{arg_float.class} value=#{arg_float} arg_string class=#{arg_string.class} value=#{arg_string}"
+      end
+    end
+
+Note that all Rumx::Bean public methods are prefixed with "bean_" to help avoid name collisions.
+
+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 includes a Sinatra server app called Rumx::Server.  You could startup a server by creating the following config.ru and running "rackup -p 4567"
+
+    require 'rubygems'
+    require 'rumx'
+    require 'my_bean'
+    require ...
+
+    run Rumx::Server
+
+Then, you can just browse to http://localhost:4567 to inspect, modify, and execute attributes and operations.
+
+Rumx comes with some ready-made beans that you can use within your application.  For instance, suppose you wanted to track the
+amount of time that an expensive operation takes to execute.  You might do something like the following:
+
+    class MyClass
+      @@timer = Rumx::Beans::Timer.new
+      Rumx::Bean.root.bean_add_child(:my_timer, @@timer)
+
+      def my_expensive_operation
+        @@timer.measure do
+          ...
+        end
+      end
+
+      ...
+    end
+
+Then you could use a tool such as munin, nagios, hyperic, etc to poll the url http://my-host:4567/my_timer.json?reset=true
+to monitor, graph, or create an alert based on the average, max, and min times that your operation takes.
+Refer to the timer example for more information.
+
+## TODO
+
+Api doc non-existent.
+
+Really needs some html/css love.  Right now the sinatra pages are so ugly they'll make your eyes hurt but I don't do this stuff
+so well.  Volunteers anyone?
+
+Need tests!  So far just doing Example Driven Development.
+
+Build in optional authentication or just let user extend Rumx::Server?
+
+Railtie it.
+
+## Author
+
+Brad Pardee
+
+## Copyright
+
+Copyright (c) 2011 Clarity Services. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'date'
+
+desc "Build gem"
+task :gem  do |t|
+  system 'gem build rumx.gemspec'
+end
+
+task :test do
+
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end
+
+desc "Generate RDOC documentation"
+task :doc do
+  system "rdoc --main README.md --inline-source --quiet README.md `find lib -name '*.rb'`"
+end

data/examples/bean_list/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_list/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_list/my_bean.rb

@@ -0,0 +1,35 @@
+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     :greeting, :string, 'My greeting'
+
+  bean_attr_embed_list :entries,           'My entries'
+
+  bean_operation   :push_entry, :void, 'Push entry onto entry list', [
+      [ :my_int,    :integer, 'An integer argument' ],
+      [ :my_string, :string,  'A string argument' ]
+  ]
+
+  def initialize
+    @greeting = 'Hello, Rumx'
+    @entries = [MyEntryBean.new(1, '#1')]
+  end
+
+  def push_entry(my_int, my_string)
+    @entries.push(MyEntryBean.new(my_int, my_string))
+  end
+end
+

data/examples/embedded/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/embedded/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/embedded/my_bean.rb

@@ -0,0 +1,23 @@
+require 'rumx'
+require 'my_embedded_bean'
+
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_accessor :greeting, :string,  'My greeting'
+  bean_attr_embed    :embedded,           'My embedded bean'
+
+  bean_operation     :my_operation,       :string,  'My operation', [
+      [ :arg_int,    :integer, 'An int argument'   ]
+  ]
+
+  def initialize
+    @greeting = 'Hello, Rumx'
+    @embedded = MyEmbeddedBean.new
+  end
+
+  def my_operation(arg_int)
+    "arg_int value=#{arg_int}"
+  end
+end
+

data/examples/embedded/my_embedded_bean.rb

@@ -0,0 +1,22 @@
+require 'rumx'
+
+class MyEmbeddedBean
+  include Rumx::Bean
+
+  bean_attr_reader   :foo, :integer, 'Foo integer'
+  bean_attr_accessor :bar, :integer, 'Bar integer'
+
+  bean_operation     :my_embedded_operation,       :string,  'My embedded_operation', [
+      [ :arg_string, :string,  'A string argument' ]
+  ]
+
+  def initialize
+    @foo = 2
+    @bar = 3
+  end
+  
+  def my_embedded_operation(arg_string)
+    "arg_string value=#{arg_string}"
+  end
+end
+

data/examples/list/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/list/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/list/my_bean.rb

@@ -0,0 +1,28 @@
+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
+
+  bean_operation   :push_message, :string, 'Push message onto message list', [
+      [ :message, :string, 'A string argument' ]
+  ]
+
+  def initialize
+    @messages = ['Here', 'are', 'some messages']
+    @max_messages = 5
+  end
+
+  def push_message(message)
+    @messages.push(message)
+    @messages.shift while @messages.size > @max_messages
+    return message
+  end
+
+  def bean_attributes_changed
+    @messages.shift while @messages.size > @max_messages
+  end
+end
+

data/examples/simple/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/simple/config.ru

@@ -0,0 +1,11 @@
+# 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'
+
+my_folder = Rumx::Beans::Folder.new
+Rumx::Bean.root.bean_add_child(:MyFolder, my_folder)
+my_folder.bean_add_child(:MyBean, MyBean.new)
+run Rumx::Server

data/examples/simple/my_bean.rb

@@ -0,0 +1,36 @@
+require 'rumx'
+
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_reader   :greeting,           :string,  'My greeting'
+  bean_reader        :goodbye,            :string,  'My goodbye'
+  bean_attr_accessor :my_accessor,        :integer, 'My integer accessor'
+  bean_attr_writer   :my_writer,          :float,   'My float writer'
+  bean_reader        :readable_my_writer, :float,   'My secret access to the write-only attribute my_writer'
+
+  bean_operation     :my_operation,       :string,  'My operation', [
+      [ :arg_int,    :integer, 'An int argument'   ],
+      [ :arg_float,  :float,   'A float argument'  ],
+      [ :arg_string, :string,  'A string argument' ]
+  ]
+
+  def initialize
+    @greeting    = 'Hello, Rumx'
+    @my_accessor = 4
+    @my_writer   = 10.78
+  end
+
+  def goodbye
+    'Goodbye, Rumx (hic)'
+  end
+
+  def readable_my_writer
+    @my_writer
+  end
+
+  def my_operation(arg_int, arg_float, arg_string)
+    "arg_int class=#{arg_int.class} value=#{arg_int} arg_float class=#{arg_float.class} value=#{arg_float} arg_string class=#{arg_string.class} value=#{arg_string}"
+  end
+end
+

data/examples/timer/README

@@ -0,0 +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.
+   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/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/my_bean.rb

@@ -0,0 +1,28 @@
+class MyBean
+  include Rumx::Bean
+
+  bean_attr_accessor :sleep_time,      :float,   'Amount of time 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::Timer.new(:max_errors => 5)
+
+    Thread.new do
+      while true
+        begin
+          @timer.measure do
+            if rand(100) < @percent_failure
+              raise "Failure occurred with sleep_time=#{@sleep_time} and percent failure=#{@percent_failure}"
+            end
+            sleep @sleep_time
+          end
+        rescue Exception => e
+          # Error handling...
+        end
+      end
+    end
+  end
+end

data/lib/rumx/argument.rb

@@ -0,0 +1,11 @@
+module Rumx
+  class Argument
+    attr_reader :name, :type, :description
+
+    def initialize(name, type_name, description)
+      @name        = name.to_sym
+      @type        = Type.find(type_name)
+      @description = description
+    end
+  end
+end

data/lib/rumx/attribute.rb

@@ -0,0 +1,38 @@
+module Rumx
+  class Attribute
+    attr_reader :name, :type, :description, :allow_read, :allow_write
+
+    def initialize(name, type_name, description, allow_read, allow_write, options)
+      @name        = name.to_sym
+      @type        = Type.find(type_name)
+      @description = description
+      @allow_read  = allow_read
+      @allow_write = allow_write
+      @options     = options
+    end
+
+    def get_value(bean)
+      return nil unless @allow_read
+      bean.send(self.name)
+    end
+
+    def set_value(bean, value)
+      raise 'Illegal set_value' unless @allow_write
+      bean.send(self.name.to_s+'=', type.string_to_value(value))
+    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)
+    end
+
+    def [](key)
+      @options[key]
+    end
+  end
+end