supermarketapi 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/.gitignore +12 -0
- data/.rspec +3 -0
- data/CHANGELOG.md +8 -0
- data/CODE_OF_CONDUCT.md +3 -0
- data/CONTRIBUTING.MD +77 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +45 -0
- data/LICENSE +201 -0
- data/README.md +114 -0
- data/Rakefile +6 -0
- data/TESTING.MD +7 -0
- data/lib/supermarketapi.rb +22 -0
- data/lib/supermarketapi/client.rb +24 -0
- data/lib/supermarketapi/client/cookbook.rb +52 -0
- data/lib/supermarketapi/client/tools.rb +39 -0
- data/lib/supermarketapi/client/users.rb +22 -0
- data/lib/supermarketapi/default.rb +7 -0
- data/lib/supermarketapi/version.rb +3 -0
- data/supermarketapi.gemspec +35 -0
- metadata +134 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 8b8428a9d827c9ab2c770326675117b01d980b31a44efe4571a718e942b4774f
|
4
|
+
data.tar.gz: 7ad4a6de8e7fec370462c19d39b4991d9062907700b4d62da4f091cd236b7151
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: b97113ff5f768ad82395693e573e61fa1c45e9e103faa587335fc13481e2cb77e8019d3fd9abe744747773e180b9231dcee89f84a74f19e74971e01769940a28
|
7
|
+
data.tar.gz: f5e3fc57be5df905ae6bcba37717d06aeabf8716ed05516b1946c3fe8ef90e8e97b937c612230fd12372d4ef7a261b6af9008d7f5b046b9020bf97b45dc7f87f
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/CHANGELOG.md
ADDED
data/CODE_OF_CONDUCT.md
ADDED
data/CONTRIBUTING.MD
ADDED
@@ -0,0 +1,77 @@
|
|
1
|
+
# Contributing to the Supermarket API Gem
|
2
|
+
|
3
|
+
We are glad you want to contribute to the SupermarketApi gem! The first
|
4
|
+
step is the desire to improve the project.
|
5
|
+
|
6
|
+
## Quick-contribute
|
7
|
+
|
8
|
+
* Create an issue on the github [issue tracker](https://github.com/xorima/supermarketapi/issues)
|
9
|
+
* Link to your patch as a rebased git branch or pull request from the ticket
|
10
|
+
|
11
|
+
We regularly review contributions and will get back to you if we have
|
12
|
+
any suggestions or concerns.
|
13
|
+
|
14
|
+
### Branches and Commits
|
15
|
+
|
16
|
+
You should submit your patch as a git branch named after the change.
|
17
|
+
|
18
|
+
It is a best practice to have your commit message have a _summary
|
19
|
+
line_, followed by an empty line and then a brief description of
|
20
|
+
the commit. This also helps other contributors understand the
|
21
|
+
purpose of changes to the code.
|
22
|
+
|
23
|
+
Remember that not all users use Supermarket in the same way or on the same
|
24
|
+
operating systems as you, so it is helpful to be clear about your use
|
25
|
+
case and change so they can understand it even when it doesn't apply
|
26
|
+
to them.
|
27
|
+
|
28
|
+
### Github and Pull Requests
|
29
|
+
|
30
|
+
We don't require you to use Github, and we will even take patch diffs
|
31
|
+
attached to tickets on the issue tracker. However Github has a lot of
|
32
|
+
convenient features, such as being able to see a diff of changes
|
33
|
+
between a pull request and the main repository quickly without
|
34
|
+
downloading the branch.
|
35
|
+
|
36
|
+
## Functional and Unit Tests
|
37
|
+
|
38
|
+
This cookbook is set up to run tests under
|
39
|
+
[Rspec](http://rspec.org/).
|
40
|
+
|
41
|
+
If any don't pass, investigate them before submitting your patch.
|
42
|
+
|
43
|
+
Any new feature should have unit tests included with the patch with
|
44
|
+
good code coverage to help protect it from future changes. Similarly,
|
45
|
+
patches that fix a bug or regression should have a _regression test_.
|
46
|
+
Simply put, this is a test that would fail without your patch but
|
47
|
+
passes with it. The goal is to ensure this bug doesn't regress in the
|
48
|
+
future. Consider a regular expression that doesn't match a certain
|
49
|
+
pattern that it should, so you provide a patch and a test to ensure
|
50
|
+
that the part of the code that uses this regular expression works as
|
51
|
+
expected. Later another contributor may modify this regular expression
|
52
|
+
in a way that breaks your use cases. The test you wrote will fail,
|
53
|
+
signalling to them to research your ticket and use case and accounting
|
54
|
+
for it.
|
55
|
+
|
56
|
+
If you need help writing tests, please ask on the Chef Developer's
|
57
|
+
mailing list, or [https://community-slack.chef.io/](https://community-slack.chef.io/)
|
58
|
+
|
59
|
+
## Cookbook Contribution Do's and Don't's
|
60
|
+
|
61
|
+
Please do include tests for your contribution. If you need help, ask
|
62
|
+
on the
|
63
|
+
[chef-dev mailing list](http://lists.chef.io/sympa/info/chef-dev)
|
64
|
+
or the [https://community-slack.chef.io/](https://community-slack.chef.io/)
|
65
|
+
|
66
|
+
Please do use rubocop to
|
67
|
+
lint-check the cookbook. It should pass all correctness
|
68
|
+
rules.
|
69
|
+
|
70
|
+
Please do ensure that your changes do not break or modify behavior for
|
71
|
+
other platforms supported by the gem.
|
72
|
+
|
73
|
+
Please do not modify the version number in the gem, the maintainer
|
74
|
+
will select the appropriate version based on the release cycle
|
75
|
+
information above.
|
76
|
+
|
77
|
+
Please do not update the CHANGELOG.md for a new version, but do add your change into the Unreleased section. Not all changes to a gem may be merged and released in the same versions. We will update the CHANGELOG.md when releasing a new version of the gem.
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
supermarketapi (0.1.0)
|
5
|
+
hashie
|
6
|
+
httparty
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
diff-lcs (1.3)
|
12
|
+
hashie (3.6.0)
|
13
|
+
httparty (0.17.0)
|
14
|
+
mime-types (~> 3.0)
|
15
|
+
multi_xml (>= 0.5.2)
|
16
|
+
mime-types (3.2.2)
|
17
|
+
mime-types-data (~> 3.2015)
|
18
|
+
mime-types-data (3.2019.0331)
|
19
|
+
multi_xml (0.6.0)
|
20
|
+
rake (10.5.0)
|
21
|
+
rspec (3.8.0)
|
22
|
+
rspec-core (~> 3.8.0)
|
23
|
+
rspec-expectations (~> 3.8.0)
|
24
|
+
rspec-mocks (~> 3.8.0)
|
25
|
+
rspec-core (3.8.0)
|
26
|
+
rspec-support (~> 3.8.0)
|
27
|
+
rspec-expectations (3.8.3)
|
28
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
29
|
+
rspec-support (~> 3.8.0)
|
30
|
+
rspec-mocks (3.8.0)
|
31
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
32
|
+
rspec-support (~> 3.8.0)
|
33
|
+
rspec-support (3.8.0)
|
34
|
+
|
35
|
+
PLATFORMS
|
36
|
+
ruby
|
37
|
+
|
38
|
+
DEPENDENCIES
|
39
|
+
bundler (~> 1.17)
|
40
|
+
rake (~> 10.0)
|
41
|
+
rspec (~> 3.0)
|
42
|
+
supermarketapi!
|
43
|
+
|
44
|
+
BUNDLED WITH
|
45
|
+
1.17.2
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,114 @@
|
|
1
|
+
# Supermarket API
|
2
|
+
|
3
|
+
This gem is a simple and easy-to-use wrapper for Chef's Supermarket API.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'supermarketapi'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
```bash
|
16
|
+
bundle install
|
17
|
+
```
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
```bash
|
22
|
+
gem install supermarketapi
|
23
|
+
```
|
24
|
+
|
25
|
+
## Usage
|
26
|
+
|
27
|
+
To use the API methods, you'll need to instantiate a new client and use the API methods.
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
# Create a new client
|
31
|
+
client = SupermarketApi.client()
|
32
|
+
```
|
33
|
+
|
34
|
+
### Cookbooks
|
35
|
+
|
36
|
+
#### cookbook
|
37
|
+
|
38
|
+
This method will return all metadata about the given cookbook in an hashie.mash
|
39
|
+
|
40
|
+
```ruby
|
41
|
+
client.cookbook('apache2')
|
42
|
+
```
|
43
|
+
|
44
|
+
#### cookbook_version
|
45
|
+
|
46
|
+
This method retrieves information about the cookbook version and can be used to find the latest version of a cookbook
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
client.cookbook_version('apache2', 'latest')
|
50
|
+
```
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
client.cookbook_version('apache2', '7.0.0')
|
54
|
+
```
|
55
|
+
|
56
|
+
#### cookbooks
|
57
|
+
|
58
|
+
This method searches for cookbooks. It takes the following parameters:
|
59
|
+
|
60
|
+
|name |required |type |default |description|
|
61
|
+
|---------|---------|-------- |-----------------|-----------|
|
62
|
+
|`:user` |Optional | String |`nil` | this is the name of the user to search|
|
63
|
+
|`:start` |Optional | Integer |`0` | Pagination page to start on |
|
64
|
+
|`:items` |Optional | Integer |`50` | Number of items to return |
|
65
|
+
|`:order` |Optional | Symbol |`:most_followed` | Search method, available options are: `:recently_updated`, `:recently_added`, `:most_downloaded`, or `:most_followed`
|
66
|
+
|
67
|
+
```ruby
|
68
|
+
client.cookbooks(
|
69
|
+
:user => 'sous-chefs',
|
70
|
+
:start => 1,
|
71
|
+
:items => 50,
|
72
|
+
:order => :recently_updated,
|
73
|
+
)
|
74
|
+
```
|
75
|
+
|
76
|
+
### Tools
|
77
|
+
|
78
|
+
#### tool
|
79
|
+
|
80
|
+
This method will return all metadata about the given tool in an hashie.mash
|
81
|
+
|
82
|
+
```ruby
|
83
|
+
client.tool('berkshelf')
|
84
|
+
```
|
85
|
+
|
86
|
+
#### tools
|
87
|
+
|
88
|
+
This method will allow you to search for tools
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
client.tools(
|
92
|
+
:query => 'berks',
|
93
|
+
:start => 1,
|
94
|
+
:items => 50,
|
95
|
+
)
|
96
|
+
```
|
97
|
+
|
98
|
+
### Users
|
99
|
+
|
100
|
+
#### user
|
101
|
+
|
102
|
+
This method will return all metadata about the given user in an hashie.mash
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
client.user('sous-chefs')
|
106
|
+
```
|
107
|
+
|
108
|
+
## Contributing
|
109
|
+
|
110
|
+
1. Fork it
|
111
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
112
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
113
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
114
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
data/TESTING.MD
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'httparty'
|
3
|
+
require 'hashie'
|
4
|
+
require 'supermarketapi/version'
|
5
|
+
require 'supermarketapi/default'
|
6
|
+
require 'supermarketapi/client'
|
7
|
+
|
8
|
+
module SupermarketApi
|
9
|
+
class << self
|
10
|
+
def client(options={})
|
11
|
+
@client = SupermarketApi::Client.new(options) unless @client
|
12
|
+
@client
|
13
|
+
end
|
14
|
+
|
15
|
+
private
|
16
|
+
|
17
|
+
def method_missing(name, *args, &block)
|
18
|
+
SupermarketApi.client.send(name, *args, &block)
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
require 'supermarketapi/client/cookbook'
|
2
|
+
require 'supermarketapi/client/tools'
|
3
|
+
require 'supermarketapi/client/users'
|
4
|
+
|
5
|
+
module SupermarketApi
|
6
|
+
class Client
|
7
|
+
|
8
|
+
include HTTParty
|
9
|
+
base_uri Default::API_ENDPOINT
|
10
|
+
|
11
|
+
include SupermarketApi::Client::Cookbooks
|
12
|
+
include SupermarketApi::Client::Tools
|
13
|
+
include SupermarketApi::Client::Users
|
14
|
+
def initialize(options={})
|
15
|
+
end
|
16
|
+
|
17
|
+
private
|
18
|
+
|
19
|
+
def get(url, params={})
|
20
|
+
response = self.class.get url, :query => params
|
21
|
+
Hashie::Mash.new response.parsed_response
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
module SupermarketApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
# Methods for the Cookbook API.
|
5
|
+
#
|
6
|
+
# @see https://docs.chef.io/supermarket_api.html
|
7
|
+
module Cookbooks
|
8
|
+
|
9
|
+
# Show all information about a cookbook
|
10
|
+
#
|
11
|
+
# This method returns all available information for the
|
12
|
+
# given cookbook
|
13
|
+
#
|
14
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
15
|
+
# @example
|
16
|
+
# client.cookbook('apache2')
|
17
|
+
def cookbook(cookbook_name)
|
18
|
+
get "/cookbooks/#{cookbook_name}"
|
19
|
+
end
|
20
|
+
|
21
|
+
# Show informatiom about a cookbook version
|
22
|
+
#
|
23
|
+
# This method returns all available information for the
|
24
|
+
# given cookbook version
|
25
|
+
#
|
26
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
27
|
+
# @example
|
28
|
+
# client.cookbook('apache2', 'latest')
|
29
|
+
def cookbook_version(cookbook_name, cookbook_version)
|
30
|
+
get "/cookbooks/#{cookbook_name}/versions/#{cookbook_version}"
|
31
|
+
end
|
32
|
+
|
33
|
+
# Show information about all cookbook
|
34
|
+
#
|
35
|
+
# This method returns high level information for
|
36
|
+
# a number of cookbooks
|
37
|
+
#
|
38
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
39
|
+
# @example
|
40
|
+
# client.cookbooks(user='sous-chefs', start=0, items=100, order=:most_followed)
|
41
|
+
def cookbooks(user=nil, start=0, items=50, order=:most_followed)
|
42
|
+
options = {
|
43
|
+
:start => start,
|
44
|
+
:items => items,
|
45
|
+
:order => order,
|
46
|
+
}
|
47
|
+
options[:user] = user if user
|
48
|
+
get "/cookbooks", options
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
module SupermarketApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
# Methods for the tools API.
|
5
|
+
#
|
6
|
+
# @see https://docs.chef.io/supermarket_api.html
|
7
|
+
module Tools
|
8
|
+
|
9
|
+
# Show all information about a tool
|
10
|
+
#
|
11
|
+
# This method returns all available information for the
|
12
|
+
# given tool
|
13
|
+
#
|
14
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
15
|
+
# @example
|
16
|
+
# client.tool('berkshelf')
|
17
|
+
def tool(tool_name)
|
18
|
+
get "/tools/#{tool_name}"
|
19
|
+
end
|
20
|
+
|
21
|
+
# Tools search endpoint
|
22
|
+
#
|
23
|
+
# This method returns high level information for
|
24
|
+
# a number of tools based on search
|
25
|
+
#
|
26
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
27
|
+
# @example
|
28
|
+
# client.tools-search(query='berk', start=0, items=100)
|
29
|
+
def tools(query, start=0, items=50)
|
30
|
+
options = {
|
31
|
+
:start => start,
|
32
|
+
:items => items,
|
33
|
+
:q => query,
|
34
|
+
}
|
35
|
+
get "/tools-search", options
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
module SupermarketApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
# Methods for the Users API.
|
5
|
+
#
|
6
|
+
# @see https://docs.chef.io/supermarket_api.html
|
7
|
+
module Users
|
8
|
+
|
9
|
+
# Show all information about a user
|
10
|
+
#
|
11
|
+
# This method returns all available information for the
|
12
|
+
# given user
|
13
|
+
#
|
14
|
+
# @return [Hashie::Mash] The properties of the cookbook.
|
15
|
+
# @example
|
16
|
+
# client.user('sous-chefs')
|
17
|
+
def user(username)
|
18
|
+
get "/users/#{username}"
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "supermarketapi/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "supermarketapi"
|
8
|
+
spec.version = Supermarketapi::VERSION
|
9
|
+
spec.authors = ["Xorima"]
|
10
|
+
spec.email = ["jason@avon-lea.co.uk"]
|
11
|
+
|
12
|
+
spec.summary = 'Chef Supermarket Api Gem'
|
13
|
+
spec.description = 'Gem to interact with the Chef Supermarket Restful API'
|
14
|
+
spec.homepage = "https://github.com/xorima/supermarketapi"
|
15
|
+
|
16
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
17
|
+
spec.metadata["source_code_uri"] = "https://github.com/xorima/supermarketapi"
|
18
|
+
spec.metadata["changelog_uri"] = "https://github.com/xorima/supermarketapi"
|
19
|
+
|
20
|
+
# Specify which files should be added to the gem when it is released.
|
21
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
22
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
23
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
24
|
+
end
|
25
|
+
spec.bindir = "exe"
|
26
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
27
|
+
spec.require_paths = ["lib"]
|
28
|
+
|
29
|
+
spec.add_development_dependency "bundler", "~> 1.17"
|
30
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
31
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
32
|
+
spec.add_dependency "httparty"
|
33
|
+
spec.add_dependency "hashie"
|
34
|
+
spec.add_dependency "json" if RUBY_VERSION < '1.9.2'
|
35
|
+
end
|
metadata
ADDED
@@ -0,0 +1,134 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: supermarketapi
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Xorima
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-04-27 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.17'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.17'
|
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: httparty
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: hashie
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :runtime
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: Gem to interact with the Chef Supermarket Restful API
|
84
|
+
email:
|
85
|
+
- jason@avon-lea.co.uk
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- ".rspec"
|
92
|
+
- CHANGELOG.md
|
93
|
+
- CODE_OF_CONDUCT.md
|
94
|
+
- CONTRIBUTING.MD
|
95
|
+
- Gemfile
|
96
|
+
- Gemfile.lock
|
97
|
+
- LICENSE
|
98
|
+
- README.md
|
99
|
+
- Rakefile
|
100
|
+
- TESTING.MD
|
101
|
+
- lib/supermarketapi.rb
|
102
|
+
- lib/supermarketapi/client.rb
|
103
|
+
- lib/supermarketapi/client/cookbook.rb
|
104
|
+
- lib/supermarketapi/client/tools.rb
|
105
|
+
- lib/supermarketapi/client/users.rb
|
106
|
+
- lib/supermarketapi/default.rb
|
107
|
+
- lib/supermarketapi/version.rb
|
108
|
+
- supermarketapi.gemspec
|
109
|
+
homepage: https://github.com/xorima/supermarketapi
|
110
|
+
licenses: []
|
111
|
+
metadata:
|
112
|
+
homepage_uri: https://github.com/xorima/supermarketapi
|
113
|
+
source_code_uri: https://github.com/xorima/supermarketapi
|
114
|
+
changelog_uri: https://github.com/xorima/supermarketapi
|
115
|
+
post_install_message:
|
116
|
+
rdoc_options: []
|
117
|
+
require_paths:
|
118
|
+
- lib
|
119
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - ">="
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
125
|
+
requirements:
|
126
|
+
- - ">="
|
127
|
+
- !ruby/object:Gem::Version
|
128
|
+
version: '0'
|
129
|
+
requirements: []
|
130
|
+
rubygems_version: 3.0.1
|
131
|
+
signing_key:
|
132
|
+
specification_version: 4
|
133
|
+
summary: Chef Supermarket Api Gem
|
134
|
+
test_files: []
|