sanger_warren 0.1.0 → 0.2.0.rc1

data/lib/warren/subscription.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Warren
+  # Configures and wraps up subscriptions on a Bunny Channel/Queue
+  class Subscription
+    extend Forwardable
+
+    attr_reader :channel
+
+    #
+    # Great a new subscription. Handles queue creation, binding and attaching
+    # consumers to the queues
+    #
+    # @param channel [Warren::Handler::Broadcast::Channel] A chanel on which to register queues
+    # @param config [Hash] queue configuration hash
+    #
+    def initialize(channel:, config:)
+      @channel = channel
+      @queue_name = config.fetch('name')
+      @queue_options = config.fetch('options')
+      @bindings = config.fetch('bindings')
+    end
+
+    def_delegators :channel, :nack, :ack
+
+    #
+    # Subscribes to the given queue
+    #
+    # @param consumer_tag [String] Identifier for the consumer
+    #
+    # @yieldparam [Bunny::DeliveryInfo] delivery_info Metadata about the delivery
+    # @yieldparam [Bunny::MessageProperties] properties
+    # @yieldparam [String] payload the contents of the message
+    #
+    # @return [Bunny::Consumer] The bunny consumer object
+    #
+    def subscribe(consumer_tag, &block)
+      channel.prefetch(10)
+      queue.subscribe(manual_ack: true, block: false, consumer_tag: consumer_tag, durable: true, &block)
+    end
+
+    # Ensures the queues and channels are set up to receive messages
+    # keys: additional routing_keys to bind
+    def activate!
+      establish_bindings!
+    end
+
+    private
+
+    def add_binding(exchange, options)
+      queue.bind(exchange, options)
+    end
+
+    def exchange(config)
+      channel.exchange(*config.values_at('name', 'options'))
+    end
+
+    def queue
+      raise StandardError, 'No queue configured' if @queue_name.nil?
+
+      channel.queue(@queue_name, @queue_options)
+    end
+
+    def establish_bindings!
+      @bindings.each do |binding_config|
+        exchange = exchange(binding_config['exchange'])
+        add_binding(exchange, binding_config['options'])
+      end
+    end
+  end
+end

data/lib/warren/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Warren
-  VERSION = '0.1.0'
+  # Gem version number. Bump prior to release of new version
+  VERSION = '0.2.0.rc1'
 end

data/sanger-warren.gemspec

@@ -15,24 +15,25 @@ Gem::Specification.new do |spec|
   DESCRIPTION
   spec.homepage = 'https://github.com/sanger/warren'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  spec.license = 'GPL'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/sanger/warren'
   spec.metadata['changelog_uri'] = 'https://github.com/sanger/warren/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/sanger_warren'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = 'bin'
+  spec.executables << 'warren'
   spec.require_paths = ['lib']
 
   # Dependencies
   spec.add_runtime_dependency 'bunny', '~> 2.17.0'
   spec.add_runtime_dependency 'connection_pool', '~> 2.2.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.0'
+  spec.add_runtime_dependency 'thor', '~> 1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanger_warren
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0.rc1
 platform: ruby
 authors:
 - James Glover
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -52,19 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: |
   Warren provides connection pooling for RabbitMQ connections. It also adds
   the ability to switch in different adapters during testing and development.
 email:
 - james.glover@sanger.ac.uk
-executables: []
+executables:
+- warren
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -73,30 +88,55 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/warren
 - checksums
 - complete
+- lefthook.yml
+- lib/sanger_warren.rb
 - lib/warren.rb
+- lib/warren/app.rb
+- lib/warren/app/cli.rb
+- lib/warren/app/config.rb
+- lib/warren/app/consumer.rb
+- lib/warren/app/consumer_add.rb
+- lib/warren/app/consumer_start.rb
+- lib/warren/app/exchange_config.rb
+- lib/warren/app/templates/subscriber.tt
 - lib/warren/callback.rb
 - lib/warren/callback/broadcast_associated_with_warren.rb
 - lib/warren/callback/broadcast_with_warren.rb
+- lib/warren/client.rb
+- lib/warren/config/consumers.rb
+- lib/warren/den.rb
+- lib/warren/exceptions.rb
+- lib/warren/fox.rb
+- lib/warren/framework_adaptor/rails_adaptor.rb
 - lib/warren/handler.rb
+- lib/warren/handler/base.rb
 - lib/warren/handler/broadcast.rb
 - lib/warren/handler/log.rb
 - lib/warren/handler/test.rb
+- lib/warren/helpers/state_machine.rb
+- lib/warren/log_tagger.rb
 - lib/warren/message.rb
 - lib/warren/message/full.rb
 - lib/warren/message/short.rb
+- lib/warren/railtie.rb
+- lib/warren/subscriber/base.rb
+- lib/warren/subscription.rb
 - lib/warren/version.rb
 - object_types
 - objects/root.dat
 - proxy_types
 - sanger-warren.gemspec
 homepage: https://github.com/sanger/warren
-licenses: []
+licenses:
+- GPL
 metadata:
   homepage_uri: https://github.com/sanger/warren
   source_code_uri: https://github.com/sanger/warren
   changelog_uri: https://github.com/sanger/warren/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/sanger_warren
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -108,9 +148,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: 

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4