tdl-client-ruby 0.3.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59d9974ca954b39851624b6674af2037ecf42355
-  data.tar.gz: 27ecf0f6a162bfe79f3e9104168dcd32119bf6a7
+  metadata.gz: 5f26c749800235135540aa9dbd89683d51c7acc2
+  data.tar.gz: 50a2516af1455cfca7428985e3f187ec281d33c4
 SHA512:
-  metadata.gz: 70674f14ac8d674e56e1d6adea36e997f7969c7ee575992aea410d862e254c9486420f3f92b5236890544e67abaa506cbe2a6fca988064e257e17318e1ef67e8
-  data.tar.gz: 83c19dfb37355b6caf246c74c165ce868562c8ca7c1451d5aaf48050e7cfc582c7757ff38399b85aecd08c2e9f844639124ad60fb0d8a5699441bb4765b9e883
+  metadata.gz: c65df7f640fcb09cd9aa9ff8e5dc79febc92d1d8a706c73b5ecf58b487aa7f22eb163a7cc35cb73bd85a11deb4b093cd600516a3e15ea5a0538212225303822f
+  data.tar.gz: ff0f24af5b8a58132d6e142f4c3b11c7033fbbd5b6560cd3b2a69566262f0aa7cbca9a227259f8a1bec53a2766d80aec00d53558529813c4781fad82b301d291

data/examples/add_numbers.rb

@@ -5,10 +5,27 @@ Logging.logger.root.appenders = Logging.appenders.stdout
 Logging.logger.root.level = :info
 
 
-client = TDL::Client.new('localhost', 21613, 'test')
+def run_client
+  client = TDL::Client.new('localhost', 61613, 'julian')
+  include TDL::ClientActions
+  rules = TDL::ProcessingRules.new
+  rules.on('display_description').call(method(:display)).then(publish)
+  rules.on('display_required_methods').call(method(:display)).then(publish)
+  rules.on('increment').call(method(:increment)).then(publish_and_stop)
 
-client.go_live_with { |params|
-  x = params[0].to_i
-  y = params[1].to_i
-  x + y
-}
+  # puts processing_rules.to_yaml
+
+  client.go_live_with(rules)
+end
+
+def display(str)
+  puts str
+  'OK'
+end
+
+def increment(x)
+  x + 1
+end
+
+
+run_client

data/lib/tdl/abstractions/processing_rule.rb

@@ -0,0 +1,10 @@
+module TDL
+  class ProcessingRule
+    attr_reader :user_implementation, :client_action
+
+    def initialize(user_implementation, client_action)
+      @user_implementation = user_implementation
+      @client_action = client_action
+    end
+  end
+end

data/lib/tdl/abstractions/processing_rules.rb

@@ -0,0 +1,52 @@
+require 'tdl/abstractions/processing_rule'
+require 'tdl/actions/client_actions'
+
+module TDL
+  class ProcessingRules
+
+    def initialize
+      @rules = Hash.new
+    end
+
+    # ~~~~ Builders
+
+    def add(method_name, user_implementation, client_action)
+      @rules[method_name] = ProcessingRule.new(user_implementation, client_action)
+    end
+
+    def on(method_name)
+      ProcessingRuleBuilder.new(self, method_name)
+    end
+
+
+    class ProcessingRuleBuilder
+
+      def initialize(instance, method_name)
+        @instance = instance
+        @method_name = method_name
+      end
+
+      def call(user_implementation)
+        @user_implementation = user_implementation
+        self
+      end
+
+      def then(client_action)
+        @instance.add(@method_name, @user_implementation, client_action)
+      end
+    end
+
+
+
+    # ~~~~ Accessors
+
+    def get_rule_for(request)
+      if @rules.has_key?(request.method)
+        @rules[request.method]
+      else
+        raise NameError.new("Method #{request.method} did not match any processing rule.")
+      end
+    end
+
+  end
+end

data/lib/tdl/abstractions/request.rb

@@ -1,10 +1,16 @@
 module TDL
   class Request
-    attr_reader :id, :params
+    attr_reader :original_message, :id, :method, :params
 
-    def initialize(id, params)
-      @id = id
-      @params = params
+    def initialize(original_message, request_data)
+      @original_message = original_message
+      @id = request_data['id']
+      @method = request_data['method']
+      @params = request_data['params']
+    end
+
+    def audit_text
+      "id = #{@id}, req = #{@method}(#{@params.join(', ')})"
     end
   end
 end

data/lib/tdl/abstractions/response.rb

@@ -2,8 +2,8 @@ module TDL
   class Response
     attr_reader :result, :id
 
-    def initialize(request, result)
-      @id = request.id
+    def initialize(id, result)
+      @id = id
       @result = result
     end
 
@@ -14,5 +14,9 @@ module TDL
         :id => @id,
       }
     end
+
+    def audit_text
+      "resp = #{@result}"
+    end
   end
 end

data/lib/tdl/actions/client_actions.rb

@@ -0,0 +1,20 @@
+require 'tdl/actions/publish_action'
+require 'tdl/actions/stop_action'
+require 'tdl/actions/publish_and_stop_action'
+
+module TDL
+  module ClientActions
+
+    def publish
+      PublishAction.new
+    end
+
+    def stop
+      StopAction.new
+    end
+
+    def publish_and_stop
+      PublishAndStopAction.new
+    end
+  end
+end

data/lib/tdl/actions/publish_action.rb

@@ -0,0 +1,17 @@
+module TDL
+  class PublishAction
+
+    def audit_text
+      ''
+    end
+
+    def after_response(remote_broker, request, response)
+      remote_broker.respond_to(request, response)
+    end
+
+    def prepare_for_next_request(remote_broker)
+    #   DO nothing
+    end
+
+  end
+end

data/lib/tdl/actions/publish_and_stop_action.rb

@@ -0,0 +1,16 @@
+module TDL
+  class PublishAndStopAction
+
+    def audit_text
+      ''
+    end
+
+    def after_response(remote_broker, request, response)
+      remote_broker.respond_to(request, response)
+    end
+
+    def prepare_for_next_request(remote_broker)
+      remote_broker.close
+    end
+  end
+end

data/lib/tdl/actions/stop_action.rb

@@ -0,0 +1,17 @@
+module TDL
+  class StopAction
+
+    def audit_text
+      '(NOT PUBLISHED)'
+    end
+
+    def after_response(remote_broker, request, response)
+      # do nothing
+    end
+
+    def prepare_for_next_request(remote_broker)
+      remote_broker.close
+    end
+
+  end
+end

data/lib/tdl/client.rb

@@ -2,7 +2,10 @@ require 'stomp'
 require 'logging'
 
 require 'tdl/transport/remote_broker'
-require 'tdl/deserialize_and_respond_to_message'
+require 'tdl/abstractions/processing_rules'
+require 'tdl/actions/stop_action'
+
+require 'tdl/serialization/json_rpc_serialization_provider'
 
 module TDL
 
@@ -15,19 +18,11 @@ module TDL
       @logger = Logging.logger[self]
     end
 
-    def go_live_with(user_implementation)
-      run(RespondToAllRequests.new(DeserializeAndRespondToMessage.using(user_implementation)))
-    end
-
-    def trial_run_with(user_implementation)
-      run(PeekAtFirstRequest.new(DeserializeAndRespondToMessage.using(user_implementation)))
-    end
-
-    def run(handling_strategy)
+    def go_live_with(processing_rules)
       begin
         @logger.info 'Starting client.'
         remote_broker = RemoteBroker.new(@hostname, @port, @username)
-        remote_broker.subscribe(handling_strategy)
+        remote_broker.subscribe(ApplyProcessingRules.new(processing_rules))
 
         #DEBT: We should have no timeout here. We could put a special message in the queue
         remote_broker.join(3)
@@ -35,37 +30,81 @@ module TDL
         remote_broker.close
       rescue Exception => e
         @logger.error "Problem communicating with the broker. #{e.message}"
-        raise $! if ENV["RUBY_ENV"] == "test"
+        raise $! if ENV['RUBY_ENV'] == 'test'
       end
     end
 
+
     #~~~~ Queue handling policies
 
-    class RespondToAllRequests
-      def initialize(message_handler)
-        @message_handler = message_handler
+    class ApplyProcessingRules
+
+      def initialize(processing_rules)
+        @processing_rules = processing_rules
+        @logger = Logging.logger[self]
+        @audit = AuditStream.new
       end
 
-      def process_next_message_from(remote_broker, msg)
-        response = @message_handler.respond_to(msg.body)
-        if response.nil?
-          remote_broker.close
-        else
-          remote_broker.publish(response)
-          remote_broker.acknowledge(msg)
+      def process_next_request_from(remote_broker, request)
+        @audit.start_line
+        @audit.log(request)
+
+        # Obtain response from user
+        processing_rule = @processing_rules.get_rule_for(request)
+        response = get_response_for(processing_rule, request)
+        @audit.log(response ? response : Response.new('','empty'))
+
+        # Obtain action
+        client_action = response ? processing_rule.client_action : StopAction.new
+
+        # Act
+        client_action.after_response(remote_broker, request, response)
+        @audit.log(client_action)
+        @audit.end_line
+        client_action.prepare_for_next_request(remote_broker)
+      end
+
+      def get_response_for(processing_rule, request)
+        begin
+          user_implementation = processing_rule.user_implementation
+          result = user_implementation.call(*request.params)
+
+          response = Response.new(request.id, result)
+        rescue Exception => e
+          response = nil
+          @logger.info "The user implementation has thrown exception. #{e.message}"
         end
+        response
       end
+
     end
+  end
 
-    class PeekAtFirstRequest
-      def initialize(message_handler)
-        @message_handler = message_handler
-      end
 
-      def process_next_message_from(remote_broker, msg)
-        @message_handler.respond_to(msg.body)
-        remote_broker.close
+  # ~~~~ Utils
+
+  class AuditStream
+
+    def initialize
+      @logger = Logging.logger[self]
+      start_line
+    end
+
+    def start_line
+      @str = ''
+    end
+
+    def log(auditable)
+      text = auditable.audit_text
+      if not text.empty? and @str.length > 0
+        @str << ', '
       end
+
+      @str << text
+    end
+
+    def end_line
+      @logger.info @str
     end
 
   end

data/lib/tdl/serialization/json_rpc_serialization_provider.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'tdl/abstractions/request'
 require 'tdl/abstractions/response'
 
@@ -7,11 +8,9 @@ module TDL
       @logger = Logging.logger[self]
     end
 
-    def deserialize(message_text)
-      json = JSON.parse(message_text)
-
-      OpenStruct.new(json)
-      # DEBT means there is no Request object needed
+    def deserialize(msg)
+      request_data = JSON.parse(msg.body)
+      Request.new(msg, request_data)
     end
 
     def serialize(response)

data/lib/tdl/transport/remote_broker.rb

@@ -3,17 +3,20 @@ module TDL
     def initialize(hostname, port, username)
       @stomp_client = Stomp::Client.new('', '', hostname, port)
       @username = username
+      @serialization_provider = JSONRPCSerializationProvider.new
     end
 
-
     def subscribe(handling_strategy)
       @stomp_client.subscribe("/queue/#{@username}.req", {:ack => 'client', 'activemq.prefetchSize' => 1}) do |msg|
-        handling_strategy.process_next_message_from(self, msg)
+        request = @serialization_provider.deserialize(msg)
+        handling_strategy.process_next_request_from(self, request)
       end
     end
 
-    def acknowledge(msg)
-      @stomp_client.acknowledge(msg)
+    def respond_to(request, response)
+      serialized_response = @serialization_provider.serialize(response)
+      @stomp_client.publish("/queue/#{@username}.resp", serialized_response)
+      @stomp_client.acknowledge(request.original_message)
     end
 
     def publish(response)

data/lib/tdl/version.rb

@@ -1,5 +1,5 @@
 module TDL
-  PREVIOUS_VERSION = '0.3.5'
+  PREVIOUS_VERSION = '0.3.6'
   # the current MAJOR.MINOR version is dynamically computed from the version of the Spec
-  CURRENT_PATCH_VERSION = '6'
+  CURRENT_PATCH_VERSION = '7'
 end

data/tdl-client-ruby.iml

@@ -40,7 +40,6 @@
     <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.11.2, rbenv: 2.2.2) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="multi_test (v0.1.2, rbenv: 2.2.2) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.10.3, rbenv: 2.2.2) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v10.4.2, rbenv: 2.2.2) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rest-client (v1.8.0, rbenv: 2.2.2) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.7.5, rbenv: 2.2.2) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.10.0, rbenv: 2.2.2) [gem]" level="application" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdl-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Julian Ghionoiu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stomp
@@ -198,13 +198,15 @@ files:
 - Rakefile
 - examples/add_numbers.rb
 - lib/tdl.rb
+- lib/tdl/abstractions/processing_rule.rb
+- lib/tdl/abstractions/processing_rules.rb
 - lib/tdl/abstractions/request.rb
 - lib/tdl/abstractions/response.rb
+- lib/tdl/actions/client_actions.rb
+- lib/tdl/actions/publish_action.rb
+- lib/tdl/actions/publish_and_stop_action.rb
+- lib/tdl/actions/stop_action.rb
 - lib/tdl/client.rb
-- lib/tdl/deserialize_and_respond_to_message.rb
-- lib/tdl/respond/audit_traffic.rb
-- lib/tdl/respond/obtain_response.rb
-- lib/tdl/respond/validate_response.rb
 - lib/tdl/serialization/json_rpc_serialization_provider.rb
 - lib/tdl/transport/remote_broker.rb
 - lib/tdl/version.rb

data/lib/tdl/deserialize_and_respond_to_message.rb

@@ -1,24 +0,0 @@
-require 'tdl/serialization/json_rpc_serialization_provider'
-require 'tdl/respond/validate_response'
-require 'tdl/respond/audit_traffic'
-require 'tdl/respond/obtain_response'
-
-module TDL
-  class DeserializeAndRespondToMessage
-    def initialize(user_implementation)
-      @serialization_provider = JSONRPCSerializationProvider.new
-      @response_strategy = ValidateResponse.new(AuditTraffic.new(ObtainResponse.new(user_implementation)))
-      @logger = Logging.logger[self]
-    end
-
-    def self.using(user_implementation)
-      DeserializeAndRespondToMessage.new(user_implementation)
-    end
-
-    def respond_to(message_text)
-      request = @serialization_provider.deserialize(message_text)
-      response = @response_strategy.respond_to(request)
-      @serialization_provider.serialize(response)
-    end
-  end
-end

data/lib/tdl/respond/audit_traffic.rb

@@ -1,20 +0,0 @@
-require 'tdl/abstractions/request'
-require 'tdl/abstractions/response'
-
-module TDL
-  class AuditTraffic
-    def initialize(wrapped_strategy)
-      @wrapped_strategy = wrapped_strategy
-      @logger = Logging.logger[self]
-    end
-
-    def respond_to(request)
-      response = @wrapped_strategy.respond_to(request)
-
-      @logger.info "id = #{request.id}, req = #{request.to_h[:method]}(#{request.params.join(", ")}), resp = #{response.result}"
-      # DEBT method method taken on ostruct
-
-      response
-    end
-  end
-end

data/lib/tdl/respond/obtain_response.rb

@@ -1,33 +0,0 @@
-require 'tdl/abstractions/request'
-require 'tdl/abstractions/response'
-
-module TDL
-  class ObtainResponse
-    def initialize(user_implementation)
-      @user_implementation = user_implementation
-      @logger = Logging.logger[self]
-    end
-
-    def respond_to(request)
-      begin
-        # DEBT method is a default method on objects
-        # o = OpenStruct.new({method: 5})
-        # o.method !! Error
-
-        # DEBT object is treated and a collection of anonymous methods and not a normal object this is not ideomatic ruby
-
-        result = @user_implementation.send(request.to_h[:method], *request.params)
-      rescue Exception => e
-        @logger.info "The user implementation has thrown exception. #{e.message}"
-        result = nil
-        raise $! if ENV["RUBY_ENV"] == "test"
-      end
-
-      if result.nil?
-        @logger.info 'User implementation has returned "nil"'
-      end
-
-      Response.new(request, result)
-    end
-  end
-end

data/lib/tdl/respond/validate_response.rb

@@ -1,17 +0,0 @@
-require 'tdl/abstractions/request'
-require 'tdl/abstractions/response'
-
-module TDL
-  class ValidateResponse
-    def initialize(wrapped_strategy)
-      @wrapped_strategy = wrapped_strategy
-      @logger = Logging.logger[self]
-    end
-
-    def respond_to(request)
-      response = @wrapped_strategy.respond_to(request)
-      (response.result == nil) ? nil : response
-      # DEBT should pass nil response to top level
-    end
-  end
-end