usmu-s3 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2bf26b514877f1596619bb43c3f6a702fd26be9
-  data.tar.gz: d2ad7cd9958cf71e5e68a123555829d08677db50
+  metadata.gz: ed718f2274fba13642f76b974506164780db8d06
+  data.tar.gz: 88a9c13316372475e68922edeca87e80089c6d73
 SHA512:
-  metadata.gz: a040b35e4fc077cd0b82677b2efe3cc0608be03842e0890bea510af89827ee245de5425e2334a427f50673ffb37298fb7b75910116c2b9fc30bf77f272b98cc5
-  data.tar.gz: b05383994090614f96c6befb4d90122d0ed92d5cbcd5362d55e9c9933307a5c649c940bcd0748719d34ab8d34fc409cd5fe1ec7a975508c02aed41d2f4bca097
+  metadata.gz: 02e856d7c49ab50309c0a5c3dc6858d51ef12b4fe5a766884c756847972c11a2b16adc44437746283a1f2ea3f2acfc9d313ebe3fd10cc9e30527bae6d068de7e
+  data.tar.gz: 72d2601cdf3c358452dc6034a11f720d3614aa2fde9d6554b1cf3402df213e72e4cc5c895ad2a3858cec9bfa02779f75bd636eea35037eee85a15a27538f6f8b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Usmu S3 Upload plugin changelog
 
+## 1.1.0.pre
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Bump to 1.1.0.pre for further dev (7778eab819fcbd07560615fa2e6333f8d339201e)
+* [ci skip] Update README (8638b8202aef9b9662fdbc738c209c485d206842)
+* [#9] Add reduced redundancy support (63506a00ac84e38f171e9386cd54ea2e0df8fab2)
+* Fix command's tests (788741ef5d95c766140e20bed7ea167f23451d22)
+
 ## 1.0.0
 
 Matthew Scharley <matt.scharley@gmail.com>

data/README.md

@@ -16,15 +16,34 @@
 
 Allows you to deploy your [Usmu][usmu] website to Amazon's S3 service.
 
-TODO: Write synopsis here
-
 ## Installation
 
     $ gem install usmu-s3
 
+OR
+
+    $ echo 'gem "usmu-s3"' >> Gemfile
+    $ bundle install
+
+Usmu will automatically detect any plugins available and automatically make them available.
+
+## Configuration
+
+You can configure this plugin in your `usmu.yml` file:
+
+    plugin:
+      s3:
+        access_key: '%env{AWS_ACCESS_KEY_ID}'
+        secret_key: '%env{AWS_SECRET_ACCESS_KEY}'
+        region: 'us-east-1'
+        bucket: 'usmu.org'
+
+All S3 configuration options can be pulled from environment variables as shown above. Your access key and secret key
+will default to the above environment variables (the same ones used by the SDK) if not specified.
+
 ## Usage
 
-TODO: Write usage instructions here
+    $ usmu s3 deploy
 
   [gh-contrib]: https://github.com/usmu/usmu-s3/graphs/contributors
   [gh-issues]: https://github.com/usmu/usmu-s3/issues

data/lib/usmu/s3.rb

@@ -30,9 +30,9 @@ module Usmu
       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
+    def command_deploy(args, options)
+      raise 'This command does not take arguments' unless args.empty?
+      raise 'Invalid options' unless options.inspect.start_with? '<Commander::Command::Options '
 
       configuration = @ui.configuration
       s3_configuration = S3Configuration.new(configuration['plugin', 's3', default: {}])

data/lib/usmu/s3/s3_configuration.rb

@@ -23,6 +23,10 @@ module Usmu
         substitute_env @config['bucket'] || ''
       end
 
+      def reduced_redundancy
+        @config['reduced redundancy'] || false
+      end
+
       def inspect
         "\#<#{self.class} region=\"#{region}\" access_key=\"#{access_key}\" bucket=\"#{bucket}\">"
       end

data/lib/usmu/s3/uploader.rb

@@ -7,6 +7,7 @@ module Usmu
       def initialize(configuration, s3_configuration)
         @log = Logging.logger[self]
         @configuration = configuration
+        @s3_configuration = s3_configuration
         s3 = Aws::S3::Resource.new(credentials: s3_configuration.credentials, region: s3_configuration.region)
         @bucket = s3.bucket(s3_configuration.bucket)
       end
@@ -21,15 +22,18 @@ module Usmu
 
       attr_reader :log
       attr_reader :configuration
+      attr_reader :s3_configuration
       attr_reader :bucket
 
       def push_local(files)
+        storage_class = @s3_configuration.reduced_redundancy ? 'REDUCED_REDUNDANCY' : 'STANDARD'
         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,
+                                   storage_class: storage_class
                                })
           end
         end

