surfliner-metadata_consumer 0.1.0.pre.alpha → 0.1.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6520951750821f9f2de1ed06f02a3d087d497283c2a2107a3f3f40ddcf786f
-  data.tar.gz: f243e4bda74dcbdfc85c99d77477df1e29d69816e568ba7314aadb96534875c1
+  metadata.gz: 22ceb6aaafb75d24e2cf646c3ac55eaca9c0fc92183a448f3ad3a09e9920eaea
+  data.tar.gz: 52c43074990eade7d93c32fa471329e845d2776f9229246f57bec81e75fa558d
 SHA512:
-  metadata.gz: 49de449388610d4683296ea83021fe4bd7f5c5a2112eb52173c4adb81e8c1bd6e14b17acb2f1e6b4397f6699c973f04b22bc1d2ccfce9a2ea3d05a41d8e92277
-  data.tar.gz: 5192138d3868a691247adb1777270b23552465b3fe60ed76303f3605b1851d9ce5bff7afd09ea31c2d0da200316f37ea6cc81ef0363aa2c565e5ec45c847aec2
+  metadata.gz: f19622750625a84977122fa344b8635bac1d6f80de562237505be22f82aa3acbc532d53f768f0f3b9b7dbda84724d1979b9396e785dca25d30216b71b8746c65
+  data.tar.gz: 47621bc83433c05a36cd0d15a3b3a526eb981b0bd1085014c5179ea7c1dce0ad0a12722895873d629bfc1a510cb3648d1a5b2695d1b797d9960befcbb90e517e

data/CHANGES.md

@@ -0,0 +1,7 @@
+# 0.1.0.pre.alpha.1 (2025-02-12)
+
+- CI pipeline gem release test
+
+# 0.1.0.pre.alpha (2025-02-12)
+
+- Initial release

data/Gemfile

@@ -2,5 +2,4 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in surfliner_schema.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    surfliner-metadata_consumer (0.1.0.pre.alpha)
+    surfliner-metadata_consumer (0.1.0.pre.alpha.2)
       bunny (~> 2.23)
       opentelemetry-exporter-otlp (~> 0.26.3)
       opentelemetry-instrumentation-all (~> 0.60.0)
@@ -13,7 +13,7 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    amq-protocol (2.3.2)
+    amq-protocol (2.3.3)
     ast (2.4.2)
     bigdecimal (3.1.9)
     builder (3.3.0)
@@ -34,7 +34,7 @@ GEM
     debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.0)
     docile (1.4.1)
     dotenv (2.8.1)
     faraday (2.12.2)
@@ -44,11 +44,6 @@ GEM
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
     google-protobuf (3.25.6)
-    google-protobuf (3.25.6-aarch64-linux)
-    google-protobuf (3.25.6-arm64-darwin)
-    google-protobuf (3.25.6-x86-linux)
-    google-protobuf (3.25.6-x86_64-darwin)
-    google-protobuf (3.25.6-x86_64-linux)
     googleapis-common-protos-types (1.18.0)
       google-protobuf (>= 3.18, < 5.a)
     hashdiff (1.1.2)
@@ -57,14 +52,14 @@ GEM
       pp (>= 0.6.0)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
-    json (2.9.1)
+    json (2.10.1)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    logger (1.6.5)
+    logger (1.6.6)
     net-http (0.6.0)
       uri
-    opentelemetry-api (1.4.0)
-    opentelemetry-common (0.21.0)
+    opentelemetry-api (1.5.0)
+    opentelemetry-common (0.22.0)
       opentelemetry-api (~> 1.0)
     opentelemetry-exporter-otlp (0.26.3)
       google-protobuf (~> 3.14)
@@ -250,17 +245,17 @@ GEM
       opentelemetry-helpers-sql-obfuscation
       opentelemetry-instrumentation-base (~> 0.22.1)
       opentelemetry-semantic_conventions (>= 1.8.0)
-    opentelemetry-registry (0.3.1)
+    opentelemetry-registry (0.4.0)
       opentelemetry-api (~> 1.1)
     opentelemetry-sdk (1.4.1)
       opentelemetry-api (~> 1.1)
       opentelemetry-common (~> 0.20)
       opentelemetry-registry (~> 0.2)
       opentelemetry-semantic_conventions
