rabbit_feed 2.3.10 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b141fd052af473176629d66db5d86963fe4c403
-  data.tar.gz: 38f362690f98f836cab2caef5fad99a4a8bca27a
+  metadata.gz: b027daa2e82c9b3cca12bcec5df1cf82a9d27eec
+  data.tar.gz: a95205ed61bfc7a16b7a6fd2f5e6f33f1f4bf8f3
 SHA512:
-  metadata.gz: 88e147ca7b35bf34bb703b9041eb94cbe9d4042e38df8742c55fbea6091c3e2575a64e04214ebe9010a42ae514d60fc1f2c84e6b9a46a4ad6190889722c6141a
-  data.tar.gz: 30e4acb794167f0d505b65a3f64363f8b66f88ed6ddb77fd1d1b61aed121f44d355f5fe92576880029bc39f364dbbe26c7b378df3f478f4894f861ed0713a34e
+  metadata.gz: 2ac970507750197992c5fed39203a12073e0e7ac4a0cce6fe35b5363f6bbc3a52e39c3545601e3d596655378771ec689200eeda0a0de265cf442490d5e44b6dd
+  data.tar.gz: 18949fc9dc50a089032465ddf03b293ef4b759d05cd17bcd2a19afa46a86948812cd08fb52aa21b251939bf52ac5bb4f0a047bbd6e49172be6ead5200756d838

data/README.md

@@ -270,6 +270,38 @@ Starts a consumer. Note: until you've specified the [event routing](https://gith
 
 _This only applies if you've started the consumer with the `--daemon` option._
 
+### Console Consumer
+
+    bundle exec bin/rabbit_feed console --environment development --config spec/fixtures/configuration.yml --logfile development.log --pidfile rabbit_feed.pid --verbose
+
+The console consumer will accept any event from any application and will print the event metadata and payload to the console. This is useful during development to get instant feedback on the events being published.
+
+#### Example Console Output
+
+```
+RabbitFeed console starting at 2016-02-08 16:22:22 UTC...
+Environment: development
+Queue: development.rabbit_feed_console
+There are currently 4 message(s) in the console's queue.
+Would you like to purge the queue before proceeding? (y/N)>
+n
+Ready. Press CTRL+C to exit.
+----------------------------user_creates_beaver: 2016-02-08 16:19:30 UTC----------------------------
+#Event metadata
+application: rails_app
+created_at_utc: 2016-02-08T16:19:30.530210Z
+environment: development
+host: localhost
+name: user_creates_beaver
+schema_version: 2.0.0
+version: 1.0.0
+****************************************************************************************************
+#Event payload
+beaver_name: 02/08/16 16:19:30
+----------------------------------------------------------------------------------------------------
+1 events received.
+```
+
 ## Event Definitions DSL
 
 Provides a means to define all events that are published by an application. Defines the event names and the payload associated with each event. The DSL is converted into a schema that is serialized along with the event payload, meaning the events are self-describing. This is accomplished using Apache [Avro](http://avro.apache.org/docs/current/). This also validates the event payload against its schema before it is published.

data/Rakefile

@@ -6,12 +6,12 @@ task :default => [:all]
 
 desc 'Run specs and features'
 RSpec::Core::RakeTask.new(:all) do |t|
-  t.pattern = './spec/{**/*_spec.rb,features/**/*.feature}'
+  t.pattern = "spec/{**/*_spec.rb,features/**/*.feature}"
 end
 
 desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = './spec/{**/*_spec.rb}'
+  t.pattern = "spec/**/*_spec.rb"
 end
 
 def gemspec

data/example/non_rails_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../
   specs:
-    rabbit_feed (2.3.10)
+    rabbit_feed (2.4.0)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)
@@ -59,4 +59,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/example/rails_app/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../../
   specs:
-    rabbit_feed (2.3.10)
+    rabbit_feed (2.4.0)
       activemodel (>= 3.2.0, < 5.0.0)
       activesupport (>= 3.2.0, < 5.0.0)
       avro (>= 1.5.4, < 1.8.0)
@@ -189,4 +189,4 @@ DEPENDENCIES
   unicorn
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/lib/rabbit_feed/client.rb

@@ -16,10 +16,10 @@ module RabbitFeed
 
     attr_reader :command, :options
     validates_presence_of :command, :options
-    validates :command, inclusion: { in: %w(consume produce shutdown), message: "%{value} is not a valid command" }
+    validates :command, inclusion: { in: %w(consume produce shutdown console), message: "%{value} is not a valid command" }
     validate :log_file_path_exists
     validate :config_file_exists
-    validate :require_path_valid
+    validate :require_path_valid, unless: :console?
     validate :pidfile_path_exists, if: :daemonize?
     validate :environment_specified
 
@@ -32,7 +32,7 @@ module RabbitFeed
 
         set_logging
         set_configuration
-        load_dependancies
+        load_dependancies unless console?
       end
     end
 
@@ -73,6 +73,12 @@ module RabbitFeed
       RabbitFeed::Consumer.run
     end
 
+    def console
+      require_relative 'console_consumer'
+      ConsoleConsumer.init
+      consume
+    end
+
     def shutdown
       `kill -TERM #{pid}`
     end
@@ -127,6 +133,10 @@ module RabbitFeed
       options[:daemon]
     end
 
+    def console?
+      command == 'console'
+    end
+
     def verbose?
       options[:verbose]
     end

data/lib/rabbit_feed/console_consumer.rb

@@ -0,0 +1,119 @@
+module RabbitFeed
+  module ConsoleConsumer
+    extend self
+
+    APPLICATION_NAME = 'rabbit_feed_console'
+
+    def init
+      @event_count = 0
+      set_application
+      route_all_events
+      puts welcome_message
+      ask_to_purge_queue unless queue_empty?
+      puts "Ready. Press CTRL+C to exit."
+    end
+
+    def formatted event
+      Formatter.new(event).to_s
+    end
+
+    def event_count_message
+      "#{@event_count} events received."
+    end
+
+    def increment_event_count
+      @event_count += 1
+    end
+
+    private
+
+    def welcome_message
+"""RabbitFeed console starting at #{Time.now.utc}...
+Environment: #{RabbitFeed.environment}
+Queue: #{RabbitFeed.configuration.queue}
+"""
+    end
+
+    def queue_empty?
+      ConsumerConnection.instance.queue_depth.zero?
+    end
+
+    def ask_to_purge_queue
+      puts "There are currently #{ConsumerConnection.instance.queue_depth} message(s) in the console's queue.\n"+
+      "Would you like to purge the queue before proceeding? (y/N)>"
+      response = STDIN.gets.chomp
+      purge_queue if response == 'y'
+    end
+
+    def purge_queue
+      ConsumerConnection.instance.purge_queue
+      puts "Queue purged."
+    end
+
+    def route_all_events
+      scope = self
+      EventRouting do
+        accept_from(:any) do
+          event(:any) do |event|
+            scope.increment_event_count
+            puts (scope.formatted event)
+            puts scope.event_count_message
+          end
+        end
+      end
+    end
+
+    def set_application
+      RabbitFeed.application = APPLICATION_NAME
+    end
+
+    class Formatter
+
+      BORDER_WIDTH = 100
+      BORDER_CHAR  = "-"
+      DIVIDER_CHAR = "*"
+      NEWLINE      = "\n"
+
+      attr_reader :event
+
+      def initialize event
+        @event = event
+      end
+
+      def to_s
+        [header, metadata, divider, payload, footer].join(NEWLINE)
+      end
+
+      private
+
+      def header
+        event_detail = "#{event.name}: #{event.created_at_utc}"
+        border_filler = BORDER_CHAR*((BORDER_WIDTH - event_detail.length)/2)
+        border_filler+event_detail+border_filler
+      end
+
+      def footer
+        BORDER_CHAR*BORDER_WIDTH
+      end
+
+      def metadata
+        pretty_print_hash 'Event metadata', event.metadata
+      end
+
+      def divider
+        DIVIDER_CHAR*BORDER_WIDTH
+      end
+
+      def payload
+        pretty_print_hash 'Event payload', event.payload
+      end
+
+      def pretty_print_hash description, hash
+        '#' + description + NEWLINE +
+        hash.keys.sort.map do |key|
+          "#{key}: #{hash[key]}"
+        end.join(NEWLINE)
+      end
+    end
+  end
+end

data/lib/rabbit_feed/consumer_connection.rb

@@ -45,6 +45,14 @@ module RabbitFeed
       end
     end
 
+    def queue_depth
+      @queue.message_count
+    end
+
+    def purge_queue
+      @queue.purge
+    end
+
     private
 
     attr_reader :queue

data/lib/rabbit_feed/version.rb

@@ -1,3 +1,3 @@
 module RabbitFeed
-  VERSION = '2.3.10'
+  VERSION = '2.4.0'
 end

data/spec/fixtures/configuration.yml

@@ -1,3 +1,10 @@
+development:
+  host: localhost
+  port: 5672
+  user: guest
+  password: guest
+  application: rabbit_feed
+  auto_delete_queue: false
 test:
   host: localhost
   port: 5672

data/spec/lib/rabbit_feed/console_consumer_spec.rb

@@ -0,0 +1,60 @@
+require 'rabbit_feed/console_consumer'
+
+module RabbitFeed
+  describe ConsoleConsumer do
+    let(:purge) { 'n' }
+    let(:queue_depth) { 0 }
+    let(:connection) { double(:connection, queue_depth: queue_depth) }
+    before do
+      allow(ConsumerConnection).to receive(:instance).and_return(connection)
+      allow(STDIN).to receive(:gets).and_return(purge)
+    end
+
+    describe '#init' do
+
+      it 'prints a welcome message' do
+        expect{ subject.init }.to output(
+/RabbitFeed console starting at .* UTC\.\.\.
+Environment: test
+Queue: test\.rabbit_feed_console
+Ready\. Press CTRL\+C to exit\./).to_stdout
+      end
+
+      context 'when there are events on the rabbit_feed_console queue' do
+        let(:queue_depth) { 1 }
+
+        it 'asks to purge the queue' do
+          expect{ subject.init }.to output(
+/There are currently 1 message\(s\) in the console's queue\.
+Would you like to purge the queue before proceeding\? \(y\/N\)>/).to_stdout
+        end
+
+        context 'when the user wishes to purge the queue' do
+          let(:purge) { 'y' }
+
+          it 'purges the queue' do
+            expect(connection).to receive(:purge_queue)
+            expect{ subject.init }.to output(/Queue purged\./).to_stdout
+          end
+        end
+      end
+    end
+
+    describe 'receiving an event' do
+      let(:event) { Event.new({name: 'name'},{key: :value}) }
+      before { subject.init }
+
+      it 'prints the event' do
+        expect{ rabbit_feed_consumer.consume_event event }.to output(
+/-----------------------------------------------name: -----------------------------------------------
+#Event metadata
+name: name
+(\*)+
+#Event payload
+key: value
+----------------------------------------------------------------------------------------------------
+1 events received\./).to_stdout
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -31,7 +31,8 @@ RSpec.configure do |config|
   end
 
   config.after(connectivity: true) do
-    Thread.kill @consumer_thread if @consumer_thread.present?
+    @consumer_thread.kill if @consumer_thread.present?
+    @consumer_thread.join if @consumer_thread.present?
   end
 
   RabbitFeed::TestingSupport.include_support config
@@ -39,6 +40,7 @@ end
 
 def reset_environment
   RabbitFeed.log                         = RabbitFeed.default_logger
+  RabbitFeed.application                 = nil
   RabbitFeed.environment                 = 'test'
   RabbitFeed.configuration_file_path     = 'spec/fixtures/configuration.yml'
   RabbitFeed.instance_variable_set('@configuration', nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_feed
 version: !ruby/object:Gem::Version
-  version: 2.3.10
+  version: 2.4.0
 platform: ruby
 authors:
 - Simply Business
@@ -313,6 +313,7 @@ files:
 - lib/rabbit_feed/client.rb
 - lib/rabbit_feed/configuration.rb
 - lib/rabbit_feed/connection.rb
+- lib/rabbit_feed/console_consumer.rb
 - lib/rabbit_feed/consumer.rb
 - lib/rabbit_feed/consumer_connection.rb
 - lib/rabbit_feed/event.rb
@@ -337,6 +338,7 @@ files:
 - spec/fixtures/configuration.yml
 - spec/lib/rabbit_feed/client_spec.rb
 - spec/lib/rabbit_feed/configuration_spec.rb
+- spec/lib/rabbit_feed/console_consumer_spec.rb
 - spec/lib/rabbit_feed/consumer_connection_spec.rb
 - spec/lib/rabbit_feed/event_definitions_spec.rb
 - spec/lib/rabbit_feed/event_routing_spec.rb
@@ -377,6 +379,7 @@ test_files:
 - spec/fixtures/configuration.yml
 - spec/lib/rabbit_feed/client_spec.rb
 - spec/lib/rabbit_feed/configuration_spec.rb
+- spec/lib/rabbit_feed/console_consumer_spec.rb
 - spec/lib/rabbit_feed/consumer_connection_spec.rb
 - spec/lib/rabbit_feed/event_definitions_spec.rb
 - spec/lib/rabbit_feed/event_routing_spec.rb