This application will provide a single page that provides a link to a student's current courses regardless of whether are in CTools or Canvas.
This code is kept in github and will be public for the whole world to see forever.
This server implements both a single page UI and a Rest API. The Rest api can be used independently if that is appropriate. It assumes that authentication has already been done and the request object has a valid value for REMOTE_USER.
The server is implemented using Ruby and Sinatra. The application is packaged into a war file along with JRuby 1.7 (implementing Ruby 1.9.3). It expects to run within a container, such as Tomcat 7, that will provide authentication. The container must be configured to supply the REMOTE_USER environment variable value in the request. An example server.xml file for Tomcat is included.
The application runs under Ruby 1.9.3. After checking out the source use RVM to get the proper Ruby environment (1.9.3) and then run the bundle command to update dependencies.
bundle install
The server can then be run locally using common Ruby web servers. StudentDashboard can be run locally using the included script "./runServerBundle.sh" This will run on port 3000 at the URL: http://localhost:3000/
Use RVM to select the version of ruby to use. Using JRuby may require getting rid of the unicorn and/or guard gems.
To build the war file for installation under Tomcat use the command
warble
The top level directory contains the Ruby configuration files required to build the war file. Delivery of the application configuration files is handled separately.
Depending on your setup the application will be available at a URL similar to: http://localhost:8080/StudentDashboard
Note that the urls for a server run locally with a default Ruby server will not require a context name but when running the war package in a container the URLS will require including the StudentDashboard context element.
The vagrant directory contains configuration files to allow building and starting a VM to test a build. The control commands are available via the Rakefile. Run 'rake -T' to see the available tasks. The README.TXT in the vagrant directory has more details.
#Application Configuration and Deployment#
The application has default configuration values suitable for development testing but for any installation that is not simply for local testing two yaml configuration files should be provided. See copies of those files in the application source for detailed information on the contents. The configuration files will be read from the directory /usr/local/ctools/app/ctools/tl/home or, if a file isn't there, from the server/local directory under the current directory or, if running under Tomcat, in the expanded war file directory.
The directory name used for configuration files can be overridden by an environment variable. The variable LATTE_OPTS will be checked and it is not nil then the contents will be parsed as command line options. Currently all command line values except for --config_dir will be ignored. The value for --config_dir needs to be a directory - the file name expected in that directory is studentdashboard.yml. If it is required to set the environment variable then, when running from the command line, it can simply be set as an exported variable on the command line. To set the value when running under Tomcat it needs to be set in the setenv.sh file. See the vagrant directory for an example of how to do that.
The file security.yml contains the ESB connection information. There are no appropriate defaults and it must be configured for each installation. Copy the file security.yaml.TEMPLATE and fill in values appropriate for your installation. Note that the security.yml file must have restricted read permissions.
The file studentdashboard.yml contains values that may change from instance
to instance but don't contain sensitive information. The values in it
that are most likely to change change are the ESB application id and the
auth settings. The first identifies the information in the security file that
will be used to connect to the ESB. The auth values are for load testing
and allow using a stub authentication service. See the sample file for details.
Suggested configuration files for QA, Load testing and Production deployments are included.
#License#
Copyright (c) 2014 University of Michigan
Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.osedu.org/licenses/ECL-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
#TEST Testing that Jenkins SCM polling works