jnewland-capsize 0.5.0

data/History.txt

@@ -0,0 +1,18 @@
+== 2007/06/13
+
+* Re-branded Capsize 'Capsize' with 'Capazon' no more...
+* Compatibility w/ Amazon EC2 (amazon-ec2) Gem v. >= 0.2.0
+* Lots of enhancements (See website or README.txt)
+
+== 2007/04/30
+
+* Compatibility w/ Capistrano 2.0
+
+== 2007/03/28
+
+* Fix gem dependancies
+
+== 2007/03/27
+
+* Initial Release
+* Provides Capistrano tasks wrapping the Amazon EC2 API

data/License.txt

@@ -0,0 +1,67 @@
+Copyright (c) 2007-2008 Jesse Newland
+Copyright (c) 2007 Glenn Rempe
+
+This software is distributed under the Ruby License.  A copy of which is
+provided below.
+
+RUBY LICENSE
+
+http://www.ruby-lang.org/en/LICENSE.txt
+
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.co.jp>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+          with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under this terms.
+
+     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
+     files under the ./missing directory.  See each file for the copying
+     condition.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Manifest.txt

@@ -0,0 +1,24 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+examples/capsize.yml.template
+examples/deploy.rb
+lib/capsize.rb
+lib/capsize/capsize.rb
+lib/capsize/configuration.rb
+lib/capsize/ec2.rb
+lib/capsize/ec2_plugin.rb
+lib/capsize/meta_tasks.rb
+lib/capsize/sqs.rb
+lib/capsize/sqs_plugin.rb
+lib/capsize/version.rb
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_capsize.rb
+test/test_helper.rb

data/README.textile

@@ -0,0 +1,78 @@
+h1. Capsize
+
+Capsize provides Capistrano tasks to manage Amazon EC2.
+
+This project is in no way endorsed, sponsored by, or associated with Amazon, Amazon.com, or Amazon Web Services.
+
+h2. Installation
+
+* @gem install jnewland-capsize -s http://gems.github.com@
+* Edit your your @config/deploy.rb@:
+
+<pre>
+<code>
+# #################################################################
+# CAPSIZE EC2 GEM
+# #################################################################
+
+# Include the Capsize EC2 'cap' tasks
+# WARNING : This must be placed in your deploy.rb file anywhere
+# AFTER the line where you set your application name!  Looks like:
+#   set :application, "foobar".
+# The application name is used by Capsize and the order matters.
+require 'capsize'
+
+# Use this to overwrite the standard capsize config dir locations
+#set :capsize_config_dir, 'config/capsize'
+#set :capsize_secure_config_dir, 'config/capsize'
+
+# Use these to overwrite the actual config file names stored in the config dirs.
+#set :capsize_config_file_name, 'capsize.yml'
+#set :capsize_secure_config_file_name, 'secure.yml'
+</code>
+</pre>
+
+* Run @cap deploy:setup@
+* Paste the generated config into @config/deploy.rb@
+
+h2. Tasks
+
+Run cap -e <taskname> on any task to get more details
+
+* cap ec2:console:output
+* cap ec2:images:show
+* cap ec2:instances:reboot
+* cap ec2:instances:run
+* cap ec2:instances:show
+* cap ec2:instances:ssh
+* cap ec2:instances:terminate
+* cap ec2:keypairs:create
+* cap ec2:keypairs:delete
+* cap ec2:keypairs:show
+* cap ec2:security_groups:authorize_ingress
+* cap ec2:security_groups:create
+* cap ec2:security_groups:create_with_standard_ports
+* cap ec2:security_groups:delete
+* cap ec2:security_groups:revoke_ingress
+* cap ec2:security_groups:show
+* cap ec2:setup
+* cap ec2:setup:check
+
+h4. Notes:
+
+* <em>All tasks optionally take environment variables in lieu of capistrano configuration variables.</em>
+
+h4. Contributing
+
+Source is on "GitHub":http://github.com/jnewland/capsize. You know what to do.
+
+h4. Authors
+
+* "Jesse Newland":http://jnewland.com/
+* "Glenn Rempe":http://blog.rempe.us/
+
+h4. Copyright
+
+(c) 2007-2008 Jesse Newland, Glenn Rempe
+
+Distributes under the same terms as Ruby

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'capsize/version'
+
+AUTHOR = ['Jesse Newland','Glenn Rempe']  # can also be an array of Authors
+EMAIL = "jnewland@gmail.com"
+DESCRIPTION = "Capsize is a Capistrano plugin used to provide an easy way to manage and script interaction with the Amazon EC2 service using the amazon-ec2 Ruby gem."
+GEM_NAME = 'capsize' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'capsize' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "grempe"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Capsize::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'capsize documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README.txt",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  p.extra_deps = [['capistrano', '>= 2.1.0'], ['amazon-ec2', '>= 0.2.6'], ['rcov', '>= 0.8.1.2.0'], ['SQS', '>= 0.1.5'], ['builder', '>= 2.1.2'], ['RedCloth', '>= 3.0.4']]
+
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  p.spec_extras = {
+    :extra_rdoc_files => ["README.txt", "History.txt"],
+    :rdoc_options => RDOC_OPTS,
+    :autorequire => "capsize"
+  }
+
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+  %w[rake hoe newgem rubigen].each do |req_gem|
+
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+#require 'capsize'

data/examples/capsize.yml.template

@@ -0,0 +1,67 @@
+# capsize.yml
+
+# Regular Config Info for the Capsize (capsize) gem
+
+# This file should be setup to be deployed by capistrano
+# along with the rest of your application.  This file should only
+# contain non-security related config info and thusly can be
+# safely versioned in your version control system.
+
+# I should be put in the RAILS_ROOT/config/capsize/secure.yml of your Ruby on Rails app
+# or the location of your choice if you override :capsize_config_dir
+
+# set variables in 'common' that are the same across
+# ALL environments.  This helps us keep this file nice and DRY.
+common: &common
+
+  # KEYPAIR CONFIG
+  ##########################################################
+  #defaults to the name of the :application set in deploy.rb
+  #key_name: 'my_cool_key_name'
+
+
+  # CAPSIZE CONFIG
+  ##########################################################
+  # use an ssl connection to talk to EC2? true or false allowed (no quotes)
+  # Defaults to true
+  #use_ssl: true
+
+
+  # SECURITY GROUP CONFIG
+  ##########################################################
+  # Set the default security group to apply firewall ingress rules to.
+  # Defaults, appropriately, to 'default' security group.
+  #group_name: 'default'
+
+  # Set the default security group ip protocol to apply firewall ingress rules to.
+  # Defaults, appropriately, to 'tcp'.
+  #ip_protocol: 'tcp'
+
+  # other options you can override if needed
+  #from_port: nil
+  #to_port: nil
+  #cidr_ip: '0.0.0.0/0'
+  #source_security_group_name: nil
+  #source_security_group_owner_id: nil
+
+
+development:
+  <<: *common
+
+  # Uncomment and I only apply to the dev environment
+  # or overwrite a common value
+  #foo: 'bar'
+
+test:
+  <<: *common
+
+staging:
+  <<: *common
+
+production:
+  <<: *common
+
+  # Uncomment and I only apply to the production environment
+  # or overwrite a common value
+  #foo: 'baz'
+

data/examples/deploy.rb

@@ -0,0 +1,29 @@
+# CAPSIZE 'deploy.rb' SAMPLE
+# Use this as a starting point for what you will need to add to your
+# standard Capistrano deploy.rb file to make it function with Capsize.
+
+# #################################################################
+# CAPSIZE CONFIG SETTINGS
+# #################################################################
+
+# Include the Capsize EC2 'cap' tasks
+# WARNING : This must be placed in your deploy.rb file anywhere 
+# AFTER the line where you set your application name!  Looks like:
+#   set :application, "foobar".
+# The application name is used by Capsize and the order matters!
+require 'capsize'
+
+# Uncomment to override the standard capsize config dir
+# used for standard config info.
+#set :capsize_config_dir, 'config/capsize'
+
+# Uncomment to override location used to store a 
+# secure config file with your AWS credentials,
+# and EC2 private keypair information.
+#set :capsize_secure_config_dir, 'config/capsize'
+
+# Uncomment to override the actual config file names 
+# that are stored in the config dirs noted above.
+#set :capsize_config_file_name, 'capsize.yml'
+#set :capsize_secure_config_file_name, 'secure.yml'
+

data/lib/capsize/capsize.rb

