cli-proton-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4a093138bedcfc8d3887ae6642853dc082d655769d3f4e154730a3e9bcac238
+  data.tar.gz: 788a3da1be2cf22de966091cf1699b7623f43bbf8db82a50d535b101ebab0446
+SHA512:
+  metadata.gz: e8834697ba69e4fd6bf5a92563228b82120f099b9f62f77bd1626715246dcd71127f94d29101b30b94d6d0833d21237c5710c3489ef3edec230414160cc912e1
+  data.tar.gz: f710bd2152728f4dc20946257c4b496b926786d583ab85b47d67d8804e6e46b6a855b8bdd187b218ea60eea337943d31250cdb7fa564e163a7b98527f0f69bde

data/bin/cli-proton-ruby-connector

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#--
+# 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 '../lib/connector_client'
+
+# Run connector client with command line arguments
+ConnectorClient.new(ARGV)
+
+# eof

data/bin/cli-proton-ruby-receiver

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#--
+# 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 '../lib/receiver_client'
+
+# Run receiver client with command line arguments
+ReceiverClient.new(ARGV)
+
+# eof

data/bin/cli-proton-ruby-sender

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+#--
+# 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 '../lib/sender_client'
+
+# Run sender client with command line arguments
+SenderClient.new(ARGV)
+
+# eof

data/lib/connector_client.rb

@@ -0,0 +1,50 @@
+#--
+# 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/connector_option_parser'
+require_relative 'handlers/connector_handler'
+
+# ConnectorClient parses arguments
+# and runs connector
+class ConnectorClient
+
+  # Initialization of connector client,
+  # parsing connector client arguments
+  # and connector client run
+  # ==== Parameters
+  # args:: connector client arguments
+  def initialize(args)
+    # Parse arguments
+    connector_options_parser = Options::ConnectorOptionParser.new(args)
+    # Create connector handler
+    connector_handler = Handlers::ConnectorHandler.new(
+      connector_options_parser.options.broker,
+      connector_options_parser.options.count,
+      connector_options_parser.options.sasl_mechs,
+      connector_options_parser.options.idle_timeout,
+      connector_options_parser.options.max_frame_size,
+      connector_options_parser.options.sasl_enabled,
+      connector_options_parser.options.log_lib,
+      connector_options_parser.options.exit_timer,
+    )
+    # Run connector client
+    Qpid::Proton::Container.new(connector_handler).run
+  end
+
+end # class ConnectorClient
+
+# eof

data/lib/constants.rb

@@ -0,0 +1,27 @@
+#--
+# 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 constant values
+module Constants
+
+  # Minimal port range value
+  CONST_MIN_PORT_RANGE_VALUE = 0
+  # Maximal port range value
+  CONST_MAX_PORT_RANGE_VALUE = 65535
+
+end # module Constants
+
+# eof

data/lib/defaults.rb

@@ -0,0 +1,91 @@
+#--
+# 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 default values
+module Defaults
+
+  # Default value for broker URI in format IP:PORT/queue
+  DEFAULT_BROKER             = "127.0.0.1:5672/examples"
+  # Default value for message(s)/connection(s) count to send/receive/create
+  DEFAULT_COUNT              = 1
+  # Default value for format of message(s) log
+  DEFAULT_LOG_MSGS           = "none"
+  # Default value of message properties
+  DEFAULT_MSG_PROPERTIES     = nil
+  # Default value for message content
+  DEFAULT_MSG_CONTENT        = nil
+  # Default value for content type
+  DEFAULT_CONTENT_TYPE       = "string"
+  # Default value for message content type
+  DEFAULT_MSG_CONTENT_TYPE   = nil
+  # Default message durability
+  DEFAULT_MSG_DURABLE        = false
+  # Default value for message correlation ID
+  DEFAULT_CORR_ID            = nil
+  # Default value for reply-to
+  DEFAULT_MSG_REPLY_TO       = nil
+  # Default value for process reply to
+  DEFAULT_PROC_REPLY_TO      = false
+  # Default value for message group ID
+  DEFAULT_GROUP_ID           = nil
+  # Default value for browse messages
+  DEFAULT_BROWSE             = false
+  # Default value for message selector
+  DEFAULT_SELECTOR           = nil
+  # Default value for SASL allowed mechanisms
+  DEFAULT_SASL_MECHS         = "ANONYMOUS PLAIN EXTERNAL"
+  # Default value for idle timeout
+  DEFAULT_IDLE_TIMEOUT       = 0
+  # Default value for message TTL (ms)
+  DEFAULT_MSG_TTL            = 0
+  # Default value for message priority
+  DEFAULT_MSG_PRIORITY       = nil
+  # Default value for message ID
+  DEFAULT_MSG_ID             = nil
+  # Default value for message user ID
+  DEFAULT_MSG_USER_ID        = nil
+  # Default value for message subject
+  DEFAULT_MSG_SUBJECT        = nil
+  # Default value for anonymous
+  DEFAULT_ANONYMOUS          = false
+  # Default value for exit timer
+  DEFAULT_EXIT_TIMER         = nil
+  # Default minimal max frame size
+  DEFAULT_MIN_MAX_FRAME_SIZE = 512
+  # Default maximal max frame size
+  DEFAULT_MAX_MAX_FRAME_SIZE = 2**20  # TODO(jdanek): workaround PROTON-1809 Unable to receive messages ...
+  # Default value for max frame size
+  DEFAULT_MAX_FRAME_SIZE     = DEFAULT_MAX_MAX_FRAME_SIZE
+  # Default client library logging
+  DEFAULT_LOG_LIB            = "NONE"
+  # Default value for recv-listen
+  DEFAULT_RECV_LISTEN        = false
+  # Default value for recv-listen port
+  DEFAULT_RECV_LISTEN_PORT   = 5672
+  # Default value for auto-settle-off
+  DEFAULT_AUTO_SETTLE_OFF    = false
+  # Default value of credit for messages to be pre-fetched
+  DEFAULT_PREFETCH           = 10
+  # Default message destination
+  DEFAULT_TO                 = nil
+  # Default message content hashed
+  DEFAULT_MSG_CONTENT_HASHED = false
+  # Default connection SASL enabled
+  DEFAULT_SASL_ENABLED       = true
+
+end # module Defaults
+
+# eof

