aws-msk-iam-sasl-signer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c1a55e1e98d1cb058d624b31c02ecb16b661bfdf2f896e087a10bc84279e799
-  data.tar.gz: 52a0b1d7d1ff7cb6115551b69a4a6f396ce1682f65f855d603332026d6464783
+  metadata.gz: f0d7e320950177e18b7c8d5fe2b73885caba82e0ae9e2412c2a9fa4774831aff
+  data.tar.gz: 1eea46bda5a52a5025fa511a693ed578bd1b422367e7d9085d52fd2b6e77971f
 SHA512:
-  metadata.gz: 452a78478ed3b6677dc3cbd047b6296310b9005bbd2d618a3a436e960621a3213342ed98c2da012fc2ab2909ff99a3d844842bf7d21501759cc20f7f0b089250
-  data.tar.gz: b528420b2cef1f7bc66fe81a553de226f64ba18f933c336ec902cb58224147fd85e3e82f713e5f0a422b5d8e27515decf01f1363e9e24f61a5aef4a11a8cc340
+  metadata.gz: 267053e91070bfdc18b8de061b39fc455c005ec000cb94d2eb1e99b1776171f58b8e9ee81fdf93b342c4f44564787bae75c813c2df1ac3d74d6067740f597c59
+  data.tar.gz: 18a7053eb427399aa2c7b161f0f01ccc6b7f7aa42384bf48c47591102695d853a0ea16cc5b84151de52f2be568c35b1c45bb212692bd64297fa1262f3ec2b8f4

data/README.md

@@ -34,72 +34,10 @@ This is the preferred method to install aws-msk-iam-sasl-signer-ruby, as it will
 gem install aws-msk-iam-sasl-signer
 ```
 
-## Usage
+## Examples
 
-```ruby
-
-# frozen_string_literal: true
-require "aws-msk-iam-sasl-signer"
-require "json"
-require "rdkafka"
-
-KAFKA_TOPIC = ENV['KAFKA_TOPIC']
-KAFKA_BOOTSTRAP_SERVERS = ENV['KAFKA_BOOTSTRAP_SERVERS']
-
-kafka_config = {
-  "bootstrap.servers": KAFKA_BOOTSTRAP_SERVERS,
-  "security.protocol": 'sasl_ssl',
-  "sasl.mechanisms": 'OAUTHBEARER',
-  "client.id": 'ruby-producer',
-}
-
-def refresh_token(client, config)
-  signer = AwsMskIamSaslSigner::MSKTokenProvider.new(region: 'us-east-1')
-  auth_token = signer.generate_auth_token
-
-  error_buffer = FFI::MemoryPointer.from_string(' ' * 256)
-  response = Rdkafka::Bindings.rd_kafka_oauthbearer_set_token(
-    client, auth_token.token, auth_token.expiration_time_ms, 'kafka-cluster', nil, 0, error_buffer, 256
-  )
-  return unless response != 0
-
-  Rdkafka::Bindings.rd_kafka_oauthbearer_set_token_failure(client,
-                                                           "Failed to set token: #{error_buffer.read_string}")
-
-end
-
-# set the token refresh callback
-Rdkafka::Config.oauthbearer_token_refresh_callback = method(:refresh_token)
-producer = Rdkafka::Config.new(kafka_config).producer
-
-# seed the token
-# events_poll will invoke all registered callbacks, of which oauthbearer_token_refresh_callback is one
-
-consumer = Rdkafka::Config.new(kafka_config).consumer
-consumer.events_poll
-
-# produce some messages
+- [rdkafka](examples/rdkafka/README.md) (using rdkafka gem)
 
-Payload = Data.define(:device_id, :creation_timestamp, :temperature)
-
-loop do
-  payload = Payload.new(
-    device_id: '1234',
-    creation_timestamp: Time.now.to_i,
-    temperature: rand(0..100)
-  )
-
-  handle = producer.produce(
-    topic: KAFKA_TOPIC,
-    payload: payload.to_h.to_json,
-    key: "ruby-kafka-#{rand(0..999)}"
-  )
-  handle.wait(max_wait_timeout: 10)
-
-  sleep(10)
-end
-
-```
 
 In order to use a named profile to generate the token, replace the `generate_auth_token` function with code below:
 
@@ -110,7 +48,6 @@ In order to use a named profile to generate the token, replace the `generate_aut
   )
 ```
 
-
 In order to use a role arn to generate the token, replace the `generate_auth_token` function with code below:
 
 ```ruby
@@ -201,3 +138,17 @@ Everyone interacting in this project’s codebases, issue trackers, chat rooms a
 ## Contribution guide
 
 Pull requests are welcome!
+
+## Releasing
+
+- create PR with version change
+- bump version in `lib/aws-msk-iam-sasl-signer/version.rb`
+- approve and merge
+
+```bash
+git checkout main
+git pull origin main
+VERSION="v$(grep -o 'VERSION = "[^"]*' lib/aws-msk-iam-sasl-signer/version.rb | grep -o '[^"]*$')"
+git tag -a ${VERSION} -m "${VERSION}"
+git push origin ${VERSION}
+```

data/lib/aws-msk-iam-sasl-signer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AwsMskIamSaslSigner
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-msk-iam-sasl-signer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - bruce szalwinski
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-kafka
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - bruce.szalwinski@hotelengine.com
 executables:
@@ -64,7 +64,7 @@ metadata:
   source_code_uri: https://github.com/bruce-szalwinski-he/aws-msk-iam-sasl-signer-ruby
   homepage_uri: https://github.com/bruce-szalwinski-he/aws-msk-iam-sasl-signer-ruby
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +79,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.5.16
+signing_key: 
 specification_version: 4
 summary: MSK Library in Ruby for SASL/OAUTHBEARER Auth
 test_files: []