docker-engine 0.1.1

data/lib/docker_engine/models/volume_inspect_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Volumes#inspect_
+    class VolumeInspectParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/volume_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Volumes#list
+    class VolumeListParams < DockerEngine::Internal::Type::BaseModel
+      extend DockerEngine::Internal::Type::RequestParameters::Converter
+      include DockerEngine::Internal::Type::RequestParameters
+
+      # @!attribute filters
+      #   JSON encoded value of the filters (a `map[string][]string`) to process on the
+      #   volumes list. Available filters:
+      #
+      #   - `dangling=<boolean>` When set to `true` (or `1`), returns all volumes that are
+      #     not in use by a container. When set to `false` (or `0`), only volumes that are
+      #     in use by one or more containers are returned.
+      #   - `driver=<volume-driver-name>` Matches volumes based on their driver.
+      #   - `label=<key>` or `label=<key>:<value>` Matches volumes based on the presence
+      #     of a `label` alone or a `label` and a value.
+      #   - `name=<volume-name>` Matches all or part of a volume name.
+      #
+      #   @return [String, nil]
+      optional :filters, String
+
+      # @!method initialize(filters: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::VolumeListParams} for more details.
+      #
+      #   @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      #   @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/docker_engine/models/volume_list_response.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Models
+    # @see DockerEngine::Resources::Volumes#list
+    class VolumeListResponse < DockerEngine::Internal::Type::BaseModel
+      # @!attribute volumes
+      #   List of volumes
+      #
+      #   @return [Array<DockerEngine::Models::Volume>, nil]
+      optional :volumes,
+               -> {
+                 DockerEngine::Internal::Type::ArrayOf[DockerEngine::Volume]
+               },
+               api_name: :Volumes
+
+      # @!attribute warnings
+      #   Warnings that occurred when fetching the list of volumes.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, DockerEngine::Internal::Type::ArrayOf[String], api_name: :Warnings
+
+      # @!method initialize(volumes: nil, warnings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {DockerEngine::Models::VolumeListResponse} for more details.
+      #
+      #   Volume list response
+      #
+      #   @param volumes [Array<DockerEngine::Models::Volume>] List of volumes
+      #
+      #   @param warnings [Array<String>] Warnings that occurred when fetching the list of volumes.
+    end
+  end
+end

data/lib/docker_engine/models.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  [DockerEngine::Internal::Type::BaseModel, *DockerEngine::Internal::Type::BaseModel.subclasses].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, DockerEngine::Internal::AnyHash) } }
+  end
+
+  DockerEngine::Internal::Util.walk_namespaces(DockerEngine::Models).each do |mod|
+    case mod
+    in DockerEngine::Internal::Type::Enum | DockerEngine::Internal::Type::Union
+      mod.constants.each do |name|
+        case mod.const_get(name)
+        in true | false
+          mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
+          mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
+        in Integer
+          mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
+          mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
+        in Float
+          mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
+          mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
+        in Symbol
+          mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
+          mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
+        else
+        end
+      end
+    else
+    end
+  end
+
+  DockerEngine::Internal::Util.walk_namespaces(DockerEngine::Models)
+                              .lazy
+                              .grep(DockerEngine::Internal::Type::Union)
+                              .each do |mod|
+    const = :Variants
+    next if mod.sorbet_constant_defined?(const)
+
+    mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
+  end
+
+  AuthLoginParams = DockerEngine::Models::AuthLoginParams
+
+  AuthResponse = DockerEngine::Models::AuthResponse
+
+  Config = DockerEngine::Models::Config
+
+  Container = DockerEngine::Models::Container
+
+  ContainerCreateParams = DockerEngine::Models::ContainerCreateParams
+
+  ContainerDeleteParams = DockerEngine::Models::ContainerDeleteParams
+
+  ContainerInspectParams = DockerEngine::Models::ContainerInspectParams
+
+  ContainerKillParams = DockerEngine::Models::ContainerKillParams
+
+  ContainerListParams = DockerEngine::Models::ContainerListParams
+
+  ContainerLogsParams = DockerEngine::Models::ContainerLogsParams
+
+  ContainerStartParams = DockerEngine::Models::ContainerStartParams
+
+  ContainerStopParams = DockerEngine::Models::ContainerStopParams
+
+  CreateRequest = DockerEngine::Models::CreateRequest
+
+  CreateResponse = DockerEngine::Models::CreateResponse
+
+  Error = DockerEngine::Models::Error
+
+  Image = DockerEngine::Models::Image
+
+  ImageDeleteParams = DockerEngine::Models::ImageDeleteParams
+
+  ImageInspectParams = DockerEngine::Models::ImageInspectParams
+
+  ImageListParams = DockerEngine::Models::ImageListParams
+
+  ImagePullParams = DockerEngine::Models::ImagePullParams
+
+  Network = DockerEngine::Models::Network
+
+  NetworkCreateParams = DockerEngine::Models::NetworkCreateParams
+
+  NetworkDeleteParams = DockerEngine::Models::NetworkDeleteParams
+
+  NetworkInspectParams = DockerEngine::Models::NetworkInspectParams
+
+  NetworkListParams = DockerEngine::Models::NetworkListParams
+
+  Service = DockerEngine::Models::Service
+
+  ServiceCreateParams = DockerEngine::Models::ServiceCreateParams
+
+  ServiceDeleteParams = DockerEngine::Models::ServiceDeleteParams
+
+  ServiceInspectParams = DockerEngine::Models::ServiceInspectParams
+
+  ServiceListParams = DockerEngine::Models::ServiceListParams
+
+  Spec = DockerEngine::Models::Spec
+
+  Summary = DockerEngine::Models::Summary
+
+  SystemInfoParams = DockerEngine::Models::SystemInfoParams
+
+  SystemPingParams = DockerEngine::Models::SystemPingParams
+
+  SystemVersionParams = DockerEngine::Models::SystemVersionParams
+
+  Volume = DockerEngine::Models::Volume
+
+  VolumeCreateParams = DockerEngine::Models::VolumeCreateParams
+
+  VolumeDeleteParams = DockerEngine::Models::VolumeDeleteParams
+
+  VolumeInspectParams = DockerEngine::Models::VolumeInspectParams
+
+  VolumeListParams = DockerEngine::Models::VolumeListParams
+end

