Coding standards improvements

Author: kenorb

README.md

@@ -47,6 +47,16 @@ KnownUser API
 You can use the Known user setting to test if a specific user has arrived at your site via the queue,
 or if the user has tried to bypass the queue. The KnownUser validation must only be done on page requests.
 
+Troubleshooting
+===============
+
+> Error: Class KnownUser not found
+
+When using _Composer Manager_, make sure you've rebuilded and updated `composer.json` correctly by:
+
+    drush composer-json-rebuild
+    drush composer-manager update
+
 Notes
 =====
 
@@ -55,4 +65,4 @@ Notes
 - Older versions [API1](http://api.queue-it.net) has been deprecated now.
 - The service will accept both XML and JSON formatted data by setting the `Content-Type` HTTP header.
 - Source code and binaries are available at [Github](https://github.com/queueit).
-- For support of Queue-it Implementation, please contact Queue-itsupport at <[email protected]>.
+- For support of Queue-it Implementation, please contact Queue-it support at <[email protected]>.

composer.json

@@ -2,7 +2,7 @@
     "name": "queueit/KnownUser.V3.PHP",
     "type": "library",
     "description": "The Queue-it Security Framework is used to ensure that end users cannot bypass the queue by adding a server-side integration to your server.",
-    "homepage": "https://drupal.org/project/coder",
+    "homepage": "https://github.com/drupal-modules/queueit",
     "support": {
         "issues": "https://github.com/queueit/KnownUser.V3.PHP/issues",
         "source": "https://github.com/queueit/KnownUser.V3.PHP"

queueit.admin.inc

@@ -23,7 +23,7 @@ function queueit_settings_form($form, &$form_state) {
     '#options' => [
       'integration' => 'Integration config',
       'code' => 'Configuration in code',
-      //'js' => 'JavaScript', // @todo
+      // 'js' => 'JavaScript', // @todo
     ],
     '#description' => t('Select the type of Queue-it implementation.<br>Select Integration Config to load the configuration from the Go Queue-it platform.<br>Select Configuration in code if your application server is not allowed to do external GET requests (this is without using the Trigger/Action paradigm).'),
     '#default_value' => variable_get('queueit_mode', 'code'),
@@ -78,22 +78,22 @@ function queueit_settings_form($form, &$form_state) {
     '#type' => 'textfield',
     '#title' => t('Culture of the queue ticket layout.'),
     '#description' => t('Culture of the queue ticket layout in the format specified <a href="!url">here</a>.',
-      [ '!url' => 'https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx' ]
-      ),
+      ['!url' => 'https://msdn.microsoft.com/en-us/library/ee825488(v=cs.20).aspx']
+    ),
     '#default_value' => variable_get('queueit_culture_of_layout'),
   );
   /* Validation parameters */
   $form['validate'] = array(
     '#title' => 'Validation logic',
     '#type' => 'fieldset',
   );
-	// Exclude Queue-it on specific pages.
-	$form['validate']['queueit_exclude_pages'] = array(
-		'#type' => 'textarea',
-		'#title' => t('Exclude Queue-it on specific pages.'),
-		'#default_value' => variable_get('queueit_exclude_pages', QUEUEIT_EXCLUDE),
-		'#description' => t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. It is recommended to exclude resources and AJAX calls."),
-	);
+  // Exclude Queue-it on specific pages.
+  $form['validate']['queueit_exclude_pages'] = array(
+    '#type' => 'textarea',
+    '#title' => t('Exclude Queue-it on specific pages.'),
+    '#default_value' => variable_get('queueit_exclude_pages', QUEUEIT_EXCLUDE),
+    '#description' => t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. It is recommended to exclude resources and AJAX calls."),
+  );
   $form['validate']['queueit_ignore_post'] = array(
     '#type' => 'checkbox',
     '#title' => t('Ignore queue validation for the POST requests.'),
@@ -144,14 +144,15 @@ function queueit_settings_form_validate($form, &$form_state) {
   module_load_include('php', 'queueit', 'src/classes/QueueitKnownUser');
   // Validate the configuration.
   try {
-    $known_user = new QueueitKnownUser;
+    $known_user = new QueueitKnownUser();
     if (!$known_user->validateConfig()) {
       drupal_set_message(t('Queue-it configuration is not valid.'), 'warning');
     }
     switch (variable_get('queueit_mode', 'code')) {
       case 'code':
         $result = $known_user->validateRequestByIntegrationConfig();
         break;
+
       case 'integration':
         $config = $known_user->getIntegrationConfig();
         if (!$config) {

queueit.inc

@@ -12,18 +12,18 @@ function queueit_md2html($content) {
   // Convert new lines into <br>.
   $content = nl2br($content, FALSE);
   // Format code.
-  $content = preg_replace( '/`(.*?)`/s', '<code>\1</code>', $content);
+  $content = preg_replace('/`(.*?)`/s', '<code>\1</code>', $content);
   // Convert links.
   $content = preg_replace('/\[([^\[]+)\]\(([^\)]+)\)/', '<a href=\'\2\'>\1</a>', $content);
   // Convert headers.
   $content = preg_replace('/\n?(.*)\n=+/', '<h1>\1</h1>', $content);
   $content = preg_replace_callback('/\n(#+)(.*)/',
     function ($regs) {
-      list($tmp, $chars, $header) = $regs;
+      list(, $chars, $header) = $regs;
       return sprintf('<h%d>%s</h%d>', strlen($chars), trim($header), strlen($chars));
     },
     $content);
   // Remove not needed characters.
   $content = strtr($content, ['=' => '']);
-	return $content;
+  return $content;
 }

queueit.info

@@ -1,6 +1,5 @@
 name = Queue-it
 description = Queue-it offers an API for programmatic access to configuring and controlling the queue.
-version = VERSION
 core = 7.x
 files[] = tests/queueit.test
 configure = admin/config/services/queueit

queueit.install

@@ -18,16 +18,19 @@ function queueit_requirements($phase) {
     $requirements['queueit'] = array(
       'title' => $t('KnownUser.V3.PHP'),
       'severity' => $exists ? REQUIREMENT_OK : REQUIREMENT_ERROR,
-      'value' => t('%lib library %state.',
-        ['%lib' => 'KnownUser.V3.PHP',
-        '%state' => $exists ? 'installed' : 'not installed']),
+      'value' => $t('%lib library %state.',
+        [
+          '%lib' => 'KnownUser.V3.PHP',
+          '%state' => $exists ? 'installed' : 'not installed',
+        ]),
     );
     module_load_include('php', 'queueit', 'src/classes/QueueitBase');
     if ($exists && class_exists('QueueitBase') && !((new QueueitBase)->validateConfig())) {
       $requirements['queueit']['value'] .= ' ' . $t("But not configured correctly.");
       $requirements['queueit']['severity'] = REQUIREMENT_WARNING;
-    } else {
-      $queueit = new QueueitBase;
+    }
+    else {
+      $queueit = new QueueitBase();
       $config = $queueit->getIntegrationConfig();
       $requirements['queueit']['severity'] = $config ? REQUIREMENT_OK : REQUIREMENT_WARNING;
       $requirements['queueit']['description'] = json_encode(json_decode($config), TRUE);
@@ -36,4 +39,3 @@ function queueit_requirements($phase) {
 
   return $requirements;
 }
-

queueit.module

@@ -5,7 +5,7 @@
  * Queue-it main module file.
  */
 
-define('QUEUEIT_EXCLUDE',  "admin\nadmin/*\nsites/*\nsystem/ajax/*");
+define('QUEUEIT_EXCLUDE', "admin\nadmin/*\nsites/*\nsystem/ajax/*");
 
 /**
  * Implements hook_help().
@@ -16,7 +16,7 @@ function queueit_help($path, $arg) {
   $content .= file_get_contents(libraries_get_path('composer') . '/queueit/knownuserv3' . '/README.md');
   module_load_include('inc', 'queueit');
   switch ($path) {
-    // Main module help for the queueit module
+    // Main module help for the queueit module.
     case 'admin/help#queueit':
       return '<p>' . queueit_md2html($content) . '</p>';
   }
@@ -43,13 +43,13 @@ function queueit_init() {
     // Check for matching page path to exclude.
     $page_match = drupal_match_path($curr_path, drupal_strtolower($path));
     if ($curr_path != $_GET['q']) {
-      $page_match = $page_match || drupal_match_path($_GET['q'], $pages);
+      $page_match = $page_match || drupal_match_path($_GET['q'], drupal_strtolower($path));
     }
     if ($page_match) {
       return;
     }
   }
-  $known_user = new QueueitKnownUser;
+  $known_user = new QueueitKnownUser();
   // Ignore processing if the config is invalid.
   if (!$known_user->validateConfig()) {
     return;
@@ -67,6 +67,7 @@ function queueit_init() {
       case 'code':
         $result = $known_user->validateRequestByIntegrationConfig();
         break;
+
       case 'integration':
         $result = $known_user->resolveRequestByLocalEventConfig();
         break;
@@ -106,16 +107,16 @@ function queueit_menu() {
   return $items;
 }
 
-/** 
+/**
  * Implements hook_library().
  */
 function queueit_library() {
   // Register libraries available in the external directory.
-  $path = libraries_get_path('composer') . '/queueit/knownuserv3';
   $libraries['queueit/KnownUser'] = array(
     'title' => 'KnownUser.V3.PHP',
+    'website' => 'https://github.com/queueit/KnownUser.V3.PHP',
     'version' => '3',
-  );    
+  );
   return $libraries;
 }
 

src/classes/QueueitBase.php

@@ -7,7 +7,7 @@
  */
 class QueueitBase {
 
-  // Protected variables.
+  /* Protected variables */
   protected $apiKey;         // API Key.
   protected $customerID;     // Customer ID.
   protected $secretKey;      // Secret key.
@@ -20,15 +20,14 @@ class QueueitBase {
   protected $layoutName;     // Name of the queue ticket layout.
   protected $cultureLayout;  // Culture of the queue ticket layout.
   protected $isDebug;        // Debug mode.
-
-  // Constants.
+  /* Constants */
   const QI_API_DOMAIN = 'queue-it.net';
   const QI_CONFIG_URI = '/status/integrationconfig';
 
   /**
    * Class constructor.
    */
-  function __construct($customer_id = '', $secret_key = '', $api_key = '') {
+  public function __construct($customer_id = '', $secret_key = '', $api_key = '') {
     $this->apiKey = $api_key
       ?: variable_get('queueit_api_key');
     $this->customerID = $customer_id
@@ -48,9 +47,9 @@ function __construct($customer_id = '', $secret_key = '', $api_key = '') {
    * Validate config.
    *
    * @return bools
-   * Returns TRUE if config is valid (e.g. credentials aren't empty).
+   *   Returns TRUE if config is valid (e.g. credentials aren't empty).
    */
-  function validateConfig() {
+  public function validateConfig() {
     return $this->getCustomerId() && $this->secretKey;
   }
 
@@ -59,14 +58,14 @@ function validateConfig() {
   /**
    * Sets event config.
    */
-  function setEventConfig() {
-    $eventConfig = new QueueEventConfig;
+  public function setEventConfig() {
+    $eventConfig = new QueueEventConfig();
 
     // ID of the queue to use.
     $eventConfig->eventId = "";
 
     // Domain name of the queue.
-    // Usually in the format [CustomerId].queue-it.net
+    // Usually in the format [CustomerId].queue-it.net.
     $eventConfig->queueDomain = $this->queueDomain;
 
     // Domain name where the Queue-it session cookie should be saved.
@@ -75,14 +74,14 @@ function setEventConfig() {
 
     // Validity of the Queue-it session cookie.
     // Optional. Default is 10 minutes.
-    $eventConfig->cookieValidityMinute = $this->cookieValidity; 
+    $eventConfig->cookieValidityMinute = $this->cookieValidity;
 
     // Should the Queue-it session cookie validity time be extended each time the validation runs?
     // Optional. Default is true.
     $eventConfig->extendCookieValidity = $this->extCookieTime;
 
     // Name of the queue ticket layout - e.g. "Default layout by Queue-it".
-    // Optional. Default is to take what is specified on the Event
+    // Optional. Default is to take what is specified on the Event.
     $eventConfig->layoutName = $this->layoutName;
 
     // Culture of the queue ticket layout in the format specified at:
@@ -99,9 +98,9 @@ function setEventConfig() {
    * Retrieve the integration config.
    *
    * @return string
-   * Returns plain JSON content.
+   *   Returns plain JSON content.
    */
-  function getIntegrationConfig() {
+  public function getIntegrationConfig() {
     // Ignore fetching on invalid configuration.
     if (!$this->validateConfig()) {
       return NULL;
@@ -116,7 +115,7 @@ function getIntegrationConfig() {
   /**
    * Get the integration config URL.
    */
-  function getIntegrationConfigPath() {
+  public function getIntegrationConfigPath() {
     return sprintf("http://%s.%s%s/%s",
       $this->getCustomerId(),
       self::QI_API_DOMAIN,
@@ -128,42 +127,42 @@ function getIntegrationConfigPath() {
   /**
    * Get API Key.
    */
-  function getAPIKey() {
+  public function getAPIKey() {
     return $this->apiKey;
   }
 
   /**
    * Get customer ID.
    */
-  function getCustomerId() {
+  public function getCustomerId() {
     return $this->customerID;
   }
 
   /**
    * Get secret key.
    */
-  function getSecretKey() {
+  public function getSecretKey() {
     return $this->secretKey;
   }
 
   /**
    * Get a queue token.
    */
-  function getQueueToken() {
+  public function getQueueToken() {
     return filter_input(INPUT_GET, 'queueittoken');
   }
 
   /**
    * Helper method to get the current URL.
    */
-  function getFullRequestUri() {
+  public function getFullRequestUri() {
     return file_create_url(current_path());
   }
 
   /**
    * Gets event config.
    */
-  function getEventConfig() {
+  public function getEventConfig() {
     return $this->eventConfig;
   }
 

src/classes/QueueitKnownUser.php

@@ -10,7 +10,7 @@ class QueueitKnownUser extends QueueitBase {
   /**
    * Validate that the user has been through the queue.
    */
-  function validateRequestByIntegrationConfig() {
+  public function validateRequestByIntegrationConfig() {
     /*
      * This call will validate the timestamp and hash
      * and if valid create a cookie with a TTL like:
@@ -31,7 +31,7 @@ function validateRequestByIntegrationConfig() {
   /**
    * Verify if the user has been through the queue.
    */
-  function resolveRequestByLocalEventConfig() {
+  public function resolveRequestByLocalEventConfig() {
     $this->setEventConfig();
     return KnownUser::resolveRequestByLocalEventConfig(
       $this->getFullRequestUri(),

tests/queueit.test

@@ -24,7 +24,7 @@ class QueueitTestCase extends DrupalWebTestCase {
   /**
    * Implements setUp().
    */
-  function setUp() {
+  public function setUp() {
     // Call the parent with an array of modules to enable for the test.
     parent::setUp(array('queueit'));
 
@@ -34,7 +34,7 @@ class QueueitTestCase extends DrupalWebTestCase {
   /**
    * Test the module's functionality.
    */
-  function testTodoChangeThisName() {
+  public function testTodoChangeThisName() {
     // TODO: write test!
   }