Storyplayer\SPv2\Modules\Users\FromUsers

Complexity

Total Complexity

3

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getUser()	0	17	2
A	generateNewPassword()	0	4	1

<?php

/**
 * Copyright (c) 2011-present Mediasift Ltd
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   * Neither the names of the copyright holders nor the names of his
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Libraries
 * @package   Storyplayer/Modules/Users
 * @author    Stuart Herbert <stuart.herbert@datasift.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */

namespace Storyplayer\SPv2\Modules\Users;

use DataSift\Stone\PasswordLib\BasicGenerator;
use Prose\Prose;
use Storyplayer\SPv2\Modules\Exceptions;
use Storyplayer\SPv2\Modules\Log;

/**
 * work with the library of test users
 *
 * @category  Libraries
 * @package   Storyplayer/Modules/Users
 * @author    Stuart Herbert <stuart.herbert@datasift.com>
 * @copyright 2011-present Mediasift Ltd www.datasift.com
 * @license   http://www.opensource.org/licenses/bsd-license.php  BSD License
 * @link      http://datasift.github.io/storyplayer
 */
class FromUsers extends Prose
{
    /**
     * return a user from the test users file
     *
     * @param  string $userId
     *         the ID of the user to retrieve
     * @return \DataSift\Stone\ObjectLib\BaseObject
     */
    public function getUser($userId)
    {
        // what are we doing?
        $log = Log::usingLog()->startAction("get user ID '{$userId}'");

        // do we have this user?
        $users = $this->st->getTestUsers();
        if (!isset($users->$userId)) {
            $msg = "user ID '{$userId}' not found";
            $log->endAction($msg);
            throw Exceptions::newActionFailedException($msg);
        }

        // all done
        $log->endAction($users->$userId);
        return $users->$userId;
    }

    /**
     * generates a random password of the requested length
     *
     * @param  integer $minLength
     *         minimum number of characters to include
     * @param  integer $maxLength
     *         maximum number of characters to include
     * @return string
     *         the generated password
     */
    public function generateNewPassword($minLength = 8, $maxLength = 20)
    {
        return BasicGenerator::generatePassword($minLength, $maxLength);
    }
}