rhcp 0.1.6 → 0.1.7

data/bin/http_test_server.rb

@@ -0,0 +1,70 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'rhcp'
+
+require 'net/http'
+require 'logger'
+
+$logger = Logger.new($stdout)
+
+broker = RHCP::Broker.new()
+broker.register_command(RHCP::Command.new("test", "just a test command", lambda { |req,res| "testing" }))
+broker.register_command(
+  RHCP::Command.new("reverse", "reversing input strings", 
+    lambda { |req,res| req.get_param_value("input").reverse }
+  ).add_param(RHCP::CommandParam.new("input", "the string to reverse", { 
+        :lookup_method => lambda { [ "zaphod", "beeblebrox" ] } 
+    }))
+)
+broker.register_command RHCP::Command.new("cook", "cook something nice out of some ingredients", 
+  lambda { |req,res| 
+    ingredients = req.get_param_value("ingredient").join(" ")
+    puts "cooking something with #{ingredients}"
+    ingredients
+  }
+  ).add_param(RHCP::CommandParam.new("ingredient", "something to cook with", 
+      { 
+        :lookup_method => lambda { [ "mascarpone", "chocolate", "eggs", "butter", "marzipan" ] },
+        :allows_multiple_values => true,
+        :mandatory => true
+      }
+  )
+)
+command = RHCP::Command.new("list_stuff", "this command lists stuff", 
+  lambda { |req,res|
+    [ "peace", "aquaeduct", "education" ]
+  }
+)
+command.mark_as_read_only()
+command.result_hints[:display_type] = "list"
+broker.register_command command
+
+command = RHCP::Command.new("build_table", "this command returns tabular data", 
+  lambda { |req,res|
+    [ 
+      { :the_first_name => "Zaphod", :last_name => "Beeblebrox", :heads => 2, :character => "dangerous" },
+      { :the_first_name => "Arthur", :last_name => "Dent", :heads => 1, :character => "harmless (mostly)" },
+      { :the_first_name => "Prostetnik", :last_name => "Yoltz (?)", :heads => 1, :character => "ugly" }
+    ]
+  }
+)
+command.mark_as_read_only()
+command.result_hints[:display_type] = "table"
+command.result_hints[:overview_columns] = [ "the_first_name", "last_name" ]
+command.result_hints[:column_titles] = [ "First Name", "Last Name" ]
+broker.register_command command
+
+exporter = RHCP::HttpExporter.new(broker, :port => 42000)
+
+trap("INT") {
+  exporter.stop
+  Kernel.exit 0
+}
+
+$logger.info "launching http exporter..."
+exporter.start()
+while (true) do
+  sleep 30
+  puts "."
+end
+$logger.info "exiting"

data/lib/rhcp.rb

@@ -21,7 +21,7 @@ module RHCP #:nodoc:
     
     MAJOR = 0
     MINOR = 1
-    TINY  = 6
+    TINY  = 7
 
     def Version.to_s
       [ MAJOR, MINOR, TINY ].join(".")

data/lib/rhcp/broker.rb

@@ -5,12 +5,12 @@ module RHCP
   # all code that wants to export/publish these commands  
   class Broker
     
+    attr_reader :name
     
-    # TODO add a getName() thingy?
-    
-    def initialize
+    def initialize(name = "")
       # command_name => command
       @known_commands = Hash.new()
+      @name = name
     end  
 
     # returns a list of all known commands

data/lib/rhcp/client/http_broker.rb

@@ -12,8 +12,7 @@ module RHCP
       # This is an implementation of a RHCP broker that retrieves it's data via
       # http from a remote broker. Since it implements the same interface as RHCP::Broker,
       # clients can use it exactly as if they were talking with the broker itself.
-      # TODO shouldn't this descend from Broker?
-      class HttpBroker
+      class HttpBroker < Broker
 
         def initialize(url)
           # TODO should this really be an URL? or just a host name?

data/lib/rhcp/http_exporter.rb

@@ -61,6 +61,7 @@ module RHCP
       }
       # TODO this path should probably be quite relative
       @server.mount "/#{@url_prefix}/info", HTTPServlet::FileHandler, "docroot"
