automate_soup 0.1.1 → 0.1.2

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: c3f6b554c5615cb81dd4099a66320f56b12ef5e4
4
- data.tar.gz: 66e99ba4bb788a37851da46a05721a2d22868950
3
+ metadata.gz: 8036d0ab15b43a0ec0035ac62bc85d7d417f1a14
4
+ data.tar.gz: a25c4393f41685378ce47d5b757fd17085c0acb1
5
5
  SHA512:
6
- metadata.gz: 72d465645bd7a03cf5609eab54995cef33fddad68ebda356ae7e1eb585523b7ea829fd0ce635370a76c03a57a1201a00181da21311a3ec11b9688bdb68de9c5f
7
- data.tar.gz: 72fccb1c49f5faf9809712c2376acd0a4a6bb14de12dd98cf846e7ed3ed38096a0ef7ad4803da2d4c0dd4badcbcdc0abd8f21516a84976bef98b14c649a6793e
6
+ metadata.gz: 92f04d63b2aa970324ad99caa4fbc9f5cff4e2dac0e8414dfae05802261faf51280e23e23495e8fe1ac6b50dd4ffefdf9e22d41189e8e1a11357f9c3a130ccd0
7
+ data.tar.gz: ec1bddbcae7e159bd9ce9cfd71e44b67c0863982a103f3ae4c388becb947a95a13ded05b455c29db7906b999f4fd1bdf556089f610aee1fbe75a39bab5259267
@@ -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 = File.read('./README.md')
14
+ spec.description = 'Ruby API for interacting with Chef Automate'
15
15
  spec.homepage = 'https://github.com/skylerto/automate_soup'
16
16
  spec.license = 'MIT'
17
17
 
@@ -1,3 +1,3 @@
1
1
  module AutomateSoup
2
- VERSION = "0.1.1"
2
+ VERSION = "0.1.2"
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.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Skyler Layne
@@ -94,135 +94,7 @@ dependencies:
94
94
  - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '0'
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).
97
+ description: Ruby API for interacting with Chef Automate
226
98
  email:
227
99
  - skylerclayne@gmail.com
228
100
  executables: []