octopress-deploy 1.0.0.rc.8 → 1.0.0.rc.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c93a257c3f64bcde00586e19181c10ab9ab2d9
-  data.tar.gz: 00eee66f5704f5be8315653acfaa8551d15c6ee6
+  metadata.gz: 9ef41485f860af0564de3ea78c84c486da797d39
+  data.tar.gz: 588bc538b038234a285f95aaff34f7b38631d5be
 SHA512:
-  metadata.gz: e69984f331b0ed90ffd675d73bb866f90d160a79bc174b8c3aa2990e54f0202d4e1faafb26eee05e40b014f13a890748db999e8e3e57c8123e2c5c9bcdc4cf33
-  data.tar.gz: f9ba5ecfe4ba887c63bc9c48830856f63611ffb5d61209b641e562044b218057b529275b55151e7ec6251306a75472cb0c7b829be04f68f55fa49c746b598763
+  metadata.gz: fe6a2c50c206d7c38d7ed6249701a2751fcc1efa46311ba1108170000e69b401998f23b515e0d5f9e3410066079033af062eed5f580d9528a95efa4f17ded850
+  data.tar.gz: fdd2b7dc8bf51523c018bd0062497993873ef64fc771832eac33df6b560fb8bc8751e9cc80d313a72c2b6ac24c65e319cbc43dab5a2372735a1276c753bd574a

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 
 ## Current version
