0.0
Low commit activity in last 3 years
Gem para gerar uma API com o objetivo de consumir dados do sistemas acadêmico do IFMS
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 4.0, < 5.0
~> 8.1.4
>= 13.0, < 14.0
~> 3.13

Runtime

>= 2.6, < 3.0
>= 2.9, < 3.0
>= 1.15, < 2.0
 Project Readme

SigaeduApi

Cliente Ruby para consultar dados acadêmicos do SIGA Edu do IFMS.

Requisitos

  • Ruby 4.0 ou superior

Instalação

Adicione a gem ao Gemfile da aplicação:

gem "sigaedu_api"

Em seguida, execute bundle install.

Uso

require "sigaedu_api"

courses = SigaeduApi::AcademicRegistry::Course.new(login, password)
courses.get_data("Campo Grande")

students = SigaeduApi::AcademicRegistry::Student.new(login, password)
students.get_data("Campo Grande")

student_data = SigaeduApi::AcademicRegistry::StudentData.new(login, password)
student_data.get_data(student_id)

As credenciais são usadas somente para autenticar a sessão no SIGA Edu. Os testes automatizados não acessam o sistema acadêmico.

TLS do SIGA Edu

O SIGA Edu atualmente não entrega toda a cadeia de certificados necessária para alguns ambientes Ruby. A gem inclui os certificados públicos RNP ICPEdu GR46 e GlobalSign Root R46 para completar essa cadeia, mantendo a verificação TLS e de hostname ativas.

Desenvolvimento

Depois de clonar o repositório, instale as dependências com bundle install e rode a suíte com:

bundle exec rake spec

O CI executa os specs em Ruby 4.0 e instala Rails 8.1 como dependência de desenvolvimento para validar a compatibilidade da gem.

Licença

Distribuída sob a licença MIT. Consulte LICENSE.txt.