eh_messaging 1.0.0

data/sig/eh_messaging.rbs

@@ -0,0 +1,168 @@
+module EhMessaging
+  type payload = Hash[untyped, untyped] | Array[untyped] | String
+  type headers = Hash[String | Symbol, untyped]
+  type broker_name = Symbol
+  type reconsume_options = { ?until_time: Time, ?partitions: Hash[Integer, Integer], ?group: String }
+
+  class Error < StandardError
+  end
+
+  class Client
+    def initialize: () -> void
+    def configure: (**untyped) ?{ (Configuration) -> void } -> self
+    def configuration: () -> Configuration
+    def publish: (String topic, event: String, application_name: String, component: String, correlation_id: String, version: String, partition_key: untyped, payload: payload, ?headers: headers, ?broker: broker_name | String, ?raw: bool) -> DeliveryReport
+    def subscribe: (untyped handler) -> Subscriber
+    def reconsume: (untyped handler, **reconsume_options) -> untyped
+    def boot: () -> self
+    def run: () -> untyped
+    def shutdown: () -> untyped
+    def reset!: () -> self
+  end
+
+  class RecoverableError < StandardError
+  end
+
+  class Configuration
+    attr_accessor application_name: String?
+    attr_accessor logging: bool
+    attr_accessor log_message_body: bool
+    attr_accessor poll_timeout: Numeric
+    attr_accessor log_level: String
+    attr_accessor logger: untyped
+
+    attr_reader brokers: Hash[broker_name, Hash[Symbol, untyped]]
+    attr_reader topics: Hash[String, Hash[Symbol, untyped]]
+    attr_reader producer: ProducerSettings
+    attr_reader consumer: ConsumerSettings
+
+    def initialize: () -> void
+    def apply: (**untyped) -> void
+    def broker: (broker_name name, **untyped) -> void
+    def topic: (String name, ?broker: broker_name?, ?side: Symbol, **untyped) -> void
+    def validate!: () -> self
+    def broker_config: (?broker_name name) -> Hash[Symbol, untyped]
+    def topic_config: (String name, ?side: Symbol?) -> Hash[Symbol, untyped]
+    def kafka_config: (Hash[Symbol, untyped] connection, ?kind: Symbol, ?group_id: String?) -> Hash[String, untyped]
+
+    class Settings
+      def to_kafka: () -> Hash[String, untyped]
+    end
+
+    class ProducerSettings < Settings
+      def metadata_max_age_ms: () -> untyped
+      def metadata_max_age_ms=: (untyped) -> untyped
+      def message_send_max_retries: () -> untyped
+      def message_send_max_retries=: (untyped) -> untyped
+      def request_timeout_ms: () -> untyped
+      def request_timeout_ms=: (untyped) -> untyped
+      def socket_keepalive_enable: () -> untyped
+      def socket_keepalive_enable=: (untyped) -> untyped
+      def batch_num_messages: () -> untyped
+      def batch_num_messages=: (untyped) -> untyped
+      def linger_ms: () -> untyped
+      def linger_ms=: (untyped) -> untyped
+    end
+
+    class ConsumerSettings < Settings
+      def socket_timeout_ms: () -> untyped
+      def socket_timeout_ms=: (untyped) -> untyped
+      def session_timeout_ms: () -> untyped
+      def session_timeout_ms=: (untyped) -> untyped
+      def heartbeat_interval_ms: () -> untyped
+      def heartbeat_interval_ms=: (untyped) -> untyped
+      def max_poll_interval_ms: () -> untyped
+      def max_poll_interval_ms=: (untyped) -> untyped
+      def metadata_max_age_ms: () -> untyped
+      def metadata_max_age_ms=: (untyped) -> untyped
+      def socket_keepalive_enable: () -> untyped
+      def socket_keepalive_enable=: (untyped) -> untyped
+      def auto_offset_reset: () -> String
+      def auto_offset_reset=: (String) -> void
+      def enable_auto_commit: () -> bool
+      def enable_auto_commit=: (bool) -> void
+    end
+  end
+
+  class Envelope
+    attr_reader payload: untyped
+    attr_reader partition_key: untyped
+    attr_reader headers: Hash[String, untyped]
+    attr_reader event_name: String?
+    attr_reader event_id: String?
+    attr_reader correlation_id: String?
+    attr_reader application_name: String?
+    attr_reader component_name: String?
+    attr_reader version: String?
+    attr_reader timestamp: String?
+    attr_reader enqueued_at: Time?
+    attr_reader topic: String?
+    attr_reader partition: Integer?
+    attr_reader offset: Integer?
+    attr_reader consumer_group: String?
+    attr_reader mode: Symbol?
+
+    def initialize: (payload: untyped, partition_key: untyped, headers: Hash[String, untyped], ?mode: Symbol?, ?consumer_group: String?, ?topic: String?, ?partition: Integer?, ?offset: Integer?, ?enqueued_at: Time?) -> void
+    def self.header: (Hash[untyped, untyped] headers, String | Symbol key) -> untyped
+    def self.from_message: (untyped message, mode: Symbol, consumer_group: String) -> Envelope
+    def self.headers_from_message: (untyped message) -> Hash[String, untyped]
+    def self.decode: (untyped value) -> untyped
+    def self.header_bytes: (untyped value) -> (String | Array[untyped])
+    def self.timestamp: () -> String
+    def self.headers: (event: String, application_name: String, component: String, correlation_id: String, version: String, ?headers: headers) -> Hash[String, untyped]
+  end
+
+  class DeliveryReport
+    attr_reader raw: untyped
+    attr_reader sent_keys: Array[untyped]
+    attr_reader error_keys: Array[untyped]
+
+    def initialize: (untyped raw, untyped key) -> void
+    def error: () -> untyped
+  end
+
+  class Publisher
+    attr_reader producers: Hash[broker_name, untyped]
+
+    def initialize: (Configuration configuration, ?producer_factory: untyped, ?logger: untyped) -> void
+    def boot: () -> self
+    def publish: (String topic, event: String, application_name: String, component: String, correlation_id: String, version: String, partition_key: untyped, payload: payload, ?headers: headers, ?broker: broker_name | String, ?raw: bool) -> DeliveryReport
+    def publish_dead_letter: (String topic, Envelope envelope, Exception error, ?broker: broker_name) -> DeliveryReport
+    def publish_raw: (String topic, untyped payload, untyped key, Hash[String, untyped] headers, ?broker: broker_name) -> DeliveryReport
+    def topic_exists?: (String topic, ?broker: broker_name) -> bool
+    def shutdown: () -> self
+  end
+
+  module Topics
+    def self.dead_letter: (String topic, String group) -> String
+    def self.recovery: (String topic, String group) -> String
+    def self.recovery_group: (String group) -> String
+    def self.reconsume_group: (String group) -> String
+  end
+
+  def self.configure: (**untyped) ?{ (Configuration) -> void } -> singleton(EhMessaging)
+  def self.configuration: () -> Configuration
+  def self.publish: (String topic, event: String, application_name: String, component: String, correlation_id: String, version: String, partition_key: untyped, payload: payload, ?headers: headers, ?broker: broker_name | String, ?raw: bool) -> DeliveryReport
+  def self.subscribe: (untyped handler) -> Subscriber
+  def self.reconsume: (untyped handler, **reconsume_options) -> untyped
+  def self.boot: () -> singleton(EhMessaging)
+  def self.run: () -> untyped
+  def self.shutdown: () -> untyped
+  def self.reset!: () -> untyped
+
+  class Subscriber
+    attr_reader subscriptions: Array[untyped]
+
+    def initialize: (Configuration configuration, ?consumer_factory: untyped, ?producer: Publisher?, ?logger: untyped) -> void
+    def subscribe: (untyped handler) -> self
+    def boot: () -> self
+    def reconsume: (untyped handler, ?until_time: Time?, ?partitions: Hash[Integer, Integer]?, ?group: String?) -> untyped
+    def run: () -> untyped
+    def shutdown: () -> self
+  end
+end
+
+module EhMessagingPublicApiTypecheck
+  def self.configure_and_publish: () -> EhMessaging::DeliveryReport
+  def self.envelope_and_topics: (EhMessaging::Envelope) -> String
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: eh_messaging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diego E
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rdkafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.43'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.43'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A Ruby library for producing and consuming messages on Azure Event Hubs
+  using its Kafka-compatible endpoint
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- eh_messaging.gemspec
+- lib/eh_messaging.rb
+- lib/eh_messaging/audit_logger.rb
+- lib/eh_messaging/client.rb
+- lib/eh_messaging/configuration.rb
+- lib/eh_messaging/dead_letter_router.rb
+- lib/eh_messaging/envelope.rb
+- lib/eh_messaging/publisher.rb
+- lib/eh_messaging/recoverable_error.rb
+- lib/eh_messaging/subscriber.rb
+- lib/eh_messaging/subscriber_metadata.rb
+- lib/eh_messaging/subscriber_polling.rb
+- lib/eh_messaging/telemetry.rb
+- lib/eh_messaging/topics.rb
+- lib/eh_messaging/version.rb
+- sig/eh_messaging.rbs
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby library for Azure Event Hubs over the Kafka-compatible protocol
+test_files: []