bubblez 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/FUNDING.yml +1 -0
- data/.gitignore +48 -0
- data/.travis.yml +7 -0
- data/CODE_OF_CONDUCT.md +77 -0
- data/CONTRIBUTING.md +31 -0
- data/Gemfile +4 -0
- data/LICENSE +373 -0
- data/README.md +78 -0
- data/Rakefile +5 -0
- data/bubblez.gemspec +46 -0
- data/lib/bubblez/config.rb +353 -0
- data/lib/bubblez/endpoint.rb +286 -0
- data/lib/bubblez/rest_client_resources.rb +489 -0
- data/lib/bubblez/rest_environment.rb +67 -0
- data/lib/bubblez/version.rb +24 -0
- data/lib/bubblez.rb +28 -0
- data/lib/tasks/coverage.rake +22 -0
- data/lib/tasks/spec.rake +5 -0
- metadata +223 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: d684ad002fc4ff1e52f4125c05222e30277f6726d06070ac24d757f8bba49622
|
4
|
+
data.tar.gz: fcd5027fe258daf8ebad53f188a5901ee38c933a31508aa1dff8a178fa77c382
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 67aac8c3c1527c07c0be3fb03e07c4e7aac1df80ba0e56e1af9f650f43639105760bf743a9ab810020cb8028ff7f37f20d01274a2f3e8e9560a62f58a7b5bbaf
|
7
|
+
data.tar.gz: aebf61433dbd7da19d757b005e817d66840e0dc2d0a86c632436a0d5b27b6620843a687151600a10c7ddf008ee4629aec24ea6ba6478a8bbea1e14fa5cce48fe
|
data/.github/FUNDING.yml
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
github: jwir3
|
data/.gitignore
ADDED
@@ -0,0 +1,48 @@
|
|
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 (use of CocoaPods):
|
17
|
+
#
|
18
|
+
# We recommend against adding the Pods directory to your .gitignore. However
|
19
|
+
# you should judge for yourself, the pros and cons are mentioned at:
|
20
|
+
# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
|
21
|
+
#
|
22
|
+
# vendor/Pods/
|
23
|
+
|
24
|
+
## Documentation cache and generated files:
|
25
|
+
/.yardoc/
|
26
|
+
/_yardoc/
|
27
|
+
/doc/
|
28
|
+
/rdoc/
|
29
|
+
|
30
|
+
## Environment normalization:
|
31
|
+
/.bundle/
|
32
|
+
/vendor/bundle
|
33
|
+
/lib/bundler/man/
|
34
|
+
|
35
|
+
# for a library or gem, you might want to ignore these files since the code is
|
36
|
+
# intended to run in multiple environments; otherwise, check them in:
|
37
|
+
# Gemfile.lock
|
38
|
+
# .ruby-version
|
39
|
+
# .ruby-gemset
|
40
|
+
|
41
|
+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
|
42
|
+
.rvmrc
|
43
|
+
|
44
|
+
# Ignore RubyMine files
|
45
|
+
.idea/**
|
46
|
+
|
47
|
+
# Ignore Gemfile.lock because this is a gem
|
48
|
+
Gemfile.lock
|
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,77 @@
|
|
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 of Bubbles pledge to making participation in our
|
7
|
+
project and our community a harassment-free experience for everyone,
|
8
|
+
regardless of age, body size, disability, ethnicity, sex characteristics,
|
9
|
+
gender identity and expression, level of experience, education,
|
10
|
+
socio-economic status, nationality, personal appearance, race, religion,
|
11
|
+
or sexual identity and orientation.
|
12
|
+
|
13
|
+
## Our Standards
|
14
|
+
|
15
|
+
Examples of behavior that contributes to creating a positive environment
|
16
|
+
include:
|
17
|
+
|
18
|
+
* Using welcoming and inclusive language
|
19
|
+
* Being respectful of differing viewpoints and experiences
|
20
|
+
* Gracefully accepting constructive criticism
|
21
|
+
* Focusing on what is best for the community and users
|
22
|
+
* Showing empathy towards other community members
|
23
|
+
|
24
|
+
Examples of unacceptable behavior by participants include:
|
25
|
+
|
26
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
27
|
+
advances
|
28
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
29
|
+
* Public or private harassment
|
30
|
+
* Publishing others' private information, such as a physical or electronic
|
31
|
+
address, without explicit permission
|
32
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
33
|
+
professional setting
|
34
|
+
|
35
|
+
## Our Responsibilities
|
36
|
+
|
37
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
38
|
+
behavior and are expected to take appropriate and fair corrective action in
|
39
|
+
response to any instances of unacceptable behavior.
|
40
|
+
|
41
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
42
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
43
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
44
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
45
|
+
threatening, offensive, or harmful.
|
46
|
+
|
47
|
+
## Scope
|
48
|
+
|
49
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
50
|
+
when an individual is representing the project or its community. Examples of
|
51
|
+
representing a project or community include using an official project e-mail
|
52
|
+
address, posting via an official social media account, or acting as an appointed
|
53
|
+
representative at an online or offline event. Representation of a project may be
|
54
|
+
further defined and clarified by project maintainers.
|
55
|
+
|
56
|
+
## Enforcement
|
57
|
+
|
58
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
59
|
+
reported by contacting Scott Johnson, our project lead, at jaywir3@gmail.com. All
|
60
|
+
complaints will be reviewed and investigated and will result in a response that
|
61
|
+
is deemed necessary and appropriate to the circumstances. The project leadership
|
62
|
+
team is obligated to maintain confidentiality with regard to the reporter of an
|
63
|
+
incident. Further details of specific enforcement policies may be posted separately.
|
64
|
+
|
65
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
66
|
+
faith may face temporary or permanent repercussions as determined by other
|
67
|
+
members of the project's leadership.
|
68
|
+
|
69
|
+
## Attribution
|
70
|
+
|
71
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
72
|
+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
73
|
+
|
74
|
+
[homepage]: https://www.contributor-covenant.org
|
75
|
+
|
76
|
+
For answers to common questions about this code of conduct, see
|
77
|
+
https://www.contributor-covenant.org/faq
|
data/CONTRIBUTING.md
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# Contributing to Bubbles
|
2
|
+
|
3
|
+
## Introduction
|
4
|
+
First off, thanks for looking to contribute to Bubbles! We need people like you
|
5
|
+
to help us make the best quality product we possibly can. Regardless of whether
|
6
|
+
you're a developer, a designer, a technical writer, a student, or even someone
|
7
|
+
just interested in learning more about open source and how to contribute, you're
|
8
|
+
welcome here.
|
9
|
+
|
10
|
+
## Code of Conduct
|
11
|
+
Please take a look at our contributor [Code of Conduct](CODE_OF_CONDUCT.md). We
|
12
|
+
take harassment and non-inclusive behavior very seriously and will not tolerate
|
13
|
+
bullying in any form.
|
14
|
+
|
15
|
+
## Development Process
|
16
|
+
Our development process works as follows:
|
17
|
+
|
18
|
+
1. Fork this repository to your own local Github account.
|
19
|
+
2. Clone your local version of the repository: `git clone git@github.com:<username>/bubbles`.
|
20
|
+
3. Create a branch on your local repository: `git checkout -b <username>/#<issue>-<short-description>`.
|
21
|
+
4. Make any changes you see fit to fix the issue or add your work.
|
22
|
+
5. Verify that tests pass: `bundle install && rake spec`.
|
23
|
+
6. If you're adding a new feature, make sure to add tests for the feature.
|
24
|
+
7. Commit your changes and push to your fork of the repository.
|
25
|
+
8. Submit a pull request to the `master` branch of the original repository.
|
26
|
+
9. You will receive a review within 7 days, at which time, you may need to make
|
27
|
+
modifications to your code, or your contribution might be accepted as-is.
|
28
|
+
|
29
|
+
## Good First Issues
|
30
|
+
You can take a look at our [good first issues](https://github.com/FoamFactory/bubbles/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
31
|
+
to check out some issues that might be a good starting point for you.
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,373 @@
|
|
1
|
+
Mozilla Public License Version 2.0
|
2
|
+
==================================
|
3
|
+
|
4
|
+
1. Definitions
|
5
|
+
--------------
|
6
|
+
|
7
|
+
1.1. "Contributor"
|
8
|
+
means each individual or legal entity that creates, contributes to
|
9
|
+
the creation of, or owns Covered Software.
|
10
|
+
|
11
|
+
1.2. "Contributor Version"
|
12
|
+
means the combination of the Contributions of others (if any) used
|
13
|
+
by a Contributor and that particular Contributor's Contribution.
|
14
|
+
|
15
|
+
1.3. "Contribution"
|
16
|
+
means Covered Software of a particular Contributor.
|
17
|
+
|
18
|
+
1.4. "Covered Software"
|
19
|
+
means Source Code Form to which the initial Contributor has attached
|
20
|
+
the notice in Exhibit A, the Executable Form of such Source Code
|
21
|
+
Form, and Modifications of such Source Code Form, in each case
|
22
|
+
including portions thereof.
|
23
|
+
|
24
|
+
1.5. "Incompatible With Secondary Licenses"
|
25
|
+
means
|
26
|
+
|
27
|
+
(a) that the initial Contributor has attached the notice described
|
28
|
+
in Exhibit B to the Covered Software; or
|
29
|
+
|
30
|
+
(b) that the Covered Software was made available under the terms of
|
31
|
+
version 1.1 or earlier of the License, but not also under the
|
32
|
+
terms of a Secondary License.
|
33
|
+
|
34
|
+
1.6. "Executable Form"
|
35
|
+
means any form of the work other than Source Code Form.
|
36
|
+
|
37
|
+
1.7. "Larger Work"
|
38
|
+
means a work that combines Covered Software with other material, in
|
39
|
+
a separate file or files, that is not Covered Software.
|
40
|
+
|
41
|
+
1.8. "License"
|
42
|
+
means this document.
|
43
|
+
|
44
|
+
1.9. "Licensable"
|
45
|
+
means having the right to grant, to the maximum extent possible,
|
46
|
+
whether at the time of the initial grant or subsequently, any and
|
47
|
+
all of the rights conveyed by this License.
|
48
|
+
|
49
|
+
1.10. "Modifications"
|
50
|
+
means any of the following:
|
51
|
+
|
52
|
+
(a) any file in Source Code Form that results from an addition to,
|
53
|
+
deletion from, or modification of the contents of Covered
|
54
|
+
Software; or
|
55
|
+
|
56
|
+
(b) any new file in Source Code Form that contains any Covered
|
57
|
+
Software.
|
58
|
+
|
59
|
+
1.11. "Patent Claims" of a Contributor
|
60
|
+
means any patent claim(s), including without limitation, method,
|
61
|
+
process, and apparatus claims, in any patent Licensable by such
|
62
|
+
Contributor that would be infringed, but for the grant of the
|
63
|
+
License, by the making, using, selling, offering for sale, having
|
64
|
+
made, import, or transfer of either its Contributions or its
|
65
|
+
Contributor Version.
|
66
|
+
|
67
|
+
1.12. "Secondary License"
|
68
|
+
means either the GNU General Public License, Version 2.0, the GNU
|
69
|
+
Lesser General Public License, Version 2.1, the GNU Affero General
|
70
|
+
Public License, Version 3.0, or any later versions of those
|
71
|
+
licenses.
|
72
|
+
|
73
|
+
1.13. "Source Code Form"
|
74
|
+
means the form of the work preferred for making modifications.
|
75
|
+
|
76
|
+
1.14. "You" (or "Your")
|
77
|
+
means an individual or a legal entity exercising rights under this
|
78
|
+
License. For legal entities, "You" includes any entity that
|
79
|
+
controls, is controlled by, or is under common control with You. For
|
80
|
+
purposes of this definition, "control" means (a) the power, direct
|
81
|
+
or indirect, to cause the direction or management of such entity,
|
82
|
+
whether by contract or otherwise, or (b) ownership of more than
|
83
|
+
fifty percent (50%) of the outstanding shares or beneficial
|
84
|
+
ownership of such entity.
|
85
|
+
|
86
|
+
2. License Grants and Conditions
|
87
|
+
--------------------------------
|
88
|
+
|
89
|
+
2.1. Grants
|
90
|
+
|
91
|
+
Each Contributor hereby grants You a world-wide, royalty-free,
|
92
|
+
non-exclusive license:
|
93
|
+
|
94
|
+
(a) under intellectual property rights (other than patent or trademark)
|
95
|
+
Licensable by such Contributor to use, reproduce, make available,
|
96
|
+
modify, display, perform, distribute, and otherwise exploit its
|
97
|
+
Contributions, either on an unmodified basis, with Modifications, or
|
98
|
+
as part of a Larger Work; and
|
99
|
+
|
100
|
+
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
101
|
+
for sale, have made, import, and otherwise transfer either its
|
102
|
+
Contributions or its Contributor Version.
|
103
|
+
|
104
|
+
2.2. Effective Date
|
105
|
+
|
106
|
+
The licenses granted in Section 2.1 with respect to any Contribution
|
107
|
+
become effective for each Contribution on the date the Contributor first
|
108
|
+
distributes such Contribution.
|
109
|
+
|
110
|
+
2.3. Limitations on Grant Scope
|
111
|
+
|
112
|
+
The licenses granted in this Section 2 are the only rights granted under
|
113
|
+
this License. No additional rights or licenses will be implied from the
|
114
|
+
distribution or licensing of Covered Software under this License.
|
115
|
+
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
116
|
+
Contributor:
|
117
|
+
|
118
|
+
(a) for any code that a Contributor has removed from Covered Software;
|
119
|
+
or
|
120
|
+
|
121
|
+
(b) for infringements caused by: (i) Your and any other third party's
|
122
|
+
modifications of Covered Software, or (ii) the combination of its
|
123
|
+
Contributions with other software (except as part of its Contributor
|
124
|
+
Version); or
|
125
|
+
|
126
|
+
(c) under Patent Claims infringed by Covered Software in the absence of
|
127
|
+
its Contributions.
|
128
|
+
|
129
|
+
This License does not grant any rights in the trademarks, service marks,
|
130
|
+
or logos of any Contributor (except as may be necessary to comply with
|
131
|
+
the notice requirements in Section 3.4).
|
132
|
+
|
133
|
+
2.4. Subsequent Licenses
|
134
|
+
|
135
|
+
No Contributor makes additional grants as a result of Your choice to
|
136
|
+
distribute the Covered Software under a subsequent version of this
|
137
|
+
License (see Section 10.2) or under the terms of a Secondary License (if
|
138
|
+
permitted under the terms of Section 3.3).
|
139
|
+
|
140
|
+
2.5. Representation
|
141
|
+
|
142
|
+
Each Contributor represents that the Contributor believes its
|
143
|
+
Contributions are its original creation(s) or it has sufficient rights
|
144
|
+
to grant the rights to its Contributions conveyed by this License.
|
145
|
+
|
146
|
+
2.6. Fair Use
|
147
|
+
|
148
|
+
This License is not intended to limit any rights You have under
|
149
|
+
applicable copyright doctrines of fair use, fair dealing, or other
|
150
|
+
equivalents.
|
151
|
+
|
152
|
+
2.7. Conditions
|
153
|
+
|
154
|
+
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
155
|
+
in Section 2.1.
|
156
|
+
|
157
|
+
3. Responsibilities
|
158
|
+
-------------------
|
159
|
+
|
160
|
+
3.1. Distribution of Source Form
|
161
|
+
|
162
|
+
All distribution of Covered Software in Source Code Form, including any
|
163
|
+
Modifications that You create or to which You contribute, must be under
|
164
|
+
the terms of this License. You must inform recipients that the Source
|
165
|
+
Code Form of the Covered Software is governed by the terms of this
|
166
|
+
License, and how they can obtain a copy of this License. You may not
|
167
|
+
attempt to alter or restrict the recipients' rights in the Source Code
|
168
|
+
Form.
|
169
|
+
|
170
|
+
3.2. Distribution of Executable Form
|
171
|
+
|
172
|
+
If You distribute Covered Software in Executable Form then:
|
173
|
+
|
174
|
+
(a) such Covered Software must also be made available in Source Code
|
175
|
+
Form, as described in Section 3.1, and You must inform recipients of
|
176
|
+
the Executable Form how they can obtain a copy of such Source Code
|
177
|
+
Form by reasonable means in a timely manner, at a charge no more
|
178
|
+
than the cost of distribution to the recipient; and
|
179
|
+
|
180
|
+
(b) You may distribute such Executable Form under the terms of this
|
181
|
+
License, or sublicense it under different terms, provided that the
|
182
|
+
license for the Executable Form does not attempt to limit or alter
|
183
|
+
the recipients' rights in the Source Code Form under this License.
|
184
|
+
|
185
|
+
3.3. Distribution of a Larger Work
|
186
|
+
|
187
|
+
You may create and distribute a Larger Work under terms of Your choice,
|
188
|
+
provided that You also comply with the requirements of this License for
|
189
|
+
the Covered Software. If the Larger Work is a combination of Covered
|
190
|
+
Software with a work governed by one or more Secondary Licenses, and the
|
191
|
+
Covered Software is not Incompatible With Secondary Licenses, this
|
192
|
+
License permits You to additionally distribute such Covered Software
|
193
|
+
under the terms of such Secondary License(s), so that the recipient of
|
194
|
+
the Larger Work may, at their option, further distribute the Covered
|
195
|
+
Software under the terms of either this License or such Secondary
|
196
|
+
License(s).
|
197
|
+
|
198
|
+
3.4. Notices
|
199
|
+
|
200
|
+
You may not remove or alter the substance of any license notices
|
201
|
+
(including copyright notices, patent notices, disclaimers of warranty,
|
202
|
+
or limitations of liability) contained within the Source Code Form of
|
203
|
+
the Covered Software, except that You may alter any license notices to
|
204
|
+
the extent required to remedy known factual inaccuracies.
|
205
|
+
|
206
|
+
3.5. Application of Additional Terms
|
207
|
+
|
208
|
+
You may choose to offer, and to charge a fee for, warranty, support,
|
209
|
+
indemnity or liability obligations to one or more recipients of Covered
|
210
|
+
Software. However, You may do so only on Your own behalf, and not on
|
211
|
+
behalf of any Contributor. You must make it absolutely clear that any
|
212
|
+
such warranty, support, indemnity, or liability obligation is offered by
|
213
|
+
You alone, and You hereby agree to indemnify every Contributor for any
|
214
|
+
liability incurred by such Contributor as a result of warranty, support,
|
215
|
+
indemnity or liability terms You offer. You may include additional
|
216
|
+
disclaimers of warranty and limitations of liability specific to any
|
217
|
+
jurisdiction.
|
218
|
+
|
219
|
+
4. Inability to Comply Due to Statute or Regulation
|
220
|
+
---------------------------------------------------
|
221
|
+
|
222
|
+
If it is impossible for You to comply with any of the terms of this
|
223
|
+
License with respect to some or all of the Covered Software due to
|
224
|
+
statute, judicial order, or regulation then You must: (a) comply with
|
225
|
+
the terms of this License to the maximum extent possible; and (b)
|
226
|
+
describe the limitations and the code they affect. Such description must
|
227
|
+
be placed in a text file included with all distributions of the Covered
|
228
|
+
Software under this License. Except to the extent prohibited by statute
|
229
|
+
or regulation, such description must be sufficiently detailed for a
|
230
|
+
recipient of ordinary skill to be able to understand it.
|
231
|
+
|
232
|
+
5. Termination
|
233
|
+
--------------
|
234
|
+
|
235
|
+
5.1. The rights granted under this License will terminate automatically
|
236
|
+
if You fail to comply with any of its terms. However, if You become
|
237
|
+
compliant, then the rights granted under this License from a particular
|
238
|
+
Contributor are reinstated (a) provisionally, unless and until such
|
239
|
+
Contributor explicitly and finally terminates Your grants, and (b) on an
|
240
|
+
ongoing basis, if such Contributor fails to notify You of the
|
241
|
+
non-compliance by some reasonable means prior to 60 days after You have
|
242
|
+
come back into compliance. Moreover, Your grants from a particular
|
243
|
+
Contributor are reinstated on an ongoing basis if such Contributor
|
244
|
+
notifies You of the non-compliance by some reasonable means, this is the
|
245
|
+
first time You have received notice of non-compliance with this License
|
246
|
+
from such Contributor, and You become compliant prior to 30 days after
|
247
|
+
Your receipt of the notice.
|
248
|
+
|
249
|
+
5.2. If You initiate litigation against any entity by asserting a patent
|
250
|
+
infringement claim (excluding declaratory judgment actions,
|
251
|
+
counter-claims, and cross-claims) alleging that a Contributor Version
|
252
|
+
directly or indirectly infringes any patent, then the rights granted to
|
253
|
+
You by any and all Contributors for the Covered Software under Section
|
254
|
+
2.1 of this License shall terminate.
|
255
|
+
|
256
|
+
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
257
|
+
end user license agreements (excluding distributors and resellers) which
|
258
|
+
have been validly granted by You or Your distributors under this License
|
259
|
+
prior to termination shall survive termination.
|
260
|
+
|
261
|
+
************************************************************************
|
262
|
+
* *
|
263
|
+
* 6. Disclaimer of Warranty *
|
264
|
+
* ------------------------- *
|
265
|
+
* *
|
266
|
+
* Covered Software is provided under this License on an "as is" *
|
267
|
+
* basis, without warranty of any kind, either expressed, implied, or *
|
268
|
+
* statutory, including, without limitation, warranties that the *
|
269
|
+
* Covered Software is free of defects, merchantable, fit for a *
|
270
|
+
* particular purpose or non-infringing. The entire risk as to the *
|
271
|
+
* quality and performance of the Covered Software is with You. *
|
272
|
+
* Should any Covered Software prove defective in any respect, You *
|
273
|
+
* (not any Contributor) assume the cost of any necessary servicing, *
|
274
|
+
* repair, or correction. This disclaimer of warranty constitutes an *
|
275
|
+
* essential part of this License. No use of any Covered Software is *
|
276
|
+
* authorized under this License except under this disclaimer. *
|
277
|
+
* *
|
278
|
+
************************************************************************
|
279
|
+
|
280
|
+
************************************************************************
|
281
|
+
* *
|
282
|
+
* 7. Limitation of Liability *
|
283
|
+
* -------------------------- *
|
284
|
+
* *
|
285
|
+
* Under no circumstances and under no legal theory, whether tort *
|
286
|
+
* (including negligence), contract, or otherwise, shall any *
|
287
|
+
* Contributor, or anyone who distributes Covered Software as *
|
288
|
+
* permitted above, be liable to You for any direct, indirect, *
|
289
|
+
* special, incidental, or consequential damages of any character *
|
290
|
+
* including, without limitation, damages for lost profits, loss of *
|
291
|
+
* goodwill, work stoppage, computer failure or malfunction, or any *
|
292
|
+
* and all other commercial damages or losses, even if such party *
|
293
|
+
* shall have been informed of the possibility of such damages. This *
|
294
|
+
* limitation of liability shall not apply to liability for death or *
|
295
|
+
* personal injury resulting from such party's negligence to the *
|
296
|
+
* extent applicable law prohibits such limitation. Some *
|
297
|
+
* jurisdictions do not allow the exclusion or limitation of *
|
298
|
+
* incidental or consequential damages, so this exclusion and *
|
299
|
+
* limitation may not apply to You. *
|
300
|
+
* *
|
301
|
+
************************************************************************
|
302
|
+
|
303
|
+
8. Litigation
|
304
|
+
-------------
|
305
|
+
|
306
|
+
Any litigation relating to this License may be brought only in the
|
307
|
+
courts of a jurisdiction where the defendant maintains its principal
|
308
|
+
place of business and such litigation shall be governed by laws of that
|
309
|
+
jurisdiction, without reference to its conflict-of-law provisions.
|
310
|
+
Nothing in this Section shall prevent a party's ability to bring
|
311
|
+
cross-claims or counter-claims.
|
312
|
+
|
313
|
+
9. Miscellaneous
|
314
|
+
----------------
|
315
|
+
|
316
|
+
This License represents the complete agreement concerning the subject
|
317
|
+
matter hereof. If any provision of this License is held to be
|
318
|
+
unenforceable, such provision shall be reformed only to the extent
|
319
|
+
necessary to make it enforceable. Any law or regulation which provides
|
320
|
+
that the language of a contract shall be construed against the drafter
|
321
|
+
shall not be used to construe this License against a Contributor.
|
322
|
+
|
323
|
+
10. Versions of the License
|
324
|
+
---------------------------
|
325
|
+
|
326
|
+
10.1. New Versions
|
327
|
+
|
328
|
+
Mozilla Foundation is the license steward. Except as provided in Section
|
329
|
+
10.3, no one other than the license steward has the right to modify or
|
330
|
+
publish new versions of this License. Each version will be given a
|
331
|
+
distinguishing version number.
|
332
|
+
|
333
|
+
10.2. Effect of New Versions
|
334
|
+
|
335
|
+
You may distribute the Covered Software under the terms of the version
|
336
|
+
of the License under which You originally received the Covered Software,
|
337
|
+
or under the terms of any subsequent version published by the license
|
338
|
+
steward.
|
339
|
+
|
340
|
+
10.3. Modified Versions
|
341
|
+
|
342
|
+
If you create software not governed by this License, and you want to
|
343
|
+
create a new license for such software, you may create and use a
|
344
|
+
modified version of this License if you rename the license and remove
|
345
|
+
any references to the name of the license steward (except to note that
|
346
|
+
such modified license differs from this License).
|
347
|
+
|
348
|
+
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
349
|
+
Licenses
|
350
|
+
|
351
|
+
If You choose to distribute Source Code Form that is Incompatible With
|
352
|
+
Secondary Licenses under the terms of this version of the License, the
|
353
|
+
notice described in Exhibit B of this License must be attached.
|
354
|
+
|
355
|
+
Exhibit A - Source Code Form License Notice
|
356
|
+
-------------------------------------------
|
357
|
+
|
358
|
+
This Source Code Form is subject to the terms of the Mozilla Public
|
359
|
+
License, v. 2.0. If a copy of the MPL was not distributed with this
|
360
|
+
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
361
|
+
|
362
|
+
If it is not possible or desirable to put the notice in a particular
|
363
|
+
file, then You may include the notice in a location (such as a LICENSE
|
364
|
+
file in a relevant directory) where a recipient would be likely to look
|
365
|
+
for such a notice.
|
366
|
+
|
367
|
+
You may add additional accurate notices of copyright ownership.
|
368
|
+
|
369
|
+
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
370
|
+
---------------------------------------------------------
|
371
|
+
|
372
|
+
This Source Code Form is "Incompatible With Secondary Licenses", as
|
373
|
+
defined by the Mozilla Public License, v. 2.0.
|
data/README.md
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
# bubblez
|
2
|
+
[![Build Status](https://travis-ci.org/FoamFactory/bubbles.svg?branch=master)](https://travis-ci.org/FoamFactory/bubbles)
|
3
|
+
|
4
|
+
A gem for easily defining client REST interfaces in ruby
|
5
|
+
|
6
|
+
## Project Goals
|
7
|
+
When working in an Android environment, [Retrofit](https://square.github.io/retrofit/) provides a simple and effective
|
8
|
+
way of annotating methods so that you can define your REST interface:
|
9
|
+
```java
|
10
|
+
public interface GitHubService {
|
11
|
+
@GET("users/{user}/repos")
|
12
|
+
Call<List<Repo>> listRepos(@Path("user") String user);
|
13
|
+
}
|
14
|
+
```
|
15
|
+
|
16
|
+
You can then instantiate your REST client as follows:
|
17
|
+
```java
|
18
|
+
Retrofit retrofit = new Retrofit.Builder()
|
19
|
+
.baseUrl("https://api.github.com/")
|
20
|
+
.build();
|
21
|
+
|
22
|
+
GitHubService service = retrofit.create(GitHubService.class);
|
23
|
+
```
|
24
|
+
|
25
|
+
What this does is allow you to focus on your _handling_ of the REST responses, rather than worrying about the
|
26
|
+
boilerplate code required to set up the client side of the REST API.
|
27
|
+
|
28
|
+
_bubblez_ is a Gem that seeks to provide this same behavior.
|
29
|
+
|
30
|
+
## Usage
|
31
|
+
If you're using Rails, it's suggested to have a `config/initializers/bubblez.rb` configuration file where you can
|
32
|
+
easily configure your endpoints and environments. If you're not using Rails, then you can put this configuration just
|
33
|
+
about anywhere, provided it's executed before where you want to use it.
|
34
|
+
|
35
|
+
## Quickstart
|
36
|
+
In `config/initializers/bubblez.rb`, add the following:
|
37
|
+
```ruby
|
38
|
+
require 'bubblez'
|
39
|
+
|
40
|
+
Bubblez.configure do |config|
|
41
|
+
config.endpoints = [
|
42
|
+
{
|
43
|
+
:method => :get,
|
44
|
+
:location => :version,
|
45
|
+
:authenticated => false,
|
46
|
+
:api_key_required => false
|
47
|
+
}
|
48
|
+
]
|
49
|
+
|
50
|
+
config.environments = [{
|
51
|
+
:scheme => 'http',
|
52
|
+
:host => '0.0.0.0',
|
53
|
+
:port => '1234'
|
54
|
+
}]
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
The `config.endpoints` section is where you configure which endpoints you want to support. The `config.environments`
|
59
|
+
defines the environments, or remote configurations, for accessing the endpoint on specific remote destinations.
|
60
|
+
|
61
|
+
Now, you can use this endpoint with:
|
62
|
+
```ruby
|
63
|
+
require 'bubblez'
|
64
|
+
...
|
65
|
+
|
66
|
+
def version
|
67
|
+
resources = Bubbles::Resources.new
|
68
|
+
|
69
|
+
# The following will make a GET request to
|
70
|
+
# http://0.0.0.0:1234/version and return the result.
|
71
|
+
result = resources.environment.version
|
72
|
+
|
73
|
+
puts(result)
|
74
|
+
end
|
75
|
+
```
|
76
|
+
|
77
|
+
## Detailed Documentation
|
78
|
+
For more examples and detailed documentation, please see [the Bubbles GitHub page](http://foamfactory.github.io/bubblez).
|