configure-s3-website 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08b5066bdcecf96cf6e4e9f2d0c4e1f4a8ed6023
-  data.tar.gz: 0b40908190a3ca1bb15a02f6fd0f1d53b765a47b
+  metadata.gz: e24e80677d4bf2df5bb592886165792ace426fe0
+  data.tar.gz: 7301fa4fd9f3fd6d3c0fbdebc1c72d87015703d7
 SHA512:
-  metadata.gz: c2d26e2b560294b0655e1ffc7fe6052ceb6bad7a8da2140af9da6fdfa95acdb2f6555a003a9c182c8a972354a1f26e7703b6033764a0acf5c2299e9182c7a232
-  data.tar.gz: 801dc529a403eab16e13f4213d0d65cfa9ed9d823b68eae9a2d91bf8fc262523aaca7f15e780a24052a4eb848e7a83f6a5998ecc020d46e9c2dcea127258cc48
+  metadata.gz: dd9c294392739927e55a655a6c6cde97404aa6f62f020895d76cec341abae8e345a8622f7860bae3b905da7c9c8ec331b062cf4f3aebc3ab921148fb9f6ab371
+  data.tar.gz: fcf99bf599d895177d639e42d57b98daff56eb34b1724212443938957505e2a13fcf3632f37c9127e23a63322a421d638a0c2354a261f2496c3a973fd586a0ce

data/README.md

@@ -31,6 +31,12 @@ s3_secret: your-aws-secret-key
 s3_bucket: name-of-your-bucket
 ```
 
+**or** you may omit the `profile` and `s3_id` keys to use the system's default credentials.
+This requires [configuring AWS credentials](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-setting-credentials).
+Options include [setting environment variables](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-credentials-environment),
+using a [shared credentials file](http://docs.aws.amazon.com/sdk-for-ruby/v2/developer-guide/setup-config.html#aws-ruby-sdk-credentials-shared),
+or running an [EC2 instance with IAM roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances).
+
 Save the file (as *config.yml*, for example). Now you are ready to go. Run the
 following command:
 

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.3.0
+
+* Add support for default credentials providers
+
 ## 2.2.0
 
 * Convert `http_error_code_returned_equals` value to string 

data/lib/configure-s3-website/config_source/file_config_source.rb

@@ -82,11 +82,6 @@ module ConfigureS3Website
       if not config.keys.include?'s3_bucket'
         raise "File #{yaml_file_path} does not contain the required key 's3_bucket'"
       end
-
-      # check that either s3_id or profile is configured
-      if not (config.keys.include?'s3_id' or config.keys.include?'profile')
-        raise "File #{yaml_file_path} does not contain either 's3_id' or 'profile'"
-      end
     end
   end
 end

data/lib/configure-s3-website/s3_client.rb

@@ -27,11 +27,15 @@ module ConfigureS3Website
           access_key_id: config_source.s3_access_key_id,
           secret_access_key: config_source.s3_secret_access_key
         )
-      else
+      elsif config_source.profile
         Aws::S3::Client.new(
           region: config_source.s3_endpoint,
           profile: config_source.profile,
         )
+      else
+        Aws::S3::Client.new(
+          region: config_source.s3_endpoint,
+        )
       end
     end
 

data/lib/configure-s3-website/version.rb

@@ -1,3 +1,3 @@
 module ConfigureS3Website
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/spec/config_source/file_config_source_spec.rb

@@ -21,6 +21,14 @@ describe ConfigureS3Website::FileConfigSource do
     expect(config_source.description).to eq(yaml_file_path)
   end
 
+  it 'does not require s3_id, s3_secret or profile ' do
+    config_no_credentials = ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file_no_credentials.yml')
+    expect(config_no_credentials.s3_access_key_id).to be_nil
+    expect(config_no_credentials.s3_secret_access_key).to be_nil
+    expect(config_no_credentials.profile).to be_nil
+    expect(config_no_credentials.s3_bucket_name).to eq('my-bucket')
+  end
+
   describe 'setter for cloudfront_distribution_id' do
     let(:original_yaml_contents) {
       %Q{

data/spec/s3_client_spec.rb

@@ -144,4 +144,19 @@ describe ConfigureS3Website::S3Client do
       ConfigureS3Website::S3Client.configure_website({config_source: config_source})
     end
   end
+
+  context 's3_id, s3_secret and profile not required' do
+    let(:config_source) {
+      ConfigureS3Website::FileConfigSource.new('spec/sample_files/_config_file_no_credentials.yml')
+    }
+
+    it 'calls the S3 API successfully' do
+      allow_any_instance_of(Aws::S3::Client).to receive(:put_bucket_website).with(
+        hash_including(
+          :bucket => "my-bucket"
+        )
+      )
+      ConfigureS3Website::S3Client.configure_website({config_source: config_source})
+    end
+  end
 end

data/spec/sample_files/_config_file_no_credentials.yml

@@ -0,0 +1 @@
+s3_bucket: my-bucket

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: configure-s3-website
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -112,6 +112,7 @@ files:
 - spec/s3_client_spec.rb
 - spec/sample_files/_config_file.yml
 - spec/sample_files/_config_file_EU.yml
+- spec/sample_files/_config_file_no_credentials.yml
 - spec/sample_files/_config_file_oregon.yml
 - spec/sample_files/_config_file_with_eruby.yml
 - spec/sample_files/_custom_index_and_error_docs.yml