automate_soup 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +15 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +128 -0
- data/Rakefile +10 -0
- data/automate_soup.gemspec +31 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/docs/AutomateSoup.html +2566 -0
- data/docs/AutomateSoup/API.html +1174 -0
- data/docs/AutomateSoup/Change.html +892 -0
- data/docs/AutomateSoup/Credentials.html +452 -0
- data/docs/AutomateSoup/Rest.html +321 -0
- data/docs/AutomateSoup/Stage.html +428 -0
- data/docs/AutomateSoup/Topic.html +530 -0
- data/docs/_index.html +166 -0
- data/docs/class_list.html +51 -0
- data/docs/coverage/.last_run.json +5 -0
- data/docs/coverage/.resultset.json +145 -0
- data/docs/coverage/.resultset.json.lock +0 -0
- data/docs/coverage/assets/0.10.2/application.css +799 -0
- data/docs/coverage/assets/0.10.2/application.js +1707 -0
- data/docs/coverage/assets/0.10.2/colorbox/border.png +0 -0
- data/docs/coverage/assets/0.10.2/colorbox/controls.png +0 -0
- data/docs/coverage/assets/0.10.2/colorbox/loading.gif +0 -0
- data/docs/coverage/assets/0.10.2/colorbox/loading_background.png +0 -0
- data/docs/coverage/assets/0.10.2/favicon_green.png +0 -0
- data/docs/coverage/assets/0.10.2/favicon_red.png +0 -0
- data/docs/coverage/assets/0.10.2/favicon_yellow.png +0 -0
- data/docs/coverage/assets/0.10.2/loading.gif +0 -0
- data/docs/coverage/assets/0.10.2/magnify.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png +0 -0
- data/docs/coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png +0 -0
- data/docs/coverage/index.html +968 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +492 -0
- data/docs/file.README.html +211 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +211 -0
- data/docs/js/app.js +248 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +395 -0
- data/docs/top-level-namespace.html +110 -0
- data/lib/automate_soup.rb +264 -0
- data/lib/automate_soup/api.rb +112 -0
- data/lib/automate_soup/change.rb +105 -0
- data/lib/automate_soup/credentials.rb +16 -0
- data/lib/automate_soup/rest.rb +40 -0
- data/lib/automate_soup/stage.rb +25 -0
- data/lib/automate_soup/version.rb +3 -0
- metadata +195 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2c913996a141bbcadf9563efcf19c7e87b35e7eb
|
4
|
+
data.tar.gz: dcecb85948a5b33f148410b12eacd138886071d3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7f9c9188cf5d02a38663d710803549f7c1a9f3df3088bc55079437bc8a52a2feac7174ff99a09660bdf1dafb22b14b13ba0e9c121ba7aefeaf05d6712ac9085c
|
7
|
+
data.tar.gz: a20b27ea999d07997a26fa526e0621abd15ff42ff887ee5056de5a5916a04d0a8dd7ad2a3e3f615a347c36b6a6656894b9e91a1c9e9aed60d7d4a1a7804a2492
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at skylerclayne@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Skyler Layne
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
# AutomateSoup
|
2
|
+
|
3
|
+
[![Build Status](https://travis-ci.org/skylerto/automate_soup.svg?branch=master)](https://travis-ci.org/skylerto/automate_soup)
|
4
|
+
|
5
|
+
Automate Soup is a Ruby API for interacting with the Soup that is Chef Automate.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'automate_soup'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install automate_soup
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
### Setting up the Client
|
26
|
+
|
27
|
+
You can setup the client in a generic way via:
|
28
|
+
|
29
|
+
``` ruby
|
30
|
+
soup = AutomateSoup.setup(
|
31
|
+
url: ENV['AUTOMATE_URL'],
|
32
|
+
username: ENV['AUTOMATE_USERNAME'],
|
33
|
+
token: ENV['AUTOMATE_TOKEN']
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
37
|
+
You can also setup the client with an enterprise, organization, project, and
|
38
|
+
pipeline via:
|
39
|
+
|
40
|
+
``` ruby
|
41
|
+
soup = AutomateSoup.setup(
|
42
|
+
url: ENV['AUTOMATE_URL'],
|
43
|
+
username: ENV['AUTOMATE_USERNAME'],
|
44
|
+
token: ENV['AUTOMATE_TOKEN'],
|
45
|
+
organization: organization,
|
46
|
+
project: project,
|
47
|
+
pipeline: pipeline
|
48
|
+
)
|
49
|
+
```
|
50
|
+
|
51
|
+
### Fetching Changes
|
52
|
+
|
53
|
+
``` ruby
|
54
|
+
# To fetch an array of pipeline change topic names
|
55
|
+
changes = soup.pipeline_topics(
|
56
|
+
organization: organization,
|
57
|
+
project: project,
|
58
|
+
pipeline: pipeline
|
59
|
+
)
|
60
|
+
|
61
|
+
# To fetch a specific change via a topic
|
62
|
+
change = soup.change_by_topic(
|
63
|
+
organization: organization,
|
64
|
+
project: project,
|
65
|
+
pipeline: pipeline,
|
66
|
+
topic: 'blahblahblah'
|
67
|
+
)
|
68
|
+
|
69
|
+
change = soup.change_by_topic(
|
70
|
+
topic: 'blahblahblah'
|
71
|
+
)
|
72
|
+
```
|
73
|
+
|
74
|
+
### Approving Changes
|
75
|
+
|
76
|
+
``` ruby
|
77
|
+
# If you used the first way to setup the client
|
78
|
+
soup.approve_change(
|
79
|
+
organization: organization,
|
80
|
+
project: project,
|
81
|
+
pipeline: pipeline,
|
82
|
+
topic: 'blahblahblah',
|
83
|
+
wait: true
|
84
|
+
)
|
85
|
+
|
86
|
+
# If you used the second
|
87
|
+
soup.approve_change(
|
88
|
+
topic: 'blahblahblah',
|
89
|
+
wait: true
|
90
|
+
)
|
91
|
+
```
|
92
|
+
|
93
|
+
### Delivering Changes
|
94
|
+
|
95
|
+
``` ruby
|
96
|
+
# If you used the first way to setup the client
|
97
|
+
soup.deliver_change(
|
98
|
+
organization: organization,
|
99
|
+
project: project,
|
100
|
+
pipeline: pipeline,
|
101
|
+
topic: 'blahblahblah',
|
102
|
+
wait: true
|
103
|
+
)
|
104
|
+
|
105
|
+
# If you used the second
|
106
|
+
soup.deliver_change(
|
107
|
+
topic: 'blahblahblah',
|
108
|
+
wait: true
|
109
|
+
)
|
110
|
+
```
|
111
|
+
|
112
|
+
## Development
|
113
|
+
|
114
|
+
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.
|
115
|
+
|
116
|
+
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).
|
117
|
+
|
118
|
+
## Contributing
|
119
|
+
|
120
|
+
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.
|
121
|
+
|
122
|
+
## License
|
123
|
+
|
124
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
125
|
+
|
126
|
+
## Code of Conduct
|
127
|
+
|
128
|
+
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).
|
data/Rakefile
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
|
3
|
+
lib = File.expand_path('../lib', __FILE__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
require 'automate_soup/version'
|
6
|
+
|
7
|
+
Gem::Specification.new do |spec|
|
8
|
+
spec.name = 'automate_soup'
|
9
|
+
spec.version = AutomateSoup::VERSION
|
10
|
+
spec.authors = ['Skyler Layne']
|
11
|
+
spec.email = ['skylerclayne@gmail.com']
|
12
|
+
|
13
|
+
spec.summary = 'Ruby API for interacting with Chef Automate'
|
14
|
+
spec.description = 'Ruby API for interacting with Chef Automate'
|
15
|
+
spec.homepage = 'https://github.com/skylerto/automate_soup'
|
16
|
+
spec.license = 'MIT'
|
17
|
+
|
18
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
19
|
+
f.match(%r{^(test|spec|features)/})
|
20
|
+
end
|
21
|
+
spec.bindir = 'exe'
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
23
|
+
spec.require_paths = ['lib']
|
24
|
+
|
25
|
+
spec.add_development_dependency 'bundler', '~> 1.15'
|
26
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
27
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
28
|
+
spec.add_development_dependency 'yard'
|
29
|
+
spec.add_development_dependency 'byebug'
|
30
|
+
spec.add_development_dependency 'simplecov'
|
31
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "automate_soup"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,2566 @@
|
|
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
|
+
Module: AutomateSoup
|
8
|
+
|
9
|
+
— 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 = "AutomateSoup";
|
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)</a> »
|
40
|
+
|
41
|
+
|
42
|
+
<span class="title">AutomateSoup</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Module: AutomateSoup
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
<dl>
|
80
|
+
<dt>Defined in:</dt>
|
81
|
+
<dd>lib/automate_soup.rb<span class="defines">,<br />
|
82
|
+
lib/automate_soup/api.rb,<br /> lib/automate_soup/rest.rb,<br /> lib/automate_soup/stage.rb,<br /> lib/automate_soup/change.rb,<br /> lib/automate_soup/version.rb,<br /> lib/automate_soup/credentials.rb</span>
|
83
|
+
</dd>
|
84
|
+
</dl>
|
85
|
+
|
86
|
+
</div>
|
87
|
+
|
88
|
+
<h2>Overview</h2><div class="docstring">
|
89
|
+
<div class="discussion">
|
90
|
+
|
91
|
+
<p>Top level module</p>
|
92
|
+
|
93
|
+
|
94
|
+
</div>
|
95
|
+
</div>
|
96
|
+
<div class="tags">
|
97
|
+
|
98
|
+
|
99
|
+
</div><h2>Defined Under Namespace</h2>
|
100
|
+
<p class="children">
|
101
|
+
|
102
|
+
|
103
|
+
<strong class="modules">Modules:</strong> <span class='object_link'><a href="AutomateSoup/Rest.html" title="AutomateSoup::Rest (module)">Rest</a></span>
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="AutomateSoup/API.html" title="AutomateSoup::API (class)">API</a></span>, <span class='object_link'><a href="AutomateSoup/Change.html" title="AutomateSoup::Change (class)">Change</a></span>, <span class='object_link'><a href="AutomateSoup/Credentials.html" title="AutomateSoup::Credentials (class)">Credentials</a></span>, <span class='object_link'><a href="AutomateSoup/Stage.html" title="AutomateSoup::Stage (class)">Stage</a></span>
|
108
|
+
|
109
|
+
|
110
|
+
</p>
|
111
|
+
|
112
|
+
<h2>Constant Summary</h2>
|
113
|
+
<dl class="constants">
|
114
|
+
|
115
|
+
<dt id="VERSION-constant" class="">VERSION =
|
116
|
+
|
117
|
+
</dt>
|
118
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>"</span></span></pre></dd>
|
119
|
+
|
120
|
+
</dl>
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
126
|
+
<ul class="summary">
|
127
|
+
|
128
|
+
<li class="public ">
|
129
|
+
<span class="summary_signature">
|
130
|
+
|
131
|
+
<a href="#api-class_method" title="api (class method)">.<strong>api</strong> ⇒ Object </a>
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
</span>
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
<span class="summary_desc"><div class='inline'>
|
149
|
+
<p>Returns the value of attribute api.</p>
|
150
|
+
</div></span>
|
151
|
+
|
152
|
+
</li>
|
153
|
+
|
154
|
+
|
155
|
+
<li class="public ">
|
156
|
+
<span class="summary_signature">
|
157
|
+
|
158
|
+
<a href="#credentials-class_method" title="credentials (class method)">.<strong>credentials</strong> ⇒ Object </a>
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
</span>
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
<span class="summary_desc"><div class='inline'>
|
176
|
+
<p>Returns the value of attribute credentials.</p>
|
177
|
+
</div></span>
|
178
|
+
|
179
|
+
</li>
|
180
|
+
|
181
|
+
|
182
|
+
<li class="public ">
|
183
|
+
<span class="summary_signature">
|
184
|
+
|
185
|
+
<a href="#enterprise-class_method" title="enterprise (class method)">.<strong>enterprise</strong> ⇒ Object </a>
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
</span>
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
<span class="summary_desc"><div class='inline'>
|
203
|
+
<p>Returns the value of attribute enterprise.</p>
|
204
|
+
</div></span>
|
205
|
+
|
206
|
+
</li>
|
207
|
+
|
208
|
+
|
209
|
+
<li class="public ">
|
210
|
+
<span class="summary_signature">
|
211
|
+
|
212
|
+
<a href="#organization-class_method" title="organization (class method)">.<strong>organization</strong> ⇒ Object </a>
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
</span>
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
<span class="summary_desc"><div class='inline'>
|
230
|
+
<p>Returns the value of attribute organization.</p>
|
231
|
+
</div></span>
|
232
|
+
|
233
|
+
</li>
|
234
|
+
|
235
|
+
|
236
|
+
<li class="public ">
|
237
|
+
<span class="summary_signature">
|
238
|
+
|
239
|
+
<a href="#pipeline-class_method" title="pipeline (class method)">.<strong>pipeline</strong>(enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ Object </a>
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
</span>
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
<span class="summary_desc"><div class='inline'>
|
257
|
+
<p>Fetch a pipeline of a project under an enterprise, organization pair.</p>
|
258
|
+
</div></span>
|
259
|
+
|
260
|
+
</li>
|
261
|
+
|
262
|
+
|
263
|
+
<li class="public ">
|
264
|
+
<span class="summary_signature">
|
265
|
+
|
266
|
+
<a href="#project-class_method" title="project (class method)">.<strong>project</strong> ⇒ Object </a>
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
</span>
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
<span class="summary_desc"><div class='inline'>
|
284
|
+
<p>Returns the value of attribute project.</p>
|
285
|
+
</div></span>
|
286
|
+
|
287
|
+
</li>
|
288
|
+
|
289
|
+
|
290
|
+
<li class="public ">
|
291
|
+
<span class="summary_signature">
|
292
|
+
|
293
|
+
<a href="#url-class_method" title="url (class method)">.<strong>url</strong> ⇒ Object </a>
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
</span>
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
<span class="summary_desc"><div class='inline'>
|
311
|
+
<p>Returns the value of attribute url.</p>
|
312
|
+
</div></span>
|
313
|
+
|
314
|
+
</li>
|
315
|
+
|
316
|
+
|
317
|
+
</ul>
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
<h2>
|
324
|
+
Class Method Summary
|
325
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
326
|
+
</h2>
|
327
|
+
|
328
|
+
<ul class="summary">
|
329
|
+
|
330
|
+
<li class="public ">
|
331
|
+
<span class="summary_signature">
|
332
|
+
|
333
|
+
<a href="#approve_change-class_method" title="approve_change (class method)">.<strong>approve_change</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5) ⇒ Object </a>
|
334
|
+
|
335
|
+
|
336
|
+
|
337
|
+
</span>
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
<span class="summary_desc"><div class='inline'>
|
348
|
+
<p>Approve a change by change topic.</p>
|
349
|
+
</div></span>
|
350
|
+
|
351
|
+
</li>
|
352
|
+
|
353
|
+
|
354
|
+
<li class="public ">
|
355
|
+
<span class="summary_signature">
|
356
|
+
|
357
|
+
<a href="#change_by_topic-class_method" title="change_by_topic (class method)">.<strong>change_by_topic</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil) ⇒ Object </a>
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
</span>
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
<span class="summary_desc"><div class='inline'>
|
372
|
+
<p>Find a change by topic.</p>
|
373
|
+
</div></span>
|
374
|
+
|
375
|
+
</li>
|
376
|
+
|
377
|
+
|
378
|
+
<li class="public ">
|
379
|
+
<span class="summary_signature">
|
380
|
+
|
381
|
+
<a href="#deliver_change-class_method" title="deliver_change (class method)">.<strong>deliver_change</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5) ⇒ Object </a>
|
382
|
+
|
383
|
+
|
384
|
+
|
385
|
+
</span>
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
<span class="summary_desc"><div class='inline'>
|
396
|
+
<p>Delivery a change by a topic.</p>
|
397
|
+
</div></span>
|
398
|
+
|
399
|
+
</li>
|
400
|
+
|
401
|
+
|
402
|
+
<li class="public ">
|
403
|
+
<span class="summary_signature">
|
404
|
+
|
405
|
+
<a href="#orgs-class_method" title="orgs (class method)">.<strong>orgs</strong>(enterprise = 'default') ⇒ Object </a>
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
</span>
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
|
419
|
+
<span class="summary_desc"><div class='inline'>
|
420
|
+
<p>Fetch all organizations under an enterprise.</p>
|
421
|
+
</div></span>
|
422
|
+
|
423
|
+
</li>
|
424
|
+
|
425
|
+
|
426
|
+
<li class="public ">
|
427
|
+
<span class="summary_signature">
|
428
|
+
|
429
|
+
<a href="#pipeline_topics-class_method" title="pipeline_topics (class method)">.<strong>pipeline_topics</strong>(enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ Object </a>
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
</span>
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
<span class="summary_desc"><div class='inline'>
|
444
|
+
<p>Filters out the topics from the pipelines changes .</p>
|
445
|
+
</div></span>
|
446
|
+
|
447
|
+
</li>
|
448
|
+
|
449
|
+
|
450
|
+
<li class="public ">
|
451
|
+
<span class="summary_signature">
|
452
|
+
|
453
|
+
<a href="#pipelines-class_method" title="pipelines (class method)">.<strong>pipelines</strong>(enterprise: 'default', organization: nil, project: nil) ⇒ Object </a>
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
</span>
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
<span class="summary_desc"><div class='inline'>
|
468
|
+
<p>Fetch all pipelines of a project under an enterprise, organization pair.</p>
|
469
|
+
</div></span>
|
470
|
+
|
471
|
+
</li>
|
472
|
+
|
473
|
+
|
474
|
+
<li class="public ">
|
475
|
+
<span class="summary_signature">
|
476
|
+
|
477
|
+
<a href="#projects-class_method" title="projects (class method)">.<strong>projects</strong>(enterprise: 'default', organization: nil) ⇒ Object </a>
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
</span>
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
<span class="summary_desc"><div class='inline'>
|
492
|
+
<p>Fetch all projects under an enterprise, organization pair.</p>
|
493
|
+
</div></span>
|
494
|
+
|
495
|
+
</li>
|
496
|
+
|
497
|
+
|
498
|
+
<li class="public ">
|
499
|
+
<span class="summary_signature">
|
500
|
+
|
501
|
+
<a href="#setup-class_method" title="setup (class method)">.<strong>setup</strong>(url: nil, username: nil, token: nil, password: nil, enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ Object </a>
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
</span>
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
|
515
|
+
<span class="summary_desc"><div class='inline'>
|
516
|
+
<p>Setup Automate Soup client.</p>
|
517
|
+
</div></span>
|
518
|
+
|
519
|
+
</li>
|
520
|
+
|
521
|
+
|
522
|
+
<li class="public ">
|
523
|
+
<span class="summary_signature">
|
524
|
+
|
525
|
+
<a href="#status-class_method" title="status (class method)">.<strong>status</strong> ⇒ Object </a>
|
526
|
+
|
527
|
+
|
528
|
+
|
529
|
+
</span>
|
530
|
+
|
531
|
+
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
<span class="summary_desc"><div class='inline'>
|
540
|
+
<p>Check the status of Automate.</p>
|
541
|
+
</div></span>
|
542
|
+
|
543
|
+
</li>
|
544
|
+
|
545
|
+
|
546
|
+
</ul>
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
<div id="class_attr_details" class="attr_details">
|
551
|
+
<h2>Class Attribute Details</h2>
|
552
|
+
|
553
|
+
|
554
|
+
<span id="api=-class_method"></span>
|
555
|
+
<div class="method_details first">
|
556
|
+
<h3 class="signature first" id="api-class_method">
|
557
|
+
|
558
|
+
.<strong>api</strong> ⇒ <tt>Object</tt>
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
|
563
|
+
|
564
|
+
</h3><div class="docstring">
|
565
|
+
<div class="discussion">
|
566
|
+
|
567
|
+
<p>Returns the value of attribute api</p>
|
568
|
+
|
569
|
+
|
570
|
+
</div>
|
571
|
+
</div>
|
572
|
+
<div class="tags">
|
573
|
+
|
574
|
+
|
575
|
+
</div><table class="source_code">
|
576
|
+
<tr>
|
577
|
+
<td>
|
578
|
+
<pre class="lines">
|
579
|
+
|
580
|
+
|
581
|
+
14
|
582
|
+
15
|
583
|
+
16</pre>
|
584
|
+
</td>
|
585
|
+
<td>
|
586
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
587
|
+
|
588
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_api'>api</span>
|
589
|
+
<span class='ivar'>@api</span>
|
590
|
+
<span class='kw'>end</span></pre>
|
591
|
+
</td>
|
592
|
+
</tr>
|
593
|
+
</table>
|
594
|
+
</div>
|
595
|
+
|
596
|
+
|
597
|
+
<span id="credentials=-class_method"></span>
|
598
|
+
<div class="method_details ">
|
599
|
+
<h3 class="signature " id="credentials-class_method">
|
600
|
+
|
601
|
+
.<strong>credentials</strong> ⇒ <tt>Object</tt>
|
602
|
+
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
|
607
|
+
</h3><div class="docstring">
|
608
|
+
<div class="discussion">
|
609
|
+
|
610
|
+
<p>Returns the value of attribute credentials</p>
|
611
|
+
|
612
|
+
|
613
|
+
</div>
|
614
|
+
</div>
|
615
|
+
<div class="tags">
|
616
|
+
|
617
|
+
|
618
|
+
</div><table class="source_code">
|
619
|
+
<tr>
|
620
|
+
<td>
|
621
|
+
<pre class="lines">
|
622
|
+
|
623
|
+
|
624
|
+
14
|
625
|
+
15
|
626
|
+
16</pre>
|
627
|
+
</td>
|
628
|
+
<td>
|
629
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
630
|
+
|
631
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
|
632
|
+
<span class='ivar'>@credentials</span>
|
633
|
+
<span class='kw'>end</span></pre>
|
634
|
+
</td>
|
635
|
+
</tr>
|
636
|
+
</table>
|
637
|
+
</div>
|
638
|
+
|
639
|
+
|
640
|
+
<span id="enterprise=-class_method"></span>
|
641
|
+
<div class="method_details ">
|
642
|
+
<h3 class="signature " id="enterprise-class_method">
|
643
|
+
|
644
|
+
.<strong>enterprise</strong> ⇒ <tt>Object</tt>
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
</h3><div class="docstring">
|
651
|
+
<div class="discussion">
|
652
|
+
|
653
|
+
<p>Returns the value of attribute enterprise</p>
|
654
|
+
|
655
|
+
|
656
|
+
</div>
|
657
|
+
</div>
|
658
|
+
<div class="tags">
|
659
|
+
|
660
|
+
|
661
|
+
</div><table class="source_code">
|
662
|
+
<tr>
|
663
|
+
<td>
|
664
|
+
<pre class="lines">
|
665
|
+
|
666
|
+
|
667
|
+
14
|
668
|
+
15
|
669
|
+
16</pre>
|
670
|
+
</td>
|
671
|
+
<td>
|
672
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
673
|
+
|
674
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_enterprise'>enterprise</span>
|
675
|
+
<span class='ivar'>@enterprise</span>
|
676
|
+
<span class='kw'>end</span></pre>
|
677
|
+
</td>
|
678
|
+
</tr>
|
679
|
+
</table>
|
680
|
+
</div>
|
681
|
+
|
682
|
+
|
683
|
+
<span id="organization=-class_method"></span>
|
684
|
+
<div class="method_details ">
|
685
|
+
<h3 class="signature " id="organization-class_method">
|
686
|
+
|
687
|
+
.<strong>organization</strong> ⇒ <tt>Object</tt>
|
688
|
+
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
|
693
|
+
</h3><div class="docstring">
|
694
|
+
<div class="discussion">
|
695
|
+
|
696
|
+
<p>Returns the value of attribute organization</p>
|
697
|
+
|
698
|
+
|
699
|
+
</div>
|
700
|
+
</div>
|
701
|
+
<div class="tags">
|
702
|
+
|
703
|
+
|
704
|
+
</div><table class="source_code">
|
705
|
+
<tr>
|
706
|
+
<td>
|
707
|
+
<pre class="lines">
|
708
|
+
|
709
|
+
|
710
|
+
14
|
711
|
+
15
|
712
|
+
16</pre>
|
713
|
+
</td>
|
714
|
+
<td>
|
715
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
716
|
+
|
717
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_organization'>organization</span>
|
718
|
+
<span class='ivar'>@organization</span>
|
719
|
+
<span class='kw'>end</span></pre>
|
720
|
+
</td>
|
721
|
+
</tr>
|
722
|
+
</table>
|
723
|
+
</div>
|
724
|
+
|
725
|
+
|
726
|
+
<span id="pipeline=-class_method"></span>
|
727
|
+
<div class="method_details ">
|
728
|
+
<h3 class="signature " id="pipeline-class_method">
|
729
|
+
|
730
|
+
.<strong>pipeline</strong>(enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ <tt>Object</tt>
|
731
|
+
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
</h3><div class="docstring">
|
737
|
+
<div class="discussion">
|
738
|
+
|
739
|
+
<p>Fetch a pipeline of a project under an enterprise, organization pair.</p>
|
740
|
+
|
741
|
+
|
742
|
+
</div>
|
743
|
+
</div>
|
744
|
+
<div class="tags">
|
745
|
+
|
746
|
+
|
747
|
+
</div><table class="source_code">
|
748
|
+
<tr>
|
749
|
+
<td>
|
750
|
+
<pre class="lines">
|
751
|
+
|
752
|
+
|
753
|
+
80
|
754
|
+
81
|
755
|
+
82</pre>
|
756
|
+
</td>
|
757
|
+
<td>
|
758
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 80</span>
|
759
|
+
|
760
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
|
761
|
+
<span class='ivar'>@pipeline</span>
|
762
|
+
<span class='kw'>end</span></pre>
|
763
|
+
</td>
|
764
|
+
</tr>
|
765
|
+
</table>
|
766
|
+
</div>
|
767
|
+
|
768
|
+
|
769
|
+
<span id="project=-class_method"></span>
|
770
|
+
<div class="method_details ">
|
771
|
+
<h3 class="signature " id="project-class_method">
|
772
|
+
|
773
|
+
.<strong>project</strong> ⇒ <tt>Object</tt>
|
774
|
+
|
775
|
+
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
</h3><div class="docstring">
|
780
|
+
<div class="discussion">
|
781
|
+
|
782
|
+
<p>Returns the value of attribute project</p>
|
783
|
+
|
784
|
+
|
785
|
+
</div>
|
786
|
+
</div>
|
787
|
+
<div class="tags">
|
788
|
+
|
789
|
+
|
790
|
+
</div><table class="source_code">
|
791
|
+
<tr>
|
792
|
+
<td>
|
793
|
+
<pre class="lines">
|
794
|
+
|
795
|
+
|
796
|
+
14
|
797
|
+
15
|
798
|
+
16</pre>
|
799
|
+
</td>
|
800
|
+
<td>
|
801
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
802
|
+
|
803
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_project'>project</span>
|
804
|
+
<span class='ivar'>@project</span>
|
805
|
+
<span class='kw'>end</span></pre>
|
806
|
+
</td>
|
807
|
+
</tr>
|
808
|
+
</table>
|
809
|
+
</div>
|
810
|
+
|
811
|
+
|
812
|
+
<span id="url=-class_method"></span>
|
813
|
+
<div class="method_details ">
|
814
|
+
<h3 class="signature " id="url-class_method">
|
815
|
+
|
816
|
+
.<strong>url</strong> ⇒ <tt>Object</tt>
|
817
|
+
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
</h3><div class="docstring">
|
823
|
+
<div class="discussion">
|
824
|
+
|
825
|
+
<p>Returns the value of attribute url</p>
|
826
|
+
|
827
|
+
|
828
|
+
</div>
|
829
|
+
</div>
|
830
|
+
<div class="tags">
|
831
|
+
|
832
|
+
|
833
|
+
</div><table class="source_code">
|
834
|
+
<tr>
|
835
|
+
<td>
|
836
|
+
<pre class="lines">
|
837
|
+
|
838
|
+
|
839
|
+
14
|
840
|
+
15
|
841
|
+
16</pre>
|
842
|
+
</td>
|
843
|
+
<td>
|
844
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 14</span>
|
845
|
+
|
846
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
|
847
|
+
<span class='ivar'>@url</span>
|
848
|
+
<span class='kw'>end</span></pre>
|
849
|
+
</td>
|
850
|
+
</tr>
|
851
|
+
</table>
|
852
|
+
</div>
|
853
|
+
|
854
|
+
</div>
|
855
|
+
|
856
|
+
|
857
|
+
<div id="class_method_details" class="method_details_list">
|
858
|
+
<h2>Class Method Details</h2>
|
859
|
+
|
860
|
+
|
861
|
+
<div class="method_details first">
|
862
|
+
<h3 class="signature first" id="approve_change-class_method">
|
863
|
+
|
864
|
+
.<strong>approve_change</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5) ⇒ <tt>Object</tt>
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
</h3><div class="docstring">
|
871
|
+
<div class="discussion">
|
872
|
+
|
873
|
+
<p>Approve a change by change topic.</p>
|
874
|
+
|
875
|
+
<p>default. to 10</p>
|
876
|
+
|
877
|
+
|
878
|
+
</div>
|
879
|
+
</div>
|
880
|
+
<div class="tags">
|
881
|
+
<p class="tag_title">Parameters:</p>
|
882
|
+
<ul class="param">
|
883
|
+
|
884
|
+
<li>
|
885
|
+
|
886
|
+
<span class='name'>enterprise</span>
|
887
|
+
|
888
|
+
|
889
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
—
|
894
|
+
<div class='inline'>
|
895
|
+
<p>a customizable set of options</p>
|
896
|
+
</div>
|
897
|
+
|
898
|
+
</li>
|
899
|
+
|
900
|
+
<li>
|
901
|
+
|
902
|
+
<span class='name'>organization</span>
|
903
|
+
|
904
|
+
|
905
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
906
|
+
|
907
|
+
|
908
|
+
|
909
|
+
—
|
910
|
+
<div class='inline'>
|
911
|
+
<p>a customizable set of options</p>
|
912
|
+
</div>
|
913
|
+
|
914
|
+
</li>
|
915
|
+
|
916
|
+
<li>
|
917
|
+
|
918
|
+
<span class='name'>project</span>
|
919
|
+
|
920
|
+
|
921
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
922
|
+
|
923
|
+
|
924
|
+
|
925
|
+
—
|
926
|
+
<div class='inline'>
|
927
|
+
<p>a customizable set of options</p>
|
928
|
+
</div>
|
929
|
+
|
930
|
+
</li>
|
931
|
+
|
932
|
+
<li>
|
933
|
+
|
934
|
+
<span class='name'>pipeline</span>
|
935
|
+
|
936
|
+
|
937
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
938
|
+
|
939
|
+
|
940
|
+
|
941
|
+
—
|
942
|
+
<div class='inline'>
|
943
|
+
<p>a customizable set of options</p>
|
944
|
+
</div>
|
945
|
+
|
946
|
+
</li>
|
947
|
+
|
948
|
+
<li>
|
949
|
+
|
950
|
+
<span class='name'>topic</span>
|
951
|
+
|
952
|
+
|
953
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
954
|
+
|
955
|
+
|
956
|
+
|
957
|
+
—
|
958
|
+
<div class='inline'>
|
959
|
+
<p>a customizable set of options</p>
|
960
|
+
</div>
|
961
|
+
|
962
|
+
</li>
|
963
|
+
|
964
|
+
<li>
|
965
|
+
|
966
|
+
<span class='name'>wait</span>
|
967
|
+
|
968
|
+
|
969
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
970
|
+
|
971
|
+
|
972
|
+
|
973
|
+
—
|
974
|
+
<div class='inline'>
|
975
|
+
<p>a customizable set of options</p>
|
976
|
+
</div>
|
977
|
+
|
978
|
+
</li>
|
979
|
+
|
980
|
+
<li>
|
981
|
+
|
982
|
+
<span class='name'>timeout</span>
|
983
|
+
|
984
|
+
|
985
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
—
|
990
|
+
<div class='inline'>
|
991
|
+
<p>a customizable set of options</p>
|
992
|
+
</div>
|
993
|
+
|
994
|
+
</li>
|
995
|
+
|
996
|
+
<li>
|
997
|
+
|
998
|
+
<span class='name'>retries</span>
|
999
|
+
|
1000
|
+
|
1001
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1002
|
+
|
1003
|
+
|
1004
|
+
|
1005
|
+
—
|
1006
|
+
<div class='inline'>
|
1007
|
+
<p>a customizable set of options</p>
|
1008
|
+
</div>
|
1009
|
+
|
1010
|
+
</li>
|
1011
|
+
|
1012
|
+
</ul>
|
1013
|
+
|
1014
|
+
|
1015
|
+
|
1016
|
+
|
1017
|
+
<p class="tag_title">Options Hash (<tt>enterprise:</tt>):</p>
|
1018
|
+
<ul class="option">
|
1019
|
+
|
1020
|
+
<li>
|
1021
|
+
<span class="name">the</span>
|
1022
|
+
<span class="type">(<tt>String</tt>)</span>
|
1023
|
+
<span class="default">
|
1024
|
+
|
1025
|
+
</span>
|
1026
|
+
|
1027
|
+
— <div class='inline'>
|
1028
|
+
<p>enterprise to fetch org from, defaults to</p>
|
1029
|
+
</div>
|
1030
|
+
|
1031
|
+
</li>
|
1032
|
+
|
1033
|
+
</ul>
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
<p class="tag_title">Options Hash (<tt>organization:</tt>):</p>
|
1038
|
+
<ul class="option">
|
1039
|
+
|
1040
|
+
<li>
|
1041
|
+
<span class="name">the</span>
|
1042
|
+
<span class="type">(<tt>String</tt>)</span>
|
1043
|
+
<span class="default">
|
1044
|
+
|
1045
|
+
</span>
|
1046
|
+
|
1047
|
+
— <div class='inline'>
|
1048
|
+
<p>organization to fetch from.</p>
|
1049
|
+
</div>
|
1050
|
+
|
1051
|
+
</li>
|
1052
|
+
|
1053
|
+
</ul>
|
1054
|
+
|
1055
|
+
|
1056
|
+
|
1057
|
+
<p class="tag_title">Options Hash (<tt>project:</tt>):</p>
|
1058
|
+
<ul class="option">
|
1059
|
+
|
1060
|
+
<li>
|
1061
|
+
<span class="name">the</span>
|
1062
|
+
<span class="type">(<tt>String</tt>)</span>
|
1063
|
+
<span class="default">
|
1064
|
+
|
1065
|
+
</span>
|
1066
|
+
|
1067
|
+
— <div class='inline'>
|
1068
|
+
<p>project to fetch from.</p>
|
1069
|
+
</div>
|
1070
|
+
|
1071
|
+
</li>
|
1072
|
+
|
1073
|
+
</ul>
|
1074
|
+
|
1075
|
+
|
1076
|
+
|
1077
|
+
<p class="tag_title">Options Hash (<tt>pipeline:</tt>):</p>
|
1078
|
+
<ul class="option">
|
1079
|
+
|
1080
|
+
<li>
|
1081
|
+
<span class="name">the</span>
|
1082
|
+
<span class="type">(<tt>String</tt>)</span>
|
1083
|
+
<span class="default">
|
1084
|
+
|
1085
|
+
</span>
|
1086
|
+
|
1087
|
+
— <div class='inline'>
|
1088
|
+
<p>pipeline to fetch from.</p>
|
1089
|
+
</div>
|
1090
|
+
|
1091
|
+
</li>
|
1092
|
+
|
1093
|
+
</ul>
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1097
|
+
<p class="tag_title">Options Hash (<tt>topic:</tt>):</p>
|
1098
|
+
<ul class="option">
|
1099
|
+
|
1100
|
+
<li>
|
1101
|
+
<span class="name">the</span>
|
1102
|
+
<span class="type">(<tt>String</tt>)</span>
|
1103
|
+
<span class="default">
|
1104
|
+
|
1105
|
+
</span>
|
1106
|
+
|
1107
|
+
— <div class='inline'>
|
1108
|
+
<p>change topic to approve</p>
|
1109
|
+
</div>
|
1110
|
+
|
1111
|
+
</li>
|
1112
|
+
|
1113
|
+
</ul>
|
1114
|
+
|
1115
|
+
|
1116
|
+
|
1117
|
+
<p class="tag_title">Options Hash (<tt>wait:</tt>):</p>
|
1118
|
+
<ul class="option">
|
1119
|
+
|
1120
|
+
<li>
|
1121
|
+
<span class="name">to</span>
|
1122
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
1123
|
+
<span class="default">
|
1124
|
+
|
1125
|
+
</span>
|
1126
|
+
|
1127
|
+
— <div class='inline'>
|
1128
|
+
<p>wait for the approval stages to complete.</p>
|
1129
|
+
</div>
|
1130
|
+
|
1131
|
+
</li>
|
1132
|
+
|
1133
|
+
</ul>
|
1134
|
+
|
1135
|
+
|
1136
|
+
|
1137
|
+
<p class="tag_title">Options Hash (<tt>timeout:</tt>):</p>
|
1138
|
+
<ul class="option">
|
1139
|
+
|
1140
|
+
<li>
|
1141
|
+
<span class="name">the</span>
|
1142
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1143
|
+
<span class="default">
|
1144
|
+
|
1145
|
+
</span>
|
1146
|
+
|
1147
|
+
— <div class='inline'>
|
1148
|
+
<p>time in seconds to wait between requests defaults</p>
|
1149
|
+
</div>
|
1150
|
+
|
1151
|
+
</li>
|
1152
|
+
|
1153
|
+
</ul>
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1157
|
+
<p class="tag_title">Options Hash (<tt>retries:</tt>):</p>
|
1158
|
+
<ul class="option">
|
1159
|
+
|
1160
|
+
<li>
|
1161
|
+
<span class="name">the</span>
|
1162
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1163
|
+
<span class="default">
|
1164
|
+
|
1165
|
+
</span>
|
1166
|
+
|
1167
|
+
— <div class='inline'>
|
1168
|
+
<p>amount of retries to make, defaults to 5</p>
|
1169
|
+
</div>
|
1170
|
+
|
1171
|
+
</li>
|
1172
|
+
|
1173
|
+
</ul>
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
</div><table class="source_code">
|
1178
|
+
<tr>
|
1179
|
+
<td>
|
1180
|
+
<pre class="lines">
|
1181
|
+
|
1182
|
+
|
1183
|
+
140
|
1184
|
+
141
|
1185
|
+
142
|
1186
|
+
143
|
1187
|
+
144
|
1188
|
+
145
|
1189
|
+
146
|
1190
|
+
147
|
1191
|
+
148
|
1192
|
+
149
|
1193
|
+
150
|
1194
|
+
151
|
1195
|
+
152
|
1196
|
+
153
|
1197
|
+
154
|
1198
|
+
155
|
1199
|
+
156
|
1200
|
+
157
|
1201
|
+
158
|
1202
|
+
159
|
1203
|
+
160
|
1204
|
+
161
|
1205
|
+
162
|
1206
|
+
163
|
1207
|
+
164
|
1208
|
+
165
|
1209
|
+
166
|
1210
|
+
167
|
1211
|
+
168
|
1212
|
+
169
|
1213
|
+
170
|
1214
|
+
171
|
1215
|
+
172
|
1216
|
+
173
|
1217
|
+
174
|
1218
|
+
175
|
1219
|
+
176
|
1220
|
+
177
|
1221
|
+
178
|
1222
|
+
179
|
1223
|
+
180
|
1224
|
+
181
|
1225
|
+
182
|
1226
|
+
183
|
1227
|
+
184</pre>
|
1228
|
+
</td>
|
1229
|
+
<td>
|
1230
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 140</span>
|
1231
|
+
|
1232
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_approve_change'>approve_change</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='ivar'>@enterprise</span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='ivar'>@organization</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='ivar'>@project</span><span class='comma'>,</span> <span class='label'>pipeline:</span> <span class='ivar'>@pipeline</span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wait:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='int'>10</span><span class='comma'>,</span> <span class='label'>retries:</span> <span class='int'>5</span><span class='rparen'>)</span>
|
1233
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1234
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1235
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1236
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1237
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1238
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1239
|
+
<span class='rparen'>)</span>
|
1240
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_wait'>wait</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_approvable?'>approvable?</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1241
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>=</span> <span class='int'>1</span>
|
1242
|
+
<span class='kw'>while</span> <span class='id identifier rubyid_times'>times</span> <span class='op'><=</span> <span class='id identifier rubyid_retries'>retries</span>
|
1243
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1244
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1245
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1246
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1247
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1248
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1249
|
+
<span class='rparen'>)</span>
|
1250
|
+
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_approvable?'>approvable?</span>
|
1251
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_failed?'>failed?</span>
|
1252
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Stage </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_content'> retries </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_times'>times</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_retries'>retries</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1253
|
+
<span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_timeout'>timeout</span>
|
1254
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1255
|
+
<span class='kw'>end</span>
|
1256
|
+
<span class='kw'>end</span>
|
1257
|
+
|
1258
|
+
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_approve'>approve</span>
|
1259
|
+
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_wait'>wait</span> <span class='op'>&&</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1260
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>=</span> <span class='int'>1</span>
|
1261
|
+
<span class='kw'>while</span> <span class='id identifier rubyid_times'>times</span> <span class='op'><=</span> <span class='id identifier rubyid_retries'>retries</span>
|
1262
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1263
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1264
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1265
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1266
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1267
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1268
|
+
<span class='rparen'>)</span>
|
1269
|
+
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1270
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_failed?'>failed?</span>
|
1271
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Stage </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_content'> retries </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_times'>times</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_retries'>retries</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1272
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1273
|
+
<span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_timeout'>timeout</span>
|
1274
|
+
<span class='kw'>end</span>
|
1275
|
+
<span class='kw'>true</span>
|
1276
|
+
<span class='kw'>end</span></pre>
|
1277
|
+
</td>
|
1278
|
+
</tr>
|
1279
|
+
</table>
|
1280
|
+
</div>
|
1281
|
+
|
1282
|
+
<div class="method_details ">
|
1283
|
+
<h3 class="signature " id="change_by_topic-class_method">
|
1284
|
+
|
1285
|
+
.<strong>change_by_topic</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil) ⇒ <tt>Object</tt>
|
1286
|
+
|
1287
|
+
|
1288
|
+
|
1289
|
+
|
1290
|
+
|
1291
|
+
</h3><div class="docstring">
|
1292
|
+
<div class="discussion">
|
1293
|
+
|
1294
|
+
<p>Find a change by topic.</p>
|
1295
|
+
|
1296
|
+
<p>default.</p>
|
1297
|
+
|
1298
|
+
|
1299
|
+
</div>
|
1300
|
+
</div>
|
1301
|
+
<div class="tags">
|
1302
|
+
<p class="tag_title">Parameters:</p>
|
1303
|
+
<ul class="param">
|
1304
|
+
|
1305
|
+
<li>
|
1306
|
+
|
1307
|
+
<span class='name'>enterprise</span>
|
1308
|
+
|
1309
|
+
|
1310
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1311
|
+
|
1312
|
+
|
1313
|
+
|
1314
|
+
—
|
1315
|
+
<div class='inline'>
|
1316
|
+
<p>a customizable set of options</p>
|
1317
|
+
</div>
|
1318
|
+
|
1319
|
+
</li>
|
1320
|
+
|
1321
|
+
<li>
|
1322
|
+
|
1323
|
+
<span class='name'>organization</span>
|
1324
|
+
|
1325
|
+
|
1326
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1327
|
+
|
1328
|
+
|
1329
|
+
|
1330
|
+
—
|
1331
|
+
<div class='inline'>
|
1332
|
+
<p>a customizable set of options</p>
|
1333
|
+
</div>
|
1334
|
+
|
1335
|
+
</li>
|
1336
|
+
|
1337
|
+
<li>
|
1338
|
+
|
1339
|
+
<span class='name'>project</span>
|
1340
|
+
|
1341
|
+
|
1342
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1343
|
+
|
1344
|
+
|
1345
|
+
|
1346
|
+
—
|
1347
|
+
<div class='inline'>
|
1348
|
+
<p>a customizable set of options</p>
|
1349
|
+
</div>
|
1350
|
+
|
1351
|
+
</li>
|
1352
|
+
|
1353
|
+
<li>
|
1354
|
+
|
1355
|
+
<span class='name'>pipeline</span>
|
1356
|
+
|
1357
|
+
|
1358
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
—
|
1363
|
+
<div class='inline'>
|
1364
|
+
<p>a customizable set of options</p>
|
1365
|
+
</div>
|
1366
|
+
|
1367
|
+
</li>
|
1368
|
+
|
1369
|
+
<li>
|
1370
|
+
|
1371
|
+
<span class='name'>topic</span>
|
1372
|
+
|
1373
|
+
|
1374
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1375
|
+
|
1376
|
+
|
1377
|
+
|
1378
|
+
—
|
1379
|
+
<div class='inline'>
|
1380
|
+
<p>a customizable set of options</p>
|
1381
|
+
</div>
|
1382
|
+
|
1383
|
+
</li>
|
1384
|
+
|
1385
|
+
</ul>
|
1386
|
+
|
1387
|
+
|
1388
|
+
|
1389
|
+
|
1390
|
+
<p class="tag_title">Options Hash (<tt>enterprise:</tt>):</p>
|
1391
|
+
<ul class="option">
|
1392
|
+
|
1393
|
+
<li>
|
1394
|
+
<span class="name">the</span>
|
1395
|
+
<span class="type">(<tt>String</tt>)</span>
|
1396
|
+
<span class="default">
|
1397
|
+
|
1398
|
+
</span>
|
1399
|
+
|
1400
|
+
— <div class='inline'>
|
1401
|
+
<p>enterprise to fetch org from, defaults to</p>
|
1402
|
+
</div>
|
1403
|
+
|
1404
|
+
</li>
|
1405
|
+
|
1406
|
+
</ul>
|
1407
|
+
|
1408
|
+
|
1409
|
+
|
1410
|
+
<p class="tag_title">Options Hash (<tt>organization:</tt>):</p>
|
1411
|
+
<ul class="option">
|
1412
|
+
|
1413
|
+
<li>
|
1414
|
+
<span class="name">the</span>
|
1415
|
+
<span class="type">(<tt>String</tt>)</span>
|
1416
|
+
<span class="default">
|
1417
|
+
|
1418
|
+
</span>
|
1419
|
+
|
1420
|
+
— <div class='inline'>
|
1421
|
+
<p>organization to fetch from.</p>
|
1422
|
+
</div>
|
1423
|
+
|
1424
|
+
</li>
|
1425
|
+
|
1426
|
+
</ul>
|
1427
|
+
|
1428
|
+
|
1429
|
+
|
1430
|
+
<p class="tag_title">Options Hash (<tt>project:</tt>):</p>
|
1431
|
+
<ul class="option">
|
1432
|
+
|
1433
|
+
<li>
|
1434
|
+
<span class="name">the</span>
|
1435
|
+
<span class="type">(<tt>String</tt>)</span>
|
1436
|
+
<span class="default">
|
1437
|
+
|
1438
|
+
</span>
|
1439
|
+
|
1440
|
+
— <div class='inline'>
|
1441
|
+
<p>project to fetch from.</p>
|
1442
|
+
</div>
|
1443
|
+
|
1444
|
+
</li>
|
1445
|
+
|
1446
|
+
</ul>
|
1447
|
+
|
1448
|
+
|
1449
|
+
|
1450
|
+
<p class="tag_title">Options Hash (<tt>pipeline:</tt>):</p>
|
1451
|
+
<ul class="option">
|
1452
|
+
|
1453
|
+
<li>
|
1454
|
+
<span class="name">the</span>
|
1455
|
+
<span class="type">(<tt>String</tt>)</span>
|
1456
|
+
<span class="default">
|
1457
|
+
|
1458
|
+
</span>
|
1459
|
+
|
1460
|
+
— <div class='inline'>
|
1461
|
+
<p>pipeline to fetch from.</p>
|
1462
|
+
</div>
|
1463
|
+
|
1464
|
+
</li>
|
1465
|
+
|
1466
|
+
</ul>
|
1467
|
+
|
1468
|
+
|
1469
|
+
|
1470
|
+
<p class="tag_title">Options Hash (<tt>topic:</tt>):</p>
|
1471
|
+
<ul class="option">
|
1472
|
+
|
1473
|
+
<li>
|
1474
|
+
<span class="name">the</span>
|
1475
|
+
<span class="type">(<tt>String</tt>)</span>
|
1476
|
+
<span class="default">
|
1477
|
+
|
1478
|
+
</span>
|
1479
|
+
|
1480
|
+
— <div class='inline'>
|
1481
|
+
<p>topic to fetch a change from.</p>
|
1482
|
+
</div>
|
1483
|
+
|
1484
|
+
</li>
|
1485
|
+
|
1486
|
+
</ul>
|
1487
|
+
|
1488
|
+
|
1489
|
+
|
1490
|
+
</div><table class="source_code">
|
1491
|
+
<tr>
|
1492
|
+
<td>
|
1493
|
+
<pre class="lines">
|
1494
|
+
|
1495
|
+
|
1496
|
+
116
|
1497
|
+
117
|
1498
|
+
118
|
1499
|
+
119
|
1500
|
+
120
|
1501
|
+
121
|
1502
|
+
122
|
1503
|
+
123
|
1504
|
+
124</pre>
|
1505
|
+
</td>
|
1506
|
+
<td>
|
1507
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 116</span>
|
1508
|
+
|
1509
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='ivar'>@enterprise</span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='ivar'>@organization</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='ivar'>@project</span><span class='comma'>,</span> <span class='label'>pipeline:</span> <span class='ivar'>@pipeline</span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1510
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pipeline'>pipeline</span><span class='lparen'>(</span>
|
1511
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1512
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1513
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1514
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
|
1515
|
+
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_topic'>topic</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span><span class='lparen'>(</span><span class='id identifier rubyid_topic'>topic</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
1516
|
+
<span class='const'><span class='object_link'><a href="" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AutomateSoup/Change.html" title="AutomateSoup::Change (class)">Change</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AutomateSoup/Change.html#initialize-instance_method" title="AutomateSoup::Change#initialize (method)">new</a></span></span> <span class='id identifier rubyid_o'>o</span>
|
1517
|
+
<span class='kw'>end</span></pre>
|
1518
|
+
</td>
|
1519
|
+
</tr>
|
1520
|
+
</table>
|
1521
|
+
</div>
|
1522
|
+
|
1523
|
+
<div class="method_details ">
|
1524
|
+
<h3 class="signature " id="deliver_change-class_method">
|
1525
|
+
|
1526
|
+
.<strong>deliver_change</strong>(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5) ⇒ <tt>Object</tt>
|
1527
|
+
|
1528
|
+
|
1529
|
+
|
1530
|
+
|
1531
|
+
|
1532
|
+
</h3><div class="docstring">
|
1533
|
+
<div class="discussion">
|
1534
|
+
|
1535
|
+
<p>Delivery a change by a topic</p>
|
1536
|
+
|
1537
|
+
<p>default. to 10</p>
|
1538
|
+
|
1539
|
+
|
1540
|
+
</div>
|
1541
|
+
</div>
|
1542
|
+
<div class="tags">
|
1543
|
+
<p class="tag_title">Parameters:</p>
|
1544
|
+
<ul class="param">
|
1545
|
+
|
1546
|
+
<li>
|
1547
|
+
|
1548
|
+
<span class='name'>enterprise</span>
|
1549
|
+
|
1550
|
+
|
1551
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1552
|
+
|
1553
|
+
|
1554
|
+
|
1555
|
+
—
|
1556
|
+
<div class='inline'>
|
1557
|
+
<p>a customizable set of options</p>
|
1558
|
+
</div>
|
1559
|
+
|
1560
|
+
</li>
|
1561
|
+
|
1562
|
+
<li>
|
1563
|
+
|
1564
|
+
<span class='name'>organization</span>
|
1565
|
+
|
1566
|
+
|
1567
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1568
|
+
|
1569
|
+
|
1570
|
+
|
1571
|
+
—
|
1572
|
+
<div class='inline'>
|
1573
|
+
<p>a customizable set of options</p>
|
1574
|
+
</div>
|
1575
|
+
|
1576
|
+
</li>
|
1577
|
+
|
1578
|
+
<li>
|
1579
|
+
|
1580
|
+
<span class='name'>project</span>
|
1581
|
+
|
1582
|
+
|
1583
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1584
|
+
|
1585
|
+
|
1586
|
+
|
1587
|
+
—
|
1588
|
+
<div class='inline'>
|
1589
|
+
<p>a customizable set of options</p>
|
1590
|
+
</div>
|
1591
|
+
|
1592
|
+
</li>
|
1593
|
+
|
1594
|
+
<li>
|
1595
|
+
|
1596
|
+
<span class='name'>pipeline</span>
|
1597
|
+
|
1598
|
+
|
1599
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1600
|
+
|
1601
|
+
|
1602
|
+
|
1603
|
+
—
|
1604
|
+
<div class='inline'>
|
1605
|
+
<p>a customizable set of options</p>
|
1606
|
+
</div>
|
1607
|
+
|
1608
|
+
</li>
|
1609
|
+
|
1610
|
+
<li>
|
1611
|
+
|
1612
|
+
<span class='name'>topic</span>
|
1613
|
+
|
1614
|
+
|
1615
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1616
|
+
|
1617
|
+
|
1618
|
+
|
1619
|
+
—
|
1620
|
+
<div class='inline'>
|
1621
|
+
<p>a customizable set of options</p>
|
1622
|
+
</div>
|
1623
|
+
|
1624
|
+
</li>
|
1625
|
+
|
1626
|
+
<li>
|
1627
|
+
|
1628
|
+
<span class='name'>wait</span>
|
1629
|
+
|
1630
|
+
|
1631
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1632
|
+
|
1633
|
+
|
1634
|
+
|
1635
|
+
—
|
1636
|
+
<div class='inline'>
|
1637
|
+
<p>a customizable set of options</p>
|
1638
|
+
</div>
|
1639
|
+
|
1640
|
+
</li>
|
1641
|
+
|
1642
|
+
<li>
|
1643
|
+
|
1644
|
+
<span class='name'>timeout</span>
|
1645
|
+
|
1646
|
+
|
1647
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1648
|
+
|
1649
|
+
|
1650
|
+
|
1651
|
+
—
|
1652
|
+
<div class='inline'>
|
1653
|
+
<p>a customizable set of options</p>
|
1654
|
+
</div>
|
1655
|
+
|
1656
|
+
</li>
|
1657
|
+
|
1658
|
+
<li>
|
1659
|
+
|
1660
|
+
<span class='name'>retries</span>
|
1661
|
+
|
1662
|
+
|
1663
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
1664
|
+
|
1665
|
+
|
1666
|
+
|
1667
|
+
—
|
1668
|
+
<div class='inline'>
|
1669
|
+
<p>a customizable set of options</p>
|
1670
|
+
</div>
|
1671
|
+
|
1672
|
+
</li>
|
1673
|
+
|
1674
|
+
</ul>
|
1675
|
+
|
1676
|
+
|
1677
|
+
|
1678
|
+
|
1679
|
+
<p class="tag_title">Options Hash (<tt>enterprise:</tt>):</p>
|
1680
|
+
<ul class="option">
|
1681
|
+
|
1682
|
+
<li>
|
1683
|
+
<span class="name">the</span>
|
1684
|
+
<span class="type">(<tt>String</tt>)</span>
|
1685
|
+
<span class="default">
|
1686
|
+
|
1687
|
+
</span>
|
1688
|
+
|
1689
|
+
— <div class='inline'>
|
1690
|
+
<p>enterprise to fetch org from, defaults to</p>
|
1691
|
+
</div>
|
1692
|
+
|
1693
|
+
</li>
|
1694
|
+
|
1695
|
+
</ul>
|
1696
|
+
|
1697
|
+
|
1698
|
+
|
1699
|
+
<p class="tag_title">Options Hash (<tt>organization:</tt>):</p>
|
1700
|
+
<ul class="option">
|
1701
|
+
|
1702
|
+
<li>
|
1703
|
+
<span class="name">the</span>
|
1704
|
+
<span class="type">(<tt>String</tt>)</span>
|
1705
|
+
<span class="default">
|
1706
|
+
|
1707
|
+
</span>
|
1708
|
+
|
1709
|
+
— <div class='inline'>
|
1710
|
+
<p>organization to fetch from.</p>
|
1711
|
+
</div>
|
1712
|
+
|
1713
|
+
</li>
|
1714
|
+
|
1715
|
+
</ul>
|
1716
|
+
|
1717
|
+
|
1718
|
+
|
1719
|
+
<p class="tag_title">Options Hash (<tt>project:</tt>):</p>
|
1720
|
+
<ul class="option">
|
1721
|
+
|
1722
|
+
<li>
|
1723
|
+
<span class="name">the</span>
|
1724
|
+
<span class="type">(<tt>String</tt>)</span>
|
1725
|
+
<span class="default">
|
1726
|
+
|
1727
|
+
</span>
|
1728
|
+
|
1729
|
+
— <div class='inline'>
|
1730
|
+
<p>project to fetch from.</p>
|
1731
|
+
</div>
|
1732
|
+
|
1733
|
+
</li>
|
1734
|
+
|
1735
|
+
</ul>
|
1736
|
+
|
1737
|
+
|
1738
|
+
|
1739
|
+
<p class="tag_title">Options Hash (<tt>pipeline:</tt>):</p>
|
1740
|
+
<ul class="option">
|
1741
|
+
|
1742
|
+
<li>
|
1743
|
+
<span class="name">the</span>
|
1744
|
+
<span class="type">(<tt>String</tt>)</span>
|
1745
|
+
<span class="default">
|
1746
|
+
|
1747
|
+
</span>
|
1748
|
+
|
1749
|
+
— <div class='inline'>
|
1750
|
+
<p>pipeline to fetch from.</p>
|
1751
|
+
</div>
|
1752
|
+
|
1753
|
+
</li>
|
1754
|
+
|
1755
|
+
</ul>
|
1756
|
+
|
1757
|
+
|
1758
|
+
|
1759
|
+
<p class="tag_title">Options Hash (<tt>topic:</tt>):</p>
|
1760
|
+
<ul class="option">
|
1761
|
+
|
1762
|
+
<li>
|
1763
|
+
<span class="name">the</span>
|
1764
|
+
<span class="type">(<tt>String</tt>)</span>
|
1765
|
+
<span class="default">
|
1766
|
+
|
1767
|
+
</span>
|
1768
|
+
|
1769
|
+
— <div class='inline'>
|
1770
|
+
<p>change topic to approve</p>
|
1771
|
+
</div>
|
1772
|
+
|
1773
|
+
</li>
|
1774
|
+
|
1775
|
+
</ul>
|
1776
|
+
|
1777
|
+
|
1778
|
+
|
1779
|
+
<p class="tag_title">Options Hash (<tt>wait:</tt>):</p>
|
1780
|
+
<ul class="option">
|
1781
|
+
|
1782
|
+
<li>
|
1783
|
+
<span class="name">to</span>
|
1784
|
+
<span class="type">(<tt>Boolean</tt>)</span>
|
1785
|
+
<span class="default">
|
1786
|
+
|
1787
|
+
</span>
|
1788
|
+
|
1789
|
+
— <div class='inline'>
|
1790
|
+
<p>wait for the approval stages to complete.</p>
|
1791
|
+
</div>
|
1792
|
+
|
1793
|
+
</li>
|
1794
|
+
|
1795
|
+
</ul>
|
1796
|
+
|
1797
|
+
|
1798
|
+
|
1799
|
+
<p class="tag_title">Options Hash (<tt>timeout:</tt>):</p>
|
1800
|
+
<ul class="option">
|
1801
|
+
|
1802
|
+
<li>
|
1803
|
+
<span class="name">the</span>
|
1804
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1805
|
+
<span class="default">
|
1806
|
+
|
1807
|
+
</span>
|
1808
|
+
|
1809
|
+
— <div class='inline'>
|
1810
|
+
<p>time in seconds to wait between requests defaults</p>
|
1811
|
+
</div>
|
1812
|
+
|
1813
|
+
</li>
|
1814
|
+
|
1815
|
+
</ul>
|
1816
|
+
|
1817
|
+
|
1818
|
+
|
1819
|
+
<p class="tag_title">Options Hash (<tt>retries:</tt>):</p>
|
1820
|
+
<ul class="option">
|
1821
|
+
|
1822
|
+
<li>
|
1823
|
+
<span class="name">the</span>
|
1824
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
1825
|
+
<span class="default">
|
1826
|
+
|
1827
|
+
</span>
|
1828
|
+
|
1829
|
+
— <div class='inline'>
|
1830
|
+
<p>amount of retries to make, defaults to 5</p>
|
1831
|
+
</div>
|
1832
|
+
|
1833
|
+
</li>
|
1834
|
+
|
1835
|
+
</ul>
|
1836
|
+
|
1837
|
+
|
1838
|
+
|
1839
|
+
</div><table class="source_code">
|
1840
|
+
<tr>
|
1841
|
+
<td>
|
1842
|
+
<pre class="lines">
|
1843
|
+
|
1844
|
+
|
1845
|
+
201
|
1846
|
+
202
|
1847
|
+
203
|
1848
|
+
204
|
1849
|
+
205
|
1850
|
+
206
|
1851
|
+
207
|
1852
|
+
208
|
1853
|
+
209
|
1854
|
+
210
|
1855
|
+
211
|
1856
|
+
212
|
1857
|
+
213
|
1858
|
+
214
|
1859
|
+
215
|
1860
|
+
216
|
1861
|
+
217
|
1862
|
+
218
|
1863
|
+
219
|
1864
|
+
220
|
1865
|
+
221
|
1866
|
+
222
|
1867
|
+
223
|
1868
|
+
224
|
1869
|
+
225
|
1870
|
+
226
|
1871
|
+
227
|
1872
|
+
228
|
1873
|
+
229
|
1874
|
+
230
|
1875
|
+
231
|
1876
|
+
232
|
1877
|
+
233
|
1878
|
+
234
|
1879
|
+
235
|
1880
|
+
236
|
1881
|
+
237
|
1882
|
+
238
|
1883
|
+
239
|
1884
|
+
240
|
1885
|
+
241
|
1886
|
+
242
|
1887
|
+
243
|
1888
|
+
244
|
1889
|
+
245
|
1890
|
+
246</pre>
|
1891
|
+
</td>
|
1892
|
+
<td>
|
1893
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 201</span>
|
1894
|
+
|
1895
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_deliver_change'>deliver_change</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='ivar'>@enterprise</span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='ivar'>@organization</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='ivar'>@project</span><span class='comma'>,</span> <span class='label'>pipeline:</span> <span class='ivar'>@pipeline</span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>wait:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>timeout:</span> <span class='int'>10</span><span class='comma'>,</span> <span class='label'>retries:</span> <span class='int'>5</span><span class='rparen'>)</span>
|
1896
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1897
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1898
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1899
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1900
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1901
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1902
|
+
<span class='rparen'>)</span>
|
1903
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1904
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_wait'>wait</span> <span class='op'>&&</span> <span class='op'>!</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1905
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>=</span> <span class='int'>1</span>
|
1906
|
+
<span class='kw'>while</span> <span class='id identifier rubyid_times'>times</span> <span class='op'><=</span> <span class='id identifier rubyid_retries'>retries</span>
|
1907
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1908
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1909
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1910
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1911
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1912
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1913
|
+
<span class='rparen'>)</span>
|
1914
|
+
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliverable?'>deliverable?</span>
|
1915
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_failed?'>failed?</span>
|
1916
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Stage </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_content'> retries </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_times'>times</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_retries'>retries</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1917
|
+
<span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_timeout'>timeout</span>
|
1918
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1919
|
+
<span class='kw'>end</span>
|
1920
|
+
<span class='kw'>end</span>
|
1921
|
+
|
1922
|
+
<span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_deliver'>deliver</span>
|
1923
|
+
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_wait'>wait</span> <span class='op'>&&</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_delivered?'>delivered?</span>
|
1924
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>=</span> <span class='int'>1</span>
|
1925
|
+
<span class='kw'>while</span> <span class='id identifier rubyid_times'>times</span> <span class='op'><=</span> <span class='id identifier rubyid_retries'>retries</span>
|
1926
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_change_by_topic'>change_by_topic</span><span class='lparen'>(</span>
|
1927
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
1928
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
1929
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
1930
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span><span class='comma'>,</span>
|
1931
|
+
<span class='label'>topic:</span> <span class='id identifier rubyid_topic'>topic</span>
|
1932
|
+
<span class='rparen'>)</span>
|
1933
|
+
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_delivered?'>delivered?</span>
|
1934
|
+
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_failed?'>failed?</span>
|
1935
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Stage </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_o'>o</span><span class='period'>.</span><span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='embexpr_end'>}</span><span class='tstring_content'> retries </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_times'>times</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_retries'>retries</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
1936
|
+
<span class='id identifier rubyid_times'>times</span> <span class='op'>+=</span> <span class='int'>1</span>
|
1937
|
+
<span class='id identifier rubyid_sleep'>sleep</span> <span class='id identifier rubyid_timeout'>timeout</span>
|
1938
|
+
<span class='kw'>end</span>
|
1939
|
+
<span class='kw'>true</span>
|
1940
|
+
<span class='kw'>end</span></pre>
|
1941
|
+
</td>
|
1942
|
+
</tr>
|
1943
|
+
</table>
|
1944
|
+
</div>
|
1945
|
+
|
1946
|
+
<div class="method_details ">
|
1947
|
+
<h3 class="signature " id="orgs-class_method">
|
1948
|
+
|
1949
|
+
.<strong>orgs</strong>(enterprise = 'default') ⇒ <tt>Object</tt>
|
1950
|
+
|
1951
|
+
|
1952
|
+
|
1953
|
+
|
1954
|
+
|
1955
|
+
</h3><div class="docstring">
|
1956
|
+
<div class="discussion">
|
1957
|
+
|
1958
|
+
<p>Fetch all organizations under an enterprise</p>
|
1959
|
+
|
1960
|
+
|
1961
|
+
</div>
|
1962
|
+
</div>
|
1963
|
+
<div class="tags">
|
1964
|
+
|
1965
|
+
|
1966
|
+
</div><table class="source_code">
|
1967
|
+
<tr>
|
1968
|
+
<td>
|
1969
|
+
<pre class="lines">
|
1970
|
+
|
1971
|
+
|
1972
|
+
59
|
1973
|
+
60
|
1974
|
+
61</pre>
|
1975
|
+
</td>
|
1976
|
+
<td>
|
1977
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 59</span>
|
1978
|
+
|
1979
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_orgs'>orgs</span><span class='lparen'>(</span><span class='id identifier rubyid_enterprise'>enterprise</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>default</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
1980
|
+
<span class='ivar'>@api</span><span class='period'>.</span><span class='id identifier rubyid_orgs'>orgs</span> <span class='id identifier rubyid_enterprise'>enterprise</span>
|
1981
|
+
<span class='kw'>end</span></pre>
|
1982
|
+
</td>
|
1983
|
+
</tr>
|
1984
|
+
</table>
|
1985
|
+
</div>
|
1986
|
+
|
1987
|
+
<div class="method_details ">
|
1988
|
+
<h3 class="signature " id="pipeline_topics-class_method">
|
1989
|
+
|
1990
|
+
.<strong>pipeline_topics</strong>(enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ <tt>Object</tt>
|
1991
|
+
|
1992
|
+
|
1993
|
+
|
1994
|
+
|
1995
|
+
|
1996
|
+
</h3><div class="docstring">
|
1997
|
+
<div class="discussion">
|
1998
|
+
|
1999
|
+
<p>Filters out the topics from the pipelines changes .</p>
|
2000
|
+
|
2001
|
+
<p>default.</p>
|
2002
|
+
|
2003
|
+
|
2004
|
+
</div>
|
2005
|
+
</div>
|
2006
|
+
<div class="tags">
|
2007
|
+
<p class="tag_title">Parameters:</p>
|
2008
|
+
<ul class="param">
|
2009
|
+
|
2010
|
+
<li>
|
2011
|
+
|
2012
|
+
<span class='name'>enterprise</span>
|
2013
|
+
|
2014
|
+
|
2015
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2016
|
+
|
2017
|
+
|
2018
|
+
|
2019
|
+
—
|
2020
|
+
<div class='inline'>
|
2021
|
+
<p>a customizable set of options</p>
|
2022
|
+
</div>
|
2023
|
+
|
2024
|
+
</li>
|
2025
|
+
|
2026
|
+
<li>
|
2027
|
+
|
2028
|
+
<span class='name'>organization</span>
|
2029
|
+
|
2030
|
+
|
2031
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2032
|
+
|
2033
|
+
|
2034
|
+
|
2035
|
+
—
|
2036
|
+
<div class='inline'>
|
2037
|
+
<p>a customizable set of options</p>
|
2038
|
+
</div>
|
2039
|
+
|
2040
|
+
</li>
|
2041
|
+
|
2042
|
+
<li>
|
2043
|
+
|
2044
|
+
<span class='name'>project</span>
|
2045
|
+
|
2046
|
+
|
2047
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2048
|
+
|
2049
|
+
|
2050
|
+
|
2051
|
+
—
|
2052
|
+
<div class='inline'>
|
2053
|
+
<p>a customizable set of options</p>
|
2054
|
+
</div>
|
2055
|
+
|
2056
|
+
</li>
|
2057
|
+
|
2058
|
+
<li>
|
2059
|
+
|
2060
|
+
<span class='name'>pipeline</span>
|
2061
|
+
|
2062
|
+
|
2063
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2064
|
+
|
2065
|
+
|
2066
|
+
|
2067
|
+
—
|
2068
|
+
<div class='inline'>
|
2069
|
+
<p>a customizable set of options</p>
|
2070
|
+
</div>
|
2071
|
+
|
2072
|
+
</li>
|
2073
|
+
|
2074
|
+
</ul>
|
2075
|
+
|
2076
|
+
|
2077
|
+
|
2078
|
+
|
2079
|
+
<p class="tag_title">Options Hash (<tt>enterprise:</tt>):</p>
|
2080
|
+
<ul class="option">
|
2081
|
+
|
2082
|
+
<li>
|
2083
|
+
<span class="name">the</span>
|
2084
|
+
<span class="type">(<tt>String</tt>)</span>
|
2085
|
+
<span class="default">
|
2086
|
+
|
2087
|
+
</span>
|
2088
|
+
|
2089
|
+
— <div class='inline'>
|
2090
|
+
<p>enterprise to fetch org from, defaults to</p>
|
2091
|
+
</div>
|
2092
|
+
|
2093
|
+
</li>
|
2094
|
+
|
2095
|
+
</ul>
|
2096
|
+
|
2097
|
+
|
2098
|
+
|
2099
|
+
<p class="tag_title">Options Hash (<tt>organization:</tt>):</p>
|
2100
|
+
<ul class="option">
|
2101
|
+
|
2102
|
+
<li>
|
2103
|
+
<span class="name">the</span>
|
2104
|
+
<span class="type">(<tt>String</tt>)</span>
|
2105
|
+
<span class="default">
|
2106
|
+
|
2107
|
+
</span>
|
2108
|
+
|
2109
|
+
— <div class='inline'>
|
2110
|
+
<p>organization to fetch from.</p>
|
2111
|
+
</div>
|
2112
|
+
|
2113
|
+
</li>
|
2114
|
+
|
2115
|
+
</ul>
|
2116
|
+
|
2117
|
+
|
2118
|
+
|
2119
|
+
<p class="tag_title">Options Hash (<tt>project:</tt>):</p>
|
2120
|
+
<ul class="option">
|
2121
|
+
|
2122
|
+
<li>
|
2123
|
+
<span class="name">the</span>
|
2124
|
+
<span class="type">(<tt>String</tt>)</span>
|
2125
|
+
<span class="default">
|
2126
|
+
|
2127
|
+
</span>
|
2128
|
+
|
2129
|
+
— <div class='inline'>
|
2130
|
+
<p>project to fetch from.</p>
|
2131
|
+
</div>
|
2132
|
+
|
2133
|
+
</li>
|
2134
|
+
|
2135
|
+
</ul>
|
2136
|
+
|
2137
|
+
|
2138
|
+
|
2139
|
+
<p class="tag_title">Options Hash (<tt>pipeline:</tt>):</p>
|
2140
|
+
<ul class="option">
|
2141
|
+
|
2142
|
+
<li>
|
2143
|
+
<span class="name">the</span>
|
2144
|
+
<span class="type">(<tt>String</tt>)</span>
|
2145
|
+
<span class="default">
|
2146
|
+
|
2147
|
+
</span>
|
2148
|
+
|
2149
|
+
— <div class='inline'>
|
2150
|
+
<p>pipeline to fetch from.</p>
|
2151
|
+
</div>
|
2152
|
+
|
2153
|
+
</li>
|
2154
|
+
|
2155
|
+
</ul>
|
2156
|
+
|
2157
|
+
|
2158
|
+
|
2159
|
+
</div><table class="source_code">
|
2160
|
+
<tr>
|
2161
|
+
<td>
|
2162
|
+
<pre class="lines">
|
2163
|
+
|
2164
|
+
|
2165
|
+
97
|
2166
|
+
98
|
2167
|
+
99
|
2168
|
+
100
|
2169
|
+
101
|
2170
|
+
102
|
2171
|
+
103
|
2172
|
+
104</pre>
|
2173
|
+
</td>
|
2174
|
+
<td>
|
2175
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 97</span>
|
2176
|
+
|
2177
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_pipeline_topics'>pipeline_topics</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>default</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pipeline:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2178
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_pipeline'>pipeline</span><span class='lparen'>(</span>
|
2179
|
+
<span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span>
|
2180
|
+
<span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span>
|
2181
|
+
<span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='comma'>,</span>
|
2182
|
+
<span class='label'>pipeline:</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
|
2183
|
+
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_topic'>topic</span> <span class='rbrace'>}</span>
|
2184
|
+
<span class='kw'>end</span></pre>
|
2185
|
+
</td>
|
2186
|
+
</tr>
|
2187
|
+
</table>
|
2188
|
+
</div>
|
2189
|
+
|
2190
|
+
<div class="method_details ">
|
2191
|
+
<h3 class="signature " id="pipelines-class_method">
|
2192
|
+
|
2193
|
+
.<strong>pipelines</strong>(enterprise: 'default', organization: nil, project: nil) ⇒ <tt>Object</tt>
|
2194
|
+
|
2195
|
+
|
2196
|
+
|
2197
|
+
|
2198
|
+
|
2199
|
+
</h3><div class="docstring">
|
2200
|
+
<div class="discussion">
|
2201
|
+
|
2202
|
+
<p>Fetch all pipelines of a project under an enterprise, organization pair</p>
|
2203
|
+
|
2204
|
+
|
2205
|
+
</div>
|
2206
|
+
</div>
|
2207
|
+
<div class="tags">
|
2208
|
+
|
2209
|
+
|
2210
|
+
</div><table class="source_code">
|
2211
|
+
<tr>
|
2212
|
+
<td>
|
2213
|
+
<pre class="lines">
|
2214
|
+
|
2215
|
+
|
2216
|
+
73
|
2217
|
+
74
|
2218
|
+
75</pre>
|
2219
|
+
</td>
|
2220
|
+
<td>
|
2221
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 73</span>
|
2222
|
+
|
2223
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_pipelines'>pipelines</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>default</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2224
|
+
<span class='ivar'>@api</span><span class='period'>.</span><span class='id identifier rubyid_pipelines'>pipelines</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='comma'>,</span> <span class='label'>project:</span> <span class='id identifier rubyid_project'>project</span><span class='rparen'>)</span>
|
2225
|
+
<span class='kw'>end</span></pre>
|
2226
|
+
</td>
|
2227
|
+
</tr>
|
2228
|
+
</table>
|
2229
|
+
</div>
|
2230
|
+
|
2231
|
+
<div class="method_details ">
|
2232
|
+
<h3 class="signature " id="projects-class_method">
|
2233
|
+
|
2234
|
+
.<strong>projects</strong>(enterprise: 'default', organization: nil) ⇒ <tt>Object</tt>
|
2235
|
+
|
2236
|
+
|
2237
|
+
|
2238
|
+
|
2239
|
+
|
2240
|
+
</h3><div class="docstring">
|
2241
|
+
<div class="discussion">
|
2242
|
+
|
2243
|
+
<p>Fetch all projects under an enterprise, organization pair</p>
|
2244
|
+
|
2245
|
+
|
2246
|
+
</div>
|
2247
|
+
</div>
|
2248
|
+
<div class="tags">
|
2249
|
+
|
2250
|
+
|
2251
|
+
</div><table class="source_code">
|
2252
|
+
<tr>
|
2253
|
+
<td>
|
2254
|
+
<pre class="lines">
|
2255
|
+
|
2256
|
+
|
2257
|
+
66
|
2258
|
+
67
|
2259
|
+
68</pre>
|
2260
|
+
</td>
|
2261
|
+
<td>
|
2262
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 66</span>
|
2263
|
+
|
2264
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_projects'>projects</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>default</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2265
|
+
<span class='ivar'>@api</span><span class='period'>.</span><span class='id identifier rubyid_projects'>projects</span><span class='lparen'>(</span><span class='label'>enterprise:</span> <span class='id identifier rubyid_enterprise'>enterprise</span><span class='comma'>,</span> <span class='label'>organization:</span> <span class='id identifier rubyid_organization'>organization</span><span class='rparen'>)</span>
|
2266
|
+
<span class='kw'>end</span></pre>
|
2267
|
+
</td>
|
2268
|
+
</tr>
|
2269
|
+
</table>
|
2270
|
+
</div>
|
2271
|
+
|
2272
|
+
<div class="method_details ">
|
2273
|
+
<h3 class="signature " id="setup-class_method">
|
2274
|
+
|
2275
|
+
.<strong>setup</strong>(url: nil, username: nil, token: nil, password: nil, enterprise: 'default', organization: nil, project: nil, pipeline: nil) ⇒ <tt>Object</tt>
|
2276
|
+
|
2277
|
+
|
2278
|
+
|
2279
|
+
|
2280
|
+
|
2281
|
+
</h3><div class="docstring">
|
2282
|
+
<div class="discussion">
|
2283
|
+
|
2284
|
+
<p>Setup Automate Soup client.</p>
|
2285
|
+
|
2286
|
+
|
2287
|
+
</div>
|
2288
|
+
</div>
|
2289
|
+
<div class="tags">
|
2290
|
+
<p class="tag_title">Parameters:</p>
|
2291
|
+
<ul class="param">
|
2292
|
+
|
2293
|
+
<li>
|
2294
|
+
|
2295
|
+
<span class='name'>url</span>
|
2296
|
+
|
2297
|
+
|
2298
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2299
|
+
|
2300
|
+
|
2301
|
+
|
2302
|
+
—
|
2303
|
+
<div class='inline'>
|
2304
|
+
<p>a customizable set of options</p>
|
2305
|
+
</div>
|
2306
|
+
|
2307
|
+
</li>
|
2308
|
+
|
2309
|
+
<li>
|
2310
|
+
|
2311
|
+
<span class='name'>username</span>
|
2312
|
+
|
2313
|
+
|
2314
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2315
|
+
|
2316
|
+
|
2317
|
+
|
2318
|
+
—
|
2319
|
+
<div class='inline'>
|
2320
|
+
<p>a customizable set of options</p>
|
2321
|
+
</div>
|
2322
|
+
|
2323
|
+
</li>
|
2324
|
+
|
2325
|
+
<li>
|
2326
|
+
|
2327
|
+
<span class='name'>token</span>
|
2328
|
+
|
2329
|
+
|
2330
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2331
|
+
|
2332
|
+
|
2333
|
+
|
2334
|
+
—
|
2335
|
+
<div class='inline'>
|
2336
|
+
<p>a customizable set of options</p>
|
2337
|
+
</div>
|
2338
|
+
|
2339
|
+
</li>
|
2340
|
+
|
2341
|
+
<li>
|
2342
|
+
|
2343
|
+
<span class='name'>password</span>
|
2344
|
+
|
2345
|
+
|
2346
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
2347
|
+
|
2348
|
+
|
2349
|
+
|
2350
|
+
—
|
2351
|
+
<div class='inline'>
|
2352
|
+
<p>a customizable set of options</p>
|
2353
|
+
</div>
|
2354
|
+
|
2355
|
+
</li>
|
2356
|
+
|
2357
|
+
</ul>
|
2358
|
+
|
2359
|
+
|
2360
|
+
|
2361
|
+
|
2362
|
+
<p class="tag_title">Options Hash (<tt>url:</tt>):</p>
|
2363
|
+
<ul class="option">
|
2364
|
+
|
2365
|
+
<li>
|
2366
|
+
<span class="name">The</span>
|
2367
|
+
<span class="type">(<tt>String</tt>)</span>
|
2368
|
+
<span class="default">
|
2369
|
+
|
2370
|
+
</span>
|
2371
|
+
|
2372
|
+
— <div class='inline'>
|
2373
|
+
<p>Chef Automate URL.</p>
|
2374
|
+
</div>
|
2375
|
+
|
2376
|
+
</li>
|
2377
|
+
|
2378
|
+
</ul>
|
2379
|
+
|
2380
|
+
|
2381
|
+
|
2382
|
+
<p class="tag_title">Options Hash (<tt>username:</tt>):</p>
|
2383
|
+
<ul class="option">
|
2384
|
+
|
2385
|
+
<li>
|
2386
|
+
<span class="name">The</span>
|
2387
|
+
<span class="type">(<tt>String</tt>)</span>
|
2388
|
+
<span class="default">
|
2389
|
+
|
2390
|
+
</span>
|
2391
|
+
|
2392
|
+
— <div class='inline'>
|
2393
|
+
<p>Chef Automate username.</p>
|
2394
|
+
</div>
|
2395
|
+
|
2396
|
+
</li>
|
2397
|
+
|
2398
|
+
</ul>
|
2399
|
+
|
2400
|
+
|
2401
|
+
|
2402
|
+
<p class="tag_title">Options Hash (<tt>token:</tt>):</p>
|
2403
|
+
<ul class="option">
|
2404
|
+
|
2405
|
+
<li>
|
2406
|
+
<span class="name">The</span>
|
2407
|
+
<span class="type">(<tt>String</tt>)</span>
|
2408
|
+
<span class="default">
|
2409
|
+
|
2410
|
+
</span>
|
2411
|
+
|
2412
|
+
— <div class='inline'>
|
2413
|
+
<p>Chef Automate user token.</p>
|
2414
|
+
</div>
|
2415
|
+
|
2416
|
+
</li>
|
2417
|
+
|
2418
|
+
</ul>
|
2419
|
+
|
2420
|
+
|
2421
|
+
|
2422
|
+
<p class="tag_title">Options Hash (<tt>password:</tt>):</p>
|
2423
|
+
<ul class="option">
|
2424
|
+
|
2425
|
+
<li>
|
2426
|
+
<span class="name">The</span>
|
2427
|
+
<span class="type">(<tt>String</tt>)</span>
|
2428
|
+
<span class="default">
|
2429
|
+
|
2430
|
+
</span>
|
2431
|
+
|
2432
|
+
— <div class='inline'>
|
2433
|
+
<p>Chef Automate user password.</p>
|
2434
|
+
</div>
|
2435
|
+
|
2436
|
+
</li>
|
2437
|
+
|
2438
|
+
</ul>
|
2439
|
+
|
2440
|
+
|
2441
|
+
|
2442
|
+
|
2443
|
+
|
2444
|
+
|
2445
|
+
|
2446
|
+
|
2447
|
+
|
2448
|
+
|
2449
|
+
|
2450
|
+
</div><table class="source_code">
|
2451
|
+
<tr>
|
2452
|
+
<td>
|
2453
|
+
<pre class="lines">
|
2454
|
+
|
2455
|
+
|
2456
|
+
24
|
2457
|
+
25
|
2458
|
+
26
|
2459
|
+
27
|
2460
|
+
28
|
2461
|
+
29
|
2462
|
+
30
|
2463
|
+
31
|
2464
|
+
32
|
2465
|
+
33
|
2466
|
+
34
|
2467
|
+
35
|
2468
|
+
36
|
2469
|
+
37
|
2470
|
+
38
|
2471
|
+
39
|
2472
|
+
40
|
2473
|
+
41
|
2474
|
+
42
|
2475
|
+
43
|
2476
|
+
44
|
2477
|
+
45
|
2478
|
+
46</pre>
|
2479
|
+
</td>
|
2480
|
+
<td>
|
2481
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 24</span>
|
2482
|
+
|
2483
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_setup'>setup</span><span class='lparen'>(</span>
|
2484
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2485
|
+
<span class='label'>username:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2486
|
+
<span class='label'>token:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2487
|
+
<span class='label'>password:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2488
|
+
<span class='label'>enterprise:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>default</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
2489
|
+
<span class='label'>organization:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2490
|
+
<span class='label'>project:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2491
|
+
<span class='label'>pipeline:</span> <span class='kw'>nil</span>
|
2492
|
+
<span class='rparen'>)</span>
|
2493
|
+
<span class='ivar'>@url</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
|
2494
|
+
<span class='ivar'>@credentials</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_token'>token</span>
|
2495
|
+
<span class='id identifier rubyid_token_credentials'>token_credentials</span><span class='lparen'>(</span><span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
|
2496
|
+
<span class='kw'>else</span>
|
2497
|
+
<span class='id identifier rubyid_password_credentials'>password_credentials</span><span class='lparen'>(</span><span class='id identifier rubyid_username'>username</span><span class='comma'>,</span> <span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
|
2498
|
+
<span class='kw'>end</span>
|
2499
|
+
<span class='ivar'>@api</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="AutomateSoup/API.html" title="AutomateSoup::API (class)">API</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="AutomateSoup/API.html#initialize-instance_method" title="AutomateSoup::API#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
|
2500
|
+
<span class='ivar'>@enterprise</span> <span class='op'>=</span> <span class='id identifier rubyid_enterprise'>enterprise</span>
|
2501
|
+
<span class='ivar'>@organization</span> <span class='op'>=</span> <span class='id identifier rubyid_organization'>organization</span>
|
2502
|
+
<span class='ivar'>@project</span> <span class='op'>=</span> <span class='id identifier rubyid_project'>project</span>
|
2503
|
+
<span class='ivar'>@pipeline</span> <span class='op'>=</span> <span class='id identifier rubyid_pipeline'>pipeline</span>
|
2504
|
+
<span class='kw'>self</span>
|
2505
|
+
<span class='kw'>end</span></pre>
|
2506
|
+
</td>
|
2507
|
+
</tr>
|
2508
|
+
</table>
|
2509
|
+
</div>
|
2510
|
+
|
2511
|
+
<div class="method_details ">
|
2512
|
+
<h3 class="signature " id="status-class_method">
|
2513
|
+
|
2514
|
+
.<strong>status</strong> ⇒ <tt>Object</tt>
|
2515
|
+
|
2516
|
+
|
2517
|
+
|
2518
|
+
|
2519
|
+
|
2520
|
+
</h3><div class="docstring">
|
2521
|
+
<div class="discussion">
|
2522
|
+
|
2523
|
+
<p>Check the status of Automate</p>
|
2524
|
+
|
2525
|
+
|
2526
|
+
</div>
|
2527
|
+
</div>
|
2528
|
+
<div class="tags">
|
2529
|
+
|
2530
|
+
|
2531
|
+
</div><table class="source_code">
|
2532
|
+
<tr>
|
2533
|
+
<td>
|
2534
|
+
<pre class="lines">
|
2535
|
+
|
2536
|
+
|
2537
|
+
51
|
2538
|
+
52
|
2539
|
+
53
|
2540
|
+
54</pre>
|
2541
|
+
</td>
|
2542
|
+
<td>
|
2543
|
+
<pre class="code"><span class="info file"># File 'lib/automate_soup.rb', line 51</span>
|
2544
|
+
|
2545
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
|
2546
|
+
<span class='id identifier rubyid_o'>o</span> <span class='op'>=</span> <span class='ivar'>@api</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span>
|
2547
|
+
<span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_o'>o</span>
|
2548
|
+
<span class='kw'>end</span></pre>
|
2549
|
+
</td>
|
2550
|
+
</tr>
|
2551
|
+
</table>
|
2552
|
+
</div>
|
2553
|
+
|
2554
|
+
</div>
|
2555
|
+
|
2556
|
+
</div>
|
2557
|
+
|
2558
|
+
<div id="footer">
|
2559
|
+
Generated on Mon Dec 18 14:46:35 2017 by
|
2560
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2561
|
+
0.9.9 (ruby-2.4.1).
|
2562
|
+
</div>
|
2563
|
+
|
2564
|
+
</div>
|
2565
|
+
</body>
|
2566
|
+
</html>
|