s3deploy 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # S3deploy
 
-TODO: Write a gem description
+S3deploy is a tool for deploying static websites to Amazon S3.
 
 ## Installation
 
@@ -18,9 +18,38 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Get an Amazon AWS account and create the bucket you want to use. Set up the bucket to be used as a website.
+
+### Create configuration files
+
+Create a folder configuration file like this:
+
+    $ s3deploy init
+
+Then update the newly created .s3deploy.yml with your settings.
+You might want to create a default configuration file where you can store information shared between sites, like Amazon access key, secret and region. You do that with this command:
+
+    $ s3deploy init --default
+  
+This configuration file will be created in your home directory in the .s3deploy folder. Update this file with your info, remember that the settings in the .s3deploy.yml in the project folder takes precedance over settings in this file.
+
+### Deployment
+
+Deploying is easy now, just type:
+
+    $ s3deploy
+
+If you want to test-drive your configuration you can simulate a deploy
+
+    $ s3deploy simulate
+
+## Whats in the pipe-line
+1. Setting caching-headers by regex
+2. Skipping files by regex
+3. Putting it on github for others to contribute
 
 ## Contributing
+(you cant do this riktigt now, but it will be on the githubz soon)
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/bin/s3deploy

@@ -2,13 +2,32 @@
 
 require "s3deploy"
 
-puts "This is a pre-release but expect something more within a week or so :)"
-
-if ARGV.empty?
-  s3deploy = S3deploy.new
-  s3deploy.deploy
-elsif ARGV.first == "init"
-  S3deploy.install_config(ARGV.include? "--default")
-else
-  puts "Nope, no command."
+begin
+  if ARGV.empty?
+    unless S3deploy.config_files?
+      raise "Create config files first with 's3deploy init' or 's3deploy init --default'."
+    end
+    s3deploy = S3deploy.new
+    s3deploy.deploy
+  elsif ARGV.first == "init"
+    S3deploy.install_config(ARGV.include? "--default")
+  elsif ARGV.first == "simulate"
+    s3deploy = S3deploy.new
+    s3deploy.deploy(true)
+  else
+    puts <<-eos
+  S3deploy usage.
+
+  s3deploy init (creates folder configuration)
+  s3deploy init --default (creates default configuration)
+
+  s3deploy (deploys the site to Amazon S3)
+  s3deploy simulate (simulates a deployment of the site to Amazon S3)
+  
+  Folder configurations takes precedence over default configurations.
+  I put my aws key, secret and region in default and the rest in folder.
+            eos
+  end
+rescue Exception => e
+  puts e.message
 end

data/lib/.s3deploy.yml

@@ -1,9 +1,17 @@
 ---
-aws_key:
-aws_secret:
-aws_bucket:
-aws_region:
+aws_key:      # your amazon key                   *required*
+aws_secret:   # your amazon secret                *required*
+aws_bucket:   # the bucket you want to deploy to  *required*
+#aws_region:  # the region where your bucket is located
+              # region names are: (blank for US Standard)
+              #     us-west-2         US West (Oregon)
+              #     us-west-1         US West (Northern California)
+              #     eu-west-1         EU (Ireland)
+              #     ap-southeast-1    Singapore ( Asia Pacific )
+              #     ap-northeast-1    Tokyo ( Asia Pacific )
+              #     sa-east-1         South America (Sao Paulo)
+#path:        # the relative path to the files you want to deploy, leave it blank for current directory.
+#remote_path: # the path within the bucket to where you want to deploy, leave it blank for bucket root.
 extras:
-  - delete_old_files
-  - replace_with_gzip
-  - ssl
+  #- delete_old_files    # deletes files that were in the bucket but not in the latest deploy
+  #- replace_with_gzip   # replaces files with gz versions if they exist

data/lib/s3deploy/version.rb

@@ -1,3 +1,3 @@
 class S3deploy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/s3deploy.rb

@@ -1,17 +1,24 @@
 require "s3deploy/version"
 require "AWS/S3"
+require "digest/md5"
+require "yaml" unless defined? YAML
 
 class S3deploy
 
   AWS_REGIONS = %W(us-west-2 us-west-1 eu-west-1 ap-southeast-1 ap-northeast-1 sa-east-1)
 
