DEV Community: Mahmoud Ahmed

Custom your routes in Lumen

Mahmoud Ahmed — Sun, 02 Aug 2020 17:42:18 +0000

Lumen package to help you customize your routes.
Specialize for whom using lumen,

If you don't you better do now, Lumen is stunningly micro-framework Faster 4x than laravel.

Installation

composer require lararoutes/lumen-custom-routes

Usage

Add those lines in top of routes/web.php

  use Lararoutes\Lumen\CustomRoutes;
  $app = new CustomRoutes($router);

That's it. done

Example

Instead of doing this shit

  $router->get('posts', 'PostController@index');
  $router->post('posts', 'PostController@store');
  $router->get('posts/{id}', 'PostController@show');
  $router->put('posts/{id}', 'PostController@update');
  $router->delete('posts/{id}', 'PostController@destroy');

We Can simple do this now

$app->apiResource('posts', 'PostController');

However, you can also custom your routes as much as u want in Lararoutes\Lumen\CustomRoutes.php

    function apiResoruce($uri, $controller)
    {
        $this->app->get($uri, $controller.'@index');
        $this->app->post($uri, $controller.'@store');
        $this->app->get($uri.'/{id}', $controller.'@show');
        $this->app->put($uri.'/{id}', $controller.'@update');
        $this->app->delete($uri.'/{id}', $controller.'@destroy');

        // feel free to add more..

    }

Credits

License

The MIT License (MIT). Please see License File for more information.

LaraSecure - IP Blocker

Mahmoud Ahmed — Wed, 22 Jul 2020 14:30:17 +0000

IP Blocker

A Laravel Package to increase the security of your websites by preventing access for users having blocked IP Addresses.

However, you can add IP Addresses as many as you want into table called ipblockers which you want to disallow access to your site from spam etc.

Installation

composer require larasecure/ip-blocker --dev

Then publish the config

php artisan vendor:publish --tag=ipblocker

php artisan migrate

Usage

Add this middleware in Kernel.php $routeMiddleware to restrict IP Addresses

'IPBlocking' => \Larasecure\IPBlocker\Middlewares\IPBlocking::class

Add IPBlocking middleware to route group for which you want to restrict access.

  Route::group(['middleware' => 'IPBlocking'], function(){
    // you routes..
  });

or you can injected in RouteServiceProvider.php

  protected function mapApiRoutes()
    {
        Route::prefix('api')
            ->middleware(['api', 'IPBlocking'])
            ->namespace($this->namespace)
            ->group(base_path('routes/api.php'));
    }

or just add middleware to single route

  Route::get('/', function () {
    //
  })->middleware('IPBlocking');

Users will be redirect to "403 | Forbidden" page if their IP exist on ipblockers table.

Security

If you discover any security related issues, please email mahmoud.italy@outlook.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

Becoming a (good) developer

Mahmoud Ahmed — Sat, 18 Jul 2020 11:04:50 +0000

Hello again. In this post, I will walk you through the topics which might be helpful to support your goal to become a good and successful developer.

This post assumes you are already at least an entry level developer regardless of the programming language.

So, let’s dive into the concepts to become a good developer.

Learn the core concepts

The core concepts of programming in general is helpful no matter which programming language background you are from. Learning the core concepts of the programming in general or for a specific programming language can help you boost your confidence, and it can also leverage your skills on how you can approach to a problem by simply applying the concepts.

For example, if you belong to the php programming background. You should checkout its core concepts, like, data types (variables), conditional statements (if/else/else if), control statements (for/foreach/while/do..while), OOP (Object oriented programming) concepts. Object oriented programming concepts are similar for most of the programming languages.

Keep in mind, if you have concepts clear for one programming language, you can easily adopt another programming language. I can say this by my experience. I have been a php developer since last 3 years, and in those last 3 years I have learned too many different things about the workings of php programming language and the core concepts behind it. And since last 1 year, I was able to adopt javascript and dart (used in flutter). Which is great in comparison of learning php in 3 years and other 2 programming languages in just 1 year.

So take this seriously, take time to learn about the programming language you are engaged into.

Read Code

For new developers, this point may seem like, what the hell. Why should I read code while I should be typing it. But, reading code is a good practice to improve your skills and is followed my most of the experienced developers.

Where should you read the code ? Github….😊.

As a developer you might have used some kind of library. Is it worth studying the library ? Of course. Go ahead and check the code of any library you might have used. You may be surprised what approaches can be used to solve a problem differently. By reading others’ code you can learn new techniques to acheive something more efficiently. Bonus, you can undestand how the library works, which at some point of time is useful, because as a developer you may need a customized solution with some functionality of a library.

If you are going to work on an existing project, take it as an opportunity to read the code someone else has wrote. Reading code is a good practice and should be considered important on your journey towards becoming a good developer.

P.S. Learning by mistakes is a good thing, and learning by others’ mistakes is even better. Reading others’ code can help you avoid the mistakes they might have made.

Write readable code (well)

Along with reading the code of others, it is also important to write the readable code.

How can I make my code readable ?

Use appropriate names for variables, methods and functions. Split each method and function so that each method have single responsibility.
Splitting method per responsibility can also help in implementing DRY (Don’t repeat yourself) concept.
Avoid concurrency. (Don’t write code that works in the same way for different places, instead make a single place more capable and responsible for the task).
If you are going to create classes which in core have the same architecture but corresponds to different entities create an abstact class for them instead of creating the classes with same properties and methods.
Create trait classes if you are attaching functionality to more than one class.
The points above are the core ideas, it may differ from the view point of the programming language you might belong to, but every programming language have support for writing code using these approaches.

Why should I write readable code ?

No one would like to work on the code which can not be understood. Even you will curse the developer who might have wrote code that is not readable. So the sake of the art of development, write code that is readable and understadable, so that anyone can undestand your code and can start working on it asap.

Learn techniques, not tools

Tools help you to find your way around the problem, but techniques will always stay besides you no matter what tools/programming language you use. Tools come and go. It is good to get familier with the tools you use but don’t rely on them.

Where can I learn techniques ?

Out there, in this open source world, there are plenty of implementation in libraries, projects of different techniques. Read code, find different techniques inside them. Here, above discussed point Read Code makes more sense. Follow good developers on Twitter, follow blogs which publishes this kind of articles.

Learning is a never ending process, but ultimately it makes you better overtime.

Share the knowledge

Are you afraid of forgetting the concepts you might have learned ? Here is my tip for making them permenant part of yourself.

Sharing what you know.

Teaching what you have learned to other developers is a good practice. Teaching is a process where your mind needs to be precise. And don’t take it as a responsibility, but take it as a goodwill of your knowledge. The knowledge you have aquired was ultimately shared by someone else. So act your part. Share what you have learned.

Sharing your knowledge makes the learned concepts concrete. Teaching process needs clear knowledge of the concept you are going to teach. So your mind automatically does the process of clearing the concepts if it were not already before you teach it to someone else.

Be responsible

Take responsibility of your work and/or your teams’ work. If there has been some fault because of you, take responsibility of the fault. Rectify your mistakes and resolve them.

This is a very important process, beacause taking responsibility of your mistakes, and resolving them will make you more vigilant before making similar kind of faults/problems, also you will have a solution if you have already resolved similar kind of problems.

This process will also make you more confident. Also you will be in possesion of new wits with each mistake. 😇

Conclusion

Being a (good) developer is not a milestone, its a process. You have to stay with the principles whichever helps your become better, either some from this article or from anywhere else.

Let me know, if I have missed anything in the comments.
This article written by Afaz Khatri

Larafast/fastApi package

Mahmoud Ahmed — Wed, 15 Jul 2020 16:15:37 +0000

Larafast FastAPI

What does mean FastAPI:

A Fastapi Laravel package to help you generate CRUD API Controllers and Resources, Model.. etc

What actually do?

Suppose you are building an api, and you want to create controller and resources and model and factory.. etc, then you have to do a ton of other tedious and to be honest, boring things like creating migrations, model factories, the controller, form validation and adding all !.

So what FastAPI does is when you tell it the model name, it will do all those boring things. When it's done you have the following:

Blog.php
BlogController.php ship with code already exists
BlogStoreRequest.php and BlogUpdateRequest.php
BlogResoure.php
Timestamped create_blogs_table.php migration file
BlogFactory.php

Installation

composer require larafast/fastapi --dev

Then publish the config

php artisan vendor:publish --tag=fastApi

Example

php artisan fastApi Blog

Once done, it will show you the details of the files generated.

Factory created successfully

Created Migration: 2020_07_14_125128_create_blogs_table

Model created successfully

Controller created successfully

Request created successfully

Request created successfully

Resource created successfully

Snapshot of BlogController

namespace App\Http\Controllers;

use App\Blog;
use Illuminate\Http\Request;
use App\Http\Requests\BlogUpdateRequest;
use App\Http\Requests\BlogStoreRequest;
use App\Http\Resources\BlogResource;

class BlogController extends Controller
{
    /**
     * Display a listing of the resource.
     *
     * @return \Illuminate\Http\Response
     */
    public function index()
    {
        $rows = BlogResource::collection(Blog::fetchData(request()->all()));
        return response()->json(['data' => $rows], 200);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  BlogStoreRequest  $request
     * @return \Illuminate\Http\Response
     */
    public function store(BlogStoreRequest $request)
    {
        try {
            Blog::create($request->all());
            return response()->json(['message' => ''], 201);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to create entry, '. $e->getMessage()], 500);
        }
    }

    /**
     * Display the specified resource.
     *
     * @param  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function show(Blog $blog)
    {
        $row = new BlogResource(Blog::findOrFail($blog));
        return response()->json(['row' => $row], 200);
    }

    /**
     * Update the specified resource in storage.
     *
     * @param  OrderUpdateRequest  $request
     * @param  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function update(BlogUpdateRequest $request, Blog $blog)
    {
        try {
            $blog->update($request->all());
            return response()->json(['message' => ''], 200);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to update entry, '. $e->getMessage()], 500);
        }
    }

    /**
     * Remove the specified resource from storage.
     *
     * @param  \App\Blog  $blog
     * @return \Illuminate\Http\Response
     */
    public function destroy(Blog $blog)
    {
        try {
            $blog->delete();
            return response()->json(['message' => ''], 200);
        } catch (\Exception $e) {
            return response()->json(['message' => 'Unable to delete entry, '. $e->getMessage()], 500);
        }
    }
}

Snapshot of Blog Model

namespace App;

// use Stroage;
use Illuminate\Database\Eloquent\Model;
// use Illuminate\Database\Eloquent\SoftDeletes;

class Blog extends Model
{
    // use SoftDeletes;
    protected $guarded = [];

    // imageable polymorphic
    public function image() {
        return $this->morphOne(Image::class, 'imageable');
    }

    // handle attributes
    public function setImageAttribute($value){
        $imageName = time().'.'.$value->extension();  
        Storage::disk('public')->put('uploads/'.$imageName, $value);
        $this->image()->save($imageName);
    }

    // fetch Data
    public static function fetchData($value='')
    {
        // this way will fire up speed of the query
        $obj = self::query();

          // langauges in case you use multilanguages transactions package..
          if(isset($value['locale'])) {
             app()->setLocale($value['locale']);
          }

          // search for multiple columns..
          if(isset($value['search'])) {
            $obj->where(function($q){
                $q->where('title', 'like','%'.$value['search'].'%');
                $q->orWhere('body', 'like', '%'.$value['search'].'%');
                $q->orWhere('id', $value['search']);
            });
          }

          // order By..
          if(isset($value['order'])) {
            $obj->orderBy('id', $value['order']);
          } else {
            $obj->orderBy('id', 'DESC');
          }



          // feel free to add any query filter as much as you want...




        $obj = $obj->paginate($value['paginate'] ?? 10);
        return $obj;
    }
}

Snapshot of Blog Resource

namespace App\Http\Resources;

use Illuminate\Http\Resources\Json\JsonResource;

class BlogResource extends JsonResource
{
    /**
     * Transform the resource into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array
     */
    public function toArray($request)
    {
        return [
            'id'            => $this->id,
            'encrypt_id'    => encrypt($this->id),
            // 'image'         => ($this->image) ? $this->image->url : NULL,

            // 'title'      => $this->title,
            // 'body'       => $this->body,

            'dateForHumans' => $this->created_at->diffForHumans(),
            'timestamp'     => $this->created_at
        ];
    }
}

Now add the necessary fields and run

php artisan migrate

And that saved you an hour worth of repetitive and boring work which you can spend on more important development challenges.

Security

If you discover any security related issues, please email mahmoud.italy@outlook.com.

Credits

License

The MIT License (MIT). Please see License File for more information.