SMService 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba77f89b36377c88a36275cae2ee1cb0fe7933070fe29ee26dc52afcd5d3be14
-  data.tar.gz: cf59fc3d4f92594b23817a59c4e5623d3e2ba75898894fd7f8aa52402d0fc22a
+  metadata.gz: 99628cf63e1cded8cfdd814002fb905aecd17833a19bd474da23671fe692c78e
+  data.tar.gz: 4eb82e840f5f730707784fb51fddd90f3accfe4501d9e3b5e9aa731133915490
 SHA512:
-  metadata.gz: 9c57d922c113e68c45b4dc068e771795c4e1782b8701b1492513b55b662ac51eb73871c35cb90b27aeb911337b968d29877527894427007fdf23b6e67f76f574
-  data.tar.gz: 0b8dc1990f4e49fb3937d7da8ab818bc71f15d9e945b625617593d39bef173398d3460c88b45928914962e3f9da02a3cb9473039a53d3352547ee0914607b838
+  metadata.gz: d3d7a51b6da0ff3144deefa211fd27fdd15473f2197ee0baf55d9b669e32bfd032e7c0a6d8c350c151b6c062530968c7a8e6cb13ff224799949d4e8ec456a3c1
+  data.tar.gz: f879a7f6182bbbac5c336f551991ea395f08953425ae6691d49712767947132413a7ef90fb898ff1495dde014f37ca0e5dfe1aceb644588c9b5e228d1133e092

data/Dockerfile

@@ -20,8 +20,9 @@ RUN apk update \
      pcre \
      zlib \
      tzdata \
-     mc \
+     tmux \
      vim \
+     mc \
 \
 && cp -R /usr/share/zoneinfo/Europe/Amsterdam /etc/localtime \
 && echo 'Europe/Amsterdam' > /etc/timezone \

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    SMService (0.1.3)
+    SMService (0.1.8)
       ffi-rzmq (~> 2.0)
       logger (~> 1.2)
       msgpack (~> 1.1)
@@ -9,6 +9,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.1.2)
     diff-lcs (1.3)
     ffi (1.9.18)
     ffi-rzmq (2.0.5)
@@ -16,7 +17,11 @@ GEM
     ffi-rzmq-core (1.0.6)
       ffi
     logger (1.2.8)
+    method_source (0.9.0)
     msgpack (1.1.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -38,6 +43,7 @@ PLATFORMS
 DEPENDENCIES
   SMService!
   bundler (~> 1.16)
+  pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3.0)
 

data/{smservice.gemspec → SMService.gemspec}

@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
 
 
   s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "pry", "~> 0.11"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "rspec", "~> 3.0"
 end

data/bin/console

@@ -1,16 +1,73 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+require 'pry'
 require 'bundler'
 Bundler.setup
 Bundler.require
 require 'smservice'
+require_relative '../examples/dummy'
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+class SMService::TestCase
+  include SMService
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+  def initialize
+    super name: 'test_ruby', actions: 'test'
+  end
 
