cli-proton-ruby 1.0.0

data/lib/options/sr_common_option_parser.rb

@@ -0,0 +1,96 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require_relative 'basic_option_parser'
+
+module Options
+
+  # Option parser of basic (see Options::BasicOptionParser) and common
+  # options for sender and receiver client
+  # ==== Common sender and receiver options
+  # log-msgs:: format of message(s) log (none/body/dict,
+  #            default: DEFAULT_LOG_MSGS, see Defaults)
+  class SRCommonOptionParser < Options::BasicOptionParser
+
+    # Initialization of basic and common sender and receiver options
+    def initialize()
+      # Initialization of basic options
+      super()
+      # SR usage
+      @opt_parser.banner = "Usage: <sr_program> [OPTIONS]"
+
+      # SR specific options with default values
+
+      # Format of message log option
+      @options.log_msgs = Defaults::DEFAULT_LOG_MSGS
+      # Hash message content
+      @options.msg_content_hashed = Defaults::DEFAULT_MSG_CONTENT_HASHED
+      # Auto settle off
+      @options.auto_settle_off = Defaults::DEFAULT_AUTO_SETTLE_OFF
+
+      # Format of message log
+      @opt_parser.on(
+        "--log-msgs FORMAT",
+        %w(none body dict interop),
+        "format of message(s) log (none/body/dict/interop, "+
+        "default: #{Defaults::DEFAULT_LOG_MSGS})"
+      ) do |log_msgs|
+        @options.log_msgs = log_msgs
+      end
+
+      # Message content hashed
+      @opt_parser.on(
+        "--msg-content-hashed [HASHED]",
+        Options::BOOLEAN_STRINGS,
+        "display SHA-1 hash of message content in logged messages (true/false) (default: #{Defaults::DEFAULT_MSG_CONTENT_HASHED})"
+      ) do |msg_content_hashed|
+        @options.msg_content_hashed = true
+        @options.msg_content_hashed = \
+          StringUtils.str_to_bool(msg_content_hashed) if msg_content_hashed
+      end
+
+      # Auto settle off
+      @opt_parser.on(
+        "--auto-settle-off [OFF]",
+        Options::BOOLEAN_STRINGS,
+        "disable auto settle mode (default: #{Defaults::DEFAULT_AUTO_SETTLE_OFF})"
+      ) do |auto_settle_off|
+        @options.auto_settle_off = true
+        @options.auto_settle_off = \
+          StringUtils.str_to_bool(auto_settle_off) if auto_settle_off
+      end
+
+      @options.duration = 0
+      @opt_parser.on(
+        "--duration DURATION", Float,
+        "message actions total duration (defines msg-rate together with count, default 0)"
+      ) do |d|
+        @options.duration = d
+      end
+    end # initialize
+
+    # Parsing of basic and common options for sender and receiver client
+    # ==== Parameters
+    # args:: arguments to parse
+    def parse(args)
+      @opt_parser.parse(args)
+    end # parse(args)
+
+  end # class SRCommonOptionParser
+
+end # module Options
+
+# eof

data/lib/receiver_client.rb

@@ -0,0 +1,61 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'qpid_proton'
+require_relative 'options/receiver_option_parser'
+require_relative 'handlers/receiver_handler'
+
+# ReceiverClient parses arguments
+# and runs receiver
+class ReceiverClient
+
+  # Initialization of receiver client,
+  # parsing receiver client arguments
+  # and receiver client run
+  # ==== Parameters
+  # args:: receiver client arguments
+  def initialize(args)
+    # Parse arguments
+    receiver_options_parser = Options::ReceiverOptionParser.new(args)
+    # Create receiver handler
+    receiver_handler = Handlers::ReceiverHandler.new(
+      receiver_options_parser.options.broker,
+      receiver_options_parser.options.log_msgs,
+      receiver_options_parser.options.msg_content_hashed,
+      receiver_options_parser.options.count,
+      receiver_options_parser.options.prefetch,
+      receiver_options_parser.options.process_reply_to,
+      receiver_options_parser.options.browse,
+      receiver_options_parser.options.selector,
+      receiver_options_parser.options.sasl_mechs,
+      receiver_options_parser.options.idle_timeout,
+      receiver_options_parser.options.max_frame_size,
+      receiver_options_parser.options.sasl_enabled,
+      receiver_options_parser.options.log_lib,
+      receiver_options_parser.options.recv_listen,
+      receiver_options_parser.options.recv_listen_port,
+      receiver_options_parser.options.auto_settle_off,
+      receiver_options_parser.options.exit_timer,
+      receiver_options_parser.options.duration,
+      receiver_options_parser.options.duration_mode
+    )
+    # Run receiver client
+    Qpid::Proton::Container.new(receiver_handler).run
+  end
+
+end # class ReceiverClient
+
+# eof

