subscriptions-config 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f24471ee1244174cf8a1f8a73d4a9a63d0cd0a8965127ce93907c2e58a066a78
+  data.tar.gz: a7b11ee16615955247750dbc4098d92d8c2f1e197bd712872ee27aab7dc42614
+SHA512:
+  metadata.gz: bb5944a032b719bb48a5db5d3f3cc80054563dda5ef32329d23770f34f5c51a4eaff2b44939a2618ace3a60802598fa7368b01f7a4c6f3eeae6d4fc3a93af789
+  data.tar.gz: b05dc1b80257ab59a0ede4e34e7516e9c6a5f7fbe572fc5347868a715e865a8c2fb583daf15b647ccf4edcf3a296f02621a629b20f019127d66a22fc4f407b83

data/lib/subscriptions-config.rb

@@ -0,0 +1,372 @@
+class SubscriptionsConfig
+  puts 'subscriptions-config'
+
+  DEFAULT_CONFIG = {
+    hostname: 'localhost',
+    message_bus_type: 'IbmMQ',
+    exchange: 'dataDelivery',
+    routing_spec: "",
+    queue_base: "",
+    durable: false,
+    model: "",
+    extension: "",
+    port: "1414",
+    trace_level: "0",
+    credentials: "",
+    vhost: "",
+    keep_queue: "n",
+    sub_name: ""
+  }.freeze
+
+  def initialize(config)
+    @config = DEFAULT_CONFIG.merge(config)
+  end
+
+  def create!
+    create_rabbitmq! if message_bus_type == 'RabbitMQ'
+    create_ibmmq! if message_bus_type == 'IbmMQ'
+    self
+  end
+
+  def delete!
+    delete_rabbit! if message_bus_type == 'RabbitMQ'
+    delete_ibmmq! if message_bus_type == 'IbmMQ'
+    self
+  end
+
+  def show_topics
+    puts topics
+    self
+  end
+
+  def show_bindings
+    puts bindings
+    self
+  end
+
+  def show_environment
+    puts "Bus Type: #{message_bus_type}"
+    show_environment_ibmmq if message_bus_type == 'IbmMQ'
+    show_environment_rabbit if message_bus_type == 'RabbitMQ'
+    self
+  end
+
+  def subscription_name(queue_name, routing_key)
+    if sub_name.nil?
+      routing_key_digest = Digest::SHA1.hexdigest(routing_key)[0..8]
+      "#{queue_name}.#{routing_key_digest}"
+    else
+      sub_name
+    end
+  end
+
+  def show_keep_queue
+    puts keep_queue
+    self
+  end
+
+  def show_sub_name
+    puts sub_name
+    self
+  end
+
+  private
+  def bindings
+    @bindings ||= begin
+      topics.map do |topic|
+        if message_bus_type == 'IbmMQ'
+          if (exchange.nil? && extension.nil?)
+            topic_str = topic.gsub(".","/")
+          elsif extension.nil?
+            topic_str = exchange+"/"+topic.gsub(".","/")
+          else
+            topic_str = extension+"/"+exchange+"/"+topic.gsub(".","/")
+          end
+          subscription_name = subscription_name(queue_name, topic_str)
+          hash = {:topic_str => topic_str, :subscription_name => subscription_name }
+        elsif message_bus_type == 'RabbitMQ'
+          topic_str=topic
+          subscription_name = queue_name+'_'+topic_str  # not used in rabbit mq
+          hash = {:topic_str => topic_str, :subscription_name => subscription_name }
+        end
+      end
+    end
+  end
+
+  def topics
+    @topics ||= @config[:routing_spec].split(",")
+  end
+
+  def connection_name
+    if message_bus_type == 'RabbitMQ'
+      @connection_name = hostname.to_s+':'+port.to_s
+    else
+      @connection_name = hostname.to_s+'('+port.to_s+')'
+    end
+  end
+
+  def mq_url
+    @mq_url="amqp://"+username+":"+password+"@"+connection_name+"/"+vhost
+  end
+
+  def queue_name
+    if message_bus_type == 'RabbitMQ'
+      @queue_name = queue_base
+    elsif extension.nil?
+      @queue_name = queue_base
+    else
+      @queue_name = queue_base+'.'+extension
+    end
+  end
+
+  def extension
+    @config[:extension]
+  end
+
+  def exchange
+    @config[:exchange]
+  end
+
+  def model
+    @config[:model]
+  end
+
+  def durable
+    @config[:durable]
+  end
+
+  def queue_base
+    @config[:queue_base]
+  end
+
+  def sub_name
+    @config[:sub_name]
+  end
+
+  def hostname
+    @config[:hostname]
+  end
+
+  def channel
+    @config[:channel]
+  end
+
+  def port
+    @config[:port]
+  end
+
+  def message_bus_type
+    @config[:message_bus_type]
+  end
+
+  def routing_spec
+    @config[:routing_spec]
+  end
+
+  def trace_level
+    @config[:trace_level].to_i
+  end
+
+  def vhost
+    @config[:vhost]
+  end
+
+  def keep_queue
+    @config[:keep_queue]
+  end
+
+  def credentials
+    @config[:credentials]
+  end
+
+  def username
+    items ||= credentials.split("/")
+    @username = items[0]
+  end
+
+  def password
+    items ||= credentials.split("/")
+    @password = items[1]
+  end
+
+#  RabbitMQ version of create!
+  def create_rabbitmq!
+    conn = Bunny.new(:host => hostname, :vhost => vhost, :user => username, :password => password)
+
+    #conn = Bunny.new("amqp://cdu-qa:cdu2018@r00xgjn0c.bnymellon.net:5672")
+    conn.start
+
+    ch = conn.create_channel
+    q  = ch.queue(queue_name, :durable => true, :exclusive => false)
+    x    = ch.topic(exchange, durable: true)
+    bindings.each do |binding|
+      if trace_level > 0
+        puts "  -- Create Subscription for routing key: #{binding[:topic_str]} to queue: #{queue_name}"
+      end
+      q.bind(exchange, routing_key: binding[:topic_str])
+    end
+
+    q.subscribe do |delivery_info, metadata, payload|
+     puts "Received #{payload}"
+    end
+
+    bindings.each do |binding|
+     message_body="Test topic string: "+binding[:topic_str]
+     x.publish(message_body, routing_key: binding[:topic_str])
+    end
+
+    sleep 1.0
+    conn.close
+    self
+  end
+
+  def delete_rabbitmq!
+    conn = Bunny.new(:host => hostname, :vhost => vhost, :user => username, :password => password)
+    conn.start
+    ch = conn.create_channel
+    puts " -- remove queue #{queue_name} and all it's bindings" if trace_level > 0
+    ch.queue_delete(queue_name)
+    ch.close
+    conn.close
+    self
+  end
+
+  def show_environment_rabbit
+    puts "credentials=\"#{username}/#{password}\""
+    puts "MQ_SUBSCRIBER_URL=\"#{mq_url}\""
+    puts "MQ_SUBSCRIBER_EXCHANGE=\"#{exchange}\""
+    puts "MQ_QUEUE_NAME=#{queue_name}"
+    puts "MQ_ROUTING_KEY=#{routing_spec}"
+    self
+  end
+
+  def show_environment_ibmmq
+    puts "MQ_SUBSCRIBER_URL=\"#{channel}/TCP/#{connection_name}\""
+    if extension.nil?
+      puts "MQ_SUBSCRIBER_EXCHANGE=\"#{exchange}\""
+    else
+      puts "MQ_SUBSCRIBER_EXCHANGE=\"#{extension}/#{exchange}\""
+    end
+    puts "MQ_QUEUE_NAME=#{queue_name}"
+    puts "MQ_ROUTING_KEY=#{routing_spec}"
+    if keep_queue == "y" or keep_queue == "Y" then
+      puts "KEEP_QUEUE=YES"
+    end
+    self
+  end
+
+  def create_ibmmq!
+    if trace_level > 0
+      puts "Create Subscription Connection: #{channel}/TCP/#{connection_name}  "
+      puts "  -- Create Queue #{queue_name} from model #{model}"
+    end
+    WMQ::QueueManager.connect(
+          channel_name: channel,
+          trp_type: 'TCP',
+          connection_name: connection_name) do |qmgr|
+      begin
+        qmgr.open_queue(
+                q_name: model,
+                dynamic_q_name: queue_name,
+                mode:           :input
+                                            ) do |target_queue|
+#          puts 'Queue Open Status: '+target_queue.reason
+ #         puts target_queue.inspect
+#          puts 'New Queue: '+target_queue.name
+          if trace_level > 0
+            puts "== queue == #{target_queue.name.to_s} status: #{target_queue.reason}"
+#            puts target_queue.reason
+          end
+        end
+      rescue WMQ::WMQException => mqe
+        exception_string="WMQ::Queue#open(). Error opening Queue:"+model.to_s+", reason:MQRC_OBJECT_ALREADY_EXISTS[2100]"
+        if mqe.message.eql?exception_string
+          puts "== queue == #{queue_name} exists"
+        else
+          puts "WARNING: there was a problem creating the queue #{mqe.to_s}"
+          puts "Exception Class: #{ mqe.class.name }"
+          puts "Exception Message: #{ mqe.message }"
+          puts "Exception Backtrace: #{ mqe.backtrace }"
+        end
+      end  # end do target_queue
+
+      bindings.each do |binding|
+        if trace_level > 0
+          puts "  -- Create Subscription Name: #{binding[:subscription_name]} for topic string: #{binding[:topic_str]} to queue: #{queue_name}"
+        end
+        sub = WMQ::Subscription.new( queue_manager:  qmgr,
+                                            topic_string: binding[:topic_str],
+                                            subscription_name: binding[:subscription_name],
+                                            durable: true,
+                                            managed: false,
+                                            resume: true,
+                                            keep: true,
+                                            q_name: queue_name,
+                                            mode: :input)
+        sub.open
+        if trace_level > 0
+#          puts sub.reason
+#          puts "Subscription: Connect: #{hostname}:#{port} / #{channel}\n"
+          puts "== sub == status: #{sub.reason}"
+        end
+        sub.close
+      end  # end do bindings
+    end  # end do qmgr
+    self
+  end
+
+  def delete_ibmmq!
+    puts 'delete_ibmmq'
+     WMQ::QueueManager.connect(
+          channel_name: channel,
+          trp_type: 'TCP',
+          connection_name: connection_name) do |qmgr|
+            puts "4"
+      bindings.each do |binding|
+        puts "5"
+        subscription = WMQ::Subscription.new( queue_manager:  qmgr,
+                                              topic_string: binding[:topic_str],
+                                              subscription_name: binding[:subscription_name],
+                                              durable: true,
+                                              managed: false,
+                                              resume: true,
+                                              keep: false,
+                                              q_name: queue_name,
+                                              mode: :input)
+                                              puts "6"
+        subscription.open
+        if trace_level > 0
+          puts "  -- Delete Subscription Name: #{binding[:subscription_name]} for topic string: #{binding[:topic_str]} to queue: #{queue_name}"
+#          puts subscription.reason
+        end
+        subscription.close
+      end # end do bindings
+
+      if keep_queue != "y" and keep_queue != "Y" then
+        qmgr.open_queue(
+             q_name: queue_name,
+             mode:           :input,
+              close_options: WMQ::MQCO_DELETE
+            ) do |target_queue|
+          if trace_level > 0
+            puts 'Queue Open Status: '+target_queue.reason
+            puts 'Queue to delete: '+target_queue.name
+            puts target_queue.reason
+          end
+          puts "Clear old messages ..."
+          message_count=0
+          message = WMQ::Message.new
+          while target_queue.get(message: message, wait: 2000)
+            message.descriptor = {}
+            message_count += 1
+          end # end while get()
+          puts "Removed #{message_count} messages from queue #{target_queue.name} "
+        end # end do target_queue
+      else
+        puts "Subscription queue #{queue_name} preserved"
+      end
+    end # end do qmgr
+    self
+  end # end delete_subscription
+
+end

metadata

@@ -0,0 +1,44 @@
+--- !ruby/object:Gem::Specification
+name: subscriptions-config
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Bill Whiting
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies: []
+description: Provides a class to create and destroy durable subscriptions in both
+  IBM-MQ and RabbitMQ
+email: william.whiting@bnymellon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/subscriptions-config.rb
+homepage: https://gitlab.bnymellon.net/zmq/zmq-00/subscription-mgr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key: 
+specification_version: 4
+summary: create durable subscriptions
+test_files: []