aeries-api 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e692f94cd8e689c675f41bb47fc09f63c53e3047292bab665da23c726f1c7ebe
+  data.tar.gz: c54d14db243e3482e2b4c576d088175689880a77b78fab23f238fe5efcf32a4c
+SHA512:
+  metadata.gz: 322ef154e740fb8f27141c2d823be0cc3bba3e0a9a42cdd913efd914c9a82caee9551023d6a0ba99fc523add917c212ef5f0391ab413a4cdc9cd99db7a7119eb
+  data.tar.gz: 52fec14b017afeeb62bc6336fbdc1c3ff8b9448fe2db0a47edaa5943abba49cb1e3c1bf3bf2386ff20d1a4f93b33d83364b623ee3c07773b3e10b5ba14cd3fc5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,82 @@
+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 = Aeries::Api::Client.new(
+  aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
+  base_uri: ' https://demo.aeries.net/aeries/api/v3'
+)
+```
+
+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'
+
+aeries = Aeries::Api::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:
+
+```ruby
+aeries.students(school_code: 99, grade_level: 4)
+```
+
+Available Methods:
+
+```ruby
+# /api/v3/schools
+schools # returns all schools
+
+# /api/v3/schools/#{school_code}
+school(school_code: school_code) # returns a single school
+
+# /api/v3/schools/#{school_code}/StudentGroups
+student_groups(school_code: school_code) # returns all student groups at a school
+
+# /api/v3/schools/#{school_code}/students
+students(school_code: school_code) # returns all students at a school
+
+# /api/v3/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}
+student(school_code: school_code, student_id: student_id) # returns a single student
+
+# /api/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
+student_picture(school_code: school_code) # returns all student pictures at a school
+
+# /api/schools/#{school_code}/StudentPictures/#{student_id}
+student_pictures(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

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

data/aeries-api.gemspec

@@ -0,0 +1,44 @@
+
+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', "~> 10.0"
+  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

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+require 'aeries-api/version'
+require 'aeries-api/client'
+
+module AeriesApi
+  class Error < StandardError; end
+end

data/lib/aeries-api/client.rb

@@ -0,0 +1,41 @@
+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'
+
+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
+
+    format :json
+
+    def initialize(aeries_cert: nil, base_uri: nil)
+      aeries_cert ||= ENV['AERIES_CERT']
+      base_uri ||= ENV['AERIES_BASE_URI']
+
+      self.class.default_options.merge!(headers: { 'AERIES-CERT': aeries_cert }, base_uri: base_uri)
+    end
+
+    private
+
+    def mash_and_underscore_keys(parsed_response)
+      new_response = []
+      parsed_response.each_with_object(new_response) do |r, a|
+        r.deep_transform_keys! { |k| k.to_s.underscore }
+        a << Hashie::Mash.new(r)
+      end
+      return new_response
+    end
+
+  end
+end

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

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

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

@@ -0,0 +1,19 @@
+module AeriesApi
+  class Client
+
+    module Schools
+
+      def school(school_code:)
+        response = self.class.get("/schools/#{school_code}")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+      def schools
+        response = self.class.get("/schools")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,14 @@
+module AeriesApi
+  class Client
+
+    module StudentGroups
+
+      def student_groups(school_code:)
+        response = self.class.get("/schools/#{school_code}/studentgroups")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,19 @@
+module AeriesApi
+  class Client
+
+    module StudentPictures
+
+      def student_picture(school_code:, student_id:)
+        response = self.class.get("/schools/#{school_code}/studentpictures/#{student_id}")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+      def student_pictures(school_code:)
+        response = self.class.get("/schools/#{school_code}/studentpictures")
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,24 @@
+module AeriesApi
+  class Client
+
+    module Students
+
+      def student(school_code:, student_id:)
+        response = self.class.get("/schools/#{school_code}/students/#{student_id}")
+        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)
+        mash_and_underscore_keys(response.parsed_response)
+      end
+
+    end
+
+  end
+end

data/lib/aeries-api/version.rb

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

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: aeries-api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Derek Povah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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/students.rb
+- lib/aeries-api/version.rb
+homepage: https://github.com/derekpovah/aeries-api
+licenses:
+- MIT
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple REST client for the Aeries SIS API
+test_files: []