tng-gtk-utils 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e3fd1b1e17d4ed800b02914df72e2a001bb68131571e693957ebea2970f48ac3
4
+ data.tar.gz: 5759d3e439d81b341db6b5fe549b997a40279e75b31455970b8acc7a00e0301b
5
+ SHA512:
6
+ metadata.gz: 519089a97c506902f17b681f8c177b526575a2a1143bb3a6aa87e66c042e7571a77942f1d9f1a4a7cf6e4ee5236301e9a53a7db0022a14b9bbfb2d2cfbfacfb1
7
+ data.tar.gz: 8591a9e3fbbe454849fe8ade24f2914aac5d6395c40e8e912d96b672e39e2526706ab8d00e25822d05c3ec1dde1d57268e1c1b8a0fa67a338a73b2e8b2d9c08c
data/.gitignore ADDED
@@ -0,0 +1,50 @@
1
+ *.gem
2
+ *.rbc
3
+ /.config
4
+ /coverage/
5
+ /InstalledFiles
6
+ /pkg/
7
+ /spec/reports/
8
+ /spec/examples.txt
9
+ /test/tmp/
10
+ /test/version_tmp/
11
+ /tmp/
12
+
13
+ # Used by dotenv library to load environment variables.
14
+ # .env
15
+
16
+ ## Specific to RubyMotion:
17
+ .dat*
18
+ .repl_history
19
+ build/
20
+ *.bridgesupport
21
+ build-iPhoneOS/
22
+ build-iPhoneSimulator/
23
+
24
+ ## Specific to RubyMotion (use of CocoaPods):
25
+ #
26
+ # We recommend against adding the Pods directory to your .gitignore. However
27
+ # you should judge for yourself, the pros and cons are mentioned at:
28
+ # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
29
+ #
30
+ # vendor/Pods/
31
+
32
+ ## Documentation cache and generated files:
33
+ /.yardoc/
34
+ /_yardoc/
35
+ /doc/
36
+ /rdoc/
37
+
38
+ ## Environment normalization:
39
+ /.bundle/
40
+ /vendor/bundle
41
+ /lib/bundler/man/
42
+
43
+ # for a library or gem, you might want to ignore these files since the code is
44
+ # intended to run in multiple environments; otherwise, check them in:
45
+ Gemfile.lock
46
+ .ruby-version
47
+ .ruby-gemset
48
+
49
+ # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
50
+ .rvmrc
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.4.3
5
+ before_install: gem install bundler -v 1.16.2
@@ -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 jose.bonnet@icloud.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
@@ -0,0 +1,6 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ # Specify your gem's dependencies in tng-gtk-utils.gemspec
6
+ gemspec
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/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 José Bonnet
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,146 @@
1
+ [![Join the chat at https://gitter.im/sonata-nfv/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sonata-nfv/Lobby)
2
+
3
+ <p align="center"><img src="https://github.com/sonata-nfv/tng-api-gtw/wiki/images/sonata-5gtango-logo-500px.png" /></p>
4
+
5
+ # 5GTANGO Gatekeeper utils
6
+ This is the 5GTANGO Gatekeeper utils gem, which implements some utilitary features shared across the different Gatekeeper repositories: [`tng-gtk-common`](https://github.com/sonata-nfv/tng-gtk-common), [`tng-gtk-sp`](https://github.com/sonata-nfv/tng-gtk-sp) and [`tng-gtk-vnv`](https://github.com/sonata-nfv/tng-gtk-vnv).
7
+
8
+ The code for this utility library was extracted from those repositories and made available to them so that code shouldn't hang around duplicated.
9
+
10
+ For details on the overall 5GTANGO architecture please check [here](https://5gtango.eu/project-outcomes/deliverables/2-uncategorised/31-d2-2-architecture-design.html) and also in the [previously](https://github.com/sonata-nfv/tng-gtk-common) [mentioned](https://github.com/sonata-nfv/tng-gtk-sp) [repositories](https://github.com/sonata-nfv/tng-gtk-vnv).
11
+
12
+ ## Features
13
+ This library implements some of the features that were being duplicated in the 5GTANGO Gatekeeper repositories mentioned above, [`tng-gtk-common`](https://github.com/sonata-nfv/tng-gtk-common), [`tng-gtk-sp`](https://github.com/sonata-nfv/tng-gtk-sp) and [`tng-gtk-vnv`](https://github.com/sonata-nfv/tng-gtk-vnv).
14
+
15
+ ### Logger
16
+ Ruby's standard library already provides a [Logger](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html), which we want to extend and make it providing outputs such as the following (in JSON format):
17
+
18
+ ```json
19
+ {
20
+ "type": "I",
21
+ "timestamp": "2018-10-18 15:49:08 UTC",
22
+ "status": "END",
23
+ "component": "tng-api-gtw",
24
+ "operation": "package upload",
25
+ "result": "package uploaded 201",
26
+ "status_code": "201",
27
+ "time_elapsed": "00:01:20"
28
+ }
29
+ ```
30
+ The usual approach of redefining the formatter (see below) doesn't have the full flexibility.
31
+
32
+ ```ruby
33
+ Logger.new(logdev, formatter: proc {|severity, datetime, progname, msg|
34
+ JSON.dump(timestamp: "#{datetime.to_s}", message: msg)
35
+ })
36
+ ```
37
+
38
+ It should also support a `LOGLEVEL` variable that may assume one of the usual values `debug`, `info`, `warning`, `error`, `fatal` or `unknown` (defaults to `warning`, so only logging messages marked as `unknown`, `fatal`, `error` or `warning` are shown).
39
+
40
+ ### Cache
41
+ The first ...
42
+ uses Logger
43
+
44
+ ### Fetch
45
+ remote
46
+ uses Cache and Logger
47
+
48
+ ## Installing
49
+
50
+ This gem is implemented in [ruby](https://www.ruby-lang.org/en/), version **2.4.3**.
51
+
52
+ ### Installing globally
53
+
54
+ To install this gem in your system, please do:
55
+
56
+ ```shell
57
+ git clone https://github.com/sonata-nfv/tng-gtk-utils.git # Clone this repository
58
+ cd tng-gtk-utils && gem build tng-gtk-utils.gemspec # Build the gem
59
+ [sudo] gem install tng-gtk-utils-0.0.1.gem # Install it (the filename/version may vary)
60
+ ```
61
+ ### Installing it via a Gemfile
62
+
63
+ To install this gem using a Gemfile, please add the following line to that file:
64
+
65
+ ```ruby
66
+ gem 'tng-gtk-utils', git: 'https://github.com/sonata-nfv/tng-gtk-utils'
67
+ ```
68
+
69
+ ## Developing
70
+ This section covers all the needs a developer has in order to be able to contribute to this project.
71
+
72
+ ### Dependencies
73
+ We are using the following libraries (also referenced in the [`Gemfile`](https://github.com/sonata-nfv/tng-gtk-sp/Gemfile) file) for development:
74
+
75
+ * `activerecord` (`5.2`), the *Object-Relational Mapper (ORM)*;
76
+ * `bunny` (`2.8.0`), the adapter to the [RabbitMQ](https://www.rabbitmq.com/) message queue server;
77
+ * `pg` (`0.21.0`), the adapter to the [PostgreSQL](https://www.postgresql.org/) database;
78
+ * `puma` (`3.11.0`), an application server;
79
+ * `rack` (`2.0.4`), a web-server interfacing library, on top of which `sinatra` has been built;
80
+ * `rake`(`12.3.0`), a dependencies management tool for ruby, similar to *make*;
81
+ * `sinatra` (`2.0.2`), a web framework for implementing efficient ruby APIs;
82
+ * `sinatra-activerecord` (`2.0.13`),
83
+ * `sinatra-contrib` (`2.0.2`), several add-ons to `sinatra`;
84
+ * `sinatra-cross_origin` (`0.4.0`), a *middleware* to `sinatra` that helps in managing the [`Cross Origin Resource Sharing (CORS)`](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) problem;
85
+ * `sinatra-logger` (`0.3.2`), a *logger* *middleware*;
86
+
87
+ The following *gems* (libraries) are used just for tests:
88
+ * `ci_reporter_rspec` (`1.0.0`), a library for helping in generating continuous integration (CI) test reports;
89
+ * `rack-test` (`0.8.2`), a helper testing framework for `rack`-based applications;
90
+ * `rspec` (`3.7.0`), a testing framework for ruby;
91
+ * `rubocop` (`0.52.0`), a library for white box tests;
92
+ * `rubocop-checkstyle_formatter` (`0.4.0`), a helper library for `rubocop`;
93
+ * `webmock` (`3.1.1`), which alows *mocking* (i.e., faking) HTTP calls;
94
+
95
+ These libraries are installed/updated in the developer's machine when running the command (see above):
96
+
97
+ ```shell
98
+ $ bundle install
99
+ ```
100
+
101
+ ### Prerequisites
102
+ We usually use [`rbenv`](https://github.com/rbenv/rbenv) as the ruby version manager, but others like [`rvm`](https://rvm.io/) may work as well.
103
+
104
+ ### Setting up Dev
105
+ Developing this library is straightforward with a low amount of necessary steps.
106
+
107
+
108
+
109
+ ### Submiting changes
110
+ Changes to the repository can be requested using [this repository's issues](https://github.com/sonata-nfv/tng-gtk-utils/issues) and [pull requests](https://github.com/sonata-nfv/tng-gtk-utils/pulls) mechanisms.
111
+
112
+ ## Versioning
113
+
114
+ The most up-to-date version is v4. For the versions available, see the [link to tags on this repository](https://github.com/sonata-nfv/tng-gtk-sp/releases).
115
+
116
+ ## Configuration
117
+ The configuration of the micro-service is done through the following environment variables, defined in the [Dockerfile](https://github.com/sonata-nfv/tng-gtk-sp/blob/master/Dockerfile):
118
+
119
+ * `CATALOGUE_URL`, which defines the Catalogue's URL, where test descriptors are fetched from;
120
+ * `REPOSITORY_URL`, which defines the Repository's URL, where test plans and test results are fetched from;
121
+ * `DATABASE_URL`, which defines the database's URL, in the following format: `postgresql://user:password@host:port/database_name` (**Note:** this is an alternative format to the one described in the [Installing from the Docker container](#installing-from-the-Docker-container) section);
122
+ * `MQSERVER_URL`, which defines the message queue server's URL, in the following format: `amqp://user:password@host:port`
123
+
124
+ ## Tests
125
+ Unit tests are defined for both `controllers` and `services`, in the `/spec` folder. Since we use `rspec` as the test library, we configure tests in the [`spec_helper.rb`](https://github.com/sonata-nfv/tng-gtk-sp/blob/master/spec/spec_helper.rb) file, also in the `/spec` folder.
126
+
127
+ These tests are executed by running the following command:
128
+ ```shel
129
+ $ bundle exec rspec spec
130
+ ```
131
+
132
+ Wider scope (integration and functional) tests involving this micro-service are defined in [`tng-tests`](https://github.com/sonata-nfv/tng-tests).
133
+
134
+ ## Style guide
135
+ Our style guide is really simple:
136
+
137
+ 1. We try to follow a [Clean Code](https://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882) philosophy in as much as possible, i.e., classes and methods should do one thing only, have the least number of parameters possible, etc.;
138
+ 1. we use two spaces for identation.
139
+
140
+ ## API Reference
141
+
142
+ We have specified this micro-service's API in a [swagger](https://github.com/sonata-nfv/tng-gtk-sp/blob/master/doc/swagger.json)-formated file. Please check it there.
143
+
144
+ ## Licensing
145
+
146
+ This 5GTANGO component is published under Apache 2.0 license. Please see the [LICENSE](https://github.com/sonata-nfv/tng-gtk-sp/blob/master/LICENSE) file for more details.
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "tng/gtk/utils"
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,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,105 @@
1
+ ## Copyright (c) 2015 SONATA-NFV, 2017 5GTANGO [, ANY ADDITIONAL AFFILIATION]
2
+ ## ALL RIGHTS RESERVED.
3
+ ##
4
+ ## Licensed under the Apache License, Version 2.0 (the "License");
5
+ ## you may not use this file except in compliance with the License.
6
+ ## You may obtain a copy of the License at
7
+ ##
8
+ ## http://www.apache.org/licenses/LICENSE-2.0
9
+ ##
10
+ ## Unless required by applicable law or agreed to in writing, software
11
+ ## distributed under the License is distributed on an "AS IS" BASIS,
12
+ ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ ## See the License for the specific language governing permissions and
14
+ ## limitations under the License.
15
+ ##
16
+ ## Neither the name of the SONATA-NFV, 5GTANGO [, ANY ADDITIONAL AFFILIATION]
17
+ ## nor the names of its contributors may be used to endorse or promote
18
+ ## products derived from this software without specific prior written
19
+ ## permission.
20
+ ##
21
+ ## This work has been performed in the framework of the SONATA project,
22
+ ## funded by the European Commission under Grant number 671517 through
23
+ ## the Horizon 2020 and 5G-PPP programmes. The authors would like to
24
+ ## acknowledge the contributions of their colleagues of the SONATA
25
+ ## partner consortium (www.sonata-nfv.eu).
26
+ ##
27
+ ## This work has been performed in the framework of the 5GTANGO project,
28
+ ## funded by the European Commission under Grant number 761493 through
29
+ ## the Horizon 2020 and 5G-PPP programmes. The authors would like to
30
+ ## acknowledge the contributions of their colleagues of the 5GTANGO
31
+ ## partner consortium (www.5gtango.eu).
32
+ # encoding: utf-8
33
+ # frozen_string_literal: true
34
+ require 'redis'
35
+
36
+ module Tng
37
+ module Gtk
38
+ module Utils
39
+ class Cache
40
+
41
+ class RedisCache
42
+ class << self
43
+ attr_accessor :store
44
+ end
45
+
46
+ def store=(value) self.class.store = value end
47
+ def store() self.class.store end
48
+
49
+ begin
50
+ self.store = Redis.new
51
+ rescue StandardError => e
52
+ e.inspect
53
+ e.message
54
+ end
55
+ def self.set(key, val) self.store.set(key, val) end
56
+ def self.get(key) self.store.get(key) end
57
+ def self.del(key) self.store.set(key, nil) end
58
+ end
59
+
60
+ class MemoryCache
61
+ class << self
62
+ attr_accessor :store
63
+ end
64
+ def store=(value) self.class.store = value end
65
+ def store() self.class.store end
66
+ self.store = {}
67
+ def self.set(key, val) self.store[key] = val end
68
+ def self.get(key) self.store[key] end
69
+ def self.del(key) self.store[key] = nil end
70
+ end
71
+
72
+ STRATEGIES = {
73
+ redis: RedisCache,
74
+ memory: MemoryCache
75
+ }
76
+ class << self
77
+ attr_accessor :strategy
78
+ end
79
+
80
+ def strategy=(value) self.class.strategy = value end
81
+ def strategy() self.class.strategy end
82
+
83
+ self.strategy = ENV['REDIS_URL'] ? STRATEGIES[:redis] : STRATEGIES[:memory]
84
+ STDERR.puts "Strategy used: #{self.strategy}"
85
+
86
+ def self.set(records)
87
+ if records.is_a?(Hash)
88
+ STDERR.puts "Setting key '#{records[:uuid]}' with value '#{records}' (strategy #{self.strategy})"
89
+ self.strategy.set(records[:uuid], records) if records.key?(:uuid)
90
+ return
91
+ end
92
+ records.each do |record|
93
+ STDERR.puts "Setting key '#{record[:uuid]}' with value '#{record}' (strategy #{self.strategy})"
94
+ self.strategy.set(record[:uuid], record) if record.key?(:uuid)
95
+ end
96
+ end
97
+ def self.get(key)
98
+ STDERR.puts "Getting key '#{key}' (strategy #{self.strategy})"
99
+ self.strategy.get(key)
100
+ end
101
+ def self.del(key) self.strategy.del(key) end
102
+ end
103
+ end
104
+ end
105
+ end
@@ -0,0 +1,104 @@
1
+ ## Copyright (c) 2015 SONATA-NFV, 2017 5GTANGO [, ANY ADDITIONAL AFFILIATION]
2
+ ## ALL RIGHTS RESERVED.
3
+ ##
4
+ ## Licensed under the Apache License, Version 2.0 (the "License");
5
+ ## you may not use this file except in compliance with the License.
6
+ ## You may obtain a copy of the License at
7
+ ##
8
+ ## http://www.apache.org/licenses/LICENSE-2.0
9
+ ##
10
+ ## Unless required by applicable law or agreed to in writing, software
11
+ ## distributed under the License is distributed on an "AS IS" BASIS,
12
+ ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ ## See the License for the specific language governing permissions and
14
+ ## limitations under the License.
15
+ ##
16
+ ## Neither the name of the SONATA-NFV, 5GTANGO [, ANY ADDITIONAL AFFILIATION]
17
+ ## nor the names of its contributors may be used to endorse or promote
18
+ ## products derived from this software without specific prior written
19
+ ## permission.
20
+ ##
21
+ ## This work has been performed in the framework of the SONATA project,
22
+ ## funded by the European Commission under Grant number 671517 through
23
+ ## the Horizon 2020 and 5G-PPP programmes. The authors would like to
24
+ ## acknowledge the contributions of their colleagues of the SONATA
25
+ ## partner consortium (www.sonata-nfv.eu).
26
+ ##
27
+ ## This work has been performed in the framework of the 5GTANGO project,
28
+ ## funded by the European Commission under Grant number 761493 through
29
+ ## the Horizon 2020 and 5G-PPP programmes. The authors would like to
30
+ ## acknowledge the contributions of their colleagues of the 5GTANGO
31
+ ## partner consortium (www.5gtango.eu).
32
+ # encoding: utf-8
33
+ # frozen_string_literal: true
34
+ require 'net/http'
35
+ require 'json'
36
+ require 'redis'
37
+ require 'tng/gtk/utils/cache'
38
+
39
+ module Tng
40
+ module Gtk
41
+ module Utils
42
+
43
+ class Fetch
44
+ class << self
45
+ attr_accessor :site
46
+ end
47
+
48
+ def site=(value) self.class.site = value end
49
+ def site() self.class.site end
50
+
51
+ def self.call(params)
52
+ msg=self.name+'#'+__method__.to_s
53
+ STDERR.puts "#{msg}: params=#{params} site=#{self.site}"
54
+ original_params = params.dup
55
+ begin
56
+ if params.key?(:uuid)
57
+ cached = Tng::Gtk::Utils::Cache.get(params[:uuid])
58
+ if cached
59
+ STDERR.puts "#{msg}: cached=#{cached}"
60
+ return cached
61
+ end
62
+ uuid = params.delete :uuid
63
+ uri = URI.parse("#{self.site}/#{uuid}")
64
+ # mind that there cany be more params, so we might need to pass params as well
65
+ else
66
+ uri = URI.parse(self.site)
67
+ uri.query = URI.encode_www_form(sanitize(params))
68
+ end
69
+ STDERR.puts "#{msg}: uri=#{uri}"
70
+ request = Net::HTTP::Get.new(uri)
71
+ request['content-type'] = 'application/json'
72
+ response = Net::HTTP.start(uri.hostname, uri.port) {|http| http.request(request)}
73
+ STDERR.puts "#{msg}: response=#{response.inspect}"
74
+ case response
75
+ when Net::HTTPSuccess
76
+ body = response.read_body
77
+ STDERR.puts "#{msg}: 200 (Ok) body=#{body}"
78
+ result = JSON.parse(body, quirks_mode: true, symbolize_names: true)
79
+ Tng::Gtk::Utils::Cache.set(result)
80
+ return result
81
+ when Net::HTTPNotFound
82
+ STDERR.puts "#{msg}: 404 Not found) body=#{body}"
83
+ return {} unless uuid.nil?
84
+ return []
85
+ else
86
+ return nil # ArgumentError.new("#{response.message}")
87
+ end
88
+ rescue Exception => e
89
+ STDERR.puts "%s - %s: %s" % [Time.now.utc.to_s, msg, e.message]
90
+ end
91
+ nil
92
+ end
93
+
94
+ private
95
+ # TODO: Get this out of here!
96
+ def self.sanitize(params)
97
+ params[:page_number] ||= ENV.fetch('DEFAULT_PAGE_NUMBER', 0)
98
+ params[:page_size] ||= ENV.fetch('DEFAULT_PAGE_SIZE', 100)
99
+ params
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,7 @@
1
+ module Tng
2
+ module Gtk
3
+ module Utils
4
+ VERSION = "0.1.1"
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,9 @@
1
+ require "tng/gtk/utils/version"
2
+
3
+ module Tng
4
+ module Gtk
5
+ module Utils
6
+ # Your code goes here...
7
+ end
8
+ end
9
+ end
@@ -0,0 +1,14 @@
1
+ require "bundler/setup"
2
+ require "tng/gtk/utils"
3
+
4
+ RSpec.configure do |config|
5
+ # Enable flags like --only-failures and --next-failure
6
+ config.example_status_persistence_file_path = ".rspec_status"
7
+
8
+ # Disable RSpec exposing methods globally on `Module` and `main`
9
+ config.disable_monkey_patching!
10
+
11
+ config.expect_with :rspec do |c|
12
+ c.syntax = :expect
13
+ end
14
+ end
@@ -0,0 +1,9 @@
1
+ RSpec.describe Tng::Gtk::Utils do
2
+ it "has a version number" do
3
+ expect(Tng::Gtk::Utils::VERSION).not_to be nil
4
+ end
5
+
6
+ it "does something useful" do
7
+ expect(false).to eq(true)
8
+ end
9
+ end
@@ -0,0 +1,39 @@
1
+
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "tng/gtk/utils/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "tng-gtk-utils"
8
+ spec.version = Tng::Gtk::Utils::VERSION
9
+ spec.authors = ["José Bonnet"]
10
+ spec.email = ["jose.bonnet@icloud.com"]
11
+
12
+ spec.summary = %q{A small library with utility features for 5GTANGO Gatekeeper}
13
+ spec.description = %q{5GTANGO Gatekeeper has been developed and started to accumulate some technical debt, namely with repeated code. This utility adresses that debt by extrating the duplicated code.}
14
+ spec.homepage = "https://github.com/sonata-nfv/tng-gtk-utils"
15
+ spec.license = "Apache-2.0"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ #if spec.respond_to?(:metadata)
20
+ # spec.metadata["allowed_push_host"] = "http://rubygems.org"
21
+ #else
22
+ # raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ #end
24
+
25
+ # Specify which files should be added to the gem when it is released.
26
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
27
+ spec.files = `git ls-files`.split($/)
28
+ spec.bindir = "bin"
29
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
30
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
31
+ spec.require_paths = ["lib"]
32
+
33
+ spec.add_development_dependency "bundler", "~> 1.16"
34
+ spec.add_development_dependency "rake", "~> 10.0"
35
+ spec.add_development_dependency "rspec", "~> 3.0"
36
+ spec.add_development_dependency "pry", '~> 0.12.0'
37
+
38
+ spec.add_dependency 'redis', '~> 4.0'
39
+ end
metadata ADDED
@@ -0,0 +1,138 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: tng-gtk-utils
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.1
5
+ platform: ruby
6
+ authors:
7
+ - José Bonnet
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2018-11-09 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.16'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.16'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: 0.12.0
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: 0.12.0
69
+ - !ruby/object:Gem::Dependency
70
+ name: redis
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '4.0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '4.0'
83
+ description: 5GTANGO Gatekeeper has been developed and started to accumulate some
84
+ technical debt, namely with repeated code. This utility adresses that debt by extrating
85
+ the duplicated code.
86
+ email:
87
+ - jose.bonnet@icloud.com
88
+ executables:
89
+ - console
90
+ - setup
91
+ extensions: []
92
+ extra_rdoc_files: []
93
+ files:
94
+ - ".gitignore"
95
+ - ".rspec"
96
+ - ".travis.yml"
97
+ - CODE_OF_CONDUCT.md
98
+ - Gemfile
99
+ - LICENSE
100
+ - LICENSE.txt
101
+ - README.md
102
+ - Rakefile
103
+ - bin/console
104
+ - bin/setup
105
+ - lib/tng/gtk/utils.rb
106
+ - lib/tng/gtk/utils/cache.rb
107
+ - lib/tng/gtk/utils/fetch.rb
108
+ - lib/tng/gtk/utils/version.rb
109
+ - spec/spec_helper.rb
110
+ - spec/tng/gtk/utils_spec.rb
111
+ - tng-gtk-utils.gemspec
112
+ homepage: https://github.com/sonata-nfv/tng-gtk-utils
113
+ licenses:
114
+ - Apache-2.0
115
+ metadata: {}
116
+ post_install_message:
117
+ rdoc_options: []
118
+ require_paths:
119
+ - lib
120
+ required_ruby_version: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ required_rubygems_version: !ruby/object:Gem::Requirement
126
+ requirements:
127
+ - - ">="
128
+ - !ruby/object:Gem::Version
129
+ version: '0'
130
+ requirements: []
131
+ rubyforge_project:
132
+ rubygems_version: 2.7.7
133
+ signing_key:
134
+ specification_version: 4
135
+ summary: A small library with utility features for 5GTANGO Gatekeeper
136
+ test_files:
137
+ - spec/spec_helper.rb
138
+ - spec/tng/gtk/utils_spec.rb