mongo-keepalive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28d074e5002228d1b11a3ed4bd8f337693ce0fcb29d35e0fd0348843bffaa5a4
+  data.tar.gz: e95137f53edb576bb1b4bcc953a75c0863f6e46669912ba962a06d5cab3bbc81
+SHA512:
+  metadata.gz: c05c2f202e951c5902df82e4ccc5ee3bba2aacc2dfd024dfedbfe26545e888251162aa6e3acee20cee4e678fa2d98a79983529c8aa1047e209abb2e6ea6c8b09
+  data.tar.gz: ec86a1e185684e704dae11142d57384d59ddcf7c3586b649a55a23e2279490c515a7f4f65498118880f56eefd1f90c67c8c75f17b219baf9bf31bab7005de0da

data/lib/keepalive.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "logger"
+require "mongo"
+
+# Keep MongoDB Atlas free-tier clusters alive by periodically sending a ping command.
+module MongoKeepAlive
+  DEFAULT_INTERVAL = "12h"
+  MAX_RETRIES = 3
+  RETRY_DELAY = 5
+
+  # Control handle returned by {.start_keep_alive}.
+  class Handle
+    def initialize(client, thread)
+      @client = client
+      @thread = thread
+      @stopped = false
+    end
+
+    # Stop the keep-alive loop and close the connection.
+    def stop
+      @stopped = true
+      @thread.kill
+      @client.close
+      MongoKeepAlive.logger.info("[mongo-keepalive] Stopped and disconnected.")
+    end
+
+    def stopped?
+      @stopped
+    end
+  end
+
+  class << self
+    # @return [Logger]
+    def logger
+      @logger ||= Logger.new($stdout, progname: "mongo-keepalive")
+    end
+
+    attr_writer :logger
+
+    # Start the keep-alive loop in a background thread.
+    #
+    # @param uri [String] MongoDB connection string.
+    # @param interval [String] Ping interval, e.g. "12h", "30m", "60s".
+    # @return [Handle] A handle with a {Handle#stop} method.
+    def start_keep_alive(uri:, interval: DEFAULT_INTERVAL)
+      raise ArgumentError, "A MongoDB connection URI is required." if uri.nil? || uri.empty?
+
+      interval_s = parse_interval(interval)
+      logger.info("[mongo-keepalive] Starting with interval #{interval} (#{interval_s} s)")
+
+      client = Mongo::Client.new(uri)
+      db = client.use("admin").database
+
+      # Initial ping
+      ping_with_retry(db)
+
+      thread = Thread.new do
+        loop do
+          sleep(interval_s)
+          ping_with_retry(db)
+        end
+      end
+
+      Handle.new(client, thread)
+    end
+
+    private
+
+    def parse_interval(interval)
+      match = interval.strip.match(/\A(\d+)\s*([hms])\z/i)
+      raise ArgumentError, "Invalid interval \"#{interval}\". Use e.g. \"12h\", \"30m\", or \"60s\"." unless match
+
+      value = match[1].to_i
+      unit = match[2].downcase
+
+      case unit
+      when "h" then value * 3600
+      when "m" then value * 60
+      when "s" then value
+      end
+    end
+
+    def ping_with_retry(db)
+      MAX_RETRIES.times do |i|
+        attempt = i + 1
+        begin
+          result = db.command(ping: 1)
+          logger.info("[mongo-keepalive] Ping successful: #{result.documents.first}")
+          return
+        rescue Mongo::Error => e
+          logger.warn("[mongo-keepalive] Ping attempt #{attempt}/#{MAX_RETRIES} failed: #{e.message}")
+          sleep(RETRY_DELAY) if attempt < MAX_RETRIES
+        end
+      end
+      logger.error("[mongo-keepalive] All #{MAX_RETRIES} ping attempts failed. Will retry at next interval.")
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: mongo-keepalive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- mongo-keepalive contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+description: Periodically sends a ping command to prevent MongoDB Atlas free-tier
+  clusters from becoming inactive.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/keepalive.rb
+homepage: https://github.com/YadavSourabhGH/mongo-keepalive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Keep MongoDB Atlas free-tier clusters alive
+test_files: []