rhcp 0.1.3 → 0.1.4

data/test/rhcp/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/test/rhcp/request_test.rb

@@ -0,0 +1,124 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'rhcp'
+
+require 'rubygems'
+require 'json'
+
+class RequestTest < Test::Unit::TestCase
+
+  def test_construction
+    command = RHCP::Command.new("test", "a test", nil)
+    assert_raise(RHCP::RhcpException) { RHCP::Request.new(nil, Hash.new()) }
+    request = RHCP::Request.new(command, Hash.new())
+    assert_not_nil request
+  end
+  
+  def test_get_param_value
+    command = RHCP::Command.new("test", "a test", nil)
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param"))
+    command.add_param(RHCP::CommandParam.new("second_param", "this is the second param", { :allows_multiple_values => true }))
+    request = RHCP::Request.new(
+      command, 
+      { 
+        "first_param" => ["foo"],
+        "second_param" => ["foo", "bar", "baz"]
+      }
+    )
+    assert_not_nil request
+    assert_equal "foo", request.get_param_value("first_param")
+    assert_equal ["foo", "bar", "baz"], request.get_param_value("second_param")
+  end
+  
+  def test_has_param_value
+    command = RHCP::Command.new("test", "a test", nil)
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param"))
+    command.add_param(RHCP::CommandParam.new("second_param", "this is the second param", { :allows_multiple_values => true }))
+    request = RHCP::Request.new(
+      command, 
+      { 
+        "first_param" => ["foo"],
+        "second_param" => ["foo", "bar", "baz"]
+      }
+    )
+    assert request.has_param_value("first_param")
+    assert ! request.has_param_value("third_param")
+  end
+  
+  def test_invalid_param_name
+    command = RHCP::Command.new("test", "another test", lambda {})
+    command.add_param(RHCP::CommandParam.new("real_param", "this param does exist"))
+    assert_not_nil RHCP::Request.new(command, { "real_param" =>  [ "value for the real param" ] })
+    assert_raise(RHCP::RhcpException) { RHCP::Request.new(command, { 
+          "does_not_exist" =>  [ "single value for non-existing param" ]
+    }) }
+  end
+  
+  def test_invalid_param_values
+    command = RHCP::Command.new("test", "another test", lambda {})
+    command.add_param(RHCP::CommandParam.new("real_param", "this param does exist"))
+    assert_raise(RHCP::RhcpException) { RHCP::Request.new(command, { 
+          "real_param" =>  [ "value for the real param", "another value for the real param" ]
+    }) }
+  end
+  
+  def test_missing_mandatory_param
+    command = RHCP::Command.new("test", "another test", lambda {})
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param", { :mandatory => true }))
+    command.add_param(RHCP::CommandParam.new("second_param", "this param is optional", { :mandatory => false }))
+    
+    # test1 : we should not have to specify optional parameters
+    assert_not_nil RHCP::Request.new(command, { "first_param" => [ "bla" ]})
+    
+    # test2 : but we need to specify mandatory params
+    assert_raise(RHCP::RhcpException) { RHCP::Request.new(command, {})}
+  end
+  
+  def test_json
+    command = RHCP::Command.new("request_test", "a test", nil)
+    command.add_param(RHCP::CommandParam.new("first_param", "this is the first param"))
+    command.add_param(RHCP::CommandParam.new("second_param", "this is the second param", { :allows_multiple_values => true }))
+    broker = RHCP::Broker.new()
+    broker.register_command(command)
+    r= RHCP::Request.new(
+      command,
+      { 
+        "first_param" => ["foo"],
+        "second_param" => ["foo", "bar", "baz"]
+      }
+    )
+    json = r.to_json
+    puts "request as JSON : >>#{json}<<"
+    assert_not_nil json
+    r2 = RHCP::Request.reconstruct_from_json(broker, json)
+    assert_instance_of RHCP::Request, r2
+    assert_equal r.command, r2.command
+    assert_equal r.param_values, r2.param_values
+  end
+  
+  def test_execute
+    command = RHCP::Command.new("request_test", "a test", lambda { |req,res| "jehova" })    
+    r= RHCP::Request.new(
+      command
+    )
+    res = r.execute
+    assert_not_nil res
+    assert_equal "jehova", res.data
+  end
+  
+  def test_execute_with_params
+    command = RHCP::Command.new("request_test", "a test", lambda { |req,res| "***" + req.get_param_value("first_one") + "***" }
+    ).add_param(RHCP::CommandParam.new("first_one", "pole position"))
+    r= RHCP::Request.new(
+      command,
+      {
+        "first_one" => "lucky bastard"
+      }
+    )
+    res = r.execute()
+    assert_not_nil res
+    assert_equal "***lucky bastard***", res.data
+  end
+  
+end

data/test/rhcp/response_test.rb

@@ -0,0 +1,45 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'rhcp/response'
+
+class ResponseTest < Test::Unit::TestCase
+  
+  def test_simple
+    response = RHCP::Response.new()
+    assert_not_nil response
+    response.mark_as_error("something went wrong")
+    assert_equal "something went wrong", response.error_text
+    assert_equal "", response.error_detail    
+  end
+  
+  def test_payload
+    response = RHCP::Response.new()
+    assert_not_nil response
+    response.set_payload("some data")
+    assert_equal "some data", response.data
+  end
+  
+  def test_json
+    response = RHCP::Response.new()    
+    response.set_payload("some data")
+    response.mark_as_error("something went wrong", "things got really fucked up")
+    
+    json = response.to_json()
+    assert_not_nil json
+    r2 = RHCP::Response.reconstruct_from_json(json)
+    #r2 = JSON.parse(json)
+    assert_not_nil r2
+    assert_instance_of RHCP::Response, r2
+    assert_equal RHCP::Response::Status::ERROR, r2.status
+    assert_equal "something went wrong", r2.error_text
+    assert_equal "things got really fucked up", r2.error_detail
+    assert_equal "some data", r2.data
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rhcp
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Philipp T.
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 +01:00
+date: 2009-01-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +20,9 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.8.3
     version: 
-description: 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.
+description: FIX (describe your package)
 email: 
 - philipp@hitchhackers.net
 executables: []
@@ -38,8 +38,43 @@ files:
 - 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
+- start_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
 has_rdoc: true
-homepage: http://rhcp.rubyforge.org
+homepage: FIX (url)
 post_install_message: 
 rdoc_options: 
 - --main
@@ -64,6 +99,6 @@ rubyforge_project: rhcp
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-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.
+summary: FIX (describe your package)
 test_files: []