usmu-s3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2bf26b514877f1596619bb43c3f6a702fd26be9
+  data.tar.gz: d2ad7cd9958cf71e5e68a123555829d08677db50
+SHA512:
+  metadata.gz: a040b35e4fc077cd0b82677b2efe3cc0608be03842e0890bea510af89827ee245de5425e2334a427f50673ffb37298fb7b75910116c2b9fc30bf77f272b98cc5
+  data.tar.gz: b05383994090614f96c6befb4d90122d0ed92d5cbcd5362d55e9c9933307a5c649c940bcd0748719d34ab8d34fc409cd5fe1ec7a975508c02aed41d2f4bca097

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile*.lock
+/_yardoc/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,6 @@
+--color
+-I spec
+-r turnip/rspec
+--require spec_helper
+--format documentation
+--no-profile

data/.travis.yml

@@ -0,0 +1,33 @@
+language: ruby
+script: rake ci
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+  - mruby-head
+  - rbx-2.1
+  - rbx-2.2
+  - rbx-2.3
+  - rbx-2.4
+matrix:
+  include:
+    - rvm: jruby
+    - rvm: jruby
+      env: JRUBY_OPTS='--2.0'
+    - rvm: jruby-head
+    - rvm: jruby-head
+      env: JRUBY_OPTS='--2.0'
+  allow_failures:
+    - rvm: 1.9.3
+    - rvm: jruby
+    - rvm: jruby-head
+    - rvm: mruby-head
+    - rvm: rbx-2.1
+    - rvm: rbx-2.2
+    - rvm: rbx-2.3
+    - rvm: rbx-2.4
+addons:
+  code_climate:
+    repo_token: ebb97d3c606e22753911d08f39444a86f27a7da6a40d834f94d640375615fff8

data/.yardopts

