cfer 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +8 -8
  2. data/README.md +17 -0
  3. data/cfer.gemspec +0 -1
  4. data/lib/cfer.rb +0 -1
  5. data/lib/cfer/core/stack.rb +0 -2
  6. data/lib/cfer/version.rb +1 -1
  7. metadata +2 -16
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- YmZlMTM5YzllNzU0ZjJiMTliYWEyMWIwYTVmNjU1OWFmNjQ0NDk5Yw==
4
+ ZWVkYTNhODMzYjViNDE5NGYwMjY0MGJkYTMwMWI0NGU0YTI3M2UzYQ==
5
5
  data.tar.gz: !binary |-
6
- MmUxM2Y1ZjkwOWMyNDA5Mzk4OWJkZTA0Y2Y5ZTdmMjU3NzY3Nzg1Mg==
6
+ ZWMzZDQzMzAxMWRiZGNhODVmODYzMTU1NjU0NzBkZjMyYmZkY2U0ZQ==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- NmQyNGQyOWZmOTA1Mzc2OGQ3NmE0Mjg5YTE5MzdmYWFhNDQ4ODZkZTRjOTc1
10
- ZTFmOTA5ZmJiODg3YzkwMTk0MTE5MGQzYWFlOTA0OGMxMzNlZTkyY2IwZjU4
11
- NTdkMWQyZGEzYTEzMDE5MGU2YjFlMzljMzI3NzczZjJhYTJhMWY=
9
+ Nzg3MzgyNmYzODRkZDUwY2UyMzk0NjIxYjk2MTZhYjI2YjYyOTUxM2EwNGUz
10
+ NGE4YmM1MWUyMGVjNmNjMDFmMzlkOWY3NzNmNWNmNjY0YzA3NWM0MTY1MzM5
11
+ Zjg4MTM1ZmRkNzMxMTExOTFiNjNmMTczNWEwZWVmZGExMjhkYjM=
12
12
  data.tar.gz: !binary |-
13
- YzkzMjUzMGJjYzgzODc2MmFkZWRlZjdiMzFkZDI1NGI5YmQ5ZWQxOWQ4ZTUy
14
- YWZiZDZhYmJmNGQ5YmUzNTA4MDRkNTZhMThiMDhjMmRiY2IxZTA5MzBiZDM2
15
- MDgxYzA0MTE3M2M0OGVhMWI0MjYxNmM5OTA4YTE2YzQwNzU5M2U=
13
+ ODJiZGZlNTU4MzZlMzI4ODg5NjM3ZDVhOTBjNTFjNzM3ZDEzYmY1ZDA1NWI5
14
+ ZmQ4Y2M5ODIzNjUyZTUzOGRmOTRkMzk5N2E1NDY4Y2ViZDI5NmIxY2NmYjMy
15
+ ZDQwYjBlOGIxYjYxMjkwNDM1MzU4NGM5NTgxZTFiOGRhMmUzODA=
data/README.md CHANGED
@@ -2,6 +2,7 @@
2
2
 
3
3
  [![Build Status](https://travis-ci.org/seanedwards/cfer.svg?branch=master)](https://travis-ci.org/seanedwards/cfer)
4
4
  [![Coverage Status](https://coveralls.io/repos/seanedwards/cfer/badge.svg)](https://coveralls.io/r/seanedwards/cfer)
5
+ [![Gem Version](https://badge.fury.io/rb/cfer.svg)](http://badge.fury.io/rb/cfer)
5
6
 
6
7
  Cfer is a lightweight toolkit for managing CloudFormation templates.
7
8
 
@@ -141,8 +142,22 @@ output :OutputName, Fn::ref(:ResourceName)
141
142
  Embedding the Cfer SDK involves interacting with two components: The `Client` and the `Stack`.
142
143
  The Cfer `Client` is the interface with the Cloud provider.
143
144
 
145
+ ### Basic API
146
+
147
+ The simplest way to use Cfer from Ruby looks similar to the CLI:
148
+
149
+ ```ruby
150
+ Cfer.converge! '<stack-name>', template: '<template-file>'
151
+ ```
152
+
153
+ This is identical to running `cfer converge <stack-name> --template <template-file>`, but is better suited to embedding in Rakefiles, chef recipes, or your own Ruby scripts.
154
+ See the Rakefile in this repository for how this might look.
155
+
144
156
  ### Cfn Client
145
157
 
158
+ The Client is a wrapper around Amazon's CloudFormation client from the AWS Ruby SDK.
159
+ Its purpose is to interact with the CloudFormation API.
160
+
146
161
  Create a new client:
147
162
 
148
163
  ```ruby
@@ -171,6 +186,8 @@ end
171
186
 
172
187
  ### Cfer Stacks
173
188
 
189
+ A Cfer stack represents a baked CloudFormation template, which is ready to be converted to JSON.
190
+
174
191
  Create a new stack:
175
192
 
176
193
  #### `stack_from_file`
data/cfer.gemspec CHANGED
@@ -28,7 +28,6 @@ Gem::Specification.new do |spec|
28
28
  spec.add_runtime_dependency 'semantic'
29
29
  spec.add_runtime_dependency 'rainbow'
30
30
  spec.add_runtime_dependency 'highline'
31
- spec.add_runtime_dependency 'rugged'
32
31
  spec.add_runtime_dependency 'table_print'
33
32
  spec.add_runtime_dependency "rake"
34
33
 
data/lib/cfer.rb CHANGED
@@ -2,7 +2,6 @@ require 'active_support/all'
2
2
  require 'aws-sdk'
3
3
  require 'logger'
4
4
  require 'json'
5
- require 'rugged'
6
5
  require 'preconditions'
7
6
  require 'rainbow'
8
7
 
data/lib/cfer/core/stack.rb CHANGED
@@ -7,7 +7,6 @@ module Cfer::Core
7
7
 
8
8
  attr_reader :parameters
9
9
  attr_reader :options
10
- attr_reader :git
11
10
 
12
11
  def converge!
13
12
  if @options[:client]
@@ -30,7 +29,6 @@ module Cfer::Core
30
29
  self[:Description] = ''
31
30
 
32
31
  @options = options
33
- @git = Rugged::Repository.discover('.')
34
32
 
35
33
  self[:Parameters] = {}
36
34
  self[:Mappings] = {}
data/lib/cfer/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Cfer
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.3"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cfer
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sean Edwards
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2015-06-05 00:00:00.000000000 Z
11
+ date: 2015-06-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: docile
@@ -136,20 +136,6 @@ dependencies:
136
136
  - - ! '>='
137
137
  - !ruby/object:Gem::Version
138
138
  version: '0'
139
- - !ruby/object:Gem::Dependency
140
- name: rugged
141
- requirement: !ruby/object:Gem::Requirement
142
- requirements:
143
- - - ! '>='
144
- - !ruby/object:Gem::Version
145
- version: '0'
146
- type: :runtime
147
- prerelease: false
148
- version_requirements: !ruby/object:Gem::Requirement
149
- requirements:
150
- - - ! '>='
151
- - !ruby/object:Gem::Version
152
- version: '0'
153
139
  - !ruby/object:Gem::Dependency
154
140
  name: table_print
155
141
  requirement: !ruby/object:Gem::Requirement