capistrano-campout 0.0.2 → 1.0.0

data/README.md

@@ -36,16 +36,24 @@ Or install it yourself as:
 
     $ gem install capistrano-campout
 
-## Usage
+## Setup
 
-Add a:
+You can generate a configuration by running
+
+    campout generate_config
+
+This will prompt you for your campfire configuration settings and create config/campout.yml and config/campout.local.yml files for you, adding config/campout.local.yml to your .gitignore file (if present) and adding a require 'capistrano-campout' to your config/deploy.rb file.
+
+## Manual Setup
+
+Alternatively add a:
 
 	require "capistrano-campout"  
 
 to your capistrano deploy.rb and create a config/campout.yml and/or a config/campout.local.yml with your campfire settings (required)
 
 	campfire:
-	    domain: 'your_campfire_domain'
+	    domain: your_campfire_domain
 	    room: room_id_to_post_to
 	    token: your_campfire_api_token
 
@@ -53,9 +61,11 @@ to your capistrano deploy.rb and create a config/campout.yml and/or a config/cam
 
 "config/campout.local.yml" is meant as a local/private configuration file - I'd recommend adding the file to the .gitignore
 
-## Additional Settings
+## Settings
+
+Run the 'campout generate_config' command - and the config/campout.yml file will have a list of all the known settings.
 
-I'll write those up one day. Until that day, use the source, Luke.
+Otherwise, use the source, Luke.
 
 ## Known Limitations
 
@@ -63,7 +73,7 @@ I'll write those up one day. Until that day, use the source, Luke.
 
 Capistrano::Campout requires [Tinder](https://github.com/collectiveidea/tinder) - which requires [ActiveSupport](https://github.com/rails/rails/tree/master/activesupport)
 
-Apparently, Capistrano's "deploy:cleanup" task breaks due to conflicts between Capistrano and ActiveSupport
+Apparently, Capistrano's "deploy:cleanup" task breaks in some situations due to conflicts between Capistrano and ActiveSupport
 
 See:
 

data/bin/campout

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2012 Jason Adam Young
+# 
+# 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.
+# 
+# Additional Copyrights
+# =====================
+# 
+# This code also contains code from the following people:
+#  
+#  rails_config : Copyright (c) 2010 Jacques Crocker
+#  deep_merge : Copyright (c) 2008 Steve Midgley, now mainted by Daniel DeLeo
+#  eycap : Copyright (c) 2008-2011 Engine Yard
+#  capfire : Copyright (c) 2010 Piet Jaspers 10to1
+#  capistrano-mountaintop : Copyright (c) 2010 Joshua Nichols.
+
+source_root = File.expand_path(File.dirname(__FILE__) + "/..")
+$LOAD_PATH.unshift("#{source_root}/lib")
+require 'rubygems' rescue nil
+require 'cli'
+Campout::CLI.start

data/lib/capistrano-campout/core.rb

@@ -2,8 +2,6 @@
 # Copyright (c) 2012 Jason Adam Young
 # === LICENSE:
 # see LICENSE file
-
-
 module Capistrano
   module Campout    
     class TemplateError < NameError

data/lib/capistrano-campout/defaults.yml

@@ -1,22 +1,6 @@
-## campfire settings
-# campfire:
-#     domain: 'your_campfire_domain'
-#     room: your_room_id
-#     token: your_campfire_token
-
-## global action settings
-# copy_log_to_server: false
-# suppress_sounds: false
-# suppress_deploy_time: false
-# suppress_github_compare: false
-
-## deployment settings
 pre_deploy:
     message: "<%= campout_deployer %> is starting to deploy <%= application %> to <%= whereto %>"
-#	 play: 'pushit'
 post_deploy_success:
     message: "<%= campout_deployer %> deployed <%= application %> to <%= whereto %>"
-#	 play: 'yeah'
 post_deploy_failure:
     message: "The deploy of <%= application %> to <%= whereto %> by <%= campout_deployer %> has failed."
-#	 play: 'drama'

data/lib/capistrano-campout/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Campout
-    VERSION = "0.0.2"
+    VERSION = "1.0.0"
   end
 end

data/lib/cli.rb

@@ -0,0 +1,98 @@
+# === COPYRIGHT:
+# Copyright (c) 2012 Jason Adam Young
+# === LICENSE:
+# see LICENSE file
+require 'thor'
+require 'yaml'
+require 'capistrano-campout/version'
+
+module Campout
+  class CLI < Thor
+    include Thor::Actions
+
+    # these are not the tasks that you seek
+    def self.source_root
+      File.expand_path(File.dirname(__FILE__) + "/..")
+    end
+    
+    no_tasks do
+      
+      def copy_configs
+        # campout.yml
+        destination = "./config/campout.yml"
+        if(!File.exists?(destination))
+          copy_file('templates/campout.yml',destination)
+        end
+        #
+        destination = "./config/campout.local.yml"
+        if(!File.exists?(destination))
+          copy_file('templates/campout.local.yml',destination)
+        end
+      end
+      
+      def add_campfire_settings(open_repository,campfire_settings)
+        if(open_repository)
+          settings_file = "./config/campout.local.yml"
+        else
+          settings_file = "./config/campout.yml"
+        end
+        
+        # has campfire settings?
+        has_campfire_settings = false
+        if(existing_settings = YAML.load(IO.read(settings_file)))
+          if(!existing_settings['campfire'].nil?)
+            has_campfire_settings = true
+          end
+        end
+        
+        if(!has_campfire_settings)
+          append_file(settings_file,campfire_settings.to_yaml)
+        end
+      end
+      
+      def add_local_to_gitignore
+        gitignore_file = './.gitignore'
+        if(File.exists?(gitignore_file))
+          if(!(File.read(gitignore_file) =~ %r{config/campout.local.yml}))
+            append_file(gitignore_file,"config/campout.local.yml\n")
+          end
+        end
+      end
+      
+      def add_campout_to_deploy
+        cap_deploy_script = './config/deploy.rb'
+        if(File.exists?(cap_deploy_script))
+          if(!(File.read(cap_deploy_script) =~ %r{require ['|"]capistrano-campout["|']}))
+            prepend_file(cap_deploy_script,"require 'capistrano-campout'\n")
+          end
+        end
+      end
+    end
+
+
+    desc "about", "about campout"  
+    def about
+      puts "Campout Version #{Capistrano::Campout::VERSION}: Post messages and paste logs from a capistrano deployment to a campfire room."
+    end
+    
+    desc "generate_config", "generate campout configuration files"
+    def generate_config
+      open_repository = yes?("Is this an open/public repository?")
+      if(open_repository)
+        say "Your campout settings will be added to ./config/campout.local.yml"
+      else
+        say "Your campout settings will be added to ./config/campout.yml"
+      end  
+      campfire_settings = {'campfire' => {'domain' => 'domain', 'room' => 'room', 'token' => 'token'}}
+      campfire_settings['campfire']['domain'] = ask("Your campfire domain:")
+      campfire_settings['campfire']['room'] = ask("Your campfire room ID:").to_i
+      campfire_settings['campfire']['token'] = ask("Your campfire api token:")
+        
+      copy_configs
+      add_campfire_settings(open_repository,campfire_settings)
+      add_local_to_gitignore
+      add_campout_to_deploy
+    end        
+  end
+  
+end

data/templates/campout.local.yml

@@ -0,0 +1,10 @@
+#### config/campout.local.yml
+## User this file for local/private campout settings for the project. This 
+## file should be excluded from your SCM.
+##
+## If your SCM repository is open it's strongly recommended that
+## your campfire settings into this local configuration file
+## particularly the campfire API token
+##
+## shared settings can be placed within a config/campout.yml file.  
+## see config/campout.yml for the settings

data/templates/campout.yml

@@ -0,0 +1,104 @@
+#### config/campout.yml
+## User this file for shared campout settings for the project. It's 
+## recommended that you add this file to your SCM.
+##
+## personal overrides or other settings can be placed 
+## within a config/campout.local.yml file.  If your SCM repository 
+## is open it's strongly recommended that your campfire settings 
+## into the local configuration file, particularly the campfire API token
+##
+### campfire settings
+## 
+## The campfire configuration settings should be added as
+## a yaml hash keyed to "campfire" e.g.
+##
+## campfire:
+##     domain: 'your_campfire_domain'
+##     room: your_room_id
+##     token: your_campfire_token
+##
+## The following campfire settings are required
+##
+## domain:
+##   The "subdomain" for your campfire site
+##   e.g. for https://yourdomain.campfirenow.com/ it will be "yourdomain"
+## room:
+##   The id of the room you want to post messages to. Click on the campfire 
+##   room that you want and get the id from the URL. 
+##  e.g. for https://yourdomain.campfirenow.com/room/123456
+##   the room id is 123456
+## token:
+##   The API authentication token for your account. You can get your token
+##   by clicking "My Info" in the top right of the campfirewnow site - or
+##   going directly to https://yourdomain.campfirenow.com/member/edit
+##
+## The following campfire settings are optional
+## 
+## ssl:
+##   If false, specifies that Tinder should not use an SSL connection
+## ssl_verify:
+##   If false, specified that Tinder should not try to verify the SSL
+##   certificate.
+##
+### global action settings
+##
+## copy_log_to_server:
+##   If set to true - the cap deployment log will be copied to a "deploy_logs"
+##   subdirectory of your #{shared_path}. The filename will be in the format:
+##   deploy-#{release_name}-#{successful? ? "success" : "failure"}.log
+## default:
+# copy_log_to_server: false
+##
+## suppress_sounds:
+##   If set to true, will supress the playing sounds specified in the "play"
+##   settings for the pre_deploy, post_deploy_success, and 
+##   post_deploy_failure sections
+##   default:
+# suppress_sounds: false
+##
+## suppress_deploy_time:
+##   If set to true, will supress the output of the benchmark timing for the
+##   deployment.
+## default:
+# suppress_deploy_time: false
+##
+## suppress_github_compare:
+##   Campout will attempt to display a github url (if the capistrano
+##   repository is a github repository) that will show the comparison
+##   of previous_revision with latest_revision (as determined by 
+##   capistrano)
+## default:
+# suppress_github_compare: false
+
+### deployment settings
+##
+## There are three deployment hashes with the following keys: 
+##   pre_deploy: settings applied before the capistrano deploy action
+##   post_deploy_success: settings applied after a successful capistrano deploy action  
+##   post_deploy_failure: settings applied after a failed capistrano deploy action  
+##
+## Each hash can include the following settings
+##   message: 
+##     The message to post to the specified campfire room. The message can include
+##     ERB - and all of the capistrano variables are available - with the addition
+##     of "campout_deployer" - which attempts to use the git user.name setting and
+##     falls back to ENV['USER'] and "whereto" - which attempts to use the stage
+##     and falls back to ENV['SERVER'] or 'production'
+##   play:
+##     specifies a campfire sound to play when the message is posted.
+##
+## defaults:
+# pre_deploy:
+#     message: "<%= campout_deployer %> is starting to deploy <%= application %> to <%= whereto %>"
+# post_deploy_success:
+#     message: "<%= campout_deployer %> deployed <%= application %> to <%= whereto %>"
+# post_deploy_failure:
+#     message: "The deploy of <%= application %> to <%= whereto %> by <%= campout_deployer %> has failed."
+##
+## recommended sounds:
+# pre_deploy:
+#     play: "pushit"
+# post_deploy_success:
+#     play: "yeah"
+# post_deploy_failure:
+#     play: "drama"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-campout
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70315888091420 !ruby/object:Gem::Requirement
+  requirement: &70347365888740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.11'
   type: :runtime
   prerelease: false
-  version_requirements: *70315888091420
+  version_requirements: *70347365888740
 - !ruby/object:Gem::Dependency
   name: tinder
-  requirement: &70315888075700 !ruby/object:Gem::Requirement
+  requirement: &70347365887720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '1.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70315888075700
+  version_requirements: *70347365887720
 - !ruby/object:Gem::Dependency
   name: grit
-  requirement: &70315888074660 !ruby/object:Gem::Requirement
+  requirement: &70347365885720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '2.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70315888074660
+  version_requirements: *70347365885720
 description: ! "    Capistrano::Campout is a gem extension to capistrano to post/speak
   messages and paste logs from a capistrano deployment \n    to a campfire room. Settings
   are configurable using ERB in a \"config/campout.yml\" or \"config/campout.local.yml\"
@@ -51,7 +51,8 @@ description: ! "    Capistrano::Campout is a gem extension to capistrano to post
   success or failure message. Event sounds\n    are also supported.\n"
 email:
 - jay@outfielding.net
-executables: []
+executables:
+- campout
 extensions: []
 extra_rdoc_files: []
 files:
@@ -60,6 +61,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/campout
 - capistrano-campout.gemspec
 - lib/capistrano-campout.rb
 - lib/capistrano-campout/core.rb
@@ -71,6 +73,9 @@ files:
 - lib/capistrano-campout/recipes/campout.rb
 - lib/capistrano-campout/recipes/deploy.rb
 - lib/capistrano-campout/version.rb
+- lib/cli.rb
+- templates/campout.local.yml
+- templates/campout.yml
 homepage: https://github.com/jasonadamyoung/capistrano-campout
 licenses:
 - MIT