0.0
No release in over a year
A client for accessing Edmentum's 2.0 APIs. Not authored by Edmentum.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 4.4, >= 4.4.6
~> 0.2, >= 0.2.16
~> 4.1, >= 4.1.2
~> 3.6, >= 3.6.0
~> 3.0, >= 3.0.1
~> 1.24, >= 1.24.3

Runtime

~> 2.3, >= 2.3.0
~> 2.1, >= 2.1.0
~> 1.0, >= 1.0.1
 Project Readme

edmentum-client-ruby

What?

A ruby client that works with the Edmentum 2.0 APIs. Not official - built by StrongMind when we needed to interoperate with Edmentum systems. Built using a swagger generator and then cleaned up to be suitable for usage.

Where?

Links

CI/CD

Local Install

To use in a project:

bundle add edmentum-client

To develop locally:

git clone https://github.com/StrongMind/edmentum-client-ruby.git
cd edmentum-client
bundle install

Run tests locally

Tests are minimal due to auto-generation. We might add some in the future.

Uses rspec for testing. To run tests locally, for example:

rspec

Code owners can be found in CODEOWNERS file

Usage

require 'edmentum_client'
ec = ::EdmentumClient.configure do |config|
config.username = "mark.ng@strongmind.com@PRIMA" # Notice the PRIMA...this is the Account name
config.password = "YOUR REAL PASSWORD HERE"
config.client_id = "YOUR REAL ID HERE"
config.client_secret = "YOUR REAL SECRET HERE"
config.debugging = true
config.api_key['Authorization'] = ::EdmentumClient::Authentication.token(config)
end

aa = ::EdmentumClient::V20AdministrationCenterApi.new
aa.users_controller_get_users(100)