+  def self.config_files?
+    File.exists?( File.expand_path "~/.s3deploy/.s3deploy.yml" ) || File.exists?( File.expand_path "./.s3deploy.yml" )
+  end
+
   def initialize(options = {})
     defaults = { "path" => ".", "remote_path" => "" }
     @options = defaults.merge(options)
     @options.merge! import_settings(File.expand_path("~/.s3deploy/.s3deploy.yml"))
     @options.merge! import_settings(File.expand_path("./.s3deploy.yml"))
 
-    puts @options
+    @options["extras"] ||= []
+
     raise "No AWS credentials given." unless @options["aws_key"] && @options["aws_secret"]
 
     set_aws_region(@options["aws_region"]) if @options["aws_region"]
@@ -20,32 +27,79 @@ class S3deploy
       :access_key_id     => @options["aws_key"],
       :secret_access_key => @options["aws_secret"]
     )
-
-    puts "Will deploy to #{@options["aws_bucket"]}"
   end
 
-  def deploy
+  def deploy(simulate = false)
 
     raise "No bucket selected." unless @options["aws_bucket"]
-    bucket = AWS::S3::Bucket.find @options["aws_bucket"]
+    @bucket = AWS::S3::Bucket.find @options["aws_bucket"]
 
     path = File.expand_path(@options["path"])
-    puts "path: #{path}"
     raise "#{@options["path"]} is not a path." unless File.directory? path
 
-    files = all_files(path).map { |f| f.gsub(/^#{path}\//, "")}
+    puts "Deploying to #{@options["aws_bucket"]}"
 
+    files = all_files(path).map { |f| f.gsub(/^#{path}\//, "")}
+    skip_files = []
+    active_files = []
     files.each do |file|
+      next if skip_files.include? file
+
       full_path = (path + "/" + file).gsub( /\/\//, "/")
       full_remote_path = (@options["remote_path"] + "/" + file).gsub( /\/\//, "/").gsub( /(^\/)|(\/$)/, "")
-      upload_file(full_path, full_remote_path)
+
+      if @options["extras"].include?("replace_with_gzip") && has_gzip_version?(file, files)
+        full_path.gsub!(/.gz$/, "")
+        file.gsub!(/.gz$/, "")
+        full_remote_path.gsub!(/.gz$/, "")
+        skip_files << file << file + ".gz"
+        if is_gzip_smaller?(full_path)
+          file = file + ".gz"
+          full_path = full_path + ".gz"
+        end
+      end
+
+      active_files << full_remote_path
+
+      if s3_file_exists?(full_path, full_remote_path)
+        puts "Skipped\t\t#{full_remote_path}"
+        next
+      end
+
+      upload_file(full_path, full_remote_path, simulate)
+    end
+
+    only_keep(active_files, simulate) if @options["extras"].include?("delete_old_files")
+
+  end
+
+  def has_gzip_version?(file, files)
+    (file !~ /.+.gz$/ && files.include?("#{file}.gz")) || ( file =~ /.+.gz$/ && files.include?( file.gsub(/.gz$/, "") ) )
+  end
+
+  def is_gzip_smaller?(full_path)
+    open("#{full_path}.gz").size < open("#{full_path}").size
+  end
+
+  def only_keep(active_files, simulate)
+    @bucket.each do |o|
+      unless active_files.include?( o.key )
+        AWS::S3::S3Object.delete(o.key, @options["aws_bucket"]) unless simulate
+        puts "Deleted\t\t#{o.key}"
+      end
     end
+  end
 
+  def s3_file_exists?(local, remote)
+    md5 = Digest::MD5.hexdigest(open(local).read)
+    !@bucket.objects.select{|o| o.key == remote && o.etag == md5 }.empty?
   end
 
-  def upload_file(local, remote)
-    AWS::S3::S3Object.store(remote, open(local), @options["aws_bucket"])
-    puts "Uploading #{local} to #{remote}"
+  def upload_file(local, remote, simulate, options = {})
+    options[:access] = :public_read
+    options[:"Content-Encoding"] = "gzip" if local =~ /.+.gz$/
+    AWS::S3::S3Object.store(remote, open(local), @options["aws_bucket"], options) unless simulate
+    puts "Uploaded\t#{remote}"
   end
 
   def self.install_config(default = false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: s3deploy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-s3