BSkyB wrapper for Adobe Sitecat analytics JS.

• RVM
• Ruby (version 1.9.3 or later)
• npm

1. Fork the repository from Github onto your local machine
2. Install npm

• echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bashrc
• . ~/.bashrc
• mkdir /usr/local
• mkdir ~/node-latest-install
• cd ~/node-latest-install
• curl http://nodejs.org/dist/node-latest.tar.gz | tar xz --strip-components=1
• ./configure --prefix=/usr/local
• make install # ok, fine, this step probably takes more than 30 seconds...
• curl https://npmjs.org/install.sh | sh

3. Install grunt either globally, or run the following to use the bundled project grunt

• npm install

• grunt/js/ The source code, unminified and ready to work on.

• grunt/js/analytics.js The public API is created here (returned at the bottom). This file brings together files from /core, /plugins and /utils.

• grunt/js/demo.js JS to make the demo page work. This JS is also used as part of the unit testing.

• grunt/sass/ The look and feel for the wiki pages.

• dist/ Compiled code (via grunt)

• _includes/ Source documentation for using the API.

• _site/ Compiled documentation (via jekyll) for using the API.

• app.rb A basic Sinatra server for running the functional tests

• test/ the functional + unit tests for the API

• circle.yml Configuration for the CI server

• config.ru Configuration for running the Sinatra server

• Gruntfile.js Configuration for grunt tasks - to do with compiling the javascript

1. In the root of the project, run the following:

• bundle
• jekyll serve --watch

2. In another terminal run:

• grunt watch (add ' --beautify' to help debugging)

3. browse to

• http://localhost:4001

These tests are automatically run on the CircleCI server upon pushing to Github

• grunt test
  • functional using minitest and capybara
  • unit using mocha and chai

To release a new version with:

• Code changes - increment the version number (described below) in _config.yml. This will update gh-pages and the S3.
• Documentation changes - Dont increment the version number. This will update gh-pages branch only.
• Release Candidate changes - Add 'rc' to the end of the version number e.g. '1.0.1rc2'. this will update the S3 only

This library should follow the Semantic versioning specification. In short, that means the following:

Version: X.Y.Z

• API changes that are not backwards compatible, and break existing calls using the API must increment the X value.

• API changes that introduce new backwards compatible changes, or change the internals, but not the interface, of existing methods will increment the Y value.

• Patches or bug fixes that are backwards compatible should increment the Z value.

Upon commiting and pushing your code to Github, the CI server will run through the functional tests and - if there are no errors - a new version of the library will be deployed to the CDN using the version number specified in the _config.yml file.