aeries-api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 878d38ffffac76bf491d369d7bd8a3f9238b5ec30055ba5af5a01595251a9eb3
-  data.tar.gz: 4a149b37d5155e5411167fbc86e141adcc45efc82b2aa80c0ba77681e53424e6
+  metadata.gz: a3c2dfe4a1a36e7e4dae6997fca6c6ed51bee6a0e224f2bc3a06b886d051d873
+  data.tar.gz: b0025b4018cb3b7da024990b163684eefc99f364466a1e63dd2206fcdc6f55ad
 SHA512:
-  metadata.gz: fbe805cc25342a4af2bf439c2affcfc0b405f21f1fa05e583a602f9bb801710eb894b56bcdd404ec2f83a84cafecb3daa9d5f985a299ab1ac96c8147c5c5444f
-  data.tar.gz: 7939d7a015af2fe09efebf9e9199d86d0bfa39fc9f2f7b774becfcb60758f98affa07dcb35dab1a9b58ff82c8d2462d78181b787f8dfcb4ea7ae75ab692eff32
+  metadata.gz: 8421dd38a16a6d141d3122359983c50ddffe29b760686eb80fb7f0a017905c10e9c560219ca618ddca80447ecc674f42a0af3a4a7d6887f9e8bf073c4f43a53d
+  data.tar.gz: baab9f86b3761139ddb06e84a5cd8fc2a99f060561fca03fdd8bf0dafe9a879fa34d3d735de0db01a0d5b20e7589b063749cbd71e2d5232c3bdbf024949f0ec7

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aeries-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Derek Povah
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2025-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,44 +126,23 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '0.21'
+description:
 email:
 - derek@derekpovah.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- aeries-api.gemspec
-- bin/console
-- bin/setup
-- lib/aeries-api.rb
-- lib/aeries-api/client.rb
-- lib/aeries-api/client/contacts.rb
-- 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/client/supplemental.rb
-- lib/aeries-api/error_handler.rb
-- lib/aeries-api/version.rb
+files: []
 homepage: https://github.com/derekpovah/aeries-api
 licenses:
 - MIT
@@ -171,7 +150,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/derekpovah/aeries-api
   source_code_uri: https://github.com/derekpovah/aeries-api
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: A simple REST client for the Aeries SIS API
 test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-Gemfile.lock
-.ruby-version
-*.gem
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-sudo: false
-cache: bundler
-
-script: bundle exec rake spec
-
-rvm:
-  - 2.6.4

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in aeries-api.gemspec
-gemspec

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Derek Povah
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/README.md

@@ -1,85 +0,0 @@
-aeries-api
-==========
-
-This gem provides an interface to the [Aeries SIS API](https://support.aeries.com/support/solutions/articles/14000077926-aeries-api-full-documentation).
-
-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.
-
-Installation
-------------
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'aeries-api'
-```
-
-Usage
------
-
-#### Setup
-
-Initialize the client:
-
-```ruby
-aeries = AeriesApi::Client.new(
-  aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
-  base_uri: ' https://demo.aeries.net/aeries/api/v5'
-)
-```
-
-The client can also be configured via the environment:
-
-```ruby
-ENV['AERIES_CERT'] = '477abe9e7d27439681d62f4e0de1f5e1'
-ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v5'
-
-aeries = AeriesApi::Client.new
-```
-
-#### Retrieving Data
-
-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)
-```
-
-Available Methods:
-
-```ruby
-# /api/v5/schools
-schools # returns all schools
-
-# /api/v5/schools/#{school_code}
-school(school_code: school_code) # returns a single school
-
-# /api/v5/schools/#{school_code}/StudentGroups
-student_groups(school_code: school_code) # returns all student groups at a school
-
-# /api/v5/schools/#{school_code}/students
-students(school_code: school_code) # returns all students at a school
-
-# /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/v5/schools/#{school_code}/students/#{student_id}
-student(school_code: school_code, student_id: student_id) # returns a single student
-
-# /api/v5/schools/#{school_code}/contacts/#{student_id}
-contacts(school_code: school_code, student_id: student_id) # returns contacts for a student
-
-# /api/v5/schools/#{school_code}/StudentPictures
-student_picture(school_code: school_code) # returns all student pictures at a school
-
-# /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
--------
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/aeries-api.gemspec

@@ -1,44 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'aeries-api/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'aeries-api'
-  spec.version       = AeriesApi::VERSION
-  spec.authors       = ['Derek Povah']
-  spec.email         = ['derek@derekpovah.com']
-
-  spec.summary       = %q{A simple REST client for the Aeries SIS API}
-  spec.homepage      = 'https://github.com/derekpovah/aeries-api'
-  spec.license       = 'MIT'
-
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-    spec.metadata['homepage_uri'] = spec.homepage
-    spec.metadata['source_code_uri'] = spec.homepage
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4.0'
-
-  spec.add_development_dependency 'bundler'
-  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'
-  spec.add_development_dependency 'webmock'
-
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'httparty'
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'aeries/api'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

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

@@ -1,11 +0,0 @@
-module AeriesApi
-  class Client
-    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
-  end
-end

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

@@ -1,17 +0,0 @@
-module AeriesApi
-  class Client
-    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
-  end
-end

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

@@ -1,11 +0,0 @@
-module AeriesApi
-  class Client
-    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
-  end
-end

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

@@ -1,17 +0,0 @@
-module AeriesApi
-  class Client
-    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
-  end
-end

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

@@ -1,11 +0,0 @@
-module AeriesApi
-  class Client
-    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
-  end
-end

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

@@ -1,22 +0,0 @@
-module AeriesApi
-  class Client
-    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
-
-      def students(school_code:, grade: nil)
-        if grade
-          endpoint = "/schools/#{school_code}/students/grade/#{grade}"
-        else
-          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
-  end
-end

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

@@ -1,27 +0,0 @@
-module AeriesApi
-  class Client
-    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
-
-      def update_school_supplemental(school_code:, student_number:, columns:)
-        options = {
-          body: { Columns: camelize_keys(columns) }.to_json,
-        }
-
-        response = self.class.post("/updateschoolsupplemental/#{school_code}/#{student_number}", options)
-        @error_handler.handle_error(response)
-        mash_and_underscore_keys(response.parsed_response)
-      end
-    end
-  end
-end

data/lib/aeries-api/client.rb

@@ -1,52 +0,0 @@
-require 'active_support/core_ext/string/inflections'
-require 'active_support/core_ext/hash/keys'
-require 'hashie'
-
-require 'aeries-api/client/contacts'
-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'
-require 'aeries-api/client/supplemental'
-require 'aeries-api/error_handler'
-
-module AeriesApi
-  class Client
-    include HTTParty
-    include AeriesApi::Client::Contacts
-    include AeriesApi::Client::Schools
-    include AeriesApi::Client::Students
-    include AeriesApi::Client::StudentGroups
-    include AeriesApi::Client::StudentPictures
-    include AeriesApi::Client::StudentPrograms
-    include AeriesApi::Client::Supplemental
-
-    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']
-
-      self.class.default_options.merge!(headers: { 'AERIES-CERT': aeries_cert, 'Content-Type': 'application/json' }, base_uri: base_uri)
-    end
-
-    private
-
-    def camelize_keys(payload)
-      payload.each do |p|
-        p.deep_transform_keys! { |k| k.to_s.camelize }
-      end
-    end
-
-    def mash_and_underscore_keys(parsed_response)
-      return Hashie::Mash.new(parsed_response.deep_transform_keys! { |k| k.underscore }) if parsed_response.is_a?(Hash)
-      parsed_response.each do |k, v|
-        v.is_a?(Array) ? mash_and_underscore_keys(v) : k.deep_transform_keys! { |k| k.underscore }
-      end
-      parsed_response.map! { |r| Hashie::Mash.new(r) }
-    end
-  end
-end

data/lib/aeries-api/error_handler.rb

@@ -1,22 +0,0 @@
-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 +0,0 @@
-module AeriesApi
-  VERSION = '1.1.0'
-end

data/lib/aeries-api.rb

@@ -1,25 +0,0 @@
-require 'httparty'
-require 'aeries-api/version'
-require 'aeries-api/client'
-
-module AeriesApi
-  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