automate_soup 0.1.0 → 0.1.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 2c913996a141bbcadf9563efcf19c7e87b35e7eb
4
- data.tar.gz: dcecb85948a5b33f148410b12eacd138886071d3
3
+ metadata.gz: c3f6b554c5615cb81dd4099a66320f56b12ef5e4
4
+ data.tar.gz: 66e99ba4bb788a37851da46a05721a2d22868950
5
5
  SHA512:
6
- metadata.gz: 7f9c9188cf5d02a38663d710803549f7c1a9f3df3088bc55079437bc8a52a2feac7174ff99a09660bdf1dafb22b14b13ba0e9c121ba7aefeaf05d6712ac9085c
7
- data.tar.gz: a20b27ea999d07997a26fa526e0621abd15ff42ff887ee5056de5a5916a04d0a8dd7ad2a3e3f615a347c36b6a6656894b9e91a1c9e9aed60d7d4a1a7804a2492
6
+ metadata.gz: 72d465645bd7a03cf5609eab54995cef33fddad68ebda356ae7e1eb585523b7ea829fd0ce635370a76c03a57a1201a00181da21311a3ec11b9688bdb68de9c5f
7
+ data.tar.gz: 72fccb1c49f5faf9809712c2376acd0a4a6bb14de12dd98cf846e7ed3ed38096a0ef7ad4803da2d4c0dd4badcbcdc0abd8f21516a84976bef98b14c649a6793e
@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
11
11
  spec.email = ['skylerclayne@gmail.com']
12
12
 
13
13
  spec.summary = 'Ruby API for interacting with Chef Automate'
14
- spec.description = 'Ruby API for interacting with Chef Automate'
14
+ spec.description = File.read('./README.md')
15
15
  spec.homepage = 'https://github.com/skylerto/automate_soup'
16
16
  spec.license = 'MIT'
17
17
 
@@ -1164,7 +1164,7 @@
1164
1164
  </div>
1165
1165
 
1166
1166
  <div id="footer">
1167
- Generated on Mon Dec 18 14:46:35 2017 by
1167
+ Generated on Mon Dec 18 14:49:18 2017 by
1168
1168
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1169
1169
  0.9.9 (ruby-2.4.1).
1170
1170
  </div>
@@ -882,7 +882,7 @@
882
882
  </div>
883
883
 
884
884
  <div id="footer">
885
- Generated on Mon Dec 18 14:46:35 2017 by
885
+ Generated on Mon Dec 18 14:49:18 2017 by
886
886
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
887
887
  0.9.9 (ruby-2.4.1).
888
888
  </div>
@@ -442,7 +442,7 @@
442
442
  </div>
443
443
 
444
444
  <div id="footer">
445
- Generated on Mon Dec 18 14:46:35 2017 by
445
+ Generated on Mon Dec 18 14:49:18 2017 by
446
446
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
447
447
  0.9.9 (ruby-2.4.1).
448
448
  </div>
@@ -311,7 +311,7 @@
311
311
  </div>
312
312
 
313
313
  <div id="footer">
314
- Generated on Mon Dec 18 14:46:35 2017 by
314
+ Generated on Mon Dec 18 14:49:18 2017 by
315
315
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
316
316
  0.9.9 (ruby-2.4.1).
317
317
  </div>
@@ -418,7 +418,7 @@
418
418
  </div>
419
419
 
420
420
  <div id="footer">
421
- Generated on Mon Dec 18 14:46:35 2017 by
421
+ Generated on Mon Dec 18 14:49:18 2017 by
422
422
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
423
423
  0.9.9 (ruby-2.4.1).
424
424
  </div>
@@ -2556,7 +2556,7 @@
2556
2556
  </div>
2557
2557
 
2558
2558
  <div id="footer">
2559
- Generated on Mon Dec 18 14:46:35 2017 by
2559
+ Generated on Mon Dec 18 14:49:18 2017 by
2560
2560
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
2561
2561
  0.9.9 (ruby-2.4.1).
2562
2562
  </div>
data/docs/_index.html CHANGED
@@ -156,7 +156,7 @@
156
156
  </div>
157
157
 
158
158
  <div id="footer">
159
- Generated on Mon Dec 18 14:46:34 2017 by
159
+ Generated on Mon Dec 18 14:49:18 2017 by
160
160
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
161
161
  0.9.9 (ruby-2.4.1).
162
162
  </div>
@@ -140,6 +140,6 @@
140
140
  null
141
141
  ]
142
142
  },
143
- "timestamp": 1513626394
143
+ "timestamp": 1513626557
144
144
  }
145
145
  }
@@ -14,7 +14,7 @@
14
14
  <img src="./assets/0.10.2/loading.gif" alt="loading"/>
15
15
  </div>
16
16
  <div id="wrapper" style="display:none;">
17
- <div class="timestamp">Generated <abbr class="timeago" title="2017-12-18T14:46:34-05:00">2017-12-18T14:46:34-05:00</abbr></div>
17
+ <div class="timestamp">Generated <abbr class="timeago" title="2017-12-18T14:49:17-05:00">2017-12-18T14:49:17-05:00</abbr></div>
18
18
  <ul class="group_tabs"></ul>
19
19
 
20
20
  <div id="content">
@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
201
201
  </div></div>
202
202
 
203
203
  <div id="footer">
204
- Generated on Mon Dec 18 14:46:35 2017 by
204
+ Generated on Mon Dec 18 14:49:18 2017 by
205
205
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
206
206
  0.9.9 (ruby-2.4.1).
207
207
  </div>
data/docs/index.html CHANGED
@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
201
201
  </div></div>
202
202
 
203
203
  <div id="footer">
204
- Generated on Mon Dec 18 14:46:35 2017 by
204
+ Generated on Mon Dec 18 14:49:18 2017 by
205
205
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
206
206
  0.9.9 (ruby-2.4.1).
207
207
  </div>
@@ -100,7 +100,7 @@
100
100
  </div>
101
101
 
102
102
  <div id="footer">
103
- Generated on Mon Dec 18 14:46:35 2017 by
103
+ Generated on Mon Dec 18 14:49:18 2017 by
104
104
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
105
105
  0.9.9 (ruby-2.4.1).
106
106
  </div>
@@ -1,3 +1,3 @@
1
1
  module AutomateSoup
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: automate_soup
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Skyler Layne
@@ -94,7 +94,135 @@ dependencies:
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
97
- description: Ruby API for interacting with Chef Automate
97
+ description: |
98
+ # AutomateSoup
99
+
100
+ [![Build Status](https://travis-ci.org/skylerto/automate_soup.svg?branch=master)](https://travis-ci.org/skylerto/automate_soup)
101
+
102
+ Automate Soup is a Ruby API for interacting with the Soup that is Chef Automate.
103
+
104
+ ## Installation
105
+
106
+ Add this line to your application's Gemfile:
107
+
108
+ ```ruby
109
+ gem 'automate_soup'
110
+ ```
111
+
112
+ And then execute:
113
+
114
+ $ bundle
115
+
116
+ Or install it yourself as:
117
+
118
+ $ gem install automate_soup
119
+
120
+ ## Usage
121
+
122
+ ### Setting up the Client
123
+
124
+ You can setup the client in a generic way via:
125
+
126
+ ``` ruby
127
+ soup = AutomateSoup.setup(
128
+ url: ENV['AUTOMATE_URL'],
129
+ username: ENV['AUTOMATE_USERNAME'],
130
+ token: ENV['AUTOMATE_TOKEN']
131
+ )
132
+ ```
133
+
134
+ You can also setup the client with an enterprise, organization, project, and
135
+ pipeline via:
136
+
137
+ ``` ruby
138
+ soup = AutomateSoup.setup(
139
+ url: ENV['AUTOMATE_URL'],
140
+ username: ENV['AUTOMATE_USERNAME'],
141
+ token: ENV['AUTOMATE_TOKEN'],
142
+ organization: organization,
143
+ project: project,
144
+ pipeline: pipeline
145
+ )
146
+ ```
147
+
148
+ ### Fetching Changes
149
+
150
+ ``` ruby
151
+ # To fetch an array of pipeline change topic names
152
+ changes = soup.pipeline_topics(
153
+ organization: organization,
154
+ project: project,
155
+ pipeline: pipeline
156
+ )
157
+
158
+ # To fetch a specific change via a topic
159
+ change = soup.change_by_topic(
160
+ organization: organization,
161
+ project: project,
162
+ pipeline: pipeline,
163
+ topic: 'blahblahblah'
164
+ )
165
+
166
+ change = soup.change_by_topic(
167
+ topic: 'blahblahblah'
168
+ )
169
+ ```
170
+
171
+ ### Approving Changes
172
+
173
+ ``` ruby
174
+ # If you used the first way to setup the client
175
+ soup.approve_change(
176
+ organization: organization,
177
+ project: project,
178
+ pipeline: pipeline,
179
+ topic: 'blahblahblah',
180
+ wait: true
181
+ )
182
+
183
+ # If you used the second
184
+ soup.approve_change(
185
+ topic: 'blahblahblah',
186
+ wait: true
187
+ )
188
+ ```
189
+
190
+ ### Delivering Changes
191
+
192
+ ``` ruby
193
+ # If you used the first way to setup the client
194
+ soup.deliver_change(
195
+ organization: organization,
196
+ project: project,
197
+ pipeline: pipeline,
198
+ topic: 'blahblahblah',
199
+ wait: true
200
+ )
201
+
202
+ # If you used the second
203
+ soup.deliver_change(
204
+ topic: 'blahblahblah',
205
+ wait: true
206
+ )
207
+ ```
208
+
209
+ ## Development
210
+
211
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
212
+
213
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
214
+
215
+ ## Contributing
216
+
217
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/automate_soup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
218
+
219
+ ## License
220
+
221
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
222
+
223
+ ## Code of Conduct
224
+
225
+ Everyone interacting in the AutomateSoup project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.md).
98
226
  email:
99
227
  - skylerclayne@gmail.com
100
228
  executables: []