apache_felix_webconsole_client 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f922e78dfd48f1328343ee2975a6c2e7f55a2348
4
+ data.tar.gz: ebacd6f4d205b5ab7a6ee1958b08ffbb16b1fcd3
5
+ SHA512:
6
+ metadata.gz: e74929ed7c83d290385b1126e5859851780c0b66ece17d253cf536ca948c0e558889f13fcfd09235a59aa48958afe4274bb3b2cb3d73b915911abb9b025bb79f
7
+ data.tar.gz: cfdd370e3320d90ffa2573ef14fc7ea84940b1cfec16e7a1e487611817a6760f63e2c20e633b6bdfd298563a6c1d8d3cc2329126da36d5c68f90e692a1965a74
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ end
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,102 @@
1
+ # apache_felix_webconsole_client
2
+
3
+ ApacheFelix - the Ruby gem for the Apache Felix WebConsole
4
+
5
+ Client for Apache Felix Web Console API. List bundles, configure services, etc.
6
+
7
+ This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
+
9
+ - API version: 4.3.0
10
+ - Package version: 0.0.1
11
+ - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build apache_felix_webconsole_client.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./apache_felix_webconsole_client-0.0.1.gem
27
+ ```
28
+ (for development, run `gem install --dev ./apache_felix_webconsole_client-0.0.1.gem` to install the development dependencies)
29
+
30
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
+
32
+ Finally add this to the Gemfile:
33
+
34
+ gem 'apache_felix_webconsole_client', '~> 0.0.1'
35
+
36
+ ### Install from Git
37
+
38
+ If the Ruby gem is hosted at a git repository: https://github.com/bstopp/apache-felix-webconsole-client-gem, then add the following in the Gemfile:
39
+
40
+ gem 'apache_felix_webconsole_client', :git => 'https://github.com/bstopp/apache-felix-webconsole-client-gem.git'
41
+
42
+ ### Include the Ruby code directly
43
+
44
+ Include the Ruby code directly using `-I` as follows:
45
+
46
+ ```shell
47
+ ruby -Ilib script.rb
48
+ ```
49
+
50
+ ## Getting Started
51
+
52
+ Please follow the [installation](#installation) procedure and then run the following code:
53
+ ```ruby
54
+ # Load the gem
55
+ require 'apache_felix_webconsole_client'
56
+
57
+ # Setup authorization
58
+ ApacheFelix.configure do |config|
59
+ # Configure HTTP basic authorization: basic
60
+ config.username = 'YOUR USERNAME'
61
+ config.password = 'YOUR PASSWORD'
62
+ end
63
+
64
+ api_instance = ApacheFelix::DefaultApi.new
65
+
66
+ bundle_id = "bundle_id_example" # String | The symbolic name or id of the bundle.
67
+
68
+
69
+ begin
70
+ #Bundle Info
71
+ result = api_instance.bundle_info(bundle_id)
72
+ p result
73
+ rescue ApacheFelix::ApiError => e
74
+ puts "Exception when calling DefaultApi->bundle_info: #{e}"
75
+ end
76
+
77
+ ```
78
+
79
+ ## Documentation for API Endpoints
80
+
81
+ All URIs are relative to *http://localhost:8080/system/console*
82
+
83
+ Class | Method | HTTP request | Description
84
+ ------------ | ------------- | ------------- | -------------
85
+ *ApacheFelix::DefaultApi* | [**bundle_info**](docs/DefaultApi.md#bundle_info) | **GET** /bundles/{bundleId}.json | Bundle Info
86
+ *ApacheFelix::DefaultApi* | [**bundles**](docs/DefaultApi.md#bundles) | **GET** /bundles.json | List bundles
87
+
88
+
89
+ ## Documentation for Models
90
+
91
+ - [ApacheFelix::Bundle](docs/Bundle.md)
92
+ - [ApacheFelix::BundleList](docs/BundleList.md)
93
+ - [ApacheFelix::BundleProps](docs/BundleProps.md)
94
+
95
+
96
+ ## Documentation for Authorization
97
+
98
+
99
+ ### basic
100
+
101
+ - **Type**: HTTP basic authentication
102
+
data/Rakefile ADDED
@@ -0,0 +1,8 @@
1
+ begin
2
+ require 'rspec/core/rake_task'
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+ task default: :spec
6
+ rescue LoadError
7
+ # no rspec available
8
+ end
@@ -0,0 +1,60 @@
1
+ # -*- encoding: utf-8 -*-
2
+ #
3
+ =begin
4
+ Apache Felix WebConsole
5
+
6
+ Client for Apache Felix Web Console API. List bundles, configure services, etc.
7
+
8
+ OpenAPI spec version: 4.3.0
9
+ Contact: bryan.stopp@gmail.com
10
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
11
+
12
+ Licensed under the Apache License, Version 2.0 (the "License");
13
+ you may not use this file except in compliance with the License.
14
+ You may obtain a copy of the License at
15
+
16
+ http://www.apache.org/licenses/LICENSE-2.0
17
+
18
+ Unless required by applicable law or agreed to in writing, software
19
+ distributed under the License is distributed on an "AS IS" BASIS,
20
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21
+ See the License for the specific language governing permissions and
22
+ limitations under the License.
23
+
24
+ =end
25
+
26
+ $:.push File.expand_path("../lib", __FILE__)
27
+ require "apache_felix_webconsole_client/version"
28
+
29
+ Gem::Specification.new do |s|
30
+ s.name = "apache_felix_webconsole_client"
31
+ s.version = ApacheFelix::VERSION
32
+ s.platform = Gem::Platform::RUBY
33
+ s.authors = ["Bryan Stopp"]
34
+ s.email = ["bryan.stopp@gmail.com"]
35
+ s.homepage = "https://github.com/bstopp/apache-felix-webconsole-client-gem"
36
+ s.summary = "Apache Felix WebConsole Client"
37
+ s.description = "Client for Apache Felix Web Console API. List bundles, configure services, etc."
38
+ s.license = "Apache-2.0"
39
+ s.required_ruby_version = ">= 1.9"
40
+
41
+ s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
42
+ s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.0'
43
+
44
+ s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
45
+ s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
46
+ s.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
47
+ s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
48
+ s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
49
+ s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
50
+ s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
51
+
52
+ s.add_development_dependency 'rubocop', '~>0'
53
+ s.add_development_dependency 'simplecov', '~>0'
54
+ s.add_development_dependency 'codeclimate-test-reporter', '~>0'
55
+
56
+ s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? && !f.end_with?('.gem') }
57
+ s.test_files = `find spec/*`.split("\n")
58
+ s.executables = []
59
+ s.require_paths = ["lib"]
60
+ end
data/docs/Bundle.md ADDED
@@ -0,0 +1,16 @@
1
+ # ApacheFelix::Bundle
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **Integer** | | [optional]
7
+ **name** | **String** | | [optional]
8
+ **fragment** | **BOOLEAN** | | [optional]
9
+ **state_raw** | **Integer** | | [optional]
10
+ **state** | **String** | | [optional]
11
+ **version** | **String** | | [optional]
12
+ **symbolic_name** | **String** | | [optional]
13
+ **category** | **String** | | [optional]
14
+ **props** | [**Array<BundleProps>**](BundleProps.md) | | [optional]
15
+
16
+
@@ -0,0 +1,10 @@
1
+ # ApacheFelix::BundleList
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **status** | **String** | | [optional]
7
+ **s** | **Array<String>** | | [optional]
8
+ **data** | [**Array<Bundle>**](Bundle.md) | | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # ApacheFelix::BundleProps
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **key** | **String** | | [optional]
7
+ **value** | **Array<String>** | | [optional]
8
+
9
+
@@ -0,0 +1,110 @@
1
+ # ApacheFelix::DefaultApi
2
+
3
+ All URIs are relative to *http://localhost:8080/system/console*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**bundle_info**](DefaultApi.md#bundle_info) | **GET** /bundles/{bundleId}.json | Bundle Info
8
+ [**bundles**](DefaultApi.md#bundles) | **GET** /bundles.json | List bundles
9
+
10
+
11
+ # **bundle_info**
12
+ > BundleList bundle_info(bundle_id)
13
+
14
+ Bundle Info
15
+
16
+ Display all information about a bundle. Same response structure as bundle listing; only one entry exists in the list.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'apache_felix_webconsole_client'
22
+ # setup authorization
23
+ ApacheFelix.configure do |config|
24
+ # Configure HTTP basic authorization: basic
25
+ config.username = 'YOUR USERNAME'
26
+ config.password = 'YOUR PASSWORD'
27
+ end
28
+
29
+ api_instance = ApacheFelix::DefaultApi.new
30
+
31
+ bundle_id = "bundle_id_example" # String | The symbolic name or id of the bundle.
32
+
33
+
34
+ begin
35
+ #Bundle Info
36
+ result = api_instance.bundle_info(bundle_id)
37
+ p result
38
+ rescue ApacheFelix::ApiError => e
39
+ puts "Exception when calling DefaultApi->bundle_info: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+
45
+ Name | Type | Description | Notes
46
+ ------------- | ------------- | ------------- | -------------
47
+ **bundle_id** | **String**| The symbolic name or id of the bundle. |
48
+
49
+ ### Return type
50
+
51
+ [**BundleList**](BundleList.md)
52
+
53
+ ### Authorization
54
+
55
+ [basic](../README.md#basic)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
61
+
62
+
63
+
64
+ # **bundles**
65
+ > BundleList bundles
66
+
67
+ List bundles
68
+
69
+ List all the bundles in the Felix system. Properties for a bundle will not be populated.
70
+
71
+ ### Example
72
+ ```ruby
73
+ # load the gem
74
+ require 'apache_felix_webconsole_client'
75
+ # setup authorization
76
+ ApacheFelix.configure do |config|
77
+ # Configure HTTP basic authorization: basic
78
+ config.username = 'YOUR USERNAME'
79
+ config.password = 'YOUR PASSWORD'
80
+ end
81
+
82
+ api_instance = ApacheFelix::DefaultApi.new
83
+
84
+ begin
85
+ #List bundles
86
+ result = api_instance.bundles
87
+ p result
88
+ rescue ApacheFelix::ApiError => e
89
+ puts "Exception when calling DefaultApi->bundles: #{e}"
90
+ end
91
+ ```
92
+
93
+ ### Parameters
94
+ This endpoint does not need any parameter.
95
+
96
+ ### Return type
97
+
98
+ [**BundleList**](BundleList.md)
99
+
100
+ ### Authorization
101
+
102
+ [basic](../README.md#basic)
103
+
104
+ ### HTTP request headers
105
+
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: application/json
108
+
109
+
110
+