wiz-teleport 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1ff1cfcc0ac285e58b14056c9d12b30632aa08d925d7035cc74036771754de4
+  data.tar.gz: a679bec7f1d1fe9de10255075fd56b2da3cd8c41a938d4ab7926d1a04726fbcb
+SHA512:
+  metadata.gz: 7a4ddc7a791b21a6b0143fc22765ed3515722cba703ab4b80a83bcb1adeef09ad9730cb3a4981719e06903d54a0355a81d1c95129bb6762158ba8b66476805ba
+  data.tar.gz: 6e406c036cdbc4b0865461f9fdeb91fc64c47a0c12adb44e10ed30da324e838aa31749117f6d2e6c25ab31f8495ece808d6b956ec558bb7fb49d4b6bc6ecca35

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 songgz
+
+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,134 @@
+# WizTeleport
+
+WizTeleport is a Ruby Gem that simplifies SSH connections and remote command execution. It is ideal for operational tasks and automated deployments.
+
+WizTeleport is designed to execute shell commands remotely over SSH, with no agents to install on remote systems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+   ```bash
+   gem 'wiz-teleport'
+   ```
+
+And then execute:
+
+   ```bash
+   $ bundle
+   ```
+
+Or install it yourself as:
+
+   ```bash
+   gem install wiz-teleport
+   ```
+
+## Usage
+WizTeleport is a powerful automation tool for configuration management, application deployment, task execution, and more. It is based on SSH, so there is no need to install the agent on the target host. Here are the basic steps and examples for using WizTeleport.
+
+1. Create a project directory
+
+    First, create a new directory to save your Ruby project:
+    ```bash
+    mkdir my_ruby_project
+    cd my_ruby_project
+    ```
+2. Install WizTeleport
+
+   Make sure you have Ruby installed. Then run the following command to install the WizTeleport:
+    ```bash
+    gem install wiz-teleport
+    ```
+
+3. Create an WizTeleport manifest file
+
+   WizTeleport uses a manifest file to define hosts. Wiz-Teleport reads a list or group from Inventory.yml and can operate these controlled nodes or hosts simultaneously and concurrently, just like Ansible. Create a file called inventory.yml that looks like this:
+   ```yaml
+   # inventory.yml
+   ---
+   - name: web1
+     user: root
+     password: root
+     servers:
+     - host: 127.0.0.1     
+   - name: data1
+     servers:
+     - host: db1.example.com       
+     - host: db2.example.com
+       name: db1
+       user: root
+       password: root
+     children:
+     - web1
+   ```
+6. Build an WizTeleport script
+
+   WizTeleport script defines tasks by writing ruby scripts. Here is an example of a simple WizTeleport script:
+   ```ruby
+   #example.rb
+   require 'wiz-teleport'
+   
+   WizTeleport::Shell.run 'web1' do
+     # write ruby code
+     puts "Hello from Ruby Shell!"
+     
+     # running linux command
+     uname "-a"
+     ls "-l" 
+     
+   end
+   
+   ```
+7. Execute WizTeleport script
+
+   Run WizTeleport script using ruby command:
+   ```bash
+   ruby example.rb
+   ```
+## Build WizTeleport task
+Executing shell tasks in rakefiles is a common requirement. A shell task is actually a rake task. Here is a basic example of how to define and execute a shell task in a Rakefile.
+
+1. Create Rakefile
+   ```ruby
+   # Rakefile.rb
+   require 'rake'
+   require 'wiz-teleport'
+   
+   namespace :custom do
+     desc "A custom shell task"
+     shell :example, 'web1' do
+       puts 'Hello from Ruby Shell!'
+       uname "-a"
+       ls "-l"
+     end
+   end
+   ```
+2. Execute Rake tasks
+   ```bash
+   rake custom:example
+   ```
+
+## File structure
+
+The project structure looks like this:
+```bash
+my_ruby_project/
+│
+├── inventory.yml
+├── Rakefile
+├── example.rb
+└── ... other file
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/songgz/wiz-teleport. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/songgz/wiz-teleport/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WizTeleport project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wiz-teleport/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/wiz-teleport/group.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require_relative './server'
+
+module WizTeleport
+  class Group
+    attr_reader :name, :servers, :children, :user, :password, :port
+
+    def initialize(options = {})
+      options = options.transform_keys(&:to_sym)
+      @name = options[:name]
+      @children = options[:children] || []
+      @user = options[:user] || 'root'
+      @password = options[:password]
+      @port = options[:port] || 22
+      @servers = (options[:servers] || []).map do |server_data|
+        server_data[:user] ||= @user
+        server_data[:password] ||= @password
+        server_data[:port] ||= @port
+        Server.new(server_data)
+      end
+    end
+
+    def to_h
+      h = {'name' => @name}
+      h['servers'] = @servers.map(&:to_h)
+      h['children'] = @children if @children
+      h['user'] = @user if @user
+      h['password'] = @password if @password
+      h['port'] = @port if @port
+      h
+    end
+  end
+end
+

data/lib/wiz-teleport/inventory.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+require 'yaml'
+require 'singleton'
+require_relative './group'
+require_relative './server'
+require_relative './ssh_client'
+
+module WizTeleport
+  class Inventory
+    include Singleton
+    attr_reader :groups
+
+    def initialize
+      @groups = []
+    end
+
+    def add_host_group(group)
+      @groups.push(group)
+    end
+
+    def find_group_by_name(name)
+      @groups.detect {|group| name == group.name}
+    end
+
+    def find_groups_by_names(names)
+      @groups.select {|group| names.include?(group.name)}
+    end
+
+    def clients_from_group(group_name)
+      group = @groups.find { |g| g.name == group_name }
+      groups = group ? find_groups_by_names([group_name] + group.children) : @groups
+
+      groups.flat_map do |group|
+        group.servers&.map do |server|
+          server.user ||= group.user
+          server.password = group.password
+          server.port ||= group.port
+          SSHClient.new(server)
+        end || []
+      end
+    end
+
+    def to_yaml(file_path = 'inventory.yml')
+      yaml_data = @groups.map(&:to_h)
+      File.write(file_path,  YAML.dump(yaml_data))
+    end
+
+
+    def from_yaml(file_path = 'inventory.yml')
+      yaml_data = YAML.load_file(file_path)
+      @groups = yaml_data.map { |group_data| Group.new(group_data) }
+    end
+
+    def clear
+      @groups = []
+    end
+
+  end
+end

data/lib/wiz-teleport/rake_dsl.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'rake'
+require_relative './shell'
+
+module WizTeleport
+  module RakeDSL
+
+    def shell(task_name, group_name, &block)
+      Rake::Task.define_task(task_name) do
+        WizTeleport::Shell.run(group_name, &block) if block_given?
+      end
+    end
+
+  end
+end
+
+# Rake::TaskManager.record_task_metadata do |t|
+#   t.instance_eval do
+#     extend Teleport::RakeDSL
+#   end
+# end
+# if defined?(Rake)
+#   Rake.application.instance_eval do
+#     extend Teleport::RakeDSL
+#   end
+# end

data/lib/wiz-teleport/server.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module WizTeleport
+  class Server
+    attr_reader :host, :name
+    attr_accessor :user, :password, :port
+
+    def initialize(options)
+      options = options.transform_keys(&:to_sym)
+      @name = options[:name]
+      @host = options[:host]
+      @user = options[:user]
+      @password = options[:password]
+      @port = options[:port]
+    end
+
+    def to_h
+      h = {'host' => @host}
+      h['name'] = @name if @name
+      h['user'] = @user if @user
+      h['password'] = @password if @password
+      h['port'] = @port if @port
+      h
+    end
+
+  end
+end
+
+

data/lib/wiz-teleport/shell.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative './inventory'
+
+module WizTeleport
+  class Shell
+    def initialize(file_path = 'inventory.yml')
+      @inventory = WizTeleport::Inventory.instance
+      @inventory.from_yaml(file_path)
+    end
+
+    def run(group_name, &block)
+      @clients = @inventory.clients_from_group(group_name)
+      @clients.each do |client|
+        client.instance_eval(&block)
+      end
+    end
+
+    def self.run(group_name, &block)
+      shell = WizTeleport::Shell.new
+      shell.run(group_name, &block)
+    end
+  end
+end
+
+
+

data/lib/wiz-teleport/ssh_client.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+require 'net/ssh'
+require 'net/scp'
+
+class SSHClient
+  attr_reader :server, :client
+
+  def initialize(server)
+    @server = server
+    @client = nil
+  end
+
+  def method_missing(command, *args)
+    command_string = command.to_s
+    if run("command -v #{command_string}")
+      puts "Executing command: #{command} #{args.join(' ')}"
+      output = run("#{command} #{args.join(' ')}")
+      puts output
+    else
+      super
+    end
+  end
+
+  def connect
+    @client = Net::SSH.start(@server.host, @server.user, password: @server.password)
+  rescue StandardError => e
+    puts "Error connecting to #{@server.host}: #{e.message}"
+  end
+
+  def run1(command)
+    return unless @client
+
+    @client.exec!(command)
+  rescue StandardError => e
+    puts "Error executing command on #{@host}: #{e.message}"
+    nil
+  end
+
+  def run(command)
+    connect unless @client
+    output = ""
+    @client.exec!(command) do |channel, stream, data|
+      output = data
+    end
+    output
+  end
+
+  def put(local_file, remote_path)
+    connect unless @client
+    Net::SCP.upload!(@client.connection, local_file, remote_path)
+  end
+
+  def close
+    @client.close if @client
+  end
+end

data/lib/wiz-teleport/version.rb

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

data/lib/wiz-teleport.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require_relative "wiz-teleport/version"
+require_relative 'wiz-teleport/rake_dsl'
+
+module WizTeleport
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+
+if defined?(Rake)
+  extend WizTeleport::RakeDSL
+end
+
+# if defined?(Rake)
+#   Rake.application.instance_eval do
+#     extend Teleport::RakeDSL
+#   end
+# end

data/sig/wiz-teleport.rbs

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: wiz-teleport
+version: !ruby/object:Gem::Version
+  version: 0.5.1
+platform: ruby
+authors:
+- songgz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-26 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.3.0
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Teleport is designed to execute shell commands remotely over SSH, with
+  no agents to install on remote systems.
+email:
+- "'sgzhe@163.com'"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wiz-teleport.rb
+- lib/wiz-teleport/group.rb
+- lib/wiz-teleport/inventory.rb
+- lib/wiz-teleport/rake_dsl.rb
+- lib/wiz-teleport/server.rb
+- lib/wiz-teleport/shell.rb
+- lib/wiz-teleport/ssh_client.rb
+- lib/wiz-teleport/version.rb
+- sig/wiz-teleport.rbs
+- vendor/cache/minitest-5.25.1.gem
+- vendor/cache/mocha-2.7.1.gem
+- vendor/cache/net-scp-4.0.0.gem
+- vendor/cache/net-ssh-7.3.0.gem
+- vendor/cache/rake-13.0.6.gem
+- vendor/cache/ruby2_keywords-0.0.5.gem
+homepage: https://github.com/songgz/wiz-teleport
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/songgz/wiz-teleport
+  source_code_uri: https://github.com/songgz/wiz-teleport
+  changelog_uri: https://github.com/songgz/wiz-teleport/releases
+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.18
+signing_key:
+specification_version: 4
+summary: Teleport is a Ruby Gem that simplifies SSH connections and remote command
+  execution. It is ideal for operational tasks and automated deployments.
+test_files: []