mascherano 1.0.0 → 1.0.2

data/README.md

@@ -2,25 +2,70 @@
 
 # Mascherano
 
-TODO: Write a gem description
+Capistrano 3.x recipes
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mascherano'
+```ruby
+gem 'mascherano'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mascherano
+```bash
+$ gem install mascherano
+```
 
+## Recipes
+
+Mascherano currently have several recipes:
+
+| recipe         | description                                                                                           |
+|----------------|-------------------------------------------------------------------------------------------------------|
+| __env__        | Manage application configuration on `.env` file                                                       |
+| __foreman__    | Manage Procfile application for [Foreman](http://ddollar.github.io/foreman)                           |
+| __figaro__     | Manage configuration, usually `application.yml` for [Figaro](https://github.com/laserlemon/figaro)    |
+| __go__         | Manage and ability to deploy go application                                                           |
+| __upstart__    | Manage application management using Upstart                                                           |
+| __token__      | Manage and generate random secret token                                                               |
+| __passenger__  | Manage Pushion Passenger based application                                                            |
+| _more to come_ | _pull request are welcome ;)_                                                                         |
+
+This package also provides a `noscm` recipe for when you don't need source code on your deployment box (usually application already compiled).
+
+```ruby
+# deploy.rb
+set :application, 'mascherano'
+set :scm, :noscm
+```
 ## Usage
 
-TODO: Write usage instructions here
+Make sure you have `Capfile` in the root of your project, so you can add these lines (choose which one you're using):
+
+```ruby
+require 'mascherano/env'
+require 'mascherano/figaro'
+require 'mascherano/foreman'
+require 'mascherano/go'
+require 'mascherano/upstart'
+```
+
+Then on `config/deploy/{env}.rb` you can customize the options:
+
+```ruby
+set :env_file, '.staging.env'
+set :foreman_procfile, -> { release_path.join('procfiles', 'staging') }
+```
+
+See the `lib/mascherano/task/*.cap` for more options.
 
 ## Contributing
 

data/lib/capistrano/noscm.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/noscm.cap', __FILE__)

data/lib/capistrano/tasks/noscm.cap

@@ -0,0 +1,8 @@
+namespace :noscm do
+  task :check do; end
+  task :create_release do
+    on roles(:all) do
+      execute :mkdir, '-p', release_path
+    end
+  end
+end

data/lib/mascherano/go.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/go.cap', __FILE__)

data/lib/mascherano/passenger.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/passenger.cap', __FILE__)

data/lib/mascherano/tasks/env.cap

@@ -5,11 +5,12 @@ namespace :env do
     You can override any of these defaults by setting the variables shown below.
 
     set :env_file, ".env"
+    set :env_roles, :all
     set :target_file, -> { shared_path.join('.env') }
   DESC
   task :upload do
-    on roles(:app) do
-      upload! fetch(:env_file), fetch(:env_target), via: :scp
+    on roles(fetch(:env_roles)) do
+      upload! fetch(:env_file), fetch(:env_target)
     end
   end
 
@@ -17,8 +18,8 @@ namespace :env do
     Symlink the .env file to the release_path
   DESC
   task :symlink do
-    on roles(:app) do
-      execute :ln, "-sf #{fetch(:env_target)} #{release_path.join('.env')}"
+    on roles(fetch(:env_roles)) do
+      execute :ln, '-sf', fetch(:env_target), release_path.join('.env')
     end
   end
 end
@@ -26,6 +27,7 @@ end
 namespace :load do
   task :defaults do
     set :env_file, ".env"
+    set :env_roles, :all
     set :env_target, -> { shared_path.join('.env') }
   end
 end

data/lib/mascherano/tasks/figaro.cap

@@ -1,3 +1,5 @@
+require 'stringio'
+
 namespace :figaro do
   desc <<-DESC
     Upload application config to the server
@@ -9,24 +11,24 @@ namespace :figaro do
     set :figaro_to_env, false
   DESC
   task :upload do
-    on roles(:app) do
+    figaro_data = nil
+
+    run_locally do
       figaro_stage = fetch(:stage)
       figaro_tmp   = "figaro-#{figaro_stage}"
 
-      run_locally do
-        if fetch(:figaro_to_env)
-          figaro_cmd = %Q(Figaro.vars("#{figaro_stage}").split)
-        else
-          figaro_cmd = %Q(Figaro.env("#{figaro_stage}").to_yaml)
-        end
-
-        execute :bundle, "exec rails runner 'puts #{figaro_cmd}' > #{figaro_tmp}"
+      if fetch(:figaro_to_env)
+        figaro_cmd = %Q(Figaro.vars("#{figaro_stage}").split)
+      else
+        figaro_cmd = %Q(Figaro.env("#{figaro_stage}").to_yaml)
       end
 
-      upload! figaro_tmp, fetch(:figaro_target), via: :scp
+      figaro_data = execute(:rails, "runner 'puts #{figaro_cmd}'").stdout
+    end
 
-      run_locally do
-        execute :rm, figaro_tmp
+    if figaro_data
+      on roles(fetch(:figaro_roles)) do
+        upload! StringIO.new(figaro_data), fetch(:figaro_target)
       end
     end
   end
@@ -35,8 +37,8 @@ namespace :figaro do
     Symlink the application config to the release_path
   DESC
   task :symlink do
-    on roles(:app) do
-      execute :ln, "-sf #{fetch(:figaro_target)} #{fetch(:figaro_config)}"
+    on roles(fetch(:figaro_roles)) do
+      execute :ln, '-sf', fetch(:figaro_target), fetch(:figaro_config)
     end
   end
 end
@@ -46,6 +48,7 @@ namespace :load do
     set :figaro_target, -> { shared_path.join('application.yml') }
     set :figaro_config, -> { release_path.join('config', 'application.yml') }
     set :figaro_to_env, false
+    set :figaro_roles, :app
   end
 end
 

data/lib/mascherano/tasks/foreman.cap

@@ -12,12 +12,14 @@ namespace :foreman do
     set :foreman_app,         -> { fetch(:application) }
     set :foreman_user,        -> { fetch(:user) }
     set :foreman_log,         -> { shared_path.join('log') }
+    set :foreman_pids,        -> { shared_path.join('pids') }
     set :foreman_concurrency, false
     set :foreman_sudo,        false
+    set :foreman_roles,       :all
   DESC
 
   task :export do
-    on roles(:all) do
+    on roles(fetch(:foreman_roles)) do
       within release_path do
         concurrency = fetch(:foreman_concurrency)
         sudo        = fetch(:foreman_sudo)
@@ -29,6 +31,7 @@ namespace :foreman do
         args << %Q(-a #{fetch(:foreman_app)})
         args << %Q(-u #{fetch(:foreman_user)})
         args << %Q(-l #{fetch(:foreman_log)})
+        args << %Q(-r #{fetch(:foreman_pids)})
         args << %Q(-c #{concurrency}) if concurrency
 
         cmd = "foreman export #{args.join(' ')}"
@@ -53,8 +56,10 @@ namespace :load do
     set :foreman_app,         -> { fetch(:application) }
     set :foreman_user,        -> { fetch(:user) }
     set :foreman_log,         -> { shared_path.join('log') }
+    set :foreman_pids,        -> { shared_path.join('pids') }
     set :foreman_concurrency, false
     set :foreman_sudo,        false
+    set :foreman_roles,       :all
   end
 end
 

data/lib/mascherano/tasks/go.cap

@@ -0,0 +1,46 @@
+namespace :go do
+  desc <<-DESC
+    Compile the go application locally
+
+    You can override any of these defaults by setting the variables shown below.
+
+    set :go_input,  'api.go'
+    set :go_output, 'api'
+    set :go_os,     'linux'
+    set :go_arch,   'amd64'
+    set :go_roles,  :app
+    set :go_target, -> { release_path.join(fetch(:go_output)) }
+  DESC
+  task :build do
+    on roles(fetch(:go_roles)) do
+      run_locally do
+        go_flags = {
+          'GOOS'   => fetch(:go_os),
+          'GOARCH' => fetch(:go_arch)
+        }
+
+        with(go_flags) do
+          execute :go, 'build', '-o', fetch(:go_output), fetch(:go_input)
+        end
+      end
+    end
+  end
+
+  desc 'Upload compiled application to the server'
+  task :upload do
+    on roles(fetch(:go_roles)) do
+      upload! fetch(:go_output), fetch(:go_target)
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :go_input,  'api.go'
+    set :go_output, 'api'
+    set :go_os,     'linux'
+    set :go_arch,   'amd64'
+    set :go_roles,  :app
+    set :go_target, -> { release_path.join(fetch(:go_output)) }
+  end
+end

data/lib/mascherano/tasks/passenger.cap

@@ -0,0 +1,42 @@
+namespace :passenger do
+  desc 'Start passenger'
+  task :start do
+    on roles(fetch(:passenger_roles)) do
+      within current_path do
+        execute fetch(:passenger_cmd), 'start', '-e', fetch(:passenger_env), '-p', fetch(:passenger_port), '-d'
+      end
+    end
+  end
+
+  desc 'Stop passenger'
+  task :stop do
+    on roles(fetch(:passenger_roles)) do
+      within current_path do
+        execute fetch(:passenger_cmd), 'stop', '-p', fetch(:passenger_port)
+      end
+    end
+  end
+
+  desc 'Restart passenger'
+  task :restart do
+    on roles(fetch(:passenger_roles)) do
+      within current_path do
+        if test " [ -f tmp/pids/passenger.#{fetch(:passenger_port)}.pid ] "
+          invoke 'passenger:stop'
+        end
+
+        invoke 'passenger:start'
+      end
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :passenger_cmd,   'bundle exec passenger'
+    set :passenger_env,   -> { fetch(:stage) }
+    set :passenger_port,  9292
+    set :passenger_roles, :app
+  end
+end
+

data/lib/mascherano/tasks/token.cap

@@ -0,0 +1,33 @@
+require 'securerandom'
+require 'stringio'
+
+def generate_token(n)
+  SecureRandom.hex(n)
+end
+
+namespace :token do
+  desc 'Generate random token'
+  task :generate do
+    on roles(fetch(:token_roles)) do
+      info generate_token(fetch(:token_length))
+    end
+  end
+
+  desc 'Upload random token as a file on remote server'
+  task :upload do
+    on roles(fetch(:token_roles)) do
+      token = generate_token(fetch(:token_length))
+      io    = StringIO.new(token)
+      upload! io, fetch(:token_target)
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    set :token_length, 64
+    set :token_target, -> { shared_path.join('.token') }
+    set :token_roles, :app
+  end
+end
+

data/lib/mascherano/tasks/upstart.cap

@@ -1,29 +1,30 @@
-def cmd(service_name, action, sudo = false)
-  sudo_cmd = sudo ? 'sudo ' : ''
-  "#{sudo_cmd} service #{service_name} #{action}"
+def build_cmd(service_name, action, sudo = false)
+  cmd = "service #{service_name} #{action}"
+  cmd = "sudo " + cmd if sudo
+  cmd
 end
 
 namespace :upstart do
   desc "Start the application services"
   task :start do
-    on roles(:app) do
-      execute cmd(fetch(:upstart_service), 'start', fetch(:upstart_sudo))
+    on roles(fetch(:upstart_roles)) do
+      execute build_cmd(fetch(:upstart_service), 'start', fetch(:upstart_sudo))
     end
   end
 
   desc "Stop the application services"
   task :stop do
-    on roles(:app) do
-      execute cmd(fetch(:upstart_service), 'stop', fetch(:upstart_sudo))
+    on roles(fetch(:upstart_roles)) do
+      execute build_cmd(fetch(:upstart_service), 'stop', fetch(:upstart_sudo))
     end
   end
 
   desc "Restart the application services"
   task :restart do
-    on roles(:app) do
-      cmd_sq  = cmd(fetch(:upstart_service), 'start', fetch(:upstart_sudo))
+    on roles(fetch(:upstart_roles)) do
+      cmd_sq  = build_cmd(fetch(:upstart_service), 'start', fetch(:upstart_sudo))
       cmd_sq += ' || '
-      cmd_sq += cmd(fetch(:upstart_service), 'restart', fetch(:upstart_sudo))
+      cmd_sq += build_cmd(fetch(:upstart_service), 'restart', fetch(:upstart_sudo))
 
       execute cmd_sq
     end
@@ -34,6 +35,7 @@ namespace :load do
   task :defaults do
     set :upstart_service, -> { fetch(:application) }
     set :upstart_sudo, false
+    set :upstart_roles, :app
   end
 end
 

data/lib/mascherano/token.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/token.cap', __FILE__)

data/lib/mascherano/version.rb

@@ -1,3 +1,3 @@
 module Mascherano
-  VERSION = "1.0.0"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mascherano
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -72,14 +72,22 @@ files:
 - README.md
 - Rakefile
 - img/mascherano-logo.png
+- lib/capistrano/noscm.rb
+- lib/capistrano/tasks/noscm.cap
 - lib/mascherano.rb
 - lib/mascherano/env.rb
 - lib/mascherano/figaro.rb
 - lib/mascherano/foreman.rb
+- lib/mascherano/go.rb
+- lib/mascherano/passenger.rb
 - lib/mascherano/tasks/env.cap
 - lib/mascherano/tasks/figaro.cap
 - lib/mascherano/tasks/foreman.cap
+- lib/mascherano/tasks/go.cap
+- lib/mascherano/tasks/passenger.cap
+- lib/mascherano/tasks/token.cap
 - lib/mascherano/tasks/upstart.cap
+- lib/mascherano/token.rb
 - lib/mascherano/upstart.rb
 - lib/mascherano/version.rb
 - mascherano.gemspec
@@ -96,12 +104,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3389475692804839278
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3389475692804839278
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -109,4 +123,3 @@ signing_key:
 specification_version: 3
 summary: Capistrano 3.x recipes
 test_files: []
-has_rdoc: