automate_soup 0.1.0

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 (69) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +15 -0
  3. data/.rspec +2 -0
  4. data/.travis.yml +5 -0
  5. data/CODE_OF_CONDUCT.md +74 -0
  6. data/Gemfile +6 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +128 -0
  9. data/Rakefile +10 -0
  10. data/automate_soup.gemspec +31 -0
  11. data/bin/console +14 -0
  12. data/bin/setup +8 -0
  13. data/docs/AutomateSoup.html +2566 -0
  14. data/docs/AutomateSoup/API.html +1174 -0
  15. data/docs/AutomateSoup/Change.html +892 -0
  16. data/docs/AutomateSoup/Credentials.html +452 -0
  17. data/docs/AutomateSoup/Rest.html +321 -0
  18. data/docs/AutomateSoup/Stage.html +428 -0
  19. data/docs/AutomateSoup/Topic.html +530 -0
  20. data/docs/_index.html +166 -0
  21. data/docs/class_list.html +51 -0
  22. data/docs/coverage/.last_run.json +5 -0
  23. data/docs/coverage/.resultset.json +145 -0
  24. data/docs/coverage/.resultset.json.lock +0 -0
  25. data/docs/coverage/assets/0.10.2/application.css +799 -0
  26. data/docs/coverage/assets/0.10.2/application.js +1707 -0
  27. data/docs/coverage/assets/0.10.2/colorbox/border.png +0 -0
  28. data/docs/coverage/assets/0.10.2/colorbox/controls.png +0 -0
  29. data/docs/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
  30. data/docs/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
  31. data/docs/coverage/assets/0.10.2/favicon_green.png +0 -0
  32. data/docs/coverage/assets/0.10.2/favicon_red.png +0 -0
  33. data/docs/coverage/assets/0.10.2/favicon_yellow.png +0 -0
  34. data/docs/coverage/assets/0.10.2/loading.gif +0 -0
  35. data/docs/coverage/assets/0.10.2/magnify.png +0 -0
  36. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
  37. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
  38. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
  39. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
  40. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
  41. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
  42. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
  43. data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
  44. data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
  45. data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
  46. data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
  47. data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
  48. data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
  49. data/docs/coverage/index.html +968 -0
  50. data/docs/css/common.css +1 -0
  51. data/docs/css/full_list.css +58 -0
  52. data/docs/css/style.css +492 -0
  53. data/docs/file.README.html +211 -0
  54. data/docs/file_list.html +56 -0
  55. data/docs/frames.html +17 -0
  56. data/docs/index.html +211 -0
  57. data/docs/js/app.js +248 -0
  58. data/docs/js/full_list.js +216 -0
  59. data/docs/js/jquery.js +4 -0
  60. data/docs/method_list.html +395 -0
  61. data/docs/top-level-namespace.html +110 -0
  62. data/lib/automate_soup.rb +264 -0
  63. data/lib/automate_soup/api.rb +112 -0
  64. data/lib/automate_soup/change.rb +105 -0
  65. data/lib/automate_soup/credentials.rb +16 -0
  66. data/lib/automate_soup/rest.rb +40 -0
  67. data/lib/automate_soup/stage.rb +25 -0
  68. data/lib/automate_soup/version.rb +3 -0
  69. metadata +195 -0
