prepper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d68d0ee338e47bb82505f4b37da819ea323e77de3f3e49cba9bbec6d4d5f6d04
-  data.tar.gz: 32e04ba18f7dbaf9397ee08a3dfb6a72e18026fb54b157c3b3649ce1ab792f54
+  metadata.gz: 8eb4e48bf36f79d83d5da672215e3ad1f4994eaa5a652532be310d5600c2597a
+  data.tar.gz: 7bfa00815d7aded4c7933e84e36a87fdc9388fa9f9c5631bec0e2d57379a2245
 SHA512:
-  metadata.gz: f71e24560ab3572628fdc97e663da08142af71ef848ac096dc988d37b0bf2c3c7abe712520b4a2a418d7d29d5676b3ff6a27577a8cc559b5fd3151c6ca220ec2
-  data.tar.gz: ecef0450a23ff26eef8ea203638c3b9ca22f19cbd9648795246d7cdb242e9be0fcf4378fb91a0e68535ede0c9b2e2117509e7e84c4711defbc7c127fb728709a
+  metadata.gz: 69f96c1720596ecb24bc4ce289b29a16821b6c9f0227f6b2cd34778b5db5122bd1772eff17c4aca39867d417381b2e931533441d3213bf9a4660816cf03c4930
+  data.tar.gz: 909b0621f3c16c31717b4a4e968f6b5e60a4fc9f3f54836cc65c5a33879042435a3bccad79e82351f3e9d466f5b3d7d7482f458280b1bf4fc83ee428f38d5c21

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change log
+
+## Unreleased
+
+## 0.2.0
+
+* better docs
+
+## 0.1.0
+
+* First release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prepper (0.1.0)
+    prepper (0.2.0)
       sshkit
       tty-option
       zeitwerk

data/README.md

@@ -17,7 +17,8 @@ upload files to the server, etc.
 
 A simple example:
 
-```
+```ruby
+
 server_host "YOUR_SERVER_IP"
 server_port 22
 server_user "root"
@@ -47,6 +48,8 @@ end
 
 You can see a full example in [examples/config.rb](examples/config.rb). You would run that file with `bundle exec prepper config.rb` to provision the server.
 
+The API documentation can be found on rubydoc: [https://rubydoc.info/github/gregmolnar/prepper](https://rubydoc.info/github/gregmolnar/prepper).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/prepper/tools/apt.rb

@@ -1,27 +1,25 @@
 module Prepper
   module Tools
+    # Helper methods to interact with Apt
     module Apt
-      def self.included(base)
-        base.class_eval do
-
-          # Updates apt repositories
-          def apt_update
-            @commands << Command.new("apt update", sudo: true)
-          end
-
-          # Installs packages
-          # @param packages [Array] array of package names
-          def apt_install(packages)
-            packages.each do |package|
-              @commands << Command.new("apt install --force-yes -qyu #{package}", sudo: true, verify: has_apt_package?(package))
-            end
-          end
+      # Updates apt repositories
+      def apt_update
+        @commands << Command.new("apt update", sudo: true)
+      end
 
-          def has_apt_package?(package)
-            Command.new("dpkg --status #{package} | grep 'ok installed'", sudo: true)
-          end
+      # Installs packages
+      # @param packages [Array] array of package names
+      def apt_install(packages)
+        packages.each do |package|
+          @commands << Command.new("apt install --force-yes -qyu #{package}", sudo: true, verify: has_apt_package?(package))
         end
       end
+
+      # Verifier command to checks if an apt package is installed
+      # @param package [String] name of the package
+      def has_apt_package?(package)
+        Command.new("dpkg --status #{package} | grep 'ok installed'", sudo: true)
+      end
     end
   end
 end

data/lib/prepper/tools/file.rb

@@ -2,67 +2,121 @@ require 'erb'
 require 'digest/md5'
 module Prepper
   module Tools
+    # Helper methods for file and directory management
     module File
-      def self.included(base)
-        base.class_eval do
 
-          def chown(path, owner, flags = "")
-            @commands << Command.new("chown #{flags} #{owner} #{path}", sudo: true)
-          end
+      # Changes ownership of a path
+      # @param path [String] the path which we want to change the ownership of
+      # @param owner [String] name of the owner, ie: 'root:root'
+      # @param flags [String] flags to pass to chown, ie: '-R' to do it recursively
+      def chown(path, owner, flags = "")
+        @commands << Command.new("chown #{flags} #{owner} #{path}", sudo: true)
+      end
 
-          def directory(path, opts = {})
-            @commands <<  Command.new("mkdir -p #{path}", opts.merge(sudo: true, verifier: has_directory?(path)))
-            @commands <<  Command.new("chown #{opts[:owner]} #{path}", sudo: true) if opts[:owner]
-            @commands <<  Command.new("chmod #{opts[:mode]} #{path}", sudo: true) if opts[:mode]
-          end
+      # Create a directory unless it already exists
+      # @param path [String] path of the directory
+      # @param [Hash] opts options hash
+      # @option opts [String] :owner Owner of the directory, ie: 'root:root'
+      # @option opts [String] :mode mode bits, ie: '0777'
+      def directory(path, opts = {})
+        @commands <<  Command.new("mkdir -p #{path}", opts.merge(sudo: true, verifier: has_directory?(path)))
+        @commands <<  Command.new("chown #{opts[:owner]} #{path}", sudo: true) if opts[:owner]
+        @commands <<  Command.new("chmod #{opts[:mode]} #{path}", sudo: true) if opts[:mode]
+      end
 
-          def has_directory?(path)
-            Command.new("test -d #{path}", sudo: true)
-          end
+      # returns a verifier command to test if a directory exists
+      # @param path [String] path to test
+      def has_directory?(path)
+        Command.new("test -d #{path}", sudo: true)
+      end
 
-          def file(path, opts = {})
-            opts[:locals] ||= {}
-            opts[:verify_content] ||= true
-            content = opts[:content] || render_template(opts[:template], opts[:locals])
-            verifier = if opts[:verify_content]
-              matches_content?(path, content)
-            else
-              has_file?(path)
-            end
-            io = StringIO.new(content)
-            @commands << Command.new("put!", {params: [io, path, {owner: opts[:owner], mode: opts[:mode]}], verifier: verifier})
-          end
+      # Create a file unless it already exists. The contents can be set to a
+      # string or a template can be rendered with the provided locals
+      # @param path [String] path of the file
+      # @param [Hash] opts options hash
+      # @option opts [String] :content string content of the file
+      # @option opts [String] :template name of the template for the file
+      # @option opts [String] :locals hash of variables to pass to the template
+      # @option opts [String] :verify_content set to true to verify the file
+      #   content is the same in case the file already exists
+      # @option opts [String] :owner Owner of the directory, ie: 'root:root'
+      # @option opts [String] :mode mode bits, ie: '0777'
+      def file(path, opts = {})
+        opts[:locals] ||= {}
+        opts[:verify_content] ||= true
+        content = opts[:content] || render_template(opts[:template], opts[:locals])
+        verifier = if opts[:verify_content]
+          matches_content?(path, content)
+        else
+          has_file?(path)
+        end
+        io = StringIO.new(content)
+        @commands << Command.new("put!", {params: [io, path, {owner: opts[:owner], mode: opts[:mode]}], verifier: verifier})
+      end
 
-          def has_file?(path)
-            Command.new("test -f #{path}", sudo: true)
-          end
+      # returns a verifier command to test if a file exists
+      # @param path [String] path to test
+      def has_file?(path)
+        Command.new("test -f #{path}", sudo: true)
+      end
 
-          def matches_content?(path, content)
-            md5 = Digest::MD5.hexdigest(content)
-            Command.new("md5sum #{path} | cut -f1 -d' '`\" = \"#{md5}\"", sudo: true, verifier: has_file?(path))
-          end
+      # returns a verifier command to test if has a matching content
+      # @param path [String] path to test
+      # @param content [String] expected content
+      def matches_content?(path, content)
+        md5 = Digest::MD5.hexdigest(content)
+        Command.new("md5sum #{path} | cut -f1 -d' '`\" = \"#{md5}\"", sudo: true, verifier: has_file?(path))
+      end
 
-          def symlink(link, target, opts = {})
-            opts.merge!(
-              sudo: true,
-              verifier: has_symlink?(link)
-            )
-            @commands << Command.new("ln -s #{target} #{link}", opts)
-          end
+      # creates a symlink
+      # @param link [String] link
+      # @param target [String] target
+      # @param [Hash] opts options hash
+      def symlink(link, target, opts = {})
+        opts.merge!(
+          sudo: true,
+          verifier: has_symlink?(link)
+        )
+        @commands << Command.new("ln -s #{target} #{link}", opts)
+      end
+
+      # returns a verifier command to test if as a matching content
+      # @param path [String] path to test
+      # @param content [String] expected content
+      def matches_content?(path, content)
+        md5 = Digest::MD5.hexdigest(content)
+        Command.new("md5sum #{path} | cut -f1 -d' '`\" = \"#{md5}\"", sudo: true, verifier: has_file?(path))
+      end
 
-          def has_symlink?(link, file = nil)
-            if file
-              Command.new("'#{file}' = `readlink #{link}`")
-            else
-              Command.new("test -L #{link}", sudo: true)
-            end
-          end
+      # creates a symlink
+      # @param link [String] link
+      # @param target [String] target
+      # @param [Hash] opts options hash
+      def symlink(link, target, opts = {})
+        opts.merge!(
+          sudo: true,
+          verifier: has_symlink?(link)
+        )
+        @commands << Command.new("ln -s #{target} #{link}", opts)
+      end
 
-          def render_template(template, locals)
-            ERB.new(::File.read("./templates/#{template}")).result_with_hash(locals)
-          end
+      # returns a verifier command to test if symlink exists
+      # @param path [String] path to test
+      # @param file [String] optionally check if it points to the correct file
+      def has_symlink?(link, file = nil)
+        if file
+          Command.new("'#{file}' = `readlink #{link}`")
+        else
+          Command.new("test -L #{link}", sudo: true)
         end
       end
+
+      # render an ERB template
+      # @param template [String] name of the template
+      # @param locals [Hash] hash of variables to pass to the template
+      def render_template(template, locals)
+        ERB.new(::File.read("./templates/#{template}")).result_with_hash(locals)
+      end
     end
   end
 end

data/lib/prepper/tools/rbenv.rb

@@ -1,27 +1,28 @@
 module Prepper
   module Tools
+    # Helper methods for rbenv
     module Rbenv
-      def self.included(base)
-        base.class_eval do
+      # install rbenv for a given user
+      # @param user [String] name of the user to install rbenv for
+      def install_rbenv(user)
+        apt_install %w{libssl-dev zlib1g zlib1g-dev libreadline-dev}
+        @commands << Command.new("sudo -u #{user} -i git clone https://github.com/sstephenson/rbenv.git /home/#{user}/.rbenv", verifier: has_directory?("/home/#{user}/.rbenv"))
+        @commands << Command.new("sudo -u #{user} -i git clone https://github.com/sstephenson/ruby-build.git /home/#{user}/.rbenv/plugins/ruby-build", verifier: has_directory?("/home/#{user}/.rbenv/plugins/ruby-build"))
 
-          def install_rbenv(user)
-            apt_install %w{libssl-dev zlib1g zlib1g-dev libreadline-dev}
-            @commands << Command.new("sudo -u #{user} -i git clone https://github.com/sstephenson/rbenv.git /home/#{user}/.rbenv", verifier: has_directory?("/home/#{user}/.rbenv"))
-            @commands << Command.new("sudo -u #{user} -i git clone https://github.com/sstephenson/ruby-build.git /home/#{user}/.rbenv/plugins/ruby-build", verifier: has_directory?("/home/#{user}/.rbenv/plugins/ruby-build"))
-
-            append_text 'export PATH="$HOME/.rbenv/bin:$PATH"', "/home/#{user}/.profile"
-            append_text 'eval "$(rbenv init -)"', "/home/#{user}/.profile"
-            chown "/home/#{user}/.profile", 'deploy:deploy'
-          end
+        append_text 'export PATH="$HOME/.rbenv/bin:$PATH"', "/home/#{user}/.profile"
+        append_text 'eval "$(rbenv init -)"', "/home/#{user}/.profile"
+        chown "/home/#{user}/.profile", 'deploy:deploy'
+      end
 
-          def install_ruby(user, version, opts = '')
-            @commands << Command.new("sudo -u #{user} -i RUBY_CONFIGURE_OPTS='#{opts}' rbenv install #{version}", verifier: has_directory?("/home/#{user}/.rbenv/versions/#{version}"))
+      # install a given ruby version for a given user
+      # @param user [String] name of the user
+      # @param version [String] ruby version
+      def install_ruby(user, version)
+        @commands << Command.new("sudo -u #{user} -i RUBY_CONFIGURE_OPTS='#{opts}' rbenv install #{version}", verifier: has_directory?("/home/#{user}/.rbenv/versions/#{version}"))
 
-            @commands << Command.new("sudo -u #{user} -i rbenv rehash")
-            @commands << Command.new("sudo -u #{user} -i rbenv global #{version}")
-            @commands << Command.new("sudo -u #{user} -i rbenv rehash")
-          end
-        end
+        @commands << Command.new("sudo -u #{user} -i rbenv rehash")
+        @commands << Command.new("sudo -u #{user} -i rbenv global #{version}")
+        @commands << Command.new("sudo -u #{user} -i rbenv rehash")
       end
     end
   end

data/lib/prepper/tools/text.rb

@@ -1,18 +1,20 @@
 module Prepper
   module Tools
+    # text related helpers
     module Text
-      def self.included(base)
-        base.class_eval do
-
-          def append_text(text, path)
-            @commands << Command.new("/bin/echo -e '#{text}' | sudo tee -a #{path}", verifier: has_text?(text, path))
-          end
+      # append text to a file
+      # @param text [String] text to append
+      # @param path [String]
+      def append_text(text, path)
+        @commands << Command.new("/bin/echo -e '#{text}' | sudo tee -a #{path}", verifier: has_text?(text, path))
+      end
 
-          def has_text?(text, path)
-            regex = Regexp.escape(text)
-            Command.new("grep -qPzo '^#{regex}$' #{path} ||", sudo: true)
-          end
-        end
+      # returns a verifier command to test the presence of a string in a file
+      # @param text [String] text
+      # @param path [String] path to file
+      def has_text?(text, path)
+        regex = Regexp.escape(text)
+        Command.new("grep -qPzo '^#{regex}$' #{path} ||", sudo: true)
       end
     end
   end

data/lib/prepper/tools/users.rb

@@ -1,22 +1,27 @@
 module Prepper
   module Tools
+    # user management related helpers
     module Users
-      def self.included(base)
-        base.class_eval do
-          def add_user(username, opts = {})
-            opts[:flags] << ' --gecos ,,,'
-            @commands << Command.new("adduser #{username} #{opts[:flags]}", sudo: true, verifier: has_user?(username))
-          end
+      # add a user to the host
+      # @param username [String] name of the user
+      # @param [Hash] opts options has
+      # @option opts [String] :flags flags to pass to adduser
+      def add_user(username, opts = {})
+        opts[:flags] << ' --gecos ,,,'
+        @commands << Command.new("adduser #{username} #{opts[:flags]}", sudo: true, verifier: has_user?(username))
+      end
 
-          def has_user?(username, opts = {})
-            if opts[:in_group]
-              command = "id -nG #{username} | xargs -n1 echo | grep #{opts[:in_group]}"
-            else
-              command = "id #{username}"
-            end
-            Command.new(command, sudo: true)
-          end
+      # returns a verifier command to check if a user exists
+      # @param username [String] name of the user
+      # @param [Hash] opts options hash
+      # @option opts [String] :in_group check if the user is in the given group
+      def has_user?(username, opts = {})
+        if opts[:in_group]
+          command = "id -nG #{username} | xargs -n1 echo | grep #{opts[:in_group]}"
+        else
+          command = "id #{username}"
         end
+        Command.new(command, sudo: true)
       end
     end
   end

data/lib/prepper/version.rb

@@ -1,3 +1,3 @@
 module Prepper
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prepper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Greg Molnar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-16 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock