aeries-api 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e692f94cd8e689c675f41bb47fc09f63c53e3047292bab665da23c726f1c7ebe
-  data.tar.gz: c54d14db243e3482e2b4c576d088175689880a77b78fab23f238fe5efcf32a4c
+  metadata.gz: dcf4182463fc330866a355e0dffd558a035c1a709b51b9a52ec5d33bdecb0064
+  data.tar.gz: 8c414cb1684e53d7aedd795a0fcb85c6512417cd828098eac8bb067483be35ee
 SHA512:
-  metadata.gz: 322ef154e740fb8f27141c2d823be0cc3bba3e0a9a42cdd913efd914c9a82caee9551023d6a0ba99fc523add917c212ef5f0391ab413a4cdc9cd99db7a7119eb
-  data.tar.gz: 52fec14b017afeeb62bc6336fbdc1c3ff8b9448fe2db0a47edaa5943abba49cb1e3c1bf3bf2386ff20d1a4f93b33d83364b623ee3c07773b3e10b5ba14cd3fc5
+  metadata.gz: 0fbf1909fbb8fadd6c6fcfe42e9d0023eb813fb39a3d008747b5cde0784117ad066996774f342d57f0f7227a07e8da19a3f5035f07f2511273b2c3a812999dba
+  data.tar.gz: 2e400f9644398c6997d3d111d2eca2fa314e3dc204f4bba4b0b089792920b8bf218c21b6705b4cc8730c883c40eb881015a0b7bf881c5ec1ed8f67aca53396c4

data/README.md

@@ -22,9 +22,9 @@ Usage
 Initialize the client:
 
 ```ruby
-aeries = Aeries::Api::Client.new(
+aeries = AeriesApi::Client.new(
   aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
-  base_uri: ' https://demo.aeries.net/aeries/api/v3'
+  base_uri: ' https://demo.aeries.net/aeries/api/v5'
 )
 ```
 
@@ -32,14 +32,14 @@ The client can also be configured via the environment:
 
 ```ruby
 ENV['AERIES_CERT'] = '477abe9e7d27439681d62f4e0de1f5e1'
-ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v3'
+ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v5'
 
-aeries = Aeries::Api::Client.new
+aeries = AeriesApi::Client.new
 ```
 
 #### Retrieving Data
 
-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:
+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:
 
 ```ruby
 aeries.students(school_code: 99, grade_level: 4)
@@ -48,32 +48,35 @@ aeries.students(school_code: 99, grade_level: 4)
 Available Methods:
 
 ```ruby
-# /api/v3/schools
+# /api/v5/schools
 schools # returns all schools
 
-# /api/v3/schools/#{school_code}
+# /api/v5/schools/#{school_code}
 school(school_code: school_code) # returns a single school
 
-# /api/v3/schools/#{school_code}/StudentGroups
+# /api/v5/schools/#{school_code}/StudentGroups
 student_groups(school_code: school_code) # returns all student groups at a school
 
-# /api/v3/schools/#{school_code}/students
+# /api/v5/schools/#{school_code}/students
 students(school_code: school_code) # returns all students at a school
 
-# /api/v3/schools/#{school_code}/students/grade/#{grade_level}
+# /api/v5/schools/#{school_code}/students/grade/#{grade_level}
 students(school_code: school_code, grade_level: grade_level) # returns students in a specific grade level
 
-# /api/v3/schools/#{school_code}/students/#{student_id}
+# /api/v5/schools/#{school_code}/students/#{student_id}
 student(school_code: school_code, student_id: student_id) # returns a single student
 
-# /api/schools/#{school_code}/contacts/#{student_id}
+# /api/v5/schools/#{school_code}/contacts/#{student_id}
 contacts(school_code: school_code, student_id: student_id) # returns contacts for a student
 
-# /api/schools/#{school_code}/StudentPictures
+# /api/v5/schools/#{school_code}/StudentPictures
 student_picture(school_code: school_code) # returns all student pictures at a school
 
-# /api/schools/#{school_code}/StudentPictures/#{student_id}
+# /api/v5/schools/#{school_code}/StudentPictures/#{student_id}
 student_pictures(school_code: school_code, student_id: student_id) # returns a single student's picture
+
+# /api/v5/schools/#{school_code}/students/#{student_id}/programs
+student_programs(school_code: school_code, student_id: student_id) # returns a single student's picture
 ```
 
 License

data/aeries-api.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.4.0'
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rake', "~> 12.3.3"
   spec.add_development_dependency 'rspec', "~> 3.0"
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'sinatra'

data/lib/aeries-api/client.rb

@@ -7,6 +7,7 @@ require 'aeries-api/client/schools'
 require 'aeries-api/client/students'
 require 'aeries-api/client/student_groups'
 require 'aeries-api/client/student_pictures'
+require 'aeries-api/client/student_programs'
 
 module AeriesApi
   class Client
@@ -16,6 +17,7 @@ module AeriesApi
     include AeriesApi::Client::Students
     include AeriesApi::Client::StudentGroups
     include AeriesApi::Client::StudentPictures
+    include AeriesApi::Client::StudentPrograms
 
     format :json
 

data/lib/aeries-api/client/student_programs.rb

@@ -0,0 +1,14 @@
+module AeriesApi
+  class Client
+
+    module StudentPrograms
+
+      def student_programs(school_code:, student_id:)
+        response = self.class.get("/schools/#{school_code}/students/#{student_id}/programs")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+    end
+
+  end
+end

data/lib/aeries-api/version.rb

@@ -1,3 +1,3 @@
 module AeriesApi
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aeries-api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Derek Povah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-05 00:00:00.000000000 Z
+date: 2020-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -159,6 +159,7 @@ files:
 - lib/aeries-api/client/schools.rb
 - lib/aeries-api/client/student_groups.rb
 - lib/aeries-api/client/student_pictures.rb
+- lib/aeries-api/client/student_programs.rb
 - lib/aeries-api/client/students.rb
 - lib/aeries-api/version.rb
 homepage: https://github.com/derekpovah/aeries-api
@@ -183,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the Aeries SIS API