bunny-publisher 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c083b8200bdbe3d30cb2672065e3529c1e1dc78f82514f8d694f83419df279b
-  data.tar.gz: 38c13c753e4bceeb6f26d344ab050769a874201fb262b47104005bfed3b22466
+  metadata.gz: 114f01661b4bf20f7b8e3e0c2a09dba2b969cac13f5b9e1140edd0a8048b8f86
+  data.tar.gz: e3a18568ee95e4eca7d5093b9ed3326cffe71c1890c235903d9f4de6395b6efd
 SHA512:
-  metadata.gz: 1db69e62d8f38eb35b3a625233af35304ddbeb5ce9af02c3fb162e559813267f3b465dd48e54547a57d1ec9e988d57483e1c03a878b883dab699b14f0588dd43
-  data.tar.gz: 462fc949e57fcc820e1486a86e4a216229c2bbe2a15792563e1dc45435f97e179cc1d6663f9fbd92a5c74417179631bf87ebadb2e5b674732e39df7d23342681
+  metadata.gz: 528c55964119b778c6d7573a489a76b0c315002ccdfff3770a34d26439f76e050e8a629012fe76739cefaffad667201ba1a24b9fa409401fb50b07eb4e6972cd
+  data.tar.gz: 933da9ba2d644c5138b4b091dede2935de7bab125cadd7007d1b4a7c311717ceb94bc417fe5251d77f7f11dbe7c757a2c45201d369044cb8b5fe14db6eea2a7e

data/CHANGELOG.md

@@ -1,5 +1,52 @@
-## Changes Between 0.1.0 and 0.1.1
+# Changelog
 
-Minor improvements of unrouted message processing at program exit.
+All notable changes to this project will be documented in this file.
 
