capistrano-s3 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb5552bb93390a37dfef42b1c2f04ab86f8c24b2
-  data.tar.gz: 7e90088960110cc77b870709ab8e1b7cc1d00af0
+  metadata.gz: e58eac78f1006adb9c1dc9ee60f4f34443a5a71e
+  data.tar.gz: 7214a8ede096b2186a2f8f526172390f81a3790c
 SHA512:
-  metadata.gz: 96b33af80859e1be1a7df56b268d6f8f6bf6a9061c16fd006ff4d2d702571bbfaa36803a7bc228db9385d088ac6cacc3b6a3e5dcbd35400467f00da5ac88ec05
-  data.tar.gz: aaeec8a903a3e4e1c1d44246108217e33b6a80046df824ed12a86b71e90c4ddb84941166b9c1465f37eed448e5c0ad85d6c87e7b9a7e85e18ef95db26884388f
+  metadata.gz: 146e8d2dfa08cd96f99c6ef87bbb07dbe4f2ff05b38804d1a93c373cbf8ef01721c4630a53f9348e23acd2f7d8c04a9d1423a392760fdc3a9bda3f4ff4a8432e
+  data.tar.gz: 420bcb2f854a5e6c7d507a105228082e54848830c089691d19694fbbdd6b614c0e08011e0147c50d43f86abbfbd1e56d9897fe86635f1dbecaa68e63a56fe1a7

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 .last_published
-Gemfile.lock
+.last_invalidation
+Gemfile.lock

data/.travis.yml

@@ -1,3 +1,7 @@
+notifications:
+  email:
+    on_success: never
+    on_failure: change
 language: ruby
 dist: trusty
 bundler_args: --without debug release

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v2.0.0
+
+Major change : AWS SDK dependency was upgragred to 2.6, see migration guide at bottom of README to upgrade from v1.
+Feature : Add wait_for_invalidation task (#32) @exoszajzbuk
+Improvement : Simpler way to set deployment_path (#33) @j15e
+
 ## v1.2.0
 
 Feature : Add exclusions (#30) @exoszajzbuk

data/README.md

@@ -77,14 +77,14 @@ Add content to your public folder and run deploy command:
 
 ## Advanced options
 
-### Custom endpoint
+### Custom region
 
 If your bucket is not in the default US Standard region,
-set [endpoint](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
+set [region](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)
 with:
 
 ```ruby
-set :s3_endpoint, 's3-eu-west-1.amazonaws.com'
+set :region, 'eu-west-1'
 ```
 
 ### Write options
@@ -139,6 +139,8 @@ set :distribution_id, "CHANGETHIS"
 set :invalidations, [ "/index.html", "/assets/*" ]
 ```
 
+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
 
 You can set a list of files or directories to exclude from upload. The path must relative to `deployment_path` and use the `dir/**/*` pattern to exclude directories.
@@ -169,6 +171,25 @@ See our boilerplate
 [sinatra-static-bp](https://github.com/hooktstudios/sinatra-static-bp)
 for an example of the complete setup.
 
+## Migration guide
+
+### From `< 2.0.0`
+
+If you have customized `deployment_path` from 2.0 use a simplified format
+
+```diff
+# config/deploy.rb
+-set :deployment_path, proc { Dir.pwd.gsub('\n', '') + '/build' }
++set :deployment_path, 'build'
+```
+
+If you have configured `s3_endpoint` to something other than the default switch to new syntax using [region](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) identifiers
+
+```diff
+-set :s3_endpoint, 's3-eu-west-1.amazonaws.com'
++set :region, 'eu-west-1'
+```
+
 ## Contributing
 
 See [CONTRIBUTING.md](https://github.com/hooktstudios/capistrano-s3/blob/master/CONTRIBUTING.md) for more details on contributing and running test.

data/capistrano-s3.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.1"
 
   # Gem dependencies
-  s.add_runtime_dependency 'aws-sdk',    '~> 1.11'
+  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 'net-ssh',    '~> 2.9'

data/lib/capistrano/s3/defaults.rb

@@ -2,9 +2,9 @@ module Capistrano
   module S3
     module Defaults
       DEFAULTS = {
-        :deployment_path      => proc { Dir.pwd.gsub("\n", "") + "/public" },
+        :deployment_path      => "public",
         :bucket_write_options => { :acl => :public_read },
-        :s3_endpoint          => "s3.amazonaws.com",
+        :region               => 'us-east-1',
         :redirect_options     => {},
         :only_gzip            => false,
         :invalidations        => [],

data/lib/capistrano/s3/publisher.rb

@@ -1,4 +1,4 @@
-require 'aws/s3'
+require 'aws-sdk'
 require 'mime/types'
 require 'fileutils'
 
@@ -6,17 +6,19 @@ module Capistrano
   module S3
     module Publisher
       LAST_PUBLISHED_FILE = '.last_published'
+      LAST_INVALIDATION_FILE = '.last_invalidation'
 
-      def self.publish!(s3_endpoint, key, secret, bucket, source, distribution_id, invalidations, exclusions, only_gzip, extra_options)
-        s3 = self.establish_s3_client_connection!(s3_endpoint, key, secret)
+      def self.publish!(region, key, secret, bucket, deployment_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
 
-        self.files(source, exclusions).each do |file|
+        self.files(deployment_path_absolute, exclusions).each do |file|
           if !File.directory?(file)
             next if self.published?(file)
             next if only_gzip && self.has_gzipped_version?(file)
 
-            path = self.base_file_path(source, file)
+            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)
@@ -25,9 +27,9 @@ module Capistrano
 
         # invalidate CloudFront distribution if needed
         if distribution_id && !invalidations.empty?
-          cf = self.establish_cf_client_connection!(key, secret)
+          cf = self.establish_cf_client_connection!(region, key, secret)
 
-          cf.create_invalidation({
+          response = cf.create_invalidation({
             :distribution_id => distribution_id,
             :invalidation_batch => {
               :paths => {
@@ -37,41 +39,57 @@ module Capistrano
               :caller_reference => SecureRandom.hex
             }
           })
+
+          if response && response.successful?
+            File.open(LAST_INVALIDATION_FILE, 'w') { |file| file.write(response[:invalidation][:id]) }
+          end
         end
 
         FileUtils.touch(LAST_PUBLISHED_FILE)
       end
 
-      def self.clear!(s3_endpoint, key, secret, bucket)
-        s3 = self.establish_s3_connection!(s3_endpoint, key, secret)
+      def self.clear!(region, key, secret, bucket)
+        s3 = self.establish_s3_connection!(region, key, secret)
         s3.buckets[bucket].clear!
 
         FileUtils.rm(LAST_PUBLISHED_FILE)
+        FileUtils.rm(LAST_INVALIDATION_FILE)
+      end
+
+      def self.check_invalidation(region, key, secret, distribution_id)
+        last_invalidation_id = File.read(LAST_INVALIDATION_FILE).strip
+
+        cf = self.establish_cf_client_connection!(region, key, secret)
+        cf.wait_until(:invalidation_completed, distribution_id: distribution_id, id: last_invalidation_id) do |w|
+          w.max_attempts = nil
+          w.delay = 30
+        end
       end
 
       private
 
         # Establishes the connection to Amazon S3
-        def self.establish_connection!(klass, s3_endpoint, key, secret)
+        def self.establish_connection!(klass, region, key, secret)
           # Send logging to STDOUT
-          AWS.config(:logger => ::Logger.new(STDOUT))
+          Aws.config[:logger] = ::Logger.new(STDOUT)
+          Aws.config[:log_formatter] = Aws::Log::Formatter.colored
           klass.new(
-            :s3_endpoint => s3_endpoint,
+            :region => region,
             :access_key_id => key,
             :secret_access_key => secret
           )
         end
 
-        def self.establish_cf_client_connection!(key, secret)
-          self.establish_connection!(AWS::CloudFront::Client, nil, key, secret)
+        def self.establish_cf_client_connection!(region, key, secret)
+          self.establish_connection!(Aws::CloudFront::Client, region, key, secret)
         end
 
-        def self.establish_s3_client_connection!(s3_endpoint, key, secret)
-          self.establish_connection!(AWS::S3::Client, s3_endpoint, key, secret)
+        def self.establish_s3_client_connection!(region, key, secret)
+          self.establish_connection!(Aws::S3::Client, region, key, secret)
         end
 
-        def self.establish_s3_connection!(s3_endpoint, key, secret)
-          self.establish_connection!(AWS::S3, s3_endpoint, key, secret)
+        def self.establish_s3_connection!(region, key, secret)
+          self.establish_connection!(Aws::S3, region, key, secret)
         end
 
         def self.base_file_path(root, file)
@@ -79,7 +97,7 @@ module Capistrano
         end
 
         def self.files(deployment_path, exclusions)
-          Dir.glob("#{deployment_path}/**/*") - Dir.glob(exclusions.map{ |e| "#{deployment_path}/#{e}" })
+          Dir.glob("#{deployment_path}/**/*") - Dir.glob(exclusions.map { |e| "#{deployment_path}/#{e}" })
         end
 
         def self.published?(file)
@@ -91,10 +109,10 @@ module Capistrano
           base_name = File.basename(file)
           mime_type = mime_type_for_file(base_name)
           options   = {
-            :bucket_name => bucket,
-            :key         => path,
-            :data        => open(file),
-            :acl         => :public_read,
+            :bucket => bucket,
+            :key    => path,
+            :body   => open(file),
+            :acl    => :public_read,
           }
 
           options.merge!(build_redirect_hash(path, extra_options[:redirect]))

data/lib/capistrano/s3/version.rb

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

data/lib/capistrano/tasks/capistrano_2.rb

@@ -11,13 +11,18 @@ module Capistrano
       namespace :s3 do
         desc "Empties bucket of all files. Caution when using this command, as it cannot be undone!"
         task :empty do
-          S3::Publisher.clear!(s3_endpoint, access_key_id, secret_access_key, bucket)
+          S3::Publisher.clear!(region, access_key_id, secret_access_key, bucket)
+        end
+
+        desc "Waits until the last CloudFront invalidation batch is completed"
+        task :wait_for_invalidation do
+          S3::Publisher.check_invalidation(region, access_key_id, secret_access_key, distribution_id)
         end
 
         desc "Upload files to the bucket in the current state"
         task :upload_files do
           extra_options = { :write => bucket_write_options, :redirect => redirect_options }
-          S3::Publisher.publish!(s3_endpoint, access_key_id, secret_access_key,
+          S3::Publisher.publish!(region, access_key_id, secret_access_key,
                              bucket, deployment_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
         end
       end

data/lib/capistrano/tasks/capistrano_3.rb

@@ -8,13 +8,18 @@ namespace :deploy do
   namespace :s3 do
     desc "Empties bucket of all files. Caution when using this command, as it cannot be undone!"
     task :empty do
-      Capistrano::S3::Publisher.clear!(fetch(:s3_endpoint), fetch(:access_key_id), fetch(:secret_access_key), fetch(:bucket))
+      Capistrano::S3::Publisher.clear!(fetch(:region), fetch(:access_key_id), fetch(:secret_access_key), fetch(:bucket))
+    end
+
+    desc "Waits until the last CloudFront invalidation batch is completed"
+    task :wait_for_invalidation do
+      Capistrano::S3::Publisher.check_invalidation(fetch(:region), fetch(:access_key_id), fetch(:secret_access_key), fetch(:distribution_id))
     end
 
     desc "Upload files to the bucket in the current state"
     task :upload_files do
       extra_options = { :write => fetch(:bucket_write_options), :redirect => fetch(:redirect_options) }
-      Capistrano::S3::Publisher.publish!(fetch(:s3_endpoint), fetch(:access_key_id), fetch(:secret_access_key),
+      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)
     end
   end

data/spec/publisher_spec.rb

@@ -9,60 +9,51 @@ describe Capistrano::S3::Publisher do
 
   context "on publish!" do
     it "publish all files" do
-      AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(8)
-
-      path = File.join(@root, 'sample')
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], false, {})
+      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, {})
     end
 
     it "publish only gzip files when option is enabled" do
-      AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(4)
-
-      path = File.join(@root, 'sample')
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], true, {})
+      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, {})
     end
 
     context "invalidations" do
       it "publish all files with invalidations" do
-        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(8)
-        AWS::CloudFront::Client::V20141106.any_instance.expects(:create_invalidation).once
+        Aws::S3::Client.any_instance.expects(:put_object).times(8)
+        Aws::CloudFront::Client.any_instance.expects(:create_invalidation).once
 
-        path = File.join(@root, 'sample')
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, '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::V20060301.any_instance.expects(:put_object).times(8)
-        AWS::CloudFront::Client::V20141106.any_instance.expects(:create_invalidation).never
+        Aws::S3::Client.any_instance.expects(:put_object).times(8)
+        Aws::CloudFront::Client.any_instance.expects(:create_invalidation).never
 
-        path = File.join(@root, 'sample')
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', './spec/sample/', 'cf123', [], [], false, {})
       end
     end
 
     context "exclusions" do
       it "exclude one files" do
-        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(7)
+        Aws::S3::Client.any_instance.expects(:put_object).times(7)
 
-        path = File.join(@root, 'sample')
         exclude_paths = ['fonts/cantarell-regular-webfont.svg']
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, '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::V20060301.any_instance.expects(:put_object).times(6)
+        Aws::S3::Client.any_instance.expects(:put_object).times(6)
 
-        path = File.join(@root, 'sample')
         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', path, '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::V20060301.any_instance.expects(:put_object).times(0)
+        Aws::S3::Client.any_instance.expects(:put_object).times(0)
 
-        path = File.join(@root, 'sample')
         exclude_paths = ['fonts/**/*']
-        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], exclude_paths, false, {})
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', 'spec/sample', 'cf123', [], exclude_paths, false, {})
       end
     end
 

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'capistrano/s3/publisher'
 require 'mocha/api'
 
-AWS.stub!
+Aws.config[:stub_responses] = true
 
 RSpec.configure do |config|
   config.mock_framework = :mocha
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-s3
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jean-Philippe Doyle
@@ -36,7 +36,7 @@ cert_chain:
   t/JsZnAlWYkJIees2SFV5X/t34oeMu04yY2u9y2YBqKovR97m5YF7zqgx0JODV0x
   ytwUJvEjznBnJV4OoDE=
   -----END CERTIFICATE-----
-date: 2017-01-25 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement