ruby_llm-docker 0.0.1 → 0.2.5

data/lib/ruby_llm/docker/tag_image.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module RubyLLM
+  module Docker
+    # RubyLLM tool for tagging Docker images.
+    #
+    # This tool provides the ability to create new tags for existing Docker images,
+    # enabling better organization, versioning, and distribution of images. Tags
+    # are essential for image management and registry operations.
+    #
+    # == Features
+    #
+    # - Tag images by ID or existing name
+    # - Support for repository and tag specification
+    # - Force tagging to overwrite existing tags
+    # - Registry-compatible tag formatting
+    # - Comprehensive error handling
+    # - Multiple tags per image support
+    #
+    # == Tag Management Benefits
+    #
+    # Proper tagging enables:
+    # - **Version Control**: Track different image versions
+    # - **Distribution**: Prepare images for registry push
+    # - **Organization**: Group related images logically
+    # - **Deployment**: Reference specific image versions
+    # - **Rollback**: Maintain previous versions for rollback
+    #
+    # == Security Considerations
+    #
+    # Tagging affects image accessibility and distribution:
+    # - Tags determine registry push destinations
+    # - Overwriting tags can affect running containers
+    # - Registry-compatible tags expose images for distribution
+    # - Tag names may reveal application details
+    #
+    # Best practices:
+    # - Use descriptive but not sensitive tag names
+    # - Avoid overwriting production tags accidentally
+    # - Implement tag naming conventions
+    # - Regular cleanup of unused tags
+    # - Control access to critical tag operations
+    #
+    # == Tag Naming Conventions
+    #
+    # Recommended patterns:
+    # - **Semantic Versioning**: `v1.2.3`, `1.2.3-alpha`
+    # - **Environment Tags**: `prod`, `staging`, `dev`
+    # - **Feature Tags**: `feature-branch-name`
+    # - **Date Tags**: `2024-01-15`, `20240115`
+    # - **Commit Tags**: `sha-abc123def`
+    #
+    # == Example Usage
+    #
+    #   # Tag with version
+    #   TagImage.call(
+    #     server_context: context,
+    #     id: "abc123def456",
+    #     repo: "myapp",
+    #     tag: "v1.0.0"
+    #   )
+    #
+    #   # Tag for registry push
+    #   TagImage.call(
+    #     server_context: context,
+    #     id: "myapp:latest",
+    #     repo: "myusername/myapp",
+    #     tag: "production"
+    #   )
+    #
+    #   # Tag for private registry
+    #   TagImage.call(
+    #     server_context: context,
+    #     id: "webapp:dev",
+    #     repo: "registry.company.com/team/webapp",
+    #     tag: "v2.1.0"
+    #   )
+    #
+    # @see BuildImage
+    # @see PushImage
+    # @see Docker::Image#tag
+    # @since 0.1.0
+    class TagImage < RubyLLM::Tool
+      description 'Tag a Docker image'
+
+      param :id, type: :string, desc: 'Image ID or current name:tag'
+      param :repo, type: :string,
+                   desc: 'Repository name (e.g., "username/imagename" or "registry/username/imagename")'
+      param :tag, type: :string, desc: 'Tag for the image (default: "latest")', required: false
+      param :force, type: :boolean, desc: 'Force tag even if it already exists (default: true)', required: false
+
+      # Tag a Docker image with a new repository and tag name.
+      #
+      # This method creates a new tag for an existing image, allowing it to
+      # be referenced by the new name. This is essential for organizing images
+      # and preparing them for registry distribution.
+      #
+      # @param id [String] image ID or current name:tag to tag
+      # @param repo [String] repository name for the new tag
+      # @param server_context [Object] RubyLLM context (unused but required)
+      # @param tag [String] tag name for the image (default: "latest")
+      # @param force [Boolean] whether to overwrite existing tags (default: true)
+      #
+      # @return [RubyLLM::Tool::Response] tagging operation results
+      #
+      # @raise [Docker::Error::NotFoundError] if source image doesn't exist
+      # @raise [StandardError] for other tagging failures
+      #
+      # @example Tag for versioning
+      #   response = TagImage.call(
+      #     server_context: context,
+      #     id: "my-app:latest",
+      #     repo: "my-app",
+      #     tag: "v1.2.3"
+      #   )
+      #
+      # @example Tag for registry push
+      #   response = tool.execute(
+      #     id: "abc123def456",
+      #     repo: "myregistry.com/myuser/myapp",
+      #     tag: "production",
+      #     force: true
+      #   )
+      #
+      # @see Docker::Image#tag
+      def execute(id:, repo:, tag: 'latest', force: true)
+        image = ::Docker::Image.get(id)
+
+        image.tag('repo' => repo, 'tag' => tag, 'force' => force)
+
+        "Image tagged successfully as #{repo}:#{tag}"
+      rescue ::Docker::Error::NotFoundError
+        "Image #{id} not found"
+      rescue StandardError => e
+        "Error tagging image: #{e.message}"
+      end
+    end
+  end
+end

data/lib/ruby_llm/docker/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-module RubyLlm
+module RubyLLM
   module Docker
-    VERSION = "0.0.1"
+    VERSION = '0.2.5'
   end
 end

data/lib/ruby_llm/docker.rb

@@ -1,10 +1,60 @@
 # frozen_string_literal: true
 
-require_relative "docker/version"
+require 'ruby_llm'
+require 'docker'
+require 'shellwords'
+require 'zeitwerk'
 
-module RubyLlm
+loader = Zeitwerk::Loader.for_gem_extension(RubyLLM)
+loader.setup
+
+require_relative 'docker/version'
+
+module RubyLLM
   module Docker
     class Error < StandardError; end
-    # Your code goes here...
+
+    # Helper method to get all Docker tool classes
+    def self.all_tools
+      [
+        # Container Management
+        ListContainers,
+        CreateContainer,
+        RunContainer,
+        StartContainer,
+        StopContainer,
+        RemoveContainer,
+        RecreateContainer,
+        ExecContainer,
+        CopyToContainer,
+        FetchContainerLogs,
+
+        # Image Management
+        ListImages,
+        PullImage,
+        BuildImage,
+        TagImage,
+        PushImage,
+        RemoveImage,
+
+        # Network Management
+        ListNetworks,
+        CreateNetwork,
+        RemoveNetwork,
+
+        # Volume Management
+        ListVolumes,
+        CreateVolume,
+        RemoveVolume
+      ]
+    end
+
+    # Helper method to add all Docker tools to a RubyLLM chat instance
+    def self.add_all_tools_to_chat(chat)
+      all_tools.each do |tool_class|
+        chat.with_tool(tool_class)
+      end
+      chat
+    end
   end
 end

data/sig/ruby_llm/docker.rbs

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

metadata

@@ -1,16 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: ruby_llm-docker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Aaron F Stanton
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: This gem provides a simple interface for managing Docker containers from
-  Ruby via RubyLLM.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A comprehensive Ruby gem that provides Docker management capabilities
+  through RubyLLM tools. Enables AI assistants to interact with Docker containers,
+  images, networks, and volumes using natural language. Ported from DockerMCP to work
+  directly with RubyLLM without requiring an external MCP server.
 email:
 - afstanton@gmail.com
 executables: []
@@ -20,7 +78,32 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/docker_chat.rb
+- examples/list_containers.rb
+- examples/test_chat.rb
 - lib/ruby_llm/docker.rb
+- lib/ruby_llm/docker/build_image.rb
+- lib/ruby_llm/docker/copy_to_container.rb
+- lib/ruby_llm/docker/create_container.rb
+- lib/ruby_llm/docker/create_network.rb
+- lib/ruby_llm/docker/create_volume.rb
+- lib/ruby_llm/docker/exec_container.rb
+- lib/ruby_llm/docker/fetch_container_logs.rb
+- lib/ruby_llm/docker/list_containers.rb
+- lib/ruby_llm/docker/list_images.rb
+- lib/ruby_llm/docker/list_networks.rb
+- lib/ruby_llm/docker/list_volumes.rb
+- lib/ruby_llm/docker/pull_image.rb
+- lib/ruby_llm/docker/push_image.rb
+- lib/ruby_llm/docker/recreate_container.rb
+- lib/ruby_llm/docker/remove_container.rb
+- lib/ruby_llm/docker/remove_image.rb
+- lib/ruby_llm/docker/remove_network.rb
+- lib/ruby_llm/docker/remove_volume.rb
+- lib/ruby_llm/docker/run_container.rb
+- lib/ruby_llm/docker/start_container.rb
+- lib/ruby_llm/docker/stop_container.rb
+- lib/ruby_llm/docker/tag_image.rb
 - lib/ruby_llm/docker/version.rb
 - sig/ruby_llm/docker.rbs
 homepage: https://github.com/afstanton/ruby_llm-docker
@@ -30,6 +113,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/afstanton/ruby_llm-docker
   source_code_uri: https://github.com/afstanton/ruby_llm-docker
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -46,5 +130,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.7.2
 specification_version: 4
-summary: A Ruby gem for interacting with Docker containers directly with RubyLLM.
+summary: Docker management tools for RubyLLM - comprehensive container, image, network,
+  and volume operations
 test_files: []