-    opentelemetry-semantic_conventions (1.10.1)
+    opentelemetry-semantic_conventions (1.11.0)
       opentelemetry-api (~> 1.0)
     parallel (1.26.3)
-    parser (3.3.7.0)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
     pp (0.6.2)
@@ -274,12 +269,12 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     rbtree (0.4.6)
-    rdoc (6.11.0)
+    rdoc (6.12.0)
       psych (>= 4.0.0)
     regexp_parser (2.10.0)
     reline (0.6.0)
       io-console (~> 0.5)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rsolr (2.6.0)
       builder (>= 2.1.2)
       faraday (>= 0.9, < 3, != 2.0.0)
@@ -287,7 +282,7 @@ GEM
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -296,17 +291,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.2)
-    rubocop (1.70.0)
+    rubocop (1.71.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.36.2, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
+    rubocop-ast (1.38.1)
       parser (>= 3.3.1.0)
     rubocop-performance (1.23.1)
       rubocop (>= 1.48.1, < 2.0)
@@ -325,10 +320,10 @@ GEM
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    standard (1.44.0)
+    standard (1.45.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.70.0)
+      rubocop (~> 1.71.0)
       standard-custom (~> 1.0.0)
       standard-performance (~> 1.6)
     standard-custom (1.0.2)
@@ -337,23 +332,19 @@ GEM
     standard-performance (1.6.0)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.23.0)
-    stringio (3.1.2)
+    stringio (3.1.5)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
-    webmock (3.24.0)
+    uri (1.0.3)
+    webmock (3.25.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yard (0.9.37)
 
 PLATFORMS
-  aarch64-linux
-  arm64-darwin
   ruby
-  x86-linux
-  x86_64-darwin
   x86_64-linux
 
 DEPENDENCIES
@@ -371,4 +362,4 @@ DEPENDENCIES
   yard (~> 0.9.37)
 
 BUNDLED WITH
-   2.5.22
+   2.6.2

data/README.md

@@ -61,11 +61,11 @@ a configured `SOLR_URL`, e.g.:
 SOLR_URL=http://admin:admin@solr:8983/solr/daylight-dev
 ```
 
-The `bin/simulate-publish-event` script expects an `API_BASE_URI`, used to generate resource URLs
+The `bin/simulate-publish-event` script expects an `METADATA_API_URL_BASE`, used to generate resource URLs
 for provided IDs:
 
 ```sh
-API_BASE_URI=http://superskunk:3000
+METADATA_API_URL_BASE=http://superskunk:3000/resources
 ```
 
 ## Solr / Daylight handler implementation

data/bin/daylight-index-listen

@@ -20,4 +20,6 @@ tracer = OpenTelemetry.tracer_provider.tracer("DaylightConsumerTracer")
 
 handler = Surfliner::MetadataConsumer::Solr::MessageHandler
 
-Surfliner::MetadataConsumer::Consumer.run(logger:, tracer:, handler:)
+opts = { queue: { durable: false } }
+
+Surfliner::MetadataConsumer::Consumer.run(logger:, tracer:, handler:, opts:)

data/bin/simulate-publish-event

@@ -6,18 +6,20 @@ require "logger"
 
 require "surfliner/metadata_consumer/mq_connection"
 
-api_base = ENV.fetch("API_BASE_URI") { "http://example.com/api" }
-logger = Logger.new($stdout)
+api_base     = ENV.fetch("METADATA_API_URL_BASE") { "http://metadata.test/resources" }
+logger       = Logger.new($stdout)
 logger.level = ENV.fetch("LOG_LEVEL") { Logger::INFO }
 
-connection = Surfliner::MetadataConsumer::MqConnection.new(logger: logger).connect
+opts = { queue: { durable: false } }
+
+connection = Surfliner::MetadataConsumer::MqConnection.new(logger:, opts:).connect
 
 begin
   ARGV.each do |id|
     payload =
-      {resourceUrl: "#{api_base}/resources/#{id}",
-       status: :published,
-       time_stamp: DateTime.now}.to_json
+      { resourceUrl: "#{api_base}/#{id}",
+        status:      :published,
+        time_stamp:  DateTime.now }.to_json
 
     logger.info "Publishing to #{connection.routing_key} with #{payload}"
     connection.exchange.publish(payload, routing_key: connection.routing_key)

data/lib/surfliner/metadata_consumer/consumer.rb

@@ -13,8 +13,9 @@ module Surfliner
       # @param tracer [OpenTelemetry::Trace::Tracer] OpenTelemetry tracer
       # @param logger [Logger] log message destination
       # @param handler #handle an object accepting a JSON string
-      def initialize(tracer:, logger:, handler:)
-        @connection = MqConnection.new(logger:)
+      # @param opts [Hash] (see MqConnection#new)
+      def initialize(tracer:, logger:, handler:, opts: nil)
+        @connection = MqConnection.new(logger:, opts:)
         @logger = logger
         @tracer = tracer
         @handler = handler
@@ -24,8 +25,9 @@ module Surfliner
       # @param tracer [OpenTelemetry::Trace::Tracer] OpenTelemetry tracer
       # @param logger [Logger] log message destination
       # @param handler #handle an object accepting a JSON string payload
-      def self.run(tracer:, logger:, handler:)
-        new(tracer:, logger:, handler:).run
+      # @param opts [Hash] (see MqConnection#new)
+      def self.run(tracer:, logger:, handler:, opts: nil)
+        new(tracer:, logger:, handler:, opts:).run
       end
 
       # Starts listening to the message queue and passing messages to the handler.

data/lib/surfliner/metadata_consumer/mq_connection.rb

@@ -4,6 +4,15 @@ module Surfliner
   module MetadataConsumer
     # An object encapsulating a RabbitMQ connection.
     class MqConnection
+      # Default RabbitMQ topic options
+      DEFAULT_TOPIC_OPTS = {auto_delete: true}.freeze
+
+      # Default RabbitMQ queue options
+      DEFAULT_QUEUE_OPTS = {durable: true}.freeze
+
+      # Default RabbitMQ topic and queue options
+      DEFAULT_OPTS = {topic: DEFAULT_TOPIC_OPTS, queue: DEFAULT_QUEUE_OPTS}.freeze
+
       # @return [Logger]  The logger
       attr_reader :logger
 
@@ -22,13 +31,18 @@ module Surfliner
       # @return [MqConfig]  The configuration
       attr_reader :config
 
+      # @return [Hash<Symbol, Hash>]  Options to pass when connecting to RabbitMQ topic and queue. Overrides DEFAULT_OPTS.
+      attr_reader :opts
+
       # Initializes a new `MqConnection`.
       #
       # @param logger [Logger] the logger
       # @param config [MqConfig] the configuration
-      def initialize(logger:, config: MqConfig.from_env)
+      # @param opts [Hash<Symbol, Hash>]  Options to pass when connecting to RabbitMQ topic and queue. Overrides DEFAULT_OPTS.
+      def initialize(logger:, config: MqConfig.from_env, opts: nil)
         @logger = logger
         @config = config
+        @opts = merge_opts(opts)
       end
 
       # Opens a connection.
@@ -41,8 +55,8 @@ module Surfliner
         @connection = Bunny.new(config.connection_url, logger: logger)
         connect_on(connection)
         @channel = connection.create_channel
-        @exchange = channel.topic(config.topic, auto_delete: true)
-        @queue = channel.queue(config.queue_name, durable: true)
+        @exchange = channel.topic(config.topic, topic_opts)
+        @queue = channel.queue(config.queue_name, queue_opts)
         queue.bind(exchange, routing_key: config.routing_key)
 
         self
@@ -68,8 +82,12 @@ module Surfliner
 
       # Closes the connection.
       def close
-        channel&.close
+        return unless channel
+        return if channel.closed?
+        logger.info("closing channel")
+        channel.close
       ensure
+        logger.info("closing connection")
         connection&.close
       end
 
@@ -93,8 +111,28 @@ module Surfliner
         config.port
       end
 
+      # @return [Hash]  Options passed when connecting to RabbitMQ topic
+      def topic_opts
+        opts[:topic]
+      end
+
+      # @return [Hash]  Options passed when connecting to RabbitMQ queue
+      def queue_opts
+        opts[:queue]
+      end
+
       private
 
+      def merge_opts(opts)
+        DEFAULT_OPTS.to_h do |opt_type, opts_default|
+          opts_actual = opts_default.dup
+          if opts && (opts_provided = opts[opt_type])
+            opts_actual.merge!(opts_provided)
+          end
+          [opt_type, opts_actual]
+        end
+      end
+
       def connect_on(connection, timeout = 120)
         timer = 0
         logger.info "Trying to open queue connection with timeout=#{timeout}"

data/lib/surfliner/metadata_consumer/version.rb

@@ -3,6 +3,6 @@ module Surfliner
   # Parent module for this gem
   module MetadataConsumer
     # The gem version
-    VERSION = "0.1.0.pre.alpha"
+    VERSION = "0.1.0.pre.alpha.2"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: surfliner-metadata_consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha
+  version: 0.1.0.pre.alpha.2
 platform: ruby
 authors:
 - Project Surfliner
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-12 00:00:00.000000000 Z
+date: 2025-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -240,19 +239,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.37
-description:
-email:
 executables:
 - daylight-index-listen
 - simulate-publish-event
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE~
 - README.md
 - Rakefile
 - bin/daylight-index-listen
@@ -268,7 +265,6 @@ files:
 - lib/surfliner/metadata_consumer/solr/message_handler.rb
 - lib/surfliner/metadata_consumer/superskunk_client.rb
 - lib/surfliner/metadata_consumer/version.rb
-- surfliner-metadata_consumer.gemspec
 homepage: https://gitlab.com/surfliner/metadata_consumer
 licenses:
 - MIT
@@ -276,7 +272,6 @@ metadata:
   homepage_uri: https://gitlab.com/surfliner/metadata_consumer
   source_code_uri: https://gitlab.com/surfliner/metadata_consumer.git
   rubygems_mfa_required: 'false'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Surfliner metadata consumer
 test_files: []

data/LICENSE~

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 The Regents of the University of California.
-
-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/surfliner-metadata_consumer.gemspec

@@ -1,42 +0,0 @@
-require_relative "lib/surfliner/metadata_consumer/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "surfliner-metadata_consumer"
-  spec.version = Surfliner::MetadataConsumer::VERSION
-  spec.authors = ["Project Surfliner"]
-
-  spec.homepage = "https://gitlab.com/surfliner/metadata_consumer"
-  spec.license = "MIT"
-  spec.summary = "Surfliner metadata consumer"
-
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.1")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://gitlab.com/surfliner/metadata_consumer.git"
-  spec.metadata["rubygems_mfa_required"] = "false"
-
-  spec.files = Dir["lib/**/*.rb"] + Dir["bin/*"] + Dir["[A-Z]*"]
-
-  ["daylight-index-listen", "simulate-publish-event"].each do |script|
-    spec.executables << script
-  end
-
-  spec.add_dependency "bunny", "~> 2.23"
-  # TODO: Figure out why we get "The otlp exporter cannot be configured - please add opentelemetry-exporter-otlp to your Gemfile"
-  spec.add_dependency "opentelemetry-exporter-otlp", "~> 0.26.3"
-  spec.add_dependency "opentelemetry-instrumentation-all", "~> 0.60.0"
-  spec.add_dependency "opentelemetry-sdk", "~> 1.4.1"
-  spec.add_dependency "rsolr", ">= 1.0", "< 3"
-
-  spec.add_development_dependency "debug", "~> 1.9.2"
-  spec.add_development_dependency "rspec", "~> 3.13"
-  spec.add_development_dependency "standard", "~> 1.31"
-  spec.add_development_dependency "ci_reporter_rspec", "~> 1.0"
-  spec.add_development_dependency "colorize", "~> 0.8"
-  spec.add_development_dependency "dotenv", "~> 2.7"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "simplecov", "~> 0.22"
-  spec.add_development_dependency "simplecov-cobertura", "~> 2.1"
-  spec.add_development_dependency "webmock", "~> 3.12"
-  spec.add_development_dependency "yard", "~> 0.9.37"
-end