waterdrop 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4ab3f673b8b2943b8ccfbc83485c27a5d558944
-  data.tar.gz: c04ab5764bd31e16dc47dcd2ef6ee9126cfdda5c
+  metadata.gz: e75b417b4e1702a407c03a3b09b414c778d22192
+  data.tar.gz: 960675222c4c7e002e3cbfab0803c70d007b7145
 SHA512:
-  metadata.gz: 130283a1fb9ee118ea56f6015873049f7bb8cee383e6b57135115773bd11f366ce8743939006d31a0d809b041664fc781559b2eafac2531db850ea77001e7b51
-  data.tar.gz: 9ea81efb46294f1308ab1cbf99c65eaae6949ca27ae891f549ad16a8d21125cab3d40d985a2ee337d504eda3720d225ebca019eba39f5699a3c3d8df5e5f5819
+  metadata.gz: d1b90f0160aa014f312117a5d275fa3b1630b442693da25ccd807fe3f0f06e37a19ebb91f69ad0ee963370d6c08dca081de56f854f63880b3a9a8bd428cb690c
+  data.tar.gz: c0a933015c71f03b774243a16936dab5f0820578f5e00b1923b10c44dc294bc2e9413bc16b9c92d1cdd08b5e68d83aaf34ed7109315ff7bbfaf6302ecfa04bea

data/.ruby-version

@@ -1 +1 @@
-ruby-2.2.2
+2.2.3

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.1.5
-  - 2.2.2
+  - 2.1.7
+  - 2.2.3
 script:
   - bundle exec rake

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # WaterDrop changelog
 
+## 0.1.5
+- raise_on_failure flag to ignore (if false) that message was not sent
+
+## 0.1.4
+- Renamed WaterDrop::Event to WaterDrop::Message to follow Apache Kafka naming convention
+
 ## 0.1.3
 - Gems cleanup
 - Requirements fix
 
 ## 0.1.2
-
 - Initial gem release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterdrop (0.1.3)
+    waterdrop (0.1.5)
       aspector
       bundler
       connection_pool
@@ -98,7 +98,7 @@ GEM
     origin (2.1.1)
     parser (2.2.2.6)
       ast (>= 1.1, < 3.0)
-    polishgeeks-dev-tools (1.0.0)
+    polishgeeks-dev-tools (1.1.0)
       brakeman
       faker
       haml-lint
@@ -156,7 +156,7 @@ GEM
       reek (= 1.6.3)
       ruby2ruby (>= 2.1.1, < 3.0)
       virtus (~> 1.0)
-    sass (3.4.16)
+    sass (3.4.17)
     sexp_processor (4.6.0)
     shoulda (3.5.0)
       shoulda-context (~> 1.0, >= 1.0.1)
