sd_notify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ca0c254a94d204fddc97bf051fbf5e1a3ad8697
+  data.tar.gz: 342501c3de33d0cd45edabbf8f4a9b5adc2ba41f
+SHA512:
+  metadata.gz: be54ed4907b91bbd92963cb0cd4b524ec2b2763346f92772f99a5bd2d723faa05a34dea3ed23319c85fb4fd159d60a74dcdad4e5d2c8ecdb34a99136f6d3d4be
+  data.tar.gz: 736bd5cbdd81d7a18fe4aabe9c57762545a3c16b428f06bdbba086858249b399ab72c7ee134745a4fe4f5a33e276a940c40bc9d50368682deaffa8054fc3d177

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License
+
+Copyright (c) 2017 Agis Anastasopoulos
+
+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,56 @@
+# ruby-sdnotify
+
+[![Gem Version](https://badge.fury.io/rb/ruby-sdnotify.svg)](https://badge.fury.io/rb/ruby-sdnotify)
+[![Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/agis/ruby-sdnotify)
+
+A pure Ruby implementation of [sd_notify(3)](https://www.freedesktop.org/software/systemd/man/sd_notify.html) that can be used to
+communicate state changes of Ruby programs to [systemd](https://www.freedesktop.org/wiki/Software/systemd/).
+
+Refer to the [API documentation](http://www.rubydoc.info/github/agis/ruby-sdnotify) for more info.
+
+## Getting started
+
+Install ruby-sdnotify:
+
+```shell
+$ gem install ruby-sdnotify
+```
+
+If you're using Bundler, add it to your Gemfile:
+
+```ruby
+gem "ruby-sdnotify"
+```
+
+and run `bundle install`.
+
+## Usage
+
+The [API](http://www.rubydoc.info/github/agis/ruby-sdnotify) is mostly tied to
+the official implementation, therefore refer to the [sd_notify(3) man pages](https://www.freedesktop.org/software/systemd/man/sd_notify.html)
+for detailed description of how the notification mechanism works.
+
+An example (assuming the program shipped as a systemd service):
+
+```ruby
+require "sd_notify"
+
+puts "Hello. Booting..."
+sleep 2 # do some initialization work ...
+SdNotify.ready
+
+sum = 0
+5.times do |i|
+  sleep 1 # perform some work
+  sum += 1
+  SdNotify.status("{sum} jobs completed")
+end
+
+puts "Finished working, shutting down..."
+SdNotify.stopping
+sleep 2 # do cleanup work...
+```
+
+## License
+
+ruby-sdnotify is licensed under MIT. See [LICENSE](LICENSE).

data/lib/sd_notify.rb

@@ -0,0 +1,97 @@
+require "socket"
+
+# SdNotify is a pure-Ruby implementation of sd_notify(3). It can be used to
+# notify systemd about state changes. Methods of this package are no-op on
+# non-systemd systems (eg. Darwin).
+#
+# The API maps closely to the original implementation of sd_notify(3),
+# therefore be sure to check the official man pages prior to using SdNotify.
+#
+# @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+module SdNotify
+  # Exception raised when there's an error writing to the notification socket
+  class NotifyError < RuntimeError; end
+
+  READY     = "READY=1"
+  RELOADING = "RELOADING=1"
+  STOPPING  = "STOPPING=1"
+  STATUS    = "STATUS="
+  ERRNO     = "ERRNO="
+  MAINPID   = "MAINPID="
+  WATCHDOG  = "WATCHDOG=1"
+  FDSTORE   = "FDSTORE=1"
+
+  def self.ready(unset_env=false)
+    notify(READY, unset_env)
+  end
+
+  def self.reloading(unset_env=false)
+    notify(RELOADING, unset_env)
+  end
+
+  def self.stopping(unset_env=false)
+    notify(STOPPING, unset_env)
+  end
+
+  # @param status [String] a custom status string that describes the current
+  #   state of the service
+  def self.status(status, unset_env=false)
+    notify("#{STATUS}#{status}", unset_env)
+  end
+
+  # @param errno [Integer]
+  def self.errno(errno, unset_env=false)
+    notify("#{ERRNO}#{errno}", unset_env)
+  end
+
+  # @param pid [Integer]
+  def self.mainpid(pid, unset_env=false)
+    notify("#{MAINPID}#{pid}", unset_env)
+  end
+
+  def self.watchdog(unset_env=false)
+    notify(WATCHDOG, unset_env)
+  end
+
+  def self.fdstore(unset_env=false)
+    notify(FDSTORE, unset_env)
+  end
+
+  # Notify systemd with the provided state, via the notification socket, if
+  # any.
+  #
+  # Generally this method will be used indirectly through the other methods
+  # of the library.
+  #
+  # @param state [String]
+  # @param unset_env [Boolean]
+  #
+  # @return [Fixnum, nil] the number of bytes written to the notification
+  #   socket or nil if there was no socket to report to (eg. the program wasn't
+  #   started by systemd)
+  #
+  # @raise [NotifyError] if there was an error communicating with the systemd
+  #   socket
+  #
+  # @see https://www.freedesktop.org/software/systemd/man/sd_notify.html
+  def self.notify(state, unset_env=false)
+    sock = ENV["NOTIFY_SOCKET"]
+
+    return nil if !sock
+
+    ENV.delete("NOTIFY_SOCKET") if unset_env
+
+    connected = false
+
+    begin
+      sock = Addrinfo.unix(sock, :DGRAM).connect
+      connected = true
+      sock.close_on_exec = true
+      sock.write(state)
+    rescue StandardError => e
+      raise NotifyError, "#{e.class}: #{e.message}", e.backtrace
+    ensure
+      sock.close if connected
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: sd_notify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Agis Anastasopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-15 00:00:00.000000000 Z
+dependencies: []
+description: sd_notify can be used to notify systemd about various service status
+  changes of Ruby programs
+email: agis.anast@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sd_notify.rb
+homepage: https://github.com/agis/ruby-sdnotify
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Pure Ruby implementation of systemd's sd_notify(3)
+test_files: []