rhcp 0.2.18 → 0.2.19

data/lib/rhcp.rb

@@ -23,7 +23,7 @@ module RHCP #:nodoc:
     
     MAJOR = 0
     MINOR = 2
-    TINY  = 18
+    TINY  = 19
 
     def Version.to_s
       [ MAJOR, MINOR, TINY ].join(".")
@@ -40,7 +40,7 @@ module RHCP #:nodoc:
     def initialize()
       # TODO do we really want to log to STDOUT per default?
       # TODO check the whole package for correct usage of loggers
-      @logger = Logger.new("rhcp.log")
+      @logger = Logger.new(STDOUT)
     end
     
     

data/lib/rhcp/command.rb

@@ -34,6 +34,10 @@ module RHCP
 
     attr_reader :accepts_extra_params
     
+    attr_reader :ignores_extra_params
+    
+    attr_accessor :notifications
+    
     # an array of context keys that enable this command
     # 
     # if at least one of the listed keys is found in the context, the command
@@ -41,6 +45,8 @@ module RHCP
     # by default
     attr_accessor :enabled_through_context_keys
     
+    attr_accessor :available_if
+    
     # hints about how the result of this command might be displayed
     attr_accessor :result_hints
 
@@ -60,6 +66,11 @@ module RHCP
       @enabled_through_context_keys = nil
       
       @accepts_extra_params = false
+      @ignores_extra_params = false
+      
+      @notifications = false
+      
+      @available_if = nil
       
       # TODO formalize this! (we need rules how clients should react, otherwise this will be a mess)
       # TODO in some cases, the display_type could also be guessed from the response, I guess
@@ -70,7 +81,7 @@ module RHCP
       }
     end
 
-    def is_enabled?(context = RHCP::Context.new())
+    def is_enabled?(context = RHCP::Context.new(), param_values = nil)
       result = true
 
       if @enabled_through_context_keys != nil
@@ -84,6 +95,12 @@ module RHCP
         end
       end
 
+      if param_values != nil        
+        if @available_if != nil
+          result = @available_if.call(param_values)
+        end
+      end
+
       result
     end
 
@@ -116,6 +133,11 @@ module RHCP
       @accepts_extra_params = true
       self
     end
+    
+    def ignore_extra_params()
+      @ignores_extra_params = true
+      self
+    end
 
     # returns the specified CommandParam
     # or throws an RhcpException if the parameter does not exist
@@ -156,7 +178,7 @@ module RHCP
         end
       rescue Exception => ex
         if (/undefined\sparameter/.match(ex.message))
-          raise RHCP::RhcpException.new(ex.message) unless @accepts_extra_params 
+          raise RHCP::RhcpException.new(ex.message) unless @accepts_extra_params or @ignores_extra_params 
         end
       end
 

data/lib/rhcp/command_param.rb

@@ -26,6 +26,8 @@ module RHCP
     # the key to a context value that is used for filling this parameter
     attr_reader :autofill_context_key
     
+    attr_reader :allows_extra_values
+    
     attr_accessor :default_value
 
     # creates a new command parameter
@@ -35,7 +37,7 @@ module RHCP
     #   :lookup_method            a block that returns an array of lookup values valid for this param
     #   :is_default_param         true if this parameter is the default param for the enclosing command
     #   :default_value            a value to use as default (who would have thought?)
-    def initialize(name, description, options = Hash.new)
+    def initialize(name, description, options = {})
       @name = name
       @description = description
 
@@ -47,6 +49,7 @@ module RHCP
       @is_default_param = options[:is_default_param] || options[:default_param] || false
       @autofill_context_key = options[:autofill_context_key] || nil
       @default_value = options[:default_value] || nil
+      @allows_extra_values = options[:allows_extra_values] || false
     end
 
     # searches the context for a values that can be auto-filled
@@ -96,7 +99,8 @@ module RHCP
       # check against lookup values
       if @has_lookup_values
         possible_value.each do |value|
-          if ! get_lookup_values(request).include?(value)
+          if ! get_lookup_values(request).include?(value) and
+             ! @allows_extra_values
             raise RHCP::RhcpException.new("invalid value '#{value}' for parameter '#{@name}'")
           end
         end

data/lib/rhcp/context.rb

@@ -15,27 +15,23 @@ module RHCP
       @cookies = cookies
       @request_context_id = request_context_id
       @request_counter = 0
+    end
+    
+    def self.from_hash(h)
+      new(h["cookies"], h["request_context_id"])
     end       
     
-    # def to_json(*args)
-      # {
-        # 'cookies' => @cookies,
-      # }.to_json(*args)
-    # end  
-#     
-    # def self.reconstruct_from_json(json_data)
-      # $logger.debug "reconstructing context from json : >>#{json_data}<<"
-      # object = JSON.parse(json_data)
-      # instance = self.new()
-      # instance.cookies = object['cookies'] 
-#       
-      # instance
-    # end
-
     def incr_and_get_request_counter()
       @request_counter += 1
     end
     
