rhcp 0.2.21 → 0.2.22

data/lib/rhcp.rb

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

data/lib/rhcp/client/context_aware_broker.rb

@@ -45,13 +45,19 @@ module RHCP
         response = @wrapped_broker.execute(new_request)
 
         # store context received with response
-        if response.context != nil
-          # TODO it would be nice if we could delete cookies as well
+        if response.context
           response.context.each do |key,value|
             @context.cookies[key] = value
             $logger.debug "storing value '#{value}' for key '#{key}' in context"
           end
         end
+        
+        if response.anti_context
+          response.anti_context.each do |key|
+            @context.cookies.delete(key)
+            $logger.info "deleted cookie '#{key}'"
+          end
+        end
 
         response
       end
@@ -67,6 +73,7 @@ module RHCP
 
       def get_lookup_values(request, param_name)
         request_with_context = give_the_request_some_context_rico(request)
+        request_with_context.context.cookies["phase"] = "lookup"
         @wrapped_broker.get_lookup_values(request_with_context, param_name)
       end
 

data/lib/rhcp/command.rb

@@ -188,7 +188,7 @@ module RHCP
       end
       
       begin
-        # TODO redirect the block's output (both Logger and STDOUT/STDERR) and send it back with the response
+        # TODO redirect the block's output (both Logger and STDOUT/STDERR) and send it back with the response?
         result = block.call(request, response)
         response.set_payload(result)
       rescue Exception => ex
@@ -219,12 +219,21 @@ module RHCP
         param_values["block"] = block
       end
 
+      param_values.merge! additional_params
+       
       # we need to carry along the context
-      the_broker = Thread.current['broker']
+      c = RHCP::Context.new()
       
-      param_values.merge! additional_params
+      the_broker = Thread.current['broker']      
+      the_broker.context.cookies.each do |k,v|
+        c.cookies[k] = v  
+      end
+      #c.cookies.merge! additional_params
 
-      request = RHCP::Request.new(self, param_values, the_broker.context)
+      request = RHCP::Request.new(self, param_values, c)
+      #puts ""
+      #puts "gonna execute #{request}"
+      #pp c.cookies
       response = the_broker.execute(request)
 
       if (response.status != RHCP::Response::Status::OK) then        
@@ -250,8 +259,8 @@ module RHCP
     end
     
     
-    # we do not serialize the block (no sense in this) nor the default param
-    # when the command is unmarshalled as stub, the default param will be set again
+    # we do not serialize the block nor the default param
+    # when the command is unmarshalled, the default param will be set again
     # automatically by add_param(), and the block will be replaced by the block
     # that does the remote invocation
     def to_json(*args)

data/lib/rhcp/encoding_helper.rb

@@ -0,0 +1,46 @@
+require 'base64'
+
+module RHCP
+  
+  module EncodingHelper
+    
+    def self.change_string_values(thing, &block)
+      result = nil
+      case thing.class.to_s
+      when "Array"
+        result = []
+        thing.each do |t|
+          result << change_string_values(t, &block)
+        end
+      when "Hash"
+        result = {}
+        thing.each do |k,v|
+          result[k] = change_string_values(v, &block)
+        end
+      #when "String","Fixnum","Boolean","TrueClass","FalseClass"
+      when "String"
+        result = block.call(thing.to_s)
+      when "Fixnum","TrueClass","FalseClass"
+        result = thing
+      when "Proc","NilClass","Binding"
+        # ignore
+      else
+        $logger.debug("don't know how to encode #{thing.class} - skipping")
+      end
+      result
+    end
+
+    def self.to_base64(thing)
+      change_string_values(thing) do |x|
+        Base64.encode64(x)
+      end
+    end
+    
+    def self.from_base64(thing)
+      change_string_values(thing) do |x|
+        Base64.decode64(x)
+      end
+    end
+    
+  end
+end

data/lib/rhcp/request.rb

@@ -1,6 +1,8 @@
 require 'rhcp/rhcp_exception'
 require 'rhcp/broker'
 
+require 'rhcp/encoding_helper'
+
 require 'rubygems'
 require 'json'
 
@@ -37,7 +39,7 @@ module RHCP
         end
         
         # fill params with default values
-        if ! param_values.has_key?(param.name) and param.default_value != nil
+        if ! param_values.has_key?(param.name) && param.default_value != nil
           if param.default_value.class == Proc
             param_values[param.name] = param.default_value.call(param_values)          
           else
@@ -66,7 +68,7 @@ module RHCP
       @param_values = param_values
 
       printable_param_values = param_values.map do |a,b|
-        a + '=' + b.join(',')
+        a.to_s + '=' + b.join(',')
       end.join('; ')
       @logger.debug("request initialized : command '#{command.name}', params : #{printable_param_values}")
     end
@@ -101,16 +103,24 @@ module RHCP
     def execute
       @command.execute_request(self)
     end
+    
+    def base64_param_values
+      result = {}
+      @param_values.each do |k,v|
+        result[k] = EncodingHelper.to_base64(v)
+      end
+      result
+    end
 
     def as_json(options={})
       {
         :command_name => @command.full_name,        
-        :param_values => @param_values,
+        :param_values => base64_param_values(),
         :context => @context.as_json(),
         :request_count => @request_count
       }
     end
