capistrano-ash 1.1.11 → 1.1.12

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+== 1.1.12
+* Applied dficker's proposed patch for issue #11
+* Added the `remote_dir_exists?` method to the `lib/ash/common.rb` 
+** TODO: better tasks to test if a remote directory exists
+* Added some Drupal Ubercart methods to help secure Ubercart encryption keys and downloadable products
+
+== 1.1.11
+* Added functionality to help fascilitate migrating local databases to remote and back
+
 == 1.1.7
 * Updated naming convention for Magento configuration files
 

data/README.textile

@@ -39,95 +39,9 @@ The capistrano/ash/drupal library takes a hash of Drupal multisites in the follo
 
 where each key is a folder in your @sites@ directory and each value is the URL of the multisite. If you are not using multisites, just exclude the @:multisites@ variable definition.
 
-
-h3. Capfile
-
-<pre>
-  <code>
-    # Capfile
-    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
-
-    # --------------------------------------------
-    # :application HAS TO BE DEFINED BEFORE
-    # REQUIRING 'ash/drupal' LIBRARY
-    # --------------------------------------------
-    set :application, "bestappever.com"
-    set :stages, %w(staging production)
-
-    # --------------------------------------------
-    # Define required Gems/libraries
-    # --------------------------------------------
-    require 'ash/drupal'
-
-    # --------------------------------------------
-    # Setting defaults
-    # --------------------------------------------
-    # IP-address or host's servername
-    role :app, "bestappever.com"
-    role :web, "bestappever.com"
-    role :db,  "bestappever.com", :primary => true
-
-    # VCS information.
-    set :repository, "https://svn.example.com/REPO/trunk"
-    set :scm_username, "SVN_USER"
-    set :scm_password, proc{Capistrano::CLI.password_prompt("Subversion password for '#{scm_username}':")}
-
-    # SSH login credentials
-    set :user, "SSH_USER"
-    set :password, proc{Capistrano::CLI.password_prompt("SSH password for '#{user}':")}
-    
-    # Deploy to file path
-    set(:deploy_to)  { "/var/www/#{application}/#{stage}" }
-
-    # Database credentials
-    set :dbuser, "DB_USER_NAME"
-
-    # Define which files or directories you want to exclude from being backed up
-    set(:backup_exclude) { [ "var/" ] }
-    
-
-    # --------------------------------------------
-    # Drupal Multi-Sites
-    # --------------------------------------------
-    # Setting which folder in the sites directory to use
-    set :multisites, { 
-      'bestapp' => 'bestappever.com', 
-    }
-
-
-    # --------------------------------------------
-    # Callbacks - Set Before/After Precedence
-    # --------------------------------------------
-    before "deploy:update_code", "deploy:setup_backup"
-    after "deploy:setup_backup", "backup"
-  </code>
-</pre>
-
-h3. config/deploy/staging.rb
-
-<pre>
-  <code>
-    # config/deploy/staging.rb
-    # Database Name
-    set :dbname, "DB_NAME"
-
-    # Backups Path (/var/www/#{application}/staging/backups)
-    set :backups_path,  "#{deploy_to}/backups"
-  </code>
-</pre>
-
-h3. config/deploy/production.rb
-
-<pre>
-  <code>
-    # config/deploy/production.rb
-    # Database Name
-    set :dbname, "DB_NAME"
-
-    # Backups Path (/var/www/#{application}/production/backups)
-    set :backups_path,  "#{deploy_to}/backups"
-  </code>
-</pre>
+Check the "Wiki":https://github.com/augustash/capistrano-ash/wiki for detailed configuration instructions.
+"Drupal on virtual or dedicated servers":https://github.com/augustash/capistrano-ash/wiki/Drupal-Private-Server-Example
+"Drupal on shared hosting":https://github.com/augustash/capistrano-ash/wiki/Drupal-Shared-Hosting-Example
 
 
 h2. Deploying Zend or Zend/Doctrine example

data/VERSION

@@ -1 +1 @@
-1.1.11
+1.1.12

data/capistrano-ash.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{capistrano-ash}
-  s.version = "1.1.6"
+  s.version = "1.1.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["August Ash"]
-  s.date = %q{2011-06-29}
+  s.authors = [%q{August Ash}]
+  s.date = %q{2011-09-26}
   s.description = %q{August Ash recipes for Capistrano}
   s.email = %q{code@augustash.com}
   s.extra_rdoc_files = [
@@ -33,8 +33,8 @@ Gem::Specification.new do |s|
     "lib/ash/zend_doctrine_shared_hosting.rb"
   ]
   s.homepage = %q{https://github.com/augustash/capistrano-ash}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.1}
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Useful task libraries for August Ash recipes for Capistrano}
 
   if s.respond_to? :specification_version then

data/lib/ash/base.rb

@@ -358,6 +358,28 @@ configuration.load do
         end
       end
     end
+    
+    namespace :dir do
+      desc "Test: Task to test existence of missing dir"
+      task :missing do
+        if remote_dir_exists?('/etc/fake_dir')
+          logger.info "FAIL - Why does the '/etc/fake_dir' dir exist???"
+        else
+          logger.info "GOOD - Verified the '/etc/fake_dir' dir does not exist!"
+        end
+      end
+      
+      desc "Test: Task used to test existence of an existing directory"
+      task :exists do
+        if remote_dir_exists?('/etc')
+          logger.info "GOOD - Verified the '/etc' dir exists!"
+        else
+          logger.info "FAIL - WHAT happened to the '/etc' dir???"
+        end
+      end
+      
+    end
+    
   end
 
 end

data/lib/ash/common.rb

@@ -20,4 +20,14 @@ end
 # the full path to the expected file location
 def remote_file_exists?(full_path)
   'true' ==  capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
-end
+end
+
+# Test to see if a directory exists on a remote
+# server by providing the full path to the expected
+# directory
+#
+# Params:
+#   +dir_path+
+def remote_dir_exists?(dir_path)
+  'true' == capture("if [[ -d #{dir_path} ]]; then echo 'true'; fi").strip
+end

data/lib/ash/drupal.rb

@@ -13,6 +13,16 @@ configuration.load do
   # --------------------------------------------
   proc{_cset( :multisites, {"#{application}" => "#{application}"} )}
   set :drush_bin, "drush"
+  
+  # --------------------------------------------
+  # Ubercart Files/Folders
+  #   assumes ubercart files are located
+  #   within a files/ubercart directory 
+  #   for each multisite
+  # --------------------------------------------
+  set :uc_root, "ubercart"
+  set :uc_downloadable_products_root, "downloadable_products"
+  set :uc_encryption_keys_root, "keys"
 
   # --------------------------------------------
   # Calling our Methods
@@ -54,7 +64,9 @@ configuration.load do
     task :finalize_update, :roles => :web, :except => { :no_release => true } do
       # remove shared directories
       multisites.each_pair do |folder, url|
-        run "mv #{latest_release}/sites/#{folder} #{latest_release}/sites/#{url}"
+        if folder != url 
+          run "mv #{latest_release}/sites/#{folder} #{latest_release}/sites/#{url}"
+        end
         run "rm -Rf #{latest_release}/sites/#{url}/files"
       end
     end
@@ -97,8 +109,8 @@ configuration.load do
   # Drupal-specific methods
   # --------------------------------------------
   namespace :drupal do
-   desc "Symlink shared directories"
-   task :symlink, :roles => :web, :except => { :no_release => true } do
+    desc "Symlink shared directories"
+    task :symlink, :roles => :web, :except => { :no_release => true } do
       multisites.each_pair do |folder, url|
         # symlinks the appropriate environment's settings.php file
         symlink_config_file
@@ -108,14 +120,14 @@ configuration.load do
       end
    end
    
-   desc <<-DESC
-    Symlinks the appropriate environment's settings file within the proper sites directory
+    desc <<-DESC
+      Symlinks the appropriate environment's settings file within the proper sites directory
     
-    Assumes the environment's settings file will be in one of two formats:
+      Assumes the environment's settings file will be in one of two formats:
         settings.<environment>.php    => new default
         settings.php.<environment>    => deprecated
-   DESC
-   task :symlink_config_file, :roles => :web, :except => { :no_release => true} do
+    DESC
+    task :symlink_config_file, :roles => :web, :except => { :no_release => true} do
      multisites.each_pair do |folder, url|
        drupal_app_site_dir = " #{latest_release}/sites/#{url}"
        
@@ -130,8 +142,8 @@ configuration.load do
      end
    end
 
-   desc "Replace local database paths with remote paths"
-   task :updatedb, :roles => :web, :except => { :no_release => true } do
+    desc "Replace local database paths with remote paths"
+    task :updatedb, :roles => :web, :except => { :no_release => true } do
      multisites.each_pair do |folder, url|
        run "#{drush_bin} -l #{url} -r #{current_path} sqlq \"UPDATE {files} SET filepath = REPLACE(filepath,'sites/#{folder}/files','sites/#{url}/files');\""
      end
@@ -140,7 +152,7 @@ configuration.load do
     desc "Clear all Drupal cache"
     task :clearcache, :roles => :web, :except => { :no_release => true } do
       multisites.each_pair do |folder, url|
-        run "#{drush_bin} -l #{url} -r #{current_path} cache-clear all"
+       run "#{drush_bin} -l #{url} -r #{current_path} cache-clear all"
       end
     end
   
@@ -150,5 +162,96 @@ configuration.load do
         run "chmod 644 #{latest_release}/sites/#{url}/settings.php*"
       end
     end
+
+    desc <<-DESC
+      Secures the ubercart sensitive information (credit card encryption keys)
+      and downloadable files by moving them from the sites file structure in
+      the Drupal root (public) and moving them to the shared directory
+    DESC
+    namespace :ubercart do
+      task :default, :roles => :web, :except => { :no_release => true } do
+        # setup necessary directories within our shared directory
+        setup_ubercart_shared
+
+        # move the sites/*/files/downloadable_products 
+        # to the shared directory via rsync
+        secure_downloadable_files
+
+        # move the sites/*/files/keys
+        # to the shared directory
+        secure_encryption_key
+      end
+
+      desc <<-DESC
+        Creates the ubercart directory within each multisites shared directory structure.
+
+        Example:
+            shared/abc/ubercart
+            shared/xyz/ubercart
+      DESC
+      task :setup_ubercart_shared, :roles => :web, :except => { :no_release => true } do
+        multisites.each_pair do |folder, url|
+          run "mkdir -p #{shared_path}/#{url}/#{uc_root}"
+        end
+      end
+
+      desc <<-DESC
+        Stubbed: Moves downloadable files from the public directory (Drupal root) 
+        to the shared directories
+
+        Example:
+            sites/abc/files/ubercart/products 
+            sites/xyz/files/ubercart/downloadable_products 
+
+          are moved to:
+            shared/abc/ubercart/products 
+            shared/xyz/ubercart/downloadable_products
+      DESC
+      task :secure_downloadable_files, :except => { :no_release => true } do
+        # loop through the multisites and move files
+        multisites.each_pair do |folder, url|
+          run "mkdir -p #{shared_path}/#{url}/#{uc_root}/#{uc_downloadable_products_root}"
+
+          ubercart_dir = "#{latest_release}/sites/#{url}/files/#{uc_root}/#{uc_downloadable_products_root}"
+
+          case true
+            when remote_dir_exists?("#{ubercart_dir}")
+              run "rsync -rltDvzog #{ubercart_dir} #{shared_path}/#{url}/#{uc_root}/#{uc_downloadable_products_root}"
+            else
+              logger.important "Failed to rsync the ubercart downloadable products in #{ubercart_dir} because the directory doesn't exist"
+          end
+
+
+          # update the ubercart's database tracking of where the 
+          # root file path is for downloadable products. This should 
+          # be set as relative to the root of the drupal directory
+          run "#{drush_bin} -l #{url} -r #{latest_release} vset --yes uc_file_base_dir ../../shared/#{url}/#{uc_root}/#{uc_downloadable_products_root}"
+        end
+      end
+
+      desc <<-DESC
+        Stubbed: Moves encryption key files from the public directory (Drupal root) 
+        to the shared directories
+
+        Example:
+            sites/abc/files/ubercart/keys 
+            sites/xyz/files/ubercart/keys 
+
+          are moved to:
+            shared/abc/ubercart/keys 
+            shared/xyz/ubercart/keys
+      DESC
+      task :secure_encryption_key, :roles => :web, :except => { :no_release => true } do
+        # loop through the multisites and move keys
+        multisites.each_pair do |folder, url|
+          run "mkdir -p #{shared_path}/#{url}/#{uc_root}/#{uc_encryption_keys_root}"
+
+          # update the ubercart's database tracking of where the 
+          # root file path is for encryption keys. This should 
+          # be set as relative to the root of the drupal directory
+          run "#{drush_bin} -l #{url} -r #{latest_release} vset --yes uc_credit_encryption_path ../../shared/#{url}/#{uc_root}/#{uc_encryption_keys_root}"
+        end
+      end
+    
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-ash
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 1.1.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000Z
+date: 2011-09-27 00:00:00.000000000Z
 dependencies: []
 description: August Ash recipes for Capistrano
 email: code@augustash.com