+    def as_json(options={})
+      {
+        "cookies" => @cookies,
+        "request_context_id" => @request_context_id
+      }
+    end
+    
     def to_s
       result = "<Context with #{@cookies.size} cookies>"
       # @cookies.each do |k,v|

data/lib/rhcp/logging_broker.rb

@@ -31,10 +31,18 @@ module RHCP
       []
     end
     
+    def get_graylisted_commands
+      []
+    end
+    
     def graylist
       [ "on_machine", "list_machines" ]
     end
     
+    def blacklist
+      blacklist_defaults + get_blacklisted_commands
+    end
+    
     # TODO would be nice if this helper method would be accessible from inside vop plugins
     def var_name(name)
       self.class.to_s + "." + name
@@ -43,57 +51,55 @@ module RHCP
     def execute(request) 
       command = get_command(request.command.name, request.context)
       mode = command.is_read_only ? 'r/o' : 'r/w'
-  
-      is_new_request = Thread.current[var_name("request_id")] == nil
-      if is_new_request
-        Thread.current[var_name("request_id")] = request.param_values.has_key?('request_id') ?
-          request.param_values['request_id'].first :
-          Time.now().to_i.to_s + '_' + request.command.name
+
+      should_be_logged = (not blacklist.include?(command.name))
+
+      if should_be_logged
+        request_id = Thread.current[var_name("request_id")]
         
-        Thread.current[var_name("stack")] = []
-        Thread.current[var_name("id_stack")] = []
-      end
-      
-      Thread.current[var_name("stack")] << command.name
-      
-      level = Thread.current[var_name("stack")].size()
-      
-      blacklist = blacklist_defaults + get_blacklisted_commands
-      blacklisted = false
-      blacklist.each do |sheep|
-        if Thread.current[var_name("stack")].include?(sheep)
-          blacklisted = true
-          break
+        is_new_request = request_id == nil
+        
+        if is_new_request
+          if mode == 'r/o'
+            should_be_logged = false
+          else
+            new_request_id = if request.param_values.has_key?('request_id')
+              request.param_values['request_id'].first
+            elsif request.context.request_context_id != nil
+              request.context.request_context_id
+            else
+              Time.now().to_i.to_s + '_' + request.command.name
+            end
+              
+            Thread.current[var_name("request_id")] = new_request_id
+            
+            Thread.current[var_name("stack")] = []
+            Thread.current[var_name("id_stack")] = []
+          end
         end
-      end
-      if not blacklisted 
-        if request.context.cookies.has_key?('__loggingbroker.blacklisted_commands') then
-          blacklisted = request.context.cookies['__loggingbroker.blacklisted_commands'].split(',').include?(request.command.name)
+        
+        if should_be_logged
+          Thread.current[var_name("stack")] << command.name #unless graylist.include? command.name
+          
+          level = Thread.current[var_name("stack")].size()
+          
+          start_ts = Time.now()
+          log_request_start(Thread.current[var_name("request_id")], level, mode, stack_for_display, request, start_ts)
         end
       end
       
-      graylisted = graylist.include? command.name
-      
-      unless blacklisted or graylisted
-        #$logger.info ">> #{command.name} (#{mode}) : #{Thread.current[var_name("stack")].join(" -> ")}"
-        start_ts = Time.now()
-        log_request_start(Thread.current[var_name("request_id")], level, mode, stack_for_display, request, start_ts)
-      end
-      
       response = @wrapped_broker.execute(request)
       
-      
-      unless blacklisted or graylisted
+      if should_be_logged
         stop_ts = Time.now()
         duration = stop_ts.to_i - start_ts.to_i
         
         log_request_stop(Thread.current[var_name("request_id")], level, mode, stack_for_display, request, response, duration)
-      end
-      
-      Thread.current[var_name("stack")].pop
-      
-      if level == 1
-        Thread.current[var_name("request_id")] = nil
+        
+        Thread.current[var_name("stack")].pop
+        if level == 1
+          Thread.current[var_name("request_id")] = nil
+        end
       end
       
       response

data/lib/rhcp/request.rb

@@ -27,11 +27,10 @@ module RHCP
       @request_count = @context.incr_and_get_request_counter()
         
       command.params.each do |param|
-        
         value_from_context = param.find_value_in_context(context)
         if value_from_context != nil          
           # if the parameter has been specified in the param values, do not override
-          if ! param_values.has_key?(param.name)
+          unless param_values.has_key?(param.name)
             @logger.debug "pre-filling param #{param.name} with value '#{value_from_context}' (context key '#{param.autofill_context_key}')"
             param_values[param.name] = value_from_context
           end                    
