API Basic Setting Package

This package allows you to secure and configure the essentials of your business using the API. :sunglasses:

Installation

You can install the package via composer:

composer require somarkn99/apibasicsetting

Middleware

AcceptJsonResponse Middleware.

It Ensures you will get a response in JSON

class AcceptJsonResponse
{
    public function handle($request, Closure $next)
    {
        $request->headers->set('Accept', 'application/json');

        return $next($request);
    }
}

CORS.

In order to avoid getting a CORS Error :triumph:

class CORS
{
    public function handle($request, Closure $next)
    {
        $response = $next($request);
        $response->headers->set('Access-Control-Allow-Origin', '*');
        $response->headers->set('Access-Control-Allow-Methods', '*');
        $response->headers->set('Access-Control-Allow-Credentials', true);
        $response->headers->set('Access-Control-Allow-Headers', 'X-Requested-With,Content-Type,X-Token-Auth,Authorization');

        return $response;
    }
}

FingerPrintHeader

Delete personal information sent with unnecessary requests (in order to increase security) :no_bell: :mute:

class FingerPrintHeader
{
    public function handle($request, Closure $next)
    {
        $request->headers->remove('X-Powered-By');
        $request->headers->remove('Server');

        return $next($request);
    }
}

Host

As an additional security step, applications are not accepted to a specific domain and are pre-defined in the .env file. :lock: :shield:

Add this only for your dashboard or frontend app Don't use it for mobile application because it recognize it by Ip address for each user mobile

Note: Local server is accepted by default :v:

class Host
{
    public function handle($request, Closure $next)
    {
        $RequestHost = parse_url(\Illuminate\Support\Facades\URL::full())['host'];
        $AcceptedHost = explode(',', env('ACCEPTED_HOST'));

        if (in_array($RequestHost, $AcceptedHost) == true || $RequestHost == 'localhost') {
            return $next($request);
        } else {
            abort(403);
        }
    }
}

You can add more than one domain and be added as follows: in your .env file add this:

ACCEPTED_HOST=www.somar-kesen.com,api.somar-kesen.com

separated between each domain by ","

localization

When you work with SPA or Mobile Apps, you do not want to send messages by language other than the user language, for example user language is EN and you send it in Spanish!!

Here you can select the language you want to send to the user, all you need to do is add the language file to the lang folder and add a new item to the array.

From Client side you should send 'X-localization' header, if you don't english will be considered the default language of messages.

class localization
{
    public function handle($request, Closure $next)
    {
        // Check header request and determine localization
        $local = ($request->hasHeader('X-localization')) ? $request->header('X-localization') : 'en';

        // set laravel localization
        app()->setLocale($local);

        // continue request
        return $next($request);
    }
}

SecureCheck

You are building apps for many customers but don't know if they will use SSL certificates or not, which may cause some features in your app to break down. For that, this middleware prepares to rejected all requests that don't use https Protocol (Under Development until know)

class SecureCheck
{
    public function handle(Request $request, Closure $next)
    {
        if (! $request->secure() && App::environment('production')) {
            return response()->json("Please use https protocol so you can send requests.", Response::HTTP_BAD_REQUEST);
        }

        return $next($request);
    }
}

Helpers

it's allow you to read the dd value from developer section in your browser.

    function _dd(...$args)
    {
        $trace = debug_backtrace();
        $path = '';
        $path .= isset($trace[1]['class']) ? class_basename($trace[1]['class']) : '';
        $path .= isset($trace[1]['function']) ? '@'.$trace[1]['function'].'()' : '';
        $path .= isset($trace[1]['function']) ? ' => line('.$trace[0]['line'].')' : null;

        return response()->json([
            'Path' => $path,
            'dd_Data' => $args,
        ],Response::HTTP_INTERNAL_SERVER_ERROR);
        exit();
    }

setEnv

You can easily adjust the value of the variables in the .env file

    function setEnv($key, $value)
    {
        $path = base_path('.env');
        if (file_exists($path)) {
            file_put_contents($path,
                str_replace($key.'='.env($key), $key.'='.$value,
                    str_replace($key.'="'.env($key).'"', $key.'="'.$value.'"',
                        file_get_contents($path))
                ));
        }
    }

checkIfFileExists

This function to check if request has file

    function checkIfFileExists($file, $name)
    {
        if (isset(request()->all()[$name])) {
            if (gettype(request()->all()[$name]) !== 'array') {
                if (! isset($file) || is_null($file) || ! request()->hasFile($name)) {
                    return response()->json('please make sure you store correct file.', Response::HTTP_BAD_REQUEST);
                }
            }
        }
    }

dateFormat

It's allow you to format your date in function nested of write it every time for example:

$dt = Carbon::create(1975, 12, 25, 14, 15, 16);
echo $dt->toFormattedDateString();                 // Dec 25, 1975

function dateFormat($date)
{
    return \Carbon\Carbon::parse($date)->toFormattedDateString();
}

Note :warning:

Not all of these codes have to be from my pure work, there are many of them on the Internet that I may have done some but not limited to some modification, improvement, or modification of the appearance of the code to become readable, understandable or appropriate to the place of use. If you have any code you think will be useful and people will use frequently in many projects do not hesitate to do a pull request to this repo.

Let's Connect

Hire Me :fire:

By the way, I'm available to work as freelancer, feel free to communicate with me in order to transform your project from an idea to reality.

Security

If you discover any security related issues, please email them first to [email protected], if we do not fix it within a short period of time please open a new issue describe your problem.