jamal 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9402212f10aa8571ed0e83d0a5dbed70eb5c70598bb85f6508f55ee96105fffe
+  data.tar.gz: 0f35b747064337969aec3d450a0a851192b42efcc9e546000be8248588ce3ac9
+SHA512:
+  metadata.gz: d3f2177e08b89eb443e48a55e41fe73773073ec5c54ba114cf3fb0886fb295ce93d855b3d193b7778c692570c44fd70b6f4f6a71a1faf898f9dbdf7214df654d
+  data.tar.gz: e413711576342ddbae07b48238507232e2a10f314ccaa79c2f9c87ba12f8c63b6d79ab1e5edf61ae40ef9fe81435a04b93b1694986bbe79a5fd9781f6254a7a2

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 mounir@ahmina.com. 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Mounir Ahmina
+
+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,30 @@
+# Jamal
+
+Jamal is a lightweight tool to deploy static websites to remote web servers.
+
+## Installation
+
+```bash
+gem install jamal
+```
+
+## Usage
+1. Run `jamal init` to initialize the configuration file `_jamal.yml`.
+2. Edit the `_jamal.yml` file to match your server configuration.
+3. Run the `jamal setup` command to setup the server.
+4. Run the `jamal deploy` command to deploy your website.
+
+## Configuration
+
+The `_jamal.yml` file is used to configure the server. It contains the following fields:
+
+- `name`: The name of the website, this acts like an identifier for the website.
+- `host`: The hostname of the server.
+- `user`: The username of the server.
+- `password`: The password of the server.
+- `domains`: The domains of the website.
+- `path`: The path to the website on your local machine.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE.txt) file for details.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/exe/jamal

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "jamal"
+
+command = ARGV[0]
+options = {}
+
+case command
+when "setup"
+  # Parse setup options
+  require 'optparse'
+  OptionParser.new do |opts|
+    opts.banner = "Usage: jamal deploy [--config CONFIG_PATH]"
+    
+    opts.on("--config CONFIG", "Path to config file") { |c| options[:config_path] = c }
+  end.parse!
+
+  Jamal::CLI.setup(**options)
+
+when "deploy"
+  # Parse deploy options
+  require 'optparse'
+  OptionParser.new do |opts|
+    opts.banner = "Usage: jamal deploy [--config CONFIG_PATH]"
+    
+    opts.on("--config CONFIG", "Path to config file") { |c| options[:config_path] = c }
+  end.parse!
+
+  Jamal::CLI.deploy(**options)
+
+when "remove"
+  # Parse remove options
+  require 'optparse'
+  OptionParser.new do |opts|
+    opts.banner = "Usage: jamal remove [--config CONFIG_PATH]"
+    
+    opts.on("--config CONFIG", "Path to config file") { |c| options[:config_path] = c }
+  end.parse!
+
+  Jamal::CLI.remove(**options)
+
+when "init"
+  Jamal::CLI.init(**options)
+
+when "-v"
+  puts "Jamal #{Jamal::VERSION}"
+  exit 0
+
+else
+  puts "Unknown command: #{command}"
+  puts "Available commands: setup, deploy, remove, init, -v"
+  exit 1
+end 

data/lib/jamal/version.rb

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

data/lib/jamal.rb

