aws_metadata 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23fc0654669922ff9d4131779dc09308d7491715
-  data.tar.gz: 55fb15342c8d499a5e3d4ec94f2846a518a7e8d8
+  metadata.gz: f848656d02297d4237d2ee354bcfed769f35713a
+  data.tar.gz: d22372ceeba57b08c7414bc0585483f23760137a
 SHA512:
-  metadata.gz: f0726ebb66175444ab5adf5d3153b313f11e95cdc7991b118f6d01c5808f99330f4c0d1cc8d97367d1875f741faec9f811f5b2522add5765d54693a30b7a4724
-  data.tar.gz: 7b938f5c05bd5488f3fcc8b7eeab91e4ffa4f25973838fb827840eb25817c1d3d2e1be34e94cae75997658657c867d4cd00d7610480293614a2a38f3bbc858d3
+  metadata.gz: 0f93d679f0f092d1873f12a5065d424cc7d20ab92e83715dbedd9d79b3ccc4f59d3e6dada2338264acff9c0fd076e89204cd903dc15cc6569f209cc75340e498
+  data.tar.gz: cda4639dd418ed53ea0f90883424f634903dfd32cd3a3de3dff670658f6c8bf09beb0cbb558253c96aecf7cba3abedceab5d0de32ac12801aefe61ba05821271

data/README.md

@@ -45,6 +45,27 @@ AWS::Metadata.stub_responses = Rails.env =~ /development|test/
 ```
 
 This will prevent HTTP calls to 169.254.169.254 and return canned results.
+
+If you have `stub_responses` set to true, you can create a `aws_identity_stubs.yml` file with the data you want returned.
+By default, the gem will look for `aws_identity_stubs.yml` in the `config` directory of a Rails app.  
+If you don't setup your own `aws_identity_stubs.yml`, then the gem will use it's own found in test/fixtures/aws_identity_stubs.yml.  You can also use this file as a template for creating your own with custom data.
+If you are not using this gem in a Rails app, then you need to specify the path in the initializer.
+
+```ruby
+AWS::Metadata.configure do |config|
+  config.stub_responses = Rails.env =~ /development|test/
+  config.aws_identity_stubs_path = 'path/to/aws_identity_stubs.yml'
+end
+```
+
+or 
+
+```ruby
+AWS::Metadata.stub_responses = Rails.env =~ /development|test/
+AWS::Metadata.aws_identity_stubs_path = 'path/to/aws_identity_stubs.yml'
+AWS::StackOutput.get
+````
+
 When stubbing responses, both `AWS::Instance` and `AWS::StackOutput` will be stubbed.
 
 ## Usage for `AWS::StackOutput`

data/lib/aws_metadata/instance_metadata.rb

@@ -89,7 +89,8 @@ module AWS
     # Helper method to provide "stubs" for non aws deployments
     # @private
     def load_stubs
-      responses = YAML.load_file(File.expand_path(File.dirname(__FILE__) + '/../../test/fixtures/responses.yml'))
+      yaml = Pathname.new(File.join(AWS::Metadata.aws_identity_stubs_path, 'aws_identity_stubs.yml'))
+      responses = YAML.load(ERB.new(yaml.read).result)
       @metadata = Hashish.new responses[:metadata]
       @user_data = responses[:user_data]
       @dynamic = Hashish.new responses[:dynamic]

data/lib/aws_metadata/version.rb

@@ -1,5 +1,5 @@
 module AWS
   module Metadata
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/aws_metadata.rb

@@ -52,11 +52,28 @@ module AWS
       @stack_name
     end
 
+    # Set the path to the aws_identity_stubs.yml
+    #
+    # Only needs to be set if {.stub_responses} is set to true.
+    #
+    # @return [String]
+    def self.aws_identity_stubs_path=(aws_identity_stubs_path)
+      @aws_identity_stubs_path = aws_identity_stubs_path
+    end
+
+    # Set the path to the aws_identity_stubs.yml
+    #
+    # Defaults to the config directory in a Rails application, or the file in tests/fixtures/aws_identity_stubs.yml if not in a Rails app.
+    #
+    # @return [String]
+    def self.aws_identity_stubs_path
+      @aws_identity_stubs_path ||= defined?(Rails) ? Rails.root.join('config') : File.expand_path(File.dirname(__FILE__) + '/../test/fixtures')
+    end
+
     # Set the path to the cfn_dev_output.yml file with the keys you have defined as Outputs for your Cloud Formation stack.
     #
     # Only needs to be set if {.stub_responses} is set to true.
     #
-    # @param stack_name
     # @return [String]
     def self.cfn_dev_outputs_path=(dev_outputs_path)
       @dev_outputs_path = dev_outputs_path
@@ -66,7 +83,6 @@ module AWS
     #
     # Defaults to the config directory in a Rails application.
     #
-    # @param stack_name
     # @return [String]
     def self.cfn_dev_outputs_path
       @dev_outputs_path ||= defined?(Rails) ? Rails.root.join('config') : ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws_metadata
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Evident.io
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ files:
 - lib/aws_metadata/instance_metadata.rb
 - lib/aws_metadata/version.rb
 - lib/extensions/string.rb
-- test/fixtures/responses.yml
+- test/fixtures/aws_identity_stubs.yml
 homepage: https://github.com/EvidentSecurity/aws_metadata
 licenses: []
 metadata: {}
@@ -133,4 +133,4 @@ signing_key:
 specification_version: 4
 summary: Gem to provide the Instance Metadata and Cloud Formation template outputs.
 test_files:
-- test/fixtures/responses.yml
+- test/fixtures/aws_identity_stubs.yml