izanami 0.14.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2RlYTk4ZDQ1ZDZiMmNlM2NiNjY0YTBjZGRiZGQ2NDZlZDg2MjNjYQ==
+  data.tar.gz: !binary |-
+    NjI4ZDI0ZDZmOTdiNzY2NzM0ZDNjYTVmMDM3NzdhZmVmNTAwZmYyMg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmQxMTM3ZWE3NDRlMWM3YzY5MjQ5YWRmNGQ3YzMyMjIzZjcyMDgzY2I1MDk0
+    ODY3M2I5NGEyMDc2NWVjNmZjYTVmMTMxNzI3ZWNhZjkxMGY4NGE1NDRiMTUz
+    OTI4ZTZmOWZjZjY2MTBjMzJjYzZmODhjMWVmY2YxMTI5NjdjMWI=
+  data.tar.gz: !binary |-
+    NmZhODcxYWIzYmI2YzU5YjU1YTU3ZWM5NDc3YjY1NDk5ZWNhNTU4YjhkNmZk
+    MDU2YjVlODAxNzM4NTBlOTcxMGVkZDZmYjkxYzk4NjFlYTQwZDJiYmUyOWEz
+    NWE4OTEyNWFhZDIzZjI1YzQwMTkzOTY1MjQ1MDMwZjU4ZDJmNGM=

data/.env.development

@@ -0,0 +1,6 @@
+RACK_ENV=development
+IZANAMI_USER=izanami
+IZANAMI_PASSWORD=izanami
+IZANAMI_RESIS_URL=redis://127.0.0.1:6379/0
+IZANAMI_SANDBOX=/Users/jhbabon/Code/projects/wuakitv/src/deploys
+IZANAMI_WATCHDOG_SLEEP_TIME=5

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+spec/sandbox/vendor/bundle
+.env
+Procfile
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec',     '~> 2.14'
+  gem 'rack-test', '~> 0.6'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Juan Hernández
+
+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,133 @@
+# Izanami
+
+Opitionated web app to handle capistrano recipes.
+
+## Rationale
+
+Izanami is a Sinatra app that tries to execute `capistrano` commands as a normal user.
+When a set of tasks is sent, Izanami forks a new process that executes that tasks as a UNIX command, and streams the output (via redis's `pub/sub` system) to the web app.
+The commands are stored in redis, with the sent tasks, an unique ID, the output of the command and the process status (pending, success or fail).
+All the redis keys are prefixed with a namespace called `izanami`.
+
+Izanami can work with any kind of `capistrano` projects. To do so, it assumes that the `capistrano` recipes are in a separated directory.
+This directory is the *sandbox* and it MUST be a ruby project handled by bundler. Every `capistrano` command will be executed as:
+
+    $ pwd
+    /path/to/sandbox
+    $ bundle exec cap [tasks]
+
+It's the admin reponsibility to set up that directory and to have all the bundler dependencies installed.
+
+Other thing to be aware of is that Izanami doesn't handle interactive `capistrano` tasks. It cannot send inputs to a running command. That means
+that the `capistrano` commands need to be non interactive.
+
+Izanami tries to be a simple interface over `capistrano`, not a complete replacement for the shell.
+It can help to handle basic tasks in a healthy system, but nothing beats the terminal when you need to solve more serious problems.
+
+## Showcase
+
+You can see a small [demo of the app here](http://cl.ly/Qt3c).
+
+## Dependencies
+
+Izanami stores all the data about the commands executed inside redis. All the keys expire after a week.
+It also uses the redis' `pub/sub` feature to show the output of a running command.
+
+## Installation
+
+You can install it by using the following command:
+
+    $ gem install izanami
+
+Or build the gem:
+
+    $ gem build izanami.gemspec
+    $ gem install izanami-x.y.x.gem
+
+## Usage
+
+### Configuration
+
+Izanami configuration is handled via environment variables:
+
+* `RACK_ENV`: App environment (e.g: `development`, `production`, `test`. Defaults to `development`).
+* `IZANAMI_PORT`: Web app port (defaults to `4567`).
+* `IZANAMI_USER`: User for the HTTP Basic Authentication (e.g: `izanami`).
+* `IZANAMI_PASSWORD`: Password for the HTTP Basic Authentication (e.g: `$3cr3t`).
+* `IZANAMI_RESIS_URL`: Redis configuration in URL format (defaults to `redis://127.0.0.1:6379/0`).
+* `IZANAMI_SANDBOX`: Path to the directory with the capistrano recipes.
+* `IZANAMI_WATCHDOG_SLEEP_TIME`: The time the watchdog sleeps before update the sandbox git repository (default to 300 seconds).
+
+### Running the web app
+
+Izanami runs with `thin` by default. You can start the app with:
+
+    $ IZANAMI_USER=izanami IZANAMI_PASSWORD=izanami IZANAMI_SANDBOX=/path/to/recipes izanami app
+
+But Izanami is a simple Sinatra app, so you can run it with any ruby server that handles a `config.ru` file:
+
+```ruby
+# simple config.ru file
+require 'rack'
+require 'izanami/app'
+
+run Izanami::App
+```
+
+The app uses the Sinatra `stream` feature, so you will need a server that can handle it, as `thin` does.
+
+### The sandbox watchdog
+
+The sandbox directory is a git repository, Izanami comes with a simple script that watches this repo and updates it (`git pull`) every 300 seconds (or any defined time period).
+This way, you can always have the latest version of the recipes.
+
+To run the watchdog, simply start the watchdog:
+
+    $ IZANAMI_SANDBOX=/path/to/recipes izanami watchdog
+
+The watchdog outputs to the standard output the result of executing `git pull` and the status of the command.
+
+### Tip: Using foreman
+
+To handle the configuration of the app, it can be a good idea to use [foreman](https://github.com/ddollar/foreman).
+
+This is an example for an `.env` file:
+
+    RACK_ENV=production
+    IZANAMI_PORT=8899
+    IZANAMI_USER=izanami
+    IZANAMI_PASSWORD=supersecretpass
+    IZANAMI_RESIS_URL=redis://redis.provider.com:6379/0
+    IZANAMI_SANDBOX=/var/recipes/
+    IZANAMI_WATCHDOG_SLEEP_TIME=600
+
+And this can be a `Procfile`:
+
+    app: izanami app
+    watchdog: izanami watchdog
+
+Also, `foreman` can be exported to `init.d` scripts an so on. Check the `foreman` documentation for more info.
+
+## Specs
+
+To run the specs, it is necessary to prepare the dummy sandbox directory after the first clone of the repository.
+
+There is a `rake` task to do it:
+
+    $ bundle exec rake spec:prepare
+
+After this, you can run the specs:
+
+    $ bundle exec rake spec
+
+## About the name
+
+*Izanami* is the name of the japanese goddess of both creation and death. Find out more about this at [wikipedia](http://en.wikipedia.org/wiki/Izanami).
+
+## Contributing
+
+1. Fork it
+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,34 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'open3'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+namespace :spec do
+  desc 'prepare the spec environment, initializing the sandbox dir'
+  task :prepare do
+    $stdout.puts '===> Initializing `spec/sandbox` directory with bundler'
+
+    # remove bundler env vars for the Open3 process.
+    bundler_keys = ENV.select { |var, _| var.to_s.match(/\ABUNDLE/) }.keys
+    env = bundler_keys.reduce({}) do |hash, (k,_)|
+      hash[k] = nil
+      hash
+    end
+
+    options = { chdir: 'spec/sandbox'}
+    Open3.popen2e(env, 'bundle install', options) do |stdin, stdout, thread|
+      while line = stdout.gets
+        $stdout.puts line.chomp
+      end
+
+      stdin.close
+      stdout.close
+    end
+  end
+end
+task spec: [:test]
+
+task default: [:test]

data/assets/css/app.css

@@ -0,0 +1 @@
+body { padding-top: 70px; }