eventboss 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c36cbbb5b46f114db4b05ca721ca4bbb54e0181c100c37a9897138f25b73ed4e
+  data.tar.gz: f720663f6c690177681bd7f22cd82cba6482778085335865cff901b1fc70ed12
+SHA512:
+  metadata.gz: a3cedeaf4620288d2055c3af2349f7f532d2226063d66982e8bef3c85f26cfe9b4c1533baa05e30cb9380e1b901682b8d3f798441174dafbc3715e433701e40f
+  data.tar.gz: 01ce03e3a310998d5376741920bb2660306ecdf25f7daa0e3151f01dd14056f56bf2942954e51e5ff6e53e87ef6b8ad8adecc9140615ac431e0fb356dd07cdd3

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    eventboss (1.0.0)
+      aws-sdk-sns (>= 1.1.0)
+      aws-sdk-sqs (>= 1.3.0)
+      concurrent-ruby (~> 1.0, >= 1.0.5)
+      dotenv (~> 2.1, >= 2.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.0.3)
+    aws-partitions (1.161.0)
+    aws-sdk-core (3.51.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-sns (1.13.0)
+      aws-sdk-core (~> 3, >= 3.48.2)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-sqs (1.13.0)
+      aws-sdk-core (~> 3, >= 3.48.2)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.1.0)
+      aws-eventstream (~> 1.0, >= 1.0.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dotenv (2.7.2)
+    jmespath (1.4.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  eventboss!
+  rake (>= 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/Guardfile

@@ -0,0 +1,4 @@
+guard 'rspec', cmd: 'bundle exec rspec --color' do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/(.*)_spec\.rb|)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 AirHelp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# Eventboss
+
+Eventboss ruby client.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventboss'
+```
+
+## Usage
+
+Run the listener by:
+```
+bundle exec eventboss
+```
+it will read conf values from ENV variables in configuration sections.
+
+### Broadcasting events:
+
+```ruby
+publisher = Eventboss.publisher(event_name)
+publisher.publish(payload)
+```
+
+### Unicasting events in batches: (via SQS)
+
+```ruby
+sender = Eventboss.sender(event_name, destination_app)
+sender.send_batch([payload1, payload2])
+```
+
+Receiving events via listeners:
+
+```ruby
+class AnyName
+  include Eventboss::Listener
+  eventboss_options source_app: 'src_app_name', event_name: 'my_event'
+
+  def receive(payload)
+  end
+end
+```
+
+
+## Configuration
+
+By default, no exception will be raised when publisher configuration is missing (`eventboss_region`,
+`eventboss_account_id`, `eventboss_app_name`). This can lead to false-positive specs, app not working without exceptions on dev/stg/prod environment. It's strongly advised to set `raise_on_missing_configuration` to true.
+
+Using `.configure`:
+
+```ruby
+Eventboss.configure do |config|
+  config.raise_on_missing_configuration = true
+  config.eventboss_account_id = 1234567
+  config.eventboss_app_name = name
+  config.eventboss_region = aws_region
+  config.concurrency = 10
+  # when using custom clients like localstack
+  config.sns_client = client # Custom SNS Client can be used, i.e. to use local mock, see: https://github.com/phstc/shoryuken/wiki/Using-a-local-mock-SQS-server
+  config.sqs_client = Aws::SQS::Client.new(endpoint: 'http://localstack:4576', region: 'us-east-1', credentials: Aws::Credentials.new('fake', 'fake'))
+end
+```
+
+Using ENVs:
+
+```
+EVENTBUS_ACCOUNT_ID=12345676
+EVENTBUS_APP_NAME=application_name
+EVENTBUS_ENV=env_name # production/staging/test
+EVENTBUS_REGION=aws_region # i.e. eu-west-1
+EVENTBUS_CONCURRENCY=10 # default is 25
+
+AWS_SNS_ENDPOINT=http://localhost:4575 # when using with localstack
+AWS_SQS_ENDPOINT=http://localhost:4576 # when using with localstack
+```
+
+### Logging and error handling
+To have more verbose logging, set `log_level` in configuration (default is `info`).
+
+Logger is used as default error handler. There is Airbrake handler available, to use it ensure you have `airbrake` or `airbrake-ruby` gem and add it to error handlers stack:
+
+```ruby
+Eventboss.configure do |config|
+  config.error_handlers << Eventboss::ErrorHandlers::Airbrake.new
+end
+```
+
+### Polling strategy
+
+Default is `Eventboss::Polling::Basic`. See `eventboss/polling/*` for other options. The configuration should be a `lambda` like so:
+
+```ruby
+Eventboss.configure do |config|
+  config.polling_strategy = lambda { |queues| Eventboss::Polling::TimedRoundRobin.new(queues) }
+end
+```
+
+## Topics & Queues naming convention
+
+The SNSes should be name in the following pattern:
+```
+eventboss-{src_app_name}-{event_name}-{environment}
+```
+
+i.e.
+```
+eventboss-srcapp-transaction_change-staging
+```
+
+The corresponding SQSes should be name like:
+```
+{dest_app_name}-eventboss-{src_app_name}-{event_name}-{environment}
+{dest_app_name}-eventboss-{src_app_name}-{event_name}-{environment}-deadletter
+```
+i.e.
+```
+destapp-eventboss-srcapp-transaction_change-staging
+destapp-eventboss-srcapp-transaction_change-staging-deadletter
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AirHelp/eventboss.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/eventboss

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'dotenv'
+require 'eventboss'
+require 'optparse'
+
+Dotenv.load
+
+STDOUT.sync = true
+options = {}
+
+OptionParser.new do |parser|
+  parser.on('-r', '--require LIBRARY', 'Require custom app entrypoint') do |lib|
+    options[:require] = lib
+  end
+end.parse!
+
+begin
+  logger = Eventboss::Logger
+
+  require 'rails'
+  logger.debug('Loading rails...')
+  if ::Rails::VERSION::MAJOR < 4
+    require File.expand_path('config/environment.rb')
+  else
+    require File.expand_path('config/application.rb')
+    require File.expand_path('config/environment.rb')
+  end
+  ::Rails.application.eager_load!
+rescue LoadError
+  logger.debug('Seems like not a Rails app')
+
+  if options[:require].nil?
+    logger.warn('Please use -r to load a custom app entrypoint')
+    exit(0)
+  else
+    logger.debug("Loading #{options[:require]}")
+    require File.expand_path(options[:require])
+  end
+end
+
+logger.info('Starting eventboss...')
+logger.info('Active Listeners:')
+logger.info(Eventboss::QueueListener.list.to_s)
+
+Eventboss.launch

data/eventboss.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventboss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventboss"
+  spec.version       = Eventboss::VERSION
+  spec.authors       = ["AirHelp"]
+  spec.email         = ["marcin.naglik@airhelp.com"]
+
+  spec.summary       = %q{Eventboss Ruby Client.}
+  spec.description   = %q{Eventboss Ruby Client.}
+  spec.homepage      = "https://airhelp.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = ["eventboss"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "concurrent-ruby", "~> 1.0", ">= 1.0.5"
+  spec.add_dependency "aws-sdk-sqs", ">= 1.3.0"
+  spec.add_dependency "aws-sdk-sns", ">= 1.1.0"
+  spec.add_dependency "dotenv", "~> 2.1", ">= 2.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/eventboss.rb

@@ -0,0 +1,79 @@
+require 'aws-sdk-sqs'
+require 'aws-sdk-sns'
+require 'concurrent'
+require 'securerandom'
+
+require 'eventboss/version'
+require 'eventboss/configuration'
+require 'eventboss/instrumentation'
+require 'eventboss/sns_client'
+require 'eventboss/queue'
+require 'eventboss/queue_listener'
+require 'eventboss/listener'
+require 'eventboss/logging'
+require 'eventboss/safe_thread'
+require 'eventboss/launcher'
+require 'eventboss/long_poller'
+require 'eventboss/unit_of_work'
+require 'eventboss/worker'
+require 'eventboss/fetcher'
+require 'eventboss/publisher'
+require 'eventboss/sender'
+require 'eventboss/manager'
+require 'eventboss/runner'
+require 'eventboss/logger'
+require 'eventboss/polling/basic'
+require 'eventboss/polling/timed_round_robin'
+require 'eventboss/extensions'
+
+# For Rails use railtie, for plain Ruby apps use custom scripts loader
+if defined?(Rails)
+  require 'eventboss/railtie'
+else
+  require 'eventboss/scripts'
+end
+
+module Eventboss
+  Shutdown = Class.new(StandardError)
+
+  class << self
+    def publisher(event_name, opts = {})
+      Publisher.new(event_name, configuration.sns_client, configuration, opts)
+    end
+
+    def sender(event_name, destination_app, options = {})
+      queue_name = Queue.build_name(
+        destination: destination_app,
+        source: configuration.eventboss_app_name,
+        event: event_name,
+        env: env,
+        generic: options[:generic]
+      )
+
+      Sender.new(
+        client: configuration.sqs_client,
+        queue: Queue.new(queue_name)
+      )
+    end
+
+    def listen
+      Eventboss::Runner.start
+    end
+
+    def launch
+      Eventboss::Runner.launch
+    end
+
+    def env
+      @env ||= ENV['EVENTBUS_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
+    end
+
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @_configuration ||= Configuration.new
+    end
+  end
+end

data/lib/eventboss/configuration.rb

@@ -0,0 +1,104 @@
+module Eventboss
+  class Configuration
+    attr_writer :raise_on_missing_configuration,
+                :error_handlers,
+                :concurrency,
+                :log_level,
+                :sns_client,
+                :sqs_client,
+                :eventboss_region,
+                :eventboss_app_name,
+                :eventboss_account_id,
+                :aws_access_key_id,
+                :aws_secret_access_key,
+                :polling_strategy,
+                :aws_sns_endpoint,
+                :aws_sqs_endpoint,
+                :sns_sqs_name_infix
+
+    def raise_on_missing_configuration
+      defined_or_default('raise_on_missing_configuration') { false }
+    end
+
+    def error_handlers
+      defined_or_default('error_handlers') { [ErrorHandlers::Logger.new] }
+    end
+
+    def concurrency
+      defined_or_default('concurrency') { ENV['EVENTBUS_CONCURRENCY'] ? ENV['EVENTBUS_CONCURRENCY'].to_i : 25 }
+    end
+
+    def log_level
+      defined_or_default('log_level') { :info }
+    end
+
+    def sns_client
+      defined_or_default('sns_client') { Eventboss::SnsClient.new(self) }
+    end
+
+    def sqs_client
+      defined_or_default('sqs_client') do
+        options = {
+          region: eventboss_region,
+          credentials: Aws::Credentials.new(
+            aws_access_key_id,
+            aws_secret_access_key
+          )
+        }
+        if aws_sqs_endpoint
+          options[:endpoint] = aws_sqs_endpoint
+        end
+
+        Aws::SQS::Client.new(options)
+      end
+    end
+
+    def eventboss_region
+      defined_or_default('eventboss_region') { ENV['EVENTBUS_REGION'] }
+    end
+
+    def eventboss_app_name
+      defined_or_default('eventboss_app_name') { ENV['EVENTBUS_APP_NAME'] }
+    end
+
+    def eventboss_account_id
+      defined_or_default('eventboss_account_id') { ENV['EVENTBUS_ACCOUNT_ID'] }
+    end
+
+    def aws_access_key_id
+      defined_or_default('aws_access_key_id') { ENV['AWS_ACCESS_KEY_ID'] }
+    end
+
+    def aws_secret_access_key
+      defined_or_default('aws_secret_access_key') { ENV['AWS_SECRET_ACCESS_KEY'] }
+    end
+
+    def aws_sqs_endpoint
+      defined_or_default('aws_sqs_endpoint') { ENV['AWS_SQS_ENDPOINT'] }
+    end
+
+    def aws_sns_endpoint
+      defined_or_default('aws_sns_endpoint') { ENV['AWS_SNS_ENDPOINT'] }
+    end
+
+    def polling_strategy
+      defined_or_default('polling_strategy') do
+        lambda { |queues| Eventboss::Polling::Basic.new(queues) }
+      end
+    end
+
+    def sns_sqs_name_infix
+      defined_or_default('sns_sqs_name_infix') { ENV['EVENTBUS_SQS_SNS_NAME_INFIX'] || '-eventboss-' }
+    end
+
+    private
+
+    def defined_or_default(variable_name)
+      if instance_variable_defined?("@#{variable_name}")
+        instance_variable_get("@#{variable_name}")
+      else
+        instance_variable_set("@#{variable_name}", yield) if block_given?
+      end
+    end
+  end
+end