systemdy 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d100ae2959d85fb8084a5d6c23113dd70a417f3f5512b8ef9664f7e49ec4b70
-  data.tar.gz: 8d7e95b1a81f21778a56ba809b621cce17d73c509222da63939744645595eba6
+  metadata.gz: 1544343d2a581add0354d499edbd139097f169be6dfc17e5ef4c310af3f27121
+  data.tar.gz: b6e96d3e254f09b8f3f53b7e3ead30f6d4290eb7a28832743552cd0dbd98dbe7
 SHA512:
-  metadata.gz: 8d900cabf4fea970eade41af5121ae5c3b2bad2defb72486d88f64c5622b9cb7673e43fb027bd496f41c0c50def879dfe40dddf96b7da8732b872697b41bc5e4
-  data.tar.gz: 0507f8e49ce30ff6affc084b52f6b4388bb136f2272d6c6d234b2d5191cad404eec16f356a19b7a5010d45a98922c0119d057cd8177d6859f30ad41ab12464c8
+  metadata.gz: ada7db214a2832e363ae2b0c4b9a64049adfd1e2a1652e490676da479c8889758343f7501d0b5f4de1733ce7cc17b3772a3bb4362ddac20eb8e6b1c3e4b2845d
+  data.tar.gz: 649e589fee12a0fdf97cf03c9a7ad5697e59191f08471bec85e2ad6e3e83fa41aafbc27e1b7590a37d5c89150c0ba489fc9b20c310570f4b9fbaf49697a2681f

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## [0.4.0] - 2022-11-22
+
+### Added
+
+- Systemdy::Utility::Formatter return_an_array_from class method for convert a complex string into array with custom splitter
+- Systemdy::Service port method for return service port if available
+- Systemdy::Service protocol method for return service protocol if available
+
+### Changed
+
+- Logic for Systemd::Utility::Formatter return_an_array_from_system_command class method 
+
+## [0.3.2] - 2022-10-21 
+
+### Fixed
+
+- documentation_uri in gemspec
+
+## [0.3.1] - 2022-10-21 
+
+### Changed
+
+- Documentation syntax for Systemdy::Utility::Formatter.remove_newline_from_system_command class method
+- documentation_uri in gemspec
+
 ## [0.3.0] - 2022-10-21 
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    systemdy (0.2.1)
+    systemdy (0.3.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -31,7 +31,9 @@ If your goal is to develop software to quickly manage systemd services or journa
   * [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)
+  * [Display all the properties for the provided service](#display-all-the-properties-for-the-provided-service)
+  * [Get service port](#get-service-port)
+  * [Get service protocol](#get-service-protocol)
   * [Start the service](#start-the-service)
   * [Restart the service](#restart-the-service)
   * [Stop the service](#stop-the-service)
@@ -70,9 +72,11 @@ And then execute:
 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 libsystemd-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:
@@ -80,6 +84,7 @@ 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.
@@ -148,9 +153,11 @@ Once executed, this method return an hash with all the essential service's infor
    "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
 ```
@@ -170,6 +177,44 @@ To extract the value of a specific property
 my_postgresql_service.properties["MemorySwapMax"]
 ```
 
+### Get service port
+
+For retrieve a service port
+
+```ruby
+my_postgresql_service.port
+```
+Once executed, this method return the provided service port:
+
+```ruby
+ "5432"
+```
+
+if the provided service has no available port, this method return a message like this:
+
+```ruby
+ "postgresql.service has no port available"
+```
+
+### Get service protocol
+
+For retrieve a service protocol
+
+```ruby
+my_postgresql_service.protocol
+```
+Once executed, this method return the provided service port:
+
+```ruby
+  "tcp"
+```
+
+if the provided service has no available protocol, this method return a message like this:
+
+```ruby
+ "postgresql.service has no protocol available"
+```
+
 ### Start the service
 
 For start the service 
@@ -218,12 +263,14 @@ 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.
@@ -266,6 +313,7 @@ Type 'exit' on your terminal as follows:
 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.
@@ -535,6 +583,7 @@ If the passed arguments not match anything the method return an array with a mes
 ```ruby
 ["-- No entries --"]
 ```
+
 ## Contributing
 
 We :heart: pull requests from everyone. 
@@ -629,9 +678,9 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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 Systemd documentation for [time specification](https://www.freedesktop.org/software/systemd/man/systemd.time.html)
+- An interesting article on [how to run sudo commands without password](https://www.linuxshelltips.com/run-sudo-commands-without-password/)
+- The official Systemd 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 
+- Thanks to [@colstrom](https://github.com/colstrom) and his [systemized](https://github.com/colstrom/systemized) for the great inspiration 

data/lib/systemdy/service.rb

@@ -7,17 +7,23 @@ module Systemdy
         # extend Forwardable standard's library module for delegate a specified method to a designated object
         extend Forwardable
 
+        # service look up information command 
+        INFO_LOOKUP_COMMAND           = "getent services"
+
+        # list of essential information on a provided service
+        LIST_OF_ESSENTIAL_INFO_LOOKUP = %w( port protocol )
+
         # list of supported actions on a provided service
-        LIST_OF_ACTIONS           = %w( start restart stop enable disable reload mask unmask )
+        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_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 
-                                    )
+        LIST_OF_STATUS_PROPERTIES     = %w( Id Description ExecMainPID LoadState ActiveState FragmentPath 
+                                            ActiveEnterTimestamp InactiveEnterTimestamp ActiveExitTimestamp 
+                                            InactiveExitTimestamp 
+                                        )
 
         attr_reader :command, :name
 
@@ -34,6 +40,8 @@ module Systemdy
 
         # 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
+        # delegate return_an_array_from method to Systemdy::Utility::Formatter class contained in Systemdy/utility/formatter.rb
+        def_delegator Systemdy::Utility::Formatter,        :return_an_array_from
         # delegate remove_newline_from_system_command to Systemdy::Utility::Formatter class contained in Systemdy/utility/formatter.rb
         def_delegator Systemdy::Utility::Formatter,        :remove_newline_from_system_command
         # delegate render_message method to Systemdy::Utility::MessageDisplayer class contained in Systemdy/utility/message_displayer.rb
@@ -51,6 +59,30 @@ module Systemdy
         def exist? 
             check_if_a_service_exist(name) # class method contained in Systemdy/utility/validator.rb
         end
+
+        # create dynamically methods based on LIST_OF_ESSENTIAL_INFO_LOOKUP constant 
+        # @!method port
+        #   return the available +port+ of the service
+        #   @example get the service port
+        #       my_postgresql_service.port #=> "5432"
+        #   @note This method is generated with use of metaprogramming techniques
+        #   @todo This method return an error message when there are no port available
+        #
+        # @!method protocol
+        #   return the available +protocol+ of the service
+        #   @example restart a service
+        #       my_postgresql_service.protocol #=> "tcp"
+        #   @note This method is generated with use of metaprogramming techniques
+        #   @todo This method return an error message when there are no protocol available
+        #
+        LIST_OF_ESSENTIAL_INFO_LOOKUP.each_with_index do |info, index|
+            define_method info do 
+                return default_error_message() unless exist?
+                essential_info = return_an_array_from(`#{INFO_LOOKUP_COMMAND} #{name}`, argument_splitter: ' ')
+                return info_lookup_error_message(info) if essential_info.nil?
+                return_an_array_from(essential_info[1], argument_splitter: '/')[index]
+            end
+        end
         
         # create dynamically methods based on LIST_OF_ACTIONS constant
         # @!method start
@@ -182,11 +214,25 @@ module Systemdy
             render_message("Unit #{name}.service could not be found.") # class method contained in Systemdy/utility/message_displayer.rb
         end
 
+        # method to show a message when a service has no port or protocols available
+        # @return [String] the info lookup error message
+        # @example call port method on a service that has no port available
+        #     a_service_that_has_no_port_available #=> "a_service_that_has_no_port_available.service has no port available"
+        def info_lookup_error_message(info)
+            render_message("#{name}.service has no #{info} available") # class method contained in Systemdy/utility/message_displayer.rb
+        end
+
         # @!method return_an_array_from_system_command
         #   @param system_call [String] system call to convert to an array
         #   @return [Array] an array-based list of the values ​​returned by making a system call
         #   @note check out more about this method in Systemdy/utility/formatter.rb
         #
+        # @!method return_an_array_from
+        #   @param string_to_parse [String] string to convert to an array
+        #   @param argument_splitter [String] character for split string to an array 
+        #   @param remove_blank_elements [Boolean] remove blank elements or not 
+        #   @return [Array] an array-based list of the values ​​returned by argument_splitter
+        #
         # @!method filter_by_keys
         #   @param hash [Hash] the hash to filter
         #   @param list_of_keys [Array] the list of keys to extract from the hash
@@ -195,6 +241,6 @@ module Systemdy
         #
 
         # make the methods below as private
-        private :render_message, :default_error_message, :return_an_array_from_system_command, :filter_by_keys 
+        private :render_message, :default_error_message, :info_lookup_error_message, :return_an_array_from_system_command, :return_an_array_from, :filter_by_keys 
     end
 end

data/lib/systemdy/utility/formatter.rb

@@ -13,7 +13,21 @@ module Systemdy
             def self.return_an_array_from_system_command(system_call)
                 system_call_without_new_line = remove_newline_from_system_command(system_call)    # remove \n from system call returned value
                 return system_call_without_new_line if !$?.success?                               # return system error message if the process has non-zero exit status
-                system_call_without_new_line.split(/\n/)                                          # convert values returned by `` system call to an array-based list
+                return_an_array_from(system_call_without_new_line)                                # convert values returned by `` system call to an array-based list based on argument_splitter value
+            end
+
+            # method for convert a string into an array without blank elements
+            #
+            # @param  string_to_parse [String] string to convert to an array
+            # @param  argument_splitter [String] character for split string to an array 
+            # @param  remove_blank_elements [Boolean] remove blank elements or not 
+            # @return [Array] an array-based list of the values ​​returned by argument_splitter
+            # @example convert a complex string into an array 
+            #   list_of_info = Systemdy::Utility::Formatter.return_an_array_from("5432/tcp  info", argument_splitter: '/', remove_blank_elements: false) #=> ["5432", "tcp", "", "", "info"]
+            # @example convert a complex string into an array without blank elements
+            #   list_of_info_without_blank_elements = Systemdy::Utility::Formatter.return_an_array_from("5432/tcp  info", argument_splitter: '/') #=> ["5432", "tcp", "info"]
+            def self.return_an_array_from(string_to_parse, argument_splitter: '\n', remove_blank_elements: true)
+                remove_blank_elements ? string_to_parse.split(/#{argument_splitter}/).reject(&:empty?) : string_to_parse.split(/#{argument_splitter}/) 
             end
 
             # method for remove +\n+ characters from system calls

data/lib/systemdy/version.rb

@@ -2,5 +2,5 @@
 
 module Systemdy
   # the current version of the gem
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: systemdy
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - magic4dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-11-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: magic4dev@gmail.com
@@ -40,7 +40,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/magic4dev/systemdy
   source_code_uri: https://github.com/magic4dev/systemdy
-  documentation_uri: https://www.rubydoc.info/gems/systemdy
+  documentation_uri: https://www.rubydoc.info/github/magic4dev/systemdy
   changelog_uri: https://github.com/magic4dev/systemdy/blob/master/CHANGELOG.md
   code_of_conduct_uri: https://github.com/magic4dev/systemdy/blob/master/CODE_OF_CONDUCT.md
 post_install_message: