tdl-client-ruby 0.22.1 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c010e01bbf54e96598f837d6dbad4d2522e8ece8c359a934e6d248fb73ac40da
-  data.tar.gz: ab556e467482c6a227d55e8425ed338bf2899856b114617f96e9c49cb53eebce
+  metadata.gz: eda7242d36229737d1741218dd19edd41df6ae474812d331db1988fa038c1196
+  data.tar.gz: df6675ee0971590ed474ede8bf2e5ec22c1669ced60da14bad725c792c4f4ff6
 SHA512:
-  metadata.gz: ec89c3029e6d36f119c390a83816762d3276f421622d3386c0358bd427583cd8f71fbc8ed9601133b6e38adf08387e0a903343d72c5d6cc25aaa3d39c8dd0a3c
-  data.tar.gz: bdf125e5e75c8ad5c6dd90fa38e1a42170931f8b72230c22ccda1c56e3d82a9228908781bc3a854edbf6c6ae72e26f9e8b04d234fd2c6ecce7655210581b51b9
+  metadata.gz: 05f39cfbb1c9613d7dc91d0a937c895a0b6429054d2ae24cb50c6785407954f74ab3e0afef7f0a51ea49ce3c84bd60618e5b64c3f49f17111eb62ce167fac082
+  data.tar.gz: 4f614415157a702d1a26c2654cd8b188978c1a71615e84550b16e8d0e33ee656c911352f4019048cd0fc11119487af972805d74a37a4c5099cb4883d40c8b541

data/README.md

@@ -5,22 +5,75 @@
 
 # tdl-client-ruby
 
+### Submodules
+
+Project contains submodules as mentioned in the `.gitmodules` file:
+
+- broker
+- tdl/client-spec (gets cloned into features/spec)
+- wiremock 
+
+Use the below command to update the submodules of the project:
+
 ```
-# Install RVM
+git submodule update --init
+```
+
+### Getting started
+
+Ruby client to connect to the central kata server.
+
+### Installing 
+
+#### Install RVM
+```bash
 curl -sSL https://get.rvm.io | bash -s stable
-echo 'source /Users/julianghionoiu/.rvm/scripts/rvm' >> .bash_profile
+echo "source $HOME/.rvm/scripts/rvm" >> .bash_profile
+```
 
-# Install ruby
+#### Install ruby
+```bash
 rvm install ruby-2.2.2
 rvm use ruby-2.2.2
+```
 
-# Install bundler
+#### Install bundler
+```bash
 gem install bundler
 ```
 
-# Installing
+#### Install coveralls
+```bash
+gem install coveralls
+```
+
+#### Install cucumber
+```bash
+gem install cucumber
+```
+
+#### Install all the gems in the project
+```bash
+bundle install
+```
+
+#### Manual 
+
+Stopping the wiremocks and broker services would be the same, using the `stop` command instead of the `start` command.
+
+#### Automatic (via script)
+
+Start and stop the wiremocks and broker services with the below:
+ 
+```bash
+./startExternalDependencies.sh
+``` 
 
-# Testing
+```bash
+./stopExternalDependencies.sh
+``` 
+
+### Testing
 
 All test require the ActiveMQ broker to be started.
 The following commands are available for the broker.
@@ -31,11 +84,17 @@ python wiremock/wiremock-wrapper.py start 41375
 python wiremock/wiremock-wrapper.py start 8222
 ```
 
+or 
+
+```bash
+./startExternalDependencies.sh
+``` 
+
 Run tests with `rake features`.
 To run a single scenario execute `cucumber path/to/file.feature:line_no`
 Recommendation is to use the cucumber command instead of rake always outside of CI.
 
-# Cleanup
+### Cleanup
 
 Stop external dependencies
 ```
@@ -44,10 +103,16 @@ python wiremock/wiremock-wrapper.py stop 41375
 python wiremock/wiremock-wrapper.py stop 8222
 ```
 
+or 
 
-# To release
+```bash
+./stopExternalDependencies.sh
+``` 
+
+
+## To release
 
 Run
 ```
 ./release.sh
-```
+```

data/lib/tdl/previous_version.rb

@@ -1,4 +1,4 @@
 module TDL
-  PREVIOUS_VERSION = '0.21.1'
+  PREVIOUS_VERSION = '0.22.1'
   # the current MAJOR.MINOR version is dynamically computed from the version of the Spec
 end

data/lib/tdl/queue/abstractions/processing_rule.rb

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

data/lib/tdl/queue/abstractions/response/fatal_error_response.rb

@@ -1,14 +1,8 @@
-require 'tdl/queue/actions/stop_action'
-
 module TDL
   class FatalErrorResponse
 
     def initialize(message)
-      @message = message
-    end
-
-    def client_action
-      StopAction.new
+      @message = message + ", (NOT PUBLISHED)"
     end
 
     def audit_text

data/lib/tdl/queue/abstractions/response/valid_response.rb

@@ -2,12 +2,11 @@ require 'tdl/util'
 
 module TDL
   class ValidResponse
-    attr_reader :id, :result, :client_action
+    attr_reader :id, :result
 
-    def initialize(id, result, client_action)
+    def initialize(id, result)
       @id = id
       @result = result
-      @client_action = client_action
     end
 
     def to_h

data/lib/tdl/queue/implementation_runner_config.rb

@@ -8,6 +8,8 @@ module TDL
             @port = 61613
             @time_to_wait_for_requests = 500
             @audit_stream = ConsoleAuditStream.new
+            @request_queue_name = ''
+            @response_queue_name = ''
         end
 
         def set_hostname(hostname)
@@ -20,8 +22,13 @@ module TDL
             self
         end
 
-        def set_unique_id(unique_id)
-            @unique_id = unique_id
+        def set_request_queue_name(queue_name)
+            @request_queue_name = queue_name
+            self
+        end
+
+        def set_response_queue_name(queue_name)
+            @response_queue_name = queue_name
             self
         end
 
@@ -43,8 +50,12 @@ module TDL
             @port
         end
 
-        def get_unique_id
-            @unique_id
+        def get_request_queue_name
+            @request_queue_name
+        end
+
+        def get_response_queue_name
+            @response_queue_name
         end
 
         def get_time_to_wait_for_requests

data/lib/tdl/queue/processing_rules.rb

@@ -1,7 +1,6 @@
 require 'tdl/queue/abstractions/processing_rule'
 require 'tdl/queue/abstractions/response/fatal_error_response'
 require 'tdl/queue/abstractions/response/valid_response'
-require 'tdl/queue/actions/client_actions'
 
 module TDL
   class ProcessingRules
@@ -13,8 +12,8 @@ module TDL
 
     # ~~~~ Builders
 
-    def add(method_name, user_implementation, client_action)
-      @rules[method_name] = ProcessingRule.new(user_implementation, client_action)
+    def add(method_name, user_implementation)
+      @rules[method_name] = ProcessingRule.new(user_implementation)
     end
 
     def on(method_name)
@@ -33,8 +32,8 @@ module TDL
         self
       end
 
-      def then(client_action)
-        @instance.add(@method_name, @user_implementation, client_action)
+      def build()
+        @instance.add(@method_name, @user_implementation)
       end
     end
 
@@ -54,7 +53,7 @@ module TDL
         user_implementation = processing_rule.user_implementation
         result = user_implementation.call(*request.params)
 
-        return ValidResponse.new(request.id, result, processing_rule.client_action)
+        return ValidResponse.new(request.id, result)
       rescue Exception => e
         message = '"user implementation raised exception"'
         @logger.warn("#{message}, #{e.message}")

data/lib/tdl/queue/queue_based_implementation_runner.rb

@@ -19,7 +19,8 @@ module TDL
                 remote_broker = RemoteBroker.new(
                     @config.get_hostname,
                     @config.get_port,
-                    @config.get_unique_id,
+                    @config.get_request_queue_name,
+                    @config.get_response_queue_name,
                     @config.get_time_to_wait_for_requests)
                 remote_broker.subscribe(ApplyProcessingRules.new(@deploy_processing_rules))
                 @logger.info 'Waiting for requests.'
@@ -59,17 +60,30 @@ module TDL
               # Obtain response from user
               response = @processing_rules.get_response_for(request)
               @audit.log(response)
-      
-              # Obtain action
-              client_action = response.client_action
-      
+
               # Act
-              client_action.after_response(remote_broker, request, response)
-              @audit.log(client_action)
+              after_response(remote_broker, request, response)
+
               @audit.end_line
-              client_action.prepare_for_next_request(remote_broker)
+
+              prepare_for_next_request(remote_broker, response)
+            end
+
+            def after_response(remote_broker, request, response)
+              if response.instance_of? FatalErrorResponse
+                 # Do nothing
+              else
+                 remote_broker.respond_to(request, response)
+              end
+            end
+
+            def prepare_for_next_request(remote_broker, response)
+                if response.instance_of? FatalErrorResponse
+                   remote_broker.close
+                else
+                   # Do nothing
+                end
             end
-      
         end
     end
 end

data/lib/tdl/queue/queue_based_implementation_runner_builder.rb

@@ -1,5 +1,4 @@
 require 'tdl/queue/queue_based_implementation_runner'
-require 'tdl/queue/actions/client_actions'
 
 module TDL
     
@@ -14,11 +13,11 @@ module TDL
             self
         end
 
-        def with_solution_for(method_name, user_implementation, action = ClientActions.publish)
+        def with_solution_for(method_name, user_implementation)
             @deploy_processing_rules
                 .on(method_name)
                 .call(user_implementation)
-                .then(action)
+                .build()
             self
         end
 
@@ -31,7 +30,7 @@ module TDL
             deploy_processing_rules
                 .on('display_description')
                 .call(-> (*params) {'OK'})
-                .then(ClientActions.publish)
+                .build()
             deploy_processing_rules
         end
 

data/lib/tdl/queue/transport/remote_broker.rb

@@ -4,11 +4,10 @@ require 'tdl/queue/serialization/json_rpc_serialization_provider'
 
 module TDL
   class RemoteBroker
