delivery_boy 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13839750d8addd8784d886e3b8a4056cbc74af2656ff5424a63ba8a4ca6f4a86
-  data.tar.gz: 931c327dc9db84ba9526518b6a3a59f467ffa1268d0569197e6b242d19f89ef3
+  metadata.gz: 68b4c9faf508180a345d2b9009b4ba48ba7892e71cb7c652931111a7fb35733d
+  data.tar.gz: 598ce8b8497f179daf5608fb16ae7f33c2c7fbd9bbe704f251f425c4f919d970
 SHA512:
-  metadata.gz: b5bb98ab0ff079b8bdfccfa8217f59bdef0bad956602485da3339edcf155553ce25ded599bd78b58a8715b693ec3d4bda06bb48ed81e7c8073b3a28d398e0a29
-  data.tar.gz: cfecd1aa7996a29db2520abc8a5240ea23d423a4bc1458a52c7190170605ce39e2ba778c75b03127e2a692463cd8f06130a415b1f4c8a047c989ace2d43f8bfb
+  metadata.gz: d0502bffd4dd32445d92fc6f3899e6d1c1bd450ee93402202d0a0cb069be3f824c6dfb650c4d649fbc7ba79b616898e3ea4a9fe945df89fd495450d5b507b77b
+  data.tar.gz: 2156cc7f694f9b8e20683699bf12357504774e8e74b66dfe140ba8b692d322de55ab7bbdffa437705dff0e2a49fd6dcff7b2c3d44d2d2935ee2bc72696f85754

data/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - name: Run Confluent Platform (Confluent Server)
+      uses: zendesk/cp-all-in-one-action@v0.2.1
+      with:
+        service: broker
+
+    - uses: zendesk/checkout@v3
+
+    - name: Set up Ruby
+      uses: zendesk/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Wait for broker to boot
+      run: 'while ! nc -z localhost 9092; do echo -n "."; sleep 0.1; done'
+
+    - name: Run tests
+      run: bundle exec rake
+      env:
+        DELIVERY_BOY_BROKERS: localhost:9092

data/.github/workflows/publish.yml

@@ -0,0 +1,12 @@
+name: Publish Gem
+
+on:
+  push:
+    tags: v*
+
+jobs:
+  call-workflow:
+    uses: zendesk/gw/.github/workflows/ruby-gem-publication.yml@main
+    secrets:
+      RUBY_GEMS_API_KEY: ${{ secrets.RUBY_GEMS_API_KEY }}
+      RUBY_GEMS_TOTP_DEVICE: ${{ secrets.RUBY_GEMS_TOTP_DEVICE }}

data/.github/workflows/stale.yml

@@ -0,0 +1,27 @@
+# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time.
+#
+# You can adjust the behavior by modifying this file.
+# For more information, see:
+# https://github.com/actions/stale
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: '40 6 * * *'
+
+jobs:
+  stale:
+
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/stale@v5
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has been marked as stale due to a lack of activity. It will be closed in 7 days unless there is new activity.'
+        stale-pr-message: 'This PR has been marked as stale due to a lack of activity. It will be closed in 7 days unless there is new activity.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

data/CHANGELOG

@@ -1,5 +1,20 @@
 # Changelog
 
+## Unreleased
+
+## v1.2.0
+
+* Test with Ruby 3.1 & 3.2
+* Add config support for AWS MSK IAM auth (#66)
+
+## v1.1.0
+
+* Support for `ssl_client_cert_key_password` in the configuration (#52)
+* Add `DeliveryBoy.buffer_size` to return the number of messages in the buffer
+* Add `DeliveryBoy::Fake#clear_buffer` and `DeliveryBoy::Fake#buffer_size` to
+support the public API when using the test helper.
+* Support for `sasl_oauth_token_provider` in the configuration. (#55)
+
 ## v1.0.1
 
 * Require ruby-kafka v1.0 or higher.

data/README.md

@@ -66,7 +66,7 @@ A third method is to produce messages first (without delivering the messages to
  class CommentsController < ApplicationController
    def create
      @comment = Comment.create!(params)
-     
+
      event = {
        name: "comment_created",
        data: {
@@ -74,13 +74,13 @@ A third method is to produce messages first (without delivering the messages to
          user_id: current_user.id
        }
      }
-     
+
      # This will queue the two messages in the internal buffer.
      DeliveryBoy.produce(comment.to_json, topic: "comments")
      DeliveryBoy.produce(event.to_json, topic: "activity")
-     
+
      # This will deliver all messages in the buffer to Kafka.
-     # This call is blocking. 
+     # This call is blocking.
      DeliveryBoy.deliver_messages
    end
  end
@@ -220,11 +220,15 @@ A PEM encoded client cert to use with an SSL connection. Must be used in combina
 
 A PEM encoded client cert key to use with an SSL connection. Must be used in combination with `ssl_client_cert`.
 
+##### `ssl_client_cert_key_password`
+
+The password required to read the ssl_client_cert_key. Must be used in combination with ssl_client_cert_key.
+
 #### SASL Authentication and authorization
 
 See [ruby-kafka](https://github.com/zendesk/ruby-kafka#authentication-using-sasl) for more information.
 
-Use either `sasl_gssapi_*` _or_ `sasl_plain_*`, not both.
+Use it through `GSSAPI`, `PLAIN` _or_ `OAUTHBEARER`.
 
 ##### `sasl_gssapi_principal`
 
@@ -246,6 +250,63 @@ The username used to authenticate.
 
 The password used to authenticate.
 
+##### `sasl_oauth_token_provider`
+
+A instance of a class which implements the `token` method.
+As described in [ruby-kafka](https://github.com/zendesk/ruby-kafka/tree/c3e90bc355fad1e27b9af1048966ff08d3d5735b#oauthbearer)
+
+```ruby
+class TokenProvider
+  def token
+    "oauth-token"
+  end
+end
+
+DeliveryBoy.configure do |config|
+  config.sasl_oauth_token_provider = TokenProvider.new
+  config.ssl_ca_certs_from_system = true
+end
+```
+#### AWS MSK IAM Authentication and Authorization
+
+##### sasl_aws_msk_iam_access_key_id
+
+The AWS IAM access key. Required.
+
+##### sasl_aws_msk_iam_secret_key_id
+
+The AWS IAM secret access key. Required.
+
+##### sasl_aws_msk_iam_aws_region
+
+The AWS region. Required.
+
+##### sasl_aws_msk_iam_session_token
+
+The session token. This value can be optional.
+
+###### Examples 
+
+Using a role arn and web identity token to generate temporary credentials:
+
+```ruby
+require "aws-sdk-core"
+require "delivery_boy"
+
+role = Aws::AssumeRoleWebIdentityCredentials.new(
+  role_arn: ENV["AWS_ROLE_ARN"],
+  web_identity_token_file: ENV["AWS_WEB_IDENTITY_TOKEN_FILE"]
+)
+
+DeliveryBoy.configure do |c|
+  c.sasl_aws_msk_iam_access_key_id = role.credentials.access_key_id
+  c.sasl_aws_msk_iam_secret_key_id = role.credentials.secret_access_key
+  c.sasl_aws_msk_iam_session_token = role.credentials.session_token
+  c.sasl_aws_msk_iam_aws_region    = ENV["AWS_REGION"]
+  c.ssl_ca_certs_from_system       = true
+end
+```
+
 ### Testing
 
 DeliveryBoy provides a test mode out of the box. When this mode is enabled, messages will be stored in memory rather than being sent to Kafka. If you use RSpec, enabling test mode is as easy as adding this to your spec helper:

data/delivery_boy.gemspec

@@ -20,10 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "ruby-kafka", "~> 1.0"
-  spec.add_runtime_dependency "king_konf", "~> 0.3"
+  spec.add_runtime_dependency "ruby-kafka", "~> 1.5"
+  spec.add_runtime_dependency "king_konf", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/delivery_boy/config.rb

@@ -20,7 +20,7 @@ module DeliveryBoy
 
     # Delivery
     integer :ack_timeout, default: 5
-    integer :delivery_interval, default: 10
+    float :delivery_interval, default: 10
     integer :delivery_threshold, default: 100
     integer :max_retries, default: 2
     integer :required_acks, default: -1
@@ -38,6 +38,7 @@ module DeliveryBoy
     string :ssl_ca_cert_file_path
     string :ssl_client_cert, default: nil
     string :ssl_client_cert_key, default: nil
+    string :ssl_client_cert_key_password, default: nil
     boolean :ssl_ca_certs_from_system, default: false
     boolean :ssl_verify_hostname, default: true
 
@@ -52,6 +53,15 @@ module DeliveryBoy
     string :sasl_scram_mechanism
     boolean :sasl_over_ssl, default: true
 
+    # SASL OAUTHBEARER
+    attr_accessor :sasl_oauth_token_provider
+
+    # AWS IAM authentication
+    string :sasl_aws_msk_iam_access_key_id
+    string :sasl_aws_msk_iam_secret_key_id
+    string :sasl_aws_msk_iam_aws_region
+    string :sasl_aws_msk_iam_session_token, default: nil
+
     # Datadog monitoring
     boolean :datadog_enabled
     string :datadog_host

data/lib/delivery_boy/fake.rb

@@ -51,6 +51,18 @@ module DeliveryBoy
       clear
     end
 
+    def clear_buffer
+      @delivery_lock.synchronize do
+        @buffer.clear
+      end
+    end
+
+    def buffer_size
+      @delivery_lock.synchronize do
+        @buffer.values.flatten.size
+      end
+    end
+
     # Clear all messages stored in memory.
     def clear
       @delivery_lock.synchronize do

data/lib/delivery_boy/instance.rb

@@ -40,6 +40,10 @@ module DeliveryBoy
       sync_producer.clear_buffer
     end
 
+    def buffer_size
+      sync_producer.buffer_size
+    end
+
     private
 
     attr_reader :config, :logger
@@ -80,6 +84,7 @@ module DeliveryBoy
         ssl_ca_cert_file_path: config.ssl_ca_cert_file_path,
         ssl_client_cert: config.ssl_client_cert,
         ssl_client_cert_key: config.ssl_client_cert_key,
+        ssl_client_cert_key_password: config.ssl_client_cert_key_password,
         ssl_ca_certs_from_system: config.ssl_ca_certs_from_system,
         ssl_verify_hostname: config.ssl_verify_hostname,
         sasl_gssapi_principal: config.sasl_gssapi_principal,
@@ -90,7 +95,12 @@ module DeliveryBoy
         sasl_scram_username: config.sasl_scram_username,
         sasl_scram_password: config.sasl_scram_password,
         sasl_scram_mechanism: config.sasl_scram_mechanism,
-        sasl_over_ssl: config.sasl_over_ssl
+        sasl_over_ssl: config.sasl_over_ssl,
+        sasl_oauth_token_provider: config.sasl_oauth_token_provider,
+        sasl_aws_msk_iam_access_key_id: config.sasl_aws_msk_iam_access_key_id,
+        sasl_aws_msk_iam_secret_key_id: config.sasl_aws_msk_iam_secret_key_id,
+        sasl_aws_msk_iam_session_token: config.sasl_aws_msk_iam_session_token,
+        sasl_aws_msk_iam_aws_region: config.sasl_aws_msk_iam_aws_region
       )
     end
 

data/lib/delivery_boy/version.rb

@@ -1,3 +1,3 @@
 module DeliveryBoy
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/lib/delivery_boy.rb

@@ -4,6 +4,7 @@ require "delivery_boy/version"
 require "delivery_boy/instance"
 require "delivery_boy/fake"
 require "delivery_boy/config"
+require "delivery_boy/config_error"
 require "delivery_boy/railtie" if defined?(Rails::Railtie)
 
 module DeliveryBoy
@@ -85,6 +86,11 @@ module DeliveryBoy
       instance.clear_buffer
     end
 
+    # Return the number of messages in the buffer
+    def buffer_size
+      instance.buffer_size
+    end
+
     # Shut down DeliveryBoy.
     #
     # Automatically called when the process exits.
@@ -116,6 +122,10 @@ module DeliveryBoy
       raise ConfigError, e.message
     end
 
+    def clear_config!
+      @config = nil
+    end
+
     # Configure DeliveryBoy in a block.
     #
     #     DeliveryBoy.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delivery_boy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -16,56 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: king_konf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,10 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/publish.yml"
+- ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -130,8 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: A simple way to produce messages to Kafka from Ruby applications

data/.circleci/config.yml

@@ -1,33 +0,0 @@
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.5.1-node
-        environment:
-          LOG_LEVEL: DEBUG
-      - image: wurstmeister/zookeeper
-      - image: wurstmeister/kafka:2.11-2.0.0
-        environment:
-          KAFKA_ADVERTISED_HOST_NAME: localhost
-          KAFKA_ADVERTISED_PORT: 9092
-          KAFKA_PORT: 9092
-          KAFKA_ZOOKEEPER_CONNECT: localhost:2181
-          KAFKA_DELETE_TOPIC_ENABLE: true
-      - image: wurstmeister/kafka:2.11-2.0.0
-        environment:
-          KAFKA_ADVERTISED_HOST_NAME: localhost
-          KAFKA_ADVERTISED_PORT: 9093
-          KAFKA_PORT: 9093
-          KAFKA_ZOOKEEPER_CONNECT: localhost:2181
-          KAFKA_DELETE_TOPIC_ENABLE: true
-      - image: wurstmeister/kafka:2.11-2.0.0
-        environment:
-          KAFKA_ADVERTISED_HOST_NAME: localhost
-          KAFKA_ADVERTISED_PORT: 9094
-          KAFKA_PORT: 9094
-          KAFKA_ZOOKEEPER_CONNECT: localhost:2181
-          KAFKA_DELETE_TOPIC_ENABLE: true
-    steps:
-      - checkout
-      - run: bundle install --path vendor/bundle
-      - run: bundle exec rspec

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.15.3