@@ -198,3 +198,6 @@ PLATFORMS
 DEPENDENCIES
   polishgeeks-dev-tools
   waterdrop!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/karafka/waterdrop.png)](https://travis-ci.org/karafka/waterdrop)
 [![Code Climate](https://codeclimate.com/github/karafka/waterdrop/badges/gpa.svg)](https://codeclimate.com/github/karafka/waterdrop)
 
-Gem used to send events to Kafka in a standard and in an aspect way.
+Gem used to send messages to Kafka in a standard and in an aspect way.
 
 ## Installation
 
@@ -27,23 +27,25 @@ bundle install
 
 WaterDrop has following configuration options:
 
-| Option                  | Value type    | Description                    |
-|-------------------------|---------------|--------------------------------|
-| send_events             | Boolean       | Should we send events to Kafka |
-| kafka_host              | String        | Kafka server host              |
-| kafka_ports             | Array<String> | Kafka server ports             |
-| connection_pool_size    | Integer       | Kafka connection pool size     |
-| connection_pool_timeout | Integer       | Kafka connection pool timeout  |
+| Option                  | Value type    | Description                      |
+|-------------------------|---------------|----------------------------------|
+| send_messages           | Boolean       | Should we send messages to Kafka |
+| kafka_host              | String        | Kafka server host                |
+| kafka_ports             | Array<String> | Kafka server ports               |
+| connection_pool_size    | Integer       | Kafka connection pool size       |
+| connection_pool_timeout | Integer       | Kafka connection pool timeout    |
+| raise_on_failure        | Boolean       | Should we raise an exception when we cannot send message to Kafka - if false will silently ignore failures (will just ignore them) |
 
 To apply this configuration, you need to use a *setup* method:
 
 ```ruby
 WaterDrop.setup do |config|
-  config.send_events = true
+  config.send_messages = true
   config.connection_pool_size = 20
   config.connection_pool_timeout = 1
   config.kafka_ports = %w( 9092 )
   config.kafka_host = 'localhost'
+  config.raise_on_failure = true
 end
 ```
 
@@ -51,40 +53,41 @@ This configuration can be placed in *config/initializers* and can vary based on
 
 ```ruby
 WaterDrop.setup do |config|
-  config.send_events = Rails.env.production?
+  config.send_messages = Rails.env.production?
   config.connection_pool_size = 20
   config.connection_pool_timeout = 1
   config.kafka_ports = %w( 9092 )
   config.kafka_host = Rails.env.production? ? 'prod-host' : 'localhost'
+  config.raise_on_failure = Rails.env.production?
 end
 ```
 
 ## Usage
 
-### Creating and sending standard events
+### Creating and sending standard messages
 
-To send Kafka messages, you don't need to use aspects, you can create and send events directly:
+To send Kafka messages, you don't need to use aspects, you can create and send messages directly:
 
 ```ruby
-event = WaterDrop::Event.new('topic', 'message')
-event.send!
+message = WaterDrop::Message.new('topic', 'message')
+message.send!
 ```
 
 message that you want to send should be either castable to string or to json. If it can be casted to both, it will be casted to json.
 
-### Using aspects to handle events
+### Using aspects to handle messages
 
-WaterDrop uses [Aspector](https://github.com/gcao/aspector) to allow aspect oriented events hookup. If you need extensive details about aspector usage, please refer to the [examples](https://github.com/gcao/aspector/tree/master/examples) directory of this project.
+WaterDrop uses [Aspector](https://github.com/gcao/aspector) to allow aspect oriented messages hookup. If you need extensive details about aspector usage, please refer to the [examples](https://github.com/gcao/aspector/tree/master/examples) directory of this project.
 
-In general aspects allows adding additional behavior to existing code without modifying the code itself. This way we can create and send events, without "polluting" the business logic with it.
+In general aspects allows adding additional behavior to existing code without modifying the code itself. This way we can create and send messages, without "polluting" the business logic with it.
 
 All the WaterDrop aspects accept following parameters:
 
-| Option                  | Value type            | Description                                  |
-|-------------------------|-----------------------|----------------------------------------------|
-| ClassName               | Class                 | Class to which we want to hook               |
-| method: :method_name    | Symbol, Array<Symbol> | Method (or methods) to which we want to hook |
-| topic: 'karafka_topic'  | String, Symbol        | Kafka topic to which we will send the event  |
+| Option                  | Value type            | Description                                    |
+|-------------------------|-----------------------|------------------------------------------------|
+| ClassName               | Class                 | Class to which we want to hook                 |
+| method: :method_name    | Symbol, Array<Symbol> | Method (or methods) to which we want to hook   |
+| topic: 'karafka_topic'  | String, Symbol        | Kafka topic to which we will send the message  |
 
 There also a *message*, *after_message* and *before_message* proc parameter that will be evaluated in the methods object context.
 
@@ -105,7 +108,7 @@ now each time before you run:
 ClassName.new.run
 ```
 
-an event with the given message will be send to Kafka.
+a message with the given message will be send to Kafka.
 
 #### After aspects hookup
 
@@ -124,7 +127,7 @@ now each time after you run:
 ClassName.new.run
 ```
 
-an event with the given message will be send to Kafka.
+a message with the given message will be send to Kafka.
 
 #### Around aspects hookup
 
@@ -144,7 +147,7 @@ now each time you run:
 ClassName.new.run
 ```
 
-an event with the given message will be send before and after the method execution.
+a message with the given message will be send before and after the method execution.
 
 ## Note on Patches/Pull Requests
 

data/lib/water_drop/aspects/after_aspect.rb

@@ -12,6 +12,7 @@ module WaterDrop
       after options[:method], interception_arg: true do |interception, result, *args|
         options = interception.options
         interception.aspect.handle(self, options, args, options[:message], result)
+        result
       end
     end
   end

data/lib/water_drop/aspects/around_aspect.rb

@@ -15,6 +15,7 @@ module WaterDrop
         interception.aspect.handle(self, options, args, options[:before_message])
         result = proxy.call(*args, &block)
         interception.aspect.handle(self, options, args, options[:after_message], result)
+        result
       end
     end
   end

data/lib/water_drop/aspects/base_aspect.rb

@@ -17,7 +17,7 @@ module WaterDrop
           instance_run(this, result, message)
         )
 
-        Event.new(options[:topic], formatter.message).send!
+        Message.new(options[:topic], formatter.message).send!
       end
 
       private

data/lib/water_drop/config.rb

@@ -11,14 +11,15 @@ module WaterDrop
     #         if none currently available.
     # @option kafka_ports [Array] the ports of kafka brokers
     # @option kafka_host [String] the host of kafka server
-    # @option send_events [Boolean] boolean value to define whether events should be sent
-    #
+    # @option send_messages [Boolean] boolean value to define whether messages should be sent
+    # @option raise_on_failure [Boolean] Should raise error when failed to deliver a message
     OPTIONS = %i(
       connection_pool_size
       connection_pool_timeout
       kafka_ports
       kafka_host
-      send_events
+      send_messages
+      raise_on_failure
     )
 
     OPTIONS.each do |attr_name|

data/lib/water_drop/message.rb

@@ -0,0 +1,41 @@
+module WaterDrop
+  # Message class which encapsulate single Kafka message logic and its delivery
+  class Message
+    attr_reader :topic, :message
+
+    # we ignore this types of errors if ::WaterDrop.config.raise_on_failure?
+    # is set to false
+    CATCHED_ERRORS = [
+      Poseidon::Errors::UnableToFetchMetadata
+    ]
+
+    # @param topic [String, Symbol] a topic to which we want to send a message
+    # @param message [Object] any object that can be serialized to a JSON string or
+    #   that can be casted to a string
+    # @return [WaterDrop::Message] WaterDrop message instance
+    # @example Creating a new message
+    #   WaterDrop::Message.new(topic, message)
+    def initialize(topic, message)
+      @topic = topic.to_s
+      @message = message.respond_to?(:to_json) ? message.to_json : message.to_s
+    end
+
+    # Sents a current message to Kafka
+    # @note Won't send any messages if send_messages config flag is set to false
+    # @example Set a message
+    #   WaterDrop::Message.new(topic, message).send!
+    def send!
+      return true unless ::WaterDrop.config.send_messages?
+
+      Pool.with do |producer|
+        producer.send_messages([
+          Poseidon::MessageToSend.new(topic, message)
+        ])
+      end
+    rescue *CATCHED_ERRORS => e
+      # Reraise if we want to raise on failure
+      # Ignore if we dont want to know that something went wrong
+      raise(e) if ::WaterDrop.config.raise_on_failure?
+    end
+  end
+end

data/lib/water_drop/pool.rb

@@ -1,5 +1,5 @@
 module WaterDrop
-  # Raw poseidon connection pool for WaterDrop events delivery
+  # Raw poseidon connection pool for WaterDrop messages delivery
   module Pool
     extend SingleForwardable
     # Delegate directly to pool

data/lib/water_drop/version.rb

@@ -1,5 +1,5 @@
 # WaterDrop library
 module WaterDrop
   # Current WaterDrop version
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/lib/waterdrop.rb

@@ -13,15 +13,14 @@
 ).each { |lib| require lib }
 
 # Internal components
-
 base_path = File.dirname(__FILE__) + '/water_drop'
 
 %w(
   version
   pool
   config
-  event
   logger
+  message
   aspects/base_aspect
   aspects/formatter
   aspects/after_aspect

data/waterdrop.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Maciej Mensfeld', 'Pavlo Vavruk']
   spec.email         = %w( maciej@mensfeld.pl pavlo.vavruk@gmail.com )
   spec.homepage      = 'https://github.com/karafka/waterdrop'
-  spec.summary       = %q{ Kafka events with aspects made easy! }
+  spec.summary       = %q{ Kafka messages with aspects made easy! }
   spec.description   = spec.summary
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Kafka events with aspects made easy!
+description: Kafka messages with aspects made easy!
 email:
 - maciej@mensfeld.pl
 - pavlo.vavruk@gmail.com
@@ -105,8 +105,8 @@ files:
 - lib/water_drop/aspects/before_aspect.rb
 - lib/water_drop/aspects/formatter.rb
 - lib/water_drop/config.rb
-- lib/water_drop/event.rb
 - lib/water_drop/logger.rb
+- lib/water_drop/message.rb
 - lib/water_drop/pool.rb
 - lib/water_drop/version.rb
 - lib/waterdrop.rb
@@ -131,9 +131,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Kafka events with aspects made easy!
+summary: Kafka messages with aspects made easy!
 test_files: []
 has_rdoc: 

data/lib/water_drop/event.rb

@@ -1,31 +0,0 @@
-module WaterDrop
-  # Event module which encapsulate single Kafka event logic and its delivery
-  class Event
-    attr_reader :topic, :message
-
-    # @param topic [String, Symbol] a topic to which we want to send a message
-    # @param message [Object] any object that can be serialized to a JSON string or
-    #   that can be casted to a string
-    # @return [WaterDrop::Event] WaterDrop event instance
-    # @example Creating a new event
-    #   WaterDrop::Event.new(topic, message)
-    def initialize(topic, message)
-      @topic = topic.to_s
-      @message = message.respond_to?(:to_json) ? message.to_json : message.to_s
-    end
-
-    # Sents a current event to Kafka
-    # @note Won't send any events if send_events config flag is set to false
-    # @example Set a message
-    #   WaterDrop::Event.new(topic, message).send!
-    def send!
-      return true unless ::WaterDrop.config.send_events?
-
-      Pool.with do |producer|
-        producer.send_messages([
-          Poseidon::MessageToSend.new(topic, message)
-        ])
-      end
-    end
-  end
-end