docker-engine-api 0.2.1

data/lib/docker_engine_api/resources/tasks.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Tasks
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::TaskListParams} for more details.
+      #
+      # List tasks
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngineAPI::Models::Task>]
+      #
+      # @see DockerEngineAPI::Models::TaskListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::TaskListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "tasks",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Task],
+          options: options
+        )
+      end
+
+      # Inspect a task
+      #
+      # @overload inspect_(id, request_options: {})
+      #
+      # @param id [String] ID of the task
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Task]
+      #
+      # @see DockerEngineAPI::Models::TaskInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["tasks/%1$s", id],
+          model: DockerEngineAPI::Task,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::TaskLogsParams} for more details.
+      #
+      # Get `stdout` and `stderr` logs from a task. See also
+      # [`/containers/{id}/logs`](#operation/ContainerLogs).
+      #
+      # **Note**: This endpoint works only for services with the `local`, `json-file` or
+      # `journald` logging drivers.
+      #
+      # @overload logs(id, details: nil, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, request_options: {})
+      #
+      # @param id [String] ID of the task
+      #
+      # @param details [Boolean] Show task context and extra details provided to logs.
+      #
+      # @param follow [Boolean] Keep connection after returning logs.
+      #
+      # @param since [Integer] Only return logs since this time, as a UNIX timestamp
+      #
+      # @param stderr [Boolean] Return logs from `stderr`
+      #
+      # @param stdout [Boolean] Return logs from `stdout`
+      #
+      # @param tail [String] Only return this number of log lines from the end of the logs.
+      #
+      # @param timestamps [Boolean] Add timestamps to every log line
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see DockerEngineAPI::Models::TaskLogsParams
+      def logs(id, params = {})
+        parsed, options = DockerEngineAPI::TaskLogsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["tasks/%1$s/logs", id],
+          query: parsed,
+          headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
+          model: StringIO,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/resources/volumes.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Volumes
+      # Create a volume
+      #
+      # @overload create(create_request:, request_options: {})
+      #
+      # @param create_request [DockerEngineAPI::Models::CreateRequest] Volume configuration
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Volume]
+      #
+      # @see DockerEngineAPI::Models::VolumeCreateParams
+      def create(params)
+        parsed, options = DockerEngineAPI::VolumeCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "volumes/create",
+          body: parsed[:create_request],
+          model: DockerEngineAPI::Volume,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::VolumeUpdateParams} for more details.
+      #
+      # "Update a volume. Valid only for Swarm cluster volumes"
+      #
+      # @overload update(name, version:, spec: nil, request_options: {})
+      #
+      # @param name [String] Path param: The name or ID of the volume
+      #
+      # @param version [Integer] Query param: The version number of the volume being updated. This is required to
+      #
+      # @param spec [DockerEngineAPI::Models::VolumeUpdateParams::Spec] Body param: Cluster-specific options used to create the volume.
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::VolumeUpdateParams
+      def update(name, params)
+        parsed, options = DockerEngineAPI::VolumeUpdateParams.dump_request(params)
+        query_params = [:version]
+        @client.request(
+          method: :put,
+          path: ["volumes/%1$s", name],
+          query: parsed.slice(*query_params),
+          body: parsed.except(*query_params),
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::VolumeListParams} for more details.
+      #
+      # List volumes
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::ListResponse]
+      #
+      # @see DockerEngineAPI::Models::VolumeListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::VolumeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "volumes",
+          query: parsed,
+          model: DockerEngineAPI::ListResponse,
+          options: options
+        )
+      end
+
+      # Instruct the driver to remove the volume.
+      #
+      # @overload delete(name, force: nil, request_options: {})
+      #
+      # @param name [String] Volume name or ID
+      #
+      # @param force [Boolean] Force the removal of the volume
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::VolumeDeleteParams
+      def delete(name, params = {})
+        parsed, options = DockerEngineAPI::VolumeDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["volumes/%1$s", name],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Inspect a volume
+      #
+      # @overload inspect_(name, request_options: {})
+      #
+      # @param name [String] Volume name or ID
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Volume]
+      #
+      # @see DockerEngineAPI::Models::VolumeInspectParams
+      def inspect_(name, params = {})
+        @client.request(
+          method: :get,
+          path: ["volumes/%1$s", name],
+          model: DockerEngineAPI::Volume,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::VolumePruneParams} for more details.
+      #
+      # Delete unused volumes
+      #
+      # @overload prune(filters: nil, request_options: {})
+      #
+      # @param filters [String] Filters to process on the prune list, encoded as JSON (a `map[string][]string`).
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::VolumePruneResponse]
+      #
+      # @see DockerEngineAPI::Models::VolumePruneParams
+      def prune(params = {})
+        parsed, options = DockerEngineAPI::VolumePruneParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "volumes/prune",
+          query: parsed,
+          model: DockerEngineAPI::Models::VolumePruneResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/version.rb

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

data/lib/docker_engine_api.rb

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
+require "English"
+require "base64"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "openssl"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) &&
+   caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
+   ARGV.none?(/dsl/)
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "docker_engine_api/version"
+require_relative "docker_engine_api/internal/util"
+require_relative "docker_engine_api/internal/type/converter"
+require_relative "docker_engine_api/internal/type/unknown"
+require_relative "docker_engine_api/internal/type/boolean"
+require_relative "docker_engine_api/internal/type/file_input"
+require_relative "docker_engine_api/internal/type/enum"
+require_relative "docker_engine_api/internal/type/union"
+require_relative "docker_engine_api/internal/type/array_of"
+require_relative "docker_engine_api/internal/type/hash_of"
+require_relative "docker_engine_api/internal/type/base_model"
+require_relative "docker_engine_api/internal/type/base_page"
+require_relative "docker_engine_api/internal/type/request_parameters"
+require_relative "docker_engine_api/internal"
+require_relative "docker_engine_api/request_options"
+require_relative "docker_engine_api/file_part"
+require_relative "docker_engine_api/errors"
+require_relative "docker_engine_api/internal/transport/base_client"
+require_relative "docker_engine_api/internal/transport/pooled_net_requester"
+require_relative "docker_engine_api/client"
+require_relative "docker_engine_api/models/auth_login_params"
+require_relative "docker_engine_api/models/auth_response"
+require_relative "docker_engine_api/models/config"
+require_relative "docker_engine_api/models/config_create_params"
+require_relative "docker_engine_api/models/config_create_response"
+require_relative "docker_engine_api/models/config_delete_params"
+require_relative "docker_engine_api/models/config_inspect_params"
+require_relative "docker_engine_api/models/config_list_params"
+require_relative "docker_engine_api/models/config_list_response"
+require_relative "docker_engine_api/models/config_update_params"
+require_relative "docker_engine_api/models/connect_request"
+require_relative "docker_engine_api/models/container"
+require_relative "docker_engine_api/models/container_archive_params"
+require_relative "docker_engine_api/models/container_attach_params"
+require_relative "docker_engine_api/models/container_changes_params"
+require_relative "docker_engine_api/models/container_changes_response"
+require_relative "docker_engine_api/models/container_create_params"
+require_relative "docker_engine_api/models/container_delete_params"
+require_relative "docker_engine_api/models/container_exec_params"
+require_relative "docker_engine_api/models/container_exec_response"
+require_relative "docker_engine_api/models/container_export_params"
+require_relative "docker_engine_api/models/container_inspect_params"
+require_relative "docker_engine_api/models/container_kill_params"
+require_relative "docker_engine_api/models/container_list_params"
+require_relative "docker_engine_api/models/container_list_response"
+require_relative "docker_engine_api/models/container_logs_params"
+require_relative "docker_engine_api/models/container_pause_params"
+require_relative "docker_engine_api/models/container_prune_params"
+require_relative "docker_engine_api/models/container_prune_response"
+require_relative "docker_engine_api/models/container_rename_params"
+require_relative "docker_engine_api/models/container_resize_params"
+require_relative "docker_engine_api/models/container_restart_params"
+require_relative "docker_engine_api/models/container_start_params"
+require_relative "docker_engine_api/models/container_stats_params"
+require_relative "docker_engine_api/models/container_stop_params"
+require_relative "docker_engine_api/models/container_top_params"
+require_relative "docker_engine_api/models/container_unpause_params"
+require_relative "docker_engine_api/models/container_update_params"
+require_relative "docker_engine_api/models/container_wait_params"
+require_relative "docker_engine_api/models/create_request"
+require_relative "docker_engine_api/models/create_response"
+require_relative "docker_engine_api/models/delete_item"
+require_relative "docker_engine_api/models/disconnect_request"
+require_relative "docker_engine_api/models/distribution_inspect_params"
+require_relative "docker_engine_api/models/error"
+require_relative "docker_engine_api/models/exec_inspect_params"
+require_relative "docker_engine_api/models/exec_inspect_response"
+require_relative "docker_engine_api/models/exec_resize_params"
+require_relative "docker_engine_api/models/exec_start_params"
+require_relative "docker_engine_api/models/filesystem_change"
+require_relative "docker_engine_api/models/history_item"
+require_relative "docker_engine_api/models/image"
+require_relative "docker_engine_api/models/image_build_params"
+require_relative "docker_engine_api/models/image_build_prune_params"
+require_relative "docker_engine_api/models/image_build_prune_response"
+require_relative "docker_engine_api/models/image_commit_params"
+require_relative "docker_engine_api/models/image_commit_response"
+require_relative "docker_engine_api/models/image_delete_params"
+require_relative "docker_engine_api/models/image_delete_response"
+require_relative "docker_engine_api/models/image_get_all_params"
+require_relative "docker_engine_api/models/image_get_params"
+require_relative "docker_engine_api/models/image_history_params"
+require_relative "docker_engine_api/models/image_history_response"
+require_relative "docker_engine_api/models/image_inspect_params"
+require_relative "docker_engine_api/models/image_list_params"
+require_relative "docker_engine_api/models/image_list_response"
+require_relative "docker_engine_api/models/image_load_params"
+require_relative "docker_engine_api/models/image_prune_params"
+require_relative "docker_engine_api/models/image_prune_response"
+require_relative "docker_engine_api/models/image_pull_params"
+require_relative "docker_engine_api/models/image_push_params"
+require_relative "docker_engine_api/models/image_search_params"
+require_relative "docker_engine_api/models/image_search_response"
+require_relative "docker_engine_api/models/image_tag_params"
+require_relative "docker_engine_api/models/info"
+require_relative "docker_engine_api/models/inspect"
+require_relative "docker_engine_api/models/inspect_response"
+require_relative "docker_engine_api/models/list_response"
+require_relative "docker_engine_api/models/network"
+require_relative "docker_engine_api/models/network_connect_params"
+require_relative "docker_engine_api/models/network_create_params"
+require_relative "docker_engine_api/models/network_delete_params"
+require_relative "docker_engine_api/models/network_disconnect_params"
+require_relative "docker_engine_api/models/network_inspect_params"
+require_relative "docker_engine_api/models/network_inspect_response"
+require_relative "docker_engine_api/models/network_list_params"
+require_relative "docker_engine_api/models/network_list_response"
+require_relative "docker_engine_api/models/network_prune_params"
+require_relative "docker_engine_api/models/network_prune_response"
+require_relative "docker_engine_api/models/node"
+require_relative "docker_engine_api/models/node_delete_params"
+require_relative "docker_engine_api/models/node_inspect_params"
+require_relative "docker_engine_api/models/node_list_params"
+require_relative "docker_engine_api/models/node_list_response"
+require_relative "docker_engine_api/models/node_update_params"
+require_relative "docker_engine_api/models/plugin"
+require_relative "docker_engine_api/models/plugin_create_params"
+require_relative "docker_engine_api/models/plugin_delete_params"
+require_relative "docker_engine_api/models/plugin_disable_params"
+require_relative "docker_engine_api/models/plugin_enable_params"
+require_relative "docker_engine_api/models/plugin_inspect_params"
+require_relative "docker_engine_api/models/plugin_list_params"
+require_relative "docker_engine_api/models/plugin_list_response"
+require_relative "docker_engine_api/models/plugin_privileges_params"
+require_relative "docker_engine_api/models/plugin_privileges_response"
+require_relative "docker_engine_api/models/plugin_pull_params"
+require_relative "docker_engine_api/models/plugin_push_params"
+require_relative "docker_engine_api/models/plugin_set_params"
+require_relative "docker_engine_api/models/plugin_upgrade_params"
+require_relative "docker_engine_api/models/privilege"
+require_relative "docker_engine_api/models/secret"
+require_relative "docker_engine_api/models/secret_create_params"
+require_relative "docker_engine_api/models/secret_create_response"
+require_relative "docker_engine_api/models/secret_delete_params"
+require_relative "docker_engine_api/models/secret_inspect_params"
+require_relative "docker_engine_api/models/secret_list_params"
+require_relative "docker_engine_api/models/secret_list_response"
+require_relative "docker_engine_api/models/secret_update_params"
+require_relative "docker_engine_api/models/service"
+require_relative "docker_engine_api/models/service_create_params"
+require_relative "docker_engine_api/models/service_delete_params"
+require_relative "docker_engine_api/models/service_inspect_params"
+require_relative "docker_engine_api/models/service_list_params"
+require_relative "docker_engine_api/models/service_list_response"
+require_relative "docker_engine_api/models/service_logs_params"
+require_relative "docker_engine_api/models/service_update_params"
+require_relative "docker_engine_api/models/spec"
+require_relative "docker_engine_api/models/stats_response"
+require_relative "docker_engine_api/models/summary"
+require_relative "docker_engine_api/models/swarm"
+require_relative "docker_engine_api/models/swarm_init_params"
+require_relative "docker_engine_api/models/swarm_init_response"
+require_relative "docker_engine_api/models/swarm_inspect_params"
+require_relative "docker_engine_api/models/swarm_join_params"
+require_relative "docker_engine_api/models/swarm_leave_params"
+require_relative "docker_engine_api/models/swarm_unlock_key_params"
+require_relative "docker_engine_api/models/swarm_unlock_key_response"
+require_relative "docker_engine_api/models/swarm_unlock_params"
+require_relative "docker_engine_api/models/swarm_update_params"
+require_relative "docker_engine_api/models/system_data_usage_params"
+require_relative "docker_engine_api/models/system_data_usage_response"
+require_relative "docker_engine_api/models/system_events_params"
+require_relative "docker_engine_api/models/system_events_response"
+require_relative "docker_engine_api/models/system_info_params"
+require_relative "docker_engine_api/models/system_ping_params"
+require_relative "docker_engine_api/models/system_ping_response"
+require_relative "docker_engine_api/models/system_version_params"
+require_relative "docker_engine_api/models/task"
+require_relative "docker_engine_api/models/task_inspect_params"
+require_relative "docker_engine_api/models/task_list_params"
+require_relative "docker_engine_api/models/task_list_response"
+require_relative "docker_engine_api/models/task_logs_params"
+require_relative "docker_engine_api/models/top_response"
+require_relative "docker_engine_api/models/update_response"
+require_relative "docker_engine_api/models/version"
+require_relative "docker_engine_api/models/volume"
+require_relative "docker_engine_api/models/volume_create_params"
+require_relative "docker_engine_api/models/volume_delete_params"
+require_relative "docker_engine_api/models/volume_inspect_params"
+require_relative "docker_engine_api/models/volume_list_params"
+require_relative "docker_engine_api/models/volume_prune_params"
+require_relative "docker_engine_api/models/volume_prune_response"
+require_relative "docker_engine_api/models/volume_update_params"
+require_relative "docker_engine_api/models/wait_response"
+require_relative "docker_engine_api/models"
+require_relative "docker_engine_api/resources/auth"
+require_relative "docker_engine_api/resources/configs"
+require_relative "docker_engine_api/resources/containers"
+require_relative "docker_engine_api/resources/distribution"
+require_relative "docker_engine_api/resources/exec"
+require_relative "docker_engine_api/resources/images"
+require_relative "docker_engine_api/resources/networks"
+require_relative "docker_engine_api/resources/nodes"
+require_relative "docker_engine_api/resources/plugins"
+require_relative "docker_engine_api/resources/secrets"
+require_relative "docker_engine_api/resources/services"
+require_relative "docker_engine_api/resources/swarm"
+require_relative "docker_engine_api/resources/system"
+require_relative "docker_engine_api/resources/tasks"
+require_relative "docker_engine_api/resources/volumes"

data/manifest.yaml

@@ -0,0 +1,17 @@
+dependencies:
+  - English
+  - base64
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - openssl
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/docker_engine_api/client.rbi

@@ -0,0 +1,80 @@
+# typed: strong
+
+module DockerEngineAPI
+  class Client < DockerEngineAPI::Internal::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(DockerEngineAPI::Resources::Auth) }
+    attr_reader :auth
+
+    sig { returns(DockerEngineAPI::Resources::System) }
+    attr_reader :system_
+
+    sig { returns(DockerEngineAPI::Resources::Containers) }
+    attr_reader :containers
+
+    sig { returns(DockerEngineAPI::Resources::Exec) }
+    attr_reader :exec_
+
+    sig { returns(DockerEngineAPI::Resources::Images) }
+    attr_reader :images
+
+    sig { returns(DockerEngineAPI::Resources::Networks) }
+    attr_reader :networks
+
+    sig { returns(DockerEngineAPI::Resources::Volumes) }
+    attr_reader :volumes
+
+    sig { returns(DockerEngineAPI::Resources::Services) }
+    attr_reader :services
+
+    sig { returns(DockerEngineAPI::Resources::Configs) }
+    attr_reader :configs
+
+    sig { returns(DockerEngineAPI::Resources::Secrets) }
+    attr_reader :secrets
+
+    sig { returns(DockerEngineAPI::Resources::Nodes) }
+    attr_reader :nodes
+
+    sig { returns(DockerEngineAPI::Resources::Swarm) }
+    attr_reader :swarm
+
+    sig { returns(DockerEngineAPI::Resources::Tasks) }
+    attr_reader :tasks
+
+    sig { returns(DockerEngineAPI::Resources::Plugins) }
+    attr_reader :plugins
+
+    sig { returns(DockerEngineAPI::Resources::Distribution) }
+    attr_reader :distribution
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float
+      ).returns(T.attached_class)
+    end
+    def self.new(
+      # Override the default base URL for the API, e.g.,
+      # `"https://api.example.com/v2/"`. Defaults to `ENV["DOCKER_BASE_URL"]`
+      base_url: ENV["DOCKER_BASE_URL"],
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: DockerEngineAPI::Client::DEFAULT_MAX_RETRIES,
+      timeout: DockerEngineAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DockerEngineAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DockerEngineAPI::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end