dockable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd1d7cb100226591b20bbbc26e606c6b803a1d37cf63f71592343d595b031605
+  data.tar.gz: 3125f9a01324f6d95abb26973d814c21a7c9f59b7b26778c2c3d6163c79ba14e
+SHA512:
+  metadata.gz: cbac6d9368592e07a1b13a449ae82e3b352dac162e6fc78636ab3e8413072b5cf3aa06dce94eb07f2cb5482964b0acf2be6f177a37de518a107d78f11645d464
+  data.tar.gz: d1596a20fed5c85bdc9317f24590b1be27c3b2bb39d7ee8a1d8dfcf0c43690642d9860535aeb2d9fc8a484075d7bea03b83051d9da1538d7ee7377ea03e30d7d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dockable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    dockable (0.1.0)
+      aws-sdk-s3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-partitions (1.64.0)
+    aws-sdk-core (3.16.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.5.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-s3 (1.8.1)
+      aws-sdk-core (~> 3)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    diff-lcs (1.3)
+    jmespath (1.3.1)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dockable!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,80 @@
+# Dockable
+
+This is a gem that helps us with getting a common setup for our Ruby apps.
+
+Features:
+
+* Load environment variables from S3.
+* Execute commands from a Procfile.
+
+At Teachable, this gem is preinstalled on our Docker base images that have Ruby.
+
+## Usage
+
+
+Dockable is a prefix to commands just like "bundle exec" or "time".
+
+Say you have the following `Procfile`:
+
+``` yaml
+web: bundle exec puma -c config/puma.rb
+worker: bundle exec sidekiq -C config/sidekiq.yml
+release: bundle exec rake release
+```
+
+You can run puma like this:
+
+```
+$ dockable web
+```
+
+### Loading environment variables from S3
+
+If you've specified the `DOCKABLE_ENV_BUCKET_NAME` and `DOCKABLE_ENV_KEY_NAME` variables, it will try to download an environment file from that location.
+
+That environment file is a yaml file, like this:
+
+``` yaml
+RAILS_ENV: production
+DATABASE_URL: postgres://...
+SECRET_KEY_BASE: deadbeef1234...
+```
+
+The reason we do it this way is so we don't have to configure so many environment variables when booting a Docker image.
+
+The values of `DOCKABLE_ENV_BUCKET_NAME` would be something like `"teachable-secrets"` and the value of `DOCKABLE_ENV_KEY_NAME` would be `"name-of-app/production.yml"`.
+
+Make sure the bucket you store these environment variables in is private, but readable for your docker image, and uses encryption.
+
+You can use dockable as an `ENTRYPOINT` option in your Dockerfile.
+
+``` Dockerfile
+RUN gem install dockable
+ENTRYPOINT ["dockable"]
+```
+
+### Other commands
+
+If the command is not available in your Procfile, it will simply be executed.
+
+```
+$ dockable ls -alh
+```
+
+Protip: to check if environments are loaded, try running `dockable env`.
+
+### Other options
+
+If `DOCKABLE_ROOT_DIR` is set, it will change the working directory.
+
+You can change the location of the Procfile with `DOCKABLE_PROCFILE_LOCATION`
+
+## 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/iain/dockable.

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 "dockable"
+
+# 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(__FILE__)

data/bin/setup

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

data/dockable.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dockable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dockable"
+  spec.version       = Dockable::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.summary       = %q{Some helpers for launching Ruby apps inside Docker}
+  spec.description   = %q{Some helpers for launching Ruby apps inside Docker}
+  spec.homepage      = "https://teachable.com"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "aws-sdk-s3"
+end

data/exe/dockable

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "dockable"
+
+vars = Dockable.load_environment_variables(
+  bucket:  ENV["DOCKABLE_ENV_BUCKET_NAME"],
+  key:     ENV["DOCKABLE_ENV_KEY_NAME"],
+)
+
+Dir.chdir(ENV["DOCKABLE_ROOT_DIR"]) if ENV["DOCKABLE_ROOT_DIR"]
+
+cmd = Dockable.load_command(ARGV, procfile_location: ENV["DOCKABLE_PROCFILE_LOCATION"])
+
+Kernel.exec(vars, *cmd)

data/lib/dockable/version.rb

@@ -0,0 +1,3 @@
+module Dockable
+  VERSION = "0.1.0"
+end

data/lib/dockable.rb

@@ -0,0 +1,52 @@
+require "dockable/version"
+
+require "yaml"
+
+module Dockable
+
+  def self.load_environment_variables(bucket:, key:)
+    if presence(bucket) && presence(key)
+      require "aws-sdk-s3"
+      client = Aws::S3::Client.new
+      resp   = client.get_object(bucket: bucket, key: key)
+      body   = resp.body.read
+      YAML.load(body).map { |k, v| [ k.to_s, v.to_s ] }.to_h
+    else
+      STDERR.puts "Dockable warning: No bucket or key found, no environment file loaded."
+      {}
+    end
+  end
+
+  def self.load_command(argv, procfile_location: nil)
+    procfile_location = presence(procfile_location) || "Procfile"
+    if File.exist?(procfile_location) && argv.size == 1
+      commands = YAML.load_file(procfile_location)
+      if commands.has_key?(argv[0])
+        [ commands[argv[0]].to_s ]
+      else
+        argv
+      end
+    elsif argv.size == 0
+      fail ArgumentError, "No command specified"
+    else
+      argv
+    end
+  end
+
+  def self.presence(value)
+    case value
+    when nil, false then nil
+    when /\A[[:space:]]*\z/
+      nil
+    when Array, Hash
+      if value.empty?
+        nil
+      else
+        value
+      end
+    else
+      value
+    end
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: dockable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  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'
+description: Some helpers for launching Ruby apps inside Docker
+email:
+- iain@iain.nl
+executables:
+- dockable
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dockable.gemspec
+- exe/dockable
+- lib/dockable.rb
+- lib/dockable/version.rb
+homepage: https://teachable.com
+licenses: []
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Some helpers for launching Ruby apps inside Docker
+test_files: []