data/lib/docker_engine/request_options.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < DockerEngine::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [DockerEngine::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in DockerEngine::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, DockerEngine::Internal::Type::HashOf[DockerEngine::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, DockerEngine::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, DockerEngine::Internal::Type::HashOf[DockerEngine::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+
+    define_sorbet_constant!(:OrHash) do
+      T.type_alias { T.any(DockerEngine::RequestOptions, DockerEngine::Internal::AnyHash) }
+    end
+  end
+end

data/lib/docker_engine/resources/auth.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Auth
+      # Validate credentials for a registry and, if available, get an identity token for
+      # accessing the registry without password.
+      #
+      # @overload login(password: nil, serveraddress: nil, username: nil, request_options: {})
+      #
+      # @param password [String]
+      # @param serveraddress [String]
+      # @param username [String]
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::AuthResponse]
+      #
+      # @see DockerEngine::Models::AuthLoginParams
+      def login(params = {})
+        parsed, options = DockerEngine::AuthLoginParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "auth",
+          body: parsed,
+          model: DockerEngine::AuthResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/containers.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Containers
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerCreateParams} for more details.
+      #
+      # Create a container
+      #
+      # @overload create(config:, name: nil, platform: nil, request_options: {})
+      #
+      # @param config [DockerEngine::Models::ContainerCreateParams::Config] Body param: Configuration for a container that is portable between hosts.
+      #
+      # @param name [String] Query param: Assign the specified name to the container. Must match
+      #
+      # @param platform [String] Query param: Platform in the format `os[/arch[/variant]]` used for image lookup.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::CreateResponse]
+      #
+      # @see DockerEngine::Models::ContainerCreateParams
+      def create(params)
+        parsed, options = DockerEngine::ContainerCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "containers/create",
+          query: parsed.except(:config),
+          body: parsed[:config],
+          model: DockerEngine::CreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerListParams} for more details.
+      #
+      # Returns a list of containers. For details on the format, see the
+      # [inspect endpoint](#operation/ContainerInspect).
+      #
+      # Note that it uses a different, smaller representation of a container than
+      # inspecting a single container. For example, the list of linked containers is not
+      # propagated .
+      #
+      # @overload list(all: nil, filters: nil, limit: nil, size: nil, request_options: {})
+      #
+      # @param all [Boolean] Return all containers. By default, only running containers are shown.
+      #
+      # @param filters [String] Filters to process on the container list, encoded as JSON (a
+      #
+      # @param limit [Integer] Return this number of most recently created containers, including
+      #
+      # @param size [Boolean] Return the size of container as fields `SizeRw` and `SizeRootFs`.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Summary>]
+      #
+      # @see DockerEngine::Models::ContainerListParams
+      def list(params = {})
+        parsed, options = DockerEngine::ContainerListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "containers/json",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Summary],
+          options: options
+        )
+      end
+
+      # Remove a container
+      #
+      # @overload delete(id, force: nil, link: nil, v: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @param force [Boolean] If the container is running, kill it before removing it.
+      #
+      # @param link [Boolean] Remove the specified link associated with the container.
+      #
+      # @param v [Boolean] Remove anonymous volumes associated with the container.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ContainerDeleteParams
+      def delete(id, params = {})
+        parsed, options = DockerEngine::ContainerDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["containers/%1$s", id],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Return low-level information about a container.
+      #
+      # @overload inspect_(id, size: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @param size [Boolean] Return the size of container as fields `SizeRw` and `SizeRootFs`
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Container]
+      #
+      # @see DockerEngine::Models::ContainerInspectParams
+      def inspect_(id, params = {})
+        parsed, options = DockerEngine::ContainerInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["containers/%1$s/json", id],
+          query: parsed,
+          model: DockerEngine::Container,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerKillParams} for more details.
+      #
+      # Send a POSIX signal to a container, defaulting to killing to the container.
+      #
+      # @overload kill(id, signal: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ContainerKillParams
+      def kill(id, params = {})
+        parsed, options = DockerEngine::ContainerKillParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["containers/%1$s/kill", id],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerLogsParams} for more details.
+      #
+      # Get `stdout` and `stderr` logs from a container.
+      #
+      # Note: This endpoint works only for containers with the `json-file` or `journald`
+      # logging driver.
+      #
+      # @overload logs(id, follow: nil, since: nil, stderr: nil, stdout: nil, tail: nil, timestamps: nil, until_: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @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 until_ [Integer] Only return logs before this time, as a UNIX timestamp
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [StringIO]
+      #
+      # @see DockerEngine::Models::ContainerLogsParams
+      def logs(id, params = {})
+        parsed, options = DockerEngine::ContainerLogsParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["containers/%1$s/logs", id],
+          query: parsed.transform_keys(until_: "until"),
+          headers: {"accept" => "application/vnd.docker.multiplexed-stream"},
+          model: StringIO,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerStartParams} for more details.
+      #
+      # Start a container
+      #
+      # @overload start(id, detach_keys: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @param detach_keys [String] Override the key sequence for detaching a container. Format is a
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ContainerStartParams
+      def start(id, params = {})
+        parsed, options = DockerEngine::ContainerStartParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["containers/%1$s/start", id],
+          query: parsed.transform_keys(detach_keys: "detachKeys"),
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ContainerStopParams} for more details.
+      #
+      # Stop a container
+      #
+      # @overload stop(id, signal: nil, t: nil, request_options: {})
+      #
+      # @param id [String] ID or name of the container
+      #
+      # @param signal [String] Signal to send to the container as an integer or string (e.g. `SIGINT`).
+      #
+      # @param t [Integer] Number of seconds to wait before killing the container
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ContainerStopParams
+      def stop(id, params = {})
+        parsed, options = DockerEngine::ContainerStopParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["containers/%1$s/stop", id],
+          query: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end