-require "irb"
-IRB.start(__FILE__)
+  def action_test(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'test'. Headers: #{headers.inspect}, message: #{message.inspect}"
+
+    # triggering 'someaction' as part of test plan
+    @tc_reply_to = headers['reply_to']       # where TC shall report-to at the end
+    message[:parent_action_headers] = headers # sending also parameters from caller
+    execute action: 'someaction', message: message
+
+    if headers['reply_to']
+      # sending reply back
+      LOGGER.info "#{self.class} - Action 'test' sending reply"
+
+      execute action: 'REPLY',
+              reply_to: headers['reply_to'],
+              message:  {status: 'OK', more_data: ['...']}
+
+      LOGGER.info "#{self.class} - Action 'test' reply sent"
+    end
+
+    LOGGER.info "#{self.class} - Terminating action 'test'"
+  end
+
+  def action_reply(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'reply'. Headers: #{headers.inspect}, message: #{message.inspect}"
+
+    # ... if conditions and validations to ensure that it is reply for this TC, by searching UUID etc etc, and by the end:
+    #
+    LOGGER.info "#{self.class} - Forwarding collected TC data to the caller, which is #{@tc_reply_to}"
+    execute action: 'REPLY',
+            reply_to: @tc_reply_to,
+            message: message
+  end
+end
+
+class SMService::API
+  include SMService
+
+  def initialize
+    super name: 'api'
+  end
+end
+
+
+dummy = SMService::Dummy.new
+dummy.start!
+
+tc = SMService::TestCase.new
+tc.start!
+
+api = SMService::API.new
+api.start!
+
+sleep 3
+api.execute(action: 'test', message: {my_request: 'ping', my_data: 'add whatever data needed'})
+
+binding.pry

data/docker-compose.yml

@@ -0,0 +1,15 @@
+version: '3'
+
+networks:
+  middleware:
+    external:
+      name: middleware_default
+
+services:
+  rubygems:
+    build: .
+    container_name: rubygems
+    volumes:
+      - ./:/app
+    networks:
+      - middleware

data/docker.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+docker build --pull -t rubygems . && \
+docker run -ti --rm --name=rubygems -v ${PWD}:/app rubygems sh

data/examples/dummy.rb

@@ -0,0 +1,25 @@
+class SMService::Dummy
+  include SMService
+
+  def initialize
+    super name: 'dummy_ruby', actions: 'someaction'
+  end
+
+  def action_someaction(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'someaction'. Headers: #{headers.inspect}, message: #{message.inspect}"
+
+    if headers['reply_to']
+      # sending reply back
+      LOGGER.info "#{self.class} - Action 'someaction' sending reply"
+
+      execute action: 'REPLY',
+              reply_to: headers['reply_to'],
+              message:  {status: 'OK', whatever: 'add it here'}
+
+      LOGGER.info "#{self.class} - Action 'someaction' reply sent"
+    end
+
+    LOGGER.info "#{self.class} - Terminating action 'someaction'"
+
+  end
+end

data/lib/smservice/version.rb

@@ -1,3 +1,3 @@
 module SMService
-  VERSION = '0.1.4'
+  VERSION = '0.1.8'
 end

data/lib/smservice.rb

@@ -10,14 +10,37 @@ module SMService
   ENDPOINT_OUT = 'tcp://proxy:6660'
   ENDPOINT_IN = 'tcp://proxy:6661'
 
-  REGISTER_WAIT_TIME = 'infinite'
+  REGISTER_WAIT_TIME  = 'infinite'
+  REGISTER_RETRY      = 10
   KEEPALIVE_WAIT_TIME = 30
 
   attr_accessor :socket_in, :socket_out
   attr_reader :service_name
 
-  def initialize(name:)
+  # When registering node, following parameters is mandatory:
+  #
+  # name: name of service/node with its id;
+  # actions: list of actions, should be in lowercase and compatible to naming standard for ruby methods
+  # actions could be presented as array or as string if service registering only single action
+  #
+  # Example:
+  # SMService::SomeService.new(name: 'dummy-ruby', actions: %w(a b c ping pong))
+  #
+  # Following actions should be defined as methods for new service, i.e.
+  #
+  # def action_ping(headers, message)
+  #   LOGGER.info "#{self.class} - Processing action: PING with headers: #{headers.inspect} and message: #{message.inspect}"
+  #   # ... business logic here
+  #  end
+  #
+  # Prohibited names for actions is register and update, those are reserved to let service communicate with SM.
+  # Check SMService::Dummy source code (in examples folder) for detais
+  #
+  def initialize(name:, actions: [])
     @service_name = name
+    @actions = [%w(ping), actions].flatten.sort.uniq
+
+    @mutex = Mutex.new
 
     context = ZMQ::Context.new
     @socket_in = context.socket ZMQ::DEALER
@@ -30,21 +53,46 @@ module SMService
     @socket_out.connect ENDPOINT_OUT
   end
 
-  def register!(wait_time: REGISTER_WAIT_TIME)
+  # starting infinite loop in order to process service logic.
+  # start! or service_poller methods could be modified implementing different services, i.e.  to run as threaded metod
+  def start!
+    register
+    keep_alive!
+    poller!
+    @started = true
+  end
+
+  def started?
+    @started
+  end
+
+  def poller!
+    Thread.start do
+      poller
+    end
+  end
+
+  def poller
+    loop do
+      pull
+    end
+  end
+
+  def register(wait_time: REGISTER_WAIT_TIME)
     if wait_time.to_f <= 0
       loop do
-        register!
+        register_service
         break if registered?
         # not registered, retrying in 10 seconds
-        sleep 10
+        sleep REGISTER_RETRY
       end
     else
       Timeout::timeout(wait_time) do
         loop do
-          register!
+          register_service
           break if registered?
           # not registered, retrying in 10 seconds
-          sleep 10
+          sleep REGISTER_RETRY
         end
       end
     end
@@ -52,11 +100,11 @@ module SMService
 
   def keep_alive!(wait_time: KEEPALIVE_WAIT_TIME)
     Thread.start do
-      LOGGER.info "Starting registration update loop with periodic interval #{wait_time} sec"
+      LOGGER.info "#{self.class} - Starting registration update loop with periodic interval #{wait_time} sec"
       loop do
         break unless registered?
         sleep wait_time
-        service_manager('UPDATE',  [])
+        request(action: 'UPDATE')
       end
       LOGGER.info 'Registration update loop terminated'
     end
@@ -66,55 +114,66 @@ module SMService
     @registered
   end
 
-  def register!
-    service_manager('REGISTER',  services: [service_name])
-    pull_action
+  def action_register(headers, message)
+    if headers['action'] == 'REGISTER' && message['result'] == 'OK'
+      @registered = true
+      LOGGER.info "#{self.class} - Action: REGISTER (successful), headers: #{headers.inspect}, message: #{message.inspect}"
+    else
+      LOGGER.info "#{self.class} - Action: REGISTER (failure), headers: #{headers.inspect}, message: #{message.inspect}"
+    end   
   end
 
-  def service_poller
-    loop do
-      pull_action
-    end
+  def action_ping(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'ping'. Headers: #{headers.inspect}, message: #{message.inspect}"
   end
 
-  def start!
-    register!
-    keep_alive!
-    service_poller
+  def action_update(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'update'. Headers: #{headers.inspect}, message: #{message.inspect}"
   end
 
-  def action_update(headers, message)
-    LOGGER.info("Action: UPDATE (successful)")
+  def action_reply(headers, message)
+    LOGGER.info "#{self.class} - Processing action 'reply'. Headers: #{headers.inspect}, message: #{message.inspect}"
   end
 
-  def action_register(headers, message)
-    if headers['action'] == 'REGISTER' && message['result'] == 'OK'
-      @registered = true
-      LOGGER.info "Action: REGISTER (successful), headers: #{headers.inspect}, message: #{message.inspect}"
-    else
-      LOGGER.info "Action: REGISTER (failure), headers: #{headers.inspect}, message: #{message.inspect}"
-    end   
+  # Requesting another service, registered at SM to execute given action, example:
+  # execute(action: 'create_customer_portal', message: {my_request: 'should create a customer', my_data: 'add whatever data needed'})
+  #
+  def execute(action:, reply_to: nil, message: nil)
+    LOGGER.info "#{self.class} - SM execute request. Action: #{action.inspect}, message: #{message.inspect}"
+    action = {service: action, reply_to: (reply_to || @service_name)}.to_msgpack
+    message = message.to_msgpack
+    @socket_out.send_strings [action, message]
   end
 
 private
 
+  def register_service
+    LOGGER.info "#{self.class} - Registering service #{service_name}"
+    request(action: 'REGISTER', message: {services: @actions})
+    pull
+  end
+
   # Sending request to the Service Manager
-  # 
-  def service_manager(action, message)
-    LOGGER.info "SM request. Action: #{action.inspect}, message: #{message.inspect}"
+  def request(action:, message: nil)
+    LOGGER.info "#{self.class} - SM request. Action: #{action.inspect}, message: #{message.inspect}"
     action = {action: action}.to_msgpack
     message = message.to_msgpack
-    @socket_in.send_strings [action, message]
+    @mutex.synchronize do
+      @socket_in.send_strings [action, message]
+    end
   end
 
-  def pull_action
-    @socket_in.recv_strings( response = [] )
+  def pull
+    response = []
+    @mutex.synchronize do
+      @socket_in.recv_strings(response)
+    end
 
     headers, message = response
     headers = MessagePack.unpack(headers)
     message = MessagePack.unpack(message)
 
-    LOGGER.info "SM response received by pull_action. Headers: #{headers.inspect}, message: #{message.inspect}"
+    LOGGER.info "#{self.class} - SM response received by pull. Headers: #{headers.inspect}, message: #{message.inspect}"
 
     # Validates is action_name exists as class method and calling it.
     # In case, if Service Manager return headers['action'] == 'METHOD_NAME',
@@ -128,17 +187,11 @@ private
     # - action_register, that confirms registration of node with Service Manager, and
     # - action_update, that confirms successfule registration update, we need it to support keep-alive
     #
-    action_name = "action_#{headers['action'].downcase}".to_sym
+    action_name = "action_#{(headers['action'] || headers['service']).downcase}".to_sym
     if respond_to? action_name.to_sym
       send(action_name, headers, message)
+    else
+      LOGGER.error "#{self.class} - Method #{action_name} does not exist in class instance for action name #{headers['action']}"
     end
   end
 end
-
-class SMService::Dummy
-  include SMService
-
-  def initialize
-    super name: 'dummy-ruby'
-  end
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SMService
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Andrius Kairiukstis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,11 +126,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SMService.gemspec
 - bin/console
 - bin/setup
+- docker-compose.yml
+- docker.sh
+- examples/dummy.rb
 - lib/smservice.rb
 - lib/smservice/version.rb
-- smservice.gemspec
 homepage: https://github.com/andrius/smservice
 licenses:
 - MIT