-    def initialize(hostname, port, unique_id, request_timeout_millis)
+    def initialize(hostname, port, request_queue_name, response_queue_name, request_timeout_millis)
       @stomp_client = Stomp::Client.new('', '', hostname, port)
-      @unique_id = unique_id
-      @request_queue = "/queue/#{@unique_id}.req"
-      @response_queue = "/queue/#{@unique_id}.resp"
+      @request_queue = "/queue/#{request_queue_name}"
+      @response_queue = "/queue/#{response_queue_name}"
       @serialization_provider = JSONRPCSerializationProvider.new
       @timer = ThreadTimer.new(request_timeout_millis, lambda = ->() { close unless closed? })
       @timer.start

data/lib/tdl/runner/runner_action.rb

@@ -1,25 +1,20 @@
-require 'tdl/queue/actions/client_actions'
-
-include TDL::ClientActions
-
 class RunnerAction
-  attr_reader :short_name, :name, :client_action
+  attr_reader :short_name, :name
 
-  def initialize(short_name, name, client_action)
+  def initialize(short_name, name)
     @short_name = short_name
     @name = name
-    @client_action = client_action
   end
 
 end
 
 module RunnerActions
   def get_new_round_description
-    RunnerAction.new('new', 'get_new_round_description', TDL::ClientActions.stop)
+    RunnerAction.new('new', 'get_new_round_description')
   end
 
   def deploy_to_production
-      RunnerAction.new('deploy', 'deploy_to_production', TDL::ClientActions.publish)
+      RunnerAction.new('deploy', 'deploy_to_production')
   end
 
   def all

data/startExternalDependencies.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -e
+set -u
+set -o pipefail
+
+startWiremocks() {
+    echo "~~~~~~~~~~ Starting Wiremocks on ports 41375 and 8222 ~~~~~~~~~"
+    python wiremock/wiremock-wrapper.py start 41375
+	python wiremock/wiremock-wrapper.py start 8222
+}
+
+startBroker() {
+    echo "~~~~~~~~~~ Starting Broker ~~~~~~~~~"
+    python broker/activemq-wrapper.py start
+}
+
+startWiremocks
+startBroker

data/stopExternalDependencies.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+set -e
+set -u
+set -o pipefail
+
+stopProcessAtPort() {
+    PORT=$1
+    PID=$(netstat -tulpn | grep :${PORT} | awk '{print $7}' | tr -d "/java" || true)
+    if [[ -z "${PID}" ]]; then
+        echo "~~~~~~~~~~ Process on port ${PORT} stopped ~~~~~~~~~"
+    else
+        kill -9 ${PID}
+        echo "~~~~~~~~~~ Process on port ${PORT} killed ~~~~~~~~~"
+    fi
+}
+
+stopWiremocks() {
+    echo "~~~~~~~~~~ Stopping Wiremocks listening on ports 41375 and 8222 ~~~~~~~~~"
+    python wiremock/wiremock-wrapper.py stop || true
+
+    stopProcessAtPort 41375
+    stopProcessAtPort 8222
+}
+
+stopBroker() {
+    echo "~~~~~~~~~~ Stoping Broker ~~~~~~~~~"
+    python broker/activemq-wrapper.py stop || true
+}
+
+stopWiremocks
+stopBroker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdl-client-ruby
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.25.1
 platform: ruby
 authors:
 - Julian Ghionoiu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-03 00:00:00.000000000 Z
+date: 2018-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: stomp
@@ -217,10 +217,6 @@ files:
 - lib/tdl/queue/abstractions/request.rb
 - lib/tdl/queue/abstractions/response/fatal_error_response.rb
 - lib/tdl/queue/abstractions/response/valid_response.rb
-- lib/tdl/queue/actions/client_actions.rb
-- lib/tdl/queue/actions/publish_action.rb
-- lib/tdl/queue/actions/publish_and_stop_action.rb
-- lib/tdl/queue/actions/stop_action.rb
 - lib/tdl/queue/implementation_runner_config.rb
 - lib/tdl/queue/processing_rules.rb
 - lib/tdl/queue/queue_based_implementation_runner.rb
@@ -237,13 +233,15 @@ files:
 - lib/tdl/thread_timer.rb
 - lib/tdl/util.rb
 - release.sh
+- startExternalDependencies.sh
+- stopExternalDependencies.sh
 - tdl-client-ruby.gemspec
 - tdl-client-ruby.iml
 homepage: https://github.com/julianghionoiu/tdl-client-ruby
 licenses:
 - GPL-3.0
 metadata:
-  previous_version: 0.21.1
+  previous_version: 0.22.1
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/tdl/queue/actions/client_actions.rb

@@ -1,20 +0,0 @@
-require 'tdl/queue/actions/publish_action'
-require 'tdl/queue/actions/stop_action'
-require 'tdl/queue/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/queue/actions/publish_action.rb

@@ -1,17 +0,0 @@
-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/queue/actions/publish_and_stop_action.rb

@@ -1,16 +0,0 @@
-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/queue/actions/stop_action.rb

@@ -1,17 +0,0 @@
-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