BETYdb 4.7

Upgrade of Rails and Enhancement of Documentation.

The Rails version we use has now been bumped up to version 3.2.22.2. This addresses certain security concerns. API version "v0" has been renamed to version "beta". The apipie Gem has been added, and code has been added to use this Gem to document the API and publish that documentation to <host>/<rails root path>/apipie. Finally, better documentation of the SchemaSpy database documentation feature has been added, and configuration settings may now be placed in the configuration file config/application.yml.

Summary of Changes

New Features

Configuration settings for SchemaSpy integrated with other configuration settings.

Configuration settings for building the SchemaSpy documentation of the BETYdb database schema may now be placed in the configuration file config/application.yml. Use of the configuration file lib/tasks/schemaSpyConfig.rb is deprecated. For more information, look at the comments in the file config/application.yml.template.

Apipie-rails Gem for API documentation

We now are using the apipie-rail gem to do inline documentation of the BETYdb APIs. Documentation is viewable at <host>/<rails root path>/apipie.

Steps Needed for Upgrade

Upgrading is straightforward:

1. In your command-line terminal, cd to the root of your Rails installation.
2. Do a git pull to get the latest code from GitHub.
3. Run bundle install to install new Gems.
4. Restart the Rails server (touch tmp/restart.txt if you are running under Apache).

Status of RSpec Tests

• All tests continue to pass when run in the default environment and can be run using the command

  bundle exec rspec
  

Complete details for running the rspec tests are on the updated Wiki page at https://github.com/PecanProject/bety/wiki/Automated-Tests.

Note that you will likely get deprecation warnings when you run the Rake tasks to set up the test database (or for that matter, any other Rake task).