halfday 0.0.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a22890d56d8fd9f4b8f92205cb1447116fb813cf
+  data.tar.gz: 3f4527bbbbd562668e1382450524767d295c07f2
+SHA512:
+  metadata.gz: 3049df5e6923dbab805760d2ce9fa52b6cf3c6b11442b2027f02592b5103f9ccda84ed7d349a03468f9685c5c9f4a00bfeb2cfae890c37a929334f2b37df25f7
+  data.tar.gz: 0e5e9ff7c4d10ce511c7b83814baff29423d38a3ef58953a80f403d6477f1c39a538abc90b461bff0ee0ff5fb296440fdcaa040654878d72284bbb26487ff263

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,8 @@
+Copyright (c) 2013, Mirego All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+Neither the name of the Mirego nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,29 +1,115 @@
 # Halfday
 
-TODO: Write a gem description
+This gem adds some recipes for Capistrano.
+
+*__Warning:__ It is not recommended to use this gem as is since you need your server to be configured in a very specific way. Extract what you need or fork it to make it compliant with your setup.*
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your applicationns `Gemfile`:
+
+```ruby
+gem 'halfday', require: false
+```
 
-    gem 'halfday'
+## Usage
 
-And then execute:
+Add those lines to your application’s `Capfile`:
 
-    $ bundle
+```ruby
+set :application, 'YOUR APPLICATION NAME'
+set :repository, 'YOUR GIT REPOSITORY'
 
-Or install it yourself as:
+require 'halfday'
+```
 
-    $ gem install halfday
+### Defining your environments
 
-## Usage
+You still need to define every environments in `config/deploy/`.
+
+```ruby
+# config/deploy/staging.rb
+
+role :app, 'HOSTNAME', primary: true
+role :web, 'HOSTNAME', primary: true
+role :db,  'HOSTNAME', primary: true
+
+set :default_tag, '0.2.4' # Branch or Tag
+```
+
+## Available recipes
+
+For now, all those recipes will be used on deployment if their Gem is included in your `Gemfile`.
+
+### Branch deployment
+
+On deployment, you’ll be ask to specify the `branch` or `tag` you want to deploy. If you hit `Enter`, the `default_tag` will be used. You can also enter `HEAD` to use the branch you’re currently on.
+
+```bash
+$ cap staging deploy
+
+  * 2013-06-20 14:02:53 executing `staging'
+  * 2013-06-20 14:02:53 executing `deploy'
+  * 2013-06-20 14:02:53 executing `deploy:update'
+ ** transaction: start
+  * 2013-06-20 14:02:53 executing `deploy:update_code'
+
+Tag or branch to deploy: [0.2.4]
+```
+
+### Dotenv
+
+[Dotenv](https://github.com/bkeepers/dotenv) is included as well in those recipes, if included in your project, it will automatically *symlink* `/opt/app/shared/.env` into `/opt/app/current` on deployment.
+
+### Foreman
+
+```bash
+cap foreman:restart      # Restart your app
+cap foreman:start        # Start your app
+cap foreman:stop         # Stop your app
+cap foreman:export       # Export upstart script to /etc/init/
+```
+
+### Git
+
+```bash
+cap git:clean            # Remove .git
+cap git:init_submodules  # Initialize Git submodule
+```
+
+### RVM
+
+If you’re using [RVM](https://rvm.io/) on your server, it’ll automatically use the Ruby version written in your `.ruby-version` file.
+
+### Whenever
+
+If your project includes [Whenever](https://github.com/javan/whenever), the crontab will be updated automatically in a callback.
+
+### Yard
+
+```bash
+cap yard:generate        # Generate your doc and make it available
+                         # in http://.../doc
+```
+
+## Todo
+
+* ~~Add a more flexible way to manage which recipes should be applied.~~
+* Add Rails generator for the Capfile.
+* Remove dependancy from Rails.
+* More recipes, always.
+
+## License
 
-TODO: Write usage instructions here
+`Halfday` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/active_model_serializers_validator/blob/master/LICENSE.md) file.
 
-## Contributing
+## About Mirego
 
-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
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun.
+We proudly built mobile applications for
+[iPhone](http://mirego.com/en/iphone-app-development/ "iPhone application development"),
+[iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"),
+[Android](http://mirego.com/en/android-app-development/ "Android application development"),
+[Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"),
+[Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and
+[Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development").

data/halfday.gemspec

@@ -6,12 +6,12 @@ require 'halfday/version'
 Gem::Specification.new do |spec|
   spec.name          = "halfday"
   spec.version       = Halfday::VERSION
-  spec.authors       = ["Rémi Prévost"]
-  spec.email         = ["remi@exomel.com"]
-  spec.description   = ""
-  spec.summary       = ""
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ["Samuel Garneau"]
+  spec.email         = ["sgarneau@mirego.com"]
+  spec.description   = %q{Collection of Capistrano recipes - Deploy. Then, take a halfday.}
+  spec.summary       = %q{Collection of Capistrano recipes - Deploy. Then, take a halfday.}
+  spec.homepage      = "https://github.com/mirego/halfday"
+  spec.license       = 'BSD 3-Clause'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,4 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+
+  spec.add_dependency "capistrano"
+  spec.add_dependency "capistrano-ext"
+
+  spec.add_dependency "foreman"
 end

data/lib/halfday/capistrano.rb

@@ -0,0 +1,57 @@
+require 'halfday/helpers/cset'
+require 'halfday/helpers/require_recipe'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  # Stages
+  # Load 3rd party recipes
+  require_recipe "bundler/capistrano"
+  require_recipe 'dotenv/capistrano'
+
+  require 'capistrano/ext/multistage'
+
+  load 'deploy' if respond_to?(:namespace)
+  load 'deploy/assets'
+
+  # Load recipes
+  _cset :ignored_recipes, []
+
+  [:foreman, :git, :yard, :whenever, :rvm, :setup, :nginx].each do |mod|
+    require "halfday/#{mod}/capistrano" unless ignored_recipes.include?(mod)
+  end
+
+  # Callbacks
+  after 'deploy',             'deploy:cleanup'
+  after 'deploy:update_code', 'deploy:migrate'
+
+  # Bundler
+  set :bundle_without, [:test]
+  _cset :bundle_cmd,   "bundle"
+
+  # Deploy
+  _cset :deploy_to,      "/opt/#{application}"
+
+  set :scm,            :git
+  set :keep_releases,  3
+  set :ssh_options,    { forward_agent: true }
+
+  # User
+  set :use_sudo,       false
+  set :user,           :ubuntu
+
+  # Environment
+  #
+  # On all our remote server, the environment
+  # should be staging.
+  set :rails_env,      Proc.new { 'staging' }
+  set :migrate_env,    Proc.new { "RAILS_ENV=#{rails_env}" }
+
+  # Branch
+  set :branch do
+    tag = Capistrano::CLI.ui.ask "Tag or branch to deploy: [#{default_tag}] "
+    tag = `git symbolic-ref -q HEAD | sed -e 's|^refs/heads/||'`.chomp if tag == 'HEAD'
+
+    (tag.empty?) ? default_tag : tag
+  end
+
+  default_run_options[:pty] = true
+end

data/lib/halfday/foreman/capistrano.rb

@@ -0,0 +1,42 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  after 'deploy', 'foreman:export'
+  after 'deploy', 'foreman:restart'
+
+  namespace :foreman do
+
+    desc "Export upstart script"
+    task :export, roles: :app do
+      # Uploading process template
+      run "mkdir -p #{shared_path}/templates"
+      upload File.expand_path('../upstart/process.conf.erb', __FILE__), "#{shared_path}/templates/process.conf.erb"
+
+      # I couldn't simply use `sudo bundle exec` since
+      # there was an issue using RVM. It was raising
+      #
+      # no such file to load -- rubygems
+      #
+      # If you have an idea on how to fix this. Pull
+      # request are more than welcomed :)
+      #
+      # The fix was to write the upstart script into
+      # a non-restricted folder and move it right after.
+      run  "cd #{current_path} && #{bundle_cmd} exec foreman export upstart -a #{application} -u #{user} -l #{shared_path}/log/ -t #{shared_path}/templates #{shared_path}/upstart"
+      sudo "mv #{shared_path}/upstart/* /etc/init/"
+
+      # Cleaning up this mess
+      run  "rm -rf #{shared_path}/upstart"
+      run  "rm -rf #{shared_path}/templates"
+    end
+
+    [:start, :stop, :restart].each do |action|
+      desc "#{action.to_s.capitalize} application"
+      task action, roles: :app do
+        sudo "service #{application} #{action}"
+      end
+
+      before "foreman:#{action}", 'foreman:export'
+    end
+
+  end
+end

data/lib/halfday/foreman/upstart/process.conf.erb

@@ -0,0 +1,5 @@
+start on starting <%= app %>-<%= name %>
+stop on stopping <%= app %>-<%= name %>
+respawn
+
+exec su - <%= user %> -c 'cd <%= engine.root %>; source .env; <%= process.command %> >> <%= log %>/<%=name%>-<%=num%>.log 2>&1'

data/lib/halfday/git/capistrano.rb

@@ -0,0 +1,21 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  before 'bundle:install', 'git:init_submodules'
+  after  'deploy',         'git:clean'
+
+  namespace :git do
+
+    desc "Update git submodules"
+    task :init_submodules, roles: :app do
+      run "cd #{release_path} && git submodule init --quiet"
+      run "cd #{release_path} && git submodule update --quiet"
+    end
+
+    desc "Remove git crumbles"
+    task :clean, roles: :app do
+      run "rm -fr `find #{deploy_to}/releases -iname \".git*\"`"
+    end
+
+  end
+
+end

data/lib/halfday/helpers/cset.rb

@@ -0,0 +1,12 @@
+# _cset is a method from the original
+# Capistrano code.
+#
+# https://github.com/capistrano/capistrano/blob/cb38c68bf9ec079590e6124728a1027668914f68/lib/capistrano/recipes/deploy.rb#L5
+#
+# It wasn't accessible through this gem
+# so I had to copy it there.
+def _cset(name, *args, &block)
+  unless exists?(name)
+    set(name, *args, &block)
+  end
+end

data/lib/halfday/helpers/require_recipe.rb

@@ -0,0 +1,7 @@
+def require_recipe(path)
+  begin
+    require path
+  rescue LoadError
+    "> Unable to load #{path}"
+  end
+end

data/lib/halfday/nginx/capistrano.rb

@@ -0,0 +1,21 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  after 'deploy:create_symlink', 'nginx:configure'
+
+  namespace :nginx do
+
+    desc 'Add app configuration for Mirego infrastructure'
+    task :configure, roles: :app do
+      if %w{ci qa staging}.include?(rails_env)
+        conf_path = "/etc/nginx/apps.conf.d/#{application}.conf"
+
+        upload File.expand_path('../templates/app.conf', __FILE__), conf_path
+
+        run "sed -i #{conf_path} -e s/\\\\[APPLICATION\\\\]/#{application}/g"
+        run "source #{current_path}/.env && sed -i #{conf_path} -e s/\\\\[PORT\\\\]/$PORT/g"
+        run "sudo service nginx reload"
+      end
+    end
+  end
+
+end

data/lib/halfday/nginx/templates/app.conf

@@ -0,0 +1,13 @@
+upstream local-[APPLICATION]{
+  server 127.0.0.1:[PORT];
+}
+
+server {
+  listen      8080;
+  server_name [APPLICATION].*;
+
+  location / {
+    proxy_pass http://local-[APPLICATION];
+    proxy_set_header Host $http_host;
+  }
+}

data/lib/halfday/rvm/capistrano.rb

@@ -0,0 +1,15 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  begin
+    require 'rvm/capistrano'
+
+    _cset :rvm_ruby_string, :release_path
+
+    # Make sure that the bash_profile is sourced
+    # before running bundle command.
+    set :bundle_cmd, 'source $HOME/.bash_profile && bundle'
+  rescue LoadError
+    puts "WARNING: RVM is not part of the application"
+  end
+
+end

data/lib/halfday/setup/capistrano.rb

@@ -0,0 +1,14 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  before 'deploy:setup', 'setup:create_directory'
+
+  namespace :setup do
+
+    desc "Create app directory"
+    task :create_directory, roles: :app do
+      run "sudo mkdir -p #{deploy_to} && sudo chown ubuntu:ubuntu #{deploy_to}"
+    end
+
+  end
+
+end

data/lib/halfday/version.rb

@@ -1,3 +1,3 @@
 module Halfday
-  VERSION = "0.0.1"
+  VERSION = "0.1.2"
 end

data/lib/halfday/whenever/capistrano.rb

@@ -0,0 +1,14 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  begin
+    require 'whenever/capistrano'
+
+    after 'bundle:install', 'whenever:update_crontab'
+
+    set :whenever_environment, defer { rails_env }
+    set :whenever_command, "bundle exec whenever"
+  rescue LoadError
+    puts "WARNING: Whenever is not part of the application"
+  end
+
+end

data/lib/halfday/yard/capistrano.rb

@@ -0,0 +1,19 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  if defined?(Yard)
+    after 'deploy:create_symlink', 'yard:generate'
+
+    namespace :yard do
+
+      desc "Update the documentation alone before a release`"
+      task :generate, roles: :app do
+        # Build the documentation for the application and make it public
+        run "mkdir #{current_path}/doc"
+        run "cd #{current_path} && #{bundle_cmd} exec yard doc RAILS_ENV=#{stage}"
+        run "mv #{current_path}/doc #{current_path}/public/doc"
+      end
+
+    end
+  end
+
+end

data/lib/halfday.rb

@@ -1,5 +1,5 @@
 require "halfday/version"
+require "halfday/capistrano"
 
 module Halfday
-  # Your code goes here...
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: halfday
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
-- Rémi Prévost
+- Samuel Garneau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,63 +27,109 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  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'
+- !ruby/object:Gem::Dependency
+  name: capistrano-ext
+  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'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  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: Collection of Capistrano recipes - Deploy. Then, take a halfday.
 email:
-- remi@exomel.com
+- sgarneau@mirego.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - halfday.gemspec
 - lib/halfday.rb
+- lib/halfday/capistrano.rb
+- lib/halfday/foreman/capistrano.rb
+- lib/halfday/foreman/upstart/process.conf.erb
+- lib/halfday/git/capistrano.rb
+- lib/halfday/helpers/cset.rb
+- lib/halfday/helpers/require_recipe.rb
+- lib/halfday/nginx/capistrano.rb
+- lib/halfday/nginx/templates/app.conf
+- lib/halfday/rvm/capistrano.rb
+- lib/halfday/setup/capistrano.rb
 - lib/halfday/version.rb
-homepage: ''
+- lib/halfday/whenever/capistrano.rb
+- lib/halfday/yard/capistrano.rb
+homepage: https://github.com/mirego/halfday
 licenses:
-- MIT
+- BSD 3-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1669050678196599340
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1669050678196599340
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
-summary: ''
+specification_version: 4
+summary: Collection of Capistrano recipes - Deploy. Then, take a halfday.
 test_files: []
+has_rdoc: 

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Rémi Prévost
-
-MIT License
-
-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.