chicken_soup 0.1.0 → 0.2.0

data/lib/chicken_soup/notifiers/checks.rb

@@ -2,7 +2,7 @@
 #                           NOTIFIERS CHECK                          #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  after 'environment:check', 'notifiers:check'
+  before  'notifiers:check',         'load_notifier_checks'
 
   namespace :notifiers do
     namespace :check do

data/lib/chicken_soup/notifiers/defaults.rb

@@ -2,8 +2,7 @@
 #                        DEFAULT NOTIFIERS SETUP                     #
 ######################################################################
 Capistrano::Configuration.instance(:must_exist).load do
-  after   'environment:defaults',       'notifiers:defaults'
-  before  'notifiers:defaults',         'load_notifiers'
+  before  'notifiers:defaults',         'load_notifier_defaults'
 
   namespace :notifiers do
     namespace :defaults do

data/lib/chicken_soup/notifiers/email/email-checks.rb

@@ -0,0 +1,26 @@
+######################################################################
+#                       EMAIL NOTIFIER CHECKS                        #
+######################################################################
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :notifiers do
+    namespace :check do
+      desc <<-DESC
+        [internal] Checks to see if all necessary email notification environment variables have been set up.
+      DESC
+      task :email do
+        required_variables = [
+          :email_notifier_client_recipients,
+          :email_notifier_internal_recipients,
+          :email_notifier_domain,
+          :email_notifier_username,
+          :email_notifier_password,
+          :vc_log
+        ]
+
+        abort "You must specify either internal or client recipients in order to use the email notifier." if email_notifier_client_recipients.empty? && email_notifier_internal_recipients.empty?
+
+        verify_variables(required_variables)
+      end
+    end
+  end
+end

data/lib/chicken_soup/notifiers/email/email-defaults.rb

@@ -0,0 +1,50 @@
+######################################################################
+#                       EMAIL NOTIFIER DEFAULTS                      #
+######################################################################
+require 'mail'
+require 'erb'
+require 'chicken_soup/notifiers/email/presenter'
+
+Capistrano::Configuration.instance(:must_exist).load do |cap|
+  namespace :notifiers do
+    namespace :defaults do
+      task :email do
+        _cset :email_notifier_format,              'html'
+
+        _cset :email_notifier_mail_method,         :smtp
+        _cset :email_notifier_server,              "smtp.gmail.com"
+        _cset :email_notifier_port,                587
+        _cset :email_notifier_authentication,      'plain'
+
+        _cset(:email_notifier_mail_options)      do
+                                                    { :address              => email_notifier_server,
+                                                      :port                 => email_notifier_port,
+                                                      :domain               => email_notifier_domain,
+                                                      :user_name            => email_notifier_username,
+                                                      :password             => email_notifier_password,
+                                                      :authentication       => email_notifier_authentication,
+                                                      :enable_starttls_auto => true  }
+                                                 end
+
+        _cset :email_notifier_client_recipients,   []
+        _cset :email_notifier_internal_recipients, []
+        _cset :email_notifier_sender,              'theshadow@theshadowknows.com'
+        _cset :email_notifier_subject,             "#{application.titleize} has been deployed to #{rails_env.capitalize}"
+        _cset :email_notifier_client_template,     read_template("client_email.#{email_notifier_format}.erb")
+        _cset :email_notifier_internal_template,   read_template("internal_email.#{email_notifier_format}.erb")
+
+        email_presenter= ChickenSoup::Email::Presenter.new(cap)
+        _cset :email_notifier_client_body,         render_erb(email_notifier_client_template, email_presenter)
+        _cset :email_notifier_internal_body,       render_erb(email_notifier_internal_template, email_presenter)
+      end
+    end
+  end
+end
+
+def render_erb(template, email_info)
+  ERB.new(template, 0, "%<>").result(binding)
+end
+
+def read_template(template)
+  File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', template))
+end

data/lib/chicken_soup/notifiers/email/email-tasks.rb

@@ -0,0 +1,37 @@
+######################################################################
+#                        EMAIL NOTIFIER TASKS                        #
+######################################################################
+require 'mail'
+
+Capistrano::Configuration.instance(:must_exist).load do |cap|
+  after     'deploy:cleanup',             'notify:by_email'
+
+  namespace :notify do
+    desc <<-DESC
+      [internal] Sends a notification via email once a deployment is complete.
+    DESC
+    task :by_email do
+      Mail.defaults do
+        delivery_method cap[:email_notifier_mail_method], cap[:email_notifier_mail_options]
+      end
+
+      if !cap[:email_notifier_client_recipients].empty?
+        Mail.deliver do
+              to cap[:email_notifier_client_recipients]
+            from cap[:email_notifier_sender]
+         subject cap[:email_notifier_subject]
+            body cap[:email_notifier_client_body]
+        end
+      end
+
+      if !cap[:email_notifier_internal_recipients].empty?
+        Mail.deliver do
+              to cap[:email_notifier_internal_recipients]
+            from cap[:email_notifier_sender]
+         subject cap[:email_notifier_subject]
+            body cap[:email_notifier_internal_body]
+        end
+      end
+    end
+  end
+end

data/lib/chicken_soup/notifiers/email/presenter.rb

@@ -0,0 +1,56 @@
+require 'etc'
+require 'time'
+
+module ChickenSoup
+  module Email
+    class Presenter
+      LongDateFormat = "%A, %B %e, %Y at %l:%M%p %Z"
+
+      def initialize(capistrano)
+        @capistrano = capistrano
+      end
+
+      def application
+        @capistrano[:application].titleize
+      end
+
+      def environment
+        @capistrano[:rails_env].titleize
+      end
+
+      def deployed_by
+        Etc.getlogin
+      end
+
+      def deploy_date_in_long_format
+        format_timestamp(@capistrano[:current_release], LongDateFormat)
+      end
+
+      def previous_deploy_date_in_long_format
+        format_timestamp(@capistrano[:previous_release], LongDateFormat)
+      end
+
+      def notifiers
+        @capistrano[:notifiers].join(", ")
+      end
+
+      def changes_since_last_deployment
+        @capistrano[:vc_log]
+      end
+
+      private
+      def format_timestamp(capistrano_timestamp, format)
+        timestamp = convert_capistrano_timestamp(capistrano_timestamp)
+        timestamp.strftime(format)
+      end
+
+      def convert_capistrano_timestamp(capistrano_timestamp)
+        begin
+          Date.strptime(capistrano_timestamp, "%Y%m%d%H%M%S")
+        rescue
+          Date.today
+        end
+      end
+    end
+  end
+end

data/lib/chicken_soup/notifiers/tasks.rb

@@ -0,0 +1,12 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  before  'notifiers:load_tasks',      'load_notifier_tasks'
+
+  namespace :notifiers do
+    desc <<-DESC
+      [internal] A helper task used to load all of the tasks associated with the
+      requested notifiers.
+    DESC
+    task :load_tasks do
+    end
+  end
+end

data/lib/chicken_soup/templates/client_email.html.erb

@@ -0,0 +1,21 @@
+<%= email_info.application %>
+
+Deployment to <%= email_info.environment %>
+
+Deployed By <%= email_info.deployed_by %>
+<%= email_info.deploy_date_in_long_format %>
+
+<%= email_info.application %> was last deployed to <%= email_info.environment %> on <%= email_info.previous_deploy_date_in_long_format %>.
+
+Other Notifications Sent
+-------------------------------
+<%= email_info.notifiers %>
+
+
+Changes Since The Last Deployment
+-------------------------------
+<%= email_info.changes_since_last_deployment %>
+
+
+Thank you for eating your Chicken Soup.  Your mother would be proud.
+Chicken Soup is a free product of The Kompanee.  Please deploy responsibly.

data/lib/chicken_soup/templates/internal_email.html.erb

@@ -0,0 +1,19 @@
+<%= email_info.application %>
+
+Deployment to <%= email_info.environment %>
+
+Deployed By <%= email_info.deployed_by %>
+<%= email_info.deploy_date_in_long_format %>
+
+<%= email_info.application %> was last deployed to <%= email_info.environment %> on <%= email_info.previous_deploy_date_in_long_format %>.
+
+Other Notifications Sent
+-------------------------------
+<%= email_info.notifiers %>
+
+Changes Since The Last Deployment
+-------------------------------
+<%= email_info.changes_since_last_deployment %>
+
+Thank you for eating your Chicken Soup.  Your mother would be proud.
+Chicken Soup is a free product of The Kompanee.  Please deploy responsibly.

data/lib/chicken_soup/version.rb

@@ -1,3 +1,3 @@
 module ChickenSoup
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/chicken_stock.rb

@@ -1,5 +1,5 @@
-require "chicken_soup/global"
-require "chicken_soup/environment"
+require 'chicken_soup/global'
+require 'chicken_soup/environment'
 require 'chicken_soup/capabilities'
 require 'chicken_soup/notifiers'
-require "chicken_soup/deploy"
+require 'chicken_soup/deploy'

data/spec/support/focused.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  # Configure RSpec to run focused specs, and also respect the alias 'fit' for focused specs
+  config.filter_run       :focused => true
+  config.alias_example_to :fit, :focused => true
+
+  # Configure RSpec to respect the alias 'pit' for pending specs
+  config.alias_example_to :pit, :pending => true
+
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: chicken_soup
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - thekompanee
@@ -10,39 +11,64 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 -06:00
+date: 2011-06-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: capistrano
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.5.19
-    version: 
+        version: 2.6.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mail
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.2.15
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: bundler
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 1.0.10
-    version: 
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+  type: :development
+  version_requirements: *id005
 description: ...for the Deployment Soul.  Why do you keep typing all that crap into your Capistrano recipes?  Are you too cool for standards?  Well, ARE YA!?
 email: support@thekompanee.com
 executables: []
@@ -54,38 +80,68 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - .gitignore
+- .rspec
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - chicken_soup.gemspec
 - lib/chicken_soup/capabilities.rb
-- lib/chicken_soup/capabilities/apache.rb
-- lib/chicken_soup/capabilities/bundler.rb
+- lib/chicken_soup/capabilities/apache/apache-checks.rb
+- lib/chicken_soup/capabilities/apache/apache-defaults.rb
+- lib/chicken_soup/capabilities/apache/apache-tasks.rb
+- lib/chicken_soup/capabilities/bundler/bundler-checks.rb
+- lib/chicken_soup/capabilities/bundler/bundler-defaults.rb
+- lib/chicken_soup/capabilities/bundler/bundler-tasks.rb
 - lib/chicken_soup/capabilities/checks.rb
 - lib/chicken_soup/capabilities/defaults.rb
-- lib/chicken_soup/capabilities/git.rb
-- lib/chicken_soup/capabilities/heroku.rb
-- lib/chicken_soup/capabilities/mysql.rb
-- lib/chicken_soup/capabilities/passenger.rb
-- lib/chicken_soup/capabilities/postgres.rb
-- lib/chicken_soup/capabilities/rvm.rb
-- lib/chicken_soup/capabilities/shared/db.rb
-- lib/chicken_soup/capabilities/svn.rb
-- lib/chicken_soup/capabilities/unix.rb
+- lib/chicken_soup/capabilities/git/git-defaults.rb
+- lib/chicken_soup/capabilities/heroku/heroku-checks.rb
+- lib/chicken_soup/capabilities/heroku/heroku-defaults.rb
+- lib/chicken_soup/capabilities/heroku/heroku-tasks.rb
+- lib/chicken_soup/capabilities/mysql/mysql-tasks.rb
+- lib/chicken_soup/capabilities/nginx/nginx-checks.rb
+- lib/chicken_soup/capabilities/nginx/nginx-defaults.rb
+- lib/chicken_soup/capabilities/nginx/nginx-tasks.rb
+- lib/chicken_soup/capabilities/passenger/passenger-tasks.rb
+- lib/chicken_soup/capabilities/postgres/postgres-checks.rb
+- lib/chicken_soup/capabilities/postgres/postgres-defaults.rb
+- lib/chicken_soup/capabilities/postgres/postgres-tasks.rb
+- lib/chicken_soup/capabilities/rvm/rvm-checks.rb
+- lib/chicken_soup/capabilities/rvm/rvm-defaults.rb
+- lib/chicken_soup/capabilities/rvm/rvm-tasks.rb
+- lib/chicken_soup/capabilities/shared/db-checks.rb
+- lib/chicken_soup/capabilities/shared/db-defaults.rb
+- lib/chicken_soup/capabilities/shared/db-tasks.rb
+- lib/chicken_soup/capabilities/shared/web_server-tasks.rb
+- lib/chicken_soup/capabilities/svn/svn-defaults.rb
+- lib/chicken_soup/capabilities/svn/svn-tasks.rb
+- lib/chicken_soup/capabilities/tasks.rb
+- lib/chicken_soup/capabilities/unix/unix-checks.rb
+- lib/chicken_soup/capabilities/unix/unix-defaults.rb
+- lib/chicken_soup/capabilities/unix/unix-tasks.rb
 - lib/chicken_soup/deploy.rb
 - lib/chicken_soup/environment.rb
 - lib/chicken_soup/environment/checks.rb
 - lib/chicken_soup/environment/defaults.rb
+- lib/chicken_soup/environment/tasks.rb
 - lib/chicken_soup/global.rb
 - lib/chicken_soup/notifiers.rb
 - lib/chicken_soup/notifiers/checks.rb
 - lib/chicken_soup/notifiers/defaults.rb
-- lib/chicken_soup/notifiers/email.rb
-- lib/chicken_soup/notifiers/git.rb
-- lib/chicken_soup/notifiers/hoptoad.rb
+- lib/chicken_soup/notifiers/email/email-checks.rb
+- lib/chicken_soup/notifiers/email/email-defaults.rb
+- lib/chicken_soup/notifiers/email/email-tasks.rb
+- lib/chicken_soup/notifiers/email/presenter.rb
+- lib/chicken_soup/notifiers/git/git-tasks.rb
+- lib/chicken_soup/notifiers/hoptoad/hoptoad-tasks.rb
+- lib/chicken_soup/notifiers/tasks.rb
+- lib/chicken_soup/templates/client_email.html.erb
+- lib/chicken_soup/templates/internal_email.html.erb
 - lib/chicken_soup/version.rb
 - lib/chicken_stock.rb
+- spec/support/focused.rb
 has_rdoc: true
 homepage: http://github.com/jfelchner/chicken_soup
 licenses: []
@@ -96,23 +152,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: chicken_soup
-rubygems_version: 1.3.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: chicken_soup-0.1.0
-test_files: []
-
+summary: chicken_soup-0.2.0
+test_files: 
+- spec/support/focused.rb