data/lib/usmu/s3/version.rb

@@ -2,6 +2,6 @@
 module Usmu
   class S3
     # The current version string for the gem
-    VERSION = '1.0.0'
+    VERSION = '1.0.1'
   end
 end

data/spec/s3/s3_configuration_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe Usmu::S3::S3Configuration do
             'access key' => 'replace %env{TEST_ACCESS_KEY}',
             'secret key' => 'replace %env{TEST_SECRET_KEY}',
             'bucket' => 'replace %env{TEST_BUCKET}',
+            'reduced redundancy' => true,
         }
     )
   }
@@ -86,6 +87,16 @@ RSpec.describe Usmu::S3::S3Configuration do
     end
   end
 
+  context '#reduced_redundancy' do
+    it 'has a default value of false' do
+      expect(empty_configuration.reduced_redundancy).to eq(false)
+    end
+
+    it 'returns the "reduced redundancy" key' do
+      expect(configuration.reduced_redundancy).to eq(true)
+    end
+  end
+
   context '#substitute_env' do
     it 'replaces environment variables' do
       expect(empty_configuration.send :substitute_env, '%env{AWS_REGION}').to eq('us-east-1')

data/spec/s3/uploader_spec.rb

@@ -21,13 +21,14 @@ RSpec.describe Usmu::S3::Uploader do
   let (:uploader) { Usmu::S3::Uploader.new(configuration, s3_configuration) }
 
   before do
