AppClient::getSecretByAppId() - Code Metrics - ArcherZdip/laravel-api-auth - Measure and Improve Code Quality continuously with Scrutinizer

AppClient::getSecretByAppId() A
last analyzed 2020-03-25 14:47 UTC

↳ Parent: AppClient

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	9
rs	10
cc	2
nc	2
nop	1

<?php

namespace ArcherZdip\LaravelApiAuth\Models;

use Illuminate\Support\Str;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Support\Facades\Cache;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Database\Eloquent\Model;
filter:
    dependency_paths: ["lib/*"]
use Illuminate\Database\Eloquent\SoftDeletes;
filter:
    dependency_paths: ["lib/*"]

class AppClient extends Model
{
    use SoftDeletes;

    const EVENT_NAME_CREATED     = 'created';
    const EVENT_NAME_ACTIVATED   = 'activated';
    const EVENT_NAME_DEACTIVATED = 'deactivated';
    const EVENT_NAME_DELETED     = 'deleted';

    /** @var int activate status */
    const ACTIVATE = 1;
    const DEACTIVATE = 0;

    protected static $nameRegex = '/^[a-z0-9-]{1,255}$/';

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'name',
        'appid',
        'secret',
        'active'
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array
     */
    protected $hidden = [];

    public static function boot()
    {
        parent::boot();

        static::created(function(AppClient $appClient) {
            self::logApiAuthOprateEvent($appClient, self::EVENT_NAME_CREATED);
        });

        static::updated(function(AppClient $appClient) {

            $changed = $appClient->getDirty();

            if (isset($changed) && $changed['active'] === self::ACTIVATE) {
                self::logApiAuthOprateEvent($appClient, self::EVENT_NAME_ACTIVATED);
            }

            if (isset($changed) && $changed['active'] === self::DEACTIVATE) {
                self::logApiAuthOprateEvent($appClient, self::EVENT_NAME_DEACTIVATED);
            }

            // flush cache
            self::flushCache($appClient->name);
        });

        static::deleted(function(AppClient $appClient) {
            self::logApiAuthOprateEvent($appClient, self::EVENT_NAME_DELETED);

            // flush cache
            self::flushCache($appClient->name);
        });

    }

    /**
     * AppClient constructor.
     * @param array $attributes
     */
    public function __construct(array $attributes = [])
    {
        parent::__construct($attributes);

        $this->setTable(config('apikey.table_name.app_clients'));
        $this->setTable(/** @scrutinizer ignore-call */ config('apikey.table_name.app_clients'));
    }

    /**
     * Get secret by appid
     *
     * @param $appid
     * @return mixed
     */
    public static function getSecretByAppId($appid)
    {
        // cache false
        if (!config('apikey.cache.is_taken', false)) {
        if (!/** @scrutinizer ignore-call */ config('apikey.cache.is_taken', false)) {
            return self::getValueById($appid);
        }

        return Cache::rememberForever(config('apikey.cache.cache_key', 'apikey:clients:') . $appid, function () use ($appid) {
            return self::getValueById($appid);
        });
    }

    /**
     * Get model by appid
     *
     * @param $appid
     * @return mixed
     */
    public static function getValueById($appid)
    {
        return self::where([
            'active' => self::ACTIVATE,
            'appid'  => $appid
        ])->first();
    }

    /**
     * Generate AppId
     *
     * @return string
     */
    public static function generateAppId()
    {
        do {
            $appId = Str::random(config('apikey.appid_length', 16));
            $appId = Str::random(/** @scrutinizer ignore-call */ config('apikey.appid_length', 16));
        } while (self::appIdExists($appId));

        return $appId;
    }

    /**
     * Generate secret
     *
     * @return string
     */
    public static function generateSecret()
    {
        return Str::random(config('apikey.secret_length', 64));
        return Str::random(/** @scrutinizer ignore-call */ config('apikey.secret_length', 64));
    }

    /**
     * Check name is valid format
     *
     * @param $name
     * @return bool
     */
    public static function isValidName($name)
    {
        return (bool)preg_match(self::$nameRegex, $name);
    }

    /**
     * Check name is or not exists
     *
     * @param $name
     * @return bool
     */
    public static function nameExists($name)
    {
        return self::where('name', '=', $name)->first() instanceof self;
    }

    /**
     * Check AppId is or not exists
     *
     * @param $secret
     * @return bool
     */
    public static function appIdExists($appId)
    {
        return self::where('appid', $appId)->withTrashed()->first() instanceof self;
    }

    /**
     * Flush the key cache
     *
     * @param $cacheKey
     */
    public function flushCache($cacheKey)
    {
        Cache::forget($cacheKey);
    }

    /**
     * Log an app oprate admin event
     *
     * @param AppClient $appClient
     * @param string $eventName
     */
    protected static function logApiAuthOprateEvent(AppClient $appClient, $eventName)
    {
        $event = new ApiAuthOprateEvent();
        $event->app_client_id = $appClient->id;
        $event->ip_address = request()->ip();
        $event->ip_address = /** @scrutinizer ignore-call */ request()->ip();
        $event->event = $eventName;
        $event->save();
    }
}

ArcherZdip / laravel-api-auth

AppClient::getSecretByAppId() A last analyzed 2020-03-25 14:47 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AppClient::getSecretByAppId() A
last analyzed 2020-03-25 14:47 UTC