SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Acl/Proxy/LoginProxy.php

Indentation +91 added lines, -91 removed lines

@@ -5,95 +5,95 @@
 
 class LoginProxy
 {
-    private $apiConsumer;
-
-    private $auth;
-
-    private $request;
-
-    private $userRepository;
-
-    public function __construct(Application $app) 
-    {
-
-        $this->userRepository = $app->make('App\Modules\Acl\Repositories\UserRepository');
-        $this->apiConsumer    = $app->make('apiconsumer');
-        $this->auth           = $app->make('auth');
-        $this->request        = $app->make('request');
-    }
-
-    /**
-     * Attempt to create an access token using user credentials.
-     *
-     * @param  array   $credentials
-     * @param  boolean $adminLogin
-     * @return array
-     */
-    public function login($credentials, $adminLogin = false)
-    {
-        $this->userRepository->login($credentials, $adminLogin);
-
-        return $this->proxy('password', [
-            'username' => $credentials['email'],
-            'password' => $credentials['password']
-        ]);
-    }
-
-    /**
-     * Attempt to refresh the access token useing the given refresh token.
-     * 
-     * @param  string $refreshToken
-     * @return array
-     */
-    public function refreshtoken($refreshToken)
-    {
-        return $this->proxy('refresh_token', [
-            'refresh_token' => $refreshToken
-        ]);
-    }
-
-    /**
-     * Proxy a request to the OAuth server.
-     *
-     * @param string $grantType what type of grant type should be proxied
-     * @param array 
-     */
-    public function proxy($grantType, array $data = [])
-    {
-        $data = array_merge($data, [
-            'client_id'     => config('skeleton.passport_client_id'),
-            'client_secret' => config('skeleton.passport_client_secret'),
-            'grant_type'    => $grantType
-        ]);
-
-        $response = $this->apiConsumer->post('/oauth/token', $data);
-
-        if ( ! $response->isSuccessful()) 
-        {
-            if ($grantType == 'refresh_token') 
-            {
-                \ErrorHandler::invalidRefreshToken();
-            }
-
-            \ErrorHandler::loginFailed();
-        }
-
-        $data = json_decode($response->getContent());
-
-        return [
-            'access_token'  => $data->access_token,
-            'refresh_token' => $data->refresh_token,
-            'expires_in'    => $data->expires_in
-        ];
-    }
-
-    /**
-     * Logs out the user. We revoke access token and refresh token.
-     * 
-     * @return void
-     */
-    public function logout()
-    {
-        \Core::users()->revokeAccessToken($this->auth->user()->token());
-    }
+	private $apiConsumer;
+
+	private $auth;
+
+	private $request;
+
+	private $userRepository;
+
+	public function __construct(Application $app) 
+	{
+
+		$this->userRepository = $app->make('App\Modules\Acl\Repositories\UserRepository');
+		$this->apiConsumer    = $app->make('apiconsumer');
+		$this->auth           = $app->make('auth');
+		$this->request        = $app->make('request');
+	}
+
+	/**
+	 * Attempt to create an access token using user credentials.
+	 *
+	 * @param  array   $credentials
+	 * @param  boolean $adminLogin
+	 * @return array
+	 */
+	public function login($credentials, $adminLogin = false)
+	{
+		$this->userRepository->login($credentials, $adminLogin);
+
+		return $this->proxy('password', [
+			'username' => $credentials['email'],
+			'password' => $credentials['password']
+		]);
+	}
+
+	/**
+	 * Attempt to refresh the access token useing the given refresh token.
+	 * 
+	 * @param  string $refreshToken
+	 * @return array
+	 */
+	public function refreshtoken($refreshToken)
+	{
+		return $this->proxy('refresh_token', [
+			'refresh_token' => $refreshToken
+		]);
+	}
+
+	/**
+	 * Proxy a request to the OAuth server.
+	 *
+	 * @param string $grantType what type of grant type should be proxied
+	 * @param array 
+	 */
+	public function proxy($grantType, array $data = [])
+	{
+		$data = array_merge($data, [
+			'client_id'     => config('skeleton.passport_client_id'),
+			'client_secret' => config('skeleton.passport_client_secret'),
+			'grant_type'    => $grantType
+		]);
+
+		$response = $this->apiConsumer->post('/oauth/token', $data);
+
+		if ( ! $response->isSuccessful()) 
+		{
+			if ($grantType == 'refresh_token') 
+			{
+				\ErrorHandler::invalidRefreshToken();
+			}
+
+			\ErrorHandler::loginFailed();
+		}
+
+		$data = json_decode($response->getContent());
+
+		return [
+			'access_token'  => $data->access_token,
+			'refresh_token' => $data->refresh_token,
+			'expires_in'    => $data->expires_in
+		];
+	}
+
+	/**
+	 * Logs out the user. We revoke access token and refresh token.
+	 * 
+	 * @return void
+	 */
+	public function logout()
+	{
+		\Core::users()->revokeAccessToken($this->auth->user()->token());
+	}
 }
\ No newline at end of file

src/Modules/Acl/Repositories/UserRepository.php

Braces +7 added lines, -14 removed lines

@@ -102,20 +102,16 @@ 
         if ( ! $user = $this->first(['email' => $credentials['email']])) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
+        } else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
+        } else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
         {
             \ErrorHandler::loginFailed();
-        }
-        else if ($user->blocked)
+        } else if ($user->blocked)
         {
             \ErrorHandler::userIsBlocked();
-        }
-        else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
+        } else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
         {
             \ErrorHandler::emailNotConfirmed();
         }
@@ -165,8 +161,7 @@ 
         {
             $user->confirmed = 1;
             $user->save();
-        }
-        else if ( ! config('skeleton.disable_confirm_email'))  
+        } else if ( ! config('skeleton.disable_confirm_email'))  
         {
             $this->sendConfirmationEmail($user->email);
         }
@@ -189,12 +184,10 @@ 
         if ( ! $this->hasGroup(['Admin']))
         {
             \ErrorHandler::noPermissions();
-        }
-        else if (\Auth::id() == $userId)
+        } else if (\Auth::id() == $userId)
         {
             \ErrorHandler::noPermissions();
-        }
-        else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
+        } else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
         {
             \ErrorHandler::noPermissions();
         }

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
         $user        = \Core::users()->find(\Auth::id(), $relations);
         foreach ($user->groups()->get() as $group)
         {
-            $group->permissions->each(function ($permission) use (&$permissions){
+            $group->permissions->each(function($permission) use (&$permissions){
                 $permissions[$permission->model][$permission->id] = $permission->name;
             });
         }
@@ -51,7 +51,7 @@ 
         $user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
         $permissions = [];
 
-        $user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
+        $user->groups->pluck('permissions')->each(function($permission) use (&$permissions, $model){
             $permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
         });
         
@@ -80,7 +80,7 @@ 
      */
     public function assignGroups($userId, $groupIds)
     {
-        \DB::transaction(function () use ($userId, $groupIds) {
+        \DB::transaction(function() use ($userId, $groupIds) {
             $user = $this->find($userId);
             $user->groups()->detach();
             $user->groups()->attach($groupIds);
@@ -250,7 +250,7 @@ 
      */
     public function resetPassword($credentials)
     {
-        $response = \Password::reset($credentials, function ($user, $password) {
+        $response = \Password::reset($credentials, function($user, $password) {
             $user->password = $password;
             $user->save();
         });

Doc Comments +3 added lines, -3 removed lines

@@ -61,7 +61,7 @@ 
     /**
      * Check if the logged in user has the given group.
      * 
-     * @param  array $groups
+     * @param  string[] $groups
      * @param  mixed $user
      * @return boolean
      */
@@ -155,7 +155,7 @@ 
      * 
      * @param  array   $credentials
      * @param  boolean $skipConfirmEmail
-     * @return array
+     * @return boolean
      */
     public function register($credentials, $skipConfirmEmail = false)
     {
@@ -246,7 +246,7 @@ 
      * Reset the given user's password.
      *
      * @param  array  $credentials
-     * @return array
+     * @return string|null
      */
     public function resetPassword($credentials)
     {

Indentation +402 added lines, -402 removed lines

@@ -5,414 +5,414 @@
 
 class UserRepository extends AbstractRepository
 {
-    /**
-     * Return the model full namespace.
-     * 
-     * @return string
-     */
-    protected function getModel()
-    {
-        return 'App\Modules\Acl\AclUser';
-    }
-
-
-    /**
-     * Return the logged in user account.
-     *
-     * @param  array   $relations
-     * @return boolean
-     */
-    public function account($relations = [])
-    {
-        $permissions = [];
-        $user        = \Core::users()->find(\Auth::id(), $relations);
-        foreach ($user->groups()->get() as $group)
-        {
-            $group->permissions->each(function ($permission) use (&$permissions){
-                $permissions[$permission->model][$permission->id] = $permission->name;
-            });
-        }
-        $user->permissions = $permissions;
-
-       return $user;
-    }
-
-    /**
-     * Check if the logged in user or the given user 
-     * has the given permissions on the given model.
-     * 
-     * @param  string $nameOfPermission
-     * @param  string $model            
-     * @param  mixed  $user
-     * @return boolean
-     */
-    public function can($nameOfPermission, $model, $user = false)
-    {      
-        $user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
-        $permissions = [];
-
-        $user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
-            $permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
-        });
+	/**
+	 * Return the model full namespace.
+	 * 
+	 * @return string
+	 */
+	protected function getModel()
+	{
+		return 'App\Modules\Acl\AclUser';
+	}
+
+
+	/**
+	 * Return the logged in user account.
+	 *
+	 * @param  array   $relations
+	 * @return boolean
+	 */
+	public function account($relations = [])
+	{
+		$permissions = [];
+		$user        = \Core::users()->find(\Auth::id(), $relations);
+		foreach ($user->groups()->get() as $group)
+		{
+			$group->permissions->each(function ($permission) use (&$permissions){
+				$permissions[$permission->model][$permission->id] = $permission->name;
+			});
+		}
+		$user->permissions = $permissions;
+
+	   return $user;
+	}
+
+	/**
+	 * Check if the logged in user or the given user 
+	 * has the given permissions on the given model.
+	 * 
+	 * @param  string $nameOfPermission
+	 * @param  string $model            
+	 * @param  mixed  $user
+	 * @return boolean
+	 */
+	public function can($nameOfPermission, $model, $user = false)
+	{      
+		$user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
+		$permissions = [];
+
+		$user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
+			$permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
+		});
         
-        return in_array($nameOfPermission, $permissions);
-    }
-
-    /**
-     * Check if the logged in user has the given group.
-     * 
-     * @param  array $groups
-     * @param  mixed $user
-     * @return boolean
-     */
-    public function hasGroup($groups, $user = false)
-    {
-        $user = $user ?: $this->find(\Auth::id());
-        return $user->groups->whereIn('name', $groups)->count() ? true : false;
-    }
-
-    /**
-     * Assign the given group ids to the given user.
-     * 
-     * @param  integer $userId    
-     * @param  array   $groupIds
-     * @return object
-     */
-    public function assignGroups($userId, $groupIds)
-    {
-        \DB::transaction(function () use ($userId, $groupIds) {
-            $user = $this->find($userId);
-            $user->groups()->detach();
-            $user->groups()->attach($groupIds);
-        });
-
-        return $this->find($userId);
-    }
-
-
-    /**
-     * Handle a login request to the application.
-     * 
-     * @param  array   $credentials    
-     * @param  boolean $adminLogin
-     * @return object
-     */
-    public function login($credentials, $adminLogin = false)
-    {
-        if ( ! $user = $this->first(['email' => $credentials['email']])) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ($user->blocked)
-        {
-            \ErrorHandler::userIsBlocked();
-        }
-        else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
-        {
-            \ErrorHandler::emailNotConfirmed();
-        }
-
-        return $user;
-    }
-
-    /**
-     * Handle a social login request of the none admin to the application.
-     * 
-     * @param  string $authCode
-     * @param  string $accessToken
-     * @param  string $type
-     * @return array
-     */
-    public function loginSocial($authCode, $accessToken, $type)
-    {
-        $access_token = $authCode ? array_get(\Socialite::driver($type)->getAccessTokenResponse($authCode), 'access_token') : $accessToken;
-        $user         = \Socialite::driver($type)->userFromToken($access_token);
-
-        if ( ! $user->email)
-        {
-            \ErrorHandler::noSocialEmail();
-        }
-
-        if ( ! $registeredUser = $this->model->where('email', $user->email)->first()) 
-        {
-            $this->register(['email' => $user->email, 'password' => ''], true);
-        }
-
-        $loginProxy = \App::make('App\Modules\Acl\Proxy\LoginProxy');
-        return $loginProxy->login(['email' => $user->email, 'password' => config('skeleton.social_pass')], 0);
-    }
+		return in_array($nameOfPermission, $permissions);
+	}
+
+	/**
+	 * Check if the logged in user has the given group.
+	 * 
+	 * @param  array $groups
+	 * @param  mixed $user
+	 * @return boolean
+	 */
+	public function hasGroup($groups, $user = false)
+	{
+		$user = $user ?: $this->find(\Auth::id());
+		return $user->groups->whereIn('name', $groups)->count() ? true : false;
+	}
+
+	/**
+	 * Assign the given group ids to the given user.
+	 * 
+	 * @param  integer $userId    
+	 * @param  array   $groupIds
+	 * @return object
+	 */
+	public function assignGroups($userId, $groupIds)
+	{
+		\DB::transaction(function () use ($userId, $groupIds) {
+			$user = $this->find($userId);
+			$user->groups()->detach();
+			$user->groups()->attach($groupIds);
+		});
+
+		return $this->find($userId);
+	}
+
+
+	/**
+	 * Handle a login request to the application.
+	 * 
+	 * @param  array   $credentials    
+	 * @param  boolean $adminLogin
+	 * @return object
+	 */
+	public function login($credentials, $adminLogin = false)
+	{
+		if ( ! $user = $this->first(['email' => $credentials['email']])) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ($user->blocked)
+		{
+			\ErrorHandler::userIsBlocked();
+		}
+		else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
+		{
+			\ErrorHandler::emailNotConfirmed();
+		}
+
+		return $user;
+	}
+
+	/**
+	 * Handle a social login request of the none admin to the application.
+	 * 
+	 * @param  string $authCode
+	 * @param  string $accessToken
+	 * @param  string $type
+	 * @return array
+	 */
+	public function loginSocial($authCode, $accessToken, $type)
+	{
+		$access_token = $authCode ? array_get(\Socialite::driver($type)->getAccessTokenResponse($authCode), 'access_token') : $accessToken;
+		$user         = \Socialite::driver($type)->userFromToken($access_token);
+
+		if ( ! $user->email)
+		{
+			\ErrorHandler::noSocialEmail();
+		}
+
+		if ( ! $registeredUser = $this->model->where('email', $user->email)->first()) 
+		{
+			$this->register(['email' => $user->email, 'password' => ''], true);
+		}
+
+		$loginProxy = \App::make('App\Modules\Acl\Proxy\LoginProxy');
+		return $loginProxy->login(['email' => $user->email, 'password' => config('skeleton.social_pass')], 0);
+	}
     
-    /**
-     * Handle a registration request.
-     * 
-     * @param  array   $credentials
-     * @param  boolean $skipConfirmEmail
-     * @return array
-     */
-    public function register($credentials, $skipConfirmEmail = false)
-    {
-        $user = $this->save($credentials);
-
-        if ($skipConfirmEmail) 
-        {
-            $user->confirmed = 1;
-            $user->save();
-        }
-        else if ( ! config('skeleton.disable_confirm_email'))  
-        {
-            $this->sendConfirmationEmail($user->email);
-        }
-
-        return $user;
-    }
+	/**
+	 * Handle a registration request.
+	 * 
+	 * @param  array   $credentials
+	 * @param  boolean $skipConfirmEmail
+	 * @return array
+	 */
+	public function register($credentials, $skipConfirmEmail = false)
+	{
+		$user = $this->save($credentials);
+
+		if ($skipConfirmEmail) 
+		{
+			$user->confirmed = 1;
+			$user->save();
+		}
+		else if ( ! config('skeleton.disable_confirm_email'))  
+		{
+			$this->sendConfirmationEmail($user->email);
+		}
+
+		return $user;
+	}
     
-    /**
-     * Block the user.
-     *
-     * @param  integer $userId
-     * @return object
-     */
-    public function block($userId)
-    {
-        if ( ! $user = $this->find($userId)) 
-        {
-            \ErrorHandler::notFound('user');
-        }
-        if ( ! $this->hasGroup(['Admin']))
-        {
-            \ErrorHandler::noPermissions();
-        }
-        else if (\Auth::id() == $userId)
-        {
-            \ErrorHandler::noPermissions();
-        }
-        else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
-        {
-            \ErrorHandler::noPermissions();
-        }
-
-        $user->blocked = 1;
-        $user->save();
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer $userId
+	 * @return object
+	 */
+	public function block($userId)
+	{
+		if ( ! $user = $this->find($userId)) 
+		{
+			\ErrorHandler::notFound('user');
+		}
+		if ( ! $this->hasGroup(['Admin']))
+		{
+			\ErrorHandler::noPermissions();
+		}
+		else if (\Auth::id() == $userId)
+		{
+			\ErrorHandler::noPermissions();
+		}
+		else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
+		{
+			\ErrorHandler::noPermissions();
+		}
+
+		$user->blocked = 1;
+		$user->save();
         
-        return $user;
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer $userId
-     * @return object
-     */
-    public function unblock($userId)
-    {
-        if ( ! $this->hasGroup(['Admin']))
-        {
-            \ErrorHandler::noPermissions();
-        }
-
-        $user          = $this->find($userId);
-        $user->blocked = 0;
-        $user->save();
-
-        return $user;
-    }
-
-    /**
-     * Send a reset link to the given user.
-     *
-     * @param  string  $email
-     * @return void
-     */
-    public function sendReset($email)
-    {
-        if ( ! $user = $this->model->where('email', $email)->first())
-        {
-            \ErrorHandler::notFound('email');
-        }
-
-        $token = \Password::getRepository()->create($user);
-        \Core::notifications()->notify($user, 'ResetPassword', $token);
-    }
-
-    /**
-     * Reset the given user's password.
-     *
-     * @param  array  $credentials
-     * @return array
-     */
-    public function resetPassword($credentials)
-    {
-        $response = \Password::reset($credentials, function ($user, $password) {
-            $user->password = $password;
-            $user->save();
-        });
-
-        switch ($response) {
-            case \Password::PASSWORD_RESET:
-                return 'success';
+		return $user;
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer $userId
+	 * @return object
+	 */
+	public function unblock($userId)
+	{
+		if ( ! $this->hasGroup(['Admin']))
+		{
+			\ErrorHandler::noPermissions();
+		}
+
+		$user          = $this->find($userId);
+		$user->blocked = 0;
+		$user->save();
+
+		return $user;
+	}
+
+	/**
+	 * Send a reset link to the given user.
+	 *
+	 * @param  string  $email
+	 * @return void
+	 */
+	public function sendReset($email)
+	{
+		if ( ! $user = $this->model->where('email', $email)->first())
+		{
+			\ErrorHandler::notFound('email');
+		}
+
+		$token = \Password::getRepository()->create($user);
+		\Core::notifications()->notify($user, 'ResetPassword', $token);
+	}
+
+	/**
+	 * Reset the given user's password.
+	 *
+	 * @param  array  $credentials
+	 * @return array
+	 */
+	public function resetPassword($credentials)
+	{
+		$response = \Password::reset($credentials, function ($user, $password) {
+			$user->password = $password;
+			$user->save();
+		});
+
+		switch ($response) {
+			case \Password::PASSWORD_RESET:
+				return 'success';
                 
-            case \Password::INVALID_TOKEN:
-                \ErrorHandler::invalidResetToken('token');
-
-            case \Password::INVALID_PASSWORD:
-                \ErrorHandler::invalidResetPassword('email');
-
-            case \Password::INVALID_USER:
-                \ErrorHandler::notFound('user');
-
-            default:
-                \ErrorHandler::generalError();
-        }
-    }
-
-    /**
-     * Change the logged in user password.
-     *
-     * @param  array  $credentials
-     * @return void
-     */
-    public function changePassword($credentials)
-    {
-        $user = \Auth::user();
-        if ( ! \Hash::check($credentials['old_password'], $user->password)) 
-        {
-            \ErrorHandler::invalidOldPassword();
-        }
-
-        $user->password = $credentials['password'];
-        $user->save();
-    }
-
-    /**
-     * Confirm email using the confirmation code.
-     *
-     * @param  string $confirmationCode
-     * @return void
-     */
-    public function confirmEmail($confirmationCode)
-    {
-        $user                    = $this->first(['confirmation_code' => $confirmationCode]);
-        $user->confirmed         = 1;
-        $user->confirmation_code = null;
-        $user->save();
-    }
-
-    /**
-     * Send the confirmation mail.
-     *
-     * @param  string $email
-     * @return void
-     */
-    public function sendConfirmationEmail($email)
-    {
-        $user = $this->first(['email' => $email]);
-        if ($user->confirmed) 
-        {
-            \ErrorHandler::emailAlreadyConfirmed();
-        }
-
-        $user->confirmed         = 0;
-        $user->confirmation_code = sha1(microtime());
-        $user->save();
-        \Core::notifications()->notify($user, 'ConfirmEmail');
-    }
-
-    /**
-     * Paginate all users in the given group based on the given conditions.
-     * 
-     * @param  string  $groupName
-     * @param  array   $relations
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function group($conditions, $groupName, $relations, $perPage, $sortBy, $desc)
-    {   
-        unset($conditions['page']);
-        $conditions = $this->constructConditions($conditions, $this->model);
-        $sort       = $desc ? 'desc' : 'asc';
-        $model      = call_user_func_array("{$this->getModel()}::with", array($relations));
-
-        $model->whereHas('groups', function($q) use ($groupName){
-            $q->where('name', $groupName);
-        });
+			case \Password::INVALID_TOKEN:
+				\ErrorHandler::invalidResetToken('token');
+
+			case \Password::INVALID_PASSWORD:
+				\ErrorHandler::invalidResetPassword('email');
+
+			case \Password::INVALID_USER:
+				\ErrorHandler::notFound('user');
+
+			default:
+				\ErrorHandler::generalError();
+		}
+	}
+
+	/**
+	 * Change the logged in user password.
+	 *
+	 * @param  array  $credentials
+	 * @return void
+	 */
+	public function changePassword($credentials)
+	{
+		$user = \Auth::user();
+		if ( ! \Hash::check($credentials['old_password'], $user->password)) 
+		{
+			\ErrorHandler::invalidOldPassword();
+		}
+
+		$user->password = $credentials['password'];
+		$user->save();
+	}
+
+	/**
+	 * Confirm email using the confirmation code.
+	 *
+	 * @param  string $confirmationCode
+	 * @return void
+	 */
+	public function confirmEmail($confirmationCode)
+	{
+		$user                    = $this->first(['confirmation_code' => $confirmationCode]);
+		$user->confirmed         = 1;
+		$user->confirmation_code = null;
+		$user->save();
+	}
+
+	/**
+	 * Send the confirmation mail.
+	 *
+	 * @param  string $email
+	 * @return void
+	 */
+	public function sendConfirmationEmail($email)
+	{
+		$user = $this->first(['email' => $email]);
+		if ($user->confirmed) 
+		{
+			\ErrorHandler::emailAlreadyConfirmed();
+		}
+
+		$user->confirmed         = 0;
+		$user->confirmation_code = sha1(microtime());
+		$user->save();
+		\Core::notifications()->notify($user, 'ConfirmEmail');
+	}
+
+	/**
+	 * Paginate all users in the given group based on the given conditions.
+	 * 
+	 * @param  string  $groupName
+	 * @param  array   $relations
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function group($conditions, $groupName, $relations, $perPage, $sortBy, $desc)
+	{   
+		unset($conditions['page']);
+		$conditions = $this->constructConditions($conditions, $this->model);
+		$sort       = $desc ? 'desc' : 'asc';
+		$model      = call_user_func_array("{$this->getModel()}::with", array($relations));
+
+		$model->whereHas('groups', function($q) use ($groupName){
+			$q->where('name', $groupName);
+		});
 
         
-        if (count($conditions['conditionValues']))
-        {
-            $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
-        }
-
-        if ($perPage) 
-        {
-            return $model->orderBy($sortBy, $sort)->paginate($perPage);
-        }
-
-        return $model->orderBy($sortBy, $sort)->get();
-    }
-
-    /**
-     * Save the given data to the logged in user.
-     *
-     * @param  array $data
-     * @return void
-     */
-    public function saveProfile($data) 
-    {
-        if (array_key_exists('profile_picture', $data)) 
-        {
-            $data['profile_picture'] = \Media::uploadImageBas64($data['profile_picture'], 'admins/profile_pictures');
-        }
+		if (count($conditions['conditionValues']))
+		{
+			$model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
+		}
+
+		if ($perPage) 
+		{
+			return $model->orderBy($sortBy, $sort)->paginate($perPage);
+		}
+
+		return $model->orderBy($sortBy, $sort)->get();
+	}
+
+	/**
+	 * Save the given data to the logged in user.
+	 *
+	 * @param  array $data
+	 * @return void
+	 */
+	public function saveProfile($data) 
+	{
+		if (array_key_exists('profile_picture', $data)) 
+		{
+			$data['profile_picture'] = \Media::uploadImageBas64($data['profile_picture'], 'admins/profile_pictures');
+		}
         
-        $data['id'] = \Auth::id();
-        $this->save($data);
-    }
-
-    /**
-     * Ensure access token hasn't expired or revoked.
-     * 
-     * @param  oject $accessToken
-     * @return boolean
-     */
-    public function accessTokenExpiredOrRevoked($accessToken)
-    {
-
-        $accessTokenRepository = \App::make('League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface');
-        $data                  = new ValidationData();
-        $data->setCurrentTime(time());
-
-        if ($accessToken->validate($data) === false || $accessTokenRepository->isAccessTokenRevoked($accessToken->getClaim('jti'))) 
-        {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Revoke the given access token and all 
-     * associated refresh tokens.
-     *
-     * @param  oject $accessToken
-     * @return void
-     */
-    public function revokeAccessToken($accessToken)
-    {
-        \DB::table('oauth_refresh_tokens')
-            ->where('access_token_id', $accessToken->id)
-            ->update([
-                'revoked' => true
-            ]);
-
-        $accessToken->revoke();
-    }
+		$data['id'] = \Auth::id();
+		$this->save($data);
+	}
+
+	/**
+	 * Ensure access token hasn't expired or revoked.
+	 * 
+	 * @param  oject $accessToken
+	 * @return boolean
+	 */
+	public function accessTokenExpiredOrRevoked($accessToken)
+	{
+
+		$accessTokenRepository = \App::make('League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface');
+		$data                  = new ValidationData();
+		$data->setCurrentTime(time());
+
+		if ($accessToken->validate($data) === false || $accessTokenRepository->isAccessTokenRevoked($accessToken->getClaim('jti'))) 
+		{
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Revoke the given access token and all 
+	 * associated refresh tokens.
+	 *
+	 * @param  oject $accessToken
+	 * @return void
+	 */
+	public function revokeAccessToken($accessToken)
+	{
+		\DB::table('oauth_refresh_tokens')
+			->where('access_token_id', $accessToken->id)
+			->update([
+				'revoked' => true
+			]);
+
+		$accessToken->revoke();
+	}
 }

config/skeleton.php

Indentation +136 added lines, -136 removed lines

@@ -2,7 +2,7 @@ 
 
 return [
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Disable Confirm Email
     |--------------------------------------------------------------------------
@@ -11,9 +11,9 @@ 
     |
     */
 
-    'disable_confirm_email' => env('DISABLE_CONFIRM_EMAIL', false),
+	'disable_confirm_email' => env('DISABLE_CONFIRM_EMAIL', false),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Confirm Email URL
     |--------------------------------------------------------------------------
@@ -22,9 +22,9 @@ 
     |
     */
    
-    'confrim_email_url' => env('CONFIRM_EMAIL_URL'),
+	'confrim_email_url' => env('CONFIRM_EMAIL_URL'),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Reset Password URL
     |--------------------------------------------------------------------------
@@ -33,9 +33,9 @@ 
     |
     */
    
-    'reset_password_url' => env('RESET_PASSWORD_URL'),
+	'reset_password_url' => env('RESET_PASSWORD_URL'),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Passport Client Id
     |--------------------------------------------------------------------------
@@ -44,9 +44,9 @@ 
     |
     */
    
-    'passport_client_id' => env('PASSWORD_CLIENT_ID'),
+	'passport_client_id' => env('PASSWORD_CLIENT_ID'),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Passport Client Secret
     |--------------------------------------------------------------------------
@@ -55,9 +55,9 @@ 
     |
     */
    
-    'passport_client_secret' => env('PASSWORD_CLIENT_SECRET'),
+	'passport_client_secret' => env('PASSWORD_CLIENT_SECRET'),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Social Pass
     |--------------------------------------------------------------------------
@@ -66,9 +66,9 @@ 
     |
     */
 
-    'social_pass' => env('SOCIAL_PASS', false),
+	'social_pass' => env('SOCIAL_PASS', false),
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Relations Between Models
     |--------------------------------------------------------------------------
@@ -77,88 +77,88 @@ 
     |
     */
     
-    'relations' => [
-        'users' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'account'    => [],
-            'group'      => [],
-            'deleted'    => [],
-        ],
-        'permissions' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'deleted'    => [],
-        ],
-        'groups' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'deleted'    => [],
-        ],
-        'oauthClients' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'account'    => [],
-            'group'      => [],
-            'deleted'    => [],
-        ],
-        'notifications' => [
-            'list'   => [],
-            'unread' => [],
-        ],
-        'pushNotificationDevices' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'deleted'    => [],
-        ],
-        'reports' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'deleted'    => [],
-        ],
-        'settings' => [
-            'list'       => [],
-            'find'       => [],
-            'findby'     => [],
-            'paginate'   => [],
-            'paginateby' => [],
-            'first'      => [],
-            'search'     => [],
-            'deleted'    => [],
-        ]
-    ],
+	'relations' => [
+		'users' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'account'    => [],
+			'group'      => [],
+			'deleted'    => [],
+		],
+		'permissions' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'deleted'    => [],
+		],
+		'groups' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'deleted'    => [],
+		],
+		'oauthClients' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'account'    => [],
+			'group'      => [],
+			'deleted'    => [],
+		],
+		'notifications' => [
+			'list'   => [],
+			'unread' => [],
+		],
+		'pushNotificationDevices' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'deleted'    => [],
+		],
+		'reports' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'deleted'    => [],
+		],
+		'settings' => [
+			'list'       => [],
+			'find'       => [],
+			'findby'     => [],
+			'paginate'   => [],
+			'paginateby' => [],
+			'first'      => [],
+			'search'     => [],
+			'deleted'    => [],
+		]
+	],
 
-    /*
+	/*
     |--------------------------------------------------------------------------
     | Cache Configurations
     |--------------------------------------------------------------------------
@@ -167,46 +167,46 @@ 
     |
     */
 
-    'cache_config' => [
-        'oauthClients' => [
-            'cache' => [
-                'all',
-                'find',
-                'findBy',
-                'paginate',
-                'paginateBy',
-                'first',
-                'search',
-                'deleted'
-            ],
-            'clear' => [
-                'update'           => ['oauthClients', 'users', 'groups'],
-                'save'             => ['oauthClients', 'users', 'groups'],
-                'delete'           => ['oauthClients', 'users', 'groups'],
-                'restore'          => ['oauthClients', 'users', 'groups'],
-                'revoke'           => ['oauthClients', 'users', 'groups'],
-                'ubRevoke'         => ['oauthClients', 'users', 'groups'],
-                'regenerateSecret' => ['oauthClients', 'users', 'groups'],
-            ],
-        ],
-        'settings' => [
-            'cache' => [
-                'all',
-                'find',
-                'findBy',
-                'paginate',
-                'paginateBy',
-                'first',
-                'search',
-                'deleted'
-            ],
-            'clear' => [
-                'update'   => ['settings'],
-                'save'     => ['settings'],
-                'delete'   => ['settings'],
-                'restore'  => ['settings'],
-                'saveMany' => ['settings'],
-            ]
-        ]
-    ]
+	'cache_config' => [
+		'oauthClients' => [
+			'cache' => [
+				'all',
+				'find',
+				'findBy',
+				'paginate',
+				'paginateBy',
+				'first',
+				'search',
+				'deleted'
+			],
+			'clear' => [
+				'update'           => ['oauthClients', 'users', 'groups'],
+				'save'             => ['oauthClients', 'users', 'groups'],
+				'delete'           => ['oauthClients', 'users', 'groups'],
+				'restore'          => ['oauthClients', 'users', 'groups'],
+				'revoke'           => ['oauthClients', 'users', 'groups'],
+				'ubRevoke'         => ['oauthClients', 'users', 'groups'],
+				'regenerateSecret' => ['oauthClients', 'users', 'groups'],
+			],
+		],
+		'settings' => [
+			'cache' => [
+				'all',
+				'find',
+				'findBy',
+				'paginate',
+				'paginateBy',
+				'first',
+				'search',
+				'deleted'
+			],
+			'clear' => [
+				'update'   => ['settings'],
+				'save'     => ['settings'],
+				'delete'   => ['settings'],
+				'restore'  => ['settings'],
+				'saveMany' => ['settings'],
+			]
+		]
+	]
 ];

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

Indentation +278 added lines, -278 removed lines

@@ -8,282 +8,282 @@
 
 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', 'changePassword', 'saveProfile', 'account'];
-
-    /**
-     * 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', 'confirmEmail', 'resendEmailConfirmation'];
-
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules     = [
-        'name'     => 'nullable|string', 
-        'email'    => 'required|email|unique:users,email,{id}', 
-        'password' => 'nullable|min:6'
-    ];
-
-    /**
-     * The loginProxy implementation.
-     * 
-     * @var \App\Modules\Acl\Proxy\LoginProxy
-     */
-    protected $loginProxy;
-
-    public function __construct(LoginProxy $loginProxy)
-    {        
-        $this->loginProxy = $loginProxy;
-        parent::__construct();
-    }
-
-    /**
-     * Return the logged in user account.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function account()
-    {
-        return \Response::json($this->repo->account($this->relations), 200);
-    }
-
-    /**
-     * Block the user.
-     *
-     * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
-     */
-    public function block($id)
-    {
-        return \Response::json($this->repo->block($id), 200);
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
-     */
-    public function unblock($id)
-    {
-        return \Response::json($this->repo->unblock($id), 200);
-    }
-
-    /**
-     * Logout the user.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function logout()
-    {
-        return \Response::json($this->loginProxy->logout(), 200);
-    }
-
-    /**
-     * Handle a registration request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function register(Request $request)
-    {
-        $this->validate($request, [
-            'name'     => 'nullable|string', 
-            'email'    => 'required|email|unique:users,email,{id}', 
-            'password' => 'required|min:6'
-            ]);
-
-        return \Response::json($this->repo->register($request->only('name', 'email', 'password')), 200);
-    }
-
-    /**
-     * Handle a login request 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'    => 'nullable|boolean'
-            ]);
-
-        return \Response::json($this->loginProxy->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($this->repo->loginSocial($request->get('auth_code'), $request->get('access_token'), $request->get('type')), 200);
-    }
-
-    /**
-     * Assign the given groups to the given user.
-     *
-     * @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($this->repo->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']);
-
-        return \Response::json($this->repo->sendReset($request->get('email')), 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($this->repo->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($this->repo->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
-    }
-
-    /**
-     * Confirm email using the confirmation code.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function confirmEmail(Request $request)
-    {
-        $this->validate($request, [
-            'confirmation_code' => 'required|string|exists:users,confirmation_code'
-        ]);
-
-        return \Response::json($this->repo->confirmEmail($request->only('confirmation_code')), 200);
-    }
-
-    /**
-     * Resend the email confirmation mail.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function resendEmailConfirmation(Request $request)
-    {
-        $this->validate($request, [
-            'email' => 'required|exists:users,email'
-        ]);
-
-        return \Response::json($this->repo->sendConfirmationEmail($request->get('email')), 200);
-    }
-
-    /**
-     * Refresh the expired login token.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function refreshtoken(Request $request)
-    {
-        $this->validate($request, [
-            'refreshtoken' => 'required',
-        ]);
-
-        return \Response::json($this->loginProxy->refreshtoken($request->get('refreshtoken')), 200);
-    }
-
-    /**
-     * Paginate all users with in the given group.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string $groupName The name of the requested group.
-     * @param  integer $perPage  Number of rows per page default 15.
-     * @param  string  $sortBy   The name of the column to sort by.
-     * @param  boolean $desc     Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)
-    {
-        return \Response::json($this->repo->group($request->all(), $groupName, $this->relations, $perPage, $sortBy, $desc), 200);
-    }
-
-    /**
-     * Save the given data to the logged in user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function saveProfile(Request $request) 
-    {
-        $this->validate($request, [
-            'profile_picture' => 'nullable|string',
-            'name'            => 'nullable|string', 
-            'email'           => 'required|email|unique:users,email,' . \Auth::id()
-        ]);
-
-        return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 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', 'changePassword', 'saveProfile', 'account'];
+
+	/**
+	 * 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', 'confirmEmail', 'resendEmailConfirmation'];
+
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules     = [
+		'name'     => 'nullable|string', 
+		'email'    => 'required|email|unique:users,email,{id}', 
+		'password' => 'nullable|min:6'
+	];
+
+	/**
+	 * The loginProxy implementation.
+	 * 
+	 * @var \App\Modules\Acl\Proxy\LoginProxy
+	 */
+	protected $loginProxy;
+
+	public function __construct(LoginProxy $loginProxy)
+	{        
+		$this->loginProxy = $loginProxy;
+		parent::__construct();
+	}
+
+	/**
+	 * Return the logged in user account.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function account()
+	{
+		return \Response::json($this->repo->account($this->relations), 200);
+	}
+
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer  $id Id of the user.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function block($id)
+	{
+		return \Response::json($this->repo->block($id), 200);
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer  $id Id of the user.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function unblock($id)
+	{
+		return \Response::json($this->repo->unblock($id), 200);
+	}
+
+	/**
+	 * Logout the user.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function logout()
+	{
+		return \Response::json($this->loginProxy->logout(), 200);
+	}
+
+	/**
+	 * Handle a registration request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function register(Request $request)
+	{
+		$this->validate($request, [
+			'name'     => 'nullable|string', 
+			'email'    => 'required|email|unique:users,email,{id}', 
+			'password' => 'required|min:6'
+			]);
+
+		return \Response::json($this->repo->register($request->only('name', 'email', 'password')), 200);
+	}
+
+	/**
+	 * Handle a login request 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'    => 'nullable|boolean'
+			]);
+
+		return \Response::json($this->loginProxy->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($this->repo->loginSocial($request->get('auth_code'), $request->get('access_token'), $request->get('type')), 200);
+	}
+
+	/**
+	 * Assign the given groups to the given user.
+	 *
+	 * @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($this->repo->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']);
+
+		return \Response::json($this->repo->sendReset($request->get('email')), 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($this->repo->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($this->repo->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
+	}
+
+	/**
+	 * Confirm email using the confirmation code.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function confirmEmail(Request $request)
+	{
+		$this->validate($request, [
+			'confirmation_code' => 'required|string|exists:users,confirmation_code'
+		]);
+
+		return \Response::json($this->repo->confirmEmail($request->only('confirmation_code')), 200);
+	}
+
+	/**
+	 * Resend the email confirmation mail.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function resendEmailConfirmation(Request $request)
+	{
+		$this->validate($request, [
+			'email' => 'required|exists:users,email'
+		]);
+
+		return \Response::json($this->repo->sendConfirmationEmail($request->get('email')), 200);
+	}
+
+	/**
+	 * Refresh the expired login token.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function refreshtoken(Request $request)
+	{
+		$this->validate($request, [
+			'refreshtoken' => 'required',
+		]);
+
+		return \Response::json($this->loginProxy->refreshtoken($request->get('refreshtoken')), 200);
+	}
+
+	/**
+	 * Paginate all users with in the given group.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string $groupName The name of the requested group.
+	 * @param  integer $perPage  Number of rows per page default 15.
+	 * @param  string  $sortBy   The name of the column to sort by.
+	 * @param  boolean $desc     Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)
+	{
+		return \Response::json($this->repo->group($request->all(), $groupName, $this->relations, $perPage, $sortBy, $desc), 200);
+	}
+
+	/**
+	 * Save the given data to the logged in user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function saveProfile(Request $request) 
+	{
+		$this->validate($request, [
+			'profile_picture' => 'nullable|string',
+			'name'            => 'nullable|string', 
+			'email'           => 'required|email|unique:users,email,' . \Auth::id()
+		]);
+
+		return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 200);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -13,7 +13,7 @@ 
      * to preform actions like (add, edit ... etc).
      * @var string
      */
-    protected $model               = 'users';
+    protected $model = 'users';
 
     /**
      * List of all route actions that the base api controller
@@ -27,14 +27,14 @@ 
      * will skip login check for them.
      * @var array
      */
-    protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
+    protected $skipLoginCheck = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
 
     /**
      * The validations rules used by the base api controller
      * to check before add.
      * @var array
      */
-    protected $validationRules     = [
+    protected $validationRules = [
         'name'     => 'nullable|string', 
         'email'    => 'required|email|unique:users,email,{id}', 
         'password' => 'nullable|min:6'
@@ -281,7 +281,7 @@ 
         $this->validate($request, [
             'profile_picture' => 'nullable|string',
             'name'            => 'nullable|string', 
-            'email'           => 'required|email|unique:users,email,' . \Auth::id()
+            'email'           => 'required|email|unique:users,email,'.\Auth::id()
         ]);
 
         return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 200);

src/Modules/Core/Utl/Media.php

Indentation +51 added lines, -51 removed lines

@@ -2,63 +2,63 @@
 
 class Media
 {
-    /**
-     * Upload the given image.
-     * 
-     * @param  object  $image
-     * @param  string  $dir
-     * @return string
-     */
-    public function uploadImage($image, $dir) 
-    {
-       $imageName       =  str_slug('image' . uniqid() . time() . '_' . $image->getClientOriginalName());
-       $destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
+	/**
+	 * Upload the given image.
+	 * 
+	 * @param  object  $image
+	 * @param  string  $dir
+	 * @return string
+	 */
+	public function uploadImage($image, $dir) 
+	{
+	   $imageName       =  str_slug('image' . uniqid() . time() . '_' . $image->getClientOriginalName());
+	   $destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
 
-       ! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
-       $image->move($destinationPath, $imageName);
+	   ! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
+	   $image->move($destinationPath, $imageName);
 
-       return url($destinationPath . $imageName);
-    }
+	   return url($destinationPath . $imageName);
+	}
 
-    /**
-     * Upload the given image.
-     * 
-     * @param  object  $image
-     * @param  string  $dir
-     * @return string
-     */
-    public function uploadImageBas64($image, $dir) 
-    {
-        if (! strlen($image)) 
-        {
-            return null;
-        }
+	/**
+	 * Upload the given image.
+	 * 
+	 * @param  object  $image
+	 * @param  string  $dir
+	 * @return string
+	 */
+	public function uploadImageBas64($image, $dir) 
+	{
+		if (! strlen($image)) 
+		{
+			return null;
+		}
         
-        $imageName       = 'image' . uniqid() . time() . '.jpg';
-        $destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
+		$imageName       = 'image' . uniqid() . time() . '.jpg';
+		$destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
 
-        ! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
+		! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
 
-        $base  = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
-        \Image::make($base)->save($destinationPath . $imageName);
+		$base  = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
+		\Image::make($base)->save($destinationPath . $imageName);
 
-        return url($destinationPath . $imageName);
-    }
+		return url($destinationPath . $imageName);
+	}
 
-    /**
-     * Delete the given image.
-     * 
-     * @param  object  $path
-     * @param  string  $dir
-     * @return void
-     */
-    public function deleteImage($path, $dir) 
-    {   
-        $arr      = explode('/', $path);
-        $path     = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR . end($arr);
-        if (\File::exists($path)) 
-        {
-            \File::delete($path);
-        }
-    }
+	/**
+	 * Delete the given image.
+	 * 
+	 * @param  object  $path
+	 * @param  string  $dir
+	 * @return void
+	 */
+	public function deleteImage($path, $dir) 
+	{   
+		$arr      = explode('/', $path);
+		$path     = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR . end($arr);
+		if (\File::exists($path)) 
+		{
+			\File::delete($path);
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -11,13 +11,13 @@ 
      */
     public function uploadImage($image, $dir) 
     {
-       $imageName       =  str_slug('image' . uniqid() . time() . '_' . $image->getClientOriginalName());
-       $destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
+       $imageName       = str_slug('image'.uniqid().time().'_'.$image->getClientOriginalName());
+       $destinationPath = 'media'.DIRECTORY_SEPARATOR.$dir.DIRECTORY_SEPARATOR;
 
        ! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
        $image->move($destinationPath, $imageName);
 
-       return url($destinationPath . $imageName);
+       return url($destinationPath.$imageName);
     }
 
     /**
@@ -29,20 +29,20 @@ 
      */
     public function uploadImageBas64($image, $dir) 
     {
-        if (! strlen($image)) 
+        if ( ! strlen($image)) 
         {
             return null;
         }
         
-        $imageName       = 'image' . uniqid() . time() . '.jpg';
-        $destinationPath = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR;
+        $imageName       = 'image'.uniqid().time().'.jpg';
+        $destinationPath = 'media'.DIRECTORY_SEPARATOR.$dir.DIRECTORY_SEPARATOR;
 
         ! file_exists($destinationPath) ? \File::makeDirectory($destinationPath) : false;
 
-        $base  = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
-        \Image::make($base)->save($destinationPath . $imageName);
+        $base = base64_decode(preg_replace('#^data:image/\w+;base64,#i', '', $image));
+        \Image::make($base)->save($destinationPath.$imageName);
 
-        return url($destinationPath . $imageName);
+        return url($destinationPath.$imageName);
     }
 
     /**
@@ -55,7 +55,7 @@ 
     public function deleteImage($path, $dir) 
     {   
         $arr      = explode('/', $path);
-        $path     = 'media' . DIRECTORY_SEPARATOR . $dir . DIRECTORY_SEPARATOR . end($arr);
+        $path     = 'media'.DIRECTORY_SEPARATOR.$dir.DIRECTORY_SEPARATOR.end($arr);
         if (\File::exists($path)) 
         {
             \File::delete($path);

src/Modules/Core/Traits/Translatable.php

Indentation +40 added lines, -40 removed lines

@@ -2,50 +2,50 @@
 
 trait Translatable  
 {
-    /**
-     * Create a new model instance that is existing.
-     *
-     * @param  array  $attributes
-     * @param  string|null  $connection
-     * @return static
-     */
-    public function newFromBuilder($attributes = [], $connection = null)
-    {
-        $model = parent::newFromBuilder($attributes, $connection);
+	/**
+	 * Create a new model instance that is existing.
+	 *
+	 * @param  array  $attributes
+	 * @param  string|null  $connection
+	 * @return static
+	 */
+	public function newFromBuilder($attributes = [], $connection = null)
+	{
+		$model = parent::newFromBuilder($attributes, $connection);
 
-        foreach ($model->attributes AS $key => $value)
-        {
-            if (isset($this->translatable) && in_array($key, $this->translatable)) 
-            {
-                $model->$key = $this->getTranslatedAttribute($value);
-            }
-        }
+		foreach ($model->attributes AS $key => $value)
+		{
+			if (isset($this->translatable) && in_array($key, $this->translatable)) 
+			{
+				$model->$key = $this->getTranslatedAttribute($value);
+			}
+		}
 
-        return $model;
-    }
+		return $model;
+	}
 
-    /**
-     * Returns a translatable model attribute based on the application's locale settings.
-     *
-     * @param $values
-     * @return string
-     */
-    protected function getTranslatedAttribute($values)
-    {
-        $values         = json_decode($values);
-        $primaryLocale  = \Session::get('locale');
-        $fallbackLocale = 'en';
+	/**
+	 * Returns a translatable model attribute based on the application's locale settings.
+	 *
+	 * @param $values
+	 * @return string
+	 */
+	protected function getTranslatedAttribute($values)
+	{
+		$values         = json_decode($values);
+		$primaryLocale  = \Session::get('locale');
+		$fallbackLocale = 'en';
 
-        if ($primaryLocale == 'all') 
-        {
-            return $values;
-        }
+		if ($primaryLocale == 'all') 
+		{
+			return $values;
+		}
 
-        if ( ! $primaryLocale || ! is_object($values) || ! property_exists($values, $primaryLocale)) 
-        {
-            return $values ? isset($values->$fallbackLocale) ? $values->$fallbackLocale : $values : '';
-        }
+		if ( ! $primaryLocale || ! is_object($values) || ! property_exists($values, $primaryLocale)) 
+		{
+			return $values ? isset($values->$fallbackLocale) ? $values->$fallbackLocale : $values : '';
+		}
 
-        return $primaryLocale == 'all' ? $values : $values->$primaryLocale;
-    }
+		return $primaryLocale == 'all' ? $values : $values->$primaryLocale;
+	}
 }
\ No newline at end of file

src/Modules/Core/Providers/ModuleServiceProvider.php

Indentation +45 added lines, -45 removed lines

@@ -7,50 +7,50 @@
 class ModuleServiceProvider extends ServiceProvider
 {
 	/**
-     * Bootstrap the module services.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'core');
-        $this->loadViewsFrom(__DIR__.'/../Resources/Views', 'core');
-
-        $factory = app('Illuminate\Database\Eloquent\Factory');
-        $factory->load(__DIR__.'/../Database/Factories');
-    }
-
-    /**
-     * Register the module services.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        //Bind Core Facade to the IoC Container
-        \App::bind('Core', function()
-        {
-            return new \App\Modules\Core\Core;
-        });
-
-        //Bind ErrorHandler Facade to the IoC Container
-        \App::bind('ErrorHandler', function()
-        {
-            return new \App\Modules\Core\Utl\ErrorHandler;
-        });
-
-        //Bind CoreConfig Facade to the IoC Container
-        \App::bind('CoreConfig', function()
-        {
-            return new \App\Modules\Core\Utl\CoreConfig;
-        });
-
-        //Bind Mpgs Facade to the IoC Container
-        \App::bind('Media', function()
-        {
-            return new \App\Modules\Core\Utl\Media;
-        });
+	 * Bootstrap the module services.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'core');
+		$this->loadViewsFrom(__DIR__.'/../Resources/Views', 'core');
+
+		$factory = app('Illuminate\Database\Eloquent\Factory');
+		$factory->load(__DIR__.'/../Database/Factories');
+	}
+
+	/**
+	 * Register the module services.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		//Bind Core Facade to the IoC Container
+		\App::bind('Core', function()
+		{
+			return new \App\Modules\Core\Core;
+		});
+
+		//Bind ErrorHandler Facade to the IoC Container
+		\App::bind('ErrorHandler', function()
+		{
+			return new \App\Modules\Core\Utl\ErrorHandler;
+		});
+
+		//Bind CoreConfig Facade to the IoC Container
+		\App::bind('CoreConfig', function()
+		{
+			return new \App\Modules\Core\Utl\CoreConfig;
+		});
+
+		//Bind Mpgs Facade to the IoC Container
+		\App::bind('Media', function()
+		{
+			return new \App\Modules\Core\Utl\Media;
+		});
         
-        $this->app->register(RouteServiceProvider::class);
-    }
+		$this->app->register(RouteServiceProvider::class);
+	}
 }

src/Modules/Acl/OauthClient.php

Indentation +16 added lines, -16 removed lines

@@ -6,23 +6,23 @@
 
 class OauthClient extends Client
 {
-    protected $dates    = ['created_at', 'updated_at'];
-    protected $fillable = ['name', 'redirect', 'user_id', 'personal_access_client', 'password_client', 'revoked'];
-    public $searchable  = ['name'];
+	protected $dates    = ['created_at', 'updated_at'];
+	protected $fillable = ['name', 'redirect', 'user_id', 'personal_access_client', 'password_client', 'revoked'];
+	public $searchable  = ['name'];
     
-    public function getCreatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
-    }
+	public function getCreatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
+	}
 
-    public function getUpdatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
-    }
+	public function getUpdatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
+	}
     
-    public static function boot()
-    {
-        parent::boot();
-        OauthClient::observe(\App::make('App\Modules\Acl\ModelObservers\OauthClientObserver'));
-    }
+	public static function boot()
+	{
+		parent::boot();
+		OauthClient::observe(\App::make('App\Modules\Acl\ModelObservers\OauthClientObserver'));
+	}
 }

src/Modules/Core/Interfaces/RepositoryInterface.php

Indentation +105 added lines, -105 removed lines

@@ -2,118 +2,118 @@
 
 interface RepositoryInterface
 {
-    /**
-     * Fetch all records with relations from the storage.
-     * 
-     * @param  array  $relations
-     * @param  array  $sortBy
-     * @param  array  $desc
-     * @param  array  $columns
-     * @return collection
-     */
-    public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from the storage.
+	 * 
+	 * @param  array  $relations
+	 * @param  array  $sortBy
+	 * @param  array  $desc
+	 * @param  array  $columns
+	 * @return collection
+	 */
+	public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations from storage in pages 
-     * that matche the given query.
-     * 
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages 
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch all records with relations from storage in pages.
-     * 
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages.
+	 * 
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-     /**
-     * Save the given model/models to the storage.
-     * 
-     * @param  array $data
-     * @return mixed
-     */
-    public function save(array $data);
+	 /**
+	  * Save the given model/models to the storage.
+	  * 
+	  * @param  array $data
+	  * @return mixed
+	  */
+	public function save(array $data);
 
-    /**
-     * Update record in the storage based on the given
-     * condition.
-     * 
-     * @param  var     $value condition value
-     * @param  array   $data
-     * @param  string  $attribute condition column name
-     * @return integer affected rows
-     */
-    public function update($value, array $data, $attribute = 'id');
+	/**
+	 * Update record in the storage based on the given
+	 * condition.
+	 * 
+	 * @param  var     $value condition value
+	 * @param  array   $data
+	 * @param  string  $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function update($value, array $data, $attribute = 'id');
 
-    /**
-     * Delete record from the storage based on the given
-     * condition.
-     * 
-     * @param  var     $value condition value
-     * @param  string  $attribute condition column name
-     * @return integer affected rows
-     */
-    public function delete($value, $attribute = 'id');
+	/**
+	 * Delete record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  var     $value condition value
+	 * @param  string  $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function delete($value, $attribute = 'id');
     
-    /**
-     * Fetch records from the storage based on the given
-     * id.
-     * 
-     * @param  integer $id
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function find($id, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * id.
+	 * 
+	 * @param  integer $id
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function find($id, $relations = [], $columns = array('*'));
     
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch the first record fro the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function first($conditions, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch the first record fro the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function first($conditions, $relations = [], $columns = array('*'));
 }
\ No newline at end of file