aeries-api 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5769f47b9398392bf09682a8af92d464ebd319c5132e46d8e9d8339b93a1d4bd
-  data.tar.gz: 3d0608985d45651e4f7b9c6116c332ea8b8e7ef5e7b465e58f9a1f2e914c1a48
+  metadata.gz: 878d38ffffac76bf491d369d7bd8a3f9238b5ec30055ba5af5a01595251a9eb3
+  data.tar.gz: 4a149b37d5155e5411167fbc86e141adcc45efc82b2aa80c0ba77681e53424e6
 SHA512:
-  metadata.gz: 10080122370c9ad4295b97f80fdd5d16c18021a8aac7cd96e84919af9fe0ac6d9cfc617273ef66ac3a9b30de9ab309af77881bc5fbd0ba75bfa0f3e1efeb9621
-  data.tar.gz: 25847d47ba664b5bd69a6cfd5f7d4d2d3028ad8fbb0e701b25f0a1ebfc635b143230af5589b4643afc74a245789f8f2f9c1a95a523183bd006cf6de5933ab91d
+  metadata.gz: fbe805cc25342a4af2bf439c2affcfc0b405f21f1fa05e583a602f9bb801710eb894b56bcdd404ec2f83a84cafecb3daa9d5f985a299ab1ac96c8147c5c5444f
+  data.tar.gz: 7939d7a015af2fe09efebf9e9199d86d0bfa39fc9f2f7b774becfcb60758f98affa07dcb35dab1a9b58ff82c8d2462d78181b787f8dfcb4ea7ae75ab692eff32

data/lib/aeries-api.rb

@@ -3,5 +3,23 @@ require 'aeries-api/version'
 require 'aeries-api/client'
 
 module AeriesApi
-  class Error < StandardError; end
+  class ResponseError < StandardError
+    attr_accessor :response
+
+    def initialize(response)
+      message = response.parsed_response['Message']
+      super(message.length <= 50 ? message[0..50] : message)
+      @response = response
+    end
+  end
+
+  class AuthenticationError < ResponseError; end
+
+  class BadRequest < ResponseError; end
+
+  class Forbidden < ResponseError; end
+
+  class NotFound < ResponseError; end
+
+  class ServerError < ResponseError; end
 end

data/lib/aeries-api/client.rb

@@ -9,6 +9,7 @@ require 'aeries-api/client/student_groups'
 require 'aeries-api/client/student_pictures'
 require 'aeries-api/client/student_programs'
 require 'aeries-api/client/supplemental'
+require 'aeries-api/error_handler'
 
 module AeriesApi
   class Client
@@ -24,6 +25,8 @@ module AeriesApi
     format :json
 
     def initialize(aeries_cert: nil, base_uri: nil)
+      @error_handler = AeriesApi::ErrorHandler.new
+
       aeries_cert ||= ENV['AERIES_CERT']
       base_uri ||= ENV['AERIES_BASE_URI']
 

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

@@ -3,6 +3,7 @@ module AeriesApi
     module Contacts
       def contacts(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/contacts/#{student_id}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,11 +3,13 @@ module AeriesApi
     module Schools
       def school(school_code:)
         response = self.class.get("/schools/#{school_code}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
 
       def schools
         response = self.class.get('/schools')
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,6 +3,7 @@ module AeriesApi
     module StudentGroups
       def student_groups(school_code:)
         response = self.class.get("/schools/#{school_code}/studentgroups")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,11 +3,13 @@ module AeriesApi
     module StudentPictures
       def student_picture(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/studentpictures/#{student_id}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
 
       def student_pictures(school_code:)
         response = self.class.get("/schools/#{school_code}/studentpictures")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,6 +3,7 @@ module AeriesApi
     module StudentPrograms
       def student_programs(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/students/#{student_id}/programs")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,6 +3,7 @@ module AeriesApi
     module Students
       def student(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/students/#{student_id}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
 
@@ -13,6 +14,7 @@ module AeriesApi
           endpoint = "/schools/#{school_code}/students"
         end
         response = self.class.get(endpoint)
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

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

@@ -3,11 +3,13 @@ module AeriesApi
     module Supplemental
       def school_supplemental(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/schoolsupplemental/#{student_id}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
 
       def district_supplemental(school_code:, student_id:)
         response = self.class.get("/schools/#{school_code}/districtsupplemental/#{student_id}")
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
 
@@ -17,6 +19,7 @@ module AeriesApi
         }
 
         response = self.class.post("/updateschoolsupplemental/#{school_code}/#{student_number}", options)
+        @error_handler.handle_error(response)
         mash_and_underscore_keys(response.parsed_response)
       end
     end

data/lib/aeries-api/error_handler.rb

@@ -0,0 +1,22 @@
+module AeriesApi
+  class ErrorHandler
+    def handle_error(response)
+      return if response.success?
+      raise http_errors[response.code].new(response)
+    end
+
+    private
+
+    def http_errors
+      {
+        400 => AeriesApi::BadRequest,
+        401 => AeriesApi::AuthenticationError,
+        404 => AeriesApi::NotFound,
+        500 => AeriesApi::ServerError,
+        502 => AeriesApi::ServerError,
+        503 => AeriesApi::ServerError,
+        504 => AeriesApi::ServerError,
+      }
+    end
+  end
+end

data/lib/aeries-api/version.rb

@@ -1,3 +1,3 @@
 module AeriesApi
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aeries-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Derek Povah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - lib/aeries-api/client/student_programs.rb
 - lib/aeries-api/client/students.rb
 - lib/aeries-api/client/supplemental.rb
+- lib/aeries-api/error_handler.rb
 - lib/aeries-api/version.rb
 homepage: https://github.com/derekpovah/aeries-api
 licenses:
@@ -185,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: A simple REST client for the Aeries SIS API