Project

smarteru

0.01
No release in over 3 years
Low commit activity in last 3 years
Ruby wrapper for Smarteru API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0
>= 0
>= 0
>= 0

Runtime

 Project Readme

SmarterU API wrapper

Ruby wrapper for a SmarterU API. Allows access to a Smarteru API operations: api documentation

Basic Usage

API wrapper can be used from the command line or as part of a Ruby web framework. First install the gem:

gem install smarteru

Instantiate a client with your SmarterU credentials. You can get it here

require 'smarteru'
client = Smarteru::Client.new(account_api_key: "ACCOUNT_API_KEY", user_api_key: "USER_API_KEY")

Make api calls. You can find a list of API endpoints here

response = client.request('getGroup', {group: {name: 'MyGroup'}})
response.result =>
  {
    group: {
      name: "MyGroup",
      group_id: nil,
      created_date: "2015-01-22 23:42:55.553",
      modified_date: "2015-01-23 01:25:02.013",
      description: {
        p: "Group Description ..."
      },
      home_group_message: {
        p: "Welcome to The Group"
      },
      notification_emails: nil,
      user_count: "2",
      learning_module_count: "2",
      tags: nil,
      status: "Active"
    }
  }

Testing

bundle install
rake