data/lib/formatters.rb

@@ -0,0 +1,28 @@
+#--
+# 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 'formatter/basic_formatter'
+require 'formatter/dict_formatter'
+
+# Module containing formatters for cli-proton-ruby clients
+# ==== Formatters
+# * Formatters::BasicFormatter for formatting message body
+# * Formatters::DictFormatter for formatting message into dictionary
+module Formatters
+
+end # module Formatters
+
+# eof

data/lib/formatters/basic_formatter.rb

@@ -0,0 +1,112 @@
+#--
+# 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 '../utils/string_utils'
+
+module Formatters
+
+  # Basic formatter of message body
+  class BasicFormatter
+
+    # Message to format
+    attr_accessor :message
+    # Content hashed
+    attr_accessor :msg_content_hashed
+
+    # Initialization of basic formatter
+    # ==== Basic formatter arguments
+    # message:: message to format
+    def initialize(message, msg_content_hashed=false)
+      # Save message
+      @message = message
+      @msg_content_hashed = msg_content_hashed
+    end # initialize(message)
+
+    # Format value according to type
+    # ==== Parameters
+    # value:: value to format
+    # ==== Returns
+    # value formatted as string
+    def format_value(value)
+      # Switch by class of value
+      case value
+      # Boolean value
+      when TrueClass, FalseClass
+        value ? "True" : "False"
+      # Numeric or Range value
+      when Integer, Float, Numeric, Range #, Bignum, Fixnum are deprecated
+        value
+      # Array value
+      when Array
+        # Array for formatted items of array
+        help_array = []
+        # Each item in array needs to be formatted
+        value.each do |item|
+          # Format array item
+          help_array.push(format_value(item))
+        end
+        "[#{help_array.join(", ")}]"
+      # Dictionary/hash value
+      when Hash
+        # Array for formatted items of hash
+        help_array = []
+        # Each key-value pair needs to be formatted
+        value.each do |key, val|
+          # Format key-value pair of item
+          help_array.push("#{format_value(key)}: #{format_value(val)}")
+        end
+        "{#{help_array.join(", ")}}"
+      # String or symbol value
+      when Symbol
+        value.size > 0 ? "'#{value}'" : "None"
+      when String
+        value.size > 0 ? "'#{value.gsub(/'/, %q(\\\'))}'" : "None"
+      # Nil value
+      when NilClass
+        "None"
+      # Other or unknown type
+      else
+        raise TypeError, "Unknown value type"
+      end # case
+    end # format_value(value)
+
+    # Prints formatted message body to stdout
+    def print()
+      # Print formatted body to stdout
+      puts format_value(@msg_content_hashed ? StringUtils.sha1_hash(@message.body) : @message.body)
+    end # print()
+
+    # Escapes characters which Python's eval() cannot load
+    # that is esp. \0, \r, \n. Use a range, to be safe.
+    def self.escape_chars(msg_string)
+      if msg_string.nil?
+        nil
+      else
+        msg_string.each_codepoint.map do |s|
+          if s < 32 || s > 126
+            format('\\u%04x', s)
+          else
+            s.chr
+          end
+        end.join
+      end
+    end
+
+  end # class BasicFormatter
+
+end # module Formatters
+
+# eof

data/lib/formatters/dict_formatter.rb

@@ -0,0 +1,66 @@
+#--
+# 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_formatter'
+
+module Formatters
+
+  # Formatter of message into dictionary format
+  class DictFormatter < Formatters::BasicFormatter
+
+    # Initialization of dictionary formatter
+    # ==== Dictionary formatter arguments
+    # message:: message to format
+    def initialize(message, msg_content_hashed=false)
+      super(message, msg_content_hashed)
+    end # initialize(message)
+
+    # Format message as dictionary
+    # ==== Returns
+    # message formatted as dictionary
+    def get_as_dictionary()
+      dict_to_return = "" \
+      + "'redelivered': #{format_value(
+        @message.delivery_count == 0 ? false : true
+      )}, "\
+      + "'reply-to': #{format_value(@message.reply_to)}, "\
+      + "'subject': #{format_value(@message.subject)}, "\
+      + "'content-type': #{format_value(@message.content_type)}, "\
+      + "'id': #{format_value(@message.id)}, "\
+      + "'group-id': #{format_value(@message.group_id)}, "\
+      + "'user-id': #{format_value(@message.user_id)}, "\
+      + "'correlation-id': #{format_value(@message.correlation_id)}, "\
+      + "'priority': #{format_value(@message.priority)}, "\
+      + "'durable': #{format_value(@message.durable)}, "\
+      + "'ttl': #{format_value(@message.ttl)}, "\
+      + "'properties': #{format_value(@message.properties)}, "\
+      + "'content': #{
+        format_value(@msg_content_hashed ? StringUtils.sha1_hash(@message.body) : @message.body)
+      }"
+      return self.class.escape_chars("{#{dict_to_return}}")
+    end # get_as_dictionary()
+
+    # Prints message formatted as dictionary to stdout
+    def print()
+      # Print formatted message to stdout
+      puts get_as_dictionary()
+    end # print()
+
+  end # class DictFormatter
+
+end # module Formatters
+
+# eof