Merge pull request #154 from ohmybrew/refactor

Refactor

.travis.yml

@@ -7,7 +7,6 @@ php:
   - 7.2
 
 env:
-  - LARAVEL_VERSION=5.5.*
   - LARAVEL_VERSION=5.6.*
   - LARAVEL_VERSION=5.7.*
 

README.md

@@ -5,7 +5,7 @@
 [![StyleCI](https://styleci.io/repos/96462257/shield?branch=master)](https://styleci.io/repos/96462257)
 [![License](https://poser.pugx.org/ohmybrew/laravel-shopify/license)](https://packagist.org/packages/ohmybrew/laravel-shopify)
 
-A full-featured Laravel package for aiding in Shopify App development, similar to `shopify_app` for Rails. Works for Laravel 5.5-5.7.
+A full-featured Laravel package for aiding in Shopify App development, similar to `shopify_app` for Rails. Works for Laravel 5.6+
 
 ![Screenshot](https://github.com/ohmybrew/laravel-shopify/raw/master/screenshot.png)
 ![Screenshot: Billable](https://github.com/ohmybrew/laravel-shopify/raw/master/screenshot-billable.png)

composer.json

@@ -12,7 +12,7 @@
   ],
   "require": {
     "php": ">=7.1.0",
-    "laravel/framework": "~5.5",
+    "laravel/framework": "~5.6",
     "ohmybrew/basic-shopify-api": "~4.0",
     "doctrine/dbal": "~2.5"
   },

phpunit.xml

@@ -9,8 +9,8 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false"
-         stopOnError="false"
+         stopOnFailure="true"
+         stopOnError="true"
          stopOnIncomplete="false"
          stopOnSkipped="false">
     <testsuites>

src/ShopifyApp/Console/stubs/webhook-job.stub

@@ -28,7 +28,7 @@ class DummyClass implements ShouldQueue
      * Create a new job instance.
      *
      * @param string $shopDomain The shop's myshopify domain
-     * @param object $webhook The webhook data (JSON decoded)
+     * @param object $webhook    The webhook data (JSON decoded)
      *
      * @return void
      */

src/ShopifyApp/Controllers/AuthController.php

@@ -5,6 +5,9 @@
 use Illuminate\Routing\Controller;
 use OhMyBrew\ShopifyApp\Traits\AuthControllerTrait;
 
+/**
+ * Responsible for authenticating the shop.
+ */
 class AuthController extends Controller
 {
     use AuthControllerTrait;

src/ShopifyApp/Controllers/BillingController.php

@@ -5,6 +5,9 @@
 use Illuminate\Routing\Controller;
 use OhMyBrew\ShopifyApp\Traits\BillingControllerTrait;
 
+/**
+ * Responsible for billing a shop for plans and usage charges.
+ */
 class BillingController extends Controller
 {
     use BillingControllerTrait;

src/ShopifyApp/Controllers/HomeController.php

@@ -5,6 +5,9 @@
 use Illuminate\Routing\Controller;
 use OhMyBrew\ShopifyApp\Traits\HomeControllerTrait;
 
+/**
+ * Responsible for showing the main homescreen for the app.
+ */
 class HomeController extends Controller
 {
     use HomeControllerTrait;

src/ShopifyApp/Controllers/WebhookController.php

@@ -5,6 +5,9 @@
 use Illuminate\Routing\Controller;
 use OhMyBrew\ShopifyApp\Traits\WebhookControllerTrait;
 
+/**
+ * Responsible for handling incoming webhook requests.
+ */
 class WebhookController extends Controller
 {
     use WebhookControllerTrait;

src/ShopifyApp/Facades/ShopifyApp.php

@@ -4,6 +4,9 @@
 
 use Illuminate\Support\Facades\Facade;
 
+/**
+ * Package's facade mapper for Laravel.
+ */
 class ShopifyApp extends Facade
 {
     /**

src/ShopifyApp/Jobs/AppUninstalledJob.php

@@ -2,15 +2,18 @@
 
 namespace OhMyBrew\ShopifyApp\Jobs;
 
-use Carbon\Carbon;
 use Illuminate\Bus\Queueable;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
+use Illuminate\Support\Facades\Config;
 use OhMyBrew\ShopifyApp\Models\Charge;
 use OhMyBrew\ShopifyApp\Models\Shop;
 
+/**
+ * Webhook job responsible for handling when the app is uninstalled.
+ */
 class AppUninstalledJob implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
@@ -62,9 +65,9 @@ public function handle()
             return false;
         }
 
+        $this->cancelCharge();
         $this->cleanShop();
         $this->softDeleteShop();
-        $this->cancelCharge();
 
         return true;
     }
@@ -99,16 +102,9 @@ protected function softDeleteShop()
      */
     protected function cancelCharge()
     {
-        $lastCharge = $this->shop->charges()
-            ->withTrashed()
-            ->whereIn('type', [Charge::CHARGE_RECURRING, Charge::CHARGE_ONETIME])
-            ->orderBy('created_at', 'desc')
-            ->first();
-
-        if ($lastCharge && !$lastCharge->isDeclined() && !$lastCharge->isCancelled()) {
-            $lastCharge->status = 'cancelled';
-            $lastCharge->cancelled_on = Carbon::today()->format('Y-m-d');
-            $lastCharge->save();
+        $planCharge = $this->shop->planCharge();
+        if ($planCharge && !$planCharge->isDeclined() && !$planCharge->isCancelled()) {
+            $planCharge->cancel();
         }
     }
 
@@ -119,7 +115,7 @@ protected function cancelCharge()
      */
     protected function findShop()
     {
-        $shopModel = config('shopify-app.shop_model');
+        $shopModel = Config::get('shopify-app.shop_model');
 
         return $shopModel::where(['shopify_domain' => $this->shopDomain])->first();
     }

src/ShopifyApp/Jobs/ScripttagInstaller.php

@@ -8,6 +8,9 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 
+/**
+ * Webhook job responsible for handling installing scripttag.
+ */
 class ScripttagInstaller implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
@@ -55,7 +58,10 @@ public function handle()
         $shopScripttags = $api->rest(
             'GET',
             '/admin/script_tags.json',
-            ['limit' => 250, 'fields' => 'id,src']
+            [
+                'limit'  => 250,
+                'fields' => 'id,src',
+            ]
         )->body->script_tags;
 
         foreach ($this->scripttags as $scripttag) {

src/ShopifyApp/Jobs/WebhookInstaller.php

@@ -8,6 +8,9 @@
 use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Queue\SerializesModels;
 
+/**
+ * Webhook job responsible for handling installation of webhook listeners.
+ */
 class WebhookInstaller implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
@@ -55,7 +58,10 @@ public function handle()
         $shopWebhooks = $api->rest(
             'GET',
             '/admin/webhooks.json',
-            ['limit' => 250, 'fields' => 'id,address']
+            [
+                'limit'  => 250,
+                'fields' => 'id,address',
+            ]
         )->body->webhooks;
 
         foreach ($this->webhooks as $webhook) {

src/ShopifyApp/Middleware/AuthProxy.php

@@ -4,8 +4,13 @@
 
 use Closure;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Response;
+use Illuminate\Support\Facades\Session;
 use OhMyBrew\ShopifyApp\Facades\ShopifyApp;
 
+/**
+ * Responsible for ensuring a proper app proxy request.
+ */
 class AuthProxy
 {
     /**
@@ -19,19 +24,19 @@ class AuthProxy
     public function handle(Request $request, Closure $next)
     {
         // Grab the query parameters we need, remove signature since its not part of the signature calculation
-        $query = request()->query->all();
+        $query = $request->query->all();
         $signature = $query['signature'];
         unset($query['signature']);
 
         // Build a local signature
         $signatureLocal = ShopifyApp::createHmac(['data' => $query, 'buildQuery' => true]);
         if ($signature !== $signatureLocal || !isset($query['shop'])) {
             // Issue with HMAC or missing shop header
-            abort(401, 'Invalid proxy signature');
+            return Response::make('Invalid proxy signature.', 401);
         }
 
         // Save shop domain to session
-        session(['shopify_domain' => ShopifyApp::sanitizeShopDomain(request('shop'))]);
+        Session::put('shopify_domain', ShopifyApp::sanitizeShopDomain($request->get('shop')));
 
         // All good, process proxy request
         return $next($request);

src/ShopifyApp/Middleware/AuthShop.php

@@ -4,9 +4,15 @@
 
 use Closure;
 use Illuminate\Http\Request;
+use Illuminate\Http\Response;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Redirect;
+use Illuminate\Support\Facades\Session;
 use OhMyBrew\ShopifyApp\Facades\ShopifyApp;
-use Symfony\Component\HttpFoundation\Response;
 
+/**
+ * Response for ensuring an authenticated shop.
+ */
 class AuthShop
 {
     /**
@@ -20,7 +26,7 @@ class AuthShop
     public function handle(Request $request, Closure $next)
     {
         $shop = ShopifyApp::shop();
-        $shopParam = ShopifyApp::sanitizeShopDomain(request('shop'));
+        $shopParam = ShopifyApp::sanitizeShopDomain($request->get('shop'));
 
         // Check if shop has a session, also check the shops to ensure a match
         if (
@@ -30,12 +36,12 @@ public function handle(Request $request, Closure $next)
             $shop->trashed()
         ) {
             // Either no shop session or shops do not match
-            session()->forget('shopify_domain');
+            Session::forget('shopify_domain');
 
             // Set the return-to path so we can redirect after successful authentication
-            session(['return_to' => $request->fullUrl()]);
+            Session::put('return_to', $request->fullUrl());
 
-            return redirect()->route('authenticate', ['shop' => $shopParam]);
+            return Redirect::route('authenticate', ['shop' => $shopParam]);
         }
 
         // Shop is OK, move on...
@@ -45,7 +51,7 @@ public function handle(Request $request, Closure $next)
             $response = new Response($response);
         }
 
-        if (config('shopify-app.esdk_enabled')) {
+        if (Config::get('shopify-app.esdk_enabled')) {
             // Headers applicable to ESDK only
             $response->headers->set('P3P', 'CP="Not used"');
             $response->headers->remove('X-Frame-Options');

src/ShopifyApp/Middleware/AuthWebhook.php

@@ -4,8 +4,12 @@
 
 use Closure;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Response;
 use OhMyBrew\ShopifyApp\Facades\ShopifyApp;
 
+/**
+ * Response for ensuring a proper webhook request.
+ */
 class AuthWebhook
 {
     /**
@@ -18,14 +22,14 @@ class AuthWebhook
      */
     public function handle(Request $request, Closure $next)
     {
-        $hmac = request()->header('x-shopify-hmac-sha256') ?: '';
-        $shop = request()->header('x-shopify-shop-domain');
-        $data = request()->getContent();
+        $hmac = $request->header('x-shopify-hmac-sha256') ?: '';
+        $shop = $request->header('x-shopify-shop-domain');
+        $data = $request->getContent();
 
         $hmacLocal = ShopifyApp::createHmac(['data' => $data, 'raw' => true, 'encode' => true]);
         if (!hash_equals($hmac, $hmacLocal) || empty($shop)) {
             // Issue with HMAC or missing shop header
-            abort(401, 'Invalid webhook signature');
+            return Response::make('Invalid webhook signature.', 401);
         }
 
         // All good, process webhook

src/ShopifyApp/Middleware/Billable.php

@@ -4,9 +4,13 @@
 
 use Closure;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Config;
+use Illuminate\Support\Facades\Redirect;
 use OhMyBrew\ShopifyApp\Facades\ShopifyApp;
-use OhMyBrew\ShopifyApp\Models\Charge;
 
+/**
+ * Responsible for ensuring the shop is being billed.
+ */
 class Billable
 {
     /**
@@ -19,11 +23,11 @@ class Billable
      */
     public function handle(Request $request, Closure $next)
     {
-        if (config('shopify-app.billing_enabled') === true) {
+        if (Config::get('shopify-app.billing_enabled') === true) {
             $shop = ShopifyApp::shop();
             if (!$shop->isFreemium() && !$shop->isGrandfathered() && !$shop->plan) {
                 // They're not grandfathered in, and there is no charge or charge was declined... redirect to billing
-                return redirect()->route('billing');
+                return Redirect::route('billing');
             }
         }