systemdy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abda4b02a15b8b3dcf89cc3c92fe53027b67708cf07b37b0274f51f11d1e0e07
+  data.tar.gz: 94edeaca38a67b73676e7301f23bcdc25e87da29dce75d4584c36adc3a3f04d0
+SHA512:
+  metadata.gz: 30eda44f1659af67b18de78cb20be466f0986220e4a40963b83bbbc3422dad3a3809dc2f9f94a26bca7f236890ee4e0c682c66edb548d4a280c31a3ad2090f7c
+  data.tar.gz: 868bac0eb61ea2bb42fe849e421fad778d3fc6605f0a43f5c054fd9ac3870674662e19895cc3cfc97980b09e0ed59a5c770551106c3f8f87295bcb43866a6295

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-09-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in systemd.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    systemdy (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  systemdy!
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write 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,637 @@
+# Systemd
+
+<div align="center">
+
+![GitHub repo size](https://img.shields.io/github/repo-size/magic4dev/systemdy?label=size&style=flat-square)
+[![GitHub issues](https://img.shields.io/github/issues/magic4dev/systemdy?style=flat-square)](https://github.com/magic4dev/systemdy/issues)
+[![GitHub forks](https://img.shields.io/github/forks/magic4dev/systemdy?style=flat-square)](https://github.com/magic4dev/systemdy/network)
+[![GitHub license](https://img.shields.io/github/license/magic4dev/systemdy?style=flat-square)](https://github.com/magic4dev/systemdy/blob/master/LICENSE.txt)
+[![GitHub stars](https://img.shields.io/github/stars/magic4dev/systemdy?style=flat-square)](https://github.com/magic4dev/systemdy/stargazers)
+
+</div>
+
+A lightweight gem for interact with systemd.
+
+If your goal is to develop software to quickly manage systemd services or journalctl logs, this gem is for you! :grin:
+
+
+## Features
+
+- Lightweight
+- Expressive classes and methods
+- Manage systemd's services lifecycle with minimal effort!
+- Extract and manipulate Journalctl logs with a single action!
+
+## Table of contents
+* [Installation](#installation)
+* [Dependencies](#dependencies)
+* [Usage](#usage)
+* [Manage services](#manage-services)
+  * [Create a Systemdy Service object for control a service](#create-a-systemdy-service-object-for-control-a-service)
+  * [Check if the provided service exist](#check-if-the-provided-service-exist)
+  * [Check if the provided service is enabled](#check-if-the-provided-service-is-enabled)
+  * [Check if the provided service is active](#check-if-the-provided-service-is-active)
+  * [Check the current status of the provided service](#check-the-current-status-of-the-provided-service)
+  * [Display all the properties for the provided service](#check-the-current-status-of-the-provided-service)
+  * [Start the service](#start-the-service)
+  * [Restart the service](#restart-the-service)
+  * [Stop the service](#stop-the-service)
+  * [Enable the service](#enable-the-service)
+  * [Disable the service](#disable-the-service)
+  * [Reload the service](#reload-the-service)
+  * [Mask the service](#mask-the-service)
+  * [Unmask the service](#unmask-the-service)
+  * [Bonus tip: execute systemctl commands without prompt the password](#bonus-tip-execute-systemctl-commands-without-prompt-the-password)
+* [Manage Journalctl logs](#manage-journalctl-logs)
+  * [Display kernel logs](#display-kernel-logs)
+  * [Display boot logs](#display-boot-logs)
+  * [Display unit logs](#display-unit-logs)
+  * [Display group_id logs (GUID)](#display-group_id-logs-guid)
+  * [Display user_id logs (UID)](#display-user_id-logs-uid)
+* [Contributing](#contributing)
+  * [Develop a new feature](#develop-a-new-feature) 
+  * [Fix a bug](#fix-a-bug) 
+* [Note for testing](#note-for-testing) 
+* [License](#license)
+* [Useful links and resources](#useful-links-and-resources)
+* [Acknowledgements](#acknowledgements) 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'systemdy'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install systemdy
+## Dependencies
+
+The only dependecy you need is [systemd](http://www.freedesktop.org/wiki/Software/systemdy/) installed on your system (specifically libsystemd or the older libsystemdy-journal) in order to use the gem. Currently the gem support systemd 249 or higher.
+## Usage
+
+After installing the gem, the first step is to require it:
+
+```ruby
+require 'systemdy'
+```
+## Manage services
+
+The first goal of this gem is to manage a systemd's service with minimal effort.
+
+This section provides an overview of the Systemdy::Service class for managing the life cycle of a systemdy's service.
+
+### Create a Systemdy Service object for control a service
+
+The first step is to create a new instance of the systemdy::Service class for control the desired service
+
+```ruby
+my_postgresql_service = Systemdy::Service.new('postgresql')
+```
+
+### Check if the provided service exist
+
+Once our object has been instantiated, you can check if the service is installed on your system
+
+```ruby
+my_postgresql_service.exist?
+```
+
+For check if a service is installed on your system without create a new instance of the Systemdy::Service class
+
+```ruby
+Systemdy::Utility::Validator.check_if_a_service_exist('postgresql')
+```
+if the provided service is installed on your system this methods return _**true**_, otherwise return _**false**_.
+
+### Check if the provided service is enabled
+
+For check if a service is enabled
+
+```ruby
+my_postgresql_service.is_enabled?
+```
+if the provided service is enabled this method return _**true**_, otherwise return _**false**_.
+
+### Check if the provided service is active
+
+For check if a service is active
+
+```ruby
+my_postgresql_service.is_active?
+```
+if the provided service is active this method return _**true**_, otherwise return _**false**_.
+
+### Check the current status of the provided service
+
+For check the current status of the service 
+```ruby
+my_postgresql_service.status
+```
+Once executed, this method return an hash with all the essential service's information like this:
+
+```ruby
+ { "Id"=>"postgresql.service",              
+   "Description"=>"PostgreSQL RDBMS",          
+   "ExecMainPID"=>"48615",
+   "LoadState"=>"loaded",
+   "ActiveState"=>"active",
+   "FragmentPath"=>"/lib/systemd/system/postgresql.service",
+   "ActiveEnterTimestamp"=>"Thu 2022-09-29 17:13:07 CEST",
+   "InactiveEnterTimestamp"=>"Thu 2022-09-29 17:12:44 CEST",
+   "ActiveExitTimestamp"=>"Thu 2022-09-29 17:12:44 CEST",
+   "InactiveExitTimestamp"=>"Thu 2022-09-29 17:13:07 CEST"
+ } 
+```
+### Display all the properties for the provided service
+
+For check all the properties of the service 
+```ruby
+my_postgresql_service.properties
+```
+Once executed, this method return an hash with all the service's properties like this:
+
+```ruby
+ { "Type"=>"oneshot",
+    "Restart"=>"no",
+    "NotifyAccess"=>"none",
+    ....
+ }
+```
+
+To extract the value of a specific property
+
+```ruby
+my_postgresql_service.properties["MemorySwapMax"]
+```
+
+### Start the service
+
+For start the service 
+```ruby
+my_postgresql_service.start
+```
+
+### Restart the service
+
+For restart the service 
+```ruby
+my_postgresql_service.restart
+```
+
+### Stop the service
+
+For stop the service 
+```ruby
+my_postgresql_service.stop
+```
+
+### Enable the service
+
+For enable the service 
+```ruby
+my_postgresql_service.enable
+```
+
+### Disable the service
+
+For disable the service 
+```ruby
+my_postgresql_service.disable
+```
+
+### Reload the service
+
+For reload the service 
+```ruby
+my_postgresql_service.reload
+```
+
+### Mask the service
+
+For mask the service 
+```ruby
+my_postgresql_service.mask
+```
+### Unmask the service
+
+For unmask the service 
+```ruby
+my_postgresql_service.unmask
+```
+## Bonus tip: execute systemctl commands without prompt the password
+
+The methods **start**, **restart**, **stop**, **enable**, **disable**, **reload**, **mask** and **unmask** detect non-root users and automatically execute the methods with sudo.
+
+By default, sudo needs that a non-root user(in this case you) is authenticated using a password for complete the method execution. This is a great thing, but some times you may need to execute this methods without type the password. 
+
+In this case you need to configure sudo without a password.
+
+The first step for achieve this is gain root access:
+
+```console
+non_root_user@my-machine:~$ sudo -i
+[sudo] password for non_root_user: 
+```
+
+After provided the correct password backup your /etc/sudoers file by typing the following command:
+
+```console
+root@my-machine:~# cp /etc/sudoers /root/sudoers.bak 
+```
+
+Next step is edit the /etc/sudoers file by typing the visudo command:
+
+```console
+root@my-machine:~# visudo 
+```
+
+Append/edit the following lines in the /etc/sudoers file and substitute 'your_account_name' with your linux account name.
+```console
+'your_account_name' ALL=(ALL) NOPASSWD: /bin/systemctl
+```
+
+This line anable you to run ‘systemctl’ commands without a password. 
+
+Save with CTRL + X
+
+```console
+root@my-machine:~# exit
+```
+Exit from root session and you are ready to go! :sunglasses:
+## Manage Journalctl logs
+
+The second goal of this gem is to provide a set of useful methods for retrieving journalctl log data.
+
+This section provides a brief overview of the Systemdy::Journal class for managing journalctl log information.
+
+### Display kernel logs
+
+Sometimes we need to check if the kernel is working properly or if something went wrong to get useful information to help us fix the problem.
+
+For getting the kernel logs 
+
+```ruby
+Systemdy::Journal.display_kernel_logs
+```
+This class method executed with no arguments return an array with: 
+* a default size of 10 (the last 10 lines of log)
+* a start period not older than '00:00 AM' o' clock (today)
+* an end period not newer than the method execution timenow
+
+Obviously this method allows you to filter the kernel logs by passing **3** positional arguments:
+
+* **since**: a start period not older than the specified date
+
+* **to**: an end period not older than the specified date
+
+* **lines**: the exact number of last log lines 
+
+For example:
+
+If you want to analyze the last 50 log lines ranging from a month ago to 10:00 of the current day:
+
+```ruby
+Systemdy::Journal.display_kernel_logs(since: '1 month ago', to: '10:00', lines: 50)
+```
+
+If you want to analyze the last 20 log lines ranging from a week ago to yesterday:
+
+```ruby
+Systemdy::Journal.display_kernel_logs(since: '1 week ago', to: 'yesterday', lines: 20)
+```
+
+You can also filter the logs by specific dates in the format YYYY-MM-DD for example:
+
+```ruby
+Systemdy::Journal.display_kernel_logs(since: '2022-08-27', lines: 200)
+```
+
+If the passed arguments not match anything the method return an array with a message like this:
+
+```ruby
+["-- No entries --"]
+```
+
+### Display boot logs
+
+Sometimes we need to know if our system is working properly at boot time and if something went wrong to get useful information to help us fix the problem.
+
+For getting the boot logs 
+
+```ruby
+Systemdy::Journal.display_boot_logs
+```
+This class method executed with no arguments return an array with: 
+* a default size of 10 (the last 10 lines of log)
+* a start period not older than '00:00 AM' o' clock (today)
+* an end period not newer than the method execution timenow
+
+Obviously as for the previous method, you can filter the boot logs by passing **4** positional arguments:
+
+* **argument**: in this case the boot's number
+
+* **since**: a start period not older than the specified date
+
+* **to**: an end period not older than the specified date
+
+* **lines**: the exact number of last log lines 
+
+For example:
+
+If you want to analyze the last 50 log lines of the second boot ranging from a month ago to 10:00 of the current day:
+
+```ruby
+Systemdy::Journal.display_boot_logs(argument: 2, since: '1 month ago', to: '10:00', lines: 50)
+```
+
+If you want to analyze the last 20 log of the third boot lines ranging from a week ago to yesterday:
+
+```ruby
+Systemdy::Journal.display_boot_logs(argument: 3, since: '1 week ago', to: 'yesterday', lines: 20)
+```
+
+You can also filter the logs by specific dates in the format YYYY-MM-DD for example:
+
+```ruby
+Systemdy::Journal.display_boot_logs(since: '2022-08-27', lines: 200)
+```
+If the passed arguments not match anything the method return an array with a message like this:
+
+```ruby
+["-- No entries --"]
+```
+
+### Display unit logs
+
+Another common task is to filter logs based on the unit that we need information on. 
+
+To do this, we just simply need to pass the name of the unit as argument, for example we need to analyze postgresql unit logs:
+
+```ruby
+Systemdy::Journal.display_unit_logs(argument: 'postgresql')
+```
+
+In this case the class method return an array with: 
+* a default size of 10 (the last 10 lines of log)
+* a start period not older than '00:00 AM' o' clock (today)
+* an end period not newer than the method execution timenow
+
+Obviously this method require the unit's name as argument, if executed with no arguments return a message like this:
+
+```ruby
+"display_unit_logs require an argument!"
+```
+
+Obviously as for the previous method, you can filter the unit logs by passing **4** positional arguments:
+
+* **argument**: in this case the unit's name
+
+* **since**: a start period not older than the specified date
+
+* **to**: an end period not older than the specified date
+
+* **lines**: the exact number of last log lines 
+
+For example:
+
+If you want to analyze the last 50 log lines of the potsgresql service ranging from a month ago to 10:00 of the current day:
+
+```ruby
+Systemdy::Journal.display_unit_logs(argument: 'postgresql', since: '1 month ago', to: '10:00', lines: 50)
+```
+
+If you want to analyze the last 20 log lines of the potsgresql service ranging from a week ago to yesterday:
+
+```ruby
+Systemdy::Journal.display_unit_logs(argument: 'postgresql', since: '1 week ago', to: 'yesterday', lines: 20)
+```
+
+You can also filter the logs by specific dates in the format YYYY-MM-DD for example:
+
+```ruby
+Systemdy::Journal.display_unit_logs(argument: 'postgresql', since: '2022-08-27', lines: 200)
+```
+
+If the passed arguments not match anything the method return an array with a message like this:
+
+```ruby
+["-- No entries --"]
+```
+
+### Display group_id logs (GUID)
+
+To find all messages related to a particular group, we just simply need to pass the GUID of the group as argument, for example:
+
+```ruby
+Systemdy::Journal.display_group_id_logs(argument: 1000)
+```
+
+In this case the class method return an array with: 
+* a default size of 10 (the last 10 lines of log)
+* a start period not older than '00:00 AM' o' clock (today)
+* an end period not newer than the method execution timenow
+
+Obviously this method require the GUID as argument, if executed with no arguments return a message like this:
+
+```ruby
+"display_group_id_logs require an argument!"
+```
+
+Obviously as for the previous method, you can filter the GUID logs by passing **4** positional arguments:
+
+* **argument**: in this case the GUID
+
+* **since**: a start period not older than the specified date
+
+* **to**: an end period not older than the specified date
+
+* **lines**: the exact number of last log lines 
+
+For example:
+
+If you want to analyze the last 50 log lines of the GUID 1000 ranging from a month ago to 10:00 of the current day:
+
+```ruby
+Systemdy::Journal.display_group_id_logs(argument: 1000, since: '1 month ago', to: '10:00', lines: 50)
+```
+
+If you want to analyze the last 20 log lines of the GUID 1000 ranging from a week ago to yesterday:
+
+```ruby
+Systemdy::Journal.display_group_id_logs(argument: 1000, since: '1 week ago', to: 'yesterday', lines: 20)
+```
+
+You can also filter the logs by specific dates in the format YYYY-MM-DD for example:
+
+```ruby
+Systemdy::Journal.display_group_id_logs(argument: 1000, since: '2022-08-27', lines: 200)
+```
+
+If the passed arguments not match anything the method return an array with a message like this:
+
+```ruby
+["-- No entries --"]
+```
+
+### Display user_id logs (UID)
+
+To find all messages related to a particular user, we just simply need to pass the UID of the user as argument, for example:
+
+```ruby
+Systemdy::Journal.display_user_id_logs(argument: 1000)
+```
+
+In this case the class method return an array with: 
+* a default size of 10 (the last 10 lines of log)
+* a start period not older than '00:00 AM' o' clock (today)
+* an end period not newer than the method execution timenow
+
+Obviously this method require the UID as argument, if executed with no arguments return a message like this:
+
+```ruby
+"display_user_id_logs require an argument!"
+```
+
+Obviously as for the previous method, you can filter the UID logs by passing **4** positional arguments:
+
+* **argument**: in this case the UID
+
+* **since**: a start period not older than the specified date
+
+* **to**: an end period not older than the specified date
+
+* **lines**: the exact number of last log lines 
+
+For example:
+
+If you want to analyze the last 50 log lines of the UID 1000 ranging from a month ago to 10:00 of the current day:
+
+```ruby
+Systemdy::Journal.display_user_id_logs(argument: 1000, since: '1 month ago', to: '10:00', lines: 50)
+```
+
+If you want to analyze the last 20 log lines of the UID 1000 ranging from a week ago to yesterday:
+
+```ruby
+Systemdy::Journal.display_user_id_logs(argument: 1000, since: '1 week ago', to: 'yesterday', lines: 20)
+```
+
+You can also filter the logs by specific dates in the format YYYY-MM-DD for example:
+
+```ruby
+Systemdy::Journal.display_user_id_logs(argument: 1000, since: '2022-08-27', lines: 200)
+```
+
+If the passed arguments not match anything the method return an array with a message like this:
+
+```ruby
+["-- No entries --"]
+```
+## Contributing
+
+We :heart: pull requests from everyone. 
+
+Everyone interacting in the systemdy project's codebases is expected to follow the [code of conduct](https://github.com/magic4dev/systemdy/blob/master/CODE_OF_CONDUCT.md).
+
+### Develop a new feature
+
+If you wanna develop a new feature:
+
+* Fork this project
+
+* Clone the repo with the following command:
+
+      git clone git@github.com:your-username/systemdy.git
+
+* Install dependencies with:
+
+      bin/setup
+
+* Make your changes
+* Write tests. 
+
+    **NOTE**: For a correct testing procedure read our [Note for testing](#note-for-testing)
+* Make the tests pass with the following command:
+
+      rake spec
+
+* Add notes about your changes to the `CHANGELOG.md` file
+
+* Write a good commit message
+* Push to your fork
+* [Submit a pull request](https://github.com/magic4dev/systemdy/compare)
+* Wait for us, we will reply as soon as possible
+* We may suggest changes for better code quality
+* Please, if you push more than mone commit let's keep the history clean :stuck_out_tongue_winking_eye:
+
+Thank you for your contribution! :handshake:
+
+### Fix a bug
+
+If you wanna fix a bug:
+
+* Fork this project
+
+* Clone the repo with the following command:
+
+      git clone git@github.com:your-username/systemdy.git
+
+* Install dependencies with:
+
+      bin/setup
+
+* Make your changes
+* Write tests. 
+
+    **NOTE**: For a correct testing procedure read our [Note for testing](#note-for-testing)
+* Make the tests pass with the following command:
+
+      rake spec
+
+* Add notes about your changes to the `CHANGELOG.md` file
+
+* Write a good commit message
+* Push to your fork
+* [Submit a pull request](https://github.com/magic4dev/systemdy/compare)
+* Wait for us, we will reply as soon as possible
+* We may suggest changes for better code quality
+* Please, if you push more than mone commit let's keep the history clean :stuck_out_tongue_winking_eye:
+
+Thank you for your contribution! :handshake:
+
+## Note for testing
+
+This gem was tested on a __postgresql__ service. 
+    
+For better testing install __postgresql__ service on your system.
+    
+If you don't want to install it:
+    
+* go to _spec/setup/test_variables.rb_ 
+
+and replace: 
+
+* let (:real_service_name) { 'postgresql' }
+
+with:
+
+* let (:real_service_name) { 'a_installed_service_on_your_system' }
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Useful links and resources
+
+ - An interesting article on [how to run sudo commands without password](https://www.linuxshelltips.com/run-sudo-commands-without-password/)
+ - The official systemdy documentation for [time specification](https://www.freedesktop.org/software/systemd/man/systemd.time.html)
+ 
+## Acknowledgements
+
+ - Thanks to [@colstrom](https://github.com/colstrom) and his [systemized](https://github.com/colstrom/systemized) for the great inspiration 

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+end
+
+task default: :spec

data/lib/systemdy/journal.rb

@@ -0,0 +1,115 @@
+module Systemdy
+    class Journal 
+
+        # extend SingleForwardableForwardable standard's library module for delegate a specified method to a designated object
+        extend SingleForwardable
+               
+        # list of options for execute journalctl command that not accept arguments
+        # Example command: journalctl -k
+        # the '-k' option not accept arguments
+        # journalctl -k [argument] return
+        # Failed to add match [argument]: Invalid argument
+        LIST_OF_OPTIONS_THAT_NOT_ACCEPT_ARGUMENTS = { kernel: '-k' }
+        
+        # list of options for execute journalctl command that accept arguments
+        # Example command: journalctl -b
+        # the '-b' option accept an argument (the number of the boot)
+        # journalctl -b postgresql return the boots's logs
+        # journalctl -b 3 return the third of the availables boot logs
+        LIST_OF_OPTIONS_THAT_ACCEPT_AN_ARGUMENT   = { boot: '-b' }
+
+        # list of options for execute journalctl command that require arguments
+        # Example command: journalctl -u
+        # the '-u' option require an argument (the name of the unit)
+        # journalctl -u postgresql return the postgresql's logs
+        # journalctl -u without an argument return
+        # journalctl: option requires an argument -- 'u' 
+        LIST_OF_OPTIONS_THAT_REQUIRE_AN_ARGUMENT  = { unit: '-u', group_id: '_GID', user_id: '_UID' }
+
+        # we delegate return_an_array_from_system_command method to Systemdy::Utility::Formatter class contained in Systemdy/utility/formatter.rb
+        def_delegator Systemdy::Utility::Formatter,        :return_an_array_from_system_command
+        # we delegate render_message method to Systemdy::Utility::MessageDisplayer class contained in Systemdy/utility/message_displayer.rb
+        def_delegator Systemdy::Utility::MessageDisplayer, :render_message 
+
+        # create dynamically class methods based on LIST_OF_OPTIONS_THAT_NOT_ACCEPT_ARGUMENTS constant
+        # we can call the methods:
+        # Systemdy::Journal.display_kernel_logs
+        # this method accept 3 keyword arguments:
+        # 1. since ('the log's initial period')  - String  - default 'yesterday' 
+        # 2. to    ('the log's end period')      - String  - default Time.now.strftime('%H:%M')
+        # 3. lines ('the log's number of lines') - Integer - default 10 .display_kernel_logs
+        # Example:
+        # Systemdy::Journal.display_kernel_logs(since: '1 month ago', lines: 50)
+        # if you call this method without arguments
+        # - it return an array with 10 lines of logs
+        LIST_OF_OPTIONS_THAT_NOT_ACCEPT_ARGUMENTS.each do |message_from, option|
+            define_singleton_method "display_#{message_from}_logs" do |since: 'today', to: Time.now.strftime('%H:%M'), lines: 10|
+                # logs from system call
+                logs = `#{JOURNALCTL_COMMAND} #{option} -S '#{since}' -U '#{to}' -n #{lines} | tail -n #{lines} 2>&1`
+                # logs from system call converted into array
+                return_an_array_from_system_command(logs) # class method contained in Systemdy/utility/formatter.rb
+            end
+        end
+        
+        # create dynamically class methods based on LIST_OF_OPTIONS_THAT_ACCEPT_AN_ARGUMENT constant
+        # we can call the methods:
+        # Systemdy::Journal.display_boot_logs
+        # this method accept 4 keyword arguments:
+        # 1. argument ('the boot's number')      - Integer - optional
+        # 2. since ('the log's initial period')  - String  - default 'yesterday' 
+        # 3. to    ('the log's end period')      - String  - default Time.now.strftime('%H:%M')
+        # 4. lines ('the log's number of lines') - Integer - default 10 
+        # Example:
+        # Systemdy::Journal.display_boot_logs(argument: 3, since: '1 month ago', lines: 50)
+        # if you call this method without arguments
+        # - it return an array with 10 lines of logs
+        LIST_OF_OPTIONS_THAT_ACCEPT_AN_ARGUMENT.each do |message_from, option|
+            define_singleton_method "display_#{message_from}_logs" do |argument: '', since: 'today', to: Time.now.strftime('%H:%M'), lines: 10|
+                # logs from system call
+                logs = `#{JOURNALCTL_COMMAND} #{option} #{argument} -S '#{since}' -U '#{to}' -n #{lines} | tail -n #{lines} 2>&1`
+                # logs from system call converted into array
+                return_an_array_from_system_command(logs) # class method contained in Systemdy/utility/formatter.rb
+            end
+        end
+        
+        # create dynamically class methods based on LIST_OF_OPTIONS_THAT_REQUIRE_AN_ARGUMENT constant
+        # we can call the methods:
+        # Systemdy::Journal.display_unit_logs
+        # Systemdy::Journal.display_group_id_logs
+        # Systemdy::Journal.display_user_id_logs
+        # this method accept 4 keyword arguments:
+        # 1. argument ('the unit, the group_id or user_id) - String  - required
+        # 2. since ('the log's initial period')  - String  - default 'yesterday' 
+        # 3. to    ('the log's end period')      - String  - default Time.now.strftime('%H:%M')
+        # 4. lines ('the log's number of lines') - Integer - default 10 
+        # Example:
+        # Systemdy::Journal.display_unit_logs(argument: 'postgresql', since: '1 month ago', lines: 50)
+        # Systemdy::Journal.display_user_id_logs(argument: 1000, since: '1 month ago', lines: 50)
+        # Systemdy::Journal.display_group_id_logs(argument: 1000, since: '1 month ago', lines: 50)
+        LIST_OF_OPTIONS_THAT_REQUIRE_AN_ARGUMENT.each do |message_from, option|
+            define_singleton_method "display_#{message_from}_logs" do |argument: '', since: 'today', to: Time.now.strftime('%H:%M'), lines: 10|
+                # return an error message if the required argument is not provided
+                # render_message class method contained in Systemdy/utility/message_displayer.rb
+                return render_message("display_#{message_from}_logs require an argument!") if argument.to_s.empty?
+                # combination of option and argument based on typology
+                # '-u postgresql' or '_GUID=1000' or '_UID=1000'
+                option_with_argument = merge_option_with_argument_based_on_option_typology(message_from, option, argument)
+                # logs from system call
+                logs                 = `#{JOURNALCTL_COMMAND} #{option_with_argument} -S '#{since}' -U '#{to}' | tail -n #{lines} 2>&1`
+                # logs from system call converted into array
+                return_an_array_from_system_command(logs) # class method contained in Systemdy/utility/formatter.rb
+            end
+        end
+
+        # method for return formatted option
+        # Example
+        # merge_option_with_argument_based_on_option_typology(:unit, '-u', 'postgresql') return '-u postgresql'
+        # merge_option_with_argument_based_on_option_typology(:group_id, '_GUID', 1234566) return '_GUID=1000'
+        def self.merge_option_with_argument_based_on_option_typology(message_from, option, argument)
+            message_from == :unit ? "#{option} #{argument}" : "#{option}=#{argument}"
+        end
+
+        # make the methods below as private
+        private_class_method :return_an_array_from_system_command, :render_message, :merge_option_with_argument_based_on_option_typology
+    end 
+end    

data/lib/systemdy/service.rb

@@ -0,0 +1,122 @@
+module Systemdy
+    class Service 
+
+        # extend Forwardable standard's library module for delegate a specified method to a designated object
+        extend Forwardable
+
+        # list of supported actions on a provided service
+        LIST_OF_ACTIONS           = %w( start restart stop enable disable reload mask unmask )
+
+        # list of supported statuses on a provided service
+        LIST_OF_STATUSES          = %w( enabled active )
+
+        # list of status properties on a provided service when status command is called
+        LIST_OF_STATUS_PROPERTIES = %w( Id Description ExecMainPID LoadState ActiveState FragmentPath 
+                                        ActiveEnterTimestamp InactiveEnterTimestamp ActiveExitTimestamp 
+                                        InactiveExitTimestamp 
+                                    )
+
+        attr_reader :command, :name
+
+        # we create a new object that accept 1 argument:
+        # 1. the name of the Systemdy service to control (postgresql, redis etc..)
+        # Example:
+        # my_postgresql_service = Systemdy::Service.new('postgresql')
+        def initialize(name)
+            @command   = SYSTEMCTL_COMMAND # constant contained in Systemdy.rb
+            @name      = name 
+        end
+
+        # we delegate return_an_array_from_system_command method to Systemdy::Utility::Formatter class contained in Systemdy/utility/formatter.rb
+        def_delegator Systemdy::Utility::Formatter,        :return_an_array_from_system_command
+        # we delegate render_message method to Systemdy::Utility::MessageDisplayer class contained in Systemdy/utility/message_displayer.rb
+        def_delegator Systemdy::Utility::MessageDisplayer, :render_message 
+        # we delegate check_if_a_service_exist method to Systemdy::Utility::Validator class contained in Systemdy/utility/validator.rb
+        def_delegator Systemdy::Utility::Validator,        :check_if_a_service_exist 
+        # we delegate filter_by_keys method to Systemdy::Utility::KeyValueFilter class contained in Systemdy/utility/key_value.rb
+        def_delegator Systemdy::Utility::KeyValueFilter,   :filter_by_keys 
+
+        # method for check if a created service exist
+        # Example:
+        # my_postgresql_service.exist?
+        # if the provided service exist this method return
+        # - true
+        # otherwise return
+        # - false
+        def exist? 
+            check_if_a_service_exist(name) # class method contained in Systemdy/utility/validator.rb
+        end
+        
+        # create dynamically methods based on LIST_OF_ACTIONS constant
+        # after created a new object we can call the methods:
+        # my_postgresql_service.start
+        # my_postgresql_service.restart
+        # my_postgresql_service.stop
+        # my_postgresql_service.enable
+        # my_postgresql_service.disable
+        # my_postgresql_service.reload
+        # my_postgresql_service.mask
+        # my_postgresql_service.unmask
+        LIST_OF_ACTIONS.each do |action|
+            define_method action do 
+                sudo_command = Etc.getpwuid(Process.uid).name != 'root' ? 'sudo' : ''
+                exist? ? `#{sudo_command} #{command} #{action} #{name}` : default_error_message()
+            end
+        end
+
+        # method for return a key/value pair of the provided service's properties
+        # Example:
+        # my_postgresql_service.properties
+        # return a key/value pair of the provided service's properties
+        # { "Type"=>"oneshot",
+        #   "Restart"=>"no",
+        #   "NotifyAccess"=>"none",
+        #   ....
+        # }
+        def properties
+            array_of_properties = return_an_array_from_system_command(`#{command} show #{name}`)
+            array_of_properties.collect { |property| { property.split('=')[0] => property.split('=')[1] } }.reduce({}, :merge)
+        end
+
+        # method for return the current status of the provided service
+        # Example:
+        # my_postgresql_service.status
+        # return a key/value pair of the provided service's status
+        # { "Id"=>"postgresql.service",              
+        #   "Description"=>"PostgreSQL RDBMS",          
+        #   "ExecMainPID"=>"48615",
+        #   "LoadState"=>"loaded",
+        #   "ActiveState"=>"active",
+        #   "FragmentPath"=>"/lib/Systemdy/system/postgresql.service",
+        #   "ActiveEnterTimestamp"=>"Thu 2022-09-29 17:13:07 CEST",
+        #   "InactiveEnterTimestamp"=>"Thu 2022-09-29 17:12:44 CEST",
+        #   "ActiveExitTimestamp"=>"Thu 2022-09-29 17:12:44 CEST",
+        #   "InactiveExitTimestamp"=>"Thu 2022-09-29 17:13:07 CEST"
+        # } 
+        def status 
+            exist? ? filter_by_keys(properties, LIST_OF_STATUS_PROPERTIES) : default_error_message()
+        end
+
+        # create dynamically methods based on LIST_OF_STATUSES constant
+        # after created a new object we can call the methods:
+        # my_postgresql_service.is_enabled?
+        # my_postgresql_service.is_active?
+        # if the provided service is active or enabled this method return
+        # - true
+        # otherwise return
+        # - false
+        LIST_OF_STATUSES.each do |status|
+            define_method "is_#{status}?" do 
+                exist? ? return_an_array_from_system_command(`#{command} is-#{status} #{name}`).include?(status) : default_error_message()
+            end
+        end
+
+        # method for display error when a service or unit not exist
+        def default_error_message
+            render_message("Unit #{name}.service could not be found.") # class method contained in Systemdy/utility/message_displayer.rb
+        end
+
+        # make the methods below as private
+        private :render_message, :default_error_message, :return_an_array_from_system_command, :filter_by_keys 
+    end
+end

data/lib/systemdy/utility/formatter.rb

@@ -0,0 +1,15 @@
+module Systemdy
+    module Utility 
+        class Formatter
+            # method for convert `` system call to array based list
+            def self.return_an_array_from_system_command(system_call)
+                # remove \n from system call returned value
+                system_call_without_new_line = system_call.chomp!
+                # return system error message 
+                return(system_call_without_new_line) if !$?.success?
+                # convert `` system call to array based list
+                system_call_without_new_line.split(/\n/)
+            end
+        end
+    end
+end

data/lib/systemdy/utility/key_value_filter.rb

@@ -0,0 +1,10 @@
+module Systemdy
+    module Utility 
+        class KeyValueFilter
+            # method for filter an hash with a list of provided keys
+            def self.filter_by_keys(hash, *list_of_keys)
+                filtered_hash = hash.slice(*list_of_keys.flatten) 
+            end
+        end
+    end
+end

data/lib/systemdy/utility/message_displayer.rb

@@ -0,0 +1,10 @@
+module Systemdy
+    module Utility 
+        class MessageDisplayer
+            # method for render custom message tho the user
+            def self.render_message(message)
+                message
+            end
+        end
+    end
+end

data/lib/systemdy/utility/validator.rb

@@ -0,0 +1,13 @@
+module Systemdy
+    module Utility 
+        class Validator
+            # method for check if a service exist
+            def self.check_if_a_service_exist(service)
+                `#{SYSTEMCTL_COMMAND} list-unit-files #{service}.service | wc -l`.to_i > 3
+                # 'systemctl list-unit-files name_of_service.service | wc -l' command output:
+                #  3  when there are not matching units
+                #  >3 when there are matching units
+            end
+        end
+    end
+end

data/lib/systemdy/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Systemdy
+  VERSION = "0.1.0"
+end

data/lib/systemdy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# external gems or standard's library modules
+require "forwardable"
+require "etc"
+
+# systemdy's class and modules
+require_relative "systemdy/version"
+require_relative "systemdy/utility/validator"
+require_relative "systemdy/utility/formatter"
+require_relative "systemdy/utility/message_displayer"
+require_relative "systemdy/utility/key_value_filter"
+require_relative "systemdy/service"
+require_relative "systemdy/journal"
+
+module Systemdy
+  class Error < StandardError; end
+
+  # systemctl command
+  SYSTEMCTL_COMMAND  = 'systemctl'
+  # journalctl command
+  JOURNALCTL_COMMAND = 'journalctl'
+end

data/sig/systemdy.rbs

@@ -0,0 +1,4 @@
+module Systemdy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: systemdy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- magic4dev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: magic4dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/systemdy.rb
+- lib/systemdy/journal.rb
+- lib/systemdy/service.rb
+- lib/systemdy/utility/formatter.rb
+- lib/systemdy/utility/key_value_filter.rb
+- lib/systemdy/utility/message_displayer.rb
+- lib/systemdy/utility/validator.rb
+- lib/systemdy/version.rb
+- sig/systemdy.rbs
+homepage: https://github.com/magic4dev/systemd
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/magic4dev/systemd
+  source_code_uri: https://github.com/magic4dev/systemd
+  changelog_uri: https://github.com/magic4dev/systemd/blob/master/CHANGELOG.md
+  code_of_conduct_uri: https://github.com/magic4dev/systemd/blob/master/CODE_OF_CONDUCT.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A lightweight gem for interact with systemd
+test_files: []