data/lib/sender_client.rb

@@ -0,0 +1,69 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'qpid_proton'
+require_relative 'options/sender_option_parser'
+require_relative 'handlers/sender_handler'
+
+# SenderClient parses arguments
+# and runs sender
+class SenderClient
+
+  # Initialization of sender client,
+  # parsing sender client arguments
+  # and sender client run
+  # ==== Parameters
+  # args:: sender client arguments
+  def initialize(args)
+    # Parse arguments
+    sender_options_parser = Options::SenderOptionParser.new(args)
+    # Create sender handler
+    sender_handler = Handlers::SenderHandler.new(
+      sender_options_parser.options.broker,
+      sender_options_parser.options.log_msgs,
+      sender_options_parser.options.msg_content_hashed,
+      sender_options_parser.options.count,
+      sender_options_parser.options.msg_properties,
+      sender_options_parser.options.msg_content,
+      sender_options_parser.options.msg_content_type,
+      sender_options_parser.options.msg_durable,
+      sender_options_parser.options.msg_ttl,
+      sender_options_parser.options.msg_correlation_id,
+      sender_options_parser.options.msg_reply_to,
+      sender_options_parser.options.msg_group_id,
+      sender_options_parser.options.msg_to,
+      sender_options_parser.options.msg_priority,
+      sender_options_parser.options.msg_id,
+      sender_options_parser.options.msg_user_id,
+      sender_options_parser.options.msg_subject,
+      sender_options_parser.options.anonymous,
+      sender_options_parser.options.sasl_mechs,
+      sender_options_parser.options.idle_timeout,
+      sender_options_parser.options.max_frame_size,
+      sender_options_parser.options.sasl_enabled,
+      sender_options_parser.options.log_lib,
+      sender_options_parser.options.auto_settle_off,
+      sender_options_parser.options.exit_timer,
+      sender_options_parser.options.duration,
+      sender_options_parser.options.duration_mode
+    )
+    # Run sender client
+    Qpid::Proton::Container.new(sender_handler).run
+  end
+
+end # class SenderClient
+
+# eof

data/lib/utils/duration.rb

@@ -0,0 +1,44 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Create a Duration at the start of the process and use it to sleep for delays
+class Duration
+  # @param duration the total duration
+  # @param count the number of evenly-spaced delays within the duration
+  # @param mode only delay for this mode
+  def initialize(duration, count, mode)
+    @delay = count > 0 ? duration / count : 0     # Time for each delay
+    @deadline = Time.now + @delay     # End time of next call to #delay
+    @mode = mode
+  end
+
+  attr_reader :mode
+
+  # Return nil if mode != self.mode.
+  # Return the next delay period, taking account of cumulative time taken so far.
+  # If block given, call with the delay period.
+  def delay(mode)
+    if mode == @mode
+      d = @deadline - Time.now
+      d = 0 if d < 0            # No negative delays
+      @deadline += @delay
+      block_given? ? yield(d) : d
+    end
+  end
+
+  def zero?() @delay.zero?; end
+end

data/lib/utils/env_utils.rb

@@ -0,0 +1,39 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+# Module containing environment utilities for cli-proton-ruby clients
+module EnvUtils
+
+  # Function to set environment variable for client library logging
+  # ==== Parameters
+  # level:: log level to set and use
+  def self.set_log_lib_env(level)
+    case level
+    when "TRANSPORT_FRM"
+      ENV['PN_TRACE_FRM'] = "true"
+    when "TRANSPORT_RAW"
+      ENV['PN_TRACE_RAW'] = "true"
+    when "TRANSPORT_DRV"
+      ENV['PN_TRACE_DRV'] = "true"
+    when "NONE"
+    else
+      raise ArgumentError, "Invalid client library logging level: #{level}"
+    end
+  end
+
+end # module EnvUtils
+
+# eof

data/lib/utils/exit_timer.rb

@@ -0,0 +1,44 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Timer that exits the process if it expires.
+# Use a timer thread, as the Qpid::Proton::Container does not yet provide scheduled tasks.
+
+class ExitTimer
+
+  attr_reader :timeout
+
+  # Start the timer to exit after timeout.
+  def initialize(timeout)
+    @timeout = timeout
+    @lock = Mutex.new
+    reset
+    Thread.new do
+      while (delta = @lock.synchronize { @deadline - Time.now } ) > 0
+        sleep delta
+      end
+      puts "timeout expired"
+      exit(0)
+    end
+  end
+
+  # Reset the timer to count to timeout from now
+  def reset()
+    @lock.synchronize { @deadline = Time.now + @timeout }
+  end
+
+end

data/lib/utils/string_utils.rb

@@ -0,0 +1,81 @@
+#--
+# Copyright 2017 Red Hat Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+require 'digest'
+
+# Module containing string utilities for cli-proton-ruby clients
+module StringUtils
+
+  # Function to check if string variable is convertible to integer
+  # ==== Parameters
+  # value:: string variable to convert
+  # ==== Returns
+  # true if string variable is convertible to integer, false otherwise
+  def self.str_is_int?(value)
+    !Integer(value).nil? rescue false
+  end
+
+  # Function to check if string variable is convertible to float
+  # ==== Parameters
+  # value:: string variable to convert
+  # ==== Returns
+  # true if string variable is convertible to float, false otherwise
+  def self.str_is_float?(value)
+    !Float(value).nil? rescue false
+  end
+
+  # Function to check if string variable is convertible to client bool value
+  # ==== Returns
+  # true if string variable is convertible to client bool value, false otherwise
+  def self.str_is_bool?(value)
+    begin
+      str_to_bool value
+    rescue ArgumentError
+      return false
+    end
+
+    return true
+  end
+
+  # Function to convert string variable to client bool value
+  # (yes/no|True/False|true/false)
+  # ==== Parameters
+  # value:: string variable to convert
+  # ==== Returns
+  # bool value of the variable
+  # ==== Raises
+  # ArgumentError for invalid argument
+  def self.str_to_bool(value)
+    # If positive value
+    if ["yes", "True", "true"].include?(value)
+      # Return true
+      return true
+    # If negative value
+    elsif ["no", "False", "false"].include?(value)
+      # Return false
+      return false
+    end
+    # If value is not convertible, raise ArgumentError
+    raise ArgumentError, "invalid value for Boolean(): \"#{value}\""
+  end
+
+  def self.sha1_hash(value)
+    Digest::SHA1.hexdigest value.to_s
+  end
+
+end # module StringUtils
+
+# eof

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: cli-proton-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Radim Kubis
+- Jiri Danek
+- Alan Conway
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: qpid_proton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.26'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+description: cli-proton-ruby is a collection of commandline messaging clients suitable
+  for interacting with Message Oriented Middleware.
+email: rkubis@redhat.com
+executables:
+- cli-proton-ruby-connector
+- cli-proton-ruby-receiver
+- cli-proton-ruby-sender
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cli-proton-ruby-connector
+- bin/cli-proton-ruby-receiver
+- bin/cli-proton-ruby-sender
+- lib/connector_client.rb
+- lib/constants.rb
+- lib/defaults.rb
+- lib/formatters.rb
+- lib/formatters/basic_formatter.rb
+- lib/formatters/dict_formatter.rb
+- lib/formatters/interop_formatter.rb
+- lib/handlers.rb
+- lib/handlers/basic_handler.rb
+- lib/handlers/connector_handler.rb
+- lib/handlers/receiver_handler.rb
+- lib/handlers/sender_handler.rb
+- lib/handlers/sr_common_handler.rb
+- lib/options.rb
+- lib/options/basic_option_parser.rb
+- lib/options/connector_option_parser.rb
+- lib/options/receiver_option_parser.rb
+- lib/options/sender_option_parser.rb
+- lib/options/sr_common_option_parser.rb
+- lib/receiver_client.rb
+- lib/sender_client.rb
+- lib/utils/duration.rb
+- lib/utils/env_utils.rb
+- lib/utils/exit_timer.rb
+- lib/utils/string_utils.rb
+homepage: http://rubygems.org/gems/cli-proton-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/rh-messaging/cli-proton-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0p648
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Qpid Proton Ruby commandline clients
+test_files: []