-    expect(s3_configuration).to receive(:credentials).and_return(creds)
+    allow(s3_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 'sets up instance variables' do
       expect(uploader.send :configuration).to eq(configuration)
+      expect(uploader.send :s3_configuration).to eq(s3_configuration)
       expect(uploader.send :bucket).to eq(s3)
       expect(s3.get_bucket).to eq('bucket')
       expect(uploader.send(:log).is_a? Logging::Logger).to eq(true)
@@ -51,16 +52,34 @@ RSpec.describe Usmu::S3::Uploader do
 
   context '#push_local' do
     let (:io) { OpenStruct.new {} }
+    let (:rr_configuration) {
+      Usmu::S3::S3Configuration.new(
+          {
+              'access key' => 'access',
+              'secret key' => 'secret',
+              'region' => 'us-east-1',
+              'bucket' => 'bucket',
+              'reduced redundancy' => true,
+          }
+      )
+    }
+    let (:rr_uploader) { Usmu::S3::Uploader.new(configuration, rr_configuration) }
 
     before do
       allow(File).to receive(:open).with('site/local.html', 'r').and_yield(io)
+      allow(rr_configuration).to receive(:credentials).and_return(creds)
     end
 
     it 'sends a request to S3 to push named files' do
-      expect(s3).to receive(:put_object).with({key: 'local.html', body: io})
+      expect(s3).to receive(:put_object).with({key: 'local.html', body: io, storage_class: 'STANDARD'})
       uploader.send :push_local, ['local.html']
     end
 
+    it 'uses reduced redundancy if requested' do
+      expect(s3).to receive(:put_object).with({key: 'local.html', body: io, storage_class: 'REDUCED_REDUNDANCY'})
+      rr_uploader.send :push_local, ['local.html']
+    end
+
     it 'logs files as they are pushed' do
       uploader.send :push_local, ['local.html']
       expect(@log_output.readline).to eq("SUCCESS  Usmu::S3::Uploader : Uploading local.html\n")

data/spec/s3_spec.rb

@@ -3,6 +3,7 @@ require 'usmu/configuration'
 require 'usmu/uploader_mock'
 require 'usmu/commander_mock'
 require 'ostruct'
+require 'commander'
 
 RSpec.describe Usmu::S3 do
   let(:plugin) { Usmu::S3.new }
@@ -39,7 +40,7 @@ RSpec.describe Usmu::S3 do
       plugin.commands(ui, commander)
       expect(commander.get_command(:'s3 deploy')[:syntax]).to eq('usmu s3 deploy')
       expect(commander.get_command(:'s3 deploy')[:description]).to eq('Deploys your website to S3')
-      expect(commander.get_command(:'s3 deploy')[:action].arity).to eq(-1)
+      expect(commander.get_command(:'s3 deploy')[:action]).to be_a(Proc)
     end
   end
 
@@ -63,13 +64,14 @@ RSpec.describe Usmu::S3 do
     let(:diffs) { OpenStruct.new }
     let(:uploader) { Usmu::UploaderMock.new }
     let(:remote_files) { OpenStruct.new }
+    let (:options) { Commander::Command::Options.new }
 
     it 'raises an error when arguments are specified' do
-      expect { plugin.command_deploy(['foo']) }.to raise_error('This command does not take arguments.')
+      expect { plugin.command_deploy(['foo'], options) }.to raise_error('This command does not take arguments')
     end
 
     it 'raises an error when invalid options are specified' do
-      expect { plugin.command_deploy([], []) }.to raise_error('Invalid options, must be a Hash.')
+      expect { plugin.command_deploy([], []) }.to raise_error('Invalid options')
     end
 
     it 'gets a DirectoryDiff and passes that to an Uploader' do
@@ -78,7 +80,7 @@ RSpec.describe Usmu::S3 do
       expect(Usmu::Deployment::DirectoryDiff).to receive(:new).with(configuration, remote_files).and_return(differ)
       expect(Usmu::S3::Uploader).to receive(:new).with(configuration, s3_configuration).and_return(uploader)
       expect(Usmu::S3::S3Configuration).to receive(:new).with({'bucket' => 'test'}).and_return(s3_configuration)
-      plugin.command_deploy
+      plugin.command_deploy [], options
       expect(uploader.diffs).to eq(diffs)
     end
 
@@ -88,7 +90,7 @@ RSpec.describe Usmu::S3 do
       expect(Usmu::Deployment::DirectoryDiff).to receive(:new).with(empty_configuration, remote_files).and_return(differ)
       expect(Usmu::S3::Uploader).to receive(:new).with(empty_configuration, s3_configuration).and_return(uploader)
       expect(Usmu::S3::S3Configuration).to receive(:new).with({}).and_return(s3_configuration)
-      plugin.command_deploy
+      plugin.command_deploy [], options
     end
 
     it 'logs progress' do
@@ -97,7 +99,7 @@ RSpec.describe Usmu::S3 do
       expect(Usmu::Deployment::DirectoryDiff).to receive(:new).with(configuration, remote_files).and_return(differ)
       expect(Usmu::S3::Uploader).to receive(:new).with(configuration, s3_configuration).and_return(uploader)
       expect(Usmu::S3::S3Configuration).to receive(:new).with({'bucket' => 'test'}).and_return(s3_configuration)
-      plugin.command_deploy
+      plugin.command_deploy [], options
 
       # Discard the line from initialization
       @log_output.readline

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usmu-s3
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-18 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: usmu