aws_tools 0.0.1 → 0.0.2

data/Manifest

@@ -1,6 +1,8 @@
 MIT-LICENSE
-Manifest
 README.rdoc
 Rakefile
+aws_tools.gemspec
 lib/aws_tools.rb
+lib/aws_tools/ec2.rb
 lib/aws_tools/s3.rb
+Manifest

data/README.rdoc

@@ -8,30 +8,12 @@ To install, run
     
     $ sudo gem install aws_tools
 
-= Examples
-
-    require 'rubygems'
-    require 'right_aws'
-    require 'aws_tools'
-
-    # Connect to S3 and synchronize all buckets.
-    AwsTools::S3::Synchronize.new(RightAws::S3.new(access_key,
-                                                   secret_access_key,
-                                                   :backup_suffix => "-dr",
-                                                   :backup_location => :eu)
-
-    View the documentation for more information.
-
 = Documentation 
 
 You can generate documentation if you have the source by typing:
 
     rake doc
 
-= Release Notes
-
-First release.
-
 = Credits
 
 AwsTools is maintained by {Christopher Meiklejohn}[mailto:cmeik@me.com].  Contact me if you'd like to request any features or have any questions or feedback.

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('aws_tools', '0.0.1') do |p|
+Echoe.new('aws_tools', '0.0.2') do |p|
   p.description = "A library to help simplify common AWS tasks."
   p.url = "http://github.com/cmeiklejohn/aws_tools"
   p.author = "Christopher Meiklejohn"

data/aws_tools.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{aws_tools}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christopher Meiklejohn"]
-  s.date = %q{2010-02-25}
+  s.date = %q{2010-02-27}
   s.description = %q{A library to help simplify common AWS tasks.}
   s.email = %q{cmeik@me.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/aws_tools.rb", "lib/aws_tools/s3.rb"]
-  s.files = ["MIT-LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/aws_tools.rb", "lib/aws_tools/s3.rb", "aws_tools.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/aws_tools.rb", "lib/aws_tools/ec2.rb", "lib/aws_tools/s3.rb"]
+  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "aws_tools.gemspec", "lib/aws_tools.rb", "lib/aws_tools/ec2.rb", "lib/aws_tools/s3.rb", "Manifest"]
   s.homepage = %q{http://github.com/cmeiklejohn/aws_tools}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Aws_tools", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/lib/aws_tools.rb

@@ -8,26 +8,18 @@
 # Copyright:: Copyright (c) 2010 Christopher Meiklejohn
 # License:: Distributes under the terms specified in the MIT-LICENSE file.
 #
-# Usage example:
+# Documentation coming soon.
 #
-# # Connect to S3 and synchronize all buckets.
-# AwsTools::S3::Synchronize.new(RightAws::S3.new(access_key,
-#                                                secret_access_key,
-#                                                :backup_suffix => "-dr",
-#                                                :backup_location => :eu)
-#
-#
-require 'rubygems'
-require 'right_aws'
-
 $:.unshift(File.dirname(__FILE__))
+
 require 'aws_tools/s3'
+require 'aws_tools/ec2'
 
 module AwsTools #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY = 1
+    TINY = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/aws_tools/ec2.rb

@@ -0,0 +1,150 @@
+#!/usr/bin/ruby 
+#
+# AwsTools::Ec2
+#
+# Author:: Christopher Meiklejohn (cmeik@me.com)
+# Copyright:: Copyright (c) 2010 Christopher Meiklejohn
+# License:: Distributes under the terms specified in the MIT-LICENSE file.
+#
+# Documentation coming soon.
+#
+module AwsTools
+  class Ec2
+    class Helpers
+
+      # SynchronizeS3Buckets
+      # 
+      # Documentation coming soon.
+      class SynchronizeS3Buckets
+
+        # Accessors for everything we might need to specify.  
+        # Refactor this eventually back into AwsTools::Ec2 or 
+        # AwsTools::Ec2::Helpers
+        attr_accessor :min_count,
+                      :max_count,
+                      :security_group,
+                      :key_name,
+                      :addressing_type,
+                      :instance_type,
+                      :kernel_id,
+                      :ramdisk_id,
+                      :availability_zone,
+                      :monitoring_enabled,
+                      :subnet_id,
+                      :disable_api_termination,
+                      :instance_initiated_shutdown_behavior,
+                      :block_device_mappings
+
+        # Initalizer.
+        #
+        # Required parameters:
+        #
+        # ec2:     authenticated rightaws ec2 instance to launch the 
+        #          instance from
+        # ami:     ami to use to perform the backup
+        #
+        # access_key:        access key to use for s3 inside of instance
+        #
+        # secret_access_key: secret access key to use for s3 inside of
+        #                    instance
+        # 
+        def initialize(ec2, 
+                       ami, 
+                       access_key, 
+                       secret_access_key, 
+                       options = {}) 
+          puts "AwsTools::Ec2::Helpers::SynchronizeS3Buckets " +
+               "initialize"
+  
+          @ec2 =                ec2
+          @ami =                ami
+          @access_key =         access_key
+          @secret_access_key =  secret_access_key
+  
+          options.each_pair do |key, value| 
+            self.send("#{key}=", value)
+          end
+
+          setup_defaults
+          launch_instance
+        end
+
+        private
+  
+        # Setup defaults for EC2 instance
+        #
+        # Refactor this eventually back into AwsTools::Ec2 or 
+        # AwsTools::Ec2::Helpers right_was run_instances requires these 
+        # as arguments, but launch_instances takes a option hash.  
+        # Investigate migrating to launch_instances, which 
+        # seems the less recommended way for launching instances
+        #
+        def setup_defaults
+          @min_count = 1                  if @min_count.blank?
+          @max_count = 1                  if @max_count.blank?
+          @security_group = 'default'     if @security_group.blank?
+          @key_name = 'default'           if @key_name.blank?
+          @addressing_type = 'public'     if @addressing_type.blank?
+          @instance_type = 'm1.small'     if @instance_type.blank?
+          # @kernel_id = nil              if @kernel_id.blank?
+          # @ramdisk_id = nil             if @ramdisk_id.blank?
+          # @availability_zone = nil      if @availability_zone.blank?
+          # @monitoring_enabled = nil     if @monitoring_enabled.blank?
+          # @subnet_id = nil              if @subnet_id.blank?
+          # @disable_api_termination = nil 
+          #                 if @disable_api_termination.blank?
+          # @instance_initiated_shutdown_behavior = nil 
+          #                 if @instance_initiated_shutdown_behavior.blank?
+          # @block_device_mappings = nil  if @block_device_mappings.blank?
+        end
+
+        # Define script data to execute
+        # Refactor this to use remote workling at some point
+        def user_data
+          "#!/bin/sh
+
+/usr/bin/ruby <<EOF
+
+require 'rubygems'
+require 'right_aws'
+require 'aws_tools'
+
+AwsTools::S3::Synchronize.new(
+  RightAws::S3.new('#{@access_key}',
+                   '#{@secret_access_key}'),
+                   :backup_suffix => '-backup', 
+                   :backup_location => :'eu') 
+
+EOF
+          
+          shutdown now -h
+          "
+        end
+
+        # Launch ec2 instance
+        def launch_instance
+          puts "AwsTools::Ec2::Helpers::SynchronizeS3Buckets " +
+               "launch_instance"
+
+          # Run the instance via right_aws
+          @ec2.run_instances(@ami, 
+                             @min_count,
+                             @max_count,
+                             @security_group, 
+                             @key_name,
+                             user_data,
+                             @addressing_type,
+                             @instance_type,
+                             @kernel_id,
+                             @ramdisk_id,
+                             @availability_zone,
+                             @monitoring_enabled,
+                             @subnet_id,
+                             @disable_api_termination,
+                             @instance_initiated_shutdown_behavior,
+                             @block_device_mappings)
+        end
+      end
+    end
+  end
+end

data/lib/aws_tools/s3.rb

@@ -1,23 +1,48 @@
 #!/usr/bin/ruby 
-
-require 'rubygems'
-require 'right_aws'
+#
+# AwsTools::S3
+#
+# Author:: Christopher Meiklejohn (cmeik@me.com)
+# Copyright:: Copyright (c) 2010 Christopher Meiklejohn
+# License:: Distributes under the terms specified in the MIT-LICENSE file.
+#
+# Documentation coming soon.
+#
 
 module AwsTools
+  # S3
+  #
+  # Provides an interface to common S3 administration utilties.
   class S3
+
     # Bucket class.
     #
     # Knows how to perform synchronization of all assets 
-    # in one bucket.
+    # in one bucket.  Synchronization is one way, source to destination
+    # only.  
     class Bucket
+
       # Synchronize.
       #
       # Performs the synchronization of one bucket.
+      #
+      # One way synchronization, source to destination based on 
+      # modification time.
+      #
       class Synchronize
-        attr_accessor :bucket, :backup_bucket
 
-        def initialize(options = {})
-          puts "AwsTools::S3::Bucket::Synchronize called."
+        # Initializer.
+        #
+        # Required parameters:
+        #
+        # bucket:         source bucket
+        # backup_bucket:  destination bucket
+        #
+        def initialize(bucket, backup_bucket, options = {})
+          puts "AwsTools::S3::Bucket::Synchronize initialize"
+
+          @bucket =         bucket
+          @backup_bucket =  backup_bucket
 
           options.each_pair do |key, value| 
             self.send("#{key}=", value)
@@ -30,44 +55,53 @@ module AwsTools
 
         # Peform synchronization of one bucket.
         def perform_synchronization
-          puts "AwsTools::S3::Bucket::Synchronize synchronizing #{bucket.name} to " +
-               "#{backup_bucket.name}"
+          puts "AwsTools::S3::Bucket::Synchronize " + 
+               "perform_synchronization #{@bucket.name} " + 
+               "#{@backup_bucket.name}"
 
-          bucket.keys.each do |source_key| 
+          # Iterate through the bucket.
+          @bucket.keys.each do |source_key| 
 
             # Look for destination key.
-            destination_key = RightAws::S3::Key.create(backup_bucket, source_key.to_s)
+            destination_key = RightAws::S3::Key.create(@backup_bucket, 
+                                                       source_key.to_s)
     
             # If it exists...
             if destination_key.exists?
 
-              puts "AwsTools::S3::Bucket::Synchronize destination file #{source_key.to_s} " + 
-                   "already exists"
+              puts "AwsTools::S3::Bucket::Synchronize " +
+                   "perform_synchronization " + 
+                   "#{source_key.to_s} exists!"
 
               # Grab headers.
               source_key.head
               destination_key.head
 
               # Get last modified
-              source_date = Time.parse(source_key.headers["last-modified"])
-              destination_date = Time.parse(destination_key.headers["last-modified"])
+              source_date = Time.parse(
+                source_key.headers["last-modified"])
+              destination_date = Time.parse(
+                destination_key.headers["last-modified"])
 
               # Copy if the destination is older than the source
               if source_date > destination_date 
-                puts "AwsTools::S3::Bucket::Synchronize destination file #{source_key.to_s} " + 
-                     "is older"
+                puts "AwsTools::S3::Bucket::Synchronize " + 
+                     "perform_synchronization " + 
+                     "#{source_key.to_s} older!"
 
                 # Perform a copy of the object.
                 source_key.copy(destination_key)
        
                 # Check if it worked...
                 if destination_key.exists?
-                  puts "AwsTools::S3::Bucket::Synchronize destination file #{source_key.to_s} " + 
-                       "replaced with newer copy"
+                  puts "AwsTools::S3::Bucket::Synchronize " +
+                       "perform_synchronization " + 
+                       "#{source_key.to_s} replaced!"
                 end
               else 
-                puts "AwsTools::S3::Bucket::Synchronize destination file #{source_key.to_s} " + 
-                     "is up to date"
+                puts "AwsTools::S3::Bucket::Synchronize " +
+                     "perform_synchronization " + 
+                     "#{source_key.to_s} current!"
               end
 
             else
@@ -77,8 +111,9 @@ module AwsTools
        
               # Check if it worked...
               if destination_key.exists?
-                puts "AwsTools::S3::Bucket::Synchronize destination file #{source_key.to_s} " + 
-                     "successfully created"
+                puts "AwsTools::S3::Bucket::Synchronize " +
+                     "perform_synchronization " + 
+                     "#{source_key.to_s} created!"
               end
 
             end
@@ -93,13 +128,17 @@ module AwsTools
     #
     # Performs synchronization of every bucket in an S3 account.
     #
-    # Assume that you will be synchronizing to a bucket with a suffix located 
-    # in another zone (since names need to be unique across all zones.
+    # Assume that you will be synchronizing to a bucket with a suffix 
+    # located in another zone
+    # (since names need to be unique across all zones).
+    #
     class Synchronize
-      attr_accessor :backup_suffix, :backup_location
+      attr_accessor :backup_perms,
+                    :backup_suffix, 
+                    :backup_location
 
       def initialize(s3, options = {}) 
-        puts "AwsTools::S3::Synchronize called."
+        puts "AwsTools::S3::Synchronize initialize"
 
         @s3 = s3
 
@@ -107,34 +146,47 @@ module AwsTools
           self.send("#{key}=", value)
         end
 
+        setup_defaults
         perform_synchronization
       end
 
-      private 
+      private
+
+      # Setup defaults for S3 backups
+      #
+      def setup_defaults
+        @backup_perms =     "public-read"  if @backup_perms.blank?
+        @backup_suffix =    "-backup"      if @backup_suffix.blank?
+        @backup_location =  "eu"           if @backup_location.blank?
+      end
 
       # Retrieve all buckets, and synchronize them one by one.
       def perform_synchronization
         # Retrieve bucket list.
         @s3.buckets.each do |bucket| 
-          puts "AwsTools::S3::Synchronize assesing bucket #{bucket.name}"
+          puts "AwsTools::S3::Synchronize " +
+               "perform_synchronization #{bucket.name} (#{bucket.location})"
 
           # If the bucket is located in the normal zone, assume this
           # is a bucket we want to create a backup of.
           if bucket.location.empty?
             
             # Backup bucket.
-            backup_bucket_name = "#{bucket.name}#{backup_suffix}"
+            backup_bucket_name = "#{bucket.name}#{@backup_suffix}"
            
-            puts "AwsTools::S3::Synchronize #{bucket.name} will be synchronized " + 
-                 "to #{backup_bucket_name} in #{backup_location}"
+            puts "AwsTools::S3::Synchronize " + 
+                 "perform_synchronization #{bucket.name} " +
+                 "(#{bucket.location}) will be " +
+                 "synchronized to #{backup_bucket_name} " + 
+                 "(#{@backup_location})"
 
             backup_bucket = @s3.bucket("#{backup_bucket_name}",
                                        true,
-                                       'public-read',
-                                       :location => backup_location)
+                                       @backup_perms,
+                                       :location => @backup_location)
 
-            AwsTools::S3::Bucket::Synchronize.new(:bucket => bucket, 
-                                                  :backup_bucket => backup_bucket)
+            AwsTools::S3::Bucket::Synchronize.new(bucket, 
+                                                  backup_bucket)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aws_tools
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Christopher Meiklejohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-25 00:00:00 -05:00
+date: 2010-02-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -22,15 +22,17 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 - lib/aws_tools.rb
+- lib/aws_tools/ec2.rb
 - lib/aws_tools/s3.rb
 files: 
 - MIT-LICENSE
-- Manifest
 - README.rdoc
 - Rakefile
+- aws_tools.gemspec
 - lib/aws_tools.rb
+- lib/aws_tools/ec2.rb
 - lib/aws_tools/s3.rb
-- aws_tools.gemspec
+- Manifest
 has_rdoc: true
 homepage: http://github.com/cmeiklejohn/aws_tools
 licenses: []