bundle_cache 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9683472d381ee5cd88568aecfead357a34fd66f
-  data.tar.gz: 3fd8be58d5f8ac6f2c10cc7def71427bbc305121
+  metadata.gz: 714d518b79ff1f109f21327f53fcb8d4a4ac3694
+  data.tar.gz: da7e0c1da19f25f1542dc04d277a8c39a44baa60
 SHA512:
-  metadata.gz: 2986f2126120c2d8a4198505dbc3f665aaa6b0e0305e15cc3392d3e8fb4d7249dad82c9bca09d9b66220ac904fff46b92f9d3a7269432fb401085403cf11306a
-  data.tar.gz: d530fa02cfce66dddc23dcdef60fdc4e2dbabda0c87e90f0453f73fa5e9a1b782593c6a91e9c93872553987ff9c6ad4ff026fa171a65495759ec067de19ccfab
+  metadata.gz: 496bb2a9ff0decc29540bcc7e72ac4d632f2acb7dd1f2bca6d0f9ef1e8d8231537b6cb66a654f177d7e8e61e006ca0cf7a53a3fc4b4f959dbc8dc33eaf16aa70
+  data.tar.gz: 9bbd9cc5b0b6c948d2c67de79e7035b638945d85ec4c4ec5e243ee5d367288de3a9abeddabcfe48c4dcccdaac6f12b9f94a857becf0513828a36c0c5e89ebfb9

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/data-axle/bundle_cache.png?branch=master)](https://travis-ci.org/data-axle/bundle_cache)
 
-Utility for caching bundled gems on S3. Useful for speeding up Travis builds - 
+Utility for caching bundled gems on S3. Useful for speeding up Travis builds -
 it doesn't need to wait for `bundle install` to download/install all gems.
 
 ## Installation
@@ -16,13 +16,20 @@ Adding this to your Gemfile defeats the purpose. Instead, run
 You'll need to set some environment variables to make this work.
 
 ```
-AWS_S3_KEY=<your aws access key>
-AWS_S3_SECRET=<your aws secret>
+AWS_ACCESS_KEY_ID=<your aws access key>
+AWS_SECRET_ACCESS_KEY=<your aws secret>
 AWS_S3_BUCKET=<your bucket name>
 BUNDLE_ARCHIVE=<the filename to use for your cache>
 ```
 
-Optionally, you can set the `AWS_S3_REGION` variable if you don't use us-east-1.
+Optionally, you can set the `AWS_DEFAULT_REGION` variable if you don't use us-east-1.
+
+If you're using [IAM roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html) for your S3 credentials you might run into issues like "The AWS Access Key Id you provided does not exist in our records."
+In this case you wont need the `AWS_ACCESS_KEY_ID` or `AWS_SECRET_ACCESS_KEY` only the `AWS_SESSION_TOKEN`.
+
+```
+AWS_SESSION_TOKEN=<your aws session token>
+```
 
 ## Travis configuration
 
@@ -48,9 +55,9 @@ add the AWS credentials:
 
 1. Install the travis gem with gem install travis
 2. Log into Travis with travis login --auto (from inside your project respository directory)
-3. Encrypt your S3 credentials with: travis encrypt AWS_S3_KEY="" AWS_S3_SECRET="" --add (be sure to add your actual credentials inside the double quotes)
+3. Encrypt your S3 credentials with: travis encrypt AWS_ACCESS_KEY_ID="" AWS_SECRET_ACCESS_KEY="" --add (be sure to add your actual credentials inside the double quotes)
 
 ## License
 
-This code was originally written by Matias Korhonen and is available at 
+This code was originally written by Matias Korhonen and is available at
 http://randomerrata.com/post/45827813818/travis-s3. It is MIT licensed.

data/bin/bundle_cache

@@ -2,13 +2,5 @@
 
 require_relative '../lib/bundle_cache'
 
-required_env = %w(AWS_S3_KEY AWS_S3_SECRET AWS_S3_BUCKET BUNDLE_ARCHIVE)
-
-required_env.each do |var|
-  unless ENV[var]
-    puts "Missing ENV[#{var}]"
-    exit 1
-  end
-end
-
+BundleCache.verify_env
 BundleCache.cache

data/bin/bundle_cache_install

@@ -2,13 +2,5 @@
 
 require_relative '../lib/bundle_cache'
 
-required_env = %w(AWS_S3_KEY AWS_S3_SECRET AWS_S3_BUCKET BUNDLE_ARCHIVE)
-
-required_env.each do |var|
-  unless ENV[var]
-    puts "Missing ENV[#{var}]"
-    exit 1
-  end
-end
-
-BundleCache.install
+BundleCache.verify_env
+BundleCache.install

data/bundle_cache.gemspec

@@ -19,8 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "aws-sdk", ">= 1.0.0"
-  spec.add_dependency "bundler"
+  spec.add_dependency "bundler", "~> 1.3"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/bundle_cache.rb

@@ -1,3 +1,4 @@
+require "bundle_cache/validation"
 require "bundle_cache/version"
 require "bundle_cache/cache"
 require "bundle_cache/install"

data/lib/bundle_cache/cache.rb

@@ -3,13 +3,6 @@ require "aws-sdk"
 
 module BundleCache
   def self.cache
-    # Setup AWS credentials
-    AWS.config({
-      :access_key_id => ENV["AWS_S3_KEY"],
-      :secret_access_key => ENV["AWS_S3_SECRET"],
-      :region => ENV["AWS_S3_REGION"] || "us-east-1"
-    })
-
     acl_to_use = ENV["KEEP_BUNDLE_PRIVATE"] ? :private : :public_read
     bundle_dir = ENV["BUNDLE_DIR"] || "~/.bundle"
     processing_dir = ENV["PROCESS_DIR"] || ENV["HOME"]

data/lib/bundle_cache/install.rb

@@ -10,11 +10,6 @@ module BundleCache
     bundle_dir = ENV["BUNDLE_DIR"] || "~/.bundle"
     processing_dir = ENV['PROCESS_DIR'] || ENV['HOME']
 
-    AWS.config({
-      :access_key_id => ENV["AWS_S3_KEY"],
-      :secret_access_key => ENV["AWS_S3_SECRET"],
-      :region => ENV["AWS_S3_REGION"] || "us-east-1"
-    })
     s3 = AWS::S3.new
     bucket = s3.buckets[bucket_name]
 

data/lib/bundle_cache/validation.rb

@@ -0,0 +1,42 @@
+module BundleCache
+  extend self
+
+  def verify_env
+    deprecation_warning
+
+    %w(AWS_S3_BUCKET BUNDLE_ARCHIVE).each do |var|
+      abort("Missing ENV[#{var}]") unless ENV[var]
+    end
+
+    abort("Missing required AWS credentials") if (session_token_missing? && access_keys_missing?)
+  end
+
+  def session_token_missing?
+    ENV['AWS_SESSION_TOKEN'].nil?
+  end
+
+  def access_keys_missing?
+    ENV['AWS_ACCESS_KEY_ID'].nil? || ENV['AWS_SECRET_ACCESS_KEY'].nil?
+  end
+
+  def deprecation_warning
+    if !!ENV['AWS_S3_KEY']
+      puts "The 'AWS_S3_KEY' environment variable is deprecated and will be removed in the future."
+      puts "Please set 'AWS_ACCESS_KEY_ID' instead"
+      ENV['AWS_ACCESS_KEY_ID'] = ENV['AWS_S3_KEY']
+    end
+
+    if !!ENV['AWS_S3_SECRET']
+      puts "The 'AWS_S3_SECRET' environment variable is deprecated and will be removed in the future."
+      puts "Please set 'AWS_SECRET_ACCESS_KEY' instead"
+      ENV['AWS_SECRET_ACCESS_KEY'] = ENV['AWS_S3_SECRET']
+    end
+
+    if !!ENV['AWS_S3_REGION']
+      puts "The 'AWS_S3_REGION' environment variable is deprecated and will be removed in the future."
+      puts "Please set 'AWS_DEFAULT_REGION' instead"
+      ENV['AWS_DEFAULT_REGION'] = ENV['AWS_S3_REGION']
+    end
+  end
+
+end

data/lib/bundle_cache/version.rb

@@ -1,3 +1,3 @@
 module BundleCache
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bundle_cache
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Eric Barendt
@@ -9,62 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   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: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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'
 description: Caches bundled gems on S3
@@ -77,8 +63,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -88,6 +74,7 @@ files:
 - lib/bundle_cache.rb
 - lib/bundle_cache/cache.rb
 - lib/bundle_cache/install.rb
+- lib/bundle_cache/validation.rb
 - lib/bundle_cache/version.rb
 homepage: https://github.com/data-axle/bundle_cache
 licenses:
@@ -99,17 +86,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.2.2
 signing_key: 
 specification_version: 4
 summary: Speed up your build on Travis CI by caching bundled gems in an S3 bucket