docker-engine-api 0.2.1

data/lib/docker_engine_api/models.rb

@@ -0,0 +1,312 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  [
+    DockerEngineAPI::Internal::Type::BaseModel,
+    *DockerEngineAPI::Internal::Type::BaseModel.subclasses
+  ].each do |cls|
+    cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, DockerEngineAPI::Internal::AnyHash) } }
+  end
+
+  DockerEngineAPI::Internal::Util.walk_namespaces(DockerEngineAPI::Models).each do |mod|
+    case mod
+    in DockerEngineAPI::Internal::Type::Enum | DockerEngineAPI::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
+
+  DockerEngineAPI::Internal::Util.walk_namespaces(DockerEngineAPI::Models)
+                                 .lazy
+                                 .grep(DockerEngineAPI::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 = DockerEngineAPI::Models::AuthLoginParams
+
+  AuthResponse = DockerEngineAPI::Models::AuthResponse
+
+  Config = DockerEngineAPI::Models::Config
+
+  ConfigCreateParams = DockerEngineAPI::Models::ConfigCreateParams
+
+  ConfigDeleteParams = DockerEngineAPI::Models::ConfigDeleteParams
+
+  ConfigInspectParams = DockerEngineAPI::Models::ConfigInspectParams
+
+  ConfigListParams = DockerEngineAPI::Models::ConfigListParams
+
+  ConfigUpdateParams = DockerEngineAPI::Models::ConfigUpdateParams
+
+  ConnectRequest = DockerEngineAPI::Models::ConnectRequest
+
+  Container = DockerEngineAPI::Models::Container
+
+  ContainerArchiveParams = DockerEngineAPI::Models::ContainerArchiveParams
+
+  ContainerAttachParams = DockerEngineAPI::Models::ContainerAttachParams
+
+  ContainerChangesParams = DockerEngineAPI::Models::ContainerChangesParams
+
+  ContainerCreateParams = DockerEngineAPI::Models::ContainerCreateParams
+
+  ContainerDeleteParams = DockerEngineAPI::Models::ContainerDeleteParams
+
+  ContainerExecParams = DockerEngineAPI::Models::ContainerExecParams
+
+  ContainerExportParams = DockerEngineAPI::Models::ContainerExportParams
+
+  ContainerInspectParams = DockerEngineAPI::Models::ContainerInspectParams
+
+  ContainerKillParams = DockerEngineAPI::Models::ContainerKillParams
+
+  ContainerListParams = DockerEngineAPI::Models::ContainerListParams
+
+  ContainerLogsParams = DockerEngineAPI::Models::ContainerLogsParams
+
+  ContainerPauseParams = DockerEngineAPI::Models::ContainerPauseParams
+
+  ContainerPruneParams = DockerEngineAPI::Models::ContainerPruneParams
+
+  ContainerRenameParams = DockerEngineAPI::Models::ContainerRenameParams
+
+  ContainerResizeParams = DockerEngineAPI::Models::ContainerResizeParams
+
+  ContainerRestartParams = DockerEngineAPI::Models::ContainerRestartParams
+
+  ContainerStartParams = DockerEngineAPI::Models::ContainerStartParams
+
+  ContainerStatsParams = DockerEngineAPI::Models::ContainerStatsParams
+
+  ContainerStopParams = DockerEngineAPI::Models::ContainerStopParams
+
+  ContainerTopParams = DockerEngineAPI::Models::ContainerTopParams
+
+  ContainerUnpauseParams = DockerEngineAPI::Models::ContainerUnpauseParams
+
+  ContainerUpdateParams = DockerEngineAPI::Models::ContainerUpdateParams
+
+  ContainerWaitParams = DockerEngineAPI::Models::ContainerWaitParams
+
+  CreateRequest = DockerEngineAPI::Models::CreateRequest
+
+  CreateResponse = DockerEngineAPI::Models::CreateResponse
+
+  DeleteItem = DockerEngineAPI::Models::DeleteItem
+
+  DisconnectRequest = DockerEngineAPI::Models::DisconnectRequest
+
+  DistributionInspectParams = DockerEngineAPI::Models::DistributionInspectParams
+
+  Error = DockerEngineAPI::Models::Error
+
+  ExecInspectParams = DockerEngineAPI::Models::ExecInspectParams
+
+  ExecResizeParams = DockerEngineAPI::Models::ExecResizeParams
+
+  ExecStartParams = DockerEngineAPI::Models::ExecStartParams
+
+  FilesystemChange = DockerEngineAPI::Models::FilesystemChange
+
+  HistoryItem = DockerEngineAPI::Models::HistoryItem
+
+  Image = DockerEngineAPI::Models::Image
+
+  ImageBuildParams = DockerEngineAPI::Models::ImageBuildParams
+
+  ImageBuildPruneParams = DockerEngineAPI::Models::ImageBuildPruneParams
+
+  ImageCommitParams = DockerEngineAPI::Models::ImageCommitParams
+
+  ImageDeleteParams = DockerEngineAPI::Models::ImageDeleteParams
+
+  ImageGetAllParams = DockerEngineAPI::Models::ImageGetAllParams
+
+  ImageGetParams = DockerEngineAPI::Models::ImageGetParams
+
+  ImageHistoryParams = DockerEngineAPI::Models::ImageHistoryParams
+
+  ImageInspectParams = DockerEngineAPI::Models::ImageInspectParams
+
+  ImageListParams = DockerEngineAPI::Models::ImageListParams
+
+  ImageLoadParams = DockerEngineAPI::Models::ImageLoadParams
+
+  ImagePruneParams = DockerEngineAPI::Models::ImagePruneParams
+
+  ImagePullParams = DockerEngineAPI::Models::ImagePullParams
+
+  ImagePushParams = DockerEngineAPI::Models::ImagePushParams
+
+  ImageSearchParams = DockerEngineAPI::Models::ImageSearchParams
+
+  ImageTagParams = DockerEngineAPI::Models::ImageTagParams
+
+  Info = DockerEngineAPI::Models::Info
+
+  Inspect = DockerEngineAPI::Models::Inspect
+
+  InspectResponse = DockerEngineAPI::Models::InspectResponse
+
+  ListResponse = DockerEngineAPI::Models::ListResponse
+
+  Network = DockerEngineAPI::Models::Network
+
+  NetworkConnectParams = DockerEngineAPI::Models::NetworkConnectParams
+
+  NetworkCreateParams = DockerEngineAPI::Models::NetworkCreateParams
+
+  NetworkDeleteParams = DockerEngineAPI::Models::NetworkDeleteParams
+
+  NetworkDisconnectParams = DockerEngineAPI::Models::NetworkDisconnectParams
+
+  NetworkInspectParams = DockerEngineAPI::Models::NetworkInspectParams
+
+  NetworkListParams = DockerEngineAPI::Models::NetworkListParams
+
+  NetworkPruneParams = DockerEngineAPI::Models::NetworkPruneParams
+
+  Node = DockerEngineAPI::Models::Node
+
+  NodeDeleteParams = DockerEngineAPI::Models::NodeDeleteParams
+
+  NodeInspectParams = DockerEngineAPI::Models::NodeInspectParams
+
+  NodeListParams = DockerEngineAPI::Models::NodeListParams
+
+  NodeUpdateParams = DockerEngineAPI::Models::NodeUpdateParams
+
+  Plugin = DockerEngineAPI::Models::Plugin
+
+  PluginCreateParams = DockerEngineAPI::Models::PluginCreateParams
+
+  PluginDeleteParams = DockerEngineAPI::Models::PluginDeleteParams
+
+  PluginDisableParams = DockerEngineAPI::Models::PluginDisableParams
+
+  PluginEnableParams = DockerEngineAPI::Models::PluginEnableParams
+
+  PluginInspectParams = DockerEngineAPI::Models::PluginInspectParams
+
+  PluginListParams = DockerEngineAPI::Models::PluginListParams
+
+  PluginPrivilegesParams = DockerEngineAPI::Models::PluginPrivilegesParams
+
+  PluginPullParams = DockerEngineAPI::Models::PluginPullParams
+
+  PluginPushParams = DockerEngineAPI::Models::PluginPushParams
+
+  PluginSetParams = DockerEngineAPI::Models::PluginSetParams
+
+  PluginUpgradeParams = DockerEngineAPI::Models::PluginUpgradeParams
+
+  Privilege = DockerEngineAPI::Models::Privilege
+
+  Secret = DockerEngineAPI::Models::Secret
+
+  SecretCreateParams = DockerEngineAPI::Models::SecretCreateParams
+
+  SecretDeleteParams = DockerEngineAPI::Models::SecretDeleteParams
+
+  SecretInspectParams = DockerEngineAPI::Models::SecretInspectParams
+
+  SecretListParams = DockerEngineAPI::Models::SecretListParams
+
+  SecretUpdateParams = DockerEngineAPI::Models::SecretUpdateParams
+
+  Service = DockerEngineAPI::Models::Service
+
+  ServiceCreateParams = DockerEngineAPI::Models::ServiceCreateParams
+
+  ServiceDeleteParams = DockerEngineAPI::Models::ServiceDeleteParams
+
+  ServiceInspectParams = DockerEngineAPI::Models::ServiceInspectParams
+
+  ServiceListParams = DockerEngineAPI::Models::ServiceListParams
+
+  ServiceLogsParams = DockerEngineAPI::Models::ServiceLogsParams
+
+  ServiceUpdateParams = DockerEngineAPI::Models::ServiceUpdateParams
+
+  Spec = DockerEngineAPI::Models::Spec
+
+  StatsResponse = DockerEngineAPI::Models::StatsResponse
+
+  Summary = DockerEngineAPI::Models::Summary
+
+  SwarmAPI = DockerEngineAPI::Models::SwarmAPI
+
+  SwarmInitParams = DockerEngineAPI::Models::SwarmInitParams
+
+  SwarmInspectParams = DockerEngineAPI::Models::SwarmInspectParams
+
+  SwarmJoinParams = DockerEngineAPI::Models::SwarmJoinParams
+
+  SwarmLeaveParams = DockerEngineAPI::Models::SwarmLeaveParams
+
+  SwarmUnlockKeyParams = DockerEngineAPI::Models::SwarmUnlockKeyParams
+
+  SwarmUnlockParams = DockerEngineAPI::Models::SwarmUnlockParams
+
+  SwarmUpdateParams = DockerEngineAPI::Models::SwarmUpdateParams
+
+  SystemDataUsageParams = DockerEngineAPI::Models::SystemDataUsageParams
+
+  SystemEventsParams = DockerEngineAPI::Models::SystemEventsParams
+
+  SystemInfoParams = DockerEngineAPI::Models::SystemInfoParams
+
+  SystemPingParams = DockerEngineAPI::Models::SystemPingParams
+
+  SystemVersionParams = DockerEngineAPI::Models::SystemVersionParams
+
+  Task = DockerEngineAPI::Models::Task
+
+  TaskInspectParams = DockerEngineAPI::Models::TaskInspectParams
+
+  TaskListParams = DockerEngineAPI::Models::TaskListParams
+
+  TaskLogsParams = DockerEngineAPI::Models::TaskLogsParams
+
+  TopResponse = DockerEngineAPI::Models::TopResponse
+
+  UpdateResponse = DockerEngineAPI::Models::UpdateResponse
+
+  Version = DockerEngineAPI::Models::Version
+
+  Volume = DockerEngineAPI::Models::Volume
+
+  VolumeCreateParams = DockerEngineAPI::Models::VolumeCreateParams
+
+  VolumeDeleteParams = DockerEngineAPI::Models::VolumeDeleteParams
+
+  VolumeInspectParams = DockerEngineAPI::Models::VolumeInspectParams
+
+  VolumeListParams = DockerEngineAPI::Models::VolumeListParams
+
+  VolumePruneParams = DockerEngineAPI::Models::VolumePruneParams
+
+  VolumeUpdateParams = DockerEngineAPI::Models::VolumeUpdateParams
+
+  WaitResponse = DockerEngineAPI::Models::WaitResponse
+end

data/lib/docker_engine_api/request_options.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  # 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 < DockerEngineAPI::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in DockerEngineAPI::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,
+             DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::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, DockerEngineAPI::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, DockerEngineAPI::Internal::Type::HashOf[DockerEngineAPI::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(DockerEngineAPI::RequestOptions, DockerEngineAPI::Internal::AnyHash) }
+    end
+  end
+end

data/lib/docker_engine_api/resources/auth.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  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 [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::AuthResponse]
+      #
+      # @see DockerEngineAPI::Models::AuthLoginParams
+      def login(params = {})
+        parsed, options = DockerEngineAPI::AuthLoginParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "auth",
+          body: parsed,
+          model: DockerEngineAPI::AuthResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine_api/resources/configs.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module DockerEngineAPI
+  module Resources
+    class Configs
+      # Create a config
+      #
+      # @overload create(spec: nil, request_options: {})
+      #
+      # @param spec [DockerEngineAPI::Models::ConfigCreateParams::Spec]
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::ConfigCreateResponse]
+      #
+      # @see DockerEngineAPI::Models::ConfigCreateParams
+      def create(params = {})
+        parsed, options = DockerEngineAPI::ConfigCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "configs/create",
+          body: parsed[:spec],
+          model: DockerEngineAPI::Models::ConfigCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ConfigUpdateParams} for more details.
+      #
+      # Update a Config
+      #
+      # @overload update(id, version:, spec: nil, request_options: {})
+      #
+      # @param id [String] Path param: The ID or name of the config
+      #
+      # @param version [Integer] Query param: The version number of the config object being updated. This is
+      #
+      # @param spec [DockerEngineAPI::Models::Spec] Body param
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::ConfigUpdateParams
+      def update(id, params)
+        parsed, options = DockerEngineAPI::ConfigUpdateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["configs/%1$s/update", id],
+          query: parsed.except(:spec),
+          body: parsed[:spec],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngineAPI::Models::ConfigListParams} for more details.
+      #
+      # List configs
+      #
+      # @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::Config>]
+      #
+      # @see DockerEngineAPI::Models::ConfigListParams
+      def list(params = {})
+        parsed, options = DockerEngineAPI::ConfigListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "configs",
+          query: parsed,
+          model: DockerEngineAPI::Internal::Type::ArrayOf[DockerEngineAPI::Config],
+          options: options
+        )
+      end
+
+      # Delete a config
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID of the config
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngineAPI::Models::ConfigDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["configs/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Inspect a config
+      #
+      # @overload inspect_(id, request_options: {})
+      #
+      # @param id [String] ID of the config
+      #
+      # @param request_options [DockerEngineAPI::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngineAPI::Models::Config]
+      #
+      # @see DockerEngineAPI::Models::ConfigInspectParams
+      def inspect_(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["configs/%1$s", id],
+          model: DockerEngineAPI::Config,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngineAPI::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end