dpl-s3 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62afe207b4842b89b8c36a6980cd814b9c44d62f
+  data.tar.gz: 4c4f4e9aa6fab6ab46e9e4b457478a3995f01d23
+SHA512:
+  metadata.gz: 27d1514f863c902b6560adf4849d488aaf3a8bb40f084bba06d60443a00a5a64b866b5382903e4170eddff70ba4ad4bf05596f8ca965b9de8bebdeeb146de3ab
+  data.tar.gz: 9bb51cee2e50bdad4f292f75dcfb5473291230c79eebcb24d8aea93a93459ccfaa06079676d4541b192546cee4c5fae5f6d4160402e7caa5eebb5be016b112c9

data/dpl-s3.gemspec

@@ -0,0 +1,3 @@
+require './gemspec_helper'
+
+gemspec_for 's3', [['aws-sdk', '~> 2.0'], ['mime-types', '~> 2.0']]

data/lib/dpl/provider/s3.rb

@@ -0,0 +1,122 @@
+require 'json'
+require 'aws-sdk'
+require 'mime-types'
+
+module DPL
+  class Provider
+    class S3 < Provider
+      def api
+        @api ||= ::Aws::S3::Resource.new(s3_options)
+      end
+
+      def needs_key?
+        false
+      end
+
+      def check_app
+        log 'Warning: The endpoint option is no longer used and can be removed.' if options[:endpoint]
+      end
+
+      def access_key_id
+        options[:access_key_id] || context.env['AWS_ACCESS_KEY_ID'] || raise(Error, "missing access_key_id")
+      end
+
+      def secret_access_key
+        options[:secret_access_key] || context.env['AWS_SECRET_ACCESS_KEY'] || raise(Error, "missing secret_access_key")
+      end
+
+      def s3_options
+        {
+          region:      options[:region] || 'us-east-1',
+          credentials: ::Aws::Credentials.new(access_key_id, secret_access_key)
+        }
+      end
+
+      def check_auth
+        log "Logging in with Access Key: #{access_key_id[-4..-1].rjust(20, '*')}"
+      end
+
+      def upload_path(filename)
+        [options[:upload_dir], filename].compact.join("/")
+      end
+
+      def push_app
+        glob_args = ["**/*"]
+        glob_args << File::FNM_DOTMATCH if options[:dot_match]
+        Dir.chdir(options.fetch(:local_dir, Dir.pwd)) do
+          Dir.glob(*glob_args) do |filename|
+            opts                          = content_data_for(filename)
+            opts[:cache_control]          = get_option_value_by_filename(options[:cache_control], filename) if options[:cache_control]
+            opts[:acl]                    = options[:acl].gsub(/_/, '-') if options[:acl]
+            opts[:expires]                = get_option_value_by_filename(options[:expires], filename) if options[:expires]
+            opts[:storage_class]          = options[:storage_class] if options[:storage_class]
+            opts[:server_side_encryption] = "AES256" if options[:server_side_encryption]
+            unless File.directory?(filename)
+              log "uploading #{filename.inspect} with #{opts.inspect}"
+              result = api.bucket(option(:bucket)).object(upload_path(filename)).upload_file(filename, opts)
+              warn "error while uploading #{filename.inspect}" unless result
+            end
+          end
+        end
+
+        if suffix = options[:index_document_suffix]
+          api.bucket(option(:bucket)).website.put(
+            website_configuration: {
+              index_document: {
+                suffix: suffix
+              }
+            }
+          )
+        end
+      end
+
+      def deploy
+        super
+      rescue ::Aws::S3::Errors::InvalidAccessKeyId
+        raise Error, "Invalid S3 Access Key Id, Stopping Deploy"
+      rescue ::Aws::S3::Errors::ChecksumError
+        raise Error, "Aws Secret Key does not match Access Key Id, Stopping Deploy"
+      rescue ::Aws::S3::Errors::AccessDenied
+        raise Error, "Oops, It looks like you tried to write to a bucket that isn't yours or doesn't exist yet. Please create the bucket before trying to write to it."
+      end
+
+      private
+      def content_data_for(path)
+        content_data = {}
+        content_type = MIME::Types.type_for(path).first
+        content_data[:content_type] = content_type.to_s
+
+        encoding = encoding_for(path)
+        if detect_encoding?
+          content_data[:content_encoding] = encoding if encoding
+        end
+
+        if encoding == 'text' && default_text_charset?
+          content_data[:content_type] = "#{content_data[:content_type]}; charset=#{default_text_charset}"
+        end
+
+        return content_data
+      end
+
+      def get_option_value_by_filename(option_values, filename)
+        return option_values if !option_values.kind_of?(Array)
+        preferred_value = nil
+        hashes = option_values.select {|value| value.kind_of?(Hash) }
+        hashes.each do |hash|
+          hash.each do |value, patterns|
+            unless patterns.kind_of?(Array)
+              patterns = [patterns]
+            end
+            patterns.each do |pattern|
+              if File.fnmatch?(pattern, filename)
+                preferred_value = value
+              end
+            end
+          end
+        end
+        preferred_value = option_values.select {|value| value.kind_of?(String) }.last if preferred_value.nil?
+        return preferred_value
+      end
+    end
+  end
+end