@@ -0,0 +1,294 @@
+# frozen_string_literal: true
+
+require_relative "jamal/version"
+require 'net/ssh'
+require 'net/sftp'
+require 'yaml'
+require 'fileutils'
+require 'tempfile'
+
+module Jamal
+  class Error < StandardError; end
+
+  class CLI
+    def self.setup(config_path: '_jamal.yml')
+      # Load configuration
+      config = YAML.load_file(config_path)
+      
+      begin
+        # Establish SSH connection using config values
+        Net::SSH.start(config['host'], config['user'],
+          password: config['password']
+        ) do |ssh|
+          puts "Connected to #{config['host']}..."
+          
+          # Check if nginx is installed
+          result = ssh.exec!("nginx -v")
+          if result && !result.include?("not found")
+            puts "nginx is already installed"
+          else
+            puts "Installing nginx..."
+            # Update package list and install nginx
+            ssh.exec!("sudo apt-get update")
+            ssh.exec!("sudo apt-get install -y nginx")
+            
+            # Verify installation
+            result = ssh.exec!("nginx -v")
+            if result && !result.include?("not found")
+              puts "nginx installed successfully"
+            else
+              raise Error, "Failed to install nginx"
+            end
+          end
+
+          # Set up rsync daemon configuration
+          puts "Setting up rsync daemon..."
+          
+          # Create rsyncd configuration with consistent user permissions
+          rsyncd_conf = <<~CONFIG
+            uid = #{config['user']}
+            gid = #{config['user']}
+            use chroot = no
+            max connections = 4
+            pid file = /var/run/rsyncd.pid
+            exclude = .git/ .gitignore
+
+            [#{config['name']}]
+                path = /var/www/#{config['name']}
+                comment = Website files for #{config['name']}
+                read only = no
+                auth users = #{config['name']}
+                secrets file = /etc/rsyncd.secrets
+          CONFIG
+
+          # Generate a random password for rsync
+          special_chars = '!@#$%^&*()_+-=[]{}|;:,.<>?'.chars
+          numbers = '0123456789'.chars
+          letters = ('a'..'z').to_a + ('A'..'Z').to_a
+          rsync_password = (letters + numbers + special_chars).shuffle[0,16].join
+          
+          # First, clean up any existing entries for both the site name and root user
+          ssh.exec!("sudo sed -i '/^#{config['name']}:/d' /etc/rsyncd.secrets")
+
+          # Add new entry with the website name
+          ssh.exec!("echo '#{config['name']}:#{rsync_password}' | sudo tee -a /etc/rsyncd.secrets")
+          ssh.exec!("sudo chmod 600 /etc/rsyncd.secrets")
+          
+          # Remove any existing module configuration and create new one
+          ssh.exec!("sudo sed -i '/\\[#{config['name']}\\]/,/^$/d' /etc/rsyncd.conf")
+          
+          # Write the full rsyncd configuration
+          ssh.exec!("echo '#{rsyncd_conf}' | sudo tee -a /etc/rsyncd.conf")
+          
+          # Update the config file with the rsync password
+          config['rsync_password'] = rsync_password
+          File.write(config_path, config.to_yaml)
+          
+          # Enable and start rsync daemon
+          ssh.exec!("sudo systemctl enable rsync")
+          ssh.exec!("sudo systemctl start rsync")
+          
+          puts "Rsync daemon configured successfully!"
+        end
+      rescue Net::SSH::AuthenticationFailed
+        raise Error, "SSH authentication failed"
+      rescue StandardError => e
+        raise Error, "Setup failed: #{e.message}"
+      end
+    end
+
+    def self.deploy(config_path: '_jamal.yml')
+      # Load configuration
+      config = YAML.load_file(config_path)
+      temp_password_file = nil  # Declare variable outside begin block
+      
+      begin
+        Net::SSH.start(config['host'], config['user'],
+          password: config['password']
+        ) do |ssh|
+          puts "Connected to #{config['host']}..."
+          
+          # Check rsync daemon status
+          puts "Checking rsync daemon status..."
+          status = ssh.exec!("sudo systemctl status rsync")
+          unless status.include?("active (running)")
+            puts "Restarting rsync daemon..."
+            ssh.exec!("sudo systemctl restart rsync")
+          end
+          
+          # Create nginx configuration with support for multiple domains
+          nginx_config = <<~CONFIG
+            server {
+              listen 80;
+              server_name #{Array(config['domains']).join(' ')};
+              root /var/www/#{config['name']};
+              index index.html index.htm;
+              
+              location / {
+                try_files $uri $uri/ =404;
+              }
+            }
+          CONFIG
+          
+          # Check if nginx config already exists and is the same
+          existing_config = ssh.exec!("sudo cat /etc/nginx/sites-available/#{config['name']} 2>/dev/null")
+          if existing_config == nginx_config
+            puts "Nginx configuration unchanged, skipping update..."
+          else
+            # Create directory and upload nginx config
+            puts "Setting up nginx configuration..."
+            ssh.exec!("sudo mkdir -p /var/www/#{config['name']}")
+            ssh.exec!("sudo chown -R #{config['user']}:#{config['user']} /var/www/#{config['name']}")
+            ssh.exec!("sudo chmod -R 755 /var/www/#{config['name']}")
+            
+            # Upload nginx config using SFTP
+            File.write('/tmp/temp_nginx.conf', nginx_config)
+            ssh.sftp.connect do |sftp|
+              sftp.upload!('/tmp/temp_nginx.conf', "/tmp/#{config['name']}.conf")
+              File.delete('/tmp/temp_nginx.conf')
+            end
+            
+            # Move config to nginx sites and enable it
+            ssh.exec!("sudo mv /tmp/#{config['name']}.conf /etc/nginx/sites-available/#{config['name']}")
+            ssh.exec!("sudo ln -sf /etc/nginx/sites-available/#{config['name']} /etc/nginx/sites-enabled/")
+            
+            # Test and reload nginx
+            puts "Testing nginx configuration..."
+            result = ssh.exec!("sudo nginx -t")
+            if result && !result.include?("error")
+              ssh.exec!("sudo systemctl reload nginx")
+              puts "Nginx configuration updated successfully!"
+            else
+              raise Error, "Invalid nginx configuration"
+            end
+          end
+
+          # Replace SSH-based rsync with daemon-based rsync
+          local_path = config['local_path']
+          local_path = "#{local_path}/" unless local_path.end_with?('/')
+          
+          # Create temporary password file for rsync
+          temp_password_file = Tempfile.new('rsync_password')
+          temp_password_file.write(config['rsync_password'])
+          temp_password_file.close
+          FileUtils.chmod(0600, temp_password_file.path)
+
+          # Build rsync command for daemon mode with simplified output
+          rsync_cmd = [
+            "rsync",
+            "-ahi",                   # archive mode, human-readable, itemize changes
+            "--delete",              # delete extraneous files
+            "--out-format='%i | %n'", # simplified output format showing changes and filename
+            "--password-file=#{temp_password_file.path}",
+            local_path,
+            "rsync://#{config['name']}@#{config['host']}/#{config['name']}/"
+          ].join(" ")
+          
+          # Execute rsync with better error handling
+          puts "Syncing website files..."
+
+          IO.popen(rsync_cmd) do |io|
+            while line = io.gets
+              info = line.partition('|').first.strip
+              filename = line.partition('|').last.strip
+
+              if info[0] == '<'
+                puts "Uploading    #{filename}"
+              elsif info[0] == '.'
+                if info[1] == 'd'
+                  puts "Acessing     #{filename}"
+                else
+                  puts "Unchanged    #{filename}"
+                end
+              elsif info == "*deleting"
+                puts "Deleting    #{filename}"
+              elsif info == "cd+++++++++"
+                puts "Creating     #{filename}"
+              else
+                puts line
+              end
+            end
+          end
+
+          exit_status = $?.exitstatus
+          
+          # Clean up temporary password file
+          temp_password_file.unlink
+          
+          if exit_status != 0
+            puts "Rsync failed. Checking daemon accessibility..."
+            system("nc -zv #{config['host']} 873")
+            raise Error, "Rsync failed with status: #{exit_status}. Please check the rsync daemon is running and port 873 is accessible."
+          end
+          
+          puts "Sync completed!"
+        end
+      rescue Net::SSH::AuthenticationFailed
+        raise Error, "SSH authentication failed"
+      rescue StandardError => e
+        raise Error, "Deployment failed: #{e.message}"
+      ensure
+        # Now temp_password_file will be in scope
+        temp_password_file&.unlink
+      end
+    end
+
+    def self.remove(config_path: '_jamal.yml')
+      # Load configuration
+      config = YAML.load_file(config_path)
+      
+      begin
+        Net::SSH.start(config['host'], config['user'],
+          password: config['password']
+        ) do |ssh|
+          puts "Connected to #{config['host']}..."
+          
+          # Remove nginx configuration
+          puts "Removing nginx configuration..."
+          ssh.exec!("sudo rm -f /etc/nginx/sites-enabled/#{config['name']}")
+          ssh.exec!("sudo rm -f /etc/nginx/sites-available/#{config['name']}")
+          ssh.exec!("sudo systemctl reload nginx")
+          
+          # Remove website files
+          puts "Removing website files..."
+          ssh.exec!("sudo rm -rf /var/www/#{config['name']}")
+          
+          # Remove rsync secrets
+          puts "Removing rsync secrets..."
+          ssh.exec!("sudo sed -i '/#{config['name']}:.*$/d' /etc/rsyncd.secrets")
+          
+          # Remove rsync configuration
+          puts "Removing rsync configuration..."
+          ssh.exec!("sudo sed -i '/\\[#{config['name']}\\]/,/^$/d' /etc/rsyncd.conf")
+          
+          # Clean up empty lines in rsync config
+          ssh.exec!("sudo sed -i '/^$/N;/^\\n$/D' /etc/rsyncd.conf")
+          
+          # Remove rsync_password from local config file
+          config.delete('rsync_password')
+          File.write(config_path, config.to_yaml)
+          
+          puts "Successfully removed all configurations for #{config['name']}!"
+        end
+      rescue Net::SSH::AuthenticationFailed
+        raise Error, "SSH authentication failed"
+      rescue StandardError => e
+        raise Error, "Removal failed: #{e.message}"
+      end
+    end
+
+    def self.init(config_path: '_jamal.yml')
+      # Create the config file
+      File.write(config_path, {
+        'name' => 'example',
+        'host' => '1.2.3.4',
+        'user' => 'root',
+        'password' => 'password',
+        'domains' => ['example.com', 'www.example.com'],
+        'local_path' => './_site'
+      }.to_yaml)
+      puts "Created #{config_path} with default configuration."
+    end
+  end
+end
+

data/sig/jamal.rbs

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

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: jamal
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Mounir Ahmina
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: tempfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: 
+email: 
+executables:
+- jamal
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/jamal
+- lib/jamal.rb
+- lib/jamal/version.rb
+- sig/jamal.rbs
+homepage: https://github.com/mojl/jamal
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mojl/jamal
+  source_code_uri: https://github.com/mojl/jamal
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key: 
+specification_version: 4
+summary: Deploy your static website to a remote server
+test_files: []