delivery_boy 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a12782da215edcc91544e184fd5804b2c21fb4a4be180f69addd0e2f7787884e
-  data.tar.gz: 6de9279ba3441524aceef6091a4feaf57d67a8623499779877b39ed9a11edad9
+  metadata.gz: 68b4c9faf508180a345d2b9009b4ba48ba7892e71cb7c652931111a7fb35733d
+  data.tar.gz: 598ce8b8497f179daf5608fb16ae7f33c2c7fbd9bbe704f251f425c4f919d970
 SHA512:
-  metadata.gz: 6787bea888f6a2db4bb0d66eaad3c2234c9b6e4482c81ec69e43c27960b4c4a191ec553c0a24c87a46c5067811e2b9eb85265b34fc9457692465dfa8d902c5af
-  data.tar.gz: e10d3020dbaedfe5608fab51e6e1d343341919aab23b905766cdc386e2b844d5177d464fba93d69b79cc6d3704a5ad703ca97464f5754a363a9d362fecec2559
+  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

@@ -2,6 +2,11 @@
 
 ## 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)

data/README.md

@@ -267,7 +267,45 @@ DeliveryBoy.configure do |config|
   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
 

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 "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
@@ -56,6 +56,12 @@ module DeliveryBoy
     # 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/instance.rb

@@ -96,7 +96,11 @@ module DeliveryBoy
         sasl_scram_password: config.sasl_scram_password,
         sasl_scram_mechanism: config.sasl_scram_mechanism,
         sasl_over_ssl: config.sasl_over_ssl,
-        sasl_oauth_token_provider: config.sasl_oauth_token_provider
+        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.1.0"
+  VERSION = "1.2.0"
 end

data/lib/delivery_boy.rb

@@ -122,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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-kafka
@@ -16,14 +16,14 @@ 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
@@ -38,34 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !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'
 - !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,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+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