@@ -0,0 +1 @@
+--private --protected --default-return void -m markdown -M redcarpet -- lib/**/*.rb - README.md CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Usmu S3 Upload plugin changelog
+
+## 1.0.0
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Fix readme (fea8602d016709c089b3c8b66b6487b07ff48d05)
+* Update build system from Usmu core (65487dfac5a76c8fa9011a7c5286cf2ca2b59b4d)
+* Add an S3Configuration which can read from ENV (2fa8a5d44e539f89dc044c8821ee10e45769d19c)
+* Add gemnasium badge (0e7e2b74b143dd0ac54c38335aef7cf964783dfa)
+* Add spec for S3Configuration (541b1624a524482b57f24b4213792176af480c41)
+* Add Code Coverage (a6b7617b5be714fc1a8fefcaf23f72a6304cfc1d)
+* Convert to Code Climate's coverage data (992c27a773de91034b054a2e3c6c80636c4ef147)
+* Include the AWS SDK and update configuration to use their env vars (4d6a342050eab38f1a2dfbb7db7ac659bf1c5b5e)
+* Add mutant (943c29c358341ae4cb498d6c7e0d3ac7e20cfe3d)
+* Prepare for the deployment API (57c05d4c30b53e62598cdca89897b133b84acbaa)
+* Update coverage for S3Configuration (26287e6089b1071f375adbb793524bbae9d563cb)
+* Tests for completed sections of Usmu::S3 (2c6c9966a6274378efa606b4183c0c819aceb5dd)
+* Add a RemoteFileInterface implementation (d92ee043bf1a1e093927b4930523c7bc4690c770)
+* Add support for uploading to S3 (4f07cd33f7b79f1ecb7cc6b6a00431df99284d1a)
+* Complete 100% mutant test coverage (a1fac102bf7caa7a00fed8a79e54c3a527234efd)

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing to usmu
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usmu.gemspec
+gemspec name: 'usmu-s3'
+
+gem 'codeclimate-test-reporter', group: :test, require: nil
+
+if RUBY_VERSION.to_f >= 2 && RUBY_VERSION.to_f < 2.2 && RUBY_ENGINE == 'ruby'
+  gem 'mutant', '~> 0.7'
+  gem 'mutant-rspec', '~> 0.7'
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec', spec_paths: ['spec'] do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/usmu/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/support})      { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthew Scharley and contributors
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# usmu-s3
+
+[![Build Status](https://travis-ci.org/usmu/usmu-s3.svg?branch=master)](https://travis-ci.org/usmu/usmu-s3)
+[![Dependency Status](https://gemnasium.com/usmu/usmu-s3.svg)](https://gemnasium.com/usmu/usmu-s3)
+[![Code Climate](https://codeclimate.com/github/usmu/usmu-s3/badges/gpa.svg)](https://codeclimate.com/github/usmu/usmu-s3)
+
+**Source:** [https://github.com/usmu/usmu-s3](https://github.com/usmu/usmu-s3)  
+**Author:** Matthew Scharley  
+**Contributors:** [See contributors on GitHub][gh-contrib]  
+**Bugs/Support:** [Github Issues][gh-issues]  
+**Copyright:** 2014  
+**License:** [MIT license][license]  
+**Status:** Active
+
+## Synopsis
+
+Allows you to deploy your [Usmu][usmu] website to Amazon's S3 service.
+
+TODO: Write synopsis here
+
+## Installation
+
+    $ gem install usmu-s3
+
+## Usage
+
+TODO: Write usage instructions here
+
+  [gh-contrib]: https://github.com/usmu/usmu-s3/graphs/contributors
+  [gh-issues]: https://github.com/usmu/usmu-s3/issues
+  [license]: https://github.com/usmu/usmu-s3/blob/master/LICENSE.md
+  [usmu]: https://github.com/usmu/usmu

data/Rakefile

@@ -0,0 +1,92 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'rspec/core/rake_task'
+require 'usmu/s3/version'
+
+def current_gems
+  Dir["pkg/usmu-s3-#{Usmu::S3::VERSION}*.gem"]
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'Run all test scripts'
+task :test => [:clean, :spec, :mutant]
+
+desc 'Run mutation tests'
+task :mutant, [:target] => [:clean] do |t,args|
+  old = ENV.delete('CODECLIMATE_REPO_TOKEN')
+  if `which mutant 2>&1 > /dev/null; echo \$?`.to_i != 0
+    puts 'Mutant isn\'t supported on your platform. Please run these tests on MRI <= 2.1.5.'
+  else
+    sh('bundle', 'exec', 'mutant', '--include', 'lib', '--require', 'usmu/s3', '--use', 'rspec', args[:target] || 'Usmu::S3*')
+  end
+  ENV['CODECLIMATE_REPO_TOKEN'] = old unless old.nil?
+end
+
+desc 'Run CI test suite'
+task :ci => [:clean, :spec]
+
+desc 'Clean up after tests'
+task :clean do
+  [
+      'test/coverage',
+      current_gems,
+  ].flatten.each do |f|
+    rm_r f if File.exist? f
+  end
+end
+
+namespace :gem do
+  desc 'Build gems'
+  task :build => [:clean] do
+    mkdir 'pkg' unless File.exist? 'pkg'
+    Dir['*.gemspec'].each do |gemspec|
+      sh "gem build #{gemspec}"
+    end
+    Dir['*.gem'].each do |gem|
+      mv gem, "pkg/#{gem}"
+    end
+  end
+
+  desc 'Install gem'
+  task :install => ['gem:build'] do
+    sh "gem install pkg/usmu-s3-#{Usmu::S3::VERSION}.gem"
+  end
+
+  desc 'Deploy gems to rubygems'
+  task :deploy => ['gem:build'] do
+    current_gems.each do |gem|
+      sh "gem push #{gem}"
+    end
+    sh "git tag #{Usmu::S3::VERSION}" if File.exist? '.git'
+  end
+end
+
+# (mostly) borrowed from: https://gist.github.com/mcansky/802396
+desc 'generate changelog with nice clean output'
+task :changelog, :since_c, :until_c do |t,args|
+  since_c = args[:since_c] || `git tag | egrep '^[0-9]+\\.[0-9]+\\.[0-9]+\$' | sort -Vr | head -n 1`.chomp
+  until_c = args[:until_c]
+  cmd=`git log --pretty='format:%ci::::%an <%ae>::::%s::::%H' #{since_c}..#{until_c}`
+
+  entries = Hash.new
+  changelog_content = "\#\# #{Usmu::S3::VERSION}\n\n"
+
+  cmd.lines.each do |entry|
+    date, author, subject, hash = entry.chomp.split('::::')
+    entries[author] = Array.new unless entries[author]
+    day = date.split(' ').first
+    entries[author] << "#{subject} (#{hash})" unless subject =~ /Merge/
+  end
+
+  # generate clean output
+  entries.keys.each do |author|
+    changelog_content += author + "\n\n"
+    entries[author].reverse.each { |entry| changelog_content += "* #{entry}\n" }
+  end
+
+  puts changelog_content
+end

data/lib/usmu/s3/remote_files.rb

@@ -0,0 +1,46 @@
+require 'usmu/deployment/remote_file_interface'
+require 'aws-sdk'
+
+module Usmu
+  class S3
+    class RemoteFiles
+      include Usmu::Deployment::RemoteFileInterface
+
+      # @param [Usmu::S3::Configuration] configuration
+      #   An S3 configuration to provide connection details to the remote S3 bucket.
+      def initialize(configuration)
+        @s3 = Aws::S3::Resource.new(credentials: configuration.credentials, region: configuration.region)
+        @bucket = @s3.bucket(configuration.bucket)
+      end
+
+      # @see Usmu::Deployment::RemoteFileInterface#files_list
+      def files_list
+        objects.map {|o| o.key }
+      end
+
+      # @see Usmu::Deployment::RemoteFileInterface#stat
+      def stat(filename)
+        obj = objects.select {|o| o.key.eql? filename }.first
+        return nil if obj.nil?
+
+        etag = unless obj.etag.index('-')
+                 obj.etag.gsub(/^["]|["]$/, '')
+               end
+
+        {
+            md5: etag,
+            mtime: obj.last_modified,
+        }
+      end
+
+      private
+
+      attr_reader :s3
+      attr_reader :bucket
+
+      def objects
+        @objects ||= @bucket.objects.to_a
+      end
+    end
+  end
+end

data/lib/usmu/s3/s3_configuration.rb

@@ -0,0 +1,41 @@
+require 'aws-sdk'
+
+module Usmu
+  class S3
+    class S3Configuration
+      def initialize(hash)
+        @config = hash
+      end
+
+      def region
+        substitute_env(@config['region'] || '%env{AWS_REGION}')
+      end
+
+      def access_key
+        substitute_env(@config['access key'] || '%env{AWS_ACCESS_KEY_ID}')
+      end
+
+      def secret_key
+        substitute_env(@config['secret key'] || '%env{AWS_SECRET_ACCESS_KEY}')
+      end
+
+      def bucket
+        substitute_env @config['bucket'] || ''
+      end
+
+      def inspect
+        "\#<#{self.class} region=\"#{region}\" access_key=\"#{access_key}\" bucket=\"#{bucket}\">"
+      end
+
+      def credentials
+        @credentials ||= Aws::Credentials.new(access_key, secret_key)
+      end
+
+      private
+
+      def substitute_env(string)
+        string.gsub(%r[%env\{([^}]*)\}]) { ENV[$1] }
+      end
+    end
+  end
+end

data/lib/usmu/s3/uploader.rb

@@ -0,0 +1,50 @@
+
+module Usmu
+  class S3
+    class Uploader
+      # @param [Usmu::Configuration] configuration
+      # @param [Usmu::S3::S3Configuration] s3_configuration
+      def initialize(configuration, s3_configuration)
+        @log = Logging.logger[self]
+        @configuration = configuration
+        s3 = Aws::S3::Resource.new(credentials: s3_configuration.credentials, region: s3_configuration.region)
+        @bucket = s3.bucket(s3_configuration.bucket)
+      end
+
+      def push(diff)
+        push_local(diff[:local])
+        push_local(diff[:updated])
+        delete_remote(diff[:remote])
+      end
+
+      private
+
+      attr_reader :log
+      attr_reader :configuration
+      attr_reader :bucket
+
+      def push_local(files)
+        for file in files
+          @log.success("Uploading #{file}")
+          File.open(File.join(@configuration.destination_path, file), 'r') do |io|
+            @bucket.put_object({
+                                   key: file,
+                                   body: io,
+                               })
+          end
+        end
+      end
+
+      def delete_remote(files)
+        # We can 'only' delete 1000 items at a time with #delete_objects.
+        for i in (0...files.length).step(1000)
+          deleting = files.slice(i, 1000)
+          for f in deleting
+            @log.success("Deleting #{f}")
+          end
+          @bucket.delete_objects({delete: {objects: deleting.map { |f| {key: f} }}})
+        end
+      end
+    end
+  end
+end

data/lib/usmu/s3/version.rb

@@ -0,0 +1,7 @@
+
+module Usmu
+  class S3
+    # The current version string for the gem
+    VERSION = '1.0.0'
+  end
+end

data/lib/usmu/s3.rb

@@ -0,0 +1,52 @@
+%w{
+  aws-sdk
+  logging
+  usmu/deployment
+  usmu/s3/remote_files
+  usmu/s3/s3_configuration
+  usmu/s3/uploader
+  usmu/s3/version
+}.each {|f| require f }
+
+# Module from Usmu Core
+module Usmu
+  # Usmu::S3 is the main plugin class for this plugin. It contains entry hooks as required to implement the S3
+  # deployment interface.
+  class S3
+    def initialize
+      @log = Logging.logger[self]
+      @log.debug("Initializing usmu-s3 v#{VERSION}")
+    end
+
+    # @see Usmu::Plugin::CoreHooks#commands
+    def commands(ui, c)
+      @log.debug('Adding commands from usmu-s3.')
+      @ui = ui
+
+      c.command(:'s3 deploy') do |command|
+        command.syntax = 'usmu s3 deploy'
+        command.description = 'Deploys your website to S3'
+        command.action &method(:command_deploy)
+      end
+    end
+
+    def command_deploy(args = [], options = {})
+      raise 'This command does not take arguments.' unless args.empty?
+      raise 'Invalid options, must be a Hash.' unless options.instance_of? Hash
+
+      configuration = @ui.configuration
+      s3_configuration = S3Configuration.new(configuration['plugin', 's3', default: {}])
+      @log.info('Gathering information...')
+      diff = Deployment::DirectoryDiff.new(configuration, RemoteFiles.new(s3_configuration))
+      @log.info('Uploading files.')
+      uploader = Uploader.new(configuration, s3_configuration)
+      uploader.push(diff.get_diffs)
+      @log.info('Website updated successfully.')
+    end
+
+    private
+
+    attr_reader :log
+    attr_accessor :ui
+  end
+end

data/spec/mock/usmu/commander_mock.rb

@@ -0,0 +1,31 @@
+
+module Usmu
+  class CommanderMock
+    def initialize
+      @commands = {}
+    end
+
+    def get_command(name)
+      @commands[name]
+    end
+
+    def command(name, &block)
+      @current_command = name
+      @commands[name] = {}
+
+      block.yield(self)
+    end
+
+    def syntax=(value)
+      @commands[@current_command][:syntax] = value
+    end
+
+    def description=(value)
+      @commands[@current_command][:description] = value
+    end
+
+    def action(&block)
+      @commands[@current_command][:action] = block
+    end
+  end
+end

data/spec/mock/usmu/s3_service_mock.rb

@@ -0,0 +1,35 @@
+
+module Usmu
+  class S3ServiceMock
+    attr_accessor :objects
+
+    class ArrayWrapper
+      def initialize(objects)
+        @objects = objects
+      end
+
+      def to_a
+        @objects
+      end
+    end
+
+    def initialize(objects)
+      @objects = ArrayWrapper.new(objects)
+    end
+
+    def bucket(name)
+      @bucket = name
+      self
+    end
+
+    def get_bucket
+      @bucket
+    end
+
+    def put_object(hash)
+    end
+
+    def delete_objects(request)
+    end
+  end
+end

data/spec/mock/usmu/uploader_mock.rb

@@ -0,0 +1,10 @@
+
+module Usmu
+  class UploaderMock
+    attr_reader :diffs
+
+    def push(diffs)
+      @diffs = diffs
+    end
+  end
+end

data/spec/s3/remote_files_spec.rb

@@ -0,0 +1,74 @@
+require 'usmu/s3/s3_configuration'
+require 'usmu/s3/remote_files'
+require 'usmu/s3_service_mock'
+require 'ostruct'
+
+RSpec.describe Usmu::S3::RemoteFiles do
+  let(:now) { Time.now }
+  let(:configuration) {
+    Usmu::S3::S3Configuration.new(
+        {
+            'access key' => 'access',
+            'secret key' => 'secret',
+            'region' => 'us-east-1',
+            'bucket' => 'bucket',
+        }
+    )
+  }
+  let(:creds) { OpenStruct.new({ access_key: 'access', secret_key: 'secret' }) }
+  let(:s3) {
+    Usmu::S3ServiceMock.new(
+        [
+            OpenStruct.new({ key: 'index.html', etag: '"dffd613ea3d712d38c230c810be2e4a6"', last_modified: now }),
+            OpenStruct.new({ key: 'sitemap.xml', etag: '"dffd613ea3d712d38c230c810be2e4a6-5"', last_modified: now }),
+        ]
+    )
+  }
+  let(:remote) { Usmu::S3::RemoteFiles.new(configuration) }
+
+  before do
+    expect(configuration).to receive(:credentials).and_return(creds)
+    expect(Aws::S3::Resource).to receive(:new).with({credentials: creds, region: 'us-east-1'}).and_return(s3)
+  end
+
+  context '#initialize' do
+    it 'creates an S3 resource instance' do
+      remote
+      expect(remote.send :s3).to eq(s3)
+    end
+
+    it 'finds the relevant S3 bucket' do
+      remote
+      expect(remote.send :bucket).to eq(s3)
+      expect(s3.get_bucket).to eq(configuration.bucket)
+    end
+  end
+
+  context '#files_list' do
+    it 'returns a list of file names' do
+      expect(remote.files_list.sort).to eq(['index.html', 'sitemap.xml'])
+    end
+  end
+
+  context '#stat' do
+    it 'returns a hash of information' do
+      expect(remote.stat('index.html')).to eq({md5: 'dffd613ea3d712d38c230c810be2e4a6', mtime: now})
+    end
+
+    it 'doesn\'t return an :md5 element for multi-part uploads' do
+      expect(remote.stat('sitemap.xml')).to eq({md5: nil, mtime: now})
+    end
+
+    it 'returns nil if there is no information available' do
+      expect(remote.stat('jquery.js')).to eq(nil)
+    end
+  end
+
+  context '#objects' do
+    it 'returns a list of objects about files' do
+      objs = remote.send :objects
+      expect(objs.length).to eq(2)
+      expect(objs.map {|o| o.key }.sort).to eq(['index.html', 'sitemap.xml'])
+    end
+  end
+end