docker-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d71f9d1a293be214403e1c6ee48aef5bc62b2a5b
+  data.tar.gz: a929b1c0b897677f9853d700d32a71c5bfe4f539
+SHA512:
+  metadata.gz: 2d5c36b3f830f5329a103117a1aa6f60372bae559ae3dccc636a121b1e9585d10904b6e7b4a7e24264b71d1358059ca1ec1e0e65efe4a812663f4ecd2fce5d9e
+  data.tar.gz: 4e08c4de83d554ba122d3692e8aa3782d59e62763228d6e2a6dd1728397f4cc729bd9afcc3200d90c1bb1dfa26788ee8b6a4218f56409ff84cdc807d2ac5e800

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Manheim
+
+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,73 @@
+# docker-helpers
+
+[![Build Status](https://travis-ci.org/manheim/docker-helpers.svg?branch=master)](https://travis-ci.org/manheim/docker-helpers)
+
+Collection of helpers to assist in testing/developing with the docker-api gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'docker-helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docker-helpers
+
+## Usage
+
+You can use the Docker::Helpers.get_image method and the output stream will
+be initialized automatically.  Only the DEBUG ENV var is required to turn on
+the docker build output.
+
+# Example
+
+```
+  DEBUG=1 bundle exec your_thing
+```
+
+```ruby
+  #Manually setup a stream
+
+  output_stream = Docker::Helpers.output_stream
+  Docker::Image.build_from_dir('.', opts, &output_stream )
+
+  # or let .get_image set it up.
+  
+  # Try to get an image that exists.  Returns an instance of
+  # Docker::Image if found.
+
+  image = Docker::Helpers.get_image(image_id: 'asdf1234')
+
+  # No options passed will try to build a Dockerfile in the current dir.
+  image = Docker::Helpers.get_image()
+
+  # You can specifiy a build dir as well as
+  # options supported by Docker::Image.build_from_dir.
+
+  image = Docker::Helpers.get_image(build_dir: 'some_dir/')
+
+  opts = { build_dir: 'some_dir/', t: 'a_tag', nocache: 'true' }
+  image = Docker::Helpers.get_image(opts)
+
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/manheim/docker-helpers.
+
+## 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/helpers"
+
+# 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/circle.yml

@@ -0,0 +1,3 @@
+dependencies:
+  pre:
+    - gem install bundler

data/docker-helpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docker/helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docker-helpers"
+  spec.version       = Docker::Helpers::VERSION
+  spec.authors       = ["Reppard Walker", "Jonathan Niesen"]
+  spec.email         = ["reppard.walker@manheim.com"]
+
+  spec.summary       = 'Collection of helpers to supplement the docker-api gem'
+  spec.description   = 'Provides some helpers to assist in testing/developing with the docker-api gem.'
+  spec.homepage      = "https://github.com/manheim/docker-helpers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_runtime_dependency     "docker-api", "~> 1.26", ">= 1.26.0"
+end

data/lib/docker/helpers.rb

@@ -0,0 +1,35 @@
+require "docker/helpers/version"
+require "docker"
+require 'json'
+
+module Docker
+  module Helpers
+    class << self
+      def output_stream
+        lambda { |v|
+          body, should_output = should_output?(v)
+          if should_output
+            $stdout.puts body["stream"]
+          end
+        }
+      end
+
+      def get_image(opts = {})
+        if opts[:image_id]
+          Docker::Image.get(opts[:image_id])
+        else
+          build_dir = opts[:build_dir] || '.'
+          Docker::Image.build_from_dir(build_dir, opts, &output_stream)
+        end
+      end
+
+      private
+      def should_output?( string )
+        parsed = JSON.parse(string)
+        worth_showing = parsed && parsed.has_key?("stream") && ENV['DEBUG']
+
+        [parsed, worth_showing]
+      end
+    end
+  end
+end

data/lib/docker/helpers/version.rb

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

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: docker-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Reppard Walker
+- Jonathan Niesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-29 00:00:00.000000000 Z
+dependencies:
+- !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: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+description: Provides some helpers to assist in testing/developing with the docker-api
+  gem.
+email:
+- reppard.walker@manheim.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- docker-helpers.gemspec
+- lib/docker/helpers.rb
+- lib/docker/helpers/version.rb
+homepage: https://github.com/manheim/docker-helpers
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Collection of helpers to supplement the docker-api gem
+test_files: []