gifnoc 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6f4495a415fb5e8ccaf6373b03b938995d308eddcd1f8ce8f4e9e6367ea62fa8
4
+ data.tar.gz: 3cffaba84c2a9765370bdf5fce7f33f426c2858d6f84358dd9c11cd77fb8fa38
5
+ SHA512:
6
+ metadata.gz: 0d5f9c0f8b7b5570311f30b7d22748a51bd3dc766858d25011e80a8a6d86cf7d3793566dc086bb8c11fe383182950c8cc72cfe6f0122e0292beced067f13f201
7
+ data.tar.gz: 0c30ac0e382e75b0cf0fcc1e951dd0e27cc7817c2bd751014cb8cc2fa65230c703444a428fd5322e9e7bbd09997650f66a01c3fcd1906d8e3d318bb47118e997
@@ -0,0 +1,24 @@
1
+ # EditorConfig is awesome: http://EditorConfig.org
2
+ # top-most EditorConfig file
3
+ root = true
4
+
5
+ # all files
6
+ [*]
7
+ # Unix-style newlines
8
+ end_of_line = lf
9
+ # newline ending every file
10
+ insert_final_newline = true
11
+ # utf-8 charset
12
+ charset = utf-8
13
+ # remove and trailing whitespace chars
14
+ trim_trailing_whitespace = true
15
+ # no max line length
16
+ max_line_length = off
17
+ # default to tab spacing
18
+ indent_style = tab
19
+ # default to 4 char tabs
20
+ indent_size = 4
21
+ # "something + something" not "something+something"
22
+ spaces_around_operators = true
23
+ # "something(true)" not "something ( true )"
24
+ spaces_around_brackets = none
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
@@ -0,0 +1 @@
1
+ gifnoc-ruby
@@ -0,0 +1 @@
1
+ 2.5.3
@@ -0,0 +1,2 @@
1
+ 2018-11-22 v0.0.1
2
+ - Initial Release
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 gifnoc.gemspec
6
+ gemspec
@@ -0,0 +1,60 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ gifnoc (0.0.1)
5
+ httparty (~> 0.16.2)
6
+ ice_nine (~> 0.11.2)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ addressable (2.5.2)
12
+ public_suffix (>= 2.0.2, < 4.0)
13
+ byebug (10.0.2)
14
+ coderay (1.1.2)
15
+ crack (0.4.3)
16
+ safe_yaml (~> 1.0.0)
17
+ docile (1.3.1)
18
+ hashdiff (0.3.7)
19
+ httparty (0.16.2)
20
+ multi_xml (>= 0.5.2)
21
+ ice_nine (0.11.2)
22
+ json (2.1.0)
23
+ method_source (0.9.1)
24
+ minitest (5.11.3)
25
+ multi_xml (0.6.0)
26
+ pry (0.12.0)
27
+ coderay (~> 1.1.0)
28
+ method_source (~> 0.9.0)
29
+ pry-byebug (3.6.0)
30
+ byebug (~> 10.0)
31
+ pry (~> 0.10)
32
+ public_suffix (3.0.3)
33
+ rake (10.5.0)
34
+ safe_yaml (1.0.4)
35
+ simplecov (0.16.1)
36
+ docile (~> 1.1)
37
+ json (>= 1.8, < 3)
38
+ simplecov-html (~> 0.10.0)
39
+ simplecov-html (0.10.2)
40
+ vcr (4.0.0)
41
+ webmock (3.4.2)
42
+ addressable (>= 2.3.6)
43
+ crack (>= 0.3.2)
44
+ hashdiff
45
+
46
+ PLATFORMS
47
+ ruby
48
+
49
+ DEPENDENCIES
50
+ bundler (~> 1.16)
51
+ gifnoc!
52
+ minitest (~> 5.0)
53
+ pry-byebug (~> 3.6)
54
+ rake (~> 10.0)
55
+ simplecov (~> 0.16.1)
56
+ vcr (~> 4.0)
57
+ webmock (~> 3.4, >= 3.4.2)
58
+
59
+ BUNDLED WITH
60
+ 1.17.1
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 2018 Cloud 66
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.
@@ -0,0 +1,97 @@
1
+ # Gifnoc
2
+
3
+ A Ruby Gifnoc client implementation.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'gifnoc'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install gifnoc
20
+
21
+ ## Usage
22
+
23
+ You can initialize a new Client for Gifnoc using
24
+ ```
25
+ client = Gifnoc::Client.new(token: <your_token_secret>, base_url: <gifnoc_server_url>)
26
+ ```
27
+
28
+ The Client has 4 main components:
29
+ - Accounts
30
+ - Namespaces
31
+ - Records
32
+ - Tokens
33
+
34
+ ### Accounts
35
+
36
+ Accounts are the top level entity in Gifnoc. It’s used to isolate different users of the system, making Gifnoc safely multi-tenanted. Only the admin account can perform account operations.
37
+
38
+ The following operations are supported:
39
+ ```
40
+ accounts = client.list_accounts # list all accounts, returns an array of Gifnoc::Account
41
+ account, account_token = client.create_account # create an account, returns an array with two entries, the Gifnoc::Account, and the associated Gifnoc::Token
42
+ account = client.get_account(account_uuid) # get a specific account, returns Gifnoc::Account
43
+ client.delete_account(account_uuid) # delete an account
44
+ ```
45
+
46
+ ### Namespaces
47
+
48
+ Records are namespaced to allow a degree of separation between different users of the system within a single account. Access to namespaces is not regulated (like accounts).
49
+
50
+ The following operations are supported:
51
+ ```
52
+ namespaces = client.list_namespaces # list all namespaces, returns an array of Gifnoc::Namespace
53
+ namespace = client.create_namespace(new_namespace) # create a namespace, returns a Gifnoc::Namespace
54
+ namespace = client.get_namespace(namespace_uuid) # get a specific namespace, returns Gifnoc::Namespace
55
+ namespace = client.update_namespace(namespace_uuid, new_namespace) # update an existing namespace, returns a Gifnoc::Namespace
56
+ client.delete_namespace(namespace_uuid) # delete a namespace
57
+ ```
58
+
59
+ ### Records
60
+
61
+ A single configuration item. A Record holds the following attributes: key, raw_value, uuid, metadata, created_at, updated_at, last_access. When you create a new instance of Record you can specify the Base64 encoded raw_value directly, or use the `value=` setter method that will encode the value for you.
62
+
63
+ The following operations are supported:
64
+ ```
65
+ records = client.list_records(namespace_uuid) # list all the records of a namespace, returns an array of Gifnoc::Record
66
+ record = client.create_record(namespace_uuid, new_record) # create a record inside a namespace, returns a Gifnoc::Record
67
+ record = client.get_record(namespace_uuid, record_key) # get a specific record, returns Gifnoc::Record
68
+ record = client.update_record(namespace_uuid, record_key, new_record) # update an existing record inside a namespace, returns a Gifnoc::Record
69
+ client.delete_record(namespace_uuid, record_key) # delete a record from a namespace
70
+ ```
71
+
72
+ ### Tokens
73
+
74
+ Accounts are identified by tokens. An account can have many tokens. Tokens can have expiry dates and are identified with a UUID. Callers to the Gifnoc API will use a token’s secret in the call to identify themselves.
75
+
76
+ The following operations are supported:
77
+ ```
78
+ tokens = client.list_tokens # list all tokens, returns an array of Gifnoc::Token
79
+ token = client.create_token(new_token) # create a token, returns a Gifnoc::Token
80
+ token = client.get_token(token_uuid) # get a specific token, returns Gifnoc::Token
81
+ token = client.update_token(token_uuid, new_token) # update an existing token, returns a Gifnoc::Token
82
+ client.delete_token(token_uuid) # delete a token
83
+ ```
84
+
85
+ ## Development
86
+
87
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
88
+
89
+ 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).
90
+
91
+ ## Contributing
92
+
93
+ Bug reports and pull requests are welcome on GitHub at https://github.com/cloud66-oss/gifnoc-ruby.
94
+
95
+ ## License
96
+
97
+ The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "gifnoc"
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__)