@@ -45,9 +44,7 @@ module RHCP
             param_values[param.name] = param.default_value
           end
         end
-        
       end
-      
 
       # autobox the parameters if necessary
       param_values.each do |k,v|
@@ -88,40 +85,11 @@ module RHCP
       @command.execute_request(self)
     end
 
-    # reconstructs the request from it's JSON representation
-    # Since the JSON version of a request does hold the command name instead
-    # of the full command only, a broker is needed to lookup the command by
-    # it's name
-    #
-    # Params:
-    #   +broker+ is the broker to use for command lookup
-    #   +json_data+ is the JSON data that represents the request
-    # def self.reconstruct_from_json(broker, json_data)
-      # object = JSON.parse(json_data)
-#       
-      # context = object.has_key?('context') ?
-        # RHCP::Context.reconstruct_from_json(object['context']) :
-        # RHCP::Context.new(object['cookies'])
-#         
-      # command = broker.get_command(object['command_name'], context)      
-#         
-      # self.new(command, object['param_values'], context)
-    # end
-# 
-    # # returns a JSON representation of this request.
-    # def to_json(*args)
-      # {
-        # 'command_name' => @command.name,
-        # 'param_values' => @param_values,
-        # 'context' => @context.to_json
-      # }.to_json(*args)
-    # end
-    
     def as_json(options={})
       {
-        :command_name => @command.name,
+        :command_name => @command.full_name,        
         :param_values => @param_values,
-        :context => @context,
+        :context => @context.as_json(),
         :request_count => @request_count
       }
     end

metadata

@@ -1,22 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: rhcp
 version: !ruby/object:Gem::Version 
-  hash: 51
-  prerelease: false
+  hash: 49
+  prerelease: 
   segments: 
   - 0
   - 2
-  - 18
-  version: 0.2.18
+  - 19
+  version: 0.2.19
 platform: ruby
 authors: 
-- Philipp Traeder
+- Philipp T.
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-01-21 00:00:00 +01:00
-default_executable: 
+date: 2013-01-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -34,8 +33,8 @@ dependencies:
         version: 0.0.0
   type: :runtime
   version_requirements: *id001
-description: 
-email: philipp at hitchhackers.net
+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.
+email: philipp@virtualop.org
 executables: 
 - rhcp_test_server
 extensions: []
@@ -44,39 +43,38 @@ extra_rdoc_files: []
 
 files: 
 - bin/rhcp_test_server
-- lib/rhcp.rb
-- lib/rhcp/command_param.rb
 - lib/rhcp/response.rb
-- lib/rhcp/rhcp_exception.rb
 - lib/rhcp/logging_broker.rb
-- lib/rhcp/client/http_broker.rb
+- lib/rhcp/command_param.rb
+- lib/rhcp/rhcp_exception.rb
 - lib/rhcp/client/context_aware_broker.rb
-- lib/rhcp/client/command_stub.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/context.rb
+- lib/rhcp/request.rb
 - lib/rhcp/http_exporter.rb
 - lib/rhcp/dispatching_broker.rb
-- lib/rhcp/request.rb
 - lib/rhcp/broker.rb
-- lib/rhcp/context.rb
-- lib/rhcp/command.rb
-- test/rhcp/test_base.rb
-- test/rhcp/command_param_test.rb
-- test/rhcp/context_aware_broker_test.rb
-- test/rhcp/request_test.rb
-- test/rhcp/tests_for_brokers.rb
+- lib/rhcp.rb
+- test/rhcp/context_test.rb
 - test/rhcp/http_exporter_test.rb
+- test/rhcp/tests_for_brokers.rb
 - test/rhcp/logging_broker_test.rb
-- test/rhcp/http_test_server.rb
-- test/rhcp/dispatching_broker_test.rb
+- test/rhcp/command_test.rb
+- test/rhcp/response_test.rb
+- test/rhcp/context_aware_broker_test.rb
+- test/rhcp/test_base.rb
 - test/rhcp/broker_test.rb
+- test/rhcp/tests_for_writable_brokers.rb
 - test/rhcp/client/command_param_stub_test.rb
 - test/rhcp/client/command_stub_test.rb
+- test/rhcp/dispatching_broker_test.rb
+- test/rhcp/http_test_server.rb
+- test/rhcp/command_param_test.rb
+- test/rhcp/request_test.rb
 - test/rhcp/http_broker_test.rb
-- test/rhcp/response_test.rb
-- test/rhcp/tests_for_writable_brokers.rb
-- test/rhcp/context_test.rb
-- test/rhcp/command_test.rb
-has_rdoc: true
 homepage: http://rubyforge.org/projects/rhcp
 licenses: []
 
@@ -105,10 +103,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: rhcp
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-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: command-based rpc library thing
 test_files: []