+      @server.mount "/#{@url_prefix}/info2", HTTPServlet::FileHandler, "qooxdoo_rhcp/build"
       @server.mount "/#{@url_prefix}/get_commands", GetCommandsServlet, @broker
       @server.mount "/#{@url_prefix}/get_lookup_values", GetLookupValuesServlet, @broker
       @server.mount "/#{@url_prefix}/execute", ExecuteServlet, @broker

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rhcp
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Philipp Traeder
@@ -9,88 +9,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 +01:00
+date: 2009-02-20 00:00:00 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.8.2
-    version: 
-description: The rhcp protocol allows you to register commands along with their parameter descriptions and some metadata that can then be executed by rhcp clients.
-email: 
-- philipp@hitchhackers.net
+dependencies: []
+
+description: 
+email: philipp at hitchhackers.net
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+extra_rdoc_files: []
+
 files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- build_gem.sh
-- docroot/builder.js
-- docroot/controls.js
-- docroot/dragdrop.js
-- docroot/effects.js
-- docroot/index.html
-- docroot/prototype.js
-- docroot/scriptaculous.js
-- docroot/slider.js
-- docroot/sound.js
-- docroot/unittest.js
-- lib/rhcp.rb
-- lib/rhcp/broker.rb
+- bin/http_test_server.rb
+- bin/rhcp_test_server.sh
+- lib/rhcp
+- lib/rhcp/client
+- lib/rhcp/client/http_broker.rb
 - lib/rhcp/client/command_param_stub.rb
 - lib/rhcp/client/command_stub.rb
-- lib/rhcp/client/http_broker.rb
 - lib/rhcp/command.rb
 - lib/rhcp/command_param.rb
+- lib/rhcp/response.rb
 - lib/rhcp/dispatching_broker.rb
+- lib/rhcp/broker.rb
 - lib/rhcp/http_exporter.rb
 - lib/rhcp/request.rb
-- lib/rhcp/response.rb
 - lib/rhcp/rhcp_exception.rb
-- rhcp_test_server.sh
-- test/rhcp/broker_test.rb
+- lib/rhcp.rb
+- test/rhcp
+- test/rhcp/client
 - test/rhcp/client/command_param_stub_test.rb
 - test/rhcp/client/command_stub_test.rb
 - test/rhcp/command_param_test.rb
 - test/rhcp/command_test.rb
+- test/rhcp/response_test.rb
 - test/rhcp/dispatching_broker_test.rb
+- test/rhcp/broker_test.rb
+- test/rhcp/http_test_server.rb
 - test/rhcp/http_exporter_test.rb
 - test/rhcp/http_registry_test.rb
-- test/rhcp/http_test_server.rb
 - test/rhcp/request_test.rb
-- test/rhcp/response_test.rb
 has_rdoc: true
-homepage: http://hitchhackers.net/projects/rhcp
-post_install_message: |-
-  This is the initial release of rhcp - hope you'll like it.
-  Feel free to send me feedback to rhcp at hitchhackers dot net.
-rdoc_options: 
-- --main
-- README.txt
+homepage: http://rubyforge.org/projects/rhcp
+post_install_message: 
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -111,6 +76,6 @@ rubyforge_project: rhcp
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: The rhcp protocol allows you to register commands along with their parameter descriptions and some metadata that can then be executed by rhcp clients.
+summary: RHCP is a protocol designed for building up a command-metadata-based communication infrastructure making it easier for application developers to export commands in applications to generic clients.
 test_files: []
 

data/History.txt

@@ -1,6 +0,0 @@
-=== 1.0.0 / 2009-01-23
-
-* 1 major enhancement
-
-  * Birthday!
-

data/Manifest.txt

@@ -1,39 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-build_gem.sh
-docroot/builder.js
-docroot/controls.js
-docroot/dragdrop.js
-docroot/effects.js
-docroot/index.html
-docroot/prototype.js
-docroot/scriptaculous.js
-docroot/slider.js
-docroot/sound.js
-docroot/unittest.js
-lib/rhcp.rb
-lib/rhcp/broker.rb
-lib/rhcp/client/command_param_stub.rb
-lib/rhcp/client/command_stub.rb
-lib/rhcp/client/http_broker.rb
-lib/rhcp/command.rb
-lib/rhcp/command_param.rb
-lib/rhcp/dispatching_broker.rb
-lib/rhcp/http_exporter.rb
-lib/rhcp/request.rb
-lib/rhcp/response.rb
-lib/rhcp/rhcp_exception.rb
-rhcp_test_server.sh
-test/rhcp/broker_test.rb
-test/rhcp/client/command_param_stub_test.rb
-test/rhcp/client/command_stub_test.rb
-test/rhcp/command_param_test.rb
-test/rhcp/command_test.rb
-test/rhcp/dispatching_broker_test.rb
-test/rhcp/http_exporter_test.rb
-test/rhcp/http_registry_test.rb
-test/rhcp/http_test_server.rb
-test/rhcp/request_test.rb
-test/rhcp/response_test.rb

data/README.txt

@@ -1,46 +0,0 @@
-= RHCP
-
-http://hitchhackers.net/projects/rhcp
-
-== DESCRIPTION:
-
-The rhcp protocol allows you to register commands along with their parameter descriptions and some metadata that can then be executed by rhcp clients.
-
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-== INSTALL:
-
-* FIX (sudo gem install, anything else)
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 FIX
-
-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.

data/Rakefile

@@ -1,83 +0,0 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
-
-$LOAD_PATH.push('lib')
-require File.join(File.dirname(__FILE__), 'lib', 'rhcp')
-
-PKG_NAME      = 'rhcp'
-PKG_VERSION   = RHCP::Version.to_s
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-# TODO hoe should be a development dependency only
-
-desc "Default Task"
-task :default => [ :test ]
-
-###############################################
-### TESTS
-Rake::TestTask.new() { |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.libs << "test/rhcp"
-  t.test_files = FileList['test/rhcp/**/*_test.rb']
-  t.verbose = true
-}
-
-###############################################
-### RDOC
-Rake::RDocTask.new { |rdoc|
-  rdoc.rdoc_dir = 'doc'
-  rdoc.title    = "RHCP - really helpful command protocol"
-  rdoc.options << '--line-numbers' << '--inline-source' <<
-    '--accessor' << 'cattr_accessor=object'
-  rdoc.template = "#{ENV['template']}.rb" if ENV['template']
-  #rdoc.rdoc_files.include('README', 'CHANGELOG')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-}
-
-###############################################
-### METRICS
-task :lines do
-  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
-  for file_name in FileList["lib/**/*.rb"]
-    f = File.open(file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-    
-    total_lines     += lines
-    total_codelines += codelines
-    
-    lines, codelines = 0, 0
-  end
-
-  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
-end
-
-task :update_manifest do
-  system "rake check_manifest 2>/dev/null | grep -vE 'qooxdoo|nbproject|coverage' | grep -E '^\+' | grep -vE '^$' | grep -v '(in ' | grep -vE '^\+\+\+' | cut -b 2-200 | patch"
-end
-
-# TODO add rcov
-# rcov -I lib/ -x rcov.rb -x rhcp.rb test/**/*.rb
-
-require 'rubygems'
-require 'hoe'
-
-hoe = Hoe.new('rhcp', PKG_VERSION) do |p|
-  # p.rubyforge_name = 'rhcp' # if different than lowercase project name
-  p.developer('Philipp Traeder', 'philipp@hitchhackers.net')
-  p.extra_deps << 'json'
-  p.post_install_message = "This is the initial release of rhcp - hope you'll like it.\nFeel free to send me feedback to rhcp at hitchhackers dot net."
-end
-
-

data/build_gem.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-
-cd pkg
-
-echo "cleaning the build directory..."
-ls -l *.gem > /dev/null && rm -v *.gem
-echo ""
-
-echo "building the new gem..."
-rake gem
-echo ""
-
-echo "uninstalling the old gem if necessary..."
-gem list | grep -c rhcp > /dev/null && sudo gem uninstall rhcp
-echo ""
-
-echo "installing the new one..."
-sudo gem install --no-rdoc --no-ri *.gem
-echo ""
-
-cd -