docker-client 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p327@octo

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docker.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :cli => "-t ~live" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Georg Kunz
+
+MIT License
+
+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/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Georg Kunz.
+
+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,87 @@
+# Docker Client
+
+Docker client library to access the Docker remote API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docker-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-client
+
+## Usage
+
+So far only the containers resource is supported. The images resource and endpoints in category Mics according to the Docker [Remote API documentation](http://docs.docker.io/en/latest/api/docker_remote_api.html) are not yet implemented.
+
+
+````ruby
+require 'docker'
+require 'awesome_print'
+
+docker = Docker::API.new(base_url: 'http://localhost:4243')
+containers = docker.containers
+
+# Create a new container
+result = containers.create(['/bin/sh', '-c', 'while true; do echo hello world; sleep 1; done'], 'base')
+container_id = result["Id"]
+ap result
+
+# Start created container
+containers.start(container_id)
+
+# Get container details (inspect)
+details = containers.show(container_id)
+ap details
+
+# Get file system changes of container
+changes = containers.changes(container_id)
+ap changes
+
+# Attach to container for 3 seconds
+options = {stdout: true, stderr: false}
+containers.attach(container_id, options, 3) do |data|
+  puts ">> #{data}"
+end
+
+# Get all output since container is started
+output = containers.logs(container_id)
+ap output
+
+# List all running containers
+running_containers = containers.list
+ap running_containers
+
+# Stop container
+containers.stop(container_id)
+
+# Remove container
+containers.remove(container_id)
+
+````
+
+## Development
+
+### Run tests
+
+All tests are stubbed with VCR. You can edit the setting `config.default_cassette_options` in `spec_helper.rb` to run the tests against the docker API. Set it to `{:record => :all}`. This will  alos re-record all VCR request/response. To run the tests stubbed again uncomment the before mentioned setting.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## License
+
+MIT License. Copyright 2013 Georg Kunz.
+

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # Documentation output
+  # Disable live tests
+  t.rspec_opts = "-f d -t ~live"
+end
+
+# Only run focus examples
+RSpec::Core::RakeTask.new(:focus) do |t|
+  t.rspec_opts = "-f d -t focus"
+end
+
+task :default => :spec

data/docker.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'docker-client'
+  spec.version       = Docker::VERSION
+  spec.authors       = ['Georg Kunz']
+  spec.email         = ['kwd@gmx.ch']
+  spec.description   = %q{Docker client}
+  spec.summary       = %q{Docker client library to access the Docker remote API.}
+  spec.homepage      = 'https://github.com/geku/docker-client'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 1.9'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'vcr', '~> 2.5'
+  spec.add_development_dependency 'webmock', '~> 1.11'
+  spec.add_development_dependency 'activesupport', '~> 3.2.13'
+  
+  spec.add_runtime_dependency 'multi_json'
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'curb'
+  spec.add_runtime_dependency 'guard'
+  spec.add_runtime_dependency 'guard-rspec'
+  spec.add_runtime_dependency 'awesome_print'
+  
+  # interesting GEMs
+  # https://github.com/intridea/hashie
+  # https://github.com/tcocca/rash
+  
+end

data/lib/docker.rb

@@ -0,0 +1,10 @@
+require 'active_support/core_ext/numeric'
+
+require 'docker/version'
+require 'docker/api'
+require 'docker/resource'
+require 'docker/error'
+
+module Docker
+  # Your code goes here...
+end

data/lib/docker/api.rb

@@ -0,0 +1,32 @@
+require 'docker/connection'
+
+module Docker
+end
+
+class Docker::API
+  
+  attr_reader :connection
+  
+  def initialize(options)
+    @debug      = options[:debug]
+    @ssl        = options[:ssl] || { :verify => false }
+    base_url    = options[:base_url]
+    @connection = Docker::Connection.new(base_url: base_url)
+    # @faraday_adapter = options[:faraday_adapter] || Faraday.default_adapter
+    # @faraday         = options[:faraday]         || default_faraday
+  end
+  
+  def containers
+    Docker::Resource::Container.new(@connection)
+  end
+  
+  def images
+    Docker::Resource::Image.new(@connection)
+  end
+  
+  def system
+    
+  end
+  
+  
+end

data/lib/docker/connection.rb

@@ -0,0 +1,83 @@
+require 'curb'
+require 'multi_json'
+
+module Docker
+end
+
+class Docker::Connection
+  
+  class Response < Struct.new(:body, :status, :content_type, :timeout)
+    def body_as_json
+      MultiJson.load(body)
+    end
+  end
+    
+  def initialize(options = {})
+    @curl = Curl::Easy.new
+    @base_url = options[:base_url]
+    raise(ArgumentError, ':base_url missing') unless @base_url
+  end
+  
+  def get(path, params = {}, headers = {})
+    resp = perform_request(:GET, path, params, nil, headers)
+    raise(Docker::Error::InternalServerError, resp.body) if resp.status == 500
+    resp
+  end
+  
+  def post(path, params = {}, body = '', headers = {})
+    resp = perform_request(:POST, path, params, body, headers)
+    raise(Docker::Error::InternalServerError, resp.body) if resp.status == 500
+    resp
+  end
+  
+  def delete(path, params = {}, headers = {})
+    resp = perform_request(:DELETE, path, params, nil, headers)
+    raise(Docker::Error::InternalServerError, resp.body) if resp.status == 500
+    resp
+  end
+  
+  def stream(path, params = {}, timeout = nil, headers = {}, &block)
+    raise(ArgumentError, 'Block required to handle streaming response') if block.nil?
+    begin
+      timeout_raised = false
+      set_url(path, params)
+      set_headers(headers)
+      @curl.timeout = timeout if timeout
+      @curl.on_body {|data| block.call(data); data.size }
+      @curl.http(:POST)
+    rescue Curl::Err::TimeoutError => e
+      timeout_raised = true
+    end
+    Response.new(@curl.body_str, @curl.response_code, @curl.content_type, timeout_raised)
+  end
+  
+  
+  private
+    
+    def perform_request(verb, path, query_params, body, headers)
+      set_url(path, query_params)
+      set_headers(headers)
+      set_body(body)
+      @curl.http(verb)
+      Response.new(@curl.body_str, @curl.response_code, @curl.content_type)
+    end
+    
+    def set_body(body)
+      @curl.post_body = body if body
+    end
+    
+    def set_url(path, query_params)
+      params = query_params.collect do |key, value|
+        "#{@curl.escape(key)}=#{@curl.escape(value)}"
+      end
+      param_str = params.empty? ? '' : "?#{params.join('&')}"
+      @curl.url = "#{@base_url}#{path}#{param_str}"
+    end
+    
+    def set_headers(headers)
+      headers.each do |key, value|
+        @curl.headers[key] = value
+      end
+    end
+  
+end

data/lib/docker/error.rb

@@ -0,0 +1,9 @@
+require 'docker/error/internal_server_error'
+require 'docker/error/container_not_found'
+require 'docker/error/not_found_error'
+require 'docker/error/bad_parameter_error'
+
+module Docker
+  module Error
+  end
+end

data/lib/docker/error/bad_parameter_error.rb

@@ -0,0 +1,7 @@
+module Docker
+  module Error
+  end
+end
+
+class Docker::Error::BadParameterError < StandardError
+end

data/lib/docker/error/container_not_found.rb

@@ -0,0 +1,7 @@
+module Docker
+  module Error
+  end
+end
+
+class Docker::Error::ContainerNotFound < StandardError
+end

data/lib/docker/error/internal_server_error.rb

@@ -0,0 +1,7 @@
+module Docker
+  module Error
+  end
+end
+
+class Docker::Error::InternalServerError < StandardError
+end

data/lib/docker/error/not_found_error.rb

@@ -0,0 +1,7 @@
+module Docker
+  module Error
+  end
+end
+
+class Docker::Error::NotFoundError < StandardError
+end

data/lib/docker/resource.rb

@@ -0,0 +1,8 @@
+require 'docker/resource/base'
+require 'docker/resource/container'
+require 'docker/resource/image'
+
+module Docker
+  module Resource
+  end
+end

data/lib/docker/resource/base.rb

@@ -0,0 +1,23 @@
+module Docker
+  module Resource
+  end
+end
+
+class Docker::Resource::Base
+  def initialize(connection)
+    @connection = connection
+  end
+  
+  private
+    
+    # TODO add all methods to gather all HTTP calls in this superclass
+    # Than it should be easier to replaces it for streaming support
+    def get
+      
+    end
+    
+    
+  
+end
+
+  

data/lib/docker/resource/container.rb

@@ -0,0 +1,131 @@
+
+module Docker
+  module Resource
+  end
+end
+
+class Docker::Resource::Container < Docker::Resource::Base
+  # TODO set 'Content-Type: application/json'
+  
+  # Options
+  # all
+  # limit
+  # since
+  # before
+  def list(options = {})
+    @connection.get('/containers/ps', options).body_as_json
+  end
+  
+  def create(command, image = 'base', options = {})
+    command = [command] if command.is_a?(String)
+    body = {'Cmd' => command, 'Image' => image}
+    body = options.merge(body)
+    json_body = MultiJson.dump(body)
+    
+    response = @connection.post("/containers/create", {}, json_body, {'Content-Type' => 'application/json'})
+    raise(Docker::Error::NotFoundError) if response.status == 404
+    response.body_as_json
+  end
+  
+  # inspect is a Ruby internal method that should not be overwritten 
+  # therefore we use show as it displays the container details
+  def show(container_id)
+    @connection.get("/containers/#{container_id}/json").body_as_json
+  end
+  
+  def changes(container_id)
+    @connection.get("/containers/#{container_id}/changes").body_as_json
+  end
+  
+  # Returns a stream
+  def export
+    
+  end
+  
+  def start(container_id)
+    status = @connection.post("/containers/#{container_id}/start").status
+    raise_if_container_not_found(status)
+    status == 204
+  end
+  
+  def stop(container_id, timeout = nil)
+    params = {}
+    params['t'] = timeout if timeout
+    status = @connection.post("/containers/#{container_id}/stop", params).status
+    raise_if_container_not_found(status)
+    status == 204
+  end
+  
+  def restart(container_id, timeout = nil)
+    params = {}
+    params['t'] = timeout if timeout
+    status = @connection.post("/containers/#{container_id}/restart", params).status
+    raise_if_container_not_found(status)
+    status == 204
+  end
+  
+  def kill(container_id)
+    status = @connection.post("/containers/#{container_id}/kill").status
+    raise_if_container_not_found(status)
+    status == 204
+  end
+  
+  # Valid options:
+  # stdout  true  default is false
+  # stderr  true  default is false
+  def attach(container_id, options = {}, timeout = nil, &block)
+    raise(ArgumentError, "Block must be given to handle streamed data") if block.nil?
+    options = {stdout: true, stderr: true} if options.empty?
+    options = options.merge(stream: true, logs: false)
+    
+    response = @connection.stream("/containers/#{container_id}/attach", options, timeout, {}, &block)
+    raise_if_container_not_found(response.status)
+    raise(BadParameterError) if response.status == 400
+    response
+  end
+  
+  def logs(container_id, options = {})
+    options = {stdout: true, stderr: true} if options.empty?
+    options = options.merge(logs: true, stream: false)
+    
+    response = @connection.post("/containers/#{container_id}/attach", options)
+    raise_if_container_not_found(response.status)
+    raise(BadParameterError) if response.status == 400
+    response.body
+  end
+  
+  # Blocks until container exits
+  def wait(container_id)
+    response = @connection.post("/containers/#{container_id}/wait")
+    raise_if_container_not_found(response.status)
+    response.body_as_json
+  end
+  
+  # Options:
+  # v remove volumes of container
+  def remove(container_id, delete_volumes = false)
+    params = {v: delete_volumes}
+    status = @connection.delete("/containers/#{container_id}", params).status
+    raise_if_container_not_found(status)
+    status == 204
+  end
+  
+  private
+  
+    def raise_if_container_not_found(status)
+      raise(Docker::Error::ContainerNotFound) if status == 404
+    end
+  
+  
+end
+
+  
+
+
+
+
+
+
+
+
+