waterdrop 1.4.0

data/lib/water_drop/contracts/message_options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Contracts
+    # Contract with validation rules for validating that all the message options that
+    # we provide to producer ale valid and usable
+    # @note Does not validate message itself as it is not our concern
+    class MessageOptions < Dry::Validation::Contract
+      params do
+        required(:topic).filled(:str?, format?: TOPIC_REGEXP)
+        optional(:key).maybe(:str?, :filled?)
+        optional(:partition).filled(:int?, gteq?: 0)
+        optional(:partition_key).maybe(:str?, :filled?)
+        optional(:create_time).maybe(:time?)
+        optional(:headers).maybe(:hash?)
+      end
+    end
+  end
+end

data/lib/water_drop/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # Namespace used to encapsulate all the internal errors of WaterDrop
+  module Errors
+    # Base class for all the WaterDrop internal errors
+    BaseError = Class.new(StandardError)
+
+    # Raised when configuration doesn't match with validation contract
+    InvalidConfiguration = Class.new(BaseError)
+
+    # Raised when we try to send message with invalid options
+    InvalidMessageOptions = Class.new(BaseError)
+
+    # Raised when want to hook up to an event that is not registered and supported
+    UnregisteredMonitorEvent = Class.new(BaseError)
+  end
+end

data/lib/water_drop/instrumentation/monitor.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # Namespace for all the things related with WaterDrop instrumentation process
+  module Instrumentation
+    # Monitor is used to hookup external monitoring services to monitor how WaterDrop works
+    # Since it is a pub-sub based on dry-monitor, you can use as many subscribers/loggers at the
+    # same time, which means that you might have for example file logging and NewRelic at the same
+    # time
+    # @note This class acts as a singleton because we are only permitted to have single monitor
+    #   per running process (just as logger)
+    class Monitor < Dry::Monitor::Notifications
+      # List of events that we support in the system and to which a monitor client can hook up
+      # @note The non-error once support timestamp benchmarking
+      BASE_EVENTS = %w[
+        async_producer.call.error
+        async_producer.call.retry
+        sync_producer.call.error
+        sync_producer.call.retry
+      ].freeze
+
+      private_constant :BASE_EVENTS
+
+      # @return [WaterDrop::Instrumentation::Monitor] monitor instance for system instrumentation
+      def initialize
+        super(:waterdrop)
+        BASE_EVENTS.each(&method(:register_event))
+      end
+
+      # Allows us to subscribe to events with a code that will be yielded upon events
+      # @param event_name_or_listener [String, Object] name of the event we want to subscribe to
+      #   or a listener if we decide to go with object listener
+      def subscribe(event_name_or_listener)
+        return super unless event_name_or_listener.is_a?(String)
+        return super if available_events.include?(event_name_or_listener)
+
+        raise Errors::UnregisteredMonitorEvent, event_name_or_listener
+      end
+
+      # @return [Array<String>] names of available events to which we can subscribe
+      def available_events
+        __bus__.events.keys
+      end
+    end
+  end
+end

data/lib/water_drop/instrumentation/stdout_listener.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Instrumentation
+    # Default listener that hooks up to our instrumentation and uses its events for logging
+    # It can be removed/replaced or anything without any harm to the Waterdrop flow
+    # @note It is a module as we can use it then as a part of the Karafka framework listener
+    #   as well as we can use it standalone
+    class StdoutListener
+      # Log levels that we use in this particular listener
+      USED_LOG_LEVELS = %i[
+        info
+        error
+      ].freeze
+
+      %i[
+        sync_producer
+        async_producer
+      ].each do |producer_type|
+        error_name = :"on_#{producer_type}_call_error"
+        retry_name = :"on_#{producer_type}_call_retry"
+
+        define_method error_name do |event|
+          options = event[:options]
+          error = event[:error]
+          error "Delivery failure to: #{options} because of #{error}"
+        end
+
+        define_method retry_name do |event|
+          attempts_count = event[:attempts_count]
+          options = event[:options]
+          error = event[:error]
+
+          info "Attempt #{attempts_count} of delivery to: #{options} because of #{error}"
+        end
+      end
+
+      USED_LOG_LEVELS.each do |log_level|
+        define_method log_level do |*args|
+          WaterDrop.logger.send(log_level, *args)
+        end
+      end
+    end
+  end
+end

data/lib/water_drop/sync_producer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# WaterDrop library
+module WaterDrop
+  # Sync producer for messages
+  class SyncProducer < BaseProducer
+    # Performs message delivery using deliver_async method
+    # @param message [String] message that we want to send to Kafka
+    # @param options [Hash] options (including topic) for producer
+    # @raise [WaterDrop::Errors::InvalidMessageOptions] raised when message options are
+    #   somehow invalid and we cannot perform delivery because of that
+    def self.call(message, options)
+      attempts_count ||= 0
+      attempts_count += 1
+
+      validate!(options)
+      return unless WaterDrop.config.deliver
+
+      DeliveryBoy.deliver(message, options)
+    rescue Kafka::Error => e
+      graceful_attempt?(attempts_count, message, options, e) ? retry : raise(e)
+    end
+  end
+end

data/lib/water_drop/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# WaterDrop library
+module WaterDrop
+  # Current WaterDrop version
+  VERSION = '1.4.0'
+end

data/lib/waterdrop.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# This file is used as a compatibility step
+require 'water_drop'

data/waterdrop.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'water_drop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'waterdrop'
+  spec.version       = ::WaterDrop::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Maciej Mensfeld']
+  spec.email         = %w[maciej@mensfeld.pl]
+  spec.homepage      = 'https://github.com/karafka/waterdrop'
+  spec.summary       = 'Kafka messaging made easy!'
+  spec.description   = spec.summary
+  spec.license       = 'MIT'
+
+  spec.add_dependency 'delivery_boy', '>= 0.2', '< 2.x'
+  spec.add_dependency 'dry-configurable', '~> 0.8'
+  spec.add_dependency 'dry-monitor', '~> 0.3'
+  spec.add_dependency 'dry-validation', '~> 1.2'
+  spec.add_dependency 'ruby-kafka', '>= 0.7.8'
+  spec.add_dependency 'zeitwerk', '~> 2.1'
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  if $PROGRAM_NAME.end_with?('gem')
+    spec.signing_key = File.expand_path('~/.ssh/gem-private_key.pem')
+  end
+
+  spec.cert_chain    = %w[certs/mensfeld.pem]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: waterdrop
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Maciej Mensfeld
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhtYWNp
+  ZWovREM9bWVuc2ZlbGQvREM9cGwwHhcNMjAwODExMDkxNTM3WhcNMjEwODExMDkx
+  NTM3WjAjMSEwHwYDVQQDDBhtYWNpZWovREM9bWVuc2ZlbGQvREM9cGwwggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDCpXsCgmINb6lHBXXBdyrgsBPSxC4/
+  2H+weJ6L9CruTiv2+2/ZkQGtnLcDgrD14rdLIHK7t0o3EKYlDT5GhD/XUVhI15JE
+  N7IqnPUgexe1fbZArwQ51afxz2AmPQN2BkB2oeQHXxnSWUGMhvcEZpfbxCCJH26w
+  hS0Ccsma8yxA6hSlGVhFVDuCr7c2L1di6cK2CtIDpfDaWqnVNJEwBYHIxrCoWK5g
+  sIGekVt/admS9gRhIMaIBg+Mshth5/DEyWO2QjteTodItlxfTctrfmiAl8X8T5JP
+  VXeLp5SSOJ5JXE80nShMJp3RFnGw5fqjX/ffjtISYh78/By4xF3a25HdWH9+qO2Z
+  tx0wSGc9/4gqNM0APQnjN/4YXrGZ4IeSjtE+OrrX07l0TiyikzSLFOkZCAp8oBJi
+  Fhlosz8xQDJf7mhNxOaZziqASzp/hJTU/tuDKl5+ql2icnMv5iV/i6SlmvU29QNg
+  LCV71pUv0pWzN+OZbHZKWepGhEQ3cG9MwvkCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFImGed2AXS070ohfRidiCEhXEUN+MB0GA1Ud
+  EQQWMBSBEm1hY2llakBtZW5zZmVsZC5wbDAdBgNVHRIEFjAUgRJtYWNpZWpAbWVu
+  c2ZlbGQucGwwDQYJKoZIhvcNAQELBQADggGBAKiHpwoENVrMi94V1zD4o8/6G3AU
+  gWz4udkPYHTZLUy3dLznc/sNjdkJFWT3E6NKYq7c60EpJ0m0vAEg5+F5pmNOsvD3
+  2pXLj9kisEeYhR516HwXAvtngboUcb75skqvBCU++4Pu7BRAPjO1/ihLSBexbwSS
+  fF+J5OWNuyHHCQp+kGPLtXJe2yUYyvSWDj3I2//Vk0VhNOIlaCS1+5/P3ZJThOtm
+  zJUBI7h3HgovwRpcnmk2mXTmU4Zx/bCzX8EA6VY0khEvnmiq7S6eBF0H9qH8KyQ6
+  EkVLpvmUDFcf/uNaBQdazEMB5jYtwoA8gQlANETNGPi51KlkukhKgaIEDMkBDJOx
+  65N7DzmkcyY0/GwjIVIxmRhcrCt1YeCUElmfFx0iida1/YRm6sB2AXqScc1+ECRi
+  2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
+  nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
+  -----END CERTIFICATE-----
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delivery_boy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.x
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dry-monitor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.8
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Kafka messaging made easy!
+email:
+- maciej@mensfeld.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coditsu/ci.yml"
+- ".github/FUNDING.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENCE
+- README.md
+- certs/mensfeld.pem
+- config/errors.yml
+- lib/water_drop.rb
+- lib/water_drop/async_producer.rb
+- lib/water_drop/base_producer.rb
+- lib/water_drop/config.rb
+- lib/water_drop/config_applier.rb
+- lib/water_drop/contracts.rb
+- lib/water_drop/contracts/config.rb
+- lib/water_drop/contracts/message_options.rb
+- lib/water_drop/errors.rb
+- lib/water_drop/instrumentation/monitor.rb
+- lib/water_drop/instrumentation/stdout_listener.rb
+- lib/water_drop/sync_producer.rb
+- lib/water_drop/version.rb
+- lib/waterdrop.rb
+- log/.gitkeep
+- waterdrop.gemspec
+homepage: https://github.com/karafka/waterdrop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Kafka messaging made easy!
+test_files: []