tfoutputs 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce846ca6bd7bd7b6f76e17ac3c1c7971cc92cda7
-  data.tar.gz: 73e3495d3826861b05de0c388504b3c4d7533f52
+  metadata.gz: 0d1f519f69a2617bb93343edad27b1ebbc412363
+  data.tar.gz: 3c17ea150793faa27f730a015c89ca8e14fd3512
 SHA512:
-  metadata.gz: fa5391c6e6c00f81d70d78be77dadf2d1731154d3a90617c2e88fc2fb611694bc54672f61dae86f8993144c2c3016fbfe9174e48e14b8dc9c41a2dcae225c0ca
-  data.tar.gz: d5a317d6a4ecd5a094d49ccd3fae4bbf0a4ffb1d72ec0de25034da59996f3a4aed3ac4c7c7c6c9b7c171dd00f4af85038734b308b1824e1caec687f6faa2d797
+  metadata.gz: 74e2f00ce1c15b3393ef111e8a1a5fbb179a28669c52cdc7294f5e3bf8c56dd0ca45765bdfc2ac1b8c9c2646cd300d8f381c81c85b8f6997b3ebd17bc08063dc
+  data.tar.gz: d025fe9843ee9013bbf253344cfcb58c9bce597081de440a3ff6e930f94102c1a77167917eba62dedc4121077326b0e8555cec5b1b685319fb325f02de99aa96

data/.gitignore

@@ -12,3 +12,4 @@
 bin/
 binaries/
 vendor/
+.ruby_version

data/README.md

@@ -9,7 +9,7 @@
 
 # Ruby TF Outputs
 
-This gem takes your terraform outputs and imports them into ruby. 
+This gem is a ruby interface to access your terraform outputs.
 
 ## Installation
 
@@ -27,9 +27,63 @@ Or install it yourself as:
 
     $ gem install tfoutputs
 
+
+
+
+## Pre-requistes
+
+Ruby >= 2.2.2
+Your terraform state file also needs to be generated by terraform > 0.7.0  there are currently no plans to support terraform < 0.7.0
+
+
+
 ## Usage
 
-TODO: Write usage instructions here
+Require the gem:
+
+```ruby
+require 'tfoutputs'
+```
+
+tfoutputs uses 'backends' as a means of retrieving the state files. A backend is a place where the terraform state file lives. Currently only two are supported: s3 and file.
+
+Setting up an s3 backend:
+
+```ruby
+config = {:backend => 's3',:options => {:bucket_name => 'my-bucket-name-goes-here',
+           :bucket_region => 'eu-west-1', :bucket_key => 'terraform.tfstate' }
+         }
+state_reader = TfOutputs.configure(config)
+puts(state_reader.my_output_name)
+         
+```
+Gives us:
+
+```
+it works
+
+```
+
+Setting up a file backend:
+```ruby
+config = {:backend => 'file', :options => { :file_path => '/path/to/state/file/terraform.tfstate' } }
+state_reader = TfOutputs.configure(config)
+puts(state_reader.my_output_name)
+
+```
+
+
+Using multiple states with multiple backends:
+
+```ruby
+config = [{:backend => 's3',:options => {:bucket_name => 'my-bucket-name-goes-here',
+           :bucket_region => 'eu-west-1', :bucket_key => 'terraform.tfstate' }
+         },
+          {:backend => 'file', :options => { :file_path => '/path/to/state/file/terraform.tfstate' } }
+        ]
+state_reader = TfOutputs.configure(config)
+puts(state_reader.my_output_name)
+```
 
 
 ## Contributing

data/lib/tfoutputs/configurator/file_state_configuration.rb

@@ -1,8 +1,6 @@
 module TfOutputs
   module Configurator
     class FileStateConfiguration
-      attr_accessor :file_paths
-
       def initialize(options)
         @options = options
       end

data/lib/tfoutputs/configurator/state_configurator.rb

@@ -13,6 +13,7 @@ module TfOutputs
       def initialize(states_array)
         @states_array = states_array
       end
+
       def file_list
         file_list = []
         @states_array.each do |state_hash|

data/lib/tfoutputs/configurator/state_reader.rb

@@ -41,7 +41,7 @@ module TfOutputs
           return output[name.to_s]['value']
         end
         super(name, *args, &block)
+      end
     end
   end
-  end
 end

data/lib/tfoutputs/configurator/version.rb

@@ -1,5 +1,5 @@
 module TfOutputs
   module Configurator
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tfoutputs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - James Edwards
@@ -131,7 +131,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -165,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Gem for grabbing variables from terraform

data/.ruby-version

@@ -1 +0,0 @@
-2.3.0