@@ -0,0 +1,101 @@
+module Capsize
+
+  # capsize.get(:symbol_name) checks for variables in several places, with this precedence (from low to high):
+  # * default capistrano or capsize set variables (available with fetch())
+  # * Set in :capsize_config_dir/:capsize_config_file_name (overwrites previous)
+  # * Set in :capsize_config_dir/:capsize_secure_config_file_name (overwrites previous)
+  # * Passed in as part of the command line params and available as ENV["SYMBOL_NAME"] (overwrites previous)
+  #
+  def get(symbol=nil)
+
+    raise Exception if symbol.nil? || symbol.class != Symbol # TODO : Jesse: fixup exceptions in capsize
+
+    # populate the OpenStructs with contents of config files so we can query them.
+    @capsize_config ||= load_config(:config_file => "#{fetch(:capsize_config_dir)}/#{fetch(:capsize_config_file_name)}")
+    @secure_config ||= load_config(:config_file => "#{fetch(:capsize_secure_config_dir)}/#{fetch(:capsize_secure_config_file_name)}")
+
+    # fetch var from default capsize or default capistrano config vars,
+    # and if it doesn't exist set it to nil
+    set symbol, fetch(symbol, nil)
+
+    # if symbol exists as a var in the secure config, then set it to that
+    # overriding default cap or capsize config vars
+    if @secure_config.respond_to?(symbol)
+      set symbol, @secure_config.send(symbol)
+    end
+
+    # if symbol exists as a var in the standard capsize config, then set it to that
+    # overriding secure config vars
+    if @capsize_config.respond_to?(symbol)
+      set symbol, @capsize_config.send(symbol)
+    end
+
+    # if ENV["SYMBOL_NAME"] isn't nil set it to ENV["SYMBOL_NAME"]
+    # ENV vars passed on the command line override any previously defined vars
+    unless ENV[symbol.to_s.upcase].nil?
+      set symbol, ENV[symbol.to_s.upcase]
+    end
+
+    # Some config values should fall back to reasonable defaults.
+    # If we didn't find a value set in any config anywhere, then we should
+    # set a reasonable default value for these special cases.  It is better to
+    # do this in this one place instead of specifying fallbacks all over the place
+    # in the app.  Helps keep it DRY.
+    case symbol
+    when :group_name
+      # the :group_name should fall back to the application name if not provided.
+      if fetch(:group_name, nil).nil?
+        set symbol, fetch(:application)
+      end
+    when :key_name
+      # the :key_name should fall back to the application name if not provided.
+      if fetch(:key_name, nil).nil?
+        set symbol, fetch(:application)
+      end
+    when :group_description
+      # the :group_description should fall back to the application name if not provided.
+      if fetch(:group_description, nil).nil?
+        set symbol, fetch(:application)
+      end
+    end
+
+
+    # If we have a good set variable then return that variable, else send back a nil
+    # if that's what we get and let the calling method either raise an exception
+    # or determine how to gracefully handle it.  We don't want to raise an exception every
+    # time a get fails.  nil might be just fine as an answer for some questions.
+    return fetch(symbol)
+
+  end
+
+
+  # load specified ":config_file => 'foo.yaml'" into a OpenStruct object and return it.
+  def load_config(options = {})
+    options = {:config_file => ""}.merge(options)
+
+    raise Exception, "Config file location required" if options[:config_file].nil? || options[:config_file].empty?
+
+    if File.exist?(options[:config_file])
+
+      # try to load the yaml config file
+      begin
+        config = OpenStruct.new(YAML.load_file(options[:config_file]))
+        env_config =  OpenStruct.new(config.send(deploy_env))
+      rescue Exception => e
+        env_config = nil
+      end
+
+      # Send back an empty OpenStruct if we can't load the config file.
+      # config files are not required!  Want to avoid method calls on nil
+      # if there are no config files to load.
+      if env_config.nil?
+        return OpenStruct.new
+      else
+        return env_config
+      end
+
+    end
+  end
+end
+
+Capistrano.plugin :capsize, Capsize

data/lib/capsize/configuration.rb

@@ -0,0 +1,44 @@
+Capistrano::Configuration.instance.load do
+
+  # Set reasonable defaults for all needed values so in theory this Cap plugin
+  # will work out-of-the-box with no external config required.  Users
+  # can also opt to set any of these in their deploy.rb file to override them.
+
+  set :capsize_config_dir, 'config/capsize'
+  set :capsize_secure_config_dir, 'config/capsize'
+
+  set :capsize_config_file_name, 'capsize.yml'
+  set :capsize_secure_config_file_name, 'secure.yml'
+
+  # Where are the various extra capsize files stored?  Make them easy to get() or override
+  set :capsize_examples_dir, "#{File.join(File.dirname(__FILE__), '/../../examples')}"
+  set :capsize_bin_dir, "#{File.join(File.dirname(__FILE__), '/../../bin')}"
+
+  # Determine where we will deploy to.  if TARGET is not specified
+  # then setup for 'production' environment by default.
+  # TODO : CHANGE THIS TO TARGET_ENV IN HERE AND AMAZON-EC2, and in my app
+  # TODO : Make this work with capistrano-ext
+  set :deploy_env, ENV['TARGET'] ||= "production"
+
+  # defaults for new security groups
+  set :group_name, nil
+  set :group_description, "Default security group for the application."
+
+  set :ip_protocol, 'tcp'
+  set :from_port, nil
+  set :to_port, nil
+  set :cidr_ip, '0.0.0.0/0'
+  set :source_security_group_name, nil
+  set :source_security_group_owner_id, nil
+
+  set :image_id, nil
+  set :min_count, 1
+  set :max_count, 1
+  set :instance_type, 'm1.small'
+# FIXME : Breaks loading of this file and tests
+#  set :key_name, "#{application}"
+#  set :queue_name, "#{application}"
+  set :user_data, nil
+  set :addressing_type, 'public'
+
+end