data/spec/provider/s3_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+require 'dpl/provider/s3'
+
+describe DPL::Provider::S3 do
+
+  subject :provider do
+    described_class.new(DummyContext.new, :access_key_id => 'qwertyuiopasdfghjklz', :secret_access_key => 'qwertyuiopasdfghjklzqwertyuiopasdfghjklz', :bucket => 'my-bucket')
+  end
+
+  describe '#s3_options' do
+    context 'without region' do
+      example do
+        options = provider.s3_options
+        expect(options[:region]).to eq('us-east-1')
+      end
+    end
+
+    context 'with region' do
+      example do
+        region = 'us-west-1'
+        provider.options.update(:region => region)
+        options = provider.s3_options
+        expect(options[:region]).to eq(region)
+      end
+    end
+  end
+end
+
+describe DPL::Provider::S3 do
+
+  access_key_id = 'qwertyuiopasdfghjklz'
+  secret_access_key = 'qwertyuiopasdfghjklzqwertyuiopasdfghjklz'
+  region = 'us-east-1'
+  bucket = 'my-bucket'
+
+  client_options = {
+    stub_responses: true,
+    region: region,
+    credentials: Aws::Credentials.new(access_key_id, secret_access_key)
+  }
+
+  subject :provider do
+    described_class.new(DummyContext.new, {
+      access_key_id: access_key_id,
+      secret_access_key: secret_access_key,
+      bucket: bucket
+    })
+  end
+
+  before :each do
+    provider.stub(:s3_options).and_return(client_options)
+  end
+
+  describe "#check_auth" do
+    example do
+      expect(provider).to receive(:log).with("Logging in with Access Key: ****************jklz")
+      provider.check_auth
+    end
+  end
+
+  describe "#upload_path" do
+    example "Without :upload_dir"do
+      filename = "testfile.file"
+
+      expect(provider.upload_path(filename)).to eq("testfile.file")
+    end
+
+    example "With :upload_dir" do
+      provider.options.update(:upload_dir => 'BUILD3')
+      filename = "testfile.file"
+
+      expect(provider.upload_path(filename)).to eq("BUILD3/testfile.file")
+    end
+  end
+
+  describe "#needs_key?" do
+    example do
+      expect(provider.needs_key?).to eq(false)
+    end
+  end
+
+  describe "#push_app" do
+    example "Without local_dir" do
+      expect(Dir).to receive(:chdir).with(Dir.pwd)
+      provider.push_app
+    end
+
+    example "With local_dir" do
+      provider.options.update(:local_dir => 'BUILD')
+
+      expect(Dir).to receive(:chdir).with('BUILD')
+      provider.push_app
+    end
+
+    example "Sends MIME type" do
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:content_type => 'application/x-ruby'))
+      provider.push_app
+    end
+
+    example "Sets Cache and Expiration" do
+      provider.options.update(:cache_control => "max-age=99999999", :expires => "2012-12-21 00:00:00 -0000")
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:cache_control => 'max-age=99999999', :expires => '2012-12-21 00:00:00 -0000'))
+      provider.push_app
+    end
+
+    example "Sets different Cache and Expiration" do
+      option_list = []
+      provider.options.update(:cache_control => ["max-age=99999999", "no-cache" => ["foo.html", "bar.txt"], "max-age=9999" => "*.txt"], :expires => ["2012-12-21 00:00:00 -0000", "1970-01-01 00:00:00 -0000" => "*.html"])
+      expect(Dir).to receive(:glob).and_yield("foo.html").and_yield("bar.txt").and_yield("baz.js")
+      allow_any_instance_of(Aws::S3::Object).to receive(:upload_file) do |obj, _data, options|
+        option_list << { key: obj.key, options: options }
+      end
+      provider.push_app
+      expect(option_list).to match_array([
+        { key: "foo.html", options: hash_including(:cache_control => "no-cache", :expires => "1970-01-01 00:00:00 -0000") },
+        { key: "bar.txt", options: hash_including(:cache_control => "max-age=9999", :expires => "2012-12-21 00:00:00 -0000") },
+        { key: "baz.js", options: hash_including(:cache_control => "max-age=99999999", :expires => "2012-12-21 00:00:00 -0000") },
+      ])
+    end
+
+    example "Sets ACL" do
+      provider.options.update(:acl => "public_read")
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:acl => "public-read"))
+      provider.push_app
+    end
+
+    example "Sets Storage Class" do
+      provider.options.update(:storage_class => "STANDARD_AI")
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:storage_class => "STANDARD_AI"))
+      provider.push_app
+    end
+
+    example "Sets SSE" do
+      provider.options.update(:server_side_encryption => true)
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:server_side_encryption => "AES256"))
+      provider.push_app
+    end
+
+    example "Sets Website Index Document" do
+      provider.options.update(:index_document_suffix => "test/index.html")
+      expect(Dir).to receive(:glob).and_yield(__FILE__)
+      expect_any_instance_of(Aws::S3::BucketWebsite).to receive(:put).with(:website_configuration => { :index_document => { :suffix => "test/index.html" } })
+      provider.push_app
+    end
+
+    example "when detect_encoding is set" do
+      path = 'foo.js'
+      provider.options.update(:detect_encoding => true)
+      expect(Dir).to receive(:glob).and_yield(path)
+      expect(provider).to receive(:`).at_least(1).times.with("file '#{path}'").and_return('gzip compressed')
+      expect_any_instance_of(Aws::S3::Object).to receive(:upload_file).with(anything(), hash_including(:content_encoding => 'gzip'))
+      provider.push_app
+    end
+
+    example "when dot_match is set" do
+      provider.options.update(:dot_match => true)
+      expect(Dir).to receive(:glob).with("**/*", File::FNM_DOTMATCH)
+      provider.push_app
+    end
+  end
+
+  describe "#check_app" do
+    example "With Endpoint" do
+      provider.options.update(:endpoint => 's3test.com.s3-website-us-west-2.amazonaws.com')
+      expect(provider).to receive(:log).with('Warning: The endpoint option is no longer used and can be removed.')
+      provider.check_app
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: dpl-s3
+version: !ruby/object:Gem::Version
+  version: 1.9.0
+platform: ruby
+authors:
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dpl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: deploy tool abstraction for clients
+email: konstantin.mailinglists@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- dpl-s3.gemspec
+- lib/dpl/provider/s3.rb
+- spec/provider/s3_spec.rb
+homepage: https://github.com/travis-ci/dpl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: deploy tool
+test_files:
+- spec/provider/s3_spec.rb