dockerc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d31aaeeb7a0afc460b89d17ed826a6653ec51deb
+  data.tar.gz: ae300a20f6114ccd4b425d646db435cbe9027717
+SHA512:
+  metadata.gz: 8107b5860b6f30cd4f620a1f3d9420c58f97e07b4169ff9c456f416608b3fde4799a81b234de2c8da49c499a93c66c8df961818310f629147d0d2749ceb8a348
+  data.tar.gz: 0ecb78a29669c9ac87647aa840164d4f6a1af0de2ddec5f69b0aab284cb0ef4cecb90f86811fee470d1691f668411f9371bd82e7ba29d79f10a5bc7e5dbf3c8a

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael Gorsuch
+
+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/README.md

@@ -0,0 +1,52 @@
+# Dockerc
+
+**Note: this is alpha software. The interfaces are not stable.**
+
+A lightweight docker client that focuses on:
+
+* returning simple data structures instead of any defined object model
+* normalization of parameters
+* exceptions thrown in exceptional cases
+* explicit code to reduce confusion
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dockerc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dockerc
+
+## Usage
+
+```ruby
+# connect to unix:///var/run/docker.sock
+c = Dockerc::Client.new
+# connect to an alternate docker endpoint
+c = Dockerc::Client.new(docker_url: 'http://localhost:4243')
+
+# pull an image from the public repository
+c.pull_image 'gorsuch/litterbox'
+
+# launch a container
+c.create_container :image => 'gorsuch/litterbox', :cmd => 'date'
+
+# list all containers
+c.containers
+#=> [{:command=>"date ", :created=>1392044336, :id=>"ea1c87570244276041caafb69ab2fd102c974b0b214e885304de00222b9f6bd0", :image=>"gorsuch/litterbox:latest", :names=>["/desperate_hawking"], :ports=>[], :status=>"Exit 0"}]
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dockerc/fork )
+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

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => :test

data/dockerc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dockerc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dockerc'
+  spec.version       = Dockerc::VERSION
+  spec.authors       = ['Michael Gorsuch']
+  spec.email         = ['michael.gorsuch@gmail.com']
+  spec.summary       = %q{Yet another docker client.}
+  spec.description   = spec.summary
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  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_dependency 'excon'
+  spec.add_dependency 'multi_json'
+    
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/dockerc.rb

@@ -0,0 +1,9 @@
+require 'uri'
+
+require 'excon'
+require 'multi_json'
+
+require 'dockerc/client'
+require 'dockerc/errors'
+require 'dockerc/normalizer'
+require 'dockerc/version'

data/lib/dockerc/client.rb

@@ -0,0 +1,83 @@
+module Dockerc
+  class Client
+    attr_reader :docker_url
+
+    def initialize(args={})
+      @docker_url = args.fetch(:docker_url, ENV['DOCKER_URL'] || 'unix:///var/run/docker.sock')
+    end
+
+    def connection
+      @connection ||= create_connection!
+    end
+
+    def create_connection!
+      uri = URI.parse docker_url
+      if uri.scheme == 'unix'
+        Excon.new('unix:///', socket: uri.path, persistent: true)
+      else
+        Excon.new(docker_url, persistent: true)
+      end
+    end
+
+    def containers
+      json = connection.get({
+        path: '/containers/json',
+        query: { all: 1 },
+        expects: [ 200 ]
+      }).body
+
+      normalizer.handle_response_data(MultiJson.load(json))
+    end
+
+    def create_container(params)
+      req = {
+        path:    '/containers/create',
+        body:    normalizer.handle_request_data(params).to_json,
+        expects: [ 201 ]
+      }
+      begin
+        res = connection.post(req)
+      rescue Excon::Errors::InternalServerError => e
+        raise Dockerc::Errors::ContainerCreationError, e.response.body
+      rescue Excon::Errors::NotFound
+        raise Dockerc::Errors::ImageNotFound
+      end
+
+      normalizer.handle_response_data(MultiJson.load(res.body))
+    end
+
+    def images
+      json = connection.get({
+        path:    '/images/json',
+        query:   { all: 1 },
+        expects: [ 200 ]
+      }).body
+
+      normalizer.handle_response_data(MultiJson.load(json))
+    end
+
+    def pull_image(name)
+      parts = []
+      streamer = lambda do |chunk, remaining_bytes, total_bytes|
+        data = MultiJson.load(chunk)
+        parts << normalizer.handle_response_data(data)
+      end
+      body = connection.post({
+        path:    '/images/create',
+        query:   normalizer.handle_request_query(from_image: name),
+        expects: [ 200 ],
+        response_block: streamer
+      }).body
+      unless parts.last.has_key?(:id)
+        raise Dockerc::Errors::ImagePullFailed, parts
+      end
+      parts
+    end
+
+    private
+
+    def normalizer
+      @normalizer ||= Dockerc::Normalizer.new
+    end
+  end
+end

data/lib/dockerc/errors.rb

@@ -0,0 +1,7 @@
+module Dockerc
+  module Errors
+    class ContainerCreationError < StandardError ; end
+    class ImageNotFound < StandardError ; end
+    class ImagePullFailed < StandardError ; end
+  end
+end

data/lib/dockerc/normalizer.rb

@@ -0,0 +1,60 @@
+module Dockerc
+  class Normalizer
+    def handle_request_query(h)
+      h.inject({}) do |memo,(k,v)|
+        memo[handle_request_query_key(k)] = handle_request_query_value(v)
+        memo    
+      end
+    end
+
+    def handle_request_query_key(s)
+      parts = s.to_s.split('_')
+      parts.map!(&:capitalize)
+      parts.first.downcase!
+      parts.join
+    end
+
+    def handle_request_query_value(s)
+      case s
+      when TrueClass
+        1
+      when FalseClass
+        0
+      else
+        s
+      end
+    end
+
+    def handle_request_data(h)
+      h.inject({}) do |memo, (k,v)|
+        memo[handle_request_key(k)] = v
+        memo
+      end
+    end
+
+    def handle_request_key(s)
+      parts = s.to_s.split('_')
+      parts.map(&:capitalize).join
+    end
+  
+    def handle_response_hash(h)
+      h.inject({}) do |memo, (k,v)|
+        memo[handle_response_hash_param(k)] = v
+        memo
+      end
+    end
+
+    def handle_response_hash_param(s)
+      s.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+    end
+
+    def handle_response_data(data)
+      case data
+      when Hash
+        handle_response_hash(data)
+      when Array
+        data.map { |h| handle_response_hash h }
+      end
+    end
+  end
+end

data/lib/dockerc/version.rb

@@ -0,0 +1,3 @@
+module Dockerc
+  VERSION = '0.0.1'
+end

data/test/normalizer_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class NormalizerTest < MiniTest::Unit::TestCase
+  def test_create
+    assert Dockerc::Normalizer.new
+  end
+
+  def test_query
+    n = Dockerc::Normalizer.new
+    assert_equal({'command' => 'foo'}, n.handle_request_query({:command => 'foo'}))
+    assert_equal({'fromImage' => 'gorsuch/litterbox'}, n.handle_request_query({:from_image => 'gorsuch/litterbox'}))
+    assert_equal({'all' => 1}, n.handle_request_query({:all => true}))
+  end
+
+  def test_request
+    n = Dockerc::Normalizer.new
+    assert_equal({'AttachStdin' => false}, n.handle_request_data({:attach_stdin => false}))
+  end
+
+  def test_response
+    n = Dockerc::Normalizer.new
+    assert_equal({:id => '12345', :warnings => []}, n.handle_response_data({'Id' => '12345', 'Warnings' => []}))
+    assert_equal([{:id => '12345'}, {:id => '6789'}], n.handle_response_data([{'Id' => '12345'}, {'Id' => '6789'}]))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'dockerc'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: dockerc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Gorsuch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Yet another docker client.
+email:
+- michael.gorsuch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dockerc.gemspec
+- lib/dockerc.rb
+- lib/dockerc/client.rb
+- lib/dockerc/errors.rb
+- lib/dockerc/normalizer.rb
+- lib/dockerc/version.rb
+- test/normalizer_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Yet another docker client.
+test_files:
+- test/normalizer_test.rb
+- test/test_helper.rb