docker-porcelain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7efd63b3850efd8d08d78ecb5415b1b0d605909d
+  data.tar.gz: fb88214f6d293cb9a060a75552b20b3924082bd0
+SHA512:
+  metadata.gz: f25a8960da2cef4ad5643963aeb3a04ecf40e0c683fd07c9b06df4d8f809e8036b28b31bb6c14c69b7728cf7e6f95a36a0c9288881c74c7af3b7c1d187d91731
+  data.tar.gz: 27402efb8ed7e69890a1b62a6d9fda38acb9e89b75602009b67f5dbde1e8b3d8972b05b35ecefa6c10f8d45def964bfcd64810a6bda563a0cbfb861c86ad1723

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,32 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  RuboCop:
+#    enabled: true
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rafał Rzepecki
+
+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,86 @@
+# Docker::Porcelain
+
+Porcelain for the Docker API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docker-porcelain'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-porcelain
+
+## Usage
+
+There's several styles of using docker-porcelain:
+
+### Monkey-patching (AKA global extensions)
+
+Recommended for application code unless it causes problems.
+
+```ruby
+require 'docker/porcelain/extensions'
+
+container = Docker::Container.create 'Image' => 'alpine'
+container.write '/tmp/foo', 'This is the foo file!'
+```
+
+Note this will monkey patch docker-api classes, which might not be what you
+want (especially in a library).
+
+### Object extensions
+
+You can extend individual objects (recommended for library code):
+
+```ruby
+require 'docker/porcelain'
+
+container = Docker::Container.create 'Image' => 'alpine'
+container.extend Docker::Porcelain::Container
+container.write '/tmp/foo', 'This is the foo file!'
+```
+
+### Refinements
+
+[Not recommended](http://6ftdan.com/allyourdev/2015/06/21/ruby-refinements-not-quite-ready-for-production/),
+and it might not work as expected, but you can experiment:
+
+```ruby
+require 'docker/porcelain/refinements'
+
+using Docker::Porcelain
+
+container = Docker::Container.create 'Image' => 'alpine'
+container.write '/tmp/foo', 'This is the foo file!'
+```
+
+## Synopsis
+
+```ruby
+container.write '/tmp/foo', 'This is the foo file!'
+container.system 'true' or fail "there's no truth in the container!"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/conjurinc/docker-porcelain.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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 "docker/porcelain"
+
+# 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

data/bin/setup

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

data/docker-porcelain.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/porcelain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docker-porcelain"
+  spec.version       = Docker::Porcelain::VERSION
+  spec.authors       = ["Rafał Rzepecki"]
+  spec.email         = ["rafal@conjur.net"]
+
+  spec.summary       = %q{Porcelain for the Docker API}
+  spec.homepage      = "https://github.com/conjurinc/docker-porcelain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "docker-api", "~> 1.22"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/docker/porcelain.rb

@@ -0,0 +1,8 @@
+require "docker/porcelain/version"
+
+require 'docker/porcelain/container'
+
+module Docker
+  module Porcelain
+  end
+end

data/lib/docker/porcelain/container.rb

@@ -0,0 +1,63 @@
+require 'docker/porcelain/error'
+
+module Docker
+  module Porcelain
+    module Container
+      # Writes to a file in the container
+      # @note Executes `tee` internally, which has to be available inside the container.
+      # @param path [String] full path of the file to write
+      # @param content [String] data to be written
+      # @return [Fixnum] number of bytes written
+      def write path, content
+        stdout, stderr, code = exec ['tee', path], stdin: StringIO.new(content)
+        case code
+        when 0
+          stdout.map(&:length).inject :+
+        when 127
+          raise MisconfiguredContainerError, "error when trying to call tee: " + (stdout + stderr).join
+        else
+          raise CommandError, (stdout + stderr).join
+        end
+      end
+
+      # @overload system(command...)
+      #   Executes a command in a container
+      #   @param [String, Array<String>] command to execute.
+      #     A single string is passed to '/bin/sh -c' for execution.
+      #   @return [true, false, nil] true if the command gives zero exit status,
+      #     false for non zero exit status, nil if command execution fails.
+      #   @note The exit code is available in {.last_exitstatus}.
+      def system *args
+        env = args.shift if args.first.is_a? Hash
+        opts = args.pop if args.last.is_a? Hash
+
+        cmdline = args
+
+        raise NotImplementedError, "setting env or opts is not implemented" \
+            if [env, opts].any?
+
+        raise NotImplementedError, "overringing argv0 is not implemented" \
+            if cmdline.first.is_a? Array
+
+        if cmdline.length == 1
+          cmdline = ['/bin/sh', '-c', cmdline.first]
+        end
+
+        _stdout, _stderr, status = self.exec cmdline
+
+        # 'simulate' exit status in $?
+        @last_exitstatus = status
+
+        case status
+        when 127
+          nil
+        else
+          status == 0
+        end
+      end
+
+      # Exit status of the last command ran with {#system}
+      attr_reader :last_exitstatus
+    end
+  end
+end

data/lib/docker/porcelain/error.rb

@@ -0,0 +1,16 @@
+module Docker
+  module Porcelain
+    # Superclass of all errors from Docker::Porcelain.
+    class Error < RuntimeError
+    end
+
+    # Error caused most probably by an unexpected container configuration,
+    # eg. a missing command.
+    class MisconfiguredContainerError < Error
+    end
+
+    # Error running a command inside a container.
+    class CommandError < Error
+    end
+  end
+end

data/lib/docker/porcelain/extensions.rb

@@ -0,0 +1,11 @@
+require 'docker/porcelain'
+require 'docker/porcelain/container'
+
+require 'docker'
+
+module Docker
+  class Container
+    include Docker::Porcelain::Container
+  end
+end
+

data/lib/docker/porcelain/refinements.rb

@@ -0,0 +1,12 @@
+require 'docker/porcelain'
+require 'docker/porcelain/container'
+
+require 'docker'
+
+module Docker
+  module Porcelain
+    refine Docker::Container do
+      include Docker::Porcelain::Container
+    end
+  end
+end

data/lib/docker/porcelain/version.rb

@@ -0,0 +1,5 @@
+module Docker
+  module Porcelain
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: docker-porcelain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- rafal@conjur.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-porcelain.gemspec
+- lib/docker/porcelain.rb
+- lib/docker/porcelain/container.rb
+- lib/docker/porcelain/error.rb
+- lib/docker/porcelain/extensions.rb
+- lib/docker/porcelain/refinements.rb
+- lib/docker/porcelain/version.rb
+homepage: https://github.com/conjurinc/docker-porcelain
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Porcelain for the Docker API
+test_files: []
+has_rdoc: