SherifElfadaly / Laravel-Api-Skeleton

src/Modules/V1/Acl/Http/Controllers/UsersController.php

Indentation +215 added lines, -215 removed lines

@@ -7,219 +7,219 @@
 
 class UsersController extends BaseApiController
 {
-    /**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model               = 'users';
-
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['account', 'logout', 'sendreset'];
-
-    /**
-     * List of all route actions that the base api controller
-     * will skip login check for them.
-     * @var array
-     */
-    protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken'];
-
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules     = [
-        'user_name'     => 'string|unique:users,user_name,{id}', 
-        'email'         => 'required|email|unique:users,email,{id}', 
-        'password'      => 'min:6'
-    ];
-
-    /**
-     * Return the logged in user account.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function account()
-    {
-        $relations = $this->relations && $this->relations['account'] ? $this->relations['account'] : [];
-        return \Response::json(\Core::users()->account($relations), 200);
-    }
-
-    /**
-     * Block the user.
-     *
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function block($id)
-    {
-        return \Response::json(\Core::users()->block($id), 200);
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function unblock($id)
-    {
-        return \Response::json(\Core::users()->unblock($id), 200);
-    }
-
-    /**
-     * Logout the user.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function logout()
-    {
-        return \Response::json(\Core::users()->logout(), 200);
-    }
-
-    /**
-     * Handle a registration request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function register(Request $request)
-    {
-        $this->validate($request, [
-            'user_name'     => 'string|unique:users,user_name,{id}', 
-            'email'         => 'required|email|unique:users,email,{id}', 
-            'password'      => 'required|min:6'
-            ]);
-
-        return \Response::json(\Core::users()->register($request->only('email', 'password')), 200);
-    }
-
-    /**
-     * Handle a login request of the none admin to the application.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function login(Request $request)
-    {
-        $this->validate($request, [
-            'email'    => 'required|email', 
-            'password' => 'required|min:6',
-            'admin'    => 'boolean'
-            ]);
-
-        return \Response::json(\Core::users()->login($request->only('email', 'password'), $request->get('admin')), 200);
-    }
-
-    /**
-     * Handle a social login request of the none admin to the application.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function loginSocial(Request $request)
-    {
-        $this->validate($request, [
-            'auth_code'    => 'required_without:access_token',
-            'access_token' => 'required_without:auth_code',
-            'type'         => 'required|in:facebook,google'
-            ]);
-
-        return \Response::json(\Core::users()->loginSocial($request->only('auth_code', 'access_token', 'type')), 200);
-    }
-
-    /**
-     * Handle an assign groups to user request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function assigngroups(Request $request)
-    {
-        $this->validate($request, [
-            'group_ids' => 'required|exists:groups,id', 
-            'user_id'   => 'required|exists:users,id'
-            ]);
-
-        return \Response::json(\Core::users()->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
-    }
-
-    /**
-     * Send a reset link to the given user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function sendreset(Request $request)
-    {
-        $this->validate($request, ['email' => 'required|email', 'url' => 'required|url']);
-
-        return \Response::json(\Core::users()->sendReset($request->only('email'), $request->get('url')), 200);
-    }
-
-    /**
-     * Reset the given user's password.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function resetpassword(Request $request)
-    {
-        $this->validate($request, [
-            'token'                 => 'required',
-            'email'                 => 'required|email',
-            'password'              => 'required|confirmed|min:6',
-            'password_confirmation' => 'required',
-        ]);
-
-        return \Response::json(\Core::users()->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 200);
-    }
-
-    /**
-     * Change the logged in user password.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function changePassword(Request $request)
-    {
-        $this->validate($request, [
-            'old_password'          => 'required',
-            'password'              => 'required|confirmed|min:6',
-            'password_confirmation' => 'required',
-        ]);
-
-        return \Response::json(\Core::users()->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
-    }
-
-    /**
-     * Refresh the expired login token.
-     *
-     * @return \Illuminate\Http\Response
-     */
-    public function refreshtoken()
-    {
-        return \Response::json(\Core::users()->refreshtoken(), 200);
-    }
-
-    /**
-     * Paginate all users with inthe given group.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string $groupName
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function group(Request $request, $groupName, $perPage = 15, $sortBy = 'created_at', $desc = 1)
-    {
-        $relations = $this->relations && $this->relations['group'] ? $this->relations['group'] : [];
-        return \Response::json(\Core::users()->group($request->all(), $groupName, $relations, $perPage, $sortBy, $desc), 200);
-    }
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'users';
+
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['account', 'logout', 'sendreset'];
+
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip login check for them.
+	 * @var array
+	 */
+	protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken'];
+
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules     = [
+		'user_name'     => 'string|unique:users,user_name,{id}', 
+		'email'         => 'required|email|unique:users,email,{id}', 
+		'password'      => 'min:6'
+	];
+
+	/**
+	 * Return the logged in user account.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function account()
+	{
+		$relations = $this->relations && $this->relations['account'] ? $this->relations['account'] : [];
+		return \Response::json(\Core::users()->account($relations), 200);
+	}
+
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function block($id)
+	{
+		return \Response::json(\Core::users()->block($id), 200);
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function unblock($id)
+	{
+		return \Response::json(\Core::users()->unblock($id), 200);
+	}
+
+	/**
+	 * Logout the user.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function logout()
+	{
+		return \Response::json(\Core::users()->logout(), 200);
+	}
+
+	/**
+	 * Handle a registration request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function register(Request $request)
+	{
+		$this->validate($request, [
+			'user_name'     => 'string|unique:users,user_name,{id}', 
+			'email'         => 'required|email|unique:users,email,{id}', 
+			'password'      => 'required|min:6'
+			]);
+
+		return \Response::json(\Core::users()->register($request->only('email', 'password')), 200);
+	}
+
+	/**
+	 * Handle a login request of the none admin to the application.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function login(Request $request)
+	{
+		$this->validate($request, [
+			'email'    => 'required|email', 
+			'password' => 'required|min:6',
+			'admin'    => 'boolean'
+			]);
+
+		return \Response::json(\Core::users()->login($request->only('email', 'password'), $request->get('admin')), 200);
+	}
+
+	/**
+	 * Handle a social login request of the none admin to the application.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function loginSocial(Request $request)
+	{
+		$this->validate($request, [
+			'auth_code'    => 'required_without:access_token',
+			'access_token' => 'required_without:auth_code',
+			'type'         => 'required|in:facebook,google'
+			]);
+
+		return \Response::json(\Core::users()->loginSocial($request->only('auth_code', 'access_token', 'type')), 200);
+	}
+
+	/**
+	 * Handle an assign groups to user request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function assigngroups(Request $request)
+	{
+		$this->validate($request, [
+			'group_ids' => 'required|exists:groups,id', 
+			'user_id'   => 'required|exists:users,id'
+			]);
+
+		return \Response::json(\Core::users()->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
+	}
+
+	/**
+	 * Send a reset link to the given user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function sendreset(Request $request)
+	{
+		$this->validate($request, ['email' => 'required|email', 'url' => 'required|url']);
+
+		return \Response::json(\Core::users()->sendReset($request->only('email'), $request->get('url')), 200);
+	}
+
+	/**
+	 * Reset the given user's password.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function resetpassword(Request $request)
+	{
+		$this->validate($request, [
+			'token'                 => 'required',
+			'email'                 => 'required|email',
+			'password'              => 'required|confirmed|min:6',
+			'password_confirmation' => 'required',
+		]);
+
+		return \Response::json(\Core::users()->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 200);
+	}
+
+	/**
+	 * Change the logged in user password.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function changePassword(Request $request)
+	{
+		$this->validate($request, [
+			'old_password'          => 'required',
+			'password'              => 'required|confirmed|min:6',
+			'password_confirmation' => 'required',
+		]);
+
+		return \Response::json(\Core::users()->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
+	}
+
+	/**
+	 * Refresh the expired login token.
+	 *
+	 * @return \Illuminate\Http\Response
+	 */
+	public function refreshtoken()
+	{
+		return \Response::json(\Core::users()->refreshtoken(), 200);
+	}
+
+	/**
+	 * Paginate all users with inthe given group.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string $groupName
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function group(Request $request, $groupName, $perPage = 15, $sortBy = 'created_at', $desc = 1)
+	{
+		$relations = $this->relations && $this->relations['group'] ? $this->relations['group'] : [];
+		return \Response::json(\Core::users()->group($request->all(), $groupName, $relations, $perPage, $sortBy, $desc), 200);
+	}
 }

src/Modules/V1/Core/Utl/ErrorHandler.php

Indentation +101 added lines, -101 removed lines

@@ -2,105 +2,105 @@
 
 class ErrorHandler
 {
-    public function unAuthorized()
-    {
-        $error = ['status' => 401, 'message' => trans('errors.unAuthorized')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function tokenExpired()
-    {
-        $error = ['status' => 403, 'message' => trans('errors.tokenExpired')];
-        abort($error['status'], $error['message']);
-    }
-
-     public function noPermissions()
-    {
-        $error = ['status' => 403, 'message' => trans('errors.noPermissions')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function loginFailed()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.loginFailed')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function noSocialEmail()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.noSocialEmail')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function userAlreadyRegistered()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.userAlreadyRegistered')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function connectionError()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.connectionError')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function redisNotRunning()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.redisNotRunning')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function dbQueryError()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.dbQueryError')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function cannotCreateSetting()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.cannotCreateSetting')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function cannotUpdateSettingKey()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.cannotUpdateSettingKey')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function userIsBlocked()
-    {
-        $error = ['status' => 403, 'message' => trans('errors.userIsBlocked')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function invalidResetToken()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.invalidResetToken')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function invalidResetPassword()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.invalidResetPassword')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function invalidOldPassword()
-    {
-        $error = ['status' => 400, 'message' => trans('errors.invalidOldPassword')];
-        abort($error['status'], $error['message']);
-    }
-
-    public function notFound($text)
-    {
-        $error = ['status' => 404, 'message' => trans('errors.notFound', ['replace' => $text])];
-        abort($error['status'], $error['message']);
-    }
-
-    public function generalError()
-    {
-        $error = ['status' => 404, 'message' => trans('errors.generalError')];
-        abort($error['status'], $error['message']);
-    }
+	public function unAuthorized()
+	{
+		$error = ['status' => 401, 'message' => trans('errors.unAuthorized')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function tokenExpired()
+	{
+		$error = ['status' => 403, 'message' => trans('errors.tokenExpired')];
+		abort($error['status'], $error['message']);
+	}
+
+	 public function noPermissions()
+	{
+		$error = ['status' => 403, 'message' => trans('errors.noPermissions')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function loginFailed()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.loginFailed')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function noSocialEmail()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.noSocialEmail')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function userAlreadyRegistered()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.userAlreadyRegistered')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function connectionError()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.connectionError')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function redisNotRunning()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.redisNotRunning')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function dbQueryError()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.dbQueryError')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function cannotCreateSetting()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.cannotCreateSetting')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function cannotUpdateSettingKey()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.cannotUpdateSettingKey')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function userIsBlocked()
+	{
+		$error = ['status' => 403, 'message' => trans('errors.userIsBlocked')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function invalidResetToken()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.invalidResetToken')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function invalidResetPassword()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.invalidResetPassword')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function invalidOldPassword()
+	{
+		$error = ['status' => 400, 'message' => trans('errors.invalidOldPassword')];
+		abort($error['status'], $error['message']);
+	}
+
+	public function notFound($text)
+	{
+		$error = ['status' => 404, 'message' => trans('errors.notFound', ['replace' => $text])];
+		abort($error['status'], $error['message']);
+	}
+
+	public function generalError()
+	{
+		$error = ['status' => 404, 'message' => trans('errors.generalError')];
+		abort($error['status'], $error['message']);
+	}
 }
\ No newline at end of file