module Caliper

This file is part of IMS Caliper Analytics™ and is licensed to IMS Global Learning Consortium, Inc. (www.imsglobal.org) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information.

IMS Caliper is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 3 of the License.

IMS Caliper is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see www.gnu.org/licenses/.

Annotation actions.

Assessment actions.

Assessment item actions.

Assignable actions.

Media actions.

Profile actions.

Outcome actions.

Reading actions.

Session actions.

JSON-LD context.

Defaults

W3C Organization

An FOAF LIS Person @extends Agent

Software Application (from schema.org)

Annotation entity.

Annotation types.

Bookmark Annotation entity.

Highlight Annotation entity.

Shared Annotation entity.

Tag Annotation entity.

Assessment entity.

Assessment Item entity.

AssignableDigitalResource entity. AssignableDigitalResource's prototype is set to DigitalResource.

Assignable types.

Attempt entity on an Assignable.

Caliper representation of a CreativeWork. We add learning specific attributes, including a list of LearningObjective learning objectives and a list of String keywords. See schema.org/CreativeWork.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see www.gnu.org/licenses/.

The base Caliper Entity. Analogous to a schema.org Thing.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see www.gnu.org/licenses/.

An agent (eg. person, group, software or physical artifact). See xmlns.com/foaf/spec/#term_Agent.

The Generatable interface marks an object type that is created or generated as a result of an action. The interface allows Caliper to catch errors at compile time for instances of the marked class rather than at runtime if a marker annotation was defined instead.

Module that supports ser-des for Caliper Entities/JSON

Learning Objective

LIS Course Offering.

LIS Course Section.

LIS Group.

W3C Membership.

LTI LIS roles.

LIS Status

Audio object embedded in a web page. See schema.org/AudioObject

A image object embedded in a web page. See schema.org/ImageObject

A time based location within a media object.

An image, video, or audio object embedded in a web page. Note that a creative work may have many media objects associated with it on the same web page. For example, a page about a single song (MusicRecording) may have a music video (VideoObject), and a high and low bandwidth audio stream (2 AudioObject's). See From schema.org/MediaObject.

Media Object types.

A video object embedded in a web page. See schema.org/VideoObject.

LIS Result

Representation of an EPUB 3 Chapter. A major structural division of a piece of writing. See www.idpf.org/epub/vocab/structure/#chapter

Representation of an EPUB 3 Part. A major structural division of a piece of writing, typically encapsulating a set of related chapters. See www.idpf.org/epub/vocab/structure/#part.

Representation of an EPUB 3 subchapter. A major sub-division of a chapter. See www.idpf.org/epub/vocab/structure/#subchapter.

Public: Representation of an EPUB 3 Volume. A component of a collection. See www.idpf.org/epub/vocab/structure/#volume

A Frame

Web Page

Represents response text or integer/decimal/scientific numbers that completes a question designed with one or more “fill in the blank” option prompts.

Represents a response to a multiple choice question that permits a single option to be selected

Representation of a response to a multiple choice question that permits one or more options to be selected.

A Response

Response types.

Represents a response that identifies text from a presented paragraph or list. The response is the identified string or a mapping to a logical identifier.

Represents response to a multiple choice question that limits options to either 'true or false', 'agree or disagree', etc.

The most generic kind of creative work, including books, movies, photographs, software programs, etc.

Software Application.

the most generic type of item

Web Page.

Session Entity.

The Targetable interface marks an object type that provides coordinates to a target destination required by certain actions. The interface allows Caliper to catch errors at compile time for instances of the marked class rather than at runtime if a marker annotation was defined instead.

W3C Membership.

A W3C Organization.

Annotation Event per Caliper Annotation Profile.

Assessment Event.

AssessmentItem Event.

Assignable Event.

Base event.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see www.gnu.org/licenses/.

Module that supports ser-des for Caliper Event/JSON

Media Event.

Navigation Event.

Outcome Event.

Session Event per the Caliper Session Profile.

View Event per the Caliper Base Profile.

Module that supports ser-des for Caliper Envelope

Options

Event store envelope. Contains event info.

Event store requestor.

Module that supports ser-des for Caliper Event/JSON

Caliper Sensor.

Extends the atomic class with several new functions.

Statistic.

Statistics.

Statistics map.

Version.

Constants

VERSION

Public Class Methods

new(options = {}) click to toggle source

# File lib/caliper/options.rb, line 30
def initialize(options = {})
  self.host options[:host] || Defaults.HOST
  self.api_key options[:api_key] || ''
  self.connection_request_time_out options[:connection_request_time_out] || Defaults.CONNECTION_REQUEST_TIMEOUT
  self.connection_time_out options[:connection_time_out] || Defaults.CONNECTION_TIMEOUT
  self.socket_time_out options[:socket_time_out] || Defaults.SOCKET_TIMEOUT
end