aeries-api 0.2.0 → 1.0.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 (7) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -14
  3. data/aeries-api.gemspec +1 -1
  4. data/lib/aeries-api/client.rb +2 -0
  5. data/lib/aeries-api/client/student_programs.rb +14 -0
  6. data/lib/aeries-api/version.rb +1 -1
  7. metadata +6 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e692f94cd8e689c675f41bb47fc09f63c53e3047292bab665da23c726f1c7ebe
4
- data.tar.gz: c54d14db243e3482e2b4c576d088175689880a77b78fab23f238fe5efcf32a4c
3
+ metadata.gz: dcf4182463fc330866a355e0dffd558a035c1a709b51b9a52ec5d33bdecb0064
4
+ data.tar.gz: 8c414cb1684e53d7aedd795a0fcb85c6512417cd828098eac8bb067483be35ee
5
5
  SHA512:
6
- metadata.gz: 322ef154e740fb8f27141c2d823be0cc3bba3e0a9a42cdd913efd914c9a82caee9551023d6a0ba99fc523add917c212ef5f0391ab413a4cdc9cd99db7a7119eb
7
- data.tar.gz: 52fec14b017afeeb62bc6336fbdc1c3ff8b9448fe2db0a47edaa5943abba49cb1e3c1bf3bf2386ff20d1a4f93b33d83364b623ee3c07773b3e10b5ba14cd3fc5
6
+ metadata.gz: 0fbf1909fbb8fadd6c6fcfe42e9d0023eb813fb39a3d008747b5cde0784117ad066996774f342d57f0f7227a07e8da19a3f5035f07f2511273b2c3a812999dba
7
+ data.tar.gz: 2e400f9644398c6997d3d111d2eca2fa314e3dc204f4bba4b0b089792920b8bf218c21b6705b4cc8730c883c40eb881015a0b7bf881c5ec1ed8f67aca53396c4
data/README.md CHANGED
@@ -22,9 +22,9 @@ Usage
22
22
  Initialize the client:
23
23
 
24
24
  ```ruby
25
- aeries = Aeries::Api::Client.new(
25
+ aeries = AeriesApi::Client.new(
26
26
  aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
27
- base_uri: ' https://demo.aeries.net/aeries/api/v3'
27
+ base_uri: ' https://demo.aeries.net/aeries/api/v5'
28
28
  )
29
29
  ```
30
30
 
@@ -32,14 +32,14 @@ The client can also be configured via the environment:
32
32
 
33
33
  ```ruby
34
34
  ENV['AERIES_CERT'] = '477abe9e7d27439681d62f4e0de1f5e1'
35
- ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v3'
35
+ ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v5'
36
36
 
37
- aeries = Aeries::Api::Client.new
37
+ aeries = AeriesApi::Client.new
38
38
  ```
39
39
 
40
40
  #### Retrieving Data
41
41
 
42
- Most endpoints will require a school code to be passed as the first argument. Keyword arguments are then used to pass additional data to the API. Example:
42
+ Most endpoints require a school code so it should be passed as an argument. Keyword arguments are then used to pass additional data to the API. Example:
43
43
 
44
44
  ```ruby
45
45
  aeries.students(school_code: 99, grade_level: 4)
@@ -48,32 +48,35 @@ aeries.students(school_code: 99, grade_level: 4)
48
48
  Available Methods:
49
49
 
50
50
  ```ruby
51
- # /api/v3/schools
51
+ # /api/v5/schools
52
52
  schools # returns all schools
53
53
 
54
- # /api/v3/schools/#{school_code}
54
+ # /api/v5/schools/#{school_code}
55
55
  school(school_code: school_code) # returns a single school
56
56
 
57
- # /api/v3/schools/#{school_code}/StudentGroups
57
+ # /api/v5/schools/#{school_code}/StudentGroups
58
58
  student_groups(school_code: school_code) # returns all student groups at a school
59
59
 
60
- # /api/v3/schools/#{school_code}/students
60
+ # /api/v5/schools/#{school_code}/students
61
61
  students(school_code: school_code) # returns all students at a school
62
62
 
63
- # /api/v3/schools/#{school_code}/students/grade/#{grade_level}
63
+ # /api/v5/schools/#{school_code}/students/grade/#{grade_level}
64
64
  students(school_code: school_code, grade_level: grade_level) # returns students in a specific grade level
65
65
 
66
- # /api/v3/schools/#{school_code}/students/#{student_id}
66
+ # /api/v5/schools/#{school_code}/students/#{student_id}
67
67
  student(school_code: school_code, student_id: student_id) # returns a single student
68
68
 
69
- # /api/schools/#{school_code}/contacts/#{student_id}
69
+ # /api/v5/schools/#{school_code}/contacts/#{student_id}
70
70
  contacts(school_code: school_code, student_id: student_id) # returns contacts for a student
71
71
 
72
- # /api/schools/#{school_code}/StudentPictures
72
+ # /api/v5/schools/#{school_code}/StudentPictures
73
73
  student_picture(school_code: school_code) # returns all student pictures at a school
74
74
 
75
- # /api/schools/#{school_code}/StudentPictures/#{student_id}
75
+ # /api/v5/schools/#{school_code}/StudentPictures/#{student_id}
76
76
  student_pictures(school_code: school_code, student_id: student_id) # returns a single student's picture
77
+
78
+ # /api/v5/schools/#{school_code}/students/#{student_id}/programs
79
+ student_programs(school_code: school_code, student_id: student_id) # returns a single student's picture
77
80
  ```
78
81
 
79
82
  License
data/aeries-api.gemspec CHANGED
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
32
32
  spec.required_ruby_version = '>= 2.4.0'
33
33
 
34
34
  spec.add_development_dependency 'bundler'
35
- spec.add_development_dependency 'rake', "~> 10.0"
35
+ spec.add_development_dependency 'rake', "~> 12.3.3"
36
36
  spec.add_development_dependency 'rspec', "~> 3.0"
37
37
  spec.add_development_dependency 'pry'
38
38
  spec.add_development_dependency 'sinatra'
data/lib/aeries-api/client.rb CHANGED
@@ -7,6 +7,7 @@ require 'aeries-api/client/schools'
7
7
  require 'aeries-api/client/students'
8
8
  require 'aeries-api/client/student_groups'
9
9
  require 'aeries-api/client/student_pictures'
10
+ require 'aeries-api/client/student_programs'
10
11
 
11
12
  module AeriesApi
12
13
  class Client
@@ -16,6 +17,7 @@ module AeriesApi
16
17
  include AeriesApi::Client::Students
17
18
  include AeriesApi::Client::StudentGroups
18
19
  include AeriesApi::Client::StudentPictures
20
+ include AeriesApi::Client::StudentPrograms
19
21
 
20
22
  format :json
21
23
 
data/lib/aeries-api/client/student_programs.rb ADDED
@@ -0,0 +1,14 @@
1
+ module AeriesApi
2
+ class Client
3
+
4
+ module StudentPrograms
5
+
6
+ def student_programs(school_code:, student_id:)
7
+ response = self.class.get("/schools/#{school_code}/students/#{student_id}/programs")
8
+ mash_and_underscore_keys(response.parsed_response)
9
+ end
10
+
11
+ end
12
+
13
+ end
14
+ end
data/lib/aeries-api/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module AeriesApi
2
- VERSION = '0.2.0'
2
+ VERSION = '1.0.0'
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aeries-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Derek Povah
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2019-12-05 00:00:00.000000000 Z
11
+ date: 2020-10-07 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -30,14 +30,14 @@ dependencies:
30
30
  requirements:
31
31
  - - "~>"
32
32
  - !ruby/object:Gem::Version
33
- version: '10.0'
33
+ version: 12.3.3
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - "~>"
39
39
  - !ruby/object:Gem::Version
40
- version: '10.0'
40
+ version: 12.3.3
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: rspec
43
43
  requirement: !ruby/object:Gem::Requirement
@@ -159,6 +159,7 @@ files:
159
159
  - lib/aeries-api/client/schools.rb
160
160
  - lib/aeries-api/client/student_groups.rb
161
161
  - lib/aeries-api/client/student_pictures.rb
162
+ - lib/aeries-api/client/student_programs.rb
162
163
  - lib/aeries-api/client/students.rb
163
164
  - lib/aeries-api/version.rb
164
165
  homepage: https://github.com/derekpovah/aeries-api
@@ -183,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
183
184
  - !ruby/object:Gem::Version
184
185
  version: '0'
185
186
  requirements: []
186
- rubygems_version: 3.0.3
187
+ rubygems_version: 3.1.2
187
188
  signing_key:
188
189
  specification_version: 4
189
190
  summary: A simple REST client for the Aeries SIS API