commonlit-clever-ruby 2.1.6.beta1 → 2.1.6.beta2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/Gemfile.lock +37 -29
- data/README.md +994 -61
- data/clever-ruby.gemspec +6 -13
- data/commonlit-clever-ruby-2.1.6.beta1.gem +0 -0
- data/docs/AdminName.md +0 -1
- data/docs/BadRequest.md +0 -1
- data/docs/Contact.md +1 -2
- data/docs/ContactObject.md +0 -1
- data/docs/ContactResponse.md +0 -1
- data/docs/ContactsCreated.md +2 -3
- data/docs/ContactsDeleted.md +2 -3
- data/docs/ContactsResponse.md +0 -1
- data/docs/ContactsUpdated.md +2 -3
- data/docs/Course.md +1 -2
- data/docs/CourseObject.md +0 -1
- data/docs/CourseResponse.md +0 -1
- data/docs/CoursesCreated.md +2 -3
- data/docs/CoursesDeleted.md +2 -3
- data/docs/CoursesResponse.md +0 -1
- data/docs/CoursesUpdated.md +2 -3
- data/docs/Credentials.md +0 -1
- data/docs/DataApi.md +2784 -0
- data/docs/District.md +9 -10
- data/docs/DistrictAdmin.md +2 -3
- data/docs/DistrictAdminObject.md +0 -1
- data/docs/DistrictAdminResponse.md +0 -1
- data/docs/DistrictAdminsResponse.md +0 -1
- data/docs/DistrictObject.md +0 -1
- data/docs/DistrictResponse.md +0 -1
- data/docs/DistrictadminsCreated.md +2 -3
- data/docs/DistrictadminsDeleted.md +2 -3
- data/docs/DistrictadminsUpdated.md +2 -3
- data/docs/DistrictsCreated.md +2 -3
- data/docs/DistrictsDeleted.md +2 -3
- data/docs/DistrictsResponse.md +0 -1
- data/docs/DistrictsUpdated.md +2 -3
- data/docs/Event.md +2 -3
- data/docs/EventResponse.md +0 -1
- data/docs/EventsApi.md +1 -4
- data/docs/EventsResponse.md +0 -1
- data/docs/InternalError.md +0 -1
- data/docs/Link.md +0 -1
- data/docs/Location.md +2 -3
- data/docs/Name.md +1 -2
- data/docs/NotFound.md +0 -1
- data/docs/Principal.md +1 -2
- data/docs/School.md +3 -4
- data/docs/SchoolAdmin.md +3 -4
- data/docs/SchoolAdminObject.md +0 -1
- data/docs/SchoolAdminResponse.md +0 -1
- data/docs/SchoolAdminsResponse.md +0 -1
- data/docs/SchoolEnrollment.md +1 -2
- data/docs/SchoolObject.md +0 -1
- data/docs/SchoolResponse.md +0 -1
- data/docs/SchooladminsCreated.md +2 -3
- data/docs/SchooladminsDeleted.md +2 -3
- data/docs/SchooladminsUpdated.md +2 -3
- data/docs/SchoolsCreated.md +2 -3
- data/docs/SchoolsDeleted.md +2 -3
- data/docs/SchoolsResponse.md +0 -1
- data/docs/SchoolsUpdated.md +2 -3
- data/docs/Section.md +2 -3
- data/docs/SectionObject.md +0 -1
- data/docs/SectionResponse.md +0 -1
- data/docs/SectionsCreated.md +2 -3
- data/docs/SectionsDeleted.md +2 -3
- data/docs/SectionsResponse.md +0 -1
- data/docs/SectionsUpdated.md +2 -3
- data/docs/Student.md +3 -4
- data/docs/StudentObject.md +0 -1
- data/docs/StudentResponse.md +0 -1
- data/docs/StudentsCreated.md +2 -3
- data/docs/StudentsDeleted.md +2 -3
- data/docs/StudentsResponse.md +0 -1
- data/docs/StudentsUpdated.md +2 -3
- data/docs/Teacher.md +2 -3
- data/docs/TeacherObject.md +0 -1
- data/docs/TeacherResponse.md +0 -1
- data/docs/TeachersCreated.md +2 -3
- data/docs/TeachersDeleted.md +2 -3
- data/docs/TeachersResponse.md +0 -1
- data/docs/TeachersUpdated.md +2 -3
- data/docs/Term.md +2 -3
- data/docs/TermObject.md +0 -1
- data/docs/TermResponse.md +0 -1
- data/docs/TermsCreated.md +2 -3
- data/docs/TermsDeleted.md +2 -3
- data/docs/TermsResponse.md +0 -1
- data/docs/TermsUpdated.md +2 -3
- data/git_push.sh +55 -0
- data/lib/clever-ruby/api/data_api.rb +2999 -0
- data/lib/clever-ruby/api/events_api.rb +25 -20
- data/lib/clever-ruby/api_error.rb +23 -4
- data/lib/clever-ruby/configuration.rb +5 -9
- data/lib/clever-ruby/models/admin_name.rb +46 -22
- data/lib/clever-ruby/models/bad_request.rb +42 -20
- data/lib/clever-ruby/models/contact.rb +83 -55
- data/lib/clever-ruby/models/contact_object.rb +42 -20
- data/lib/clever-ruby/models/contact_response.rb +42 -20
- data/lib/clever-ruby/models/contacts_response.rb +44 -22
- data/lib/clever-ruby/models/course.rb +60 -36
- data/lib/clever-ruby/models/course_object.rb +42 -20
- data/lib/clever-ruby/models/course_response.rb +42 -20
- data/lib/clever-ruby/models/courses_response.rb +44 -22
- data/lib/clever-ruby/models/credentials.rb +42 -20
- data/lib/clever-ruby/models/district.rb +122 -94
- data/lib/clever-ruby/models/district_admin.rb +67 -44
- data/lib/clever-ruby/models/district_admin_object.rb +42 -20
- data/lib/clever-ruby/models/district_admin_response.rb +42 -20
- data/lib/clever-ruby/models/district_admins_response.rb +44 -22
- data/lib/clever-ruby/models/district_object.rb +42 -20
- data/lib/clever-ruby/models/district_response.rb +42 -20
- data/lib/clever-ruby/models/districts_response.rb +44 -22
- data/lib/clever-ruby/models/event.rb +60 -33
- data/lib/clever-ruby/models/event_response.rb +42 -20
- data/lib/clever-ruby/models/events_response.rb +44 -22
- data/lib/clever-ruby/models/internal_error.rb +42 -20
- data/lib/clever-ruby/models/link.rb +47 -25
- data/lib/clever-ruby/models/location.rb +73 -45
- data/lib/clever-ruby/models/name.rb +58 -33
- data/lib/clever-ruby/models/not_found.rb +42 -20
- data/lib/clever-ruby/models/principal.rb +55 -31
- data/lib/clever-ruby/models/school.rb +108 -80
- data/lib/clever-ruby/models/school_admin.rb +85 -61
- data/lib/clever-ruby/models/school_admin_object.rb +42 -20
- data/lib/clever-ruby/models/school_admin_response.rb +42 -20
- data/lib/clever-ruby/models/school_admins_response.rb +44 -22
- data/lib/clever-ruby/models/school_enrollment.rb +56 -34
- data/lib/clever-ruby/models/school_object.rb +42 -20
- data/lib/clever-ruby/models/school_response.rb +42 -20
- data/lib/clever-ruby/models/schools_response.rb +44 -22
- data/lib/clever-ruby/models/section.rb +104 -75
- data/lib/clever-ruby/models/section_object.rb +42 -20
- data/lib/clever-ruby/models/section_response.rb +42 -20
- data/lib/clever-ruby/models/sections_response.rb +44 -22
- data/lib/clever-ruby/models/student.rb +147 -126
- data/lib/clever-ruby/models/student_object.rb +42 -20
- data/lib/clever-ruby/models/student_response.rb +42 -20
- data/lib/clever-ruby/models/students_response.rb +44 -22
- data/lib/clever-ruby/models/teacher.rb +89 -63
- data/lib/clever-ruby/models/teacher_object.rb +42 -20
- data/lib/clever-ruby/models/teacher_response.rb +42 -20
- data/lib/clever-ruby/models/teachers_response.rb +44 -22
- data/lib/clever-ruby/models/term.rb +69 -44
- data/lib/clever-ruby/models/term_object.rb +42 -20
- data/lib/clever-ruby/models/term_response.rb +42 -20
- data/lib/clever-ruby/models/terms_response.rb +44 -22
- data/lib/clever-ruby/version.rb +4 -5
- data/lib/clever-ruby.rb +4 -14
- data/override/README-extension.md +1 -1
- data/override/override.sh +3 -0
- data/spec/api/data_api_spec.rb +671 -0
- data/spec/api/events_api_spec.rb +4 -3
- data/spec/api_client_spec.rb +21 -3
- data/spec/spec_helper.rb +4 -3
- metadata +25 -179
- data/docs/ContactsApi.md +0 -231
- data/docs/CoursesApi.md +0 -231
- data/docs/DistrictAdminsApi.md +0 -171
- data/docs/DistrictsApi.md +0 -113
- data/docs/SchoolAdminsApi.md +0 -231
- data/docs/SchoolsApi.md +0 -351
- data/docs/SectionsApi.md +0 -499
- data/docs/StudentsApi.md +0 -463
- data/docs/TeachersApi.md +0 -403
- data/docs/TermsApi.md +0 -231
- data/lib/clever-ruby/api/contacts_api.rb +0 -241
- data/lib/clever-ruby/api/courses_api.rb +0 -241
- data/lib/clever-ruby/api/district_admins_api.rb +0 -182
- data/lib/clever-ruby/api/districts_api.rb +0 -123
- data/lib/clever-ruby/api/school_admins_api.rb +0 -241
- data/lib/clever-ruby/api/schools_api.rb +0 -359
- data/lib/clever-ruby/api/sections_api.rb +0 -500
- data/lib/clever-ruby/api/students_api.rb +0 -468
- data/lib/clever-ruby/api/teachers_api.rb +0 -409
- data/lib/clever-ruby/api/terms_api.rb +0 -241
- data/spec/api/contacts_api_spec.rb +0 -84
- data/spec/api/courses_api_spec.rb +0 -84
- data/spec/api/district_admins_api_spec.rb +0 -70
- data/spec/api/districts_api_spec.rb +0 -56
- data/spec/api/school_admins_api_spec.rb +0 -84
- data/spec/api/schools_api_spec.rb +0 -112
- data/spec/api/sections_api_spec.rb +0 -142
- data/spec/api/students_api_spec.rb +0 -137
- data/spec/api/teachers_api_spec.rb +0 -123
- data/spec/api/terms_api_spec.rb +0 -84
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Clever API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The Clever API
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 2.1.0
|
|
7
7
|
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
-
Swagger Codegen version:
|
|
10
|
-
|
|
9
|
+
Swagger Codegen version: 3.0.51
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
require 'date'
|
|
@@ -27,28 +26,41 @@ module Clever
|
|
|
27
26
|
end
|
|
28
27
|
|
|
29
28
|
# Attribute type mapping.
|
|
30
|
-
def self.
|
|
29
|
+
def self.openapi_types
|
|
31
30
|
{
|
|
32
|
-
:'data' => :'
|
|
33
|
-
:'links' => :'
|
|
31
|
+
:'data' => :'Object',
|
|
32
|
+
:'links' => :'Object'
|
|
34
33
|
}
|
|
35
34
|
end
|
|
36
35
|
|
|
36
|
+
# List of attributes with nullable: true
|
|
37
|
+
def self.openapi_nullable
|
|
38
|
+
Set.new([
|
|
39
|
+
])
|
|
40
|
+
end
|
|
41
|
+
|
|
37
42
|
# Initializes the object
|
|
38
43
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
39
44
|
def initialize(attributes = {})
|
|
40
|
-
|
|
45
|
+
if (!attributes.is_a?(Hash))
|
|
46
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Clever::TermsResponse` initialize method"
|
|
47
|
+
end
|
|
41
48
|
|
|
42
|
-
# convert string to symbol for hash key
|
|
43
|
-
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
49
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
50
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
51
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
52
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Clever::TermsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
53
|
+
end
|
|
54
|
+
h[k.to_sym] = v
|
|
55
|
+
}
|
|
44
56
|
|
|
45
|
-
if attributes.
|
|
57
|
+
if attributes.key?(:'data')
|
|
46
58
|
if (value = attributes[:'data']).is_a?(Array)
|
|
47
59
|
self.data = value
|
|
48
60
|
end
|
|
49
61
|
end
|
|
50
62
|
|
|
51
|
-
if attributes.
|
|
63
|
+
if attributes.key?(:'links')
|
|
52
64
|
if (value = attributes[:'links']).is_a?(Array)
|
|
53
65
|
self.links = value
|
|
54
66
|
end
|
|
@@ -84,17 +96,24 @@ module Clever
|
|
|
84
96
|
end
|
|
85
97
|
|
|
86
98
|
# Calculates hash code according to all attributes.
|
|
87
|
-
# @return [
|
|
99
|
+
# @return [Integer] Hash code
|
|
88
100
|
def hash
|
|
89
101
|
[data, links].hash
|
|
90
102
|
end
|
|
91
103
|
|
|
104
|
+
# Builds the object from hash
|
|
105
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
106
|
+
# @return [Object] Returns the model itself
|
|
107
|
+
def self.build_from_hash(attributes)
|
|
108
|
+
new.build_from_hash(attributes)
|
|
109
|
+
end
|
|
110
|
+
|
|
92
111
|
# Builds the object from hash
|
|
93
112
|
# @param [Hash] attributes Model attributes in the form of hash
|
|
94
113
|
# @return [Object] Returns the model itself
|
|
95
114
|
def build_from_hash(attributes)
|
|
96
115
|
return nil unless attributes.is_a?(Hash)
|
|
97
|
-
self.class.
|
|
116
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
98
117
|
if type =~ /\AArray<(.*)>/i
|
|
99
118
|
# check to ensure the input is an array given that the attribute
|
|
100
119
|
# is documented as an array but the input is not
|
|
@@ -103,7 +122,9 @@ module Clever
|
|
|
103
122
|
end
|
|
104
123
|
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
105
124
|
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
106
|
-
|
|
125
|
+
elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
126
|
+
self.send("#{key}=", nil)
|
|
127
|
+
end
|
|
107
128
|
end
|
|
108
129
|
|
|
109
130
|
self
|
|
@@ -125,7 +146,7 @@ module Clever
|
|
|
125
146
|
value.to_i
|
|
126
147
|
when :Float
|
|
127
148
|
value.to_f
|
|
128
|
-
when :
|
|
149
|
+
when :Boolean
|
|
129
150
|
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
130
151
|
true
|
|
131
152
|
else
|
|
@@ -146,8 +167,7 @@ module Clever
|
|
|
146
167
|
end
|
|
147
168
|
end
|
|
148
169
|
else # model
|
|
149
|
-
|
|
150
|
-
temp_model.build_from_hash(value)
|
|
170
|
+
Clever.const_get(type).build_from_hash(value)
|
|
151
171
|
end
|
|
152
172
|
end
|
|
153
173
|
|
|
@@ -169,7 +189,11 @@ module Clever
|
|
|
169
189
|
hash = {}
|
|
170
190
|
self.class.attribute_map.each_pair do |attr, param|
|
|
171
191
|
value = self.send(attr)
|
|
172
|
-
|
|
192
|
+
if value.nil?
|
|
193
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
194
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
195
|
+
end
|
|
196
|
+
|
|
173
197
|
hash[param] = _to_hash(value)
|
|
174
198
|
end
|
|
175
199
|
hash
|
|
@@ -191,7 +215,5 @@ module Clever
|
|
|
191
215
|
else
|
|
192
216
|
value
|
|
193
217
|
end
|
|
194
|
-
end
|
|
195
|
-
|
|
196
|
-
end
|
|
218
|
+
end end
|
|
197
219
|
end
|
data/lib/clever-ruby/version.rb
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Clever API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The Clever API
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 2.1.0
|
|
7
7
|
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
-
Swagger Codegen version:
|
|
10
|
-
|
|
9
|
+
Swagger Codegen version: 3.0.51
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
module Clever
|
|
14
|
-
VERSION = '2.1.6.
|
|
13
|
+
VERSION = '2.1.6.beta2'
|
|
15
14
|
end
|
data/lib/clever-ruby.rb
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
#
|
|
2
|
+
#Clever API
|
|
3
3
|
|
|
4
|
-
#
|
|
4
|
+
#The Clever API
|
|
5
5
|
|
|
6
6
|
OpenAPI spec version: 2.1.0
|
|
7
7
|
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
|
-
Swagger Codegen version:
|
|
10
|
-
|
|
9
|
+
Swagger Codegen version: 3.0.51
|
|
11
10
|
=end
|
|
12
11
|
|
|
13
12
|
# Common files
|
|
@@ -102,17 +101,8 @@ require 'clever-ruby/models/terms_response'
|
|
|
102
101
|
require 'clever-ruby/models/terms_updated'
|
|
103
102
|
|
|
104
103
|
# APIs
|
|
105
|
-
require 'clever-ruby/api/
|
|
106
|
-
require 'clever-ruby/api/courses_api'
|
|
107
|
-
require 'clever-ruby/api/district_admins_api'
|
|
108
|
-
require 'clever-ruby/api/districts_api'
|
|
104
|
+
require 'clever-ruby/api/data_api'
|
|
109
105
|
require 'clever-ruby/api/events_api'
|
|
110
|
-
require 'clever-ruby/api/school_admins_api'
|
|
111
|
-
require 'clever-ruby/api/schools_api'
|
|
112
|
-
require 'clever-ruby/api/sections_api'
|
|
113
|
-
require 'clever-ruby/api/students_api'
|
|
114
|
-
require 'clever-ruby/api/teachers_api'
|
|
115
|
-
require 'clever-ruby/api/terms_api'
|
|
116
106
|
|
|
117
107
|
module Clever
|
|
118
108
|
class << self
|
|
@@ -14,7 +14,7 @@ The current client support v2.0 of the API. For v1.2 please use:
|
|
|
14
14
|
3. Run this command in the swagger-codegen repo
|
|
15
15
|
|
|
16
16
|
```
|
|
17
|
-
swagger-codegen generate -i $PATH_TO_SWAGGER_API_REPO/
|
|
17
|
+
swagger-codegen generate -i $PATH_TO_SWAGGER_API_REPO/v2.1-client.yml -l ruby -o $PATH_TO_THIS_REPO --additional-properties gemVersion=$VERSION
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
4. Run `make build` to copy over the override files
|
data/override/override.sh
CHANGED
|
@@ -11,6 +11,9 @@ cp override/models/* lib/clever-ruby/models/
|
|
|
11
11
|
# Override the parsing library with one that's aware of the inheritence
|
|
12
12
|
cp override/api_client.rb lib/clever-ruby/
|
|
13
13
|
|
|
14
|
+
# Add Addressable to the gem manifest as a dependency
|
|
15
|
+
sed -i '' "28s/^/ s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'\n/" ./clever-ruby.gemspec
|
|
16
|
+
|
|
14
17
|
# Rename references of SwaggerClient to Clever
|
|
15
18
|
git grep -l 'SwaggerClient' -- './*' ':(exclude)override/override.sh' | xargs sed -i "" 's/SwaggerClient/Clever/g'
|
|
16
19
|
git grep -l 'swagger_client' -- './*' ':(exclude)override/override.sh' | xargs sed -i "" 's/swagger_client/clever-ruby/g'
|