-## Original Release: 0.1.0
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased](https://github.com/veeqo/bunny-publisher/compare/v0.1.6...HEAD)
+
+
+## [0.1.6](https://github.com/veeqo/bunny-publisher/compare/v0.1.5...v0.1.6) - 2020-11-24
+
+### Fixed
+- [#8](https://github.com/veeqo/bunny-publisher/pull/8) Fix errors on recovery from connection failures
+
+
+## [0.1.5](https://github.com/veeqo/bunny-publisher/compare/v0.1.4...v0.1.5) - 2020-11-04
+
+### Fixed
+- [#7](https://github.com/veeqo/bunny-publisher/pull/7) Enforce single channel for threaded apps
+
+
+## [0.1.4](https://github.com/veeqo/bunny-publisher/compare/v0.1.3...v0.1.4) - 2020-11-03
+
+### Changed
+- [#5](https://github.com/veeqo/bunny-publisher/pull/5) Test against ruby 2.7.2
+
+### Fixed
+- [#6](https://github.com/veeqo/bunny-publisher/pull/6) Do not share channels between threads
+
+
+## [0.1.3](https://github.com/veeqo/bunny-publisher/compare/v0.1.2...v0.1.3) - 2020-09-18
+
+### Changed
+- [#2](https://github.com/veeqo/bunny-publisher/pull/2) Use appraisal gem to control gem versions of tests matrix
+- [#3](https://github.com/veeqo/bunny-publisher/pull/3) Require ruby 2.5
+
+### Fixed
+- [#4](https://github.com/veeqo/bunny-publisher/pull/4) Fix deprecation warnings of ruby 2.7
+
+
+## [0.1.2](https://github.com/veeqo/bunny-publisher/compare/v0.1.1...v0.1.2) - 2020-07-30
+
+### Added
+-  [846369a](https://github.com/veeqo/bunny-publisher/commit/846369a76a9ae1c38e0a08844a5c992412eac520) Test mode
+
+
+## [0.1.1](https://github.com/veeqo/bunny-publisher/compare/v0.1.0...v0.1.1) - 2020-05-21
+
+### Changed
+- [fec490c](https://github.com/veeqo/bunny-publisher/commit/fec490c91a7db9d053dba9afde0736a4ce2dde71) Imrove unrouted messages processing
+
+## [0.1.0](https://github.com/veeqo/bunny-publisher/releases/tag/v0.1.0) - 2020-05-20

data/README.md

@@ -111,6 +111,52 @@ end
 
 Not implemented yet
 
+## Test mode
+
+BunnyPublisher also has a test mode which replaces exchange and prevents real connection to RabbitMQ
+
+```ruby
+BunnyPublisher.configure do |c|
+  c.test = true # or Rails.env.test?
+
+  # ...
+end
+```
+
+Now publisher has `#messages`, `#flush!` methods:
+
+```ruby
+describe SomeServiceThatPublishesToRabbitMQ, '#call' do
+  subject { described_class.new(some: 'attributes').call }
+
+  before { BunnyPublisher.flush! }
+
+  it 'publishes a message' do
+    expect { subject }.to change(BunnyPublisher.messages).by(1)
+  end
+end
+```
+
+## Testing
+
+Run rabbitmq server (in separate console):
+```
+docker run --rm -p 5672:5672 -p 15672:15672 rabbitmq:3.8-management-alpine
+```
+
+Run tests with:
+
+```sh
+bundle
+rake
+```
+
+Use [wwtd](https://github.com/grosser/wwtd) to run test matrix:
+```sh
+gem install wwtd
+wwtd
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/veeqo/bunny-publisher.

data/lib/bunny_publisher.rb

@@ -6,6 +6,7 @@ require 'bunny_publisher/callbacks'
 require 'bunny_publisher/errors'
 require 'bunny_publisher/base'
 require 'bunny_publisher/mandatory'
+require 'bunny_publisher/test'
 
 module BunnyPublisher
   class << self
@@ -20,13 +21,28 @@ module BunnyPublisher
     def configure
       require 'ostruct'
 
-      config = OpenStruct.new({})
+      config = OpenStruct.new(mandatory: false, test: false)
 
       yield(config)
 
-      klass = Class.new(Base).tap { |k| k.include(::BunnyPublisher::Mandatory) if config.delete_field(:mandatory) }
+      klass = Class.new(Base) do
+        include ::BunnyPublisher::Mandatory if config.delete_field(:mandatory)
+        include ::BunnyPublisher::Test      if config.delete_field(:test)
+      end
 
-      @publisher = klass.new(config.to_h)
+      @publisher = klass.new(**config.to_h)
+    end
+
+    def method_missing(method_name, *args)
+      if publisher.respond_to?(method_name)
+        publisher.send(method_name, *args)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, *args)
+      publisher.respond_to?(method_name) || super
     end
   end
 end

data/lib/bunny_publisher/base.rb

@@ -25,13 +25,15 @@ module BunnyPublisher
     end
 
     def publish(message, options = {})
-      ensure_connection!
+      @mutex.synchronize do
+        ensure_connection!
 
-      run_callback(:before_publish, message, options)
-      result = run_callback(:around_publish, message, options) { exchange.publish(message, options) }
-      run_callback(:after_publish, message, options)
+        run_callback(:before_publish, message, options)
+        result = run_callback(:around_publish, message, options) { exchange.publish(message, options) }
+        run_callback(:after_publish, message, options)
 
-      result
+        result
+      end
     end
 
     def close
@@ -43,14 +45,26 @@ module BunnyPublisher
     private
 
     def ensure_connection!
-      @mutex.synchronize { connect! unless connected? }
+      @connection ||= build_connection
+
+      connection.start if connection.status == :not_connected # Lazy connection initialization.
+
+      wait_until_connection_ready(connection)
+
+      @channel ||= connection.create_channel
+      @exchange ||= build_exchange
     end
 
-    def connect!
-      @connection ||= build_connection
-      connection.start
-      @channel = connection.create_channel
-      @exchange = build_exchange
+    def wait_until_connection_ready(conn)
+      Timeout.timeout((conn.heartbeat || 60) * 2) do # 60 seconds is a default Bunny heartbeat
+        loop do
+          return if conn.status == :open && conn.transport.open?
+
+          sleep 0.001
+        end
+      end
+    rescue Timeout::Error
+      # Connection recovery takes too long, let the next interaction fail with error then.
     end
 
     def build_connection
@@ -62,9 +76,5 @@ module BunnyPublisher
 
       channel.exchange(@exchange_name, @exchange_options)
     end
-
-    def connected?
-      @connection&.connected? && channel
-    end
   end
 end

data/lib/bunny_publisher/mandatory.rb

@@ -16,7 +16,7 @@ module BunnyPublisher
     attr_reader :queue_name, :queue_options
 
     def initialize(republish_connection: nil, queue: nil, queue_options: {}, timeout_at_exit: 5, **options)
-      super(options)
+      super(**options)
 
       @queue_name = queue
       @queue_options = queue_options
@@ -51,9 +51,11 @@ module BunnyPublisher
 
     attr_reader :republish_connection, :republish_channel, :republish_exchange
 
-    def connect!
+    def ensure_connection!
       super
 
+      return if @on_return_set
+
       # `on_return` is called within a frameset of amqp connection.
       # Any interaction within the same connection leads to error. This is why we need extra connection.
       # https://github.com/ruby-amqp/bunny/blob/7fb05abf36637557f75a69790be78f9cc1cea807/lib/bunny/session.rb#L683
@@ -62,21 +64,18 @@ module BunnyPublisher
       else
         exchange.on_return { |*attrs| on_message_return(*attrs) }
       end
+
+      @on_return_set = true
     end
 
     def ensure_republish_connection!
-      @republish_mutex.synchronize { connect_for_republish! unless connected_for_republish? }
-    end
+      @republish_connection ||= build_republish_connection
+      republish_connection.start if republish_connection.status == :not_connected # Lazy connection initialization.
 
-    def connected_for_republish?
-      republish_connection&.connected? && republish_channel
-    end
+      wait_until_connection_ready(republish_connection)
 
-    def connect_for_republish!
-      @republish_connection ||= build_republish_connection
-      republish_connection.start
-      @republish_channel = republish_connection.create_channel
-      @republish_exchange = clone_exchange_for_republish
+      @republish_channel ||= republish_connection.create_channel
+      @republish_exchange ||= clone_exchange_for_republish
     end
 
     def build_republish_connection
@@ -109,14 +108,16 @@ module BunnyPublisher
     end
 
     def setup_queue_for_republish(return_info, properties, message)
-      ensure_republish_connection!
+      @republish_mutex.synchronize do
+        ensure_republish_connection!
 
-      queue = declare_republish_queue(return_info, properties, message)
+        queue = declare_republish_queue(return_info, properties, message)
 
-      # default exchange already has bindings with queues
-      declare_republish_queue_binding(queue, return_info, properties, message) unless republish_exchange.name == ''
+        # default exchange already has bindings with queues
+        declare_republish_queue_binding(queue, return_info, properties, message) unless republish_exchange.name == ''
 
-      republish_channel.deregister_queue(queue) # we are not going to work with this queue in this channel
+        republish_channel.deregister_queue(queue) # we are not going to work with this queue in this channel
+      end
     end
 
     def ensure_message_is_unrouted!(return_info, properties, message)

data/lib/bunny_publisher/test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module BunnyPublisher
+  # Test module prevents real connections to be made and replaces exchange with array-based TestExchange
+  module Test
+    class TestExchange < Array
+      def publish(message, options = {})
+        self << [message, options]
+        true
+      end
+
+      # in case if used with Mandatory module included
+      def on_return(&block); end
+    end
+
+    def exchange
+      @exchange ||= TestExchange.new
+    end
+
+    alias messages exchange
+
+    def flush!
+      exchange.clear
+    end
+
+    alias close flush!
+    alias stop flush!
+
+    private
+
+    def ensure_connection!; end
+  end
+end

data/lib/bunny_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BunnyPublisher
-  VERSION = '0.1.1'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bunny-publisher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Rustam Sharshenov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -24,20 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: AMQP publisher for RabbitMQ based on Bunny
 email:
 - rustam@sharshenov.com
@@ -101,22 +101,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bunny-publisher.gemspec
 - lib/bunny/publisher.rb
 - lib/bunny_publisher.rb
 - lib/bunny_publisher/base.rb
 - lib/bunny_publisher/callbacks.rb
 - lib/bunny_publisher/errors.rb
 - lib/bunny_publisher/mandatory.rb
+- lib/bunny_publisher/test.rb
 - lib/bunny_publisher/version.rb
 homepage: https://github.com/veeqo/bunny-publisher
 licenses:
@@ -133,14 +127,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: AMQP publisher for RabbitMQ based on Bunny

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Gemfile.lock
-/.ruby-gemset
-/.ruby-version
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,16 +0,0 @@
-Layout/LineLength:
-  Max: 120
-  Exclude:
-    - "spec/**/*"
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - "spec/**/*"
-
-Metrics/BlockLength:
-  Exclude:
-    - "spec/**/*"
-
-Style/EvalWithLocation:
-  Exclude:
-    - "spec/**/*"

data/.travis.yml

@@ -1,16 +0,0 @@
----
-dist: xenial
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
-env:
-  - BUNNY_VERSION="~> 2.15"
-  - BUNNY_VERSION="2.10.0"
-
-before_install: gem install bundler
-before_script:
-  - ".ci/install_rabbitmq"
-bundler_args: --jobs 3 --retry 3

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in bunny-publisher.gemspec
-gemspec
-
-gem 'bunny', ENV.fetch('BUNNY_VERSION', '~> 2.15')

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bunny-publisher.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'bunny_publisher/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'bunny-publisher'
-  spec.version       = BunnyPublisher::VERSION
-  spec.authors       = ['Rustam Sharshenov']
-  spec.email         = ['rustam@sharshenov.com']
-
-  spec.summary       = 'AMQP publisher for RabbitMQ based on Bunny'
-  spec.description   = 'AMQP publisher for RabbitMQ based on Bunny'
-  spec.homepage      = 'https://github.com/veeqo/bunny-publisher'
-  spec.license       = 'MIT'
-
-  if spec.respond_to?(:metadata)
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-    spec.metadata['changelog_uri'] = 'https://github.com/veeqo/bunny-publisher/blob/master/CHANGELOG.md'
-  end
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|\.ci)/}) }
-  end
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'bunny', '~> 2.10'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rabbitmq_http_api_client', '~> 1.13'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-end