automate_soup 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c913996a141bbcadf9563efcf19c7e87b35e7eb
-  data.tar.gz: dcecb85948a5b33f148410b12eacd138886071d3
+  metadata.gz: c3f6b554c5615cb81dd4099a66320f56b12ef5e4
+  data.tar.gz: 66e99ba4bb788a37851da46a05721a2d22868950
 SHA512:
-  metadata.gz: 7f9c9188cf5d02a38663d710803549f7c1a9f3df3088bc55079437bc8a52a2feac7174ff99a09660bdf1dafb22b14b13ba0e9c121ba7aefeaf05d6712ac9085c
-  data.tar.gz: a20b27ea999d07997a26fa526e0621abd15ff42ff887ee5056de5a5916a04d0a8dd7ad2a3e3f615a347c36b6a6656894b9e91a1c9e9aed60d7d4a1a7804a2492
+  metadata.gz: 72d465645bd7a03cf5609eab54995cef33fddad68ebda356ae7e1eb585523b7ea829fd0ce635370a76c03a57a1201a00181da21311a3ec11b9688bdb68de9c5f
+  data.tar.gz: 72fccb1c49f5faf9809712c2376acd0a4a6bb14de12dd98cf846e7ed3ed38096a0ef7ad4803da2d4c0dd4badcbcdc0abd8f21516a84976bef98b14c649a6793e

data/automate_soup.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['skylerclayne@gmail.com']
 
   spec.summary       = 'Ruby API for interacting with Chef Automate'
-  spec.description   = 'Ruby API for interacting with Chef Automate'
+  spec.description   = File.read('./README.md')
   spec.homepage      = 'https://github.com/skylerto/automate_soup'
   spec.license       = 'MIT'
 

data/docs/AutomateSoup/API.html

@@ -1164,7 +1164,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Change.html

@@ -882,7 +882,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Credentials.html

@@ -442,7 +442,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Rest.html

@@ -311,7 +311,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Stage.html

@@ -418,7 +418,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup.html

@@ -2556,7 +2556,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/_index.html

@@ -156,7 +156,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:34 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/coverage/.resultset.json

@@ -140,6 +140,6 @@
         null
       ]
     },
-    "timestamp": 1513626394
+    "timestamp": 1513626557
   }
 }

data/docs/coverage/index.html

@@ -14,7 +14,7 @@
       <img src="./assets/0.10.2/loading.gif" alt="loading"/>
     </div>
     <div id="wrapper" style="display:none;">
-      <div class="timestamp">Generated <abbr class="timeago" title="2017-12-18T14:46:34-05:00">2017-12-18T14:46:34-05:00</abbr></div>
+      <div class="timestamp">Generated <abbr class="timeago" title="2017-12-18T14:49:17-05:00">2017-12-18T14:49:17-05:00</abbr></div>
       <ul class="group_tabs"></ul>
 
       <div id="content">

data/docs/file.README.html

@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
 </div></div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/index.html

@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
 </div></div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:46:35 2017 by
+  Generated on Mon Dec 18 14:49:18 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/lib/automate_soup/version.rb

@@ -1,3 +1,3 @@
 module AutomateSoup
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: automate_soup
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Skyler Layne
@@ -94,7 +94,135 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby API for interacting with Chef Automate
+description: |
+  # AutomateSoup
+
+  [![Build Status](https://travis-ci.org/skylerto/automate_soup.svg?branch=master)](https://travis-ci.org/skylerto/automate_soup)
+
+  Automate Soup is a Ruby API for interacting with the Soup that is Chef Automate.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'automate_soup'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install automate_soup
+
+  ## Usage
+
+  ### Setting up the Client
+
+  You can setup the client in a generic way via:
+
+  ``` ruby
+  soup = AutomateSoup.setup(
+    url: ENV['AUTOMATE_URL'],
+    username: ENV['AUTOMATE_USERNAME'],
+    token: ENV['AUTOMATE_TOKEN']
+  )
+  ```
+
+  You can also setup the client with an enterprise, organization, project, and
+  pipeline via:
+
+  ``` ruby
+  soup = AutomateSoup.setup(
+    url: ENV['AUTOMATE_URL'],
+    username: ENV['AUTOMATE_USERNAME'],
+    token: ENV['AUTOMATE_TOKEN'],
+    organization: organization,
+    project: project,
+    pipeline: pipeline
+  )
+  ```
+
+  ### Fetching Changes
+
+  ``` ruby
+  # To fetch an array of pipeline change topic names
+  changes = soup.pipeline_topics(
+    organization: organization,
+    project: project,
+    pipeline: pipeline
+  )
+
+  # To fetch a specific change via a topic
+  change = soup.change_by_topic(
+    organization: organization,
+    project: project,
+    pipeline: pipeline,
+    topic: 'blahblahblah'
+  )
+
+  change = soup.change_by_topic(
+    topic: 'blahblahblah'
+  )
+  ```
+
+  ### Approving Changes
+
+  ``` ruby
+  # If you used the first way to setup the client
+  soup.approve_change(
+    organization: organization,
+    project: project,
+    pipeline: pipeline,
+    topic: 'blahblahblah',
+    wait: true
+  )
+
+  # If you used the second
+  soup.approve_change(
+    topic: 'blahblahblah',
+    wait: true
+  )
+  ```
+
+  ### Delivering Changes
+
+  ``` ruby
+  # If you used the first way to setup the client
+  soup.deliver_change(
+    organization: organization,
+    project: project,
+    pipeline: pipeline,
+    topic: 'blahblahblah',
+    wait: true
+  )
+
+  # If you used the second
+  soup.deliver_change(
+    topic: 'blahblahblah',
+    wait: true
+  )
+  ```
+
+  ## Development
+
+  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.
+
+  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).
+
+  ## Contributing
+
+  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.
+
+  ## License
+
+  The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+  ## Code of Conduct
+
+  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).
 email:
 - skylerclayne@gmail.com
 executables: []