dockerapi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39b737a07cdf35864b8be1402ca7d504c59fc854e2092762df7a9f448bb2bf24
+  data.tar.gz: d71d1894cab1f61a3713f0991d24c272f99373832bff140c962604a8d707621f
+SHA512:
+  metadata.gz: 3622c339bae6e7a93738d110a5d6eaa38dda6288abeebda35c4b376cd354b33fa2b1595bf53fc2da04cf8a5e6f8e78a49f7cea10927afdb3fc719f119d94a8fd
+  data.tar.gz: d40f00a1e7c913a5b005cba33182e2295da22d1631eb0fec23101d45639998391ad89829a03a51b3c197da8f69196c954fb8e70234f90175f2b7bbc410159be1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dockerapi.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    dockerapi (0.1.0)
+      excon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    excon (0.74.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dockerapi!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# dockerapi
+
+Interact directly with Docker API from Ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dockerapi'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dockerapi
+
+## Usage
+
+Let's test a Nginx container
+
+```ruby
+# Pull nginx image
+Docker::API::Image.create( fromImage: "nginx:latest" )
+
+# Create container
+Docker::API::Container.create( {name: "nginx"}, {Image: "nginx:latest", HostConfig: {PortBindings: {"80/tcp": [ {HostIp: "0.0.0.0", HostPort: "80"} ]}}})
+
+# Start container
+Docker::API::Container.start("nginx")
+
+# Open localhost or machine IP to check the container running
+
+# Restart container
+Docker::API::Container.restart("nginx")
+
+# Pause/unpause container
+Docker::API::Container.pause("nginx")
+Docker::API::Container.unpause("nginx")
+
+# List containers
+Docker::API::Container::list
+
+# List containers (including stopped ones)
+Docker::API::Container::list(all: true)
+
+# Inspect container
+Docker::API::Container.inspect("nginx")
+
+# View container's processes
+Docker::API::Container.top("nginx")
+
+# Let's enhance the output
+JSON.parse(Docker::API::Container.top("nginx").body)
+
+# View filesystem changes
+Docker::API::Container.changes("nginx")
+
+# View filesystem logs
+Docker::API::Container.logs("nginx", stdout: true)
+Docker::API::Container.logs("nginx", stdout: true, follow: true)
+
+# View filesystem stats
+Docker::API::Container.stats("nginx", stream: true)
+
+# Export container
+Docker::API::Container.export("nginx", "~/exported_container")
+
+# Get files from container
+Docker::API::Container.archive("nginx", "~/html.tar", path: "/usr/share/nginx/html/")
+
+# Stop container
+Docker::API::Container.stop("nginx")
+
+# Remove container
+Docker::API::Container.remove("nginx")
+
+# Remove stopped containers (prune)
+Docker::API::Container.prune
+```
+
+### Requests
+
+Requests should work as described in Docker API documentation.
+
+### Response
+
+All requests return a Excon::Response object.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Road to 1.0.0
+
+NS: Not Started
+
+WIP: Work In Progress
+
+
+| Class | Tests | Implementation | Refactoring |
+|---|---|---|---|
+| Container | WIP | WIP | NS |
+| Image | NS | NS | NS |
+| Volume | NS | NS | NS |
+| Network | NS | NS | NS |
+| System | NS | NS | NS |
+| Exec | NS | NS | NS |
+| Swarm | NS | NS | NS |
+| Node | NS | NS | NS |
+| Service | NS | NS | NS |
+| Task | NS | NS | NS |
+| Secret | NS | NS | NS |
+
+Misc: 
+* Improve response object
+* Improve error objects
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nu12/dockerapi.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dockerapi"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dockerapi.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/docker/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dockerapi"
+  spec.version       = Docker::API::GEM_VERSION
+  spec.authors       = ["Alysson A. Costa"]
+  spec.email         = ["alysson.avila.costa@gmail.com"]
+
+  spec.summary       = "Interact directly with Docker API from Ruby code."
+  spec.description   = "Interact directly with Docker API from Ruby code."
+  spec.homepage      = "https://github.com/nu12/dockerapi"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nu12/dockerapi.git"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon"
+end

data/lib/docker/api/connection.rb

@@ -0,0 +1,42 @@
+require "excon"
+require "singleton"
+require "json"
+module Docker
+    module API
+        class Connection
+            include Singleton
+
+            attr_reader(:connection)
+
+            def get path
+                r = @connection.get(path: path)
+                #p r
+                r
+            end
+
+            def post(path, body = nil)
+                if body
+                    r = @connection.post(path: path, headers: { "Content-Type" => "application/json" }, body: body.to_json)
+                else
+                    r = @connection.post(path: path)
+                end
+                #p r
+                r
+            end
+
+            def head(path)
+                @connection.head(path: path)
+            end
+
+            def delete path
+                @connection.delete(path: path)
+            end
+            
+            private
+            def initialize
+                @connection = Excon.new('unix:///', :socket => '/var/run/docker.sock')
+            end
+
+        end
+    end
+end

data/lib/docker/api/container.rb

@@ -0,0 +1,183 @@
+module Docker
+    module API
+        CreateBody = [:Hostname,:Domainname,:User,:AttachStdin,:AttachStdout,:AttachStderr,:ExposedPorts,:Tty,:OpenStdin,:StdinOnce,:Env,:Cmd,:HealthCheck,:ArgsEscaped,:Image,:Volumes,:WorkingDir,:Entrypoint,:NetworkDisabled,:MacAddress,:OnBuild,:Labels,:StopSignal,:StopTimeout,:Shell,:HostConfig,:NetworkingConfig]
+        UpdateBody = [:CpuShares, :Memory, :CgroupParent, :BlkioWeight, :BlkioWeightDevice, :BlkioWeightReadBps, :BlkioWeightWriteBps, :BlkioWeightReadOps, :BlkioWeightWriteOps, :CpuPeriod, :CpuQuota, :CpuRealtimePeriod, :CpuRealtimeRuntime, :CpusetCpus, :CpusetMems, :Devices, :DeviceCgroupRules, :DeviceRequest, :Kernel, :Memory, :KernelMemoryTCP, :MemoryReservation, :MemorySwap, :MemorySwappiness, :NanoCPUs, :OomKillDisable, :Init, :PidsLimit, :ULimits, :CpuCount, :CpuPercent, :IOMaximumIOps, :IOMaximumBandwidth, :RestartPolicy]
+
+        class Container
+
+            @@base_path = "/containers"
+
+            def self.list params = {}
+                self.validate Docker::API::InvalidParameter, [:all, :limit, :size, :filters], params
+                Docker::API::Connection.instance.get(self.build_path(["json"], params))
+            end
+
+            def self.inspect name, params = {}
+                self.validate Docker::API::InvalidParameter, [:size], params
+                Docker::API::Connection.instance.get(self.build_path([name, "json"], params))
+            end
+
+            def self.top name, params = {}
+                self.validate Docker::API::InvalidParameter, [:ps_args], params
+                Docker::API::Connection.instance.get(self.build_path([name, "top"], params))
+            end
+
+            def self.changes name
+                Docker::API::Connection.instance.get(self.build_path([name, "changes"]))
+            end
+
+            def self.start name, params = {}
+                self.validate Docker::API::InvalidParameter, [:detachKeys], params
+                Docker::API::Connection.instance.post(self.build_path([name, "start"], params))
+            end
+
+            def self.stop name, params = {}
+                self.validate Docker::API::InvalidParameter, [:t], params
+                Docker::API::Connection.instance.post(self.build_path([name, "stop"], params))
+            end
+
+            def self.restart name, params = {}
+                self.validate Docker::API::InvalidParameter, [:t], params
+                Docker::API::Connection.instance.post(self.build_path([name, "restart"], params))
+            end
+
+            def self.kill name, params = {}
+                self.validate Docker::API::InvalidParameter, [:signal], params
+                Docker::API::Connection.instance.post(self.build_path([name, "kill"], params))
+            end
+
+            def self.wait name, params = {}
+                self.validate Docker::API::InvalidParameter, [:condition], params
+                Docker::API::Connection.instance.post(self.build_path([name, "wait"], params))
+            end
+
+            def self.update name, body = {}
+                self.validate Docker::API::InvalidRequestBody, Docker::API::UpdateBody, body
+                Docker::API::Connection.instance.post(self.build_path([name, "update"]), body)
+            end
+
+            def self.rename name, params = {}
+                self.validate Docker::API::InvalidParameter, [:name], params
+                Docker::API::Connection.instance.post(self.build_path([name, "rename"], params))
+            end
+
+            def self.resize name, params = {}
+                self.validate Docker::API::InvalidParameter, [:w, :h], params
+                Docker::API::Connection.instance.post(self.build_path([name, "resize"], params))
+            end
+
+            def self.prune params = {}
+                self.validate Docker::API::InvalidParameter, [:filters], params
+                Docker::API::Connection.instance.post(self.build_path(["prune"], params))
+            end
+
+            def self.pause name
+                Docker::API::Connection.instance.post(self.build_path([name, "pause"]))
+            end
+
+            def self.unpause name
+                Docker::API::Connection.instance.post(self.build_path([name, "unpause"]))
+            end
+
+            def self.remove name, params = {}
+                self.validate Docker::API::InvalidParameter, [:v, :force, :link], params
+                Docker::API::Connection.instance.delete(self.build_path([name]))
+            end
+
+            def self.logs name, params = {}
+                self.validate Docker::API::InvalidParameter, [:follow, :stdout, :stderr, :since, :until, :timestamps, :tail], params
+                
+                path = self.build_path([name, "logs"], params)
+
+                if params[:follow] == true || params[:follow] == 1
+                    Docker::API::Connection.instance.connection.get(path: path , response_block: lambda { |chunk, remaining_bytes, total_bytes| puts chunk.inspect })
+                else
+                    Docker::API::Connection.instance.get(path)
+                end
+            end
+
+            def self.attach name, params = {}
+                self.validate Docker::API::InvalidParameter, [:detachKeys, :logs, :stream, :stdin, :stdout, :stderr], params
+                Docker::API::Connection.instance.connection.request(method: :post, path: self.build_path([name, "attach"], params) , response_block: lambda { |chunk, remaining_bytes, total_bytes| puts chunk.inspect })
+            end
+
+            def self.create params = {}, body = {}
+                self.validate Docker::API::InvalidParameter, [:name], params
+                self.validate Docker::API::InvalidRequestBody, Docker::API::CreateBody, body
+                Docker::API::Connection.instance.post(self.build_path(["create"], params), body)
+            end
+
+            def self.stats name, params = {}
+                self.validate Docker::API::InvalidParameter, [:stream], params
+                path = self.build_path([name, "stats"], params)
+
+                if params[:stream] == true || params[:stream] == 1
+                    streamer = lambda do |chunk, remaining_bytes, total_bytes|
+                        puts chunk
+                    end
+                    Docker::API::Connection.instance.connection.get(path: path , response_block: streamer)
+                else
+                    Docker::API::Connection.instance.get(path)
+                end
+            end
+
+            def self.export name, path = "exported_container"
+                response = Docker::API::Container.inspect(name)
+                if response.status == 200
+                    file = File.open(File.expand_path(path), "wb")
+                    streamer = lambda do |chunk, remaining_bytes, total_bytes|
+                        file.write(chunk)
+                    end
+                    response = Docker::API::Connection.instance.connection.get(path: self.build_path([name, "export"]) , response_block: streamer)
+                    file.close
+                end
+                response
+            end
+
+            def self.archive name, file, params = {}
+                self.validate Docker::API::InvalidParameter, [:path, :noOverwriteDirNonDir, :copyUIDGID], params
+
+                begin # File exists on disk, send it to container
+                    file = File.open( File.expand_path( file ) , "r")
+                    response = Docker::API::Connection.instance.connection.put(path: self.build_path([name, "archive"], params) , request_block: lambda { file.read(Excon.defaults[:chunk_size]).to_s} )
+                    file.close
+                rescue Errno::ENOENT # File doesnt exist, get it from container
+                    response = Docker::API::Connection.instance.head(self.build_path([name, "archive"], params))
+                    if response.status == 200 # file exists in container
+                        file = File.open( File.expand_path( file ) , "wb")
+                        response = Docker::API::Connection.instance.connection.get(path: self.build_path([name, "archive"], params) , response_block: lambda { |chunk, remaining_bytes, total_bytes| file.write(chunk) })
+                        file.close
+                    end
+                end
+                response
+            end
+      
+            private
+
+            def self.validate error, permitted_keys, params
+                not_permitted = params.keys - permitted_keys
+                raise error if not_permitted.size > 0
+            end
+
+            ## Converts Ruby Hash into query parameters
+            ## In general, the format is key=value
+            ## If value is another Hash, it should keep a json syntax {key:value}
+            def self.hash_to_params h
+                p = []
+                h.each do |k,v|
+                    if v.is_a?(Hash)
+                        p << "#{k}=#{v.to_json}"
+                    else
+                        p << "#{k}=#{v}"
+                    end
+                end
+                p.join("&").gsub(" ","")
+            end
+
+            def self.build_path path, params = {}
+                p = ([@@base_path] << path).join("/")
+                params.size > 0 ? [p, self.hash_to_params(params)].join("?") : p
+            end
+        end
+    end
+end

data/lib/docker/api/error.rb

@@ -0,0 +1,6 @@
+module Docker
+    module API
+      class InvalidParameter < StandardError; end
+      class InvalidRequestBody < StandardError; end
+    end
+  end

data/lib/docker/api/image.rb

@@ -0,0 +1,24 @@
+module Docker
+    module API
+        class Image
+
+            @@base_path = "/images"
+
+            def self.create query_params = {}
+                Docker::API::Connection.instance.post(self.build_path(["create"], query_params))
+            end
+
+            def self.remove name, query_params = {}
+                Docker::API::Connection.instance.delete(self.build_path([name],  query_params))
+            end
+
+            private
+
+            def self.build_path path, params = {}
+                p = ([@@base_path] << path).join("/")
+                params.size > 0 ? [p, params.map {|k,v| "#{k}=#{v}"}.join("&")].join("?") : p
+            end
+        end
+
+    end
+end

data/lib/docker/api/version.rb

@@ -0,0 +1,9 @@
+module Docker
+  module API
+    GEM_VERSION = "0.1.0"
+
+    API_VERSION = "1.40"
+
+    VERSION = "Gem: #{Docker::API::GEM_VERSION} | API: #{Docker::API::API_VERSION}"
+  end
+end

data/lib/dockerapi.rb

@@ -0,0 +1,12 @@
+require "docker/api/version"
+
+require "docker/api/error"
+require "docker/api/connection"
+require "docker/api/container"
+require "docker/api/image"
+
+module Docker
+  module API
+    
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: dockerapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alysson A. Costa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interact directly with Docker API from Ruby code.
+email:
+- alysson.avila.costa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dockerapi.gemspec
+- lib/docker/api/connection.rb
+- lib/docker/api/container.rb
+- lib/docker/api/error.rb
+- lib/docker/api/image.rb
+- lib/docker/api/version.rb
+- lib/dockerapi.rb
+homepage: https://github.com/nu12/dockerapi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nu12/dockerapi
+  source_code_uri: https://github.com/nu12/dockerapi.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Interact directly with Docker API from Ruby code.
+test_files: []