Merge pull request #30 from Brightcookie/development

Release 0.9.0 final

Author: sraka1

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# How to Contribute
+
+lxHive is developed by its community consisting of lxHive users, enthusiasts,
+Brightcookie employees, customers, partners, and others. We strongly encourage you to
+contribute to lxHive's open source efforts by implementing new features,
+enhancing existing features, and fixing bugs. We also welcome your participation
+in writing documentation and guides.
+
+To maintain code quality, all code changes are reviewed by a core set of lxHive project
+maintainers, namely @sraka1 and @RoboSparrow.
+
+As you have ideas for features you want to implement, follow the contribution
+steps outlined in the sections, below. For more details on specific steps, and
+to get a deeper understanding of lxHive in general, make sure to check out our Wiki.
+Lastly, visit the links listed in the *Additional Resources* section, below.
+
+## Getting Started
+
+* Sign up for a [GitHub account](https://github.com/signup/free) (if you don't have one already) to be able to participate.
+* [Create a new issue](https://github.com/Brightcookie/lxHive/issues/new) for your issue. If a ticket
+already exists for the issue, participate via the existing ticket.
+  * Describe the issue clearly. If it is a bug, include steps to reproduce it.
+  * Select an appropriate category for the issue.
+  * Select the earliest version (or commit) of the product affected by the issue.
+* Fork the lxHive repository.
+
+## Making Changes
+
+* Ensure you have a working lxHive development environment. A quick startup guide on setting up an instance
+is part of the README file included in this repository. 
+* Create a branch from an existing branch (typically the *development* branch) from
+which you want to base your changes.
+Use the following nomenclature when naming your branch:
+  * If you are working on a bugfix, prefix the branch name with bugfix-*
+  * If you are working on a new feature/improvement, prefix the branch name with feature-*
+  * If you are working solely on increasing ADL test compliance, prefix the branch name with compliance-*
+  * You will also notice some branches named release-x.y.z (where x.y.z is a valid semantic versioning version), which will be opened by the core maintainers in preparation for a new release (ironing out bugs out of new features before the release is made available). 
+* Commit logical units of work.
+* Follow the [PSR-0](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md), 
+[PSR-1](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-1-basic-coding-standard.md), 
+[PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md) and 
+[Symfony](http://symfony.com/doc/current/contributing/code/standards.html) code standards.
+* Include a reference to the issue (e.g. #13) in your commit messages.
+For example:
+
+        Improve code readability - #13
+
+* *Test* your changes thoroughly! Consider the wide variety of operating
+systems, databases, application servers, and other related technologies. Make sure your changes in one environment don't break something in
+another environment. See the [xAPITests](https://github.com/sraka1/xAPITests) and [xAPI_LRS_Test](https://github.com/adlnet/xAPI_LRS_Test)
+repositories for details on executing automated tests against your test instance.
+
+## Submitting Changes
+
+* Push changes in your branch to your fork.
+* [Create a pull request](https://github.com/Brightcookie/lxHive/compare) and mention the issue it fixes [as described here](https://github.com/blog/1506-closing-issues-via-pull-requests).
+* You're done! Well, not quite ... be sure to respond to comments and questions
+to your pull request until it is closed.
+
+## Additional Resources
+
+* [lxHive Website](http://www.lxhive.com/)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request
+documentation](http://help.github.com/send-pull-requests/)

README.md

@@ -1,12 +1,13 @@
 
 # ![lxHive](./public/assets/images/lxHive.logo.png)
 
+[![Circle CI](https://circleci.com/gh/Brightcookie/lxHive/tree/development.svg?style=svg)](https://circleci.com/gh/Brightcookie/lxHive/tree/development)
 [![SensioLabsInsight](https://insight.sensiolabs.com/projects/9e0e6f28-b099-4c84-ad85-ccf4de70d6a6/mini.png)](https://insight.sensiolabs.com/projects/9e0e6f28-b099-4c84-ad85-ccf4de70d6a6)
 
 ## <a name="introduction" />Introduction
 
-**lxHive** is a fast and lightweight open source xAPI conformant Learning Record Store (LRS). 
-**lxHive** logs and returns activity statements as defined in the [Experience API specification](https://github.com/adlnet/xAPI-Spec) (formerly TinCan API) currently at xAPI Version 1.0.3. 
+**lxHive** is a fast and lightweight open source xAPI conformant Learning Record Store (LRS).
+**lxHive** logs and returns activity statements as defined in the [Experience API specification](https://github.com/adlnet/xAPI-Spec) (formerly TinCan API) currently at xAPI Version 1.0.3.
 
 The Experience API (also referred to as 'xAPI') is a learning software specification that allows online learning content and systems to interact allowing recording and tracking of all types of learning experiences. It is designed to replace the legacy SCORM Standard and is steered by the US Dept. of Defense [ADL](http://www.adlnet.gov/) (Advanced Distributed Learning). It allows for the efficient aggregation and analysis of learning data as well as allowing learning designers a flexible and intelligent way to design better learning experiences. The Experience API is able to accept learning experiences from any device and/or medium (mobile, tablet, desktop), both in an offline as well as online mode.
 
@@ -27,19 +28,21 @@ The application uses [MongoDB](https://www.mongodb.org/) and [PHP](http://php.ne
 
 ### Requirements
 
-* PHP >= 5.4,
+* PHP >= 5.4, ith [mongo extension](http://php.net/manual/en/mongo.installation.php)
 * (optional) PHPUnit to run tests.
 * .htaccess enabled (or similar HTTP rewrite function)
 * [Composer](https://getcomposer.org/) installed
 * [Mongo DB](https://www.mongodb.org/) installed (supports Mongo 3.x)
 * [OpenSSL](https://www.openssl.org/)
 
-#### Notes: 
+#### Notes:
 
 * Make sure you have set the `date.timezone` setting in your php.ini
 
 ### Setup
 
+#### Application install and set-up
+
 1. Install dependencies via `composer install`.
 2. Point your server's `DocumentRoot` directive to the `public` folder
 3. Set up your database & client account:
@@ -59,13 +62,36 @@ $ ./X user:create
 
 ```
 
-#### Notes: 
+#### Set-up file Storage and extended config
+
+1. Optionally: Further customise your configuration in `src/xAPI/Config/Config.yml`
+
+    * TODO: explain options
+
+2. Set up you local file system:
+
+    * Create your storage directory as defined in `Config.yml > filesystem.local`.
+    * Create the required `files` and `log` sub directories.
+    * Assign the appropiate `r\w` permissions for your system.
+
+Default file storage structure:
+
+```
+[lxHivE]
+    |_ [storage]
+    |   |_ [files]
+    |   |_ [logs]
+    |
+    ...
+```
+
+#### Notes:
 
 * As an administrator you should first create a new user and authentication token for yourself and assign the *super* role to it.
 
 ## Documentation
 
-See the Wiki and the `docs` directory for more detailed documentation. 
+See the Wiki and the `docs` directory for more detailed documentation.
 
 ## Contributors
 

circle.yml

@@ -0,0 +1,19 @@
+machine:
+    php:
+        version: 5.5.11
+dependencies:
+    pre:
+        - yes '' | pecl -q install -f mongo
+    post:
+        - npm install -g newman
+        - git clone [email protected]:sraka1/xAPITests.git
+test:
+    pre:
+        - yes '' | ./X setup:db
+        - ./X setup:oauth
+        - ./X user:create [email protected] --password=test --permissions=super
+        - ./X auth:basic:create --name=test --description=test --expiration=1914156000 [email protected] --scopes=super --key=test --secret=test
+        - php -S localhost:8080 -t ./public/:
+            background: true
+    override:
+        - newman -c ./xAPITests/tests/1.0.3/xAPI.json -e ./xAPITests/environments/local.json -x

composer.json

@@ -24,7 +24,8 @@
         "symfony/console": "*",
         "slim/views": "~0.1",
         "twig/twig": "~1.18",
-        "symfony/yaml": "~2.6"
+        "symfony/yaml": "~2.6",
+        "birke/rememberme": "~1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "4.3.*"