Initial version of Queue-it module

Author: kenorb

README.md

@@ -0,0 +1,51 @@
+Queue-it
+========
+
+Queue-it is an online queue system designed to manage website overload during extreme end-user peaks. It offers an API for programmatic access to configuring and controlling the queue.
+
+About module
+============
+
+This module is unofficial implementation of [Queue-it Framework](https://queue-it.com/) for Drupal CMS. You need to have existing Queue-it account in order to use it.
+
+Authentication
+==============
+
+In order to authenticate and authorize the `Api-Key`, HTTP header must be supplied in the REST request. The key can be found in the [GO Queue-it Platform](https://go.queue-it.net/account/security).
+
+This API Key should be specified in the settings page of the module at `admin/config/services/queueit`.
+
+Dependencies
+============
+
+The module depends on [Known User Implementation for PHP](https://github.com/queueit/KnownUser.V3.PHP) hosted at GitHub repository.
+
+With composer, setting up things is fairly easy.
+
+1. Download and install the [Composer Manager module](https://drupal.org/project/composer_manager).
+
+2. Run the drush command: `drush composer-manager install`.
+
+   If you are already using `composer_manager` with other modules, simply run:
+   "drush composer-manager update"
+   This should set up all of your dependencies and all of the libraries necessary
+   to run behat tests.
+
+To check if the library has been installed, as admin visit /admin/config/system/composer-manager page.
+
+By default, `composer_manager` will place all of the libraries at /sites/all/vendor.
+Inside of the vendor directory there is a bin directory and inside of it we can
+find the behat executable.
+
+Dependencies
+============
+
+Notes
+=====
+
+- Queue-it Security Documentation can be found at: <http://securitydoc-assets.queue-it.net>.
+- The latest version and API (2) documentation can be found at: <https://api2.queue-it.net/>.
+- 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]>.

composer.json

@@ -0,0 +1,30 @@
+{
+    "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",
+    "support": {
+        "issues": "https://github.com/queueit/KnownUser.V3.PHP/issues",
+        "source": "https://github.com/queueit/KnownUser.V3.PHP"
+    },
+    "keywords": ["Queue-it", "framework"],
+    "license": "LGPL-3.0+",
+    "require": {
+        "queueit/KnownUser.V3.PHP": "dev-master",
+        "php": ">=5.2.0"
+    },
+		"repositories": [
+      {
+        "type": "package",
+        "package": {
+          "name": "queueit/KnownUser.V3.PHP",
+          "version": "dev-master",
+          "source": {
+            "type": "git",
+            "url": "https://github.com/queueit/KnownUser.V3.PHP.git",
+            "reference": "master"
+          }
+        }
+      }
+    ]
+}

queueit.admin.inc

@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * @file
+ * Configuration of the Queue-it module.
+ */
+
+/**
+ * Form builder.
+ */
+function queueit_settings_form($form, &$form_state) {
+  $form['queueit_api_key'] = array(
+    '#type' => 'textfield',
+    '#title' => t('API Key'),
+    '#description' => t('Specify the Api-key which can be supplied through the query string parameter. The key can be found in the GO Queue-it Platform.'),
+    '#default_value' => variable_get('queueit_api_key'),
+    '#required' => TRUE,
+  );
+
+  return system_settings_form($form);
+}

queueit.api.php

@@ -0,0 +1,11 @@
+<?php
+
+/**
+ * @file
+ * Hooks provided by the Queue-it module.
+ */
+
+/**
+ * @addtogroup hooks
+ * @{
+ */

queueit.info

@@ -0,0 +1,7 @@
+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
+dependencies[] = composer_manager

queueit.install

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * @file
+ * Module's installation file.
+ */
+
+/**
+ * Implements hook_requirements().
+ */
+function queueit_requirements($phase) {
+  $requirements = array();
+
+  if ($phase == 'runtime') {
+    $t = get_t();
+    $known_user_lib = drupal_get_library('queueit', 'queueit/KnownUser');
+    $exists = $known_user_lib;
+    $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']),
+    );
+  }
+
+  return $requirements;
+}
+

queueit.module

@@ -0,0 +1,72 @@
+<?php
+
+/**
+ * @file
+ * TODO: Enter file description here.
+ */
+
+/**
+ * Implements hook_help().
+ */
+function queueit_help($path, $arg) {
+  switch ($path) {
+    // Main module help for the block module
+    case 'admin/help#block':
+      return '<p>' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Bartik, for example, implements the regions "Sidebar first", "Sidebar second", "Featured", "Content", "Header", "Footer", etc., and a block may appear in any one of these areas. The <a href="@blocks">blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', array('@blocks' => url('admin/structure/block'))) . '</p>';
+
+    // Help for another path in the block module
+    case 'admin/structure/block':
+      return '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page.') . '</p>';
+  }
+}
+
+/**
+ * Implements hook_menu().
+ */
+function queueit_menu() {
+  $items = array();
+  $items['admin/config/services/queueit'] = array(
+    'title' => 'Queue-it settings',
+    'description' => 'Configure settings for Queue-it.',
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('queueit_settings_form'),
+    'access arguments' => array('administer queueit'),
+    'file' => 'queueit.admin.inc',
+  );
+
+  return $items;
+}
+
+/** 
+ * Implements hook_library().
+ */
+function queueit_library() {
+  // Register libraries available in the external directory.
+  $path = libraries_get_path('composer') . '/queueit/KnownUser.V3.PHP';
+  $libraries['queueit/KnownUser'] = array(
+    'title' => 'KnownUser.V3.PHP',
+    'version' => '3',
+  );    
+	return $libraries;
+}
+
+/**
+ * Implements hook_permission().
+ */
+function queueit_permission() {
+  $permissions = array();
+  $permissions['administer'] = array(
+    'title' => t('TODO: enter permission title'),
+    'description' => t('TODO: enter permission description'),
+  );
+  $permissions['queueit'] = array(
+    'title' => t('TODO: enter permission title'),
+    'description' => t('TODO: enter permission description'),
+  );
+  $permissions['administer queueit'] = array(
+    'title' => t('TODO: enter permission title'),
+    'description' => t('TODO: enter permission description'),
+  );
+
+  return $permissions;
+}

tests/queueit.test

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * @file
+ * Contains tests for the Queue-it module.
+ */
+
+/**
+ * Test case.
+ */
+class QueueitTestCase extends DrupalWebTestCase {
+
+  /**
+   * Implements getInfo().
+   */
+  public static function getInfo() {
+    return array(
+      'name' => t('Queue-it tests'),
+      'description' => t('TODO: write me.'),
+      'group' => t('Queue-it'),
+    );
+  }
+
+  /**
+   * Implements setUp().
+   */
+  function setUp() {
+    // Call the parent with an array of modules to enable for the test.
+    parent::setUp(array('queueit'));
+
+    // TODO: perform additional setup tasks here if required.
+  }
+
+  /**
+   * Test the module's functionality.
+   */
+  function testTodoChangeThisName() {
+    // TODO: write test!
+  }
+
+}