qrapi-wrapper 0.6.0

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.
Files changed (46) hide show
  1. checksums.yaml +7 -0
  2. data/lib/qrapi.rb +79 -0
  3. data/lib/qrapi/client.rb +58 -0
  4. data/lib/qrapi/error_handling_resourceable.rb +22 -0
  5. data/lib/qrapi/mappings/contact_mapping.rb +22 -0
  6. data/lib/qrapi/mappings/distribution_mapping.rb +68 -0
  7. data/lib/qrapi/mappings/division_mapping.rb +27 -0
  8. data/lib/qrapi/mappings/error_mapping.rb +19 -0
  9. data/lib/qrapi/mappings/group_mapping.rb +27 -0
  10. data/lib/qrapi/mappings/library_message_mapping.rb +20 -0
  11. data/lib/qrapi/mappings/mailing_list_mapping.rb +20 -0
  12. data/lib/qrapi/mappings/organization_mapping.rb +19 -0
  13. data/lib/qrapi/mappings/response_export_mapping.rb +14 -0
  14. data/lib/qrapi/mappings/responses_mapping.rb +45 -0
  15. data/lib/qrapi/mappings/survey_mapping.rb +33 -0
  16. data/lib/qrapi/mappings/user_mapping.rb +40 -0
  17. data/lib/qrapi/models/base_model.rb +22 -0
  18. data/lib/qrapi/models/distribution.rb +45 -0
  19. data/lib/qrapi/models/distribution/headers.rb +27 -0
  20. data/lib/qrapi/models/distribution/message.rb +26 -0
  21. data/lib/qrapi/models/distribution/recipients.rb +26 -0
  22. data/lib/qrapi/models/distribution/survey_link.rb +26 -0
  23. data/lib/qrapi/models/division.rb +32 -0
  24. data/lib/qrapi/models/group.rb +31 -0
  25. data/lib/qrapi/models/library_message.rb +27 -0
  26. data/lib/qrapi/models/mailing_list.rb +27 -0
  27. data/lib/qrapi/models/mailing_list/contact.rb +33 -0
  28. data/lib/qrapi/models/organization.rb +29 -0
  29. data/lib/qrapi/models/response.rb +40 -0
  30. data/lib/qrapi/models/response_export.rb +71 -0
  31. data/lib/qrapi/models/survey.rb +45 -0
  32. data/lib/qrapi/models/survey/expiration.rb +25 -0
  33. data/lib/qrapi/models/user.rb +44 -0
  34. data/lib/qrapi/resources/distribution_resource.rb +47 -0
  35. data/lib/qrapi/resources/division_resource.rb +24 -0
  36. data/lib/qrapi/resources/group_resource.rb +44 -0
  37. data/lib/qrapi/resources/library_message_resource.rb +41 -0
  38. data/lib/qrapi/resources/mailing_list_resource.rb +51 -0
  39. data/lib/qrapi/resources/organization_resource.rb +12 -0
  40. data/lib/qrapi/resources/response_export_resource.rb +49 -0
  41. data/lib/qrapi/resources/response_import_resource.rb +26 -0
  42. data/lib/qrapi/resources/survey_resource.rb +27 -0
  43. data/lib/qrapi/resources/user_resource.rb +35 -0
  44. data/lib/qrapi/utils/kartograph_optional_properties.rb +21 -0
  45. data/lib/qrapi/version.rb +3 -0
  46. metadata +271 -0
@@ -0,0 +1,26 @@
1
+ module QRAPI
2
+ class ResponseImportResource < ResourceKit::Resource
3
+ include ErrorHandlingResourceable
4
+
5
+ resources do
6
+ action :import, "POST /API/v3/responseimports" do
7
+ body do |survey_id, file_path|
8
+ {
9
+ surveyId: survey_id,
10
+ file: Faraday::UploadIO.new(file_path, "application/csv")
11
+ }
12
+ end
13
+ handler(200) { |response| JSON.parse(response.body)["result"]["id"] }
14
+ end
15
+
16
+ action :import_from_url, "POST /API/v3/responseimports" do
17
+ body { |survey_id, file_url| { surveyId: survey_id, fileUrl: file_url, contentType: "application/csv" } }
18
+ handler(200) { |response| JSON.parse(response.body)["result"]["id"] }
19
+ end
20
+
21
+ action :find, "GET /API/v3/responseimports/:id" do
22
+ handler(200) { |response| JSON.parse(response.body)["result"]["percentComplete"] }
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,27 @@
1
+ module QRAPI
2
+ class SurveyResource < ResourceKit::Resource
3
+ include ErrorHandlingResourceable
4
+
5
+ resources do
6
+ action :all, "GET /API/v3/surveys" do
7
+ handler(200) do |response|
8
+ body = JSON.parse(response.body)["result"].to_json
9
+ SurveyMapping.extract_collection(body, :read)
10
+ end
11
+ end
12
+
13
+ action :find, "GET /API/v3/surveys/:id" do
14
+ handler(200) { |response| SurveyMapping.extract_single(response.body, :read) }
15
+ end
16
+
17
+ action :update, "PUT /API/v3/surveys/:id" do
18
+ body { |object| SurveyMapping.representation_for(:update, object) }
19
+ handler(200) { |_| true }
20
+ end
21
+
22
+ action :delete, "DELETE /API/v3/surveys/:id" do
23
+ handler(200) { |_| true }
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,35 @@
1
+ module QRAPI
2
+ class UserResource < ResourceKit::Resource
3
+ include ErrorHandlingResourceable
4
+
5
+ resources do
6
+ action :all, "GET /API/v3/users" do
7
+ handler(200) do |response|
8
+ body = JSON.parse(response.body)["result"].to_json
9
+ UserMapping.extract_collection(body, :read)
10
+ end
11
+ end
12
+
13
+ action :find, "GET /API/v3/users/:id" do
14
+ handler(200) { |response| UserMapping.extract_single(response.body, :read) }
15
+ end
16
+
17
+ action :create, "POST /API/v3/users" do
18
+ body { |object| UserMapping.representation_for(:create, object) }
19
+ handler(200) do |response, object|
20
+ object.id = JSON.parse(response.body)["result"]["id"]
21
+ object
22
+ end
23
+ end
24
+
25
+ action :update, "PUT /API/v3/users/:id" do
26
+ body { |object| UserMapping.representation_for(:update, object) }
27
+ handler(200) { |_| true }
28
+ end
29
+
30
+ action :delete, "DELETE /API/v3/users/:id" do
31
+ handler(200) { |_| true }
32
+ end
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,21 @@
1
+ # https://github.com/digitalocean/kartograph/pull/11
2
+ # adds the ability to define properties as optional
3
+
4
+ module Kartograph
5
+ class Artist
6
+ def build_properties(object, scope, *args)
7
+ scoped_properties = scope ? properties.filter_by_scope(scope) : properties
8
+ scoped_properties.each_with_object({}) do |property, mapped|
9
+ raise ArgumentError, "#{object} does not respond to #{property.name}, so we can't map it" unless object.respond_to?(property.name)
10
+
11
+ mapped[property.key] = property.value_for(object, scope) unless property.value_for(object, scope).nil? && property.optional?
12
+ end
13
+ end
14
+ end
15
+
16
+ class Property
17
+ def optional?
18
+ !!options[:optional]
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,3 @@
1
+ module QRAPI
2
+ VERSION = "0.6.0"
3
+ end
metadata ADDED
@@ -0,0 +1,271 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: qrapi-wrapper
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.6.0
5
+ platform: ruby
6
+ authors:
7
+ - DaveEOS
8
+ - Nick Hurst
9
+ autorequire:
10
+ bindir: exe
11
+ cert_chain: []
12
+ date: 2019-10-24 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: rubyzip
16
+ requirement: !ruby/object:Gem::Requirement
17
+ requirements:
18
+ - - ">="
19
+ - !ruby/object:Gem::Version
20
+ version: '0'
21
+ type: :runtime
22
+ prerelease: false
23
+ version_requirements: !ruby/object:Gem::Requirement
24
+ requirements:
25
+ - - ">="
26
+ - !ruby/object:Gem::Version
27
+ version: '0'
28
+ - !ruby/object:Gem::Dependency
29
+ name: faraday
30
+ requirement: !ruby/object:Gem::Requirement
31
+ requirements:
32
+ - - ">="
33
+ - !ruby/object:Gem::Version
34
+ version: '0'
35
+ type: :runtime
36
+ prerelease: false
37
+ version_requirements: !ruby/object:Gem::Requirement
38
+ requirements:
39
+ - - ">="
40
+ - !ruby/object:Gem::Version
41
+ version: '0'
42
+ - !ruby/object:Gem::Dependency
43
+ name: resource_kit
44
+ requirement: !ruby/object:Gem::Requirement
45
+ requirements:
46
+ - - ">="
47
+ - !ruby/object:Gem::Version
48
+ version: '0'
49
+ type: :runtime
50
+ prerelease: false
51
+ version_requirements: !ruby/object:Gem::Requirement
52
+ requirements:
53
+ - - ">="
54
+ - !ruby/object:Gem::Version
55
+ version: '0'
56
+ - !ruby/object:Gem::Dependency
57
+ name: kartograph
58
+ requirement: !ruby/object:Gem::Requirement
59
+ requirements:
60
+ - - ">="
61
+ - !ruby/object:Gem::Version
62
+ version: '0'
63
+ type: :runtime
64
+ prerelease: false
65
+ version_requirements: !ruby/object:Gem::Requirement
66
+ requirements:
67
+ - - ">="
68
+ - !ruby/object:Gem::Version
69
+ version: '0'
70
+ - !ruby/object:Gem::Dependency
71
+ name: virtus
72
+ requirement: !ruby/object:Gem::Requirement
73
+ requirements:
74
+ - - ">="
75
+ - !ruby/object:Gem::Version
76
+ version: '0'
77
+ type: :runtime
78
+ prerelease: false
79
+ version_requirements: !ruby/object:Gem::Requirement
80
+ requirements:
81
+ - - ">="
82
+ - !ruby/object:Gem::Version
83
+ version: '0'
84
+ - !ruby/object:Gem::Dependency
85
+ name: activemodel
86
+ requirement: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - ">="
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ type: :runtime
92
+ prerelease: false
93
+ version_requirements: !ruby/object:Gem::Requirement
94
+ requirements:
95
+ - - ">="
96
+ - !ruby/object:Gem::Version
97
+ version: '0'
98
+ - !ruby/object:Gem::Dependency
99
+ name: activesupport
100
+ requirement: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - ">="
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ type: :runtime
106
+ prerelease: false
107
+ version_requirements: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: '0'
112
+ - !ruby/object:Gem::Dependency
113
+ name: smarter_csv
114
+ requirement: !ruby/object:Gem::Requirement
115
+ requirements:
116
+ - - ">="
117
+ - !ruby/object:Gem::Version
118
+ version: '0'
119
+ type: :runtime
120
+ prerelease: false
121
+ version_requirements: !ruby/object:Gem::Requirement
122
+ requirements:
123
+ - - ">="
124
+ - !ruby/object:Gem::Version
125
+ version: '0'
126
+ - !ruby/object:Gem::Dependency
127
+ name: rake
128
+ requirement: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - ">="
131
+ - !ruby/object:Gem::Version
132
+ version: '0'
133
+ type: :development
134
+ prerelease: false
135
+ version_requirements: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ version: '0'
140
+ - !ruby/object:Gem::Dependency
141
+ name: rspec
142
+ requirement: !ruby/object:Gem::Requirement
143
+ requirements:
144
+ - - ">="
145
+ - !ruby/object:Gem::Version
146
+ version: '0'
147
+ type: :development
148
+ prerelease: false
149
+ version_requirements: !ruby/object:Gem::Requirement
150
+ requirements:
151
+ - - ">="
152
+ - !ruby/object:Gem::Version
153
+ version: '0'
154
+ - !ruby/object:Gem::Dependency
155
+ name: webmock
156
+ requirement: !ruby/object:Gem::Requirement
157
+ requirements:
158
+ - - ">="
159
+ - !ruby/object:Gem::Version
160
+ version: '0'
161
+ type: :development
162
+ prerelease: false
163
+ version_requirements: !ruby/object:Gem::Requirement
164
+ requirements:
165
+ - - ">="
166
+ - !ruby/object:Gem::Version
167
+ version: '0'
168
+ - !ruby/object:Gem::Dependency
169
+ name: rubocop
170
+ requirement: !ruby/object:Gem::Requirement
171
+ requirements:
172
+ - - ">="
173
+ - !ruby/object:Gem::Version
174
+ version: '0'
175
+ type: :development
176
+ prerelease: false
177
+ version_requirements: !ruby/object:Gem::Requirement
178
+ requirements:
179
+ - - ">="
180
+ - !ruby/object:Gem::Version
181
+ version: '0'
182
+ - !ruby/object:Gem::Dependency
183
+ name: simplecov
184
+ requirement: !ruby/object:Gem::Requirement
185
+ requirements:
186
+ - - ">="
187
+ - !ruby/object:Gem::Version
188
+ version: '0'
189
+ type: :development
190
+ prerelease: false
191
+ version_requirements: !ruby/object:Gem::Requirement
192
+ requirements:
193
+ - - ">="
194
+ - !ruby/object:Gem::Version
195
+ version: '0'
196
+ description:
197
+ email:
198
+ - dave@eoschools.org
199
+ - hurst.178@osu.edu
200
+ executables: []
201
+ extensions: []
202
+ extra_rdoc_files: []
203
+ files:
204
+ - lib/qrapi.rb
205
+ - lib/qrapi/client.rb
206
+ - lib/qrapi/error_handling_resourceable.rb
207
+ - lib/qrapi/mappings/contact_mapping.rb
208
+ - lib/qrapi/mappings/distribution_mapping.rb
209
+ - lib/qrapi/mappings/division_mapping.rb
210
+ - lib/qrapi/mappings/error_mapping.rb
211
+ - lib/qrapi/mappings/group_mapping.rb
212
+ - lib/qrapi/mappings/library_message_mapping.rb
213
+ - lib/qrapi/mappings/mailing_list_mapping.rb
214
+ - lib/qrapi/mappings/organization_mapping.rb
215
+ - lib/qrapi/mappings/response_export_mapping.rb
216
+ - lib/qrapi/mappings/responses_mapping.rb
217
+ - lib/qrapi/mappings/survey_mapping.rb
218
+ - lib/qrapi/mappings/user_mapping.rb
219
+ - lib/qrapi/models/base_model.rb
220
+ - lib/qrapi/models/distribution.rb
221
+ - lib/qrapi/models/distribution/headers.rb
222
+ - lib/qrapi/models/distribution/message.rb
223
+ - lib/qrapi/models/distribution/recipients.rb
224
+ - lib/qrapi/models/distribution/survey_link.rb
225
+ - lib/qrapi/models/division.rb
226
+ - lib/qrapi/models/group.rb
227
+ - lib/qrapi/models/library_message.rb
228
+ - lib/qrapi/models/mailing_list.rb
229
+ - lib/qrapi/models/mailing_list/contact.rb
230
+ - lib/qrapi/models/organization.rb
231
+ - lib/qrapi/models/response.rb
232
+ - lib/qrapi/models/response_export.rb
233
+ - lib/qrapi/models/survey.rb
234
+ - lib/qrapi/models/survey/expiration.rb
235
+ - lib/qrapi/models/user.rb
236
+ - lib/qrapi/resources/distribution_resource.rb
237
+ - lib/qrapi/resources/division_resource.rb
238
+ - lib/qrapi/resources/group_resource.rb
239
+ - lib/qrapi/resources/library_message_resource.rb
240
+ - lib/qrapi/resources/mailing_list_resource.rb
241
+ - lib/qrapi/resources/organization_resource.rb
242
+ - lib/qrapi/resources/response_export_resource.rb
243
+ - lib/qrapi/resources/response_import_resource.rb
244
+ - lib/qrapi/resources/survey_resource.rb
245
+ - lib/qrapi/resources/user_resource.rb
246
+ - lib/qrapi/utils/kartograph_optional_properties.rb
247
+ - lib/qrapi/version.rb
248
+ homepage: https://www.github.com/eoschools/qrapi
249
+ licenses:
250
+ - MIT
251
+ metadata: {}
252
+ post_install_message:
253
+ rdoc_options: []
254
+ require_paths:
255
+ - lib
256
+ required_ruby_version: !ruby/object:Gem::Requirement
257
+ requirements:
258
+ - - ">="
259
+ - !ruby/object:Gem::Version
260
+ version: '0'
261
+ required_rubygems_version: !ruby/object:Gem::Requirement
262
+ requirements:
263
+ - - ">="
264
+ - !ruby/object:Gem::Version
265
+ version: '0'
266
+ requirements: []
267
+ rubygems_version: 3.0.6
268
+ signing_key:
269
+ specification_version: 4
270
+ summary: QRAPI Ruby API Wrapper
271
+ test_files: []