middleman-aws 0.0.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82cf32dd6575cad7951d83413c3246b36ed678e4
-  data.tar.gz: 13bed7ca88bef306faf4a65e88c9a077f8359224
+  metadata.gz: 128306ee099cc7965b6dbfabbffaff57afe0fcee
+  data.tar.gz: 3916fad18988c321d16fa35e2a00f4a81058fd50
 SHA512:
-  metadata.gz: 12daf88153a2c0dc1e83fe26843024aca460f9e280d1cbad41d847e7e16e2d4f869c3e1bea3c63d1ed4d64a5ab0284bf171121bd8ac53f7972acbef6bf64ba9b
-  data.tar.gz: 0d89ae81c4affd4614d33bf488a1c97aeaee6d60c128f1453a70f0654df17aa84b7f8a7b63e0f74ef752d8984c008c9cb9af57a6c01f7c49f47e4049acbe62c7
+  metadata.gz: fc5ac87054c46363924561ead0edfdca6af601cdc57a356eb06f561a8c7e61b76821dedc341e13dc175437d0607b73ecf6f16714fde12d3ee4b9b364bb3eb976
+  data.tar.gz: e8c5ce3f8456906bee8243e4a2a799abd89ac48ba124a8e8374fb6a0c2fd52476ac4c02139885acc3487aaae3fff5743390a023b710eee5884367ab578afde75

data/.rvmrc

@@ -1 +1 @@
-rvm use ruby-2.0.0@middleman-aws --create
+rvm use ruby-2.2.0@middleman-aws --create

data/README.md

@@ -13,46 +13,61 @@ Simple set of [middleman](http://middlemanapp.com/) rake tasks to build and depl
 
     require 'middleman-aws'
 
+    # Even though already required by the middleman-aws gem, it appears middleman does not
+    #   pick up transitive dependency extensions early enough  to avoid the
+    #   "== Unknown Extension:" error.  Add these to your main project
+    #   (I wish this was unnecessary but don't know how to work around it)
+    gem 'middleman-s3_sync'
+    gem 'middleman-cloudfront'
+
+
 ### Step 3: Add your aws credentials
 e.g. `~/.aws/acme.yml`
 
-This should contain the access and secret keys generated from the selected IAM user.  This is the only file that will need to reside 
-outside the repository.  `acme` is equivalent to the directory name for your project.  Don't worry, validation will make sure you have it right.
+This should contain the access and secret keys generated from the selected IAM user.  This is the only file that will need to reside
+outside the repository.  `acme` is equivalent to the directory name for your project.
+Don't worry, validation will make sure you have the path right.
 
-    access_key_id: XXXXXX
-    secret_access_key: XXXXXX
+```ruby
+access_key_id: XXXXXX
+secret_access_key: XXXXXX
+```
+
+If you don't create config file, then environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` will be used. If there are no such variables, then request to AWS will fail (unless middleman-aws is used on EC2 instance with correct IAM role, then AWS will take care of authorising requests).
 
 ### Step 4: Add the necessary s3_sync and Cloudfront sections to your config
 This is a sample of how a common config is setup with variables extracted:
 
-    # Configuration variables specific to each project
-    #------------------------------------------------------------------------
-    AWS_BUCKET                      = 'acme.alienfast.com'
-    AWS_CLOUDFRONT_DISTRIBUTION_ID  = 'xxxxxx'
-
-    # Variables: Sent in on CLI by rake task via ENV
-    #------------------------------------------------------------------------
-    AWS_ACCESS_KEY                  = ENV['AWS_ACCESS_KEY']
-    AWS_SECRET                      = ENV['AWS_SECRET']
-    
-    # https://github.com/fredjean/middleman-s3_sync
-    activate :s3_sync do |s3_sync|
-      s3_sync.bucket                     = AWS_BUCKET # The name of the S3 bucket you are targeting. This is globally unique.
-      s3_sync.aws_access_key_id          = AWS_ACCESS_KEY
-      s3_sync.aws_secret_access_key      = AWS_SECRET
-      s3_sync.delete                     = false # We delete stray files by default.
-    end
-    
-    # https://github.com/andrusha/middleman-cloudfront
-    activate :cloudfront do |cf|
-      cf.access_key_id                    = AWS_ACCESS_KEY
-      cf.secret_access_key                = AWS_SECRET
-      cf.distribution_id                  = AWS_CLOUDFRONT_DISTRIBUTION_ID
-      # cf.filter = /\.html$/i
-    end
+```ruby
+# Configuration variables specific to each project
+#------------------------------------------------------------------------
+AWS_BUCKET                      = 'acme.alienfast.com'
+AWS_CLOUDFRONT_DISTRIBUTION_ID  = 'xxxxxx'
+
+# Variables: Sent in on CLI by rake task via ENV
+#------------------------------------------------------------------------
+AWS_ACCESS_KEY                  = ENV['AWS_ACCESS_KEY']
+AWS_SECRET                      = ENV['AWS_SECRET']
+
+# https://github.com/fredjean/middleman-s3_sync
+activate :s3_sync do |s3_sync|
+  s3_sync.bucket                     = AWS_BUCKET # The name of the S3 bucket you are targeting. This is globally unique.
+  s3_sync.aws_access_key_id          = AWS_ACCESS_KEY
+  s3_sync.aws_secret_access_key      = AWS_SECRET
+  s3_sync.delete                     = false # We delete stray files by default.
+end
+
+# https://github.com/andrusha/middleman-cloudfront
+activate :cloudfront do |cf|
+  cf.access_key_id                    = AWS_ACCESS_KEY
+  cf.secret_access_key                = AWS_SECRET
+  cf.distribution_id                  = AWS_CLOUDFRONT_DISTRIBUTION_ID
+  # cf.filter = /\.html$/i
+end
+```
 
 # Usage
-Run the desired rake task.  It's as simple as `rake mm:publish` in one step, or you can choose to do things one step at a time.  
+Run the desired rake task.  It's as simple as `rake mm:publish` in one step, or you can choose to do things one step at a time.
 See the available rake tasks below or run `rake -T`
 
 # Available Rake Tasks
@@ -64,6 +79,10 @@ See the available rake tasks below or run `rake -T`
     rake mm:publish      # One step clobber, build, deploy
     rake mm:show_config  # Show config
 
+# Real World Sample
+If you are just getting started with middleman and want to get a quick jumpstart on your `Gemfile` and `congfig.rb`,
+check out the source in the `samples` directory for a set of commonly used configurations/gems/extensions.
+
 ## Contributing
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
@@ -73,4 +92,4 @@ See the available rake tasks below or run `rake -T`
 
 ## Copyright
 
-Copyright (c) 2014 AlienFast, LLC. See MIT LICENSE.txt for further details.
+Copyright (c) 2014 AlienFast, LLC. See MIT LICENSE.txt for further details.

data/lib/middleman-aws/tasks/middleman-aws.rake

@@ -24,22 +24,17 @@ namespace :mm do
 
     puts '## Deploy starting...'
     cd 'build' do
-      # system 'git add .'
       system 'git add -u'
       message = "Site updated at #{Time.now}"
       puts "## Commiting: #{message}"
       system "git commit -m \"#{message}\""
-      # puts "## Pushing generated website"
-      # system "git push origin master"
-      # puts "## Github Pages deploy complete"
     end
 
-    credentials!
-    aws_env = "AWS_ACCESS_KEY=#{credentials['access_key_id']} AWS_SECRET=#{credentials['secret_access_key']}"
+    aws_env = "AWS_ACCESS_KEY=#{credentials[:access_key_id]} AWS_SECRET=#{credentials[:secret_access_key]}"
     puts '## Syncing to S3...'
     system "#{aws_env} bundle exec middleman s3_sync"
     puts '## Invalidating cloudfront...'
-    system "#{aws_env}  bundle exec middleman invalidate"
+    system "#{aws_env} bundle exec middleman invalidate"
     puts '## Deploy complete.'
   end
 
@@ -56,33 +51,30 @@ namespace :mm do
   desc 'Show config'
   task :show_config do |t, args|
 
-    credentials!
-
     puts "\n----------------------------------------------------------------------------------"
     puts 'Configuration:'
     puts "\t:working directory: #{Rake.original_dir}"
     puts "\t:project: #{project}"
     puts "\t:aws_secrets_file: #{aws_secrets_file}"
-    puts "\t:access_key_id: #{credentials['access_key_id']}"
+    puts "\t:access_key_id: #{credentials[:access_key_id]}"
     puts "----------------------------------------------------------------------------------\n"
   end
 
-  # validate file exists
-  def credentials!
-    raise "\nFailed to load AWS secrets: #{aws_secrets_file}.\nFile contents should look like:\naccess_key_id: XXXX\nsecret_access_key: XXXX\n\n" unless File.exists?(aws_secrets_file)
-    credentials
-
-    ['access_key_id', 'secret_access_key'].each do |key|
-      value = credentials[key]
-      raise "\nThe #{key} must be specified in the #{aws_secrets_file}.\n\n" if value.nil?
+  def credentials
+    unless File.exists?(aws_secrets_file)
+      puts "\nWarning: Config file is missing: #{aws_secrets_file}.\nFile contents should look like:\naccess_key_id: XXXX\nsecret_access_key: XXXX\n\n."
     end
-  end
 
-  # load from a user directory i.e. ~/.aws/acme.yml
-  def credentials
-    # load secrets from the user home directory
-    @credentials = YAML::load_file(aws_secrets_file) if @credentials.nil?
-    @credentials
+    # load from a user directory i.e. ~/.aws/acme.yml
+    credentials = File.exists?(aws_secrets_file) ? YAML::load_file(aws_secrets_file) : {}
+
+    access_key_id     = credentials.fetch('access_key_id') { ENV['AWS_ACCESS_KEY_ID'] }
+    secret_access_key = credentials.fetch('secret_access_key') { ENV['AWS_SECRET_ACCESS_KEY'] }
+
+    {
+      access_key_id: access_key_id
+      secret_access_key: secret_access_key
+    }
   end
 
   def aws_secrets_file
@@ -92,4 +84,4 @@ namespace :mm do
   def project
     File.basename(Rake.original_dir)
   end
-end
+end

data/middleman-aws.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'middleman-aws'
-  s.version     = '0.0.8'
+  s.version     = '1.0.0'
   s.platform    = Gem::Platform::RUBY
 
   s.authors = ['Kevin Ross']
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.homepage = 'https://github.com/alienfast/middleman-aws'
   s.license = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
+  s.files         = `git ls-files`.split($/).reject { |f| f =~ /^samples\// }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: middleman-aws
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Kevin Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-s3_sync
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: middleman-cloudfront
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   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: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -60,8 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rvmrc"
 - Gemfile
 - LICENSE
 - README.md
@@ -80,17 +80,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Simple set of middleman rake tasks to build and deploy to AWS using s3_sync