-
+    
     def to_s
       s = @command.name + ' ('
       count = 0
@@ -126,4 +136,4 @@ module RHCP
 
   end
 
-end
+end

data/lib/rhcp/response.rb

@@ -1,6 +1,8 @@
 require 'rubygems'
 require 'json'
 
+require 'rhcp/encoding_helper'
+
 module RHCP
 
   class Response
@@ -15,8 +17,9 @@ module RHCP
     attr_accessor :error_text
     attr_accessor :error_detail
     attr_accessor :data
-    # TODO this should be called 'cookies'
+    # TODO this should be called 'cookies' maybe
     attr_accessor :context
+    attr_accessor :anti_context
     
     # textual description of the result (optional)
     attr_accessor :result_text
@@ -28,6 +31,7 @@ module RHCP
       @error_detail = ""
       @result_text = ""
       @context = nil
+      @anti_context = []
       @created_at = Time.now().to_i
     end
     
@@ -45,7 +49,12 @@ module RHCP
       @context = new_context
     end
     
+    def delete_cookie(key)
+      @anti_context << key
+    end
+    
     def as_json(options = {})
+      begin
       {
         :status => @status,
         :error_text => @error_text,
@@ -53,9 +62,15 @@ module RHCP
         :data => @data,   # TODO what about JSONinification of data? (probably data should be JSON-ish data only, i.e. no special objects)
         :result_text => @result_text,
         :context => @context,
+        :anti_context => @anti_context,
         :created_at => @created_at,
         :created_at_iso8601 => Time.at(@created_at).iso8601(),
       }
+      rescue => detail
+        $logger.warn("could not convert response to JSON : #{detail.message}\ncreated at: #{@created_at}")
+        puts @created_at.pretty_inspect 
+        raise
+      end
     end    
 
   end

metadata

@@ -1,112 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rhcp
-version: !ruby/object:Gem::Version 
-  hash: 61
+version: !ruby/object:Gem::Version
+  version: 0.2.22
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 21
-  version: 0.2.21
 platform: ruby
-authors: 
+authors:
 - Philipp T.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-03-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 0
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.0.0
   type: :runtime
-  version_requirements: *id001
-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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+description: really helpful command protocol
 email: philipp at virtualop dot org
-executables: 
+executables:
 - rhcp_test_server
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - bin/rhcp_test_server
-- lib/rhcp.rb
-- lib/rhcp/http_exporter.rb
-- lib/rhcp/request.rb
-- lib/rhcp/rhcp_exception.rb
-- lib/rhcp/logging_broker.rb
 - lib/rhcp/dispatching_broker.rb
-- lib/rhcp/command.rb
-- lib/rhcp/response.rb
-- lib/rhcp/client/http_broker.rb
+- lib/rhcp/context.rb
+- lib/rhcp/encoding_helper.rb
 - lib/rhcp/client/context_aware_broker.rb
 - lib/rhcp/client/command_stub.rb
 - lib/rhcp/client/command_param_stub.rb
-- lib/rhcp/broker.rb
+- lib/rhcp/client/http_broker.rb
+- lib/rhcp/response.rb
+- lib/rhcp/rhcp_exception.rb
+- lib/rhcp/command.rb
+- lib/rhcp/request.rb
 - lib/rhcp/command_param.rb
-- lib/rhcp/context.rb
-- test/rhcp/http_broker_test.rb
-- test/rhcp/request_test.rb
-- test/rhcp/broker_test.rb
+- lib/rhcp/broker.rb
+- lib/rhcp/logging_broker.rb
+- lib/rhcp/http_exporter.rb
+- lib/rhcp.rb
 - test/rhcp/tests_for_writable_brokers.rb
-- test/rhcp/context_test.rb
+- test/rhcp/logging_broker_test.rb
 - test/rhcp/http_test_server.rb
+- test/rhcp/context_test.rb
+- test/rhcp/request_test.rb
+- test/rhcp/broker_test.rb
+- test/rhcp/client/command_param_stub_test.rb
+- test/rhcp/client/command_stub_test.rb
+- test/rhcp/test_base.rb
+- test/rhcp/tests_for_brokers.rb
 - test/rhcp/dispatching_broker_test.rb
-- test/rhcp/command_param_test.rb
 - test/rhcp/command_test.rb
-- test/rhcp/tests_for_brokers.rb
-- test/rhcp/logging_broker_test.rb
+- test/rhcp/command_param_test.rb
 - test/rhcp/response_test.rb
-- test/rhcp/context_aware_broker_test.rb
-- test/rhcp/test_base.rb
-- test/rhcp/client/command_stub_test.rb
-- test/rhcp/client/command_param_stub_test.rb
 - test/rhcp/http_exporter_test.rb
+- test/rhcp/http_broker_test.rb
+- test/rhcp/context_aware_broker_test.rb
 homepage: http://rubyforge.org/projects/rhcp
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: command-based rpc library thing
+summary: needlessly complicated metadata-centric RPC implementation
 test_files: []
-