clever-ruby 0.14.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/Gemfile +4 -1
- data/Makefile +10 -0
- data/README.md +175 -68
- data/Rakefile +6 -36
- data/circle.yml +1 -1
- data/clever-ruby.gemspec +43 -33
- data/docs/BadRequest.md +8 -0
- data/docs/DataApi.md +2144 -0
- data/docs/District.md +10 -0
- data/docs/DistrictAdmin.md +12 -0
- data/docs/DistrictAdminResponse.md +8 -0
- data/docs/DistrictAdminsResponse.md +8 -0
- data/docs/DistrictObject.md +8 -0
- data/docs/DistrictResponse.md +8 -0
- data/docs/DistrictStatus.md +15 -0
- data/docs/DistrictStatusResponse.md +8 -0
- data/docs/DistrictsCreated.md +10 -0
- data/docs/DistrictsDeleted.md +10 -0
- data/docs/DistrictsResponse.md +8 -0
- data/docs/DistrictsUpdated.md +10 -0
- data/docs/Event.md +9 -0
- data/docs/EventResponse.md +8 -0
- data/docs/EventsApi.md +424 -0
- data/docs/EventsResponse.md +8 -0
- data/docs/GradeLevelsResponse.md +8 -0
- data/docs/InternalError.md +8 -0
- data/docs/Location.md +13 -0
- data/docs/Name.md +10 -0
- data/docs/NotFound.md +8 -0
- data/docs/Principal.md +9 -0
- data/docs/School.md +22 -0
- data/docs/SchoolAdmin.md +14 -0
- data/docs/SchoolAdminObject.md +8 -0
- data/docs/SchoolAdminResponse.md +8 -0
- data/docs/SchoolAdminsResponse.md +8 -0
- data/docs/SchoolObject.md +8 -0
- data/docs/SchoolResponse.md +8 -0
- data/docs/SchooladminsCreated.md +10 -0
- data/docs/SchooladminsDeleted.md +10 -0
- data/docs/SchooladminsUpdated.md +10 -0
- data/docs/SchoolsCreated.md +10 -0
- data/docs/SchoolsDeleted.md +10 -0
- data/docs/SchoolsResponse.md +8 -0
- data/docs/SchoolsUpdated.md +10 -0
- data/docs/Section.md +25 -0
- data/docs/SectionObject.md +8 -0
- data/docs/SectionResponse.md +8 -0
- data/docs/SectionsCreated.md +10 -0
- data/docs/SectionsDeleted.md +10 -0
- data/docs/SectionsResponse.md +8 -0
- data/docs/SectionsUpdated.md +10 -0
- data/docs/Student.md +27 -0
- data/docs/StudentContact.md +16 -0
- data/docs/StudentContactObject.md +8 -0
- data/docs/StudentContactResponse.md +8 -0
- data/docs/StudentContactsResponse.md +8 -0
- data/docs/StudentObject.md +8 -0
- data/docs/StudentResponse.md +8 -0
- data/docs/StudentcontactsCreated.md +10 -0
- data/docs/StudentcontactsDeleted.md +10 -0
- data/docs/StudentcontactsUpdated.md +10 -0
- data/docs/StudentsCreated.md +10 -0
- data/docs/StudentsDeleted.md +10 -0
- data/docs/StudentsResponse.md +8 -0
- data/docs/StudentsUpdated.md +10 -0
- data/docs/Teacher.md +19 -0
- data/docs/TeacherObject.md +8 -0
- data/docs/TeacherResponse.md +8 -0
- data/docs/TeachersCreated.md +10 -0
- data/docs/TeachersDeleted.md +10 -0
- data/docs/TeachersResponse.md +8 -0
- data/docs/TeachersUpdated.md +10 -0
- data/docs/Term.md +10 -0
- data/git_push.sh +55 -0
- data/instructions.md +12 -0
- data/lib/clever-ruby.rb +89 -318
- data/lib/clever-ruby/api/data_api.rb +2090 -0
- data/lib/clever-ruby/api/events_api.rb +429 -0
- data/lib/clever-ruby/api_client.rb +401 -0
- data/lib/clever-ruby/api_error.rb +37 -0
- data/lib/clever-ruby/configuration.rb +187 -25
- data/lib/clever-ruby/models/bad_request.rb +187 -0
- data/lib/clever-ruby/models/district.rb +205 -0
- data/lib/clever-ruby/models/district_admin.rb +223 -0
- data/lib/clever-ruby/models/district_admin_response.rb +187 -0
- data/lib/clever-ruby/models/district_admins_response.rb +189 -0
- data/lib/clever-ruby/models/district_object.rb +187 -0
- data/lib/clever-ruby/models/district_response.rb +187 -0
- data/lib/clever-ruby/models/district_status.rb +250 -0
- data/lib/clever-ruby/models/district_status_response.rb +187 -0
- data/lib/clever-ruby/models/districts_created.rb +206 -0
- data/lib/clever-ruby/models/districts_deleted.rb +207 -0
- data/lib/clever-ruby/models/districts_response.rb +189 -0
- data/lib/clever-ruby/models/districts_updated.rb +207 -0
- data/lib/clever-ruby/models/event.rb +201 -0
- data/lib/clever-ruby/models/event_response.rb +187 -0
- data/lib/clever-ruby/models/events_response.rb +189 -0
- data/lib/clever-ruby/models/grade_levels_response.rb +189 -0
- data/lib/clever-ruby/models/internal_error.rb +187 -0
- data/lib/clever-ruby/models/location.rb +232 -0
- data/lib/clever-ruby/models/name.rb +205 -0
- data/lib/clever-ruby/models/not_found.rb +187 -0
- data/lib/clever-ruby/models/principal.rb +196 -0
- data/lib/clever-ruby/models/school.rb +313 -0
- data/lib/clever-ruby/models/school_admin.rb +243 -0
- data/lib/clever-ruby/models/school_admin_object.rb +187 -0
- data/lib/clever-ruby/models/school_admin_response.rb +187 -0
- data/lib/clever-ruby/models/school_admins_response.rb +189 -0
- data/lib/clever-ruby/models/school_object.rb +187 -0
- data/lib/clever-ruby/models/school_response.rb +187 -0
- data/lib/clever-ruby/models/schooladmins_created.rb +207 -0
- data/lib/clever-ruby/models/schooladmins_deleted.rb +207 -0
- data/lib/clever-ruby/models/schooladmins_updated.rb +207 -0
- data/lib/clever-ruby/models/schools_created.rb +207 -0
- data/lib/clever-ruby/models/schools_deleted.rb +207 -0
- data/lib/clever-ruby/models/schools_response.rb +189 -0
- data/lib/clever-ruby/models/schools_updated.rb +207 -0
- data/lib/clever-ruby/models/section.rb +344 -0
- data/lib/clever-ruby/models/section_object.rb +187 -0
- data/lib/clever-ruby/models/section_response.rb +187 -0
- data/lib/clever-ruby/models/sections_created.rb +207 -0
- data/lib/clever-ruby/models/sections_deleted.rb +207 -0
- data/lib/clever-ruby/models/sections_response.rb +189 -0
- data/lib/clever-ruby/models/sections_updated.rb +207 -0
- data/lib/clever-ruby/models/student.rb +360 -0
- data/lib/clever-ruby/models/student_contact.rb +259 -0
- data/lib/clever-ruby/models/student_contact_object.rb +187 -0
- data/lib/clever-ruby/models/student_contact_response.rb +187 -0
- data/lib/clever-ruby/models/student_contacts_response.rb +189 -0
- data/lib/clever-ruby/models/student_object.rb +187 -0
- data/lib/clever-ruby/models/student_response.rb +187 -0
- data/lib/clever-ruby/models/studentcontacts_created.rb +207 -0
- data/lib/clever-ruby/models/studentcontacts_deleted.rb +207 -0
- data/lib/clever-ruby/models/studentcontacts_updated.rb +207 -0
- data/lib/clever-ruby/models/students_created.rb +196 -0
- data/lib/clever-ruby/models/students_deleted.rb +206 -0
- data/lib/clever-ruby/models/students_response.rb +189 -0
- data/lib/clever-ruby/models/students_updated.rb +207 -0
- data/lib/clever-ruby/models/teacher.rb +288 -0
- data/lib/clever-ruby/models/teacher_object.rb +187 -0
- data/lib/clever-ruby/models/teacher_response.rb +187 -0
- data/lib/clever-ruby/models/teachers_created.rb +207 -0
- data/lib/clever-ruby/models/teachers_deleted.rb +207 -0
- data/lib/clever-ruby/models/teachers_response.rb +189 -0
- data/lib/clever-ruby/models/teachers_updated.rb +207 -0
- data/lib/clever-ruby/models/term.rb +205 -0
- data/lib/clever-ruby/version.rb +12 -4
- data/override/api_client.rb +401 -0
- data/override/config.json +5 -0
- data/override/models/districts_created.rb +206 -0
- data/override/models/districts_deleted.rb +207 -0
- data/override/models/districts_updated.rb +207 -0
- data/override/models/schooladmins_created.rb +207 -0
- data/override/models/schooladmins_deleted.rb +207 -0
- data/override/models/schooladmins_updated.rb +207 -0
- data/override/models/schools_created.rb +207 -0
- data/override/models/schools_deleted.rb +207 -0
- data/override/models/schools_updated.rb +207 -0
- data/override/models/sections_created.rb +207 -0
- data/override/models/sections_deleted.rb +207 -0
- data/override/models/sections_updated.rb +207 -0
- data/override/models/studentcontacts_created.rb +207 -0
- data/override/models/studentcontacts_deleted.rb +207 -0
- data/override/models/studentcontacts_updated.rb +207 -0
- data/override/models/students_created.rb +196 -0
- data/override/models/students_deleted.rb +206 -0
- data/override/models/students_updated.rb +207 -0
- data/override/models/teachers_created.rb +207 -0
- data/override/models/teachers_deleted.rb +207 -0
- data/override/models/teachers_updated.rb +207 -0
- data/override/override.sh +9 -0
- data/sample/sample.rb +16 -0
- metadata +252 -293
- data/.document +0 -5
- data/.gitignore +0 -22
- data/.rubocop.yml +0 -4
- data/.yardopts +0 -2
- data/LICENSE.txt +0 -20
- data/lib/clever-ruby/api_operations/list.rb +0 -130
- data/lib/clever-ruby/api_operations/nested_list.rb +0 -95
- data/lib/clever-ruby/api_operations/page.rb +0 -71
- data/lib/clever-ruby/api_operations/pagelist.rb +0 -43
- data/lib/clever-ruby/api_operations/results_list.rb +0 -31
- data/lib/clever-ruby/api_resource.rb +0 -174
- data/lib/clever-ruby/clever_object.rb +0 -246
- data/lib/clever-ruby/district.rb +0 -75
- data/lib/clever-ruby/district_admin.rb +0 -45
- data/lib/clever-ruby/errors/api_connection_error.rb +0 -5
- data/lib/clever-ruby/errors/api_error.rb +0 -5
- data/lib/clever-ruby/errors/authentication_error.rb +0 -5
- data/lib/clever-ruby/errors/clever_error.rb +0 -52
- data/lib/clever-ruby/errors/invalid_request_error.rb +0 -17
- data/lib/clever-ruby/event.rb +0 -61
- data/lib/clever-ruby/json.rb +0 -34
- data/lib/clever-ruby/nested_resource.rb +0 -41
- data/lib/clever-ruby/school.rb +0 -17
- data/lib/clever-ruby/school_admin.rb +0 -19
- data/lib/clever-ruby/section.rb +0 -17
- data/lib/clever-ruby/student.rb +0 -30
- data/lib/clever-ruby/teacher.rb +0 -17
- data/lib/clever-ruby/util.rb +0 -108
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_district_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_event_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_school_admin_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_school_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_section_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_student_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/counts_teacher_properly.yml +0 -52
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_district_admin.yml +0 -90
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_event.yml +0 -124
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school.yml +0 -113
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_school_admin.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_section.yml +0 -368
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_student.yml +0 -176
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_a_single_teacher.yml +0 -191
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_districts_by_page.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_districts_with_multiple_ids.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_events_by_page.yml +0 -122
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_events_with_multiple_ids.yml +0 -131
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_school_admins_by_page.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_school_admins_with_multiple_ids.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_schools_by_page.yml +0 -110
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_schools_with_multiple_ids.yml +0 -116
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_sections_by_page.yml +0 -1168
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_sections_with_multiple_ids.yml +0 -163
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_students_by_page.yml +0 -1207
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_students_with_multiple_ids.yml +0 -127
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_teachers_by_page.yml +0 -190
- data/test/data/vcr_cassettes/Clever_APIOperations_List/finds_teachers_with_multiple_ids.yml +0 -131
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_district.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_event.yml +0 -122
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_school.yml +0 -110
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_school_admin.yml +0 -101
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_section.yml +0 -1168
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_student.yml +0 -1207
- data/test/data/vcr_cassettes/Clever_APIOperations_List/retrieves_all_teacher.yml +0 -190
- data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_events.yml +0 -526
- data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_schools.yml +0 -240
- data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_sections.yml +0 -3674
- data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_students.yml +0 -2387
- data/test/data/vcr_cassettes/Clever_District/pages_methods/pages_a_district_s_teachers.yml +0 -717
- data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_events.yml +0 -152
- data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_schools.yml +0 -211
- data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_sections.yml +0 -3649
- data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_students.yml +0 -2362
- data/test/data/vcr_cassettes/Clever_District_without_global_token/pages_methods/pages_a_district_s_teachers.yml +0 -688
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_events.yml +0 -89
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_school_admins.yml +0 -101
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_schools.yml +0 -164
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_sections.yml +0 -1168
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_students.yml +0 -1207
- data/test/data/vcr_cassettes/Clever_District_without_global_token/retrieves_a_district_s_teachers.yml +0 -324
- data/test/data/vcr_cassettes/Clever_NestedResource/must_include_auth_token_in_linked_resources.yml +0 -197
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_events.yml +0 -237
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_schools.yml +0 -217
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_sections.yml +0 -2333
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_students.yml +0 -2411
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_district_s_teachers.yml +0 -377
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_admin_s_schools.yml +0 -205
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_district.yml +0 -162
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_events.yml +0 -215
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_sections.yml +0 -1153
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_students.yml +0 -1081
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_school_s_teachers.yml +0 -283
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_district.yml +0 -417
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_events.yml +0 -470
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_school.yml +0 -420
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_students.yml +0 -482
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_section_s_teacher.yml +0 -418
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_district.yml +0 -226
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_events.yml +0 -279
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_school.yml +0 -229
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_sections.yml +0 -301
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_student_s_teachers.yml +0 -277
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_district.yml +0 -240
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_events.yml +0 -293
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_school.yml +0 -243
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_sections.yml +0 -321
- data/test/data/vcr_cassettes/Clever_NestedResource/retrieves_a_teacher_s_students.yml +0 -323
- data/test/data/vcr_cassettes/Error_handling/raises_an_InvalidRequestError_when_given_a_bad_created_since.yml +0 -151
- data/test/data/vcr_cassettes/Optional_attributes/has_the_expected_value_for_an_optional_attribute_that_is_present.yml +0 -55
- data/test/data/vcr_cassettes/last_method/page/has_working_first_and_last_methods.yml +0 -800
- data/test/integration/api_operations/list_test.rb +0 -117
- data/test/integration/district_test.rb +0 -53
- data/test/integration/district_with_non_global_token_test.rb +0 -88
- data/test/integration/error_handling_test.rb +0 -17
- data/test/integration/last_test.rb +0 -56
- data/test/integration/nested_resource_test.rb +0 -31
- data/test/test_helper.rb +0 -18
- data/test/unit/api_resource_test.rb +0 -48
- data/test/unit/clever_test.rb +0 -65
- data/test/unit/configuration_test.rb +0 -37
- data/test/unit/event_test.rb +0 -57
- data/test/unit/optional_attributes_test.rb +0 -27
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: af7feb2d9f5e5288e5bb29973ddc60673f1d6bcf
|
4
|
+
data.tar.gz: d865796c3b18c1eea223c69e2af43056ea57274f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 557078b42025a588bbae8bccff7b2fa6956213a56af55d8b2f46eb51bc4e9bbd94b7973d6e1af4931b379771283d59d573143aa299cc96a859935d61238e5920
|
7
|
+
data.tar.gz: 615c23f4ea1a513afa15e7ecaeb7093f27e36c3f3237be5bd79896f33fbf291391f24890367d11ccf589eee5d95bc136ba78ddbab80a4b6aa7a64a925548752d
|
data/CHANGELOG.md
CHANGED
data/Gemfile
CHANGED
data/Makefile
ADDED
data/README.md
CHANGED
@@ -1,102 +1,209 @@
|
|
1
|
-
#
|
1
|
+
# clever-ruby
|
2
2
|
|
3
|
-
|
3
|
+
Clever - the Ruby gem for the Clever API
|
4
4
|
|
5
|
-
|
5
|
+
The Clever API
|
6
6
|
|
7
|
-
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
|
-
|
9
|
+
- API version: 1.2.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
10
12
|
|
11
13
|
## Installation
|
12
14
|
|
13
|
-
|
15
|
+
### Build a gem
|
14
16
|
|
15
|
-
|
16
|
-
gem 'clever-ruby'
|
17
|
-
```
|
18
|
-
|
19
|
-
And then execute:
|
17
|
+
To build the Ruby code into a gem:
|
20
18
|
|
21
|
-
```
|
22
|
-
|
19
|
+
```shell
|
20
|
+
gem build clever-ruby.gemspec
|
23
21
|
```
|
24
22
|
|
25
|
-
|
23
|
+
Then either install the gem locally:
|
26
24
|
|
27
|
-
```
|
28
|
-
|
25
|
+
```shell
|
26
|
+
gem install ./clever-ruby-1.0.0.gem
|
29
27
|
```
|
28
|
+
(for development, run `gem install --dev ./clever-ruby-1.0.0.gem` to install the development dependencies)
|
30
29
|
|
31
|
-
|
32
|
-
|
33
|
-
Configure clever-ruby to use your Clever token:
|
34
|
-
|
35
|
-
```ruby
|
36
|
-
Clever.configure do |config|
|
37
|
-
config.token = 'YOUR-API-TOKEN'
|
38
|
-
end
|
39
|
-
```
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
40
31
|
|
41
|
-
|
42
|
-
further details.
|
32
|
+
Finally add this to the Gemfile:
|
43
33
|
|
44
|
-
|
34
|
+
gem 'clever-ruby', '~> 1.0.0'
|
45
35
|
|
46
|
-
|
36
|
+
### Install from Git
|
47
37
|
|
48
|
-
|
49
|
-
$ rake test
|
50
|
-
```
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
51
39
|
|
52
|
-
|
40
|
+
gem 'clever-ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
53
41
|
|
54
|
-
|
55
|
-
$ rake test TEST=test/unit/clever_test.rb
|
56
|
-
```
|
42
|
+
### Include the Ruby code directly
|
57
43
|
|
58
|
-
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
59
45
|
|
60
|
-
```
|
61
|
-
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
62
48
|
```
|
63
49
|
|
64
|
-
|
50
|
+
## Getting Started
|
65
51
|
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
### Updating VCR cassettes
|
71
|
-
|
72
|
-
It is not currently possible to easily recreate the scenario in which the original VCR cassettes were recorded, especially for the events. If you need to update or add to the recorded requests and responses:
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'clever-ruby'
|
73
56
|
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
57
|
+
# Setup authorization
|
58
|
+
Clever.configure do |config|
|
59
|
+
# Configure OAuth2 access token for authorization: oauth
|
60
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
61
|
+
end
|
79
62
|
|
80
|
-
|
63
|
+
api_instance = Clever::DataApi.new
|
81
64
|
|
82
|
-
|
65
|
+
id = "id_example" # String |
|
83
66
|
|
84
|
-
```bash
|
85
|
-
$ rake doc
|
86
|
-
```
|
87
67
|
|
88
|
-
|
68
|
+
begin
|
69
|
+
#Get only a specific studentcontact's information.
|
70
|
+
result = api_instance.get_contact(id)
|
71
|
+
p result
|
72
|
+
rescue Clever::ApiError => e
|
73
|
+
puts "Exception when calling DataApi->get_contact: #{e}"
|
74
|
+
end
|
89
75
|
|
90
|
-
```bash
|
91
|
-
$ rake doc-coverage
|
92
76
|
```
|
93
77
|
|
94
|
-
|
95
|
-
|
96
|
-
|
78
|
+
## Documentation for API Endpoints
|
79
|
+
|
80
|
+
All URIs are relative to *https://api.clever.com/v1.2*
|
81
|
+
|
82
|
+
Class | Method | HTTP request | Description
|
83
|
+
------------ | ------------- | ------------- | -------------
|
84
|
+
*Clever::DataApi* | [**get_contact**](docs/DataApi.md#get_contact) | **GET** /contacts/{id} | Get only a specific studentcontact's information.
|
85
|
+
*Clever::DataApi* | [**get_contacts**](docs/DataApi.md#get_contacts) | **GET** /contacts | Gets a list of student contacts you have access to.
|
86
|
+
*Clever::DataApi* | [**get_contacts_for_student**](docs/DataApi.md#get_contacts_for_student) | **GET** /students/{id}/contacts | Retrieves all contacts for a student.
|
87
|
+
*Clever::DataApi* | [**get_district**](docs/DataApi.md#get_district) | **GET** /districts/{id} | Get only a specific district's information.
|
88
|
+
*Clever::DataApi* | [**get_district_admin**](docs/DataApi.md#get_district_admin) | **GET** /district_admins/{id} | Retrieves a district admin
|
89
|
+
*Clever::DataApi* | [**get_district_admins**](docs/DataApi.md#get_district_admins) | **GET** /district_admins | Retrieves all users with admin access to a district.
|
90
|
+
*Clever::DataApi* | [**get_district_for_school**](docs/DataApi.md#get_district_for_school) | **GET** /schools/{id}/district | Retrieves district information for a school.
|
91
|
+
*Clever::DataApi* | [**get_district_for_section**](docs/DataApi.md#get_district_for_section) | **GET** /sections/{id}/district | Retrieves district information for a section.
|
92
|
+
*Clever::DataApi* | [**get_district_for_student**](docs/DataApi.md#get_district_for_student) | **GET** /students/{id}/district | Retrieves district information for a student.
|
93
|
+
*Clever::DataApi* | [**get_district_for_student_contact**](docs/DataApi.md#get_district_for_student_contact) | **GET** /contacts/{id}/district | Retrieves the district for a contact.
|
94
|
+
*Clever::DataApi* | [**get_district_for_teacher**](docs/DataApi.md#get_district_for_teacher) | **GET** /teachers/{id}/district | Retrieves district information for a teacher.
|
95
|
+
*Clever::DataApi* | [**get_districts**](docs/DataApi.md#get_districts) | **GET** /districts | Gets a list of districts you have access to.
|
96
|
+
*Clever::DataApi* | [**get_grade_levels_for_teacher**](docs/DataApi.md#get_grade_levels_for_teacher) | **GET** /teachers/{id}/grade_levels | Retrieves a list of all grade levels taught by a specific teacher.
|
97
|
+
*Clever::DataApi* | [**get_school**](docs/DataApi.md#get_school) | **GET** /schools/{id} | Get only a specific school's information.
|
98
|
+
*Clever::DataApi* | [**get_school_admin**](docs/DataApi.md#get_school_admin) | **GET** /school_admins/{id} | Get only a specific schooladmin's information.
|
99
|
+
*Clever::DataApi* | [**get_school_admins**](docs/DataApi.md#get_school_admins) | **GET** /school_admins | Gets a list of school_admins you have access to.
|
100
|
+
*Clever::DataApi* | [**get_school_for_section**](docs/DataApi.md#get_school_for_section) | **GET** /sections/{id}/school | Retrieves information about the school for a section
|
101
|
+
*Clever::DataApi* | [**get_school_for_student**](docs/DataApi.md#get_school_for_student) | **GET** /students/{id}/school | Retrieves information about the school for a student
|
102
|
+
*Clever::DataApi* | [**get_school_for_teacher**](docs/DataApi.md#get_school_for_teacher) | **GET** /teachers/{id}/school | Retrieves information about the school for a teacher
|
103
|
+
*Clever::DataApi* | [**get_schools**](docs/DataApi.md#get_schools) | **GET** /schools | Gets a list of schools you have access to.
|
104
|
+
*Clever::DataApi* | [**get_schools_for_school_admin**](docs/DataApi.md#get_schools_for_school_admin) | **GET** /school_admins/{id}/schools | Retrieves all schools for a school admin.
|
105
|
+
*Clever::DataApi* | [**get_section**](docs/DataApi.md#get_section) | **GET** /sections/{id} | Get only a specific section's information.
|
106
|
+
*Clever::DataApi* | [**get_sections**](docs/DataApi.md#get_sections) | **GET** /sections | Gets a list of sections you have access to.
|
107
|
+
*Clever::DataApi* | [**get_sections_for_school**](docs/DataApi.md#get_sections_for_school) | **GET** /schools/{id}/sections | Retrieves a list of all sections for a specific school.
|
108
|
+
*Clever::DataApi* | [**get_sections_for_student**](docs/DataApi.md#get_sections_for_student) | **GET** /students/{id}/sections | Retrieves a list of all sections for a student.
|
109
|
+
*Clever::DataApi* | [**get_sections_for_teacher**](docs/DataApi.md#get_sections_for_teacher) | **GET** /teachers/{id}/sections | Retrieves a list of all sections for a teacher.
|
110
|
+
*Clever::DataApi* | [**get_student**](docs/DataApi.md#get_student) | **GET** /students/{id} | Get only a specific student's information.
|
111
|
+
*Clever::DataApi* | [**get_student_for_contact**](docs/DataApi.md#get_student_for_contact) | **GET** /contacts/{id}/student | Retrieves the student for a contact.
|
112
|
+
*Clever::DataApi* | [**get_students**](docs/DataApi.md#get_students) | **GET** /students | Gets a list of students you have access to.
|
113
|
+
*Clever::DataApi* | [**get_students_for_school**](docs/DataApi.md#get_students_for_school) | **GET** /schools/{id}/students | Retrieves a list of all students for a specific school.
|
114
|
+
*Clever::DataApi* | [**get_students_for_section**](docs/DataApi.md#get_students_for_section) | **GET** /sections/{id}/students | Retrieves a list of all the section's students.
|
115
|
+
*Clever::DataApi* | [**get_students_for_teacher**](docs/DataApi.md#get_students_for_teacher) | **GET** /teachers/{id}/students | Retrieves all students that a teacher has in their sections.
|
116
|
+
*Clever::DataApi* | [**get_teacher**](docs/DataApi.md#get_teacher) | **GET** /teachers/{id} | Get only a specific teacher's information.
|
117
|
+
*Clever::DataApi* | [**get_teacher_for_section**](docs/DataApi.md#get_teacher_for_section) | **GET** /sections/{id}/teacher | Retrieves information about the primary teacher of a section.
|
118
|
+
*Clever::DataApi* | [**get_teachers**](docs/DataApi.md#get_teachers) | **GET** /teachers | Gets a list of teachers you have access to.
|
119
|
+
*Clever::DataApi* | [**get_teachers_for_school**](docs/DataApi.md#get_teachers_for_school) | **GET** /schools/{id}/teachers | Retrieves a list of all teachers for a specific school.
|
120
|
+
*Clever::DataApi* | [**get_teachers_for_section**](docs/DataApi.md#get_teachers_for_section) | **GET** /sections/{id}/teachers | Retrieves a list of all the section's teachers.
|
121
|
+
*Clever::DataApi* | [**get_teachers_for_student**](docs/DataApi.md#get_teachers_for_student) | **GET** /students/{id}/teachers | Retrieves all teachers for a student.
|
122
|
+
*Clever::EventsApi* | [**get_event**](docs/EventsApi.md#get_event) | **GET** /events/{id} | Retrieves a single event.
|
123
|
+
*Clever::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events | Retrieves all events
|
124
|
+
*Clever::EventsApi* | [**get_events_for_school**](docs/EventsApi.md#get_events_for_school) | **GET** /schools/{id}/events | Retrieves events for schools.
|
125
|
+
*Clever::EventsApi* | [**get_events_for_school_admin**](docs/EventsApi.md#get_events_for_school_admin) | **GET** /school_admins/{id}/events | Retrieves events for school_admins.
|
126
|
+
*Clever::EventsApi* | [**get_events_for_section**](docs/EventsApi.md#get_events_for_section) | **GET** /sections/{id}/events | Retrieves events for sections.
|
127
|
+
*Clever::EventsApi* | [**get_events_for_student**](docs/EventsApi.md#get_events_for_student) | **GET** /students/{id}/events | Retrieves events for students.
|
128
|
+
*Clever::EventsApi* | [**get_events_for_teacher**](docs/EventsApi.md#get_events_for_teacher) | **GET** /teachers/{id}/events | Retrieves events for teachers.
|
129
|
+
|
130
|
+
|
131
|
+
## Documentation for Models
|
132
|
+
|
133
|
+
- [Clever::BadRequest](docs/BadRequest.md)
|
134
|
+
- [Clever::District](docs/District.md)
|
135
|
+
- [Clever::DistrictAdmin](docs/DistrictAdmin.md)
|
136
|
+
- [Clever::DistrictAdminResponse](docs/DistrictAdminResponse.md)
|
137
|
+
- [Clever::DistrictAdminsResponse](docs/DistrictAdminsResponse.md)
|
138
|
+
- [Clever::DistrictObject](docs/DistrictObject.md)
|
139
|
+
- [Clever::DistrictResponse](docs/DistrictResponse.md)
|
140
|
+
- [Clever::DistrictStatus](docs/DistrictStatus.md)
|
141
|
+
- [Clever::DistrictStatusResponse](docs/DistrictStatusResponse.md)
|
142
|
+
- [Clever::DistrictsCreated](docs/DistrictsCreated.md)
|
143
|
+
- [Clever::DistrictsDeleted](docs/DistrictsDeleted.md)
|
144
|
+
- [Clever::DistrictsResponse](docs/DistrictsResponse.md)
|
145
|
+
- [Clever::DistrictsUpdated](docs/DistrictsUpdated.md)
|
146
|
+
- [Clever::Event](docs/Event.md)
|
147
|
+
- [Clever::EventResponse](docs/EventResponse.md)
|
148
|
+
- [Clever::EventsResponse](docs/EventsResponse.md)
|
149
|
+
- [Clever::GradeLevelsResponse](docs/GradeLevelsResponse.md)
|
150
|
+
- [Clever::InternalError](docs/InternalError.md)
|
151
|
+
- [Clever::Location](docs/Location.md)
|
152
|
+
- [Clever::Name](docs/Name.md)
|
153
|
+
- [Clever::NotFound](docs/NotFound.md)
|
154
|
+
- [Clever::Principal](docs/Principal.md)
|
155
|
+
- [Clever::School](docs/School.md)
|
156
|
+
- [Clever::SchoolAdmin](docs/SchoolAdmin.md)
|
157
|
+
- [Clever::SchoolAdminObject](docs/SchoolAdminObject.md)
|
158
|
+
- [Clever::SchoolAdminResponse](docs/SchoolAdminResponse.md)
|
159
|
+
- [Clever::SchoolAdminsResponse](docs/SchoolAdminsResponse.md)
|
160
|
+
- [Clever::SchoolObject](docs/SchoolObject.md)
|
161
|
+
- [Clever::SchoolResponse](docs/SchoolResponse.md)
|
162
|
+
- [Clever::SchooladminsCreated](docs/SchooladminsCreated.md)
|
163
|
+
- [Clever::SchooladminsDeleted](docs/SchooladminsDeleted.md)
|
164
|
+
- [Clever::SchooladminsUpdated](docs/SchooladminsUpdated.md)
|
165
|
+
- [Clever::SchoolsCreated](docs/SchoolsCreated.md)
|
166
|
+
- [Clever::SchoolsDeleted](docs/SchoolsDeleted.md)
|
167
|
+
- [Clever::SchoolsResponse](docs/SchoolsResponse.md)
|
168
|
+
- [Clever::SchoolsUpdated](docs/SchoolsUpdated.md)
|
169
|
+
- [Clever::Section](docs/Section.md)
|
170
|
+
- [Clever::SectionObject](docs/SectionObject.md)
|
171
|
+
- [Clever::SectionResponse](docs/SectionResponse.md)
|
172
|
+
- [Clever::SectionsCreated](docs/SectionsCreated.md)
|
173
|
+
- [Clever::SectionsDeleted](docs/SectionsDeleted.md)
|
174
|
+
- [Clever::SectionsResponse](docs/SectionsResponse.md)
|
175
|
+
- [Clever::SectionsUpdated](docs/SectionsUpdated.md)
|
176
|
+
- [Clever::Student](docs/Student.md)
|
177
|
+
- [Clever::StudentContact](docs/StudentContact.md)
|
178
|
+
- [Clever::StudentContactObject](docs/StudentContactObject.md)
|
179
|
+
- [Clever::StudentContactResponse](docs/StudentContactResponse.md)
|
180
|
+
- [Clever::StudentContactsResponse](docs/StudentContactsResponse.md)
|
181
|
+
- [Clever::StudentObject](docs/StudentObject.md)
|
182
|
+
- [Clever::StudentResponse](docs/StudentResponse.md)
|
183
|
+
- [Clever::StudentcontactsCreated](docs/StudentcontactsCreated.md)
|
184
|
+
- [Clever::StudentcontactsDeleted](docs/StudentcontactsDeleted.md)
|
185
|
+
- [Clever::StudentcontactsUpdated](docs/StudentcontactsUpdated.md)
|
186
|
+
- [Clever::StudentsCreated](docs/StudentsCreated.md)
|
187
|
+
- [Clever::StudentsDeleted](docs/StudentsDeleted.md)
|
188
|
+
- [Clever::StudentsResponse](docs/StudentsResponse.md)
|
189
|
+
- [Clever::StudentsUpdated](docs/StudentsUpdated.md)
|
190
|
+
- [Clever::Teacher](docs/Teacher.md)
|
191
|
+
- [Clever::TeacherObject](docs/TeacherObject.md)
|
192
|
+
- [Clever::TeacherResponse](docs/TeacherResponse.md)
|
193
|
+
- [Clever::TeachersCreated](docs/TeachersCreated.md)
|
194
|
+
- [Clever::TeachersDeleted](docs/TeachersDeleted.md)
|
195
|
+
- [Clever::TeachersResponse](docs/TeachersResponse.md)
|
196
|
+
- [Clever::TeachersUpdated](docs/TeachersUpdated.md)
|
197
|
+
- [Clever::Term](docs/Term.md)
|
198
|
+
|
199
|
+
|
200
|
+
## Documentation for Authorization
|
201
|
+
|
202
|
+
|
203
|
+
### oauth
|
204
|
+
|
205
|
+
- **Type**: OAuth
|
206
|
+
- **Flow**: accessCode
|
207
|
+
- **Authorization URL**: https://clever.com/oauth/authorize
|
208
|
+
- **Scopes**: N/A
|
97
209
|
|
98
|
-
1. Fork it
|
99
|
-
2. Create your feature branch (`git checkout -b my-new-feature`)
|
100
|
-
3. Commit your changes (`git add -p ./path/to/files; git commit -m 'Add some feature'`)
|
101
|
-
4. Push to the branch (`git push origin my-new-feature`)
|
102
|
-
5. Create new Pull Request
|
data/Rakefile
CHANGED
@@ -1,38 +1,8 @@
|
|
1
|
-
|
1
|
+
begin
|
2
|
+
require 'rspec/core/rake_task'
|
2
3
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
test.libs << 'test'
|
8
|
-
test.pattern = 'test/**/*_test.rb'
|
9
|
-
test.verbose = true
|
10
|
-
end
|
11
|
-
|
12
|
-
require 'yard'
|
13
|
-
require 'clever-ruby/version'
|
14
|
-
YARD::Rake::YardocTask.new :doc
|
15
|
-
|
16
|
-
require 'yardstick/rake/measurement'
|
17
|
-
Yardstick::Rake::Measurement.new(:'doc-coverage') do |measurement|
|
18
|
-
measurement.output = 'doc_coverage.txt'
|
19
|
-
end
|
20
|
-
|
21
|
-
require 'yardstick/rake/verify'
|
22
|
-
Yardstick::Rake::Verify.new(:'doc-coverage-verify') do |verify|
|
23
|
-
verify.threshold = 99.3
|
24
|
-
end
|
25
|
-
|
26
|
-
require 'rubocop/rake_task'
|
27
|
-
|
28
|
-
desc 'Run RuboCop on the lib directory'
|
29
|
-
RuboCop::RakeTask.new(:lint) do |task|
|
30
|
-
task.patterns = ['lib/**/*.rb', 'test/**/*.rb']
|
31
|
-
end
|
32
|
-
|
33
|
-
task default: [] do
|
34
|
-
Rake::Task[:test].execute
|
35
|
-
Rake::Task[:lint].execute
|
36
|
-
Rake::Task[:'doc-coverage'].execute
|
37
|
-
Rake::Task[:'doc-coverage-verify'].execute
|
4
|
+
RSpec::Core::RakeTask.new(:spec)
|
5
|
+
task default: :spec
|
6
|
+
rescue LoadError
|
7
|
+
# no rspec available
|
38
8
|
end
|
data/circle.yml
CHANGED
data/clever-ruby.gemspec
CHANGED
@@ -1,35 +1,45 @@
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
2
|
+
#
|
3
|
+
=begin
|
4
|
+
#Clever API
|
5
|
+
|
6
|
+
#The Clever API
|
7
|
+
|
8
|
+
OpenAPI spec version: 1.2.0
|
9
|
+
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
|
12
|
+
=end
|
13
|
+
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
15
|
+
require "clever-ruby/version"
|
16
|
+
|
17
|
+
Gem::Specification.new do |s|
|
18
|
+
s.name = "clever-ruby"
|
19
|
+
s.version = Clever::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["Swagger-Codegen"]
|
22
|
+
s.email = [""]
|
23
|
+
s.homepage = "https://github.com/swagger-api/swagger-codegen"
|
24
|
+
s.summary = "Clever API Ruby Gem"
|
25
|
+
s.description = "The Clever API"
|
26
|
+
# TODO uncommnet and update below with a proper license
|
27
|
+
#s.license = "Apache 2.0"
|
28
|
+
s.required_ruby_version = ">= 1.9"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
32
|
+
|
33
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
34
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
35
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
36
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
37
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
38
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
39
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
40
|
+
|
41
|
+
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
42
|
+
s.test_files = `find spec/*`.split("\n")
|
43
|
+
s.executables = []
|
44
|
+
s.require_paths = ["lib"]
|
35
45
|
end
|