aeries-api 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +3 -0
- data/.travis.yml +8 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +82 -0
- data/Rakefile +6 -0
- data/aeries-api.gemspec +44 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/aeries-api.rb +7 -0
- data/lib/aeries-api/client.rb +41 -0
- data/lib/aeries-api/client/contacts.rb +14 -0
- data/lib/aeries-api/client/schools.rb +19 -0
- data/lib/aeries-api/client/student_groups.rb +14 -0
- data/lib/aeries-api/client/student_pictures.rb +19 -0
- data/lib/aeries-api/client/students.rb +24 -0
- data/lib/aeries-api/version.rb +3 -0
- metadata +190 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: e692f94cd8e689c675f41bb47fc09f63c53e3047292bab665da23c726f1c7ebe
|
4
|
+
data.tar.gz: c54d14db243e3482e2b4c576d088175689880a77b78fab23f238fe5efcf32a4c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 322ef154e740fb8f27141c2d823be0cc3bba3e0a9a42cdd913efd914c9a82caee9551023d6a0ba99fc523add917c212ef5f0391ab413a4cdc9cd99db7a7119eb
|
7
|
+
data.tar.gz: 52fec14b017afeeb62bc6336fbdc1c3ff8b9448fe2db0a47edaa5943abba49cb1e3c1bf3bf2386ff20d1a4f93b33d83364b623ee3c07773b3e10b5ba14cd3fc5
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Derek Povah
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,82 @@
|
|
1
|
+
aeries-api
|
2
|
+
==========
|
3
|
+
|
4
|
+
This gem provides an interface to the [Aeries SIS API](https://support.aeries.com/support/solutions/articles/14000077926-aeries-api-full-documentation).
|
5
|
+
|
6
|
+
I will implement endpoints as I need them, but will also consider pull requests that add support for additional endpoints. At the time of writing, this gem is designed to be used with version 3 of the Aeries API.
|
7
|
+
|
8
|
+
Installation
|
9
|
+
------------
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
gem 'aeries-api'
|
15
|
+
```
|
16
|
+
|
17
|
+
Usage
|
18
|
+
-----
|
19
|
+
|
20
|
+
#### Setup
|
21
|
+
|
22
|
+
Initialize the client:
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
aeries = Aeries::Api::Client.new(
|
26
|
+
aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
|
27
|
+
base_uri: ' https://demo.aeries.net/aeries/api/v3'
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
31
|
+
The client can also be configured via the environment:
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
ENV['AERIES_CERT'] = '477abe9e7d27439681d62f4e0de1f5e1'
|
35
|
+
ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v3'
|
36
|
+
|
37
|
+
aeries = Aeries::Api::Client.new
|
38
|
+
```
|
39
|
+
|
40
|
+
#### Retrieving Data
|
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:
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
aeries.students(school_code: 99, grade_level: 4)
|
46
|
+
```
|
47
|
+
|
48
|
+
Available Methods:
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
# /api/v3/schools
|
52
|
+
schools # returns all schools
|
53
|
+
|
54
|
+
# /api/v3/schools/#{school_code}
|
55
|
+
school(school_code: school_code) # returns a single school
|
56
|
+
|
57
|
+
# /api/v3/schools/#{school_code}/StudentGroups
|
58
|
+
student_groups(school_code: school_code) # returns all student groups at a school
|
59
|
+
|
60
|
+
# /api/v3/schools/#{school_code}/students
|
61
|
+
students(school_code: school_code) # returns all students at a school
|
62
|
+
|
63
|
+
# /api/v3/schools/#{school_code}/students/grade/#{grade_level}
|
64
|
+
students(school_code: school_code, grade_level: grade_level) # returns students in a specific grade level
|
65
|
+
|
66
|
+
# /api/v3/schools/#{school_code}/students/#{student_id}
|
67
|
+
student(school_code: school_code, student_id: student_id) # returns a single student
|
68
|
+
|
69
|
+
# /api/schools/#{school_code}/contacts/#{student_id}
|
70
|
+
contacts(school_code: school_code, student_id: student_id) # returns contacts for a student
|
71
|
+
|
72
|
+
# /api/schools/#{school_code}/StudentPictures
|
73
|
+
student_picture(school_code: school_code) # returns all student pictures at a school
|
74
|
+
|
75
|
+
# /api/schools/#{school_code}/StudentPictures/#{student_id}
|
76
|
+
student_pictures(school_code: school_code, student_id: student_id) # returns a single student's picture
|
77
|
+
```
|
78
|
+
|
79
|
+
License
|
80
|
+
-------
|
81
|
+
|
82
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/aeries-api.gemspec
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'aeries-api/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'aeries-api'
|
8
|
+
spec.version = AeriesApi::VERSION
|
9
|
+
spec.authors = ['Derek Povah']
|
10
|
+
spec.email = ['derek@derekpovah.com']
|
11
|
+
|
12
|
+
spec.summary = %q{A simple REST client for the Aeries SIS API}
|
13
|
+
spec.homepage = 'https://github.com/derekpovah/aeries-api'
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
if spec.respond_to?(:metadata)
|
17
|
+
spec.metadata['allowed_push_host'] = 'https://rubygems.org'
|
18
|
+
|
19
|
+
spec.metadata['homepage_uri'] = spec.homepage
|
20
|
+
spec.metadata['source_code_uri'] = spec.homepage
|
21
|
+
else
|
22
|
+
raise 'RubyGems 2.0 or newer is required to protect against ' \
|
23
|
+
'public gem pushes.'
|
24
|
+
end
|
25
|
+
|
26
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
27
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
28
|
+
end
|
29
|
+
spec.bindir = 'exe'
|
30
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
31
|
+
spec.require_paths = ['lib']
|
32
|
+
spec.required_ruby_version = '>= 2.4.0'
|
33
|
+
|
34
|
+
spec.add_development_dependency 'bundler'
|
35
|
+
spec.add_development_dependency 'rake', "~> 10.0"
|
36
|
+
spec.add_development_dependency 'rspec', "~> 3.0"
|
37
|
+
spec.add_development_dependency 'pry'
|
38
|
+
spec.add_development_dependency 'sinatra'
|
39
|
+
spec.add_development_dependency 'webmock'
|
40
|
+
|
41
|
+
spec.add_dependency 'activesupport'
|
42
|
+
spec.add_dependency 'hashie'
|
43
|
+
spec.add_dependency 'httparty'
|
44
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require 'bundler/setup'
|
4
|
+
require 'aeries/api'
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require 'irb'
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/lib/aeries-api.rb
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
require 'active_support/core_ext/string/inflections'
|
2
|
+
require 'active_support/core_ext/hash/keys'
|
3
|
+
require 'hashie'
|
4
|
+
|
5
|
+
require 'aeries-api/client/contacts'
|
6
|
+
require 'aeries-api/client/schools'
|
7
|
+
require 'aeries-api/client/students'
|
8
|
+
require 'aeries-api/client/student_groups'
|
9
|
+
require 'aeries-api/client/student_pictures'
|
10
|
+
|
11
|
+
module AeriesApi
|
12
|
+
class Client
|
13
|
+
include HTTParty
|
14
|
+
include AeriesApi::Client::Contacts
|
15
|
+
include AeriesApi::Client::Schools
|
16
|
+
include AeriesApi::Client::Students
|
17
|
+
include AeriesApi::Client::StudentGroups
|
18
|
+
include AeriesApi::Client::StudentPictures
|
19
|
+
|
20
|
+
format :json
|
21
|
+
|
22
|
+
def initialize(aeries_cert: nil, base_uri: nil)
|
23
|
+
aeries_cert ||= ENV['AERIES_CERT']
|
24
|
+
base_uri ||= ENV['AERIES_BASE_URI']
|
25
|
+
|
26
|
+
self.class.default_options.merge!(headers: { 'AERIES-CERT': aeries_cert }, base_uri: base_uri)
|
27
|
+
end
|
28
|
+
|
29
|
+
private
|
30
|
+
|
31
|
+
def mash_and_underscore_keys(parsed_response)
|
32
|
+
new_response = []
|
33
|
+
parsed_response.each_with_object(new_response) do |r, a|
|
34
|
+
r.deep_transform_keys! { |k| k.to_s.underscore }
|
35
|
+
a << Hashie::Mash.new(r)
|
36
|
+
end
|
37
|
+
return new_response
|
38
|
+
end
|
39
|
+
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
module AeriesApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
module Contacts
|
5
|
+
|
6
|
+
def contacts(school_code:, student_id:)
|
7
|
+
response = self.class.get("/schools/#{school_code}/contacts/#{student_id}")
|
8
|
+
mash_and_underscore_keys(response.parsed_response)
|
9
|
+
end
|
10
|
+
|
11
|
+
end
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module AeriesApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
module Schools
|
5
|
+
|
6
|
+
def school(school_code:)
|
7
|
+
response = self.class.get("/schools/#{school_code}")
|
8
|
+
mash_and_underscore_keys(response.parsed_response)
|
9
|
+
end
|
10
|
+
|
11
|
+
def schools
|
12
|
+
response = self.class.get("/schools")
|
13
|
+
mash_and_underscore_keys(response.parsed_response)
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module AeriesApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
module StudentPictures
|
5
|
+
|
6
|
+
def student_picture(school_code:, student_id:)
|
7
|
+
response = self.class.get("/schools/#{school_code}/studentpictures/#{student_id}")
|
8
|
+
mash_and_underscore_keys(response.parsed_response)
|
9
|
+
end
|
10
|
+
|
11
|
+
def student_pictures(school_code:)
|
12
|
+
response = self.class.get("/schools/#{school_code}/studentpictures")
|
13
|
+
mash_and_underscore_keys(response.parsed_response)
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
17
|
+
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
module AeriesApi
|
2
|
+
class Client
|
3
|
+
|
4
|
+
module Students
|
5
|
+
|
6
|
+
def student(school_code:, student_id:)
|
7
|
+
response = self.class.get("/schools/#{school_code}/students/#{student_id}")
|
8
|
+
mash_and_underscore_keys(response.parsed_response)
|
9
|
+
end
|
10
|
+
|
11
|
+
def students(school_code:, grade: nil)
|
12
|
+
if grade
|
13
|
+
endpoint = "/schools/#{school_code}/students/grade/#{grade}"
|
14
|
+
else
|
15
|
+
endpoint = "/schools/#{school_code}/students"
|
16
|
+
end
|
17
|
+
response = self.class.get(endpoint)
|
18
|
+
mash_and_underscore_keys(response.parsed_response)
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,190 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aeries-api
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Derek Povah
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-12-05 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: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
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: pry
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
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: sinatra
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: webmock
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: activesupport
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :runtime
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: hashie
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :runtime
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: httparty
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
type: :runtime
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
description:
|
140
|
+
email:
|
141
|
+
- derek@derekpovah.com
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".gitignore"
|
147
|
+
- ".rspec"
|
148
|
+
- ".travis.yml"
|
149
|
+
- Gemfile
|
150
|
+
- LICENSE.txt
|
151
|
+
- README.md
|
152
|
+
- Rakefile
|
153
|
+
- aeries-api.gemspec
|
154
|
+
- bin/console
|
155
|
+
- bin/setup
|
156
|
+
- lib/aeries-api.rb
|
157
|
+
- lib/aeries-api/client.rb
|
158
|
+
- lib/aeries-api/client/contacts.rb
|
159
|
+
- lib/aeries-api/client/schools.rb
|
160
|
+
- lib/aeries-api/client/student_groups.rb
|
161
|
+
- lib/aeries-api/client/student_pictures.rb
|
162
|
+
- lib/aeries-api/client/students.rb
|
163
|
+
- lib/aeries-api/version.rb
|
164
|
+
homepage: https://github.com/derekpovah/aeries-api
|
165
|
+
licenses:
|
166
|
+
- MIT
|
167
|
+
metadata:
|
168
|
+
allowed_push_host: https://rubygems.org
|
169
|
+
homepage_uri: https://github.com/derekpovah/aeries-api
|
170
|
+
source_code_uri: https://github.com/derekpovah/aeries-api
|
171
|
+
post_install_message:
|
172
|
+
rdoc_options: []
|
173
|
+
require_paths:
|
174
|
+
- lib
|
175
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
176
|
+
requirements:
|
177
|
+
- - ">="
|
178
|
+
- !ruby/object:Gem::Version
|
179
|
+
version: 2.4.0
|
180
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
181
|
+
requirements:
|
182
|
+
- - ">="
|
183
|
+
- !ruby/object:Gem::Version
|
184
|
+
version: '0'
|
185
|
+
requirements: []
|
186
|
+
rubygems_version: 3.0.3
|
187
|
+
signing_key:
|
188
|
+
specification_version: 4
|
189
|
+
summary: A simple REST client for the Aeries SIS API
|
190
|
+
test_files: []
|