Start of webhook handler

Author: gnikyt

README.md

@@ -34,6 +34,7 @@ A Laravel package for aiding in Shopify App development, similar to `shopify_app
 - [x] Authentication & installation for shops
 - [x] Auto install app webhooks and scripttags thorugh background jobs
 - [x] Provide basic ESDK views
+- [ ] Handles and processes incoming webhooks
 
 ## Requirements
 
@@ -89,6 +90,8 @@ This package uses jobs to install webhooks and scripttags if any are defined in
 
 If you do however, you can leave the `sync` driver as default. But, it may impact load times for the customer accessing the app. Its recommended to setup Redis or database as your default driver in `config/queue.php`. See [Laravel's docs on setting up queue drivers](https://laravel.com/docs/5.4/queues).
 
+For more information on creating webhooks, see `docs/creating-webhooks.md`.
+
 ### Migrations
 
 ```bash
@@ -128,6 +131,7 @@ Information on getting started, overriding routes, controllers, is located in th
 - [Becoming a Shopify Developer](docs/becoming-a-shopify-developer.md)
 - [Process in Authentication](docs/process-in-authentication.md)
 - [Developing Locally](docs/developing-locally.md)
+- [Creating Webhooks](docs/creating-webhooks.md)
 - [Overriding / Extending Package](docs/overriding-and-extending.md)
 
 ## Route List

docs/creating-webhooks.md

@@ -0,0 +1,3 @@
+# Creating Webhooks
+
+*Coming soon!*

src/ShopifyApp/Controllers/WebhookController.php

@@ -0,0 +1,9 @@
+<?php namespace OhMyBrew\ShopifyApp\Controllers;
+
+use Illuminate\Routing\Controller;
+use OhMyBrew\ShopifyApp\Traits\WebhookControllerTrait;
+
+class WebhookController extends Controller
+{
+    use WebhookControllerTrait;
+}

src/ShopifyApp/Traits/WebhookControllerTrait.php

@@ -0,0 +1,41 @@
+<?php namespace OhMyBrew\ShopifyApp\Traits;
+
+use \Exception;
+
+trait WebhookControllerTrait
+{
+    /**
+     * Handles an incoming webhook
+     *
+     * @param string $type The type of webhook
+     * 
+     * @return \Illuminate\Http\Response
+     */
+    public function handle($type)
+    {
+        $classPath = $this->getJobClassFromType($type);
+        if (!class_exists($classPath)) {
+            // Can not find a job for this webhook type
+            abort(500, "Missing webhook job: {$classPath}");
+        }
+
+        // Dispatch
+        $shopDomain = request()->header('X-Shopify-Shop-Domain');
+        $data = request()->all();
+        dispatch(new $classPath($shopDomain, $data));
+
+        return response('', 201);
+    }
+
+    /**
+     * Converts type into a class string
+     *
+     * @param string $type The type of webhook
+     * 
+     * @return string
+     */
+    protected function getJobClassFromType($type)
+    {
+        return '\\App\\Jobs\\' . str_replace('-', '', ucwords($type, '-')) . 'Job';
+    }
+}

src/ShopifyApp/resources/routes.php

@@ -56,4 +56,19 @@
         'OhMyBrew\ShopifyApp\Controllers\AuthController@authenticate'
     )
     ->name('authenticate');
+
+    /*
+    |--------------------------------------------------------------------------
+    | Webhook Handler
+    |--------------------------------------------------------------------------
+    |
+    | Handles incoming webhooks.
+    |
+    */
+    
+    Route::post(
+        '/webhook/{type}',
+        'OhMyBrew\ShopifyApp\Controllers\WebhookController@handle'
+    )
+    ->name('webhook');
 });

tests/OrdersCreateJobStub.php

@@ -0,0 +1,20 @@
+<?php namespace App\Jobs;
+
+use Illuminate\Bus\Queueable;
+use Illuminate\Queue\SerializesModels;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+
+class OrdersCreateJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function __construct($shopDomain, $data)
+    {
+    }
+
+    public function handle()
+    {
+    }
+}

tests/WebhookControllerTest.php

@@ -0,0 +1,44 @@
+<?php namespace OhMyBrew\ShopifyApp\Test;
+
+use \ReflectionMethod;
+use Illuminate\Support\Facades\Queue;
+
+require 'OrdersCreateJobStub.php';
+
+class WebhookControllerTest extends TestCase
+{
+    public function testShouldReturn201ResponseOnSuccess()
+    {
+        Queue::fake();
+
+        $response = $this->call('post', '/webhook/orders-create');
+        $response->assertStatus(201);
+
+        Queue::assertPushed(\App\Jobs\OrdersCreateJob::class);
+    }
+
+
+    public function testShouldReturnErrorResponseOnFailure()
+    {
+        $response = $this->call('post', '/webhook/products-create');
+        $response->assertStatus(500);
+        $this->assertEquals('Missing webhook job: \App\Jobs\ProductsCreateJob', $response->exception->getMessage());
+    }
+
+    public function testShouldCaseTypeToClass()
+    {
+        $controller = new \OhMyBrew\ShopifyApp\Controllers\WebhookController;
+        $method = new ReflectionMethod(\OhMyBrew\ShopifyApp\Controllers\WebhookController::class, 'getJobClassFromType');
+        $method->setAccessible(true);
+
+        $types = [
+            'orders-create' => 'OrdersCreateJob',
+            'super-duper-order' => 'SuperDuperOrderJob',
+            'order' => 'OrderJob'
+        ];
+
+        foreach ($types as $type => $className) {
+            $this->assertEquals("\\App\\Jobs\\$className", $method->invoke($controller, $type));
+        }
+    }
+}