+###  1.0.0 RC9 - 2014-05-31
+
+- New: S3 header configuration options. [#25](https://github.com/octopress/deploy/issues/25')
+- Fix: `site_dir` defaults to `'_site'`. [#29](https://github.com/octopress/deploy/issues/29')
+- Fix: A Windows OS issue. [#30](https://github.com/octopress/deploy/pull/30).
+
+## Past versions
 
 ###  1.0.0 RC8 - 2014-05-08
 
@@ -16,8 +23,6 @@
 
 - Fixed: CLI options now override config file settings.
 
-## Past versions
-
 ### 1.0.0 RC5 - 2014-04-01
 
 - Fixed: `site_dir` config didn't work.

data/README.md

@@ -77,12 +77,40 @@ account access information.
 | `verbose`           | [optional] Display all file actions during deploy.    | true         |
 | `region`            | [optional] Region for your AWS bucket                 | us-east-1    |
 | `delete`            | Delete files in `remote_path` not found in `site_dir` | false        |
+| `headers`           | Set headers for matched files                         | []           |
 
 If you choose a bucket which doesn't yet exist, Octopress Deploy will offer to create it for you, and offer to configure it as a static website.
 
 If you configure Octopress to delete files, all files found in the `remote_path` on S3 bucket will be removed unless they match local site files.
 If `remote_path` is a subdirectory, only files in that subdirectory will be evaluated for deletion.
 
+
+### S3 Headers
+
+You can create an array of header congifs to set expiration, content and cache settings for any paths matching the `filename`.
+
+| Header Config       | Description                                           | Default
+|:--------------------|:------------------------------------------------------|:-------------|
+| `filename`          | A regex or a substring of the file to match           |              |
+| `site_dir`          | An http date or a number of years or days from now    |              |
+| `content_type`      | A string which is passed through to the headers       |              |
+| `content_encoding`  | A string which is passed through to the headers       |              |
+| `cache_control`     | A string which is passed through to the headers       |              |
+
+Here is how you might set expriation and cache controls for CSS and Javascript files.
+
+```yaml
+headers:
+  - filename: '^assets.*\.js$'
+    expires: '+3 years'
+    cache_control: 'max-age=94608000'
+    content_type: 'application/javascript'
+  - filename: '^assets.*\.css$'
+    expires: '+3 years'
+    cache_control: 'max-age=94608000'
+    content_type: 'text/css'
+```
+
 ### AWS config via ENV
 
 If you prefer, you can store AWS access credentials in environment variables instead of a conifiguration file. 

data/assets/docs/changelog.markdown

@@ -5,6 +5,13 @@ permalink: /changelog/
 
 
 ## Current version
+###  1.0.0 RC9 - 2014-05-31
+
+- New: S3 header configuration options. [#25](https://github.com/octopress/deploy/issues/25')
+- Fix: `site_dir` defaults to `'_site'`. [#29](https://github.com/octopress/deploy/issues/29')
+- Fix: A Windows OS issue. [#30](https://github.com/octopress/deploy/pull/30).
+
+## Past versions
 
 ###  1.0.0 RC8 - 2014-05-08
 
@@ -19,8 +26,6 @@ permalink: /changelog/
 
 - Fixed: CLI options now override config file settings.
 
-## Past versions
-
 ### 1.0.0 RC5 - 2014-04-01
 
 - Fixed: `site_dir` config didn't work.

data/assets/docs/index.markdown

@@ -79,12 +79,40 @@ account access information.
 | `verbose`           | [optional] Display all file actions during deploy.    | true         |
 | `region`            | [optional] Region for your AWS bucket                 | us-east-1    |
 | `delete`            | Delete files in `remote_path` not found in `site_dir` | false        |
+| `headers`           | Set headers for matched files                         | []           |
 
 If you choose a bucket which doesn't yet exist, Octopress Deploy will offer to create it for you, and offer to configure it as a static website.
 
 If you configure Octopress to delete files, all files found in the `remote_path` on S3 bucket will be removed unless they match local site files.
 If `remote_path` is a subdirectory, only files in that subdirectory will be evaluated for deletion.
 
+
+### S3 Headers
+
+You can create an array of header congifs to set expiration, content and cache settings for any paths matching the `filename`.
+
+| Header Config       | Description                                           | Default
+|:--------------------|:------------------------------------------------------|:-------------|
+| `filename`          | A regex or a substring of the file to match           |              |
+| `site_dir`          | An http date or a number of years or days from now    |              |
+| `content_type`      | A string which is passed through to the headers       |              |
+| `content_encoding`  | A string which is passed through to the headers       |              |
+| `cache_control`     | A string which is passed through to the headers       |              |
+
+Here is how you might set expriation and cache controls for CSS and Javascript files.
+
+```yaml
+headers:
+  - filename: '^assets.*\.js$'
+    expires: '+3 years'
+    cache_control: 'max-age=94608000'
+    content_type: 'application/javascript'
+  - filename: '^assets.*\.css$'
+    expires: '+3 years'
+    cache_control: 'max-age=94608000'
+    content_type: 'text/css'
+```
+
 ### AWS config via ENV
 
 If you prefer, you can store AWS access credentials in environment variables instead of a conifiguration file. 

data/lib/octopress-deploy/git.rb

@@ -9,7 +9,7 @@ module Octopress
         @remote      = @options[:remote]       || 'deploy'
         @remote_path = @options[:remote_path]  || ''
         @remote_path = @remote_path.sub(/^\//,'') #remove leading slash
-        @site_dir    = File.expand_path(@options[:site_dir])  || '_site'
+        @site_dir    = File.expand_path(@options[:site_dir]  || '_site')
         @deploy_dir  = File.expand_path(@options[:deploy_dir] || '.deploy')
         @pull_dir    = @options[:dir]
         abort "Deploy Failed: Configure a git_url in #{@options[:config_file]} before deploying.".red if @repo.nil?
@@ -19,7 +19,7 @@ module Octopress
       #
       def push
         init_repo
-        puts "Syncing #{@site_dir.sub(`pwd`.strip+'/', '')} files to #{@repo}."
+        puts "Syncing #{@site_dir.sub(Dir.pwd.strip+'/', '')} files to #{@repo}."
         FileUtils.cd @deploy_dir do
           git_pull
           clean_deploy
@@ -67,7 +67,8 @@ CONFIG
 
             # initialize the repository and add the remote.
             #
-            `git init; git remote add #{@remote} #{@repo}`
+            `git init`
+            `git remote add #{@remote} #{@repo}`
 
             # Attempt to pull from the remote.
             #
@@ -77,9 +78,12 @@ CONFIG
             # If no branch exists on remote, create one locally.
             else
               `echo "initialize deploy repo" > _`
-              `git add .; git commit -m 'initial commit'`
+              `git add .`
+              `git commit -m \"initial commit\"`
               `git branch -m #{@branch}`
-              `git rm _; git add -u; git commit -m 'cleanup'`
+              `git rm _`
+              `git add -u`
+              `git commit -m 'cleanup'`
             end
           end
         end
@@ -110,7 +114,8 @@ CONFIG
         target_dir = File.join(@deploy_dir, @remote_path).sub(/\/$/,'')
         FileUtils.cp_r @site_dir + '/.', target_dir
         message = "Site updated at: #{Time.now.utc}"
-        `git add --all :/; git commit -m '#{message}'`
+        `git add --all :/`
+        `git commit -m \"#{message}\"`
       end
     end
   end

data/lib/octopress-deploy/rsync.rb

@@ -7,7 +7,7 @@ module Octopress
         @flags        = @options[:flags] || ' -avz'
         @user         = @options[:user]
         @port         = @options[:port]
-        @local        = @options[:site_dir]
+        @local        = @options[:site_dir] || '_site'
         @remote_path  = @options[:remote_path]
         @exclude      = @options[:exclude]
         @exclude_file = @options[:exclude_file]

data/lib/octopress-deploy/s3.rb

@@ -12,7 +12,7 @@ module Octopress
           abort "Deploying to S3 requires aws-sdk. Install with `gem install aws-sdk`."
         end
         @options     = options
-        @local       = options[:site_dir]
+        @local       = options[:site_dir]          || '_site'
         @bucket_name = options[:bucket_name]
         @access_key  = options[:access_key_id]     || ENV['AWS_ACCESS_KEY_ID']
         @secret_key  = options[:secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
@@ -20,6 +20,7 @@ module Octopress
         @remote_path = (options[:remote_path]      || '/').sub(/^\//,'')
         @verbose     = options[:verbose]           || true
         @delete      = options[:delete]
+        @headers     = options[:headers]           || []
         @remote_path = @remote_path.sub(/^\//,'')  # remove leading slash
         @pull_dir    = options[:dir]
         connect
@@ -65,9 +66,12 @@ module Octopress
       #
       def write_files
         puts "Writing #{pluralize('file', site_files.size)}:" if @verbose
-        site_files.each do |file| 
-          o = @bucket.objects[remote_path(file)]
-          o.write(file: file)
+        site_files.each do |file|
+          s3_filename = remote_path(file)
+          o = @bucket.objects[s3_filename]
+          file_with_options = get_file_with_metadata(file, s3_filename);
+
+          o.write(file_with_options)
           if @verbose
             puts "+ #{remote_path(file)}"
           else
@@ -76,6 +80,48 @@ module Octopress
         end
       end
 
+      def get_file_with_metadata(file, s3_filename)
+        file_with_options = {:file => file }
+
+        @headers.each do |conf|
+          if conf.has_key? 'filename' and s3_filename.match(conf['filename'])
+            if @verbose
+              puts "+ #{remote_path(file)} matched pattern #{conf['filename']}"
+            end
+
+            if conf.has_key? 'expires'
+              expireDate = conf['expires']
+
+              relative_years = /^\+(\d+) year(s)?$/.match(conf['expires'])
+              if relative_years
+                expireDate = (Time.now + (60 * 60 * 24 * 365 * relative_years[1].to_i)).httpdate
+              end
+
+              relative_days = /^\+(\d+) day(s)?$/.match(conf['expires'])
+              if relative_days
+                expireDate = (Time.now + (60 * 60 * 24 * relative_days[1].to_i)).httpdate
+              end
+
+              file_with_options[:expires] = expireDate
+            end
+
+            if conf.has_key? 'content_type'
+              file_with_options[:content_type] = conf['content_type']
+            end
+
+            if conf.has_key? 'cache_control'
+              file_with_options[:cache_control] = conf['cache_control']
+            end
+
+            if conf.has_key? 'content_encoding'
+              file_with_options[:content_encoding] = conf['content_encoding']
+            end
+          end
+        end
+
+        return file_with_options
+      end
+
       # Delete files from the bucket, to ensure a 1:1 match with site files
       #
       def delete_files
@@ -183,4 +229,3 @@ CONFIG
     end
   end
 end
-

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0.rc.8"
+    VERSION = "1.0.0.rc.9"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.8
+  version: 1.0.0.rc.9
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress