docker-engine 0.1.1

data/lib/docker_engine/resources/images.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Images
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ImageListParams} for more details.
+      #
+      # Returns a list of images on the server. Note that it uses a different, smaller
+      # representation of an image than inspecting a single image.
+      #
+      # @overload list(all: nil, digests: nil, filters: nil, manifests: nil, shared_size: nil, request_options: {})
+      #
+      # @param all [Boolean] Show all images. Only images from a final layer (no children) are shown by defau
+      #
+      # @param digests [Boolean] Show digest information as a `RepoDigests` field on each image.
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param manifests [Boolean] Include `Manifests` in the image summary.
+      #
+      # @param shared_size [Boolean] Compute and show shared size as a `SharedSize` field on each image.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Summary>]
+      #
+      # @see DockerEngine::Models::ImageListParams
+      def list(params = {})
+        parsed, options = DockerEngine::ImageListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "images/json",
+          query: parsed.transform_keys(shared_size: "shared-size"),
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Summary],
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ImageDeleteParams} for more details.
+      #
+      # Remove an image, along with any untagged parent images that were referenced by
+      # that image.
+      #
+      # Images can't be removed if they have descendant images, are being used by a
+      # running container or are being used by a build.
+      #
+      # @overload delete(name, force: nil, noprune: nil, platforms: nil, request_options: {})
+      #
+      # @param name [String] Image name or ID
+      #
+      # @param force [Boolean] Remove the image even if it is being used by stopped containers or has other tag
+      #
+      # @param noprune [Boolean] Do not delete untagged parent images
+      #
+      # @param platforms [Array<String>] Select platform-specific content to delete.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::ImageDeleteResponseItem>]
+      #
+      # @see DockerEngine::Models::ImageDeleteParams
+      def delete(name, params = {})
+        parsed, options = DockerEngine::ImageDeleteParams.dump_request(params)
+        @client.request(
+          method: :delete,
+          path: ["images/%1$s", name],
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Models::ImageDeleteResponseItem],
+          options: options
+        )
+      end
+
+      # Return low-level information about an image.
+      #
+      # @overload inspect_(name, manifests: nil, request_options: {})
+      #
+      # @param name [String] Image name or id
+      #
+      # @param manifests [Boolean] Include Manifests in the image summary.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Image]
+      #
+      # @see DockerEngine::Models::ImageInspectParams
+      def inspect_(name, params = {})
+        parsed, options = DockerEngine::ImageInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["images/%1$s/json", name],
+          query: parsed,
+          model: DockerEngine::Image,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ImagePullParams} for more details.
+      #
+      # Pull or import an image.
+      #
+      # @overload pull(changes: nil, from_image: nil, from_src: nil, message: nil, platform: nil, repo: nil, tag: nil, body: nil, x_registry_auth: nil, request_options: {})
+      #
+      # @param changes [Array<String>] Query param: Apply `Dockerfile` instructions to the image that is created,
+      #
+      # @param from_image [String] Query param: Name of the image to pull. If the name includes a tag or digest, sp
+      #
+      # @param from_src [String] Query param: Source to import. The value may be a URL from which the image can b
+      #
+      # @param message [String] Query param: Set commit message for imported image.
+      #
+      # @param platform [String] Query param: Platform in the format os[/arch[/variant]].
+      #
+      # @param repo [String] Query param: Repository name given to an image when it is imported. The repo may
+      #
+      # @param tag [String] Query param: Tag or digest. If empty when pulling an image, this causes all tags
+      #
+      # @param body [String] Body param
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ImagePullParams
+      def pull(params = {})
+        parsed, options = DockerEngine::ImagePullParams.dump_request(params)
+        query_params = [:changes, :from_image, :from_src, :message, :platform, :repo, :tag]
+        @client.request(
+          method: :post,
+          path: "images/create",
+          query: parsed.slice(*query_params).transform_keys(from_image: "fromImage", from_src: "fromSrc"),
+          headers: {
+            "content-type" => "application/octet-stream",
+            **parsed.except(:body, *query_params)
+          }.transform_keys(
+            x_registry_auth: "x-registry-auth"
+          ),
+          body: parsed[:body],
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/networks.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Networks
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::NetworkCreateParams} for more details.
+      #
+      # Create a network
+      #
+      # @overload create(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {})
+      #
+      # @param name [String] The network's name.
+      #
+      # @param attachable [Boolean] Globally scoped network is manually attachable by regular
+      #
+      # @param config_from [DockerEngine::Models::NetworkCreateParams::ConfigFrom] The config-only network source to provide the configuration for
+      #
+      # @param config_only [Boolean] Creates a config-only network. Config-only networks are placeholder
+      #
+      # @param driver [String] Name of the network driver plugin to use.
+      #
+      # @param enable_i_pv4 [Boolean] Enable IPv4 on the network.
+      #
+      # @param enable_i_pv6 [Boolean] Enable IPv6 on the network.
+      #
+      # @param ingress [Boolean] Ingress network is the network which provides the routing-mesh
+      #
+      # @param internal [Boolean] Restrict external access to the network.
+      #
+      # @param ipam [DockerEngine::Models::NetworkCreateParams::Ipam]
+      #
+      # @param labels [Hash{Symbol=>String}] User-defined key/value metadata.
+      #
+      # @param options [Hash{Symbol=>String}] Network specific options to be used by the drivers.
+      #
+      # @param scope [String] The level at which the network exists (e.g. `swarm` for cluster-wide
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::NetworkCreateResponse]
+      #
+      # @see DockerEngine::Models::NetworkCreateParams
+      def create(params)
+        parsed, options = DockerEngine::NetworkCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "networks/create",
+          body: parsed,
+          model: DockerEngine::Models::NetworkCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::NetworkListParams} for more details.
+      #
+      # Returns a list of networks. For details on the format, see the
+      # [network inspect endpoint](#operation/NetworkInspect).
+      #
+      # Note that it uses a different, smaller representation of a network than
+      # inspecting a single network. For example, the list of containers attached to the
+      # network is not propagated in API versions 1.28 and up.
+      #
+      # @overload list(filters: nil, request_options: {})
+      #
+      # @param filters [String] JSON encoded value of the filters (a `map[string][]string`) to process
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Summary>]
+      #
+      # @see DockerEngine::Models::NetworkListParams
+      def list(params = {})
+        parsed, options = DockerEngine::NetworkListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "networks",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Summary],
+          options: options
+        )
+      end
+
+      # Remove a network
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::NetworkDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["networks/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Inspect a network
+      #
+      # @overload inspect_(id, scope: nil, verbose: nil, request_options: {})
+      #
+      # @param id [String] Network ID or name
+      #
+      # @param scope [String] Filter the network by scope (swarm, global, or local)
+      #
+      # @param verbose [Boolean] Detailed inspect output for troubleshooting
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::NetworkInspectResponse]
+      #
+      # @see DockerEngine::Models::NetworkInspectParams
+      def inspect_(id, params = {})
+        parsed, options = DockerEngine::NetworkInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["networks/%1$s", id],
+          query: parsed,
+          model: DockerEngine::Models::NetworkInspectResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/services.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Services
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ServiceCreateParams} for more details.
+      #
+      # Create a service
+      #
+      # @overload create(spec:, x_registry_auth: nil, request_options: {})
+      #
+      # @param spec [DockerEngine::Models::ServiceCreateParams::Spec] Body param: User modifiable configuration for a service.
+      #
+      # @param x_registry_auth [String] Header param: A base64url-encoded auth configuration for pulling from private
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::ServiceCreateResponse]
+      #
+      # @see DockerEngine::Models::ServiceCreateParams
+      def create(params)
+        parsed, options = DockerEngine::ServiceCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "services/create",
+          headers: parsed.except(:spec).transform_keys(x_registry_auth: "x-registry-auth"),
+          body: parsed[:spec],
+          model: DockerEngine::Models::ServiceCreateResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::Models::ServiceListParams} for more details.
+      #
+      # List services
+      #
+      # @overload list(filters: nil, status: nil, request_options: {})
+      #
+      # @param filters [String] A JSON encoded value of the filters (a `map[string][]string`) to
+      #
+      # @param status [Boolean] Include service status, with count of running and desired tasks.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Array<DockerEngine::Models::Service>]
+      #
+      # @see DockerEngine::Models::ServiceListParams
+      def list(params = {})
+        parsed, options = DockerEngine::ServiceListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "services",
+          query: parsed,
+          model: DockerEngine::Internal::Type::ArrayOf[DockerEngine::Service],
+          options: options
+        )
+      end
+
+      # Delete a service
+      #
+      # @overload delete(id, request_options: {})
+      #
+      # @param id [String] ID or name of service.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::ServiceDeleteParams
+      def delete(id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["services/%1$s", id],
+          model: NilClass,
+          options: params[:request_options]
+        )
+      end
+
+      # Inspect a service
+      #
+      # @overload inspect_(id, insert_defaults: nil, request_options: {})
+      #
+      # @param id [String] ID or name of service.
+      #
+      # @param insert_defaults [Boolean] Fill empty fields with default values.
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Service]
+      #
+      # @see DockerEngine::Models::ServiceInspectParams
+      def inspect_(id, params = {})
+        parsed, options = DockerEngine::ServiceInspectParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["services/%1$s", id],
+          query: parsed.transform_keys(insert_defaults: "insertDefaults"),
+          model: DockerEngine::Service,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/system.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class System
+      # Get system information
+      #
+      # @overload info(request_options: {})
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::SystemInfoResponse]
+      #
+      # @see DockerEngine::Models::SystemInfoParams
+      def info(params = {})
+        @client.request(
+          method: :get,
+          path: "info",
+          model: DockerEngine::Models::SystemInfoResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # This is a dummy endpoint you can use to test if the server is accessible.
+      #
+      # @overload ping(request_options: {})
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [String]
+      #
+      # @see DockerEngine::Models::SystemPingParams
+      def ping(params = {})
+        @client.request(
+          method: :get,
+          path: "_ping",
+          headers: {"accept" => "text/plain"},
+          model: String,
+          options: params[:request_options]
+        )
+      end
+
+      # Returns the version of Docker that is running and various information about the
+      # system that Docker is running on.
+      #
+      # @overload version(request_options: {})
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::SystemVersionResponse]
+      #
+      # @see DockerEngine::Models::SystemVersionParams
+      def version(params = {})
+        @client.request(
+          method: :get,
+          path: "version",
+          model: DockerEngine::Models::SystemVersionResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/resources/volumes.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module DockerEngine
+  module Resources
+    class Volumes
+      # Create a volume
+      #
+      # @overload create(create_request:, request_options: {})
+      #
+      # @param create_request [DockerEngine::Models::CreateRequest] Volume configuration
+      #
+      # @param request_options [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Volume]
+      #
+      # @see DockerEngine::Models::VolumeCreateParams
+      def create(params)
+        parsed, options = DockerEngine::VolumeCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "volumes/create",
+          body: parsed[:create_request],
+          model: DockerEngine::Volume,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::VolumeListResponse]
+      #
+      # @see DockerEngine::Models::VolumeListParams
+      def list(params = {})
+        parsed, options = DockerEngine::VolumeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "volumes",
+          query: parsed,
+          model: DockerEngine::Models::VolumeListResponse,
+          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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see DockerEngine::Models::VolumeDeleteParams
+      def delete(name, params = {})
+        parsed, options = DockerEngine::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 [DockerEngine::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [DockerEngine::Models::Volume]
+      #
+      # @see DockerEngine::Models::VolumeInspectParams
+      def inspect_(name, params = {})
+        @client.request(
+          method: :get,
+          path: ["volumes/%1$s", name],
+          model: DockerEngine::Volume,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [DockerEngine::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/docker_engine/version.rb

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