capistrano-s3 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e58eac78f1006adb9c1dc9ee60f4f34443a5a71e
-  data.tar.gz: 7214a8ede096b2186a2f8f526172390f81a3790c
+  metadata.gz: e5c8e41de2db9b9a9963fb2af782cd766617d488
+  data.tar.gz: 285b3124b1ce5173c1c2185070d808aea545bd03
 SHA512:
-  metadata.gz: 146e8d2dfa08cd96f99c6ef87bbb07dbe4f2ff05b38804d1a93c373cbf8ef01721c4630a53f9348e23acd2f7d8c04a9d1423a392760fdc3a9bda3f4ff4a8432e
-  data.tar.gz: 420bcb2f854a5e6c7d507a105228082e54848830c089691d19694fbbdd6b614c0e08011e0147c50d43f86abbfbd1e56d9897fe86635f1dbecaa68e63a56fe1a7
+  metadata.gz: 2099eed41cd7362559ebd64662636f019d32fbad791c4ebd0083c28b42b94d3d8c39485efbe8efc3af6d58b59f327b2f7d82fea719ca0fea654d4cf8a1ca550f
+  data.tar.gz: 23989024c2614fb612e469b02ff315962b31a37a291ef72f770b155dd36f232f1c326c7adfdb5b41b7633f9ac4ee73cfd1b478b1e1b1e205952beb6b0bc668f2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## v2.1.0
+
+Feature : Add option to specify target_path (#35)
+Change : Relax mime-types version requirement (#36)
+
 ## v2.0.0
 
 Major change : AWS SDK dependency was upgragred to 2.6, see migration guide at bottom of README to upgrade from v1.

data/README.md

@@ -87,9 +87,25 @@ with:
 set :region, 'eu-west-1'
 ```
 
+### Deployment path
+
+You can set `deployment_path` to select the **local** path to deploy relative to the project root. Do not use trailing slash. Default value is: `public`.
+
+```ruby
+set :deployment_path, 'dist'
+```
+
+### Target path
+
+You can also set a **remote** path relative to the bucket root using `target_path`. Do not use trailing slash. Default value is empty (bucket root).
+
+```ruby
+set :target_path, 'app'
+```
+
 ### Write options
 
-capistrano-s3 sets files `:content_type` and `:acl` to `:public_read`, add or override with:
+capistrano-s3 sets files `:content_type` and `:acl` to `public-read`, add or override with:
 
 ```ruby
 set :bucket_write_options, {
@@ -111,6 +127,8 @@ set :redirect_options, {
 }
 ```
 
+The `redirect_options` parameter takes `target_path` into account, you can use the same paths regardless of its value.
+
 Valid redirect destination should either start with `http` or `https` scheme,
 or begin with leading slash `/`.
 
@@ -139,6 +157,14 @@ set :distribution_id, "CHANGETHIS"
 set :invalidations, [ "/index.html", "/assets/*" ]
 ```
 
+The CloudFront invalidation feature takes `target_path` into account. Write your invalidations relatively to your `target_path`. For example to invalidate everything inside the remote `app` folder:
+
+```ruby
+set :target_path, "app"
+set :distribution_id, "CHANGETHIS"
+set :invalidations, [ "/*" ]
+```
+
 If you want to wait until the invalidation batch is completed (e.g. on a CI server), you can run `cap <stage> deploy:s3:wait_for_invalidation`. The command will wait indefinitely until the invalidation is completed.
 
 ### Exclude files and directories

data/capistrano-s3.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency 'aws-sdk',    '~> 2.6'
   s.add_runtime_dependency 'capistrano', '>= 2'
-  s.add_runtime_dependency 'mime-types', '~> 1.23'
+  s.add_runtime_dependency 'mime-types'
   s.add_runtime_dependency 'net-ssh',    '~> 2.9'
 
   # Development dependencies

data/lib/capistrano/s3/defaults.rb

@@ -3,7 +3,8 @@ module Capistrano
     module Defaults
       DEFAULTS = {
         :deployment_path      => "public",
-        :bucket_write_options => { :acl => :public_read },
+        :target_path          => "",
+        :bucket_write_options => { :acl => 'public-read' },
         :region               => 'us-east-1',
         :redirect_options     => {},
         :only_gzip            => false,

data/lib/capistrano/s3/publisher.rb

@@ -8,7 +8,7 @@ module Capistrano
       LAST_PUBLISHED_FILE = '.last_published'
       LAST_INVALIDATION_FILE = '.last_invalidation'
 
-      def self.publish!(region, key, secret, bucket, deployment_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
+      def self.publish!(region, key, secret, bucket, deployment_path, target_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
         deployment_path_absolute = File.expand_path(deployment_path, Dir.pwd)
         s3 = self.establish_s3_client_connection!(region, key, secret)
         updated = false
@@ -21,7 +21,7 @@ module Capistrano
             path = self.base_file_path(deployment_path_absolute, file)
             path.gsub!(/^\//, "") # Remove preceding slash for S3
 
-            self.put_object(s3, bucket, path, file, only_gzip, extra_options)
+            self.put_object(s3, bucket, target_path, path, file, only_gzip, extra_options)
           end
         end
 
@@ -34,7 +34,7 @@ module Capistrano
             :invalidation_batch => {
               :paths => {
                 :quantity => invalidations.count,
-                :items => invalidations
+                :items => invalidations.map { |path| File.join('/', target_path, path) }
               },
               :caller_reference => SecureRandom.hex
             }
@@ -105,14 +105,14 @@ module Capistrano
           File.mtime(file) < File.mtime(LAST_PUBLISHED_FILE)
         end
 
-        def self.put_object(s3, bucket, path, file, only_gzip, extra_options)
+        def self.put_object(s3, bucket, target_path, path, file, only_gzip, extra_options)
           base_name = File.basename(file)
           mime_type = mime_type_for_file(base_name)
           options   = {
             :bucket => bucket,
-            :key    => path,
+            :key    => File.join(target_path, path),
             :body   => open(file),
-            :acl    => :public_read,
+            :acl    => 'public-read',
           }
 
           options.merge!(build_redirect_hash(path, extra_options[:redirect]))
@@ -126,7 +126,7 @@ module Capistrano
               options.merge!(build_gzip_content_type_hash(file, mime_type))
 
               # upload as original file name
-              options.merge!(key: self.orig_name(path)) if only_gzip
+              options.merge!(key: File.join(target_path, self.orig_name(path))) if only_gzip
             end
           end
 

data/lib/capistrano/s3/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module S3
-    VERSION = "2.0.0"
+    VERSION = "2.1.0"
   end
 end

data/lib/capistrano/tasks/capistrano_2.rb

@@ -23,7 +23,7 @@ module Capistrano
         task :upload_files do
           extra_options = { :write => bucket_write_options, :redirect => redirect_options }
           S3::Publisher.publish!(region, access_key_id, secret_access_key,
-                             bucket, deployment_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
+                             bucket, deployment_path, target_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
         end
       end
 

data/lib/capistrano/tasks/capistrano_3.rb

@@ -20,7 +20,7 @@ namespace :deploy do
     task :upload_files do
       extra_options = { :write => fetch(:bucket_write_options), :redirect => fetch(:redirect_options) }
       Capistrano::S3::Publisher.publish!(fetch(:region), fetch(:access_key_id), fetch(:secret_access_key),
-                             fetch(:bucket), fetch(:deployment_path), fetch(:distribution_id), fetch(:invalidations), fetch(:exclusions), fetch(:only_gzip), extra_options)
+                             fetch(:bucket), fetch(:deployment_path), fetch(:target_path), fetch(:distribution_id), fetch(:invalidations), fetch(:exclusions), fetch(:only_gzip), extra_options)
     end
   end
 

data/spec/publisher_spec.rb

@@ -10,12 +10,12 @@ describe Capistrano::S3::Publisher do
   context "on publish!" do
     it "publish all files" do
       Aws::S3::Client.any_instance.expects(:put_object).times(8)
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', './spec/sample', 'cf123', [], [], false, {})
+      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], [], false, {})
     end
 
     it "publish only gzip files when option is enabled" do
       Aws::S3::Client.any_instance.expects(:put_object).times(4)
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', 'cf123', [], [], true, {})
+      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], [], true, {})
     end
 
     context "invalidations" do
@@ -23,14 +23,14 @@ describe Capistrano::S3::Publisher do
         Aws::S3::Client.any_instance.expects(:put_object).times(8)
         Aws::CloudFront::Client.any_instance.expects(:create_invalidation).once
 
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample/', 'cf123', ['*'], [], false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', ['*'], [], false, {})
       end
 
       it "publish all files without invalidations" do
         Aws::S3::Client.any_instance.expects(:put_object).times(8)
         Aws::CloudFront::Client.any_instance.expects(:create_invalidation).never
 
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', './spec/sample/', 'cf123', [], [], false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], [], false, {})
       end
     end
 
@@ -39,24 +39,22 @@ describe Capistrano::S3::Publisher do
         Aws::S3::Client.any_instance.expects(:put_object).times(7)
 
         exclude_paths = ['fonts/cantarell-regular-webfont.svg']
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', 'cf123', [], exclude_paths, false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], exclude_paths, false, {})
       end
 
       it "exclude multiple files" do
         Aws::S3::Client.any_instance.expects(:put_object).times(6)
 
         exclude_paths = ['fonts/cantarell-regular-webfont.svg', 'fonts/cantarell-regular-webfont.svg.gz']
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', 'cf123', [], exclude_paths, false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], exclude_paths, false, {})
       end
 
       it "exclude directory" do
         Aws::S3::Client.any_instance.expects(:put_object).times(0)
 
         exclude_paths = ['fonts/**/*']
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', 'cf123', [], exclude_paths, false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', '', 'cf123', [], exclude_paths, false, {})
       end
     end
-
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-s3
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jean-Philippe Doyle
@@ -36,7 +36,7 @@ cert_chain:
   t/JsZnAlWYkJIees2SFV5X/t34oeMu04yY2u9y2YBqKovR97m5YF7zqgx0JODV0x
   ytwUJvEjznBnJV4OoDE=
   -----END CERTIFICATE-----
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -70,16 +70,16 @@ dependencies:
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Build and deploy a static website to Amazon S3