Merge pull request #368 from ucfopen/dev/v2-3-2

Dev/v2 3 2

Author: bagofarms

.gitignore

@@ -13,3 +13,7 @@ reports
 assets/js/vendor/
 
 config/log.log
+
+docker/nginx.conf
+docker/nginx.crt
+docker/nginx.key

DOCKER.md

@@ -0,0 +1,103 @@
+# UDOIT for Docker
+
+## Installation Prerequisites
+
+* [Docker](https://docs.docker.com/install/)
+* [Docker Compose](https://docs.docker.com/compose/install/)
+* [Docker Machine](https://docs.docker.com/machine/install-machine/)
+
+***Note: This guide assumes you have followed the [Installation Guide located in the README.md](README.md#installing-udoit).***
+
+## Host Configuration
+
+### Setup Docker-Machine
+
+Create a docker-machine for UDOIT, get the environment commands for the new machine, and connect your shell to it:
+
+```
+$ docker-machine create udoit
+$ docker-machine env udoit
+$ eval $(docker-machine env udoit)
+```
+
+Then, save the IP address for the newly created docker-machine (E.g. `192.168.99.100`):
+
+```
+$ docker-machine ip udoit
+```
+
+### NGINX Configuration
+
+If `docker/nginx.conf` doesn't exist, create it using a copy of the template:
+
+```
+$ cp docker/nginx.template.conf docker/nginx.conf
+```
+
+Edit `docker/nginx.conf`' to point to the UDOIT docker-machine's IP address by replacing both instances of
+
+```
+localhost
+```
+
+with
+
+```
+<your_ip_address>
+```
+
+Generate SSL certificates according to the naming scheme located in the nginx.conf file (`nginx.key` and `nginx.crt`) or use your own SSL certificates:
+
+```
+$ sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout docker/nginx.key -out docker/nginx.crt
+```
+
+## Start Services using Docker-Compose
+
+Start PHP, MySQL, and NGINX:
+
+```
+$ docker-compose up -d
+```
+
+Verify everything works by navigating to
+
+```
+https://<your_ip_address>
+```
+
+The included `docker-compose.yml` automatically builds the latest images of PHP 7.1-FPM, MySQL, and NGINX.
+
+## Development
+
+### PHP
+
+Execute PHP commands on the server using `docker-compose`:
+
+```
+$ docker-compose exec php bash
+```
+
+Exit by pressing `Ctrl+P` then `Ctrl+Q`
+
+### MySQL
+
+You may access the MySQL database using either `root` or the preconfigured `udoit` user on `<your_ip_address>` and port `3306`.
+
+#### Root access (not advised)
+
+```
+username: root
+password: udoit
+```
+
+#### User access (recommended)
+
+```
+username: udoit
+password: udoit
+```
+
+## Customization
+
+Docker-Compose allows you to change build images, exposed ports, local file linkages, MySQL user accounts, etc. inside the `docker-compose.yml` file.

README.md

@@ -167,6 +167,12 @@ In order for UDOIT to scan YouTube videos for closed captioning, you will need t
 3. Enable ***YouTube Data API V3***
 4. Create an ***API key*** credential.
 
+### Vimeo API Key
+In order for UDOIT to scan Vimeo videos for closed captioning, you will need to create a Vimeo API key. Follow the instructions below:
+
+1. [Create a new App on Vimeo Developer API](https://developer.vimeo.com/apps/new?source=getting-started), please note you must have a Vimeo Developer account.
+2. On your applications "Authentication" page, Generate a new Access Token.  (Select the `Public` and `Private` checkboxes for Scopes.)
+
 ### Installing the LTI in Canvas
 Log into Canvas to add UDOIT:
 
@@ -266,6 +272,10 @@ $ php composer.phar start
 
 Then open [http://localhost:8000 in a browser](http://localhost:8000).
 
+## Docker
+
+To setup the Docker environment, follow the steps outlined in the [DOCKER.md Readme](DOCKER.md).
+
 ## Running Tests
 We use phpunit to run unit tests on UDOIT.  To run the tests, type the following command:
 
@@ -305,6 +315,7 @@ Add contributors here and dont forget composer.json!)
 * Joe Fauvel
 * [John Raible](https://github.com/rebelaide)
 * [Kevin Baugh](https://github.com/loraxx753)
+* [Sean Hernandez](https://github.com/seanlh)
 
 ### Special Thanks
 

app.json

@@ -57,6 +57,14 @@
     "WORKER_ENABLED": {
       "description": "Enable the background worker (requires you turn on the worker dyno).",
       "value": "true"
+    },
+    "SCAN_FILE_SIZE_LIMIT": {
+      "description": "Max file size to scan, anything larger gets set as unscannable.",
+      "value": "50000000"
+    },
+    "ALT_TEXT_LENGTH_LIMIT": {
+      "description": "Maximum character length for alt-text before the item gets flagged as a warning.",
+      "value": "125"
     }
   },
   "addons": [

composer.json

@@ -18,21 +18,19 @@
         "migrate" : "php bin/run_database_migrations.php",
         "start": "php -S localhost:8000 -t public/",
 
-        "docker-test": "docker-compose run --rm php71 php composer.phar test",
+        "docker-test": "docker-compose --file docker/docker-compose.yml run --rm php71 php composer.phar test",
         "docker-test-multi": [
-            "@docker-test-no-coverage-php55",
             "@docker-test-no-coverage-php56",
             "@docker-test-no-coverage-php70",
             "@docker-test-no-coverage-php71"
         ],
-        "docker-test-no-coverage-php55": "docker-compose run --rm php55 php composer.phar test-no-coverage",
-        "docker-test-no-coverage-php56": "docker-compose run --rm php56 php composer.phar test-no-coverage",
-        "docker-test-no-coverage-php70": "docker-compose run --rm php70 php composer.phar test-no-coverage",
-        "docker-test-no-coverage-php71": "docker-compose run --rm php71 php composer.phar test-no-coverage",
-        "docker-test-include-functional": "docker-compose run --rm php71 php composer.phar test-include-functional",
-        "docker-lint": "docker-compose run --rm php71 php composer.phar lint",
-        "docker-db-setup": "docker-compose run --rm php71 php composer.phar db-setup",
-        "docker-start": "docker-compose run --rm php71 php -S localhost:8000 -t public/"
+        "docker-test-no-coverage-php56": "docker-compose --file docker/docker-compose.yml run --rm php56 php composer.phar test-no-coverage",
+        "docker-test-no-coverage-php70": "docker-compose --file docker/docker-compose.yml run --rm php70 php composer.phar test-no-coverage",
+        "docker-test-no-coverage-php71": "docker-compose --file docker/docker-compose.yml run --rm php71 php composer.phar test-no-coverage",
+        "docker-test-include-functional": "docker-compose --file docker/docker-compose.yml run --rm php71 php composer.phar test-include-functional",
+        "docker-lint": "docker-compose --file docker/docker-compose.yml run --rm php71 php composer.phar lint",
+        "docker-db-setup": "docker-compose --file docker/docker-compose.yml run --rm php71 php composer.phar db-setup",
+        "docker-start": "docker-compose --file docker/docker-compose.yml run --rm php71 php -S localhost:8000 -t public/"
 
     },
     "repositories"      : [
@@ -54,7 +52,7 @@
         }
     ],
     "require": {
-        "php": "^5.4.0 || ^5.5.0 || ^5.6.0 || ^7.0.0 || ^7.1.0",
+        "php": "^5.6.0 || ^7.0.0 || ^7.1.0",
         "ext-pdo": "*",
         "ext-gd": "*",
         "nategood/httpful": "^0.2.20",
@@ -146,6 +144,11 @@
             "name": "Cooper Fellows",
             "homepage": "https://github.com/cooperfellows",
             "role": "Contributor"
+        },
+        {
+            "name": "Sean Hernandez",
+            "homepage": "https://github.com/seanlh",
+            "role": "Contributor"
         }
     ]
 }

config/herokuConfig.php

@@ -14,6 +14,12 @@
 /* Tool name for display in Canvas Navigation */
 $canvas_nav_item_name = getenv('CANVAS_NAV_ITEM_NAME');
 
+/* File Scan Size Limit */
+$file_scan_size_limit = getenv('SCAN_FILE_SIZE_LIMIT') ?: 52428800;
+
+/* Alt Text Length Limit */
+$alt_text_length_limit = getenv('ALT_TEXT_LENGTH_LIMIT') ?: 125;
+
 /* Database Config */
 
 $db_url           = parse_url(getenv('DATABASE_URL'));
@@ -42,6 +48,9 @@
 /* Google/YouTube Data Api Key */
 define('GOOGLE_API_KEY', getenv('GOOGLE_API_KEY')?:'');
 
+/* Vimeo API Key */
+define('VIMEO_API_KEY', '');
+
 /* Google Analytics Tracking Code */
 define('GA_TRACKING_CODE', '');
 
@@ -54,3 +63,7 @@
 // send logs into the heroku logs
 $log_handler = new \Monolog\Handler\ErrorLogHandler();
 $log_handler->setFormatter(new \Monolog\Formatter\LineFormatter(null, null, true, true));
+
+// Sets CURLOPT_SSL_VERIFYPEER and CURLOPT_SSL_VERIFYHOST
+// This should be true for production environments
+$curl_ssl_verify = true;

config/localConfig.template.php

@@ -19,9 +19,18 @@
 /* Tool name for display in Canvas Navigation */
 $canvas_nav_item_name = (getenv('CANVAS_NAV_ITEM_NAME')) ?: 'UDOIT';
 
+/* File Scan Size Limit */
+$file_scan_size_limit = getenv('SCAN_FILE_SIZE_LIMIT') ?: 52428800;
+
+/* Alt Text Length Limit */
+$alt_text_length_limit = getenv('ALT_TEXT_LENGTH_LIMIT') ?: 125;
+
 /* Google/YouTube Data Api Key */
 define('GOOGLE_API_KEY', '');
 
+/* Vimeo API Key */
+define('VIMEO_API_KEY', '');
+
 /* Google Analytics Tracking Code */
 define('GA_TRACKING_CODE', '');
 
@@ -38,13 +47,22 @@
 
 $debug = false;
 
-// added in v2.3.0
-// Background worker Options (See Background Workers in Readme)
+/* Background worker Options (See Background Workers in Readme) */
 $background_worker_enabled = false;
 $background_job_expire_time = 20; // after x Minutes, mark job as expired
 $background_worker_sleep_seconds = 7;
 
-// OVERRIDE the default of ENV_PROD
-// $UDOIT_ENV = ENV_PROD;
-// $UDOIT_ENV = ENV_DEV;
-// $UDOIT_ENV = ENV_TEST;
+/* Set the Environment (default value is 'ENV_DEV' */
+// Valid values are 'ENV_PROD', 'ENV_DEV', or 'ENV_TEST'
+// If '$UDOIT_ENV' is not 'ENV_PROD' UDOIT is loaded with
+    // set display errors to 1
+    // add test reports to 'View Old Reports' page in UDOIT
+    // doesn't validate Canvas tokens
+    // returns "test-token" when getting refresh token for Canvas
+    // Course Scanner doesn't scan, simply contains already loaded test reports
+// $UDOIT_ENV = ENV_PROD; // default
+
+/* Ignore SSL Certificates */
+// For use while developing with self-signed SSL Certificates
+// Sets CURLOPT_SSL_VERIFYPEER and CURLOPT_SSL_VERIFYHOST
+$curl_ssl_verify = true; // This should be true for production environments

config/localConfig.test.php

@@ -15,12 +15,21 @@
 /* Tool name for display in Canvas Navigation */
 $canvas_nav_item_name = 'test udoit';
 
+/* File Scan Size Limit */
+$file_scan_size_limit = getenv('SCAN_FILE_SIZE_LIMIT') ?: 52428800;
+
+/* Alt Text Length Limit */
+$alt_text_length_limit = getenv('ALT_TEXT_LENGTH_LIMIT') ?: 125;
+
 /* Google/YouTube Data Api Key */
 define('GOOGLE_API_KEY', 'TEST_API_KEY');
 
 /* Google Analytics Tracking Code */
 define('GA_TRACKING_CODE', 'TEST_GA_TRACKING');
 
+/* Vimeo API Key */
+define('VIMEO_API_KEY', 'TEST_VIMEO_KEY');
+
 /* Database Config */
 $db_type          = 'test'; // 'mysql' or 'pgsql'
 $db_host          = ''; // localhost or ip
@@ -40,6 +49,10 @@
 $background_job_expire_time = 20; // after x Minutes, mark job as expired
 $background_worker_sleep_seconds = 1;
 
+// Sets CURLOPT_SSL_VERIFYPEER and CURLOPT_SSL_VERIFYHOST
+// This should be true for production environments
+$curl_ssl_verify = true;
+
 // send logs into the phpunit output
 $log_handler = new \Monolog\Handler\TestHandler(null, \Monolog\Logger::WARNING);
 $log_handler->setFormatter(new \Monolog\Formatter\LineFormatter(null, null, true, true));

config/settings.php

@@ -2,7 +2,7 @@
 define('ENV_TEST', 'test');
 define('ENV_PROD', 'prod');
 define('ENV_DEV', 'dev');
-define('UDOIT_VERSION', '2.3.1');
+define('UDOIT_VERSION', '2.3.2');
 
 // SET UP AUTOLOADER (uses autoload rules from composer)
 require_once(__DIR__.'/../vendor/autoload.php');
@@ -32,7 +32,7 @@
 isset($UDOIT_ENV) || $UDOIT_ENV = ENV_PROD; // !! override in your localConfig.php
 
 // SET UP OAUTH
-UdoitUtils::setupOauth($oauth2_id, $oauth2_key, $oauth2_uri, $consumer_key, $shared_secret);
+UdoitUtils::setupOauth($oauth2_id, $oauth2_key, $oauth2_uri, $consumer_key, $shared_secret, $curl_ssl_verify);
 
 // SET UP DATABASE
 UdoitDB::setup($db_type, $dsn, $db_user, $db_password);