omeka-recipes 0.2.1 → 0.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG

@@ -0,0 +1,23 @@
+## 0.3.0
+
+Additional tasks for deploy for cleaning up, performing git-style upgrades,
+and mapping setup directories for the `#{shared_path}`.
+
+* Travis integration
+* Maintenance pages for system upgrades
+* Seppuku for destroying everything
+
+
+## 0.2.1
+
+This release contained mainly bug fixes and fixed consistency issues with the
+descriptions of individual tasks.
+
+* Ensure '|OmekaRecipes|' surrounds all tasks. Jeremy Boggs (clioweb)
+* Fixes VERSION constant redefinition
+* Added IniFile dependency to gem
+
+## 0.2.0
+
+Initial release of the gem.
+

data/README.md

@@ -1,5 +1,7 @@
 # Omeka::Recipes
 
+[![Build Status](https://secure.travis-ci.org/waynegraham/omeka-recipes.png)](http://travis-ci.org/waynegraham/omeka-recipes)
+
 Useful Capistrano recipes including:
 
 * Create MySQL database and user on server (via prompts)
@@ -9,21 +11,31 @@ Useful Capistrano recipes including:
 
 ## Included Tasks
 
-* `cap apache:reload`
-* `cap apache:restart`
-* `cap apache:start`
-* `cap apache:stop`
-* `cap db:create_ini`
-* `cap db:myql:dump`
-* `cap db:myql:fetch_dump`
-* `cap db:myql:restore`
-* `cap db:mysql:setup`
-* `cap log:rotate`
-* `cap log:tail`
-* `cap omeka:db_ini`
-* `cap omeka:plugins`
-* `cap omeka:themes`
-* `cap symlinks:make`
+* cap apache:reload                 # |OmekaRecipes| Reload Apache
+* cap apache:restart                # |OmekaRecipes| Restart Apache
+* cap apache:start                  # |OmekaRecipes| Start Apache
+* cap apache:stop                   # |OmekaRecipes| Stop Apache
+* cap db:create_ini                 # |OmekaRecipes| Create db.ini in shared pa...
+* cap db:mysql:dump                 # |OmekaRecipes| Performs a compressed data...
+* cap db:mysql:fetch_dump           # |OmekaRecipes| Downloads the compressed d...
+* cap db:mysql:restore              # |OmekaRecipes| Restores the database from...
+* cap db:mysql:setup                # |OmekaRecipes| Create MySQL database and ...
+* cap deploy                        # |OmekaRecipes| Deploy omeka, github-style
+* cap deploy:seppuku                # |OmekaRecipes| Destroys everything
+* cap deploy:setup_dirs             # |OmekaRecipes| Create shared dirs
+* cap deploy:symlink                # |OmekaRecipes| Alias for symlinks:make
+* cap log:rotate                    # |OmekaRecipes| Install log rotation scrip...
+* cap log:tail                      # |OmekaRecipes| Tail all log files
+* cap omeka:db_ini                  # |OmekaRecipes| Add the db.ini to the shar...
+* cap omeka:fix_archive_permissions # |OmekaRecipes| Ensure the archive directo...
+* cap omeka:get_plugins             # |OmekaRecipes| Deploy the plugins defined...
+* cap omeka:get_themes              # |OmekaRecipes| Deploy the themes defined ...
+* cap omeka:link_archive_dir        # |OmekaRecipes| Link the archive directoy ...
+* cap omeka:maintenance:start       # |OmekaRecipes| Add a maitenance page for ...
+* cap omeka:move_archive_dir        # |OmekaRecipes| Move the archive directory...
+* cap omeka:move_files_to_shared    # |OmekaRecipes| Move a pristine copy of th...
+* cap omeka:rename_files            # |OmekaRecipes| Rename files
+* cap symlinks:make                 # |OmekaRecipes| Make all the symlinks in a...`
 
 ## Installation
 
@@ -164,3 +176,4 @@ See the [LICENSE](https://github.com/waynegraham/omeka-recipes/blob/master/LICEN
 
 * Jeremy Boggs ([clioweb](clioweb))
 * Wayne Graham ([waynegraham](https://github.com/waynegraham))
+

data/Rakefile

@@ -1,2 +1,12 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/omeka-recipes/application.rb

@@ -32,7 +32,7 @@ Capistrano::Configuration.instance.load do
     set :rvm_ruby_string, '1.9.3' unless exists?(:rvm_ruby_string)
   end
 
-  set :shared_dirs, %w(archives) unless exists?(:shared_dirs)
+  set :shared_dirs, %w(archive) unless exists?(:shared_dirs)
 
   namespace :app do
     task :setup, :roles => :app do

data/lib/omeka-recipes/deploy.rb

@@ -0,0 +1,30 @@
+Capistrano::Configuration.instance.load do
+  set :shared_children, %w(system logs pids config archive)
+
+  namespace :deploy do
+    desc '|OmekaRecipes| Deploy omeka, github-style'
+    task :default, :roles => :app, :except => { :no_release => true } do
+      update
+    end
+
+
+    desc '|OmekaRecipes| Destroys everything'
+    task :seppuku, :roles => :app, :except => { :no_release => true } do
+      run "rm -rf #{current_path}; rm -rf #{shared_path}"
+    end
+
+    desc '|OmekaRecipes| Create shared dirs'
+    task :setup_dirs, :roles => :app, :except => { :no_release => true } do
+      commands = shared_dirs.map do |path|
+        "mkdir -p #{shared_path}/#{path}"
+      end
+      run commands.join(" && ")
+    end
+
+    desc '|OmekaRecipes| Alias for symlinks:make'
+    task :symlink, :roles => :app, :except => { :no_release => true } do
+      symlinks.make
+    end
+
+  end
+end

data/lib/omeka-recipes/omeka.rb

@@ -39,6 +39,13 @@ Capistrano::Configuration.instance.load do
       run "touch #{shared_path}/db.ini"
     end
 
+    desc '|OmekaRecipes| Move a pristine copy of the archives/files directory to the shared_path'
+    task :move_files_to_shared, :except => { :no_release => true } do
+      #run "touch #{shared_path}/db.ini"
+      run "mkdir -p #{shared_path}/application/logs/"
+      run "touch #{shared_path}/application/logs/erros.log"
+    end
+
     desc '|OmekaRecipes| Deploy the plugins defined in the plugins hash'
     task :get_plugins do
       git_clone(plugins, 'plugins')
@@ -49,11 +56,63 @@ Capistrano::Configuration.instance.load do
       git_clone(themes, 'themes')
     end
 
+    namespace :maintenance do
+      desc <<-DESC
+        |OmekaRecipes| Add a maitenance page for visitors. Disables your Omeka
+        isntance by writing a "#{maintenance_basename}.html" file to each web
+        server. The servers must be configured to detect the presence of the file,
+        and if it is present, display the maintenance page instead of performaning
+        the request.
+
+          $ cap omeka:maintenance:start \\
+            REASON="hardware upgrade" \\
+            UNTIL="12pm EST"
+
+        You can use a different template for the maintenace page by setting the
+        :maintenace_template_path variable in your deploy.rb. The template file
+        should either be a plaintext or an erb file.
+      DESC
+      task :start, :roles => :web, :except => { :no_release => true } do
+        require 'erb'
+        on_rollback { run "rm -f #{shared_path}/system/maintenance.html" }
+
+        warn <<-HTACCESS
+          # Please add something like this to your site's Apache htaccess to redirect users to the maintenance page.
+          # More Info: http://www.shiftcommathree.com/articles/make-your-rails-maintenance-page-respond-with-a-503
+
+          ErrorDocument 503 /system/maintenance.html
+          RewriteEngine On
+          RewriteCond %{REQUEST_URI} !\.(css|gif|jpg|png)$
+          RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
+          RewriteCond %{SCRIPT_FILENAME} !maintenance.html
+          RewriteRule ^.*$  -  [redirect=503,last]
+        HTACCESS
+
+        reason = ENV['REASON']
+        deadline = ENV['UNTIL']
+
+        template = File.read(maintenance_template_path)
+        result = ERB.new(template).result(binding)
+
+        put result, "#{shared_path}/system/maintenance.html", :mode => 0644
+      end
+
+      desc <<-DESC
+      Enables the application web-accessible again. Removes the \n
+      "maintenance.html" page generated by deploy:maitenance:start,
+      which, (if your server is configured properly) will make Omeka web-
+      accessible again.
+      DESC
+      task :end, :roles => :web, :except => { :no_release => true } do
+        run "rm -f #{shared_path}/system/#{maintenance_basename}.html"
+      end
+    end
   end
 
   after 'deploy:cold', 'omeka:fix_archive_permissions', 'omeka:move_archive_dir'
+  after 'deploy:setup', 'omeka:move_files_to_shared'
   #before 'deploy:create_symlink', 'omeka:move_archive_dir'
-  after 'deploy:create_symlink', 'omeka:link_archive_dir'
+  #after 'deploy:create_symlink', 'omeka:link_archive_dir'
   after 'deploy', 'omeka:get_themes', 'omeka:get_plugins', 'omeka:rename_files'
 
 end

data/lib/omeka-recipes/symlinks.rb

@@ -1,6 +1,6 @@
 Capistrano::Configuration.instance.load do
   # these are set to the same structure in shared <=> current
-  set :normal_symlinks, %w(application/logs/ archive) unless exists?(:normal_symlinks)
+  set :normal_symlinks, %w(archive db.ini) unless exists?(:normal_symlinks)
 
   # weird symlinks go somewhere else
   set :weird_symlinks, {'db.ini' => 'db.ini.changeme'} unless exists?( :weird_symlinks )

data/lib/omeka-recipes/version.rb

@@ -1,5 +1,5 @@
 module Omeka
   module Recipes
-    RECIPES_VERSION = "0.2.1"
+    RECIPES_VERSION = "0.3.0"
   end
 end

data/lib/templates/maintenance.html.erb

@@ -0,0 +1,59 @@
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<title>Maintenance</title>
+<style>
+::-moz-selection {
+  background: #b3d4fc;
+  text-shadow: none;
+}
+::selection {
+  background: #b3d4fc;
+  text-shadow: none;
+}
+html {
+  padding: 30px 10px;
+  font-size: 20px;
+  line-height: 1.4;
+  color: #737373;
+  background: #f0f0f0;
+  -webkit-text-size-adjust: 100%;
+  -ms-text-size-adjust: 100%;
+  font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+  max-width: 500px;
+  _width: 500px;
+  padding: 30ps 20px 50px;
+  border: 1px solid #b3b3b3;
+  border-radius: 4px;
+  margin: 0 auto;
+  box-shadow: 0 1px 10px #a7a7a7, inset 0 1px 0 #fff;
+  background: #fcfcfc;
+}
+#container {
+  max-width: 380px;
+  _width: 380px;
+  margin: 0 auto;
+}
+h1 {
+  margin: 0 10px;
+  font-size: 50px;
+  text-align: center;
+}
+p { margin: 1em 0 }
+</style>
+</head>
+<body>
+<div id="container">
+  <h1>The system is down</h1>
+  <p>
+  The system is down for <%= reason ? reason : 'maintenance' %> as of
+  <%= Time.now.strftime("%H:%M %Z") %>.
+  </p>
+
+  <p>
+  It'll be back <%= deadline ? deadline : "shortly" %>.
+  </p>
+</div>
+</body>
+</html>

data/tests/fixtures/config.rb

@@ -0,0 +1,5 @@
+set :application, "foo"
+set :repository, "1/2/#{application}"
+set :gateway, "#{__FILE__}.example.com"
+
+role :web, "www.example.com", :primary => true

data/tests/fixtures/db.ini

@@ -0,0 +1,7 @@
+[database]
+host     = "sds2.itc.virginia.edu"
+username = "ships_user"
+password = "(fB1hg14w43t7811"
+name     = "ships_staging"
+prefix   = "omeka_"
+;port     = "" 

data/tests/fixtures/test.rb

@@ -0,0 +1,24 @@
+
+
+def fetch_db_ini
+  require 'fileutils'
+  require 'IniFile'
+  
+  file_path = "./db.ini"
+  @db_config = IniFile.new(:filename => file_path).to_h
+end
+
+def prepare_from_ini
+puts @db_config['database']['username']
+puts @db_config['database']['password']
+puts @db_config['database']['host']
+puts @db_config['database']['name']
+puts @db_config['database']['prefix']
+puts @db_config['database']['charset']
+
+end
+
+fetch_db_ini
+test = prepare_from_ini
+
+

data/tests/omeka_test.rb

@@ -0,0 +1,8 @@
+require 'omeka-recipes/omeka.rb'
+
+class OmekaTest < Test::Unit::TestCase
+  def setup
+    @config = {}
+    
+  end
+end

data/tests/recipes_test.rb

@@ -0,0 +1,27 @@
+require 'utils'
+require 'capistrano/configuration'
+
+class RecipesTest < Test::Unit::TestCase
+  
+  def setup
+    @config = Capistrano::Configuration.new
+    @config.stubs(:logger).returns(stub_everything)
+  end
+
+
+  def test_current_release_does_not_cause_error_on_dry_run
+    @config.dry_run = true
+    @config.load 'deploy'
+    @config.load do
+      set :application, 'foo'
+      task :dry_run_test do
+        fetch :current_release
+      end
+    end
+
+    assert_nothing_raised do
+      @config.dry_run_test
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omeka-recipes
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -102,6 +102,8 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .rvmrc
+- .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -111,11 +113,18 @@ files:
 - lib/omeka-recipes/apache.rb
 - lib/omeka-recipes/application.rb
 - lib/omeka-recipes/db.rb
+- lib/omeka-recipes/deploy.rb
 - lib/omeka-recipes/log.rb
 - lib/omeka-recipes/omeka.rb
 - lib/omeka-recipes/symlinks.rb
 - lib/omeka-recipes/version.rb
+- lib/templates/maintenance.html.erb
 - omeka-recipes.gemspec
+- tests/fixtures/config.rb
+- tests/fixtures/db.ini
+- tests/fixtures/test.rb
+- tests/omeka_test.rb
+- tests/recipes_test.rb
 homepage: https://github.com/waynegraham/omeka-recipes
 licenses: []
 post_install_message: 
@@ -130,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2626221885588276034
+      hash: 4283888623917739916
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -139,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2626221885588276034
+      hash: 4283888623917739916
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24