basquiat 1.3.0.pre.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e62fb7f48142250951c4e6c7d471fe3bbff47f4
-  data.tar.gz: 044bfbfdeeeec35150d679eae3425db38ab3699e
+  metadata.gz: f2fd0255f1924260c2253d4b0ffe3bd5434184cc
+  data.tar.gz: 1db61ca0abc893884328a3de429ad0a9a7007578
 SHA512:
-  metadata.gz: fd73d055c57de8b20fd623876d270d18ddd8f0f8fd29443e76610dbd00c30dc5011010e49b1c3fa0f21a457a43a4a74f49ecdbe35db04e0b3bf9c759b743e545
-  data.tar.gz: e8e3af0254e4693d759defe4724f02bb4a6408c98df126303b214f491023fce078c57308967dbf37c72ded09d4eacb569b6d08cc3fc6db068e05cf55f04988dc
+  metadata.gz: a4755306fa1d78f6aab9e05c4504fa333c508aecafaab2784afcf64d847ae1c56d1e7f4f6c81b94e3cbfa8ca145ddbd5098dcf2cc38a466feba1e64c4dc4ce15
+  data.tar.gz: d41074fe39816491a4eba28241e928b60186d38154a04d2c0a5efbec747b16caa90957c12e5baca3d85977f373c55efcbfa03cbcb4515c52c7b257fa6ac29d74

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in basquiat.gemspec

data/Guardfile

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 guard :bundler do
   watch('Gemfile')
   watch('basquiat.gemspec')
 end
 
-guard :rspec, { cmd:  'bundle exec rspec', all_on_start: true,
-                keep: true, all_after_pass: true, run_all: { cmd: 'rspec -f progress' } } do
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true,
+      keep: true, all_after_pass: true, run_all: { cmd: 'rspec -f progress' } do
   watch(%r{^spec/.+_spec.rb$})
   watch(%r{^spec/lib/.+_spec.rb$})
   watch(%r{^lib/basquiat/(.+)\.rb$}) { |matchdata| "spec/lib/#{matchdata[1]}_spec.rb" }
