docker 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22875585676480f67e4a5a2f7d132b8b3849636e
-  data.tar.gz: ff1433914619dd2be968f2931a7d934911351003
+  metadata.gz: eab088e132fb6bb2bec9c3ab6d381a6ff2cd488e
+  data.tar.gz: 9e450fce4107d32904575463018de7276be29a14
 SHA512:
-  metadata.gz: 44a5792ac7eedd48522d0723fb9e3100d7bcdb1e88c7aa4c2dc070c3ac3fb963311ef25e44770b8851d40d8076f987c3f3b662c918d5a2e26fe4bf35d2ce0481
-  data.tar.gz: 08caac7bab4d76cb59b270a81bfbe39c12202153b827afd4af1911518279dae03bd2aa36a66025cf1502caed620ca99a7edef5c76a76b1be046ee015404ea4e0
+  metadata.gz: 31799d1342835cbaf275cd92ff4cb43b986e79f41038b2f4ce2ec85871ecded5c4246aa262005abdb079a14efdec721d54af252195cdc8e745577f96da2978e0
+  data.tar.gz: feb853dbbef941bd06d46e6f71b1e00ee63886994c5e68a6b3175c30479404ce1c74ff1036e51a177314688be47b3ca9b56c201fd6a8499757dc6d306f5f05c0

data/.gitignore

@@ -9,3 +9,58 @@
 /tmp/
 /.idea
 
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+# Ignore Byebug/Bash/etc command history file.
+/.*_hist*
+
+# Ignore mac .DS_Store files
+.DS_Store
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/dev.Dockerfile

@@ -0,0 +1,30 @@
+# 1: Use ruby 2.3.3 as base:
+FROM ruby:2.3.3
+
+# 2: We'll set this gem path as the working directory
+WORKDIR /usr/src/lib
+
+# 3: We'll set the working dir as HOME and add the app's binaries path to $PATH:
+ENV HOME=/usr/src/lib PATH=/usr/src/lib/bin:$PATH
+
+# 4: Install docker - we'll need the client to run docker commands on the host engine, by mounting
+# the host docker service's socket.
+# Ripped off from https://hub.docker.com/_/docker Dockerfiles:
+RUN set -ex && \
+    export DOCKER_BUCKET=get.docker.com && \
+    export DOCKER_VERSION=17.03.1-ce && \
+    export DOCKER_SHA256=820d13b5699b5df63f7032c8517a5f118a44e2be548dd03271a86656a544af55 && \
+    curl -fSL "https://${DOCKER_BUCKET}/builds/Linux/x86_64/docker-${DOCKER_VERSION}.tgz" -o docker.tgz && \
+    echo "${DOCKER_SHA256} *docker.tgz" | sha256sum -c - && \
+    tar -xzvf docker.tgz && \
+    mv docker/* /usr/local/bin/ && \
+    rmdir docker && \
+    rm docker.tgz
+
+# 5: Install required gems:
+ADD Gemfile docker.gemspec /usr/src/lib/
+ADD lib/docker/version.rb /usr/src/lib/lib/docker/
+RUN gem install guard && bundle install
+
+# 6: Set the default command:
+CMD ["guard"]

data/docker-compose.yml

@@ -0,0 +1,26 @@
+version: '2.1'
+
+services:
+
+  lib:
+    image: xeger/docker-gem:development
+    build:
+      context: .
+      dockerfile: dev.Dockerfile
+
+    volumes:
+      # Mount our app code directory (".") into our app containers at the `/usr/src/lib` folder:
+      - .:/usr/src/lib
+
+      # Add the docker socket to enable docker in docker:
+      - /var/run/docker.sock:/var/run/docker.sock
+
+    # Keep the stdin open, so we can attach to our app container's process
+    # and do things such as byebug, etc:
+    stdin_open: true
+
+    # Enable sending signals (CTRL+C, CTRL+P + CTRL+Q) into the container:
+    tty: true
+
+    # The command:
+    command: guard

data/docker.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/xeger/docker"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|dev\.Dockerfile|docker-compose.yml)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "backticks", "~> 0.3"
+  spec.add_dependency "backticks", "~> 1.0.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/docker.rb

@@ -2,6 +2,7 @@ require_relative 'docker/version'
 require_relative 'docker/error'
 require_relative 'docker/asset'
 require_relative 'docker/container'
+require_relative 'docker/cli'
 require_relative 'docker/session'
 
 module Docker

data/lib/docker/cli.rb

@@ -0,0 +1,62 @@
+module Docker
+  # Docker command-line parameter generator.
+  # This is a modified version of Backticks::CLI::Getopt, made specially for converting ruby objects
+  # into Docker CLI opts.
+  module CLI
+    # Translate a series Ruby positional and keyword arguments into Docker command-
+    # parameters consisting of words and options.
+    #
+    # Each positional argument can be a Hash, an Array, or another object.
+    # They are handled as follows:
+    #  - Hash is translated to a sequence of options; see #options
+    #  - Array is appended to the command line as a sequence of words
+    #  - other objects are turned into a string with #to_s and appended to the command line as a
+    #    single word
+    #
+    # @return [Array] list of String words and options
+    #
+    # @example recursively find all text files
+    #   parameters('docker', 'run', 'hello_world')
+    #
+    # @example run & remove docker hello world
+    #   parameters('docker', 'run', rm: true, 'hello_world')
+    module Getopt
+      def self.parameters(*sugar)
+        sugar.each_with_object [] do |item, argv|
+          argv.concat extract_parameter(item)
+        end
+      end
+
+      def self.extract_parameter(item)
+        return item.map(&:to_s) if item.is_a? Array
+        return options(item) if item.is_a? Hash
+        [item.to_s]
+      end
+
+      def self.options(kwargs = {})
+        # Transform opts into golang flags-style command line parameters;
+        # append them to the command.
+        kwargs.map { |kw, arg| convert_option kw, arg }.compact.flatten
+      end
+
+      def self.convert_option(option_name, option_value)
+        flag = (option_name.length == 1) ? "-#{option_name}" : "--#{option_name}"
+        return [flag] if option_value == true
+        return process_list_option flag, option_value if option_value.is_a? Array
+        return process_non_null_option flag, option_value if option_value
+      end
+
+      def self.process_list_option(flag, option_value)
+        option_value.map do |value_item|
+          process_non_null_option flag, value_item if value_item
+        end.compact.flatten
+      end
+
+      def self.process_non_null_option(flag, option_value)
+        is_long_flag = flag[0..1] == '--'
+        return "#{flag}=#{option_value}" if is_long_flag
+        [flag, option_value.to_s]
+      end
+    end
+  end
+end

data/lib/docker/session.rb

@@ -23,7 +23,7 @@ module Docker
     # Hint that we are able to parse ps output
     PS_HEADER = /ID\s+IMAGE\s+COMMAND\s+CREATED\s+STATUS\s+PORTS\s+NAMES$/
 
-    def initialize(shell=Backticks::Runner.new, host:ENV['DOCKER_HOST'])
+    def initialize(shell=Backticks::Runner.new(cli: Docker::CLI::Getopt), host:ENV['DOCKER_HOST'])
       @host = host
       @shell = shell
     end
@@ -71,6 +71,19 @@ module Docker
     # @example open a busybox shell
     #   session.run('busybox', '/bin/sh', tty:true, interactive:true)
     #
+    # @example open busybox and remove vowels from user input
+    #   session.run('busybox', '/bin/sh', tty:true, interactive:true) do |stream, data|
+    #     if [:stdout, :stderr].include?(stream)
+    #       puts data
+    #     else
+    #       data.gsub(/[aeiouy]/, '')
+    #     end
+    #   end
+    #
+    # @yield [stream, data] intercepts container I/O and passes it to the block
+    # @yieldparam [Symbol] stream :stdin, :stdout or :stderr
+    # @yieldparam [String] data the intercepted stream activity
+    #
     # @param [String] image id or name of base image to use for container
     # @param [Array] command_and_args optional command to run in container
     # @param [Integer] cpu_period scheduler period (μs)
@@ -113,7 +126,7 @@ module Docker
             tty:false,
             user:nil,
             volume:[],
-            volumes_from:nil)
+            volumes_from:nil, &block)
 
       cmd = []
 
@@ -137,7 +150,7 @@ module Docker
       cmd.concat(command_and_args)
 
       # return the output of `docker run` minus extra whitespace
-      run!('run', *cmd).strip
+      run!('run', *cmd, &block).strip
     end
 
     # Remove a container.
@@ -195,13 +208,20 @@ module Docker
     # Run a docker command without validating that the CLI parameters
     # make sense. Prepend implicit options if suitable.
     #
+    # @yield [stream, data] intercepts command I/O and passes it to the block
+    # @yieldparam [Symbol] stream :stdin, :stdout or :stderr
+    # @yieldparam [String] data the intercepted stream activity
+    #
     # @param [Array] args command-line arguments in the format accepted by
     #   Backticks::Runner#command
     # @return [String] output of the command
     # @raise [RuntimeError] if command fails
-    def run!(*args)
+    def run!(*args, &block)
       # STDERR.puts "+ " + (['docker'] + args).inspect
-      cmd = @shell.run('docker', *args).join
+      cmd = @shell.run('docker', *args)
+      cmd.tap(&block) if block_given?
+      cmd.join
+
       status, out, err = cmd.status, cmd.captured_output, cmd.captured_error
       status.success? || raise(Error.new(args.first, status, err))
       out

data/lib/docker/version.rb

@@ -1,3 +1,3 @@
 module Docker
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Tony Spataro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-21 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backticks
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -85,9 +85,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- dev.Dockerfile
+- docker-compose.yml
 - docker.gemspec
 - lib/docker.rb
 - lib/docker/asset.rb
+- lib/docker/cli.rb
 - lib/docker/container.rb
 - lib/docker/error.rb
 - lib/docker/session.rb