docker-engine 0.1.1

data/lib/docker_engine.rb

@@ -0,0 +1,114 @@
+# 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/version"
+require_relative "docker_engine/internal/util"
+require_relative "docker_engine/internal/type/converter"
+require_relative "docker_engine/internal/type/unknown"
+require_relative "docker_engine/internal/type/boolean"
+require_relative "docker_engine/internal/type/file_input"
+require_relative "docker_engine/internal/type/enum"
+require_relative "docker_engine/internal/type/union"
+require_relative "docker_engine/internal/type/array_of"
+require_relative "docker_engine/internal/type/hash_of"
+require_relative "docker_engine/internal/type/base_model"
+require_relative "docker_engine/internal/type/base_page"
+require_relative "docker_engine/internal/type/request_parameters"
+require_relative "docker_engine/internal"
+require_relative "docker_engine/request_options"
+require_relative "docker_engine/file_part"
+require_relative "docker_engine/errors"
+require_relative "docker_engine/internal/transport/base_client"
+require_relative "docker_engine/internal/transport/pooled_net_requester"
+require_relative "docker_engine/client"
+require_relative "docker_engine/models/config"
+require_relative "docker_engine/models/network"
+require_relative "docker_engine/models/spec"
+require_relative "docker_engine/models/create_request"
+require_relative "docker_engine/models/auth_login_params"
+require_relative "docker_engine/models/auth_response"
+require_relative "docker_engine/models/container"
+require_relative "docker_engine/models/container_create_params"
+require_relative "docker_engine/models/container_delete_params"
+require_relative "docker_engine/models/container_inspect_params"
+require_relative "docker_engine/models/container_kill_params"
+require_relative "docker_engine/models/container_list_params"
+require_relative "docker_engine/models/container_list_response"
+require_relative "docker_engine/models/container_logs_params"
+require_relative "docker_engine/models/container_start_params"
+require_relative "docker_engine/models/container_stop_params"
+require_relative "docker_engine/models/create_response"
+require_relative "docker_engine/models/error"
+require_relative "docker_engine/models/image"
+require_relative "docker_engine/models/image_delete_params"
+require_relative "docker_engine/models/image_delete_response"
+require_relative "docker_engine/models/image_inspect_params"
+require_relative "docker_engine/models/image_list_params"
+require_relative "docker_engine/models/image_list_response"
+require_relative "docker_engine/models/image_pull_params"
+require_relative "docker_engine/models/network_create_params"
+require_relative "docker_engine/models/network_create_response"
+require_relative "docker_engine/models/network_delete_params"
+require_relative "docker_engine/models/network_inspect_params"
+require_relative "docker_engine/models/network_inspect_response"
+require_relative "docker_engine/models/network_list_params"
+require_relative "docker_engine/models/network_list_response"
+require_relative "docker_engine/models/service"
+require_relative "docker_engine/models/service_create_params"
+require_relative "docker_engine/models/service_create_response"
+require_relative "docker_engine/models/service_delete_params"
+require_relative "docker_engine/models/service_inspect_params"
+require_relative "docker_engine/models/service_list_params"
+require_relative "docker_engine/models/service_list_response"
+require_relative "docker_engine/models/summary"
+require_relative "docker_engine/models/system_info_params"
+require_relative "docker_engine/models/system_info_response"
+require_relative "docker_engine/models/system_ping_params"
+require_relative "docker_engine/models/system_ping_response"
+require_relative "docker_engine/models/system_version_params"
+require_relative "docker_engine/models/system_version_response"
+require_relative "docker_engine/models/volume"
+require_relative "docker_engine/models/volume_create_params"
+require_relative "docker_engine/models/volume_delete_params"
+require_relative "docker_engine/models/volume_inspect_params"
+require_relative "docker_engine/models/volume_list_params"
+require_relative "docker_engine/models/volume_list_response"
+require_relative "docker_engine/models"
+require_relative "docker_engine/resources/auth"
+require_relative "docker_engine/resources/containers"
+require_relative "docker_engine/resources/images"
+require_relative "docker_engine/resources/networks"
+require_relative "docker_engine/resources/services"
+require_relative "docker_engine/resources/system"
+require_relative "docker_engine/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/client.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module DockerEngine
+  class Client < DockerEngine::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(DockerEngine::Resources::Auth) }
+    attr_reader :auth
+
+    sig { returns(DockerEngine::Resources::System) }
+    attr_reader :system_
+
+    sig { returns(DockerEngine::Resources::Containers) }
+    attr_reader :containers
+
+    sig { returns(DockerEngine::Resources::Images) }
+    attr_reader :images
+
+    sig { returns(DockerEngine::Resources::Networks) }
+    attr_reader :networks
+
+    sig { returns(DockerEngine::Resources::Volumes) }
+    attr_reader :volumes
+
+    sig { returns(DockerEngine::Resources::Services) }
+    attr_reader :services
+
+    # 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: DockerEngine::Client::DEFAULT_MAX_RETRIES,
+      timeout: DockerEngine::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DockerEngine::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DockerEngine::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+    end
+  end
+end

data/rbi/docker_engine/errors.rbi

@@ -0,0 +1,205 @@
+# typed: strong
+
+module DockerEngine
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < DockerEngine::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
+    end
+
+    class APIError < DockerEngine::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :headers
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
+      end
+    end
+
+    class APIConnectionError < DockerEngine::Errors::APIError
+      sig { returns(NilClass) }
+      attr_accessor :status
+
+      sig { returns(NilClass) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
+      end
+    end
+
+    class APITimeoutError < DockerEngine::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          headers: T.nilable(T::Hash[String, String]),
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        headers: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
+      end
+    end
+
+    class APIStatusError < DockerEngine::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.for(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          headers: T.nilable(T::Hash[String, String]),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status:,
+        headers:,
+        body:,
+        request:,
+        response:,
+        message: nil
+      )
+      end
+    end
+
+    class BadRequestError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < DockerEngine::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+  end
+end

data/rbi/docker_engine/file_part.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module DockerEngine
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a)
+    end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a)
+    end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(T.any(Pathname, String)),
+        content_type: T.nilable(String)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
+    end
+  end
+end