@@ -12,11 +13,11 @@ guard :rspec, { cmd:  'bundle exec rspec', all_on_start: true,
   watch(%r{spec/support/.+\.rb}) { 'spec' }
 end
 
-guard :rubocop, { cmd: 'rubocop', cli: '-fs -c./.rubocop.yml' } do
-  #watch(%r{.+\.rb$})
-  #watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+guard :rubocop, cmd: 'rubocop', cli: '-fs -c./.rubocop.yml' do
+  # watch(%r{.+\.rb$})
+  # watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end
 
-guard 'yard', { cli: '-r' } do
-  watch(%r{lib/.+\.rb})
+guard 'yard', cli: '-r' do
+  watch %r{lib/.+\.rb}
 end

data/README.md

@@ -1,6 +1,7 @@
 # Basquiat
 
-[![Code Climate](https://codeclimate.com/github/VAGAScom/basquiat/badges/gpa.svg)](https://codeclimate.com/github/VAGAScom/basquiat)
+[![Issue Count](https://codeclimate.com/github/VAGAScom/basquiat/badges/issue_count.svg)](https://codeclimate.com/github/VAGAScom/basquiat)
+[![Test Coverage](https://codeclimate.com/github/VAGAScom/basquiat/badges/coverage.svg)](https://codeclimate.com/github/VAGAScom/basquiat/coverage)
 
 **Basquiat** is library aimed to hide (almost) all the complexity when working with some kind of message queue from the application internals.
 
@@ -106,7 +107,8 @@ development:                                #full example of the RabbitMq option
       password: 'guest'
     requeue:
       enabled: true
-      delayed_delivery:
+      strategy: delayed_delivery
+      options:
         retries: 10
         queue_name_preffix: wait.for_it
         exchange_name: legendary

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/basquiat.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'basquiat/version'
@@ -15,9 +16,9 @@ EOD
   spec.homepage = 'http://github.com/VAGAScom/basquiat'
   spec.license  = 'MIT'
 
-  spec.files         = `git ls-files`.split($RS)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.files         = `git ls-files`.split($RS).reject { |f| f =~ /^\.|docker/ }
+  spec.executables   = spec.files.grep(%r{/^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w(lib)
 
   spec.add_development_dependency 'bundler'
@@ -36,7 +37,6 @@ EOD
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'yard'
 
-
   spec.add_dependency 'multi_json'
   spec.add_dependency 'naught'
 end

data/lib/basquiat/adapters/base_adapter.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'delegate'
 require 'basquiat/adapters/base_message'
 
 module Basquiat
   module Adapters
-    # Base implementation for an adapter
+    # Base implementation for an adapter in uses {HashRefinements} internally.
     class Base
       using Basquiat::HashRefinements
 
@@ -21,9 +22,9 @@ module Basquiat
           strategies[config_name.to_sym] = klass
         end
 
-        # Return the Strategy Class registered on key
+        # Return the Strategy Class registered on given key
         # @param key [#to_sym] configured key for the wanted strategy
-        # @return [Class] return the strategy class
+        # @return [Class] the strategy class
         # @raise [Errors::StrategyNotRegistered] if it fails to find the key
         def strategy(key)
           strategies.fetch(key)
@@ -32,7 +33,7 @@ module Basquiat
         end
       end
 
-      # @param procs: [Object]
+      # @param procs [Object]
       #   It's a hash by default, but usually will be superseded by the adapter implementation
       def initialize(procs: {})
         @options = base_options
@@ -61,8 +62,9 @@ module Basquiat
       end
 
       # The default adapter options, merged with the {Basquiat::Configuration#adapter_options}. Used internally.
-      # @todo rename this method
+      # @api private
       # @return [Hash] the full options hash
+      # @todo rename this method
       def base_options
         default_options.merge(Basquiat.configuration.adapter_options)
       end
@@ -76,19 +78,18 @@ module Basquiat
       # @!group Adapter specific implementations
       # @abstract Publish an event to the event stream
       def publish
-        fail Basquiat::Errors::SubclassResponsibility
+        raise Basquiat::Errors::SubclassResponsibility
       end
 
       # @abstract subscribe_to the event stream
       def subscribe_to
-        fail Basquiat::Errors::SubclassResponsibility
+        raise Basquiat::Errors::SubclassResponsibility
       end
 
       # @abstract Disconnect from the message queue
       def disconnect
-        fail Basquiat::Errors::SubclassResponsibility
+        raise Basquiat::Errors::SubclassResponsibility
       end
-
       # @!endgroup
 
       private

data/lib/basquiat/adapters/base_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     # The simplest Message class. It's encouraged to tailor it to your adapter needs (hence BaseMessage).

data/lib/basquiat/adapters/rabbitmq/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
@@ -7,21 +8,21 @@ module Basquiat
 
         def initialize
           @options = { connection:
-                                  { hosts: ['localhost'],
-                                    port:  5672,
-                                    auth:  { user: 'guest', password: 'guest' }
-                                  },
-                       queue:     {
-                         name:    Basquiat.configuration.queue_name,
+                         { hosts: ['localhost'],
+                           port: 5672,
+                           auth: { user: 'guest', password: 'guest' }
+                         },
+                       queue: {
+                         name: Basquiat.configuration.queue_name,
                          durable: true,
                          options: {} },
-                       exchange:  {
-                         name:    Basquiat.configuration.exchange_name,
+                       exchange: {
+                         name: Basquiat.configuration.exchange_name,
                          durable: true,
                          options: {} },
                        publisher: { confirm: true, persistent: false },
-                       consumer:  { prefetch: 1000, manual_ack: true },
-                       requeue:   { enabled: false } }
+                       consumer: { prefetch: 1000, manual_ack: true },
+                       requeue: { enabled: false } }
         end
 
         def base_options
@@ -47,10 +48,10 @@ module Basquiat
 
         # @return [Hash] the session options
         def session_options
-          { exchange:  @options[:exchange],
+          { exchange: @options[:exchange],
             publisher: @options[:publisher],
-            consumer:  @options[:consumer],
-            queue:     @options[:queue] }.deep_merge(strategy.session_options)
+            consumer: @options[:consumer],
+            queue: @options[:queue] }.deep_merge(strategy.session_options)
         end
 
         # @return [BaseStrategy] the requeue strategy or {BasicAcknowledge} if none is configured

data/lib/basquiat/adapters/rabbitmq/connection.rb

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
       # Control the connection to the RabitMQ server. Delegates calls to {Bunny::Connection}
       class Connection < SimpleDelegator
         # @param hosts: [Array<String>] IPs or FQDN of the RabbitMQ instances
-        # @param port: [Fixnum] Port that the RabbitMQ instances run
-        # @param failover: [Hash]
+        # @param port [Fixnum] Port that the RabbitMQ instances run
         # @option failover: [Fixnum] :max_retries (5) Maximum number of reconnection retries
         # @option failover: [Fixnum] :default_timeout (5) Interval between to reconnect attempts
         # @option failover: [Fixnum] :connection_timeout (5) Allowed time before a connection attempt timeouts
-        # @param auth: [Hash]
         # @option auth: [String] :user ('guest')
         # @option auth: [String] :password ('guest')
         def initialize(hosts:, port: 5672, failover: {}, auth: {})
@@ -23,19 +22,22 @@ module Basquiat
         # @return [Bunny::Channel]
         def create_channel
           connection.start
+          Basquiat.logger.debug 'Creating a new channel'
           connection.create_channel
         end
 
         # Starts the connection if needed
         def start
+          Basquiat.logger.debug 'Connecting to RabbitMQ'
           connection.start unless connection.connected?
         end
 
+        # checks if the connection is started
         def connected?
           connection.status == :started
         end
 
-        # Closes the channels and the connection.
+        # Closes all channels and then the connection.
         def disconnect
           connection.close_all_channels
           connection.close
@@ -46,6 +48,7 @@ module Basquiat
 
         def reset
           @connection = nil
+          __setobj__(nil)
         end
 
         def connection

data/lib/basquiat/adapters/rabbitmq/events.rb

@@ -1,5 +1,4 @@
-require 'set'
-
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
@@ -13,7 +12,7 @@ module Basquiat
         end
 
         def []=(key, value)
-          if key =~ /\*|\#/
+          if key =~ /\*|#/
             set_pattern_key(key, value)
           else
             @exact[key] = value
@@ -34,7 +33,7 @@ module Basquiat
           key            = if key =~ /\*/
                              /^#{key.gsub('*', '[^.]+')}$/
                            else
-                             /^#{key.gsub(/\#/, '.*')}$/
+                             /^#{key.gsub(/#/, '.*')}$/
                            end
           @patterns[key] = value
         end

data/lib/basquiat/adapters/rabbitmq/message.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
+      # A RabbitMQ message, with it's delivery info and properties
+      # It's used instead of a simple hash so we can access more easily
+      # the properties needed for acks and requeues
       class Message < Basquiat::Adapters::BaseMessage
         attr_reader :delivery_info, :props
-        alias_method :di, :delivery_info
+        alias di delivery_info
         # @!attribute [r] delivery_info
         #   @return [Hash] RabbitMQ delivery_info.
         # @!attribute [r] props
@@ -25,6 +29,7 @@ module Basquiat
         end
 
         # Shorthand for delivery_info.delivery_tag
+        # @return [String] the message's Delivery Tag
         def delivery_tag
           delivery_info.delivery_tag
         end

data/lib/basquiat/adapters/rabbitmq/requeue_strategies/auto_acknowledge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq

data/lib/basquiat/adapters/rabbitmq/requeue_strategies/base_strategy.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
@@ -17,7 +18,7 @@ module Basquiat
         end
 
         def run(_message)
-          fail Basquiat::Errors::SubclassResponsibility
+          raise Basquiat::Errors::SubclassResponsibility
         end
 
         def ack(message)

data/lib/basquiat/adapters/rabbitmq/requeue_strategies/basic_acknowledge.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq

data/lib/basquiat/adapters/rabbitmq/requeue_strategies/dead_lettering.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
@@ -11,13 +12,11 @@ module Basquiat
                 queue: {
                   options: {
                     'x-dead-letter-exchange' => opts.fetch(:exchange, 'basquiat.dlx') } } },
-              dlx: { ttl: opts.fetch(:ttl, 1_000) } }
+              dlx:     { ttl: opts.fetch(:ttl, 1_000) } }
           end
 
           def session_options
             options.fetch :session
-          rescue KeyError
-            raise 'You have to setup the strategy first'
           end
         end
 

data/lib/basquiat/adapters/rabbitmq/requeue_strategies/delayed_delivery.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
@@ -7,15 +8,16 @@ module Basquiat
           attr_reader :options
 
           def setup(opts)
-            @options = { ddl: { retries:            5,
-                                exchange_name:      'basquiat.dlx',
-                                queue_name_preffix: 'basquiat.ddlq' } }.deep_merge(opts)
+            @options = { retries:            5,
+                         exchange_name:      'basquiat.dlx',
+                         queue_name_preffix: 'basquiat.ddlq' }.deep_merge(opts)
           end
         end
 
         def initialize(session)
           super
           setup_delayed_delivery
+          @queue_name = session.queue_name
         end
 
         def run(message)
@@ -36,10 +38,10 @@ module Basquiat
         # @return [String] the calculated routing key for a republish / requeue
         def requeue_route_for(key)
           event_name, timeout = extract_event_info(key)
-          if timeout == 2**options[:retries] * 1_000
-            "rejected.#{session.queue.name}.#{event_name}"
+          if timeout == max_timeout
+            "rejected.#{@queue_name}.#{event_name}"
           else
-            "#{timeout * 2}.#{session.queue.name}.#{event_name}"
+            "#{timeout * 2}.#{@queue_name}.#{event_name}"
           end
         end
 
@@ -47,43 +49,40 @@ module Basquiat
         # @return [Array<String, Integer>] a 2 item array composed of the event.name (aka original routing_key) and
         #   the current timeout
         def extract_event_info(key)
-          md = key.match(/^(\d+)\.#{session.queue.name}\.(.+)$/)
-          if md
-            [md.captures[1], md.captures[0].to_i]
-          else
-            # So timeout can turn into 1 second, weird but spares some checking
-            [key, 500]
-          end
+          matched = key.match(/^(\d+)\.#{session.queue.name}\.(.+)$/)
+          matched && [matched.captures[1], matched.captures[0].to_i] || [key, 500]
         end
 
         def options
-          self.class.options[:ddl]
+          self.class.options
         end
 
         def setup_delayed_delivery
           @exchange = session.channel.topic(options[:exchange_name], durable: true)
           session.bind_queue("*.#{session.queue.name}.#")
           prepare_timeout_queues
+          create_and_bind_rejected_queue
+        end
+
+        def create_and_bind_rejected_queue
           queue = session.channel.queue("#{options[:queue_name_preffix]}_rejected", durable: true)
           queue.bind(@exchange, routing_key: 'rejected.#')
         end
 
         def prepare_timeout_queues
-          queues = (0..options[:retries] - 1).map do |iteration|
+          (0..options[:retries] - 1).each do |iteration|
             timeout = 2**iteration
-            session.channel.queue("#{options[:queue_name_preffix]}_#{timeout}", durable: true,
-                                                                                arguments: {
-                                                                                  'x-dead-letter-exchange' => session.exchange.name,
-                                                                                  'x-message-ttl'          => timeout * 1_000 })
+            queue   = session.channel.queue("#{options[:queue_name_preffix]}_#{timeout}",
+                                            durable:   true,
+                                            arguments: {
+                                              'x-dead-letter-exchange' => session.exchange.name,
+                                              'x-message-ttl'          => timeout * 1_000 })
+            queue.bind(@exchange, routing_key: "#{timeout * 1_000}.#")
           end
-          bind_timeout_queues(queues)
         end
 
-        def bind_timeout_queues(queues)
-          queues.each do |queue|
-            timeout = queue.arguments['x-message-ttl'].to_i
-            queue.bind(@exchange, routing_key: "#{timeout}.#")
-          end
+        def max_timeout
+          2**(options[:retries] - 1) * 1_000
         end
       end
     end

data/lib/basquiat/adapters/rabbitmq/requeue_strategies.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'basquiat/adapters/rabbitmq/requeue_strategies/base_strategy'
 require 'basquiat/adapters/rabbitmq/requeue_strategies/auto_acknowledge'
 require 'basquiat/adapters/rabbitmq/requeue_strategies/basic_acknowledge'

data/lib/basquiat/adapters/rabbitmq/session.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     class RabbitMq
+      # A RabbitMQ session.
       class Session
         attr_reader :channel
 
@@ -34,6 +36,10 @@ module Basquiat
                                    arguments: (@options[:queue][:options] || {}))
         end
 
+        def queue_name
+          queue.name
+        end
+
         def exchange
           @exchange ||= channel.topic(@options[:exchange][:name],
                                       durable:   @options[:exchange][:durable],

data/lib/basquiat/adapters/rabbitmq_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bunny'
 require 'delegate'
 
@@ -68,7 +69,7 @@ module Basquiat
         @strategy   = nil
       end
 
-      alias_method :disconnect, :reset_connection
+      alias disconnect reset_connection
 
       # Lazy initializes the requeue strategy configured for the adapter
       # @return [BaseStrategy]

data/lib/basquiat/adapters/test_adapter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Adapters
     # An adapter to be used in testing

data/lib/basquiat/adapters.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require 'basquiat/adapters/base_adapter'
 require 'basquiat/adapters/test_adapter'

data/lib/basquiat/errors/strategy_not_registered.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module Errors
     class StrategyNotRegistered < KeyError

data/lib/basquiat/errors/subclass_responsibility.rb

@@ -1,9 +1,7 @@
+# frozen_string_literal: true
 module Basquiat
   module Errors
     class SubclassResponsibility < NoMethodError
-      def message
-        'This method should be implemented by a subclass tailored to the adapter'
-      end
     end
   end
 end

data/lib/basquiat/errors.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require 'basquiat/errors/subclass_responsibility'
 require 'basquiat/errors/strategy_not_registered'

data/lib/basquiat/interfaces/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 
 module Basquiat
@@ -11,6 +12,10 @@ module Basquiat
       def descendants
         @descendants ||= []
       end
+
+      def reconfigure_children
+        descendants.each(&:reload_adapter_from_configuration)
+      end
     end
 
     def reload_adapter_from_configuration
@@ -25,7 +30,8 @@ module Basquiat
     def adapter=(adapter_klass)
       @adapter = adapter_klass.new
     end
-    alias_method :event_adapter=, :adapter=
+
+    alias event_adapter= adapter=
 
     def adapter
       @adapter ||= Kernel.const_get(Basquiat.configuration.default_adapter).new

data/lib/basquiat/rails/railtie.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   class Railtie < ::Rails::Railtie
     initializer 'load_basquiat_configuration' do

data/lib/basquiat/support/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'naught'
 require 'erb'
 require 'basquiat/support/hash_refinements'
@@ -15,7 +16,7 @@ module Basquiat
         logger.error do
           { exception: exception, stack_trace: exception.stack_trace, message: message }.to_json
         end
-        fail exception
+        raise exception
       end
     end
 
@@ -70,7 +71,7 @@ module Basquiat
 
     # Used by the railtie. Forces the reconfiguration of all extended classes
     def reload_classes
-      Basquiat::Base.descendants.each(&:reload_adapter_from_configuration)
+      Basquiat::Base.reconfigure_children
     end
 
     private

data/lib/basquiat/support/hash_refinements.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   module HashRefinements
     # @!method deep_merge

data/lib/basquiat/support/json.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Basquiat
   # A simple MultiJson wrapper to protect against eventual API changes.
   module Json

data/lib/basquiat/support.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'basquiat/support/hash_refinements'
 require 'basquiat/support/configuration'
 require 'basquiat/support/json'

data/lib/basquiat/version.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
 # Version file
 module Basquiat
-  VERSION = '1.3.0-1'
+  VERSION = '1.3.0'
 end

data/lib/basquiat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'multi_json'
 require 'naught'
 require 'yaml'
@@ -11,7 +12,7 @@ require 'basquiat/interfaces/base'
 # Overall namespace config class
 module Basquiat
   class << self
-    # resets the gems configuration. Useful for testing and not much else
+    # resets the library configuration. Useful for testing and not much else
     def reset
       @configuration = Configuration.new
     end

data/spec/lib/adapters/base_adapter_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 # Sample class used for testing

data/spec/lib/adapters/base_message_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Basquiat::Adapters::BaseMessage do