data/docs/file.README.html ADDED
@@ -0,0 +1,211 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="file_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-AutomateSoup">AutomateSoup</h1>
62
+
63
+ <p><a href="https://travis-ci.org/skylerto/automate_soup"><img
64
+ src="https://travis-ci.org/skylerto/automate_soup.svg?branch=master"></a></p>
65
+
66
+ <p>Automate Soup is a Ruby API for interacting with the Soup that is Chef
67
+ Automate.</p>
68
+
69
+ <h2 id="label-Installation">Installation</h2>
70
+
71
+ <p>Add this line to your application&#39;s Gemfile:</p>
72
+
73
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>automate_soup</span><span class='tstring_end'>&#39;</span></span>
74
+ </code></pre>
75
+
76
+ <p>And then execute:</p>
77
+
78
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
79
+
80
+ <p>Or install it yourself as:</p>
81
+
82
+ <pre class="code ruby"><code class="ruby">$ gem install automate_soup</code></pre>
83
+
84
+ <h2 id="label-Usage">Usage</h2>
85
+
86
+ <h3 id="label-Setting+up+the+Client">Setting up the Client</h3>
87
+
88
+ <p>You can setup the client in a generic way via:</p>
89
+
90
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_soup'>soup</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setup'><span class='object_link'><a href="AutomateSoup.html#setup-class_method" title="AutomateSoup.setup (method)">setup</a></span></span><span class='lparen'>(</span>
91
+ <span class='label'>url:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_URL</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
92
+ <span class='label'>username:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_USERNAME</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
93
+ <span class='label'>token:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_TOKEN</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
94
+ <span class='rparen'>)</span>
95
+ </code></pre>
96
+
97
+ <p>You can also setup the client with an enterprise, organization, project,
98
+ and pipeline via:</p>
99
+
100
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_soup'>soup</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setup'><span class='object_link'><a href="AutomateSoup.html#setup-class_method" title="AutomateSoup.setup (method)">setup</a></span></span><span class='lparen'>(</span>
101
+ <span class='label'>url:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_URL</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
102
+ <span class='label'>username:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_USERNAME</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
103
+ <span class='label'>token:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_TOKEN</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
104
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
105
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
106
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
107
+ <span class='rparen'>)</span>
108
+ </code></pre>
109
+
110
+ <h3 id="label-Fetching+Changes">Fetching Changes</h3>
111
+
112
+ <pre class="code ruby"><code class="ruby"><span class='comment'># To fetch an array of pipeline change topic names
113
+ </span><span class='id identifier rubyid_changes'>changes</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_pipeline_topics'>pipeline_topics</span><span class='lparen'>(</span>
114
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
115
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
116
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
117
+ <span class='rparen'>)</span>
118
+
119
+ <span class='comment'># To fetch a specific change via a topic
120
+ </span><span class='id identifier rubyid_change'>change</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
121
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
122
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
123
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
124
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span>
125
+ <span class='rparen'>)</span>
126
+
127
+ <span class='id identifier rubyid_change'>change</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
128
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span>
129
+ <span class='rparen'>)</span>
130
+ </code></pre>
131
+
132
+ <h3 id="label-Approving+Changes">Approving Changes</h3>
133
+
134
+ <pre class="code ruby"><code class="ruby"><span class='comment'># If you used the first way to setup the client
135
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_approve_change'>approve_change</span><span class='lparen'>(</span>
136
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
137
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
138
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
139
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
140
+ <span class='label'>wait:</span> <span class='kw'>true</span>
141
+ <span class='rparen'>)</span>
142
+
143
+ <span class='comment'># If you used the second
144
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_approve_change'>approve_change</span><span class='lparen'>(</span>
145
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
146
+ <span class='label'>wait:</span> <span class='kw'>true</span>
147
+ <span class='rparen'>)</span>
148
+ </code></pre>
149
+
150
+ <h3 id="label-Delivering+Changes">Delivering Changes</h3>
151
+
152
+ <pre class="code ruby"><code class="ruby"><span class='comment'># If you used the first way to setup the client
153
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_deliver_change'>deliver_change</span><span class='lparen'>(</span>
154
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
155
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
156
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
157
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
158
+ <span class='label'>wait:</span> <span class='kw'>true</span>
159
+ <span class='rparen'>)</span>
160
+
161
+ <span class='comment'># If you used the second
162
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_deliver_change'>deliver_change</span><span class='lparen'>(</span>
163
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
164
+ <span class='label'>wait:</span> <span class='kw'>true</span>
165
+ <span class='rparen'>)</span>
166
+ </code></pre>
167
+
168
+ <h2 id="label-Development">Development</h2>
169
+
170
+ <p>After checking out the repo, run <code>bin/setup</code> to install
171
+ dependencies. Then, run <code>rake spec</code> to run the tests. You can
172
+ also run <code>bin/console</code> for an interactive prompt that will allow
173
+ you to experiment.</p>
174
+
175
+ <p>To install this gem onto your local machine, run <code>bundle exec rake
176
+ install</code>. To release a new version, update the version number in
177
+ <code>version.rb</code>, and then run <code>bundle exec rake
178
+ release</code>, which will create a git tag for the version, push git
179
+ commits and tags, and push the <code>.gem</code> file to <a
180
+ href="https://rubygems.org">rubygems.org</a>.</p>
181
+
182
+ <h2 id="label-Contributing">Contributing</h2>
183
+
184
+ <p>Bug reports and pull requests are welcome on GitHub at <a
185
+ href="https://github.com/[USERNAME]/automate_soup">github.com/[USERNAME]/automate_soup</a>.
186
+ This project is intended to be a safe, welcoming space for collaboration,
187
+ and contributors are expected to adhere to the <a
188
+ href="http://contributor-covenant.org">Contributor Covenant</a> code of
189
+ conduct.</p>
190
+
191
+ <h2 id="label-License">License</h2>
192
+
193
+ <p>The gem is available as open source under the terms of the <a
194
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
195
+
196
+ <h2 id="label-Code+of+Conduct">Code of Conduct</h2>
197
+
198
+ <p>Everyone interacting in the AutomateSoup project’s codebases, issue
199
+ trackers, chat rooms and mailing lists is expected to follow the of
200
+ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.md].</p>
201
+ </div></div>
202
+
203
+ <div id="footer">
204
+ Generated on Mon Dec 18 14:46:35 2017 by
205
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
206
+ 0.9.9 (ruby-2.4.1).
207
+ </div>
208
+
209
+ </div>
210
+ </body>
211
+ </html>
data/docs/file_list.html ADDED
@@ -0,0 +1,56 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
+ <meta charset="utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <title>File List</title>
19
+ <base id="base_target" target="_parent" />
20
+ </head>
21
+ <body>
22
+ <div id="content">
23
+ <div class="fixed_header">
24
+ <h1 id="full_list_header">File List</h1>
25
+ <div id="full_list_nav">
26
+
27
+ <span><a target="_self" href="class_list.html">
28
+ Classes
29
+ </a></span>
30
+
31
+ <span><a target="_self" href="method_list.html">
32
+ Methods
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="file_list.html">
36
+ Files
37
+ </a></span>
38
+
39
+ </div>
40
+
41
+ <div id="search">Search: <input type="text" /></div>
42
+ </div>
43
+
44
+ <ul id="full_list" class="file">
45
+
46
+
47
+ <li id="object_README" class="odd">
48
+ <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
49
+ </li>
50
+
51
+
52
+
53
+ </ul>
54
+ </div>
55
+ </body>
56
+ </html>
data/docs/frames.html ADDED
@@ -0,0 +1,17 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>Documentation by YARD 0.9.9</title>
6
+ </head>
7
+ <script type="text/javascript" charset="utf-8">
8
+ var match = unescape(window.location.hash).match(/^#!(.+)/);
9
+ var name = match ? match[1] : 'index.html';
10
+ name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
11
+ window.top.location = name;
12
+ </script>
13
+ <noscript>
14
+ <h1>Oops!</h1>
15
+ <h2>YARD requires JavaScript!</h2>
16
+ </noscript>
17
+ </html>
data/docs/index.html ADDED
@@ -0,0 +1,211 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ File: README
8
+
9
+ &mdash; Documentation by YARD 0.9.9
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "README";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+ <span class="title">File: README</span>
41
+
42
+ </div>
43
+
44
+ <div id="search">
45
+
46
+ <a class="full_list_link" id="class_list_link"
47
+ href="class_list.html">
48
+
49
+ <svg width="24" height="24">
50
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
51
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
52
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
53
+ </svg>
54
+ </a>
55
+
56
+ </div>
57
+ <div class="clear"></div>
58
+ </div>
59
+
60
+ <div id="content"><div id='filecontents'>
61
+ <h1 id="label-AutomateSoup">AutomateSoup</h1>
62
+
63
+ <p><a href="https://travis-ci.org/skylerto/automate_soup"><img
64
+ src="https://travis-ci.org/skylerto/automate_soup.svg?branch=master"></a></p>
65
+
66
+ <p>Automate Soup is a Ruby API for interacting with the Soup that is Chef
67
+ Automate.</p>
68
+
69
+ <h2 id="label-Installation">Installation</h2>
70
+
71
+ <p>Add this line to your application&#39;s Gemfile:</p>
72
+
73
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>automate_soup</span><span class='tstring_end'>&#39;</span></span>
74
+ </code></pre>
75
+
76
+ <p>And then execute:</p>
77
+
78
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
79
+
80
+ <p>Or install it yourself as:</p>
81
+
82
+ <pre class="code ruby"><code class="ruby">$ gem install automate_soup</code></pre>
83
+
84
+ <h2 id="label-Usage">Usage</h2>
85
+
86
+ <h3 id="label-Setting+up+the+Client">Setting up the Client</h3>
87
+
88
+ <p>You can setup the client in a generic way via:</p>
89
+
90
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_soup'>soup</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setup'><span class='object_link'><a href="AutomateSoup.html#setup-class_method" title="AutomateSoup.setup (method)">setup</a></span></span><span class='lparen'>(</span>
91
+ <span class='label'>url:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_URL</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
92
+ <span class='label'>username:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_USERNAME</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
93
+ <span class='label'>token:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_TOKEN</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
94
+ <span class='rparen'>)</span>
95
+ </code></pre>
96
+
97
+ <p>You can also setup the client with an enterprise, organization, project,
98
+ and pipeline via:</p>
99
+
100
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_soup'>soup</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_setup'><span class='object_link'><a href="AutomateSoup.html#setup-class_method" title="AutomateSoup.setup (method)">setup</a></span></span><span class='lparen'>(</span>
101
+ <span class='label'>url:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_URL</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
102
+ <span class='label'>username:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_USERNAME</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
103
+ <span class='label'>token:</span> <span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>AUTOMATE_TOKEN</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
104
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
105
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
106
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
107
+ <span class='rparen'>)</span>
108
+ </code></pre>
109
+
110
+ <h3 id="label-Fetching+Changes">Fetching Changes</h3>
111
+
112
+ <pre class="code ruby"><code class="ruby"><span class='comment'># To fetch an array of pipeline change topic names
113
+ </span><span class='id identifier rubyid_changes'>changes</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_pipeline_topics'>pipeline_topics</span><span class='lparen'>(</span>
114
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
115
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
116
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
117
+ <span class='rparen'>)</span>
118
+
119
+ <span class='comment'># To fetch a specific change via a topic
120
+ </span><span class='id identifier rubyid_change'>change</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
121
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
122
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
123
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
124
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span>
125
+ <span class='rparen'>)</span>
126
+
127
+ <span class='id identifier rubyid_change'>change</span> <span class='op'>=</span> <span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
128
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span>
129
+ <span class='rparen'>)</span>
130
+ </code></pre>
131
+
132
+ <h3 id="label-Approving+Changes">Approving Changes</h3>
133
+
134
+ <pre class="code ruby"><code class="ruby"><span class='comment'># If you used the first way to setup the client
135
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_approve_change'>approve_change</span><span class='lparen'>(</span>
136
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
137
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
138
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
139
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
140
+ <span class='label'>wait:</span> <span class='kw'>true</span>
141
+ <span class='rparen'>)</span>
142
+
143
+ <span class='comment'># If you used the second
144
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_approve_change'>approve_change</span><span class='lparen'>(</span>
145
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
146
+ <span class='label'>wait:</span> <span class='kw'>true</span>
147
+ <span class='rparen'>)</span>
148
+ </code></pre>
149
+
150
+ <h3 id="label-Delivering+Changes">Delivering Changes</h3>
151
+
152
+ <pre class="code ruby"><code class="ruby"><span class='comment'># If you used the first way to setup the client
153
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_deliver_change'>deliver_change</span><span class='lparen'>(</span>
154
+ <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
155
+ <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
156
+ <span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
157
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
158
+ <span class='label'>wait:</span> <span class='kw'>true</span>
159
+ <span class='rparen'>)</span>
160
+
161
+ <span class='comment'># If you used the second
162
+ </span><span class='id identifier rubyid_soup'>soup</span><span class='period'>.</span><span class='id identifier rubyid_deliver_change'>deliver_change</span><span class='lparen'>(</span>
163
+ <span class='label'>topic:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>blahblahblah</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
164
+ <span class='label'>wait:</span> <span class='kw'>true</span>
165
+ <span class='rparen'>)</span>
166
+ </code></pre>
167
+
168
+ <h2 id="label-Development">Development</h2>
169
+
170
+ <p>After checking out the repo, run <code>bin/setup</code> to install
171
+ dependencies. Then, run <code>rake spec</code> to run the tests. You can
172
+ also run <code>bin/console</code> for an interactive prompt that will allow
173
+ you to experiment.</p>
174
+
175
+ <p>To install this gem onto your local machine, run <code>bundle exec rake
176
+ install</code>. To release a new version, update the version number in
177
+ <code>version.rb</code>, and then run <code>bundle exec rake
178
+ release</code>, which will create a git tag for the version, push git
179
+ commits and tags, and push the <code>.gem</code> file to <a
180
+ href="https://rubygems.org">rubygems.org</a>.</p>
181
+
182
+ <h2 id="label-Contributing">Contributing</h2>
183
+
184
+ <p>Bug reports and pull requests are welcome on GitHub at <a
185
+ href="https://github.com/[USERNAME]/automate_soup">github.com/[USERNAME]/automate_soup</a>.
186
+ This project is intended to be a safe, welcoming space for collaboration,
187
+ and contributors are expected to adhere to the <a
188
+ href="http://contributor-covenant.org">Contributor Covenant</a> code of
189
+ conduct.</p>
190
+
191
+ <h2 id="label-License">License</h2>
192
+
193
+ <p>The gem is available as open source under the terms of the <a
194
+ href="http://opensource.org/licenses/MIT">MIT License</a>.</p>
195
+
196
+ <h2 id="label-Code+of+Conduct">Code of Conduct</h2>
197
+
198
+ <p>Everyone interacting in the AutomateSoup project’s codebases, issue
199
+ trackers, chat rooms and mailing lists is expected to follow the of
200
+ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.md].</p>
201
+ </div></div>
202
+
203
+ <div id="footer">
204
+ Generated on Mon Dec 18 14:46:35 2017 by
205
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
206
+ 0.9.9 (ruby-2.4.1).
207
+ </div>
208
+
209
+ </div>
210
+ </body>
211
+ </html>