rufus-daemon 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e223784d24bf2446f29d91e3828094d1146d629ccb5cf09fde6056e48a2f5d80
+  data.tar.gz: 154fb35fad31697e6e7f3aa4a4efc90cec18c82c6df7d1b77319f3b5a6b8433a
+SHA512:
+  metadata.gz: 479f339eeae9f8c460d1cbbc5887bab1031314c745b87d76d8036dd73a244f2e501724f06f377e75e519bbf8adccc405eff728811e8bcc6a9f2a94aed62a9205
+  data.tar.gz: f7f153e94c0f41ebac64f686d78585602322415022559116ac91f62045c41cf731d96abde9136159b2d6c489b47bde46945411e39581b0d51ce8554e11d83b34

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+*.rbc
+.byebug_history
+.DS_Store
+Gemfile.lock
+
+*.swp
+*.swo
+*~

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  #gem "minitest", "~> 5.0"
+  #gem "rake", "~> 13.0"
+  #gem "rubocop", "~> 1.21"
+  #gem "yard", "~> 0.9"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    mirrorfile (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.27.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.7.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.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.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    yard (0.9.38)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  mirrorfile!
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.7.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Your Name
+
+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/README.md

@@ -0,0 +1,75 @@
+# rufus-daemon
+
+Run a rufus-scheduler daemon in the background, with access to the instance over DRb unix socket.
+Lovingly built to prevent hanging processes.
+
+## Why?
+1. Get status updates on your jobs
+2. Build a job querying service
+3. Allow other processes to dynamically schedule jobs
+4. Organise schedule files in ~/.rufus
+5. ???
+6. Profit
+
+## Install
+```ruby
+gem install rufus-daemon
+```
+
+## Usage
+
+### Running the command line
+```bash
+$ rufus --help
+Usage: rufus [options]
+
+Example: rufus --start
+
+Options:
+        --start
+        --restart
+        --stop
+        --status
+        --list
+
+Help options:
+        --help
+```
+
+### Access the rufus instance over DRb socket
+```ruby
+require 'rufus/daemon'
+
+Rufus::Daemon.attach.then do |service|
+  puts service.rufus # the rufus-scheduler instance
+
+  # .jobs is a helper that deserializes the jobs before sending
+  # over DRb socket. Otherwise you get a marshalling error.
+  service.jobs.each do |job|
+    puts job
+  end
+end
+```
+
+###
+The daemon will load both a `~/rufus.rb` file, and all files inside `~/.rufus` with the glob  `~/.rufus/**/*.rb`.
+Here's what your files can look like.
+```
+every '10s' do
+  # call something
+end
+
+cron '0 9 * * *' do
+  # call something
+end
+```
+
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#require "bundler/gem_tasks"
+#require "rake/testtask"
+#require "yard"
+#
+#Rake::TestTask.new(:test) do |t|
+#  t.libs << "test"
+#  t.libs << "lib"
+#  t.test_files = FileList["test/**/*_test.rb"]
+#end
+#
+#YARD::Rake::YardocTask.new do |t|
+#  t.files = ["lib/**/*.rb"]
+#  t.options = ["--markup", "markdown"]
+#end
+#
+#task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/rufus/daemon"
+require "irb"
+
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/exe/rufus

@@ -0,0 +1,122 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/rufus/daemon'
+
+#def install
+#  # install systemd service
+#  #
+#  File.write 'filename', <<~SERVICE
+#    what ever goes in a service file
+#  SERVICE
+#end
+
+SCHEDULE_FILE = File.expand_path("~/rufus.rb")
+SCHEDULE_DIR = File.expand_path("~/.rufus")
+
+# Your schedule file can look like this:
+#
+#   every '10s' do
+#     puts "hello"
+#   end
+#   
+#   cron '0 9 * * *' do
+#     puts "morning"
+#   end
+
+def start
+  Rufus::Daemon.start
+  sleep 1
+
+  if File.exist?(SCHEDULE_FILE)
+    Rufus::Daemon.attach.then do |daemon|
+      if daemon.jobs.empty?
+        daemon.load_schedule(SCHEDULE_FILE)
+      end
+    end
+  end
+
+  if Dir.exist?(SCHEDULE_DIR)
+    Rufus::Daemon.attach.then do |daemon|
+      if daemon.jobs.empty?
+        Dir.glob("#{SCHEDULE_DIR}/**/*.rb").each do |file|
+          daemon.load_schedule(file)
+        end
+      end
+    end
+  end
+rescue DRb::DRbConnError
+  puts "Failed to connect after start"
+  puts "Therefore, couldn't load schedule"
+end
+
+def stop
+  Rufus::Daemon.stop
+end
+
+def restart
+  stop
+  sleep 1
+  start
+end
+
+def status
+  Rufus::Daemon.attach.rufus.then do |rufus|
+    puts "Total jobs: #{rufus.jobs.count}"
+  end
+rescue DRb::DRbConnError => e
+  puts "Not started"
+  puts e
+end
+
+def list
+  Rufus::Daemon.attach.then do |rufus|
+    if rufus.jobs.any?
+      rufus.jobs.each do |job|
+        puts job
+      end
+    else
+      puts "No jobs"
+    end
+  end
+rescue DRb::DRbConnError => e
+  puts "Not started"
+  puts e
+end
+
+OptionParser.new.instance_exec do
+  banner = 'Usage: rufus [options]'
+
+  separator ''
+  separator 'Example: rufus --start'
+
+  separator ''
+  separator 'Options:'
+
+  on('--install') { install; exit }
+  on('--start')   { start;   exit }
+  on('--restart') { restart; exit }
+  on('--stop')    { stop;    exit }
+  on('--status')  { status;  exit }
+  on('--list')    { list;    exit }
+
+  separator ''
+  separator 'Help options:'
+
+  on('--help') { puts self; exit }
+
+  if ARGV.empty?
+    puts self
+  else
+    case ARGV.first.to_sym
+    when :start   then start
+    when :restart then restart
+    when :stop    then stop
+    when :status  then status
+    when :list    then list
+    when :help    then puts self
+    else
+      parse!
+    end
+  end
+end

data/lib/rufus/daemon.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'drb/drb'
+require 'fileutils'
+require 'rufus-scheduler'
+
+module Rufus
+  class Daemon
+    VERSION = "1.0.0"
+
+    SOCKET_DIR = "/tmp/drb-sockets"
+    SOCKET_FILE = SOCKET_DIR + "/rufus.sock"
+    SOCKET_URI = "drbunix://#{SOCKET_FILE}"
+
+    attr_reader :rufus
+
+    def initialize
+      @rufus = Rufus::Scheduler.new
+      @drb = DRb.start_service(SOCKET_URI, self)
+    end
+
+    def uri = @drb.uri
+
+    def load_schedule(path)
+      @rufus.instance_eval(File.read(path))
+    end
+
+    def stop
+      @rufus.shutdown
+    ensure
+      DRb.stop_service
+    end
+
+    def jobs
+      @rufus.jobs.map do |job|
+        {
+          id: job.id,
+          scheduled_at: job.scheduled_at.to_s,
+          next_time: (job.next_time.to_s if job.respond_to?(:next_time)),
+          last_time: (job.last_time.to_s if job.respond_to?(:last_time)),
+          tags: job.tags,
+          original: job.original
+        }.compact
+      end
+    end
+
+    def self.attach
+      DRbObject.new_with_uri(SOCKET_URI)
+    end
+
+    def self.stop
+      attach.stop
+      puts "Rufus stopped"
+    rescue DRb::DRbConnError
+      puts "Already Stopped"
+    end
+
+    def self.start
+      FileUtils.mkdir_p(SOCKET_DIR)
+
+      fork do
+        Process.setsid
+
+        fork do
+          daemon = new
+          puts "Rufus started - #{daemon.uri}"
+          DRb.thread.join
+        rescue Errno::EADDRINUSE
+          puts "Already started"
+        end
+
+        exit # closes the process after DRb ends
+      end
+
+      Process.wait # no idea what this does
+    end
+  end
+end

data/rufus-daemon.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rufus/daemon"
+
+Gem::Specification.new do |spec|
+  spec.name = "rufus-daemon"
+  spec.version = Rufus::Daemon::VERSION
+  spec.authors = ["Nathan Kidd"]
+  spec.email = ["nathankidd@hey.com"]
+
+  spec.summary = "Run rufus-scheduler in the background"
+
+  spec.description = <<~DESC
+    Run rufus-scheduler in the background with a DRb unix socket.
+    You can save schedule files in the ~/.rufus directory or as ~/rufus.rb
+  DESC
+
+  spec.homepage = "https://github.com/n-at-han-k/rufus-daemon"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|data)/}) }
+  spec.bindir = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  #spec.add_development_dependency "minitest", "~> 5.0"
+  #spec.add_development_dependency "rake", "~> 13.0"
+  #spec.add_development_dependency "rubocop", "~> 1.21"
+  #spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: rufus-daemon
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kidd
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Run rufus-scheduler in the background with a DRb unix socket.
+  You can save schedule files in the ~/.rufus directory or as ~/rufus.rb
+email:
+- nathankidd@hey.com
+executables:
+- rufus
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rufus
+- lib/rufus/daemon.rb
+- rufus-daemon.gemspec
+homepage: https://github.com/n-at-han-k/rufus-daemon
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/n-at-han-k/rufus-daemon
+  source_code_uri: https://github.com/n-at-han-k/rufus-daemon
+  documentation_uri: https://github.com/n-at-han-k/rufus-daemon
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Run rufus-scheduler in the background
+test_files: []