captainu-chinook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e50abbbf391251d5cd09e71383b810c7c5b22d6
+  data.tar.gz: 02f105868f519e6577353bbff5afb95dab8feb71
+SHA512:
+  metadata.gz: 765fb463ef4a0591d9d6f0c762b9b96c0e56ddf02f3052de094e0a01d87e7a1cfba3d0b08f33f89716bd89fe53c8b480970b5e5cacef0ccb2b4cf31369c1c9b8
+  data.tar.gz: e194e512cac75df42c89e169652683fa7d9de4bb74bf291250a7a205b2b00168ed78dbc9ede7619fd683f00528911a05b6e3248523a2a457bf2e67bc3ee9315a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/chinook.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chinook/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'captainu-chinook'
+  spec.version       = Chinook::VERSION
+  spec.authors       = ['Ben Kreeger']
+  spec.email         = ['ben@captainu.com']
+  spec.summary       = %q{Abstraction of Capistrano v2 deployment tasks.}
+  spec.homepage      = 'https://github.com/captainu/chinook'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'capistrano', '~> 2.15.5'
+  spec.add_runtime_dependency 'tinder', '~> 1.9.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+end

data/lib/chinook.rb

@@ -0,0 +1,5 @@
+require 'chinook/version'
+
+module Chinook
+  # Your code goes here...
+end

data/lib/chinook/capistrano.rb

@@ -0,0 +1,3 @@
+module Chinook::Capistrano; end
+
+%w(campfire passenger ping).each { |m| require "chinook/capistrano/#{m}" }

data/lib/chinook/capistrano/campfire.rb

@@ -0,0 +1,57 @@
+# Defines a task that will let a Campfire room know about a deploy.
+require 'capistrano'
+require 'tinder'
+
+module Chinook::Capistrano
+  module Campfire
+    def self.load_into(configuration)
+      configuration.load do
+        namespace :chinook do
+          desc 'Lets a Campfire room know about a deploy that is about to start.'
+          task :campfire_start, except: { no_release: true } do
+            unless exists?(:campfire_room_name) && exists?(:campfire_token) && exists?(:campfire_account_name)
+              logger.info 'Cannot notify Campfire without :campfire_room_name, :campfire_token, and :campfire_account_name. Skipping task.'
+              next
+            end
+
+            project_name = fetch(:project_name, application)
+            git_username = `git config user.name`.chomp
+
+            message = "#{git_username} started a deploy of #{project_name} to #{stage} at #{Time.now.strftime('%r %Z')}."
+            room_name = fetch(:campfire_room_name)
+            token = fetch(:campfire_token)
+            account_name = fetch(:campfire_account_name)
+
+            campfire = Tinder::Campfire.new(account_name, token: token)
+            room = campfire.find_room_by_name(room_name)
+            room.speak(message)
+          end
+
+          desc 'Lets a Campfire room know about a deploy has finished.'
+          task :campfire_end, except: { no_release: true } do
+            unless exists?(:campfire_room_name) && exists?(:campfire_token) && exists?(:campfire_account_name)
+              logger.info 'Cannot notify Campfire without :campfire_room_name, :campfire_token, and :campfire_account_name. Skipping task.'
+              next
+            end
+
+            project_name = fetch(:project_name, application)
+            git_username = `git config user.name`.chomp
+
+            message = "#{git_username}'s deploy of #{project_name} to #{stage} finished at #{Time.now.strftime('%r %Z')}."
+            room_name = fetch(:campfire_room_name)
+            token = fetch(:campfire_token)
+            account_name = fetch(:campfire_account_name)
+
+            campfire = Tinder::Campfire.new(account_name, token: token)
+            room = campfire.find_room_by_name(room_name)
+            room.speak(message)
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Chinook::Capistrano::Campfire.load_into(Capistrano::Configuration.instance)
+end

data/lib/chinook/capistrano/passenger.rb

@@ -0,0 +1,21 @@
+# Defines a task that will reboot passenger upon deploy.
+require 'capistrano'
+
+module Chinook::Capistrano
+  module Passenger
+    def self.load_into(configuration)
+      configuration.load do
+        namespace :deploy do
+          desc 'Restarts Passenger by touching tmp/restart.txt.'
+          task :restart, roles: :app, except: { no_release: true } do
+            run "touch #{current_path}/tmp/restart.txt"
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Chinook::Capistrano::Passenger.load_into(Capistrano::Configuration.instance)
+end

data/lib/chinook/capistrano/ping.rb

@@ -0,0 +1,37 @@
+# Defines a task that will ping the website after a Passenger restart.
+require 'capistrano'
+
+module Chinook::Capistrano
+  module Ping
+    def self.load_into(configuration)
+      configuration.load do
+        namespace :chinook do
+          desc 'Sends a basic curl request to the website to wake it up.'
+          task :ping, except: { no_release: true } do
+            unless exists?(:ping_url)
+              logger.info 'Cannot ping website without :ping_url defined. Skipping task.'
+              next
+            end
+
+            rails_env = fetch(:rails_env, 'production')
+            destination = fetch(:ping_url)
+            ping_command = "curl -LI #{destination}"
+
+            logger.info "Pinging website to wake it up at #{destination}"
+            if configuration.dry_run
+              logger.info "DRY RUN: Ping not sent."
+            else
+              result = ""
+              run(ping_command, once: true) { |ch, stream, data| result << data }
+            end
+            logger.info "Ping sent; site should now be awake and responsive."
+          end
+        end
+      end
+    end
+  end
+end
+
+if Capistrano::Configuration.instance
+  Chinook::Capistrano::Ping.load_into(Capistrano::Configuration.instance)
+end

data/lib/chinook/version.rb

@@ -0,0 +1,3 @@
+module Chinook
+  VERSION = '0.1.0'
+end

data/license.markdown

@@ -0,0 +1,22 @@
+Copyright (c) 2014 CaptainU, LLC.
+
+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.

data/readme.markdown

@@ -0,0 +1,85 @@
+# Chinook
+
+Shared deployment tasks that we use at [CaptainU](http://captainu.com) for our Capistrano deploys. We noticed we've been using a lot of these duplicated tasks per project, so this is an attempt to shoehorn those all into a shared gem that we can add per-project, and with minimal effort, simplify our codebase.
+
+## Installation & Usage
+
+Add this line to your application's `Gemfile`, preferrably in the `:development` group next to `capistrano`.
+
+``` ruby
+group :development do
+  gem 'captainu-chinook'
+  # or from git:
+  # gem 'captainu-chinook', git: 'https://github.com/captainu/chinook.git'
+end
+```
+
+And then execute:
+
+``` bash
+$ bundle
+```
+
+Each script will likely have its own set of configuration variables that you'll want to set, and many of them will be environment-specific. The format for these instructions is as follows:
+
+``` ruby
+# ./config/deploy.rb
+# Towards the top of your deploy.rb file, require the library.
+
+require 'chinook/capistrano/some_task'
+# Optionally, require the whole kitchen sink with 'chinook/capistrano'
+
+# ... Set the necessary variables required by the script.
+
+set :ping_url, 'http://some-url-to-ping.example.com'
+
+# ... Down a little further, near your other hooks, add the script's deployment task hook.
+
+after 'deploy', 'chinook:some_task'
+```
+
+### Campfire notification
+
+Notifies [Campfire](https://campfirenow.com) when a deploy starts and/or stops. Uses the value of `git config user.name` for identifying the deploying user.
+
+* Tasks:
+    - `chinook:campfire_start`
+    - `chinook:campfire_end`
+* Hooks:
+    - `before 'deploy', 'chinook:campfire_start'`
+    - `after 'deploy', 'chinook:campfire_end'`
+* Settings:
+    - `:campfire_room_name`: the room where notifications will be posted.
+    - `:campfire_token`: the API token of the user that this task will post as.
+    - `:campfire_account_name`: the subdomain of your Campfire account (**this-part**.campfirenow.com).
+    - `:project_name`: the name of your project as it will show up in the notifications. *Optional; if not supplied, the value of `:application` will be used.*
+
+### Passenger restart
+
+Restarts [Passenger](https://phusionpassenger.com) after deploy by touching the file at `tmp/restart.txt` on the receiving server.
+
+* Task: `deploy:restart`
+* Hook: None needed; automatically included
+* Settings: None needed
+
+### Ping
+
+Pings the site after a [Passenger](phusionpassenger.com) deploy to ensure that it's immediately up and running following a restart task.
+
+* Task: `chinook:ping`
+* Hook: `after 'deploy:restart', 'chinook:ping'`
+* Settings:
+    - `:ping_url`: the URL you'd like to ping to wake up. *Environment specific.*
+
+## Contributing
+
+1. [Fork it](https://github.com/captainu/chinook/fork).
+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 a new Pull Request for it and we'll review it!
+
+## Contributors
+
+- [Ben Kreeger](https://github.com/kreeger)
+- [Mike Admire](https://github.com/mikeadmire)

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: captainu-chinook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Kreeger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.5
+- !ruby/object:Gem::Dependency
+  name: tinder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben@captainu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Rakefile
+- chinook.gemspec
+- lib/chinook.rb
+- lib/chinook/capistrano.rb
+- lib/chinook/capistrano/campfire.rb
+- lib/chinook/capistrano/passenger.rb
+- lib/chinook/capistrano/ping.rb
+- lib/chinook/version.rb
+- license.markdown
+- readme.markdown
+homepage: https://github.com/captainu/chinook
+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.0
+signing_key: 
+specification_version: 4
+summary: Abstraction of Capistrano v2 deployment tasks.
+test_files: []