Open api/0.12 spec

.codacy.yaml

@@ -0,0 +1,7 @@
+---
+exclude_paths:
+  - "**/*.md"
+  - "**/*.js"
+  - "**/*.json"
+  - "tests/**/*"
+  - "database/**/*"

CHANGELOG.md

@@ -1,3 +1,101 @@
+
+## 0.12.0
+### Upgrading
+
+Update the composer package
+
+```bash
+$ composer update @getcandy/candy-api
+```
+
+```bash
+$ php artisan migrate
+```
+
+### High Impact Changes
+
+#### Maintenance Migrations
+
+Some columns have been added/removed from the database. The tables/columns affected are:
+
+- `orders`
+    - Removed `company_name` column as it wasn't being used and we have other columns for that now
+    - Added `billing_company_name` and `shipping_company_name` columns.
+- `countries`
+    - Remove `country` column in favour of a `country_id` relationship
+
+#### Eager loading relations for the current user
+
+Previously when returning the current user via `users/current` there was some hard coded includes, this has been replaced to allow the `include` query parameter.
+You should update any calls to this endpoint if you rely on included resources. The previous default includes were:
+
+```php
+['addresses.country', 'roles.permissions', 'customer', 'savedBaskets.basket.lines']
+```
+
+### Drafting has changed
+
+The way drafting previously worked has now been refactored to be less destructive. You should reindex your products before going back into the hub to get everything in sync.
+
+You can do this by running `php artisan candy:products:reindex` and `php artisan candy:categories:reindex`H
+
+### Route searching
+
+The way you search for routes has changed on the API. We have removed the `path` column and also the `locale` column in favour of a `language_id` relation.
+
+When you search for a route, previously you would do something like:
+```javascript
+const { data } = await axios('routes/search', {
+    params: {
+        slug: 'slug-for-the-product',
+        path: null,
+        include: 'element'
+    }
+})
+```
+This should now be changed to:
+```javascript
+const { data } = await axios('routes/search', {
+    params: {
+        slug: 'slug-for-the-product',
+        language_code: 'en',
+        element_type: 'product',
+        include: 'element'
+    }
+})
+```
+
+### 🐞 Fixes
+- Fixed an issue that was causing a indefinite wildcard search on products
+- Allow certain fields to be nullable on a customer address (`company_name`, `address_two`, `address_three`)
+- Fixed some issues on route creation
+- Fixed issue where shipping method relationships were not having their timestamps updated
+- Fixes to some migrations
+- Fixed an issue where the recycle bin item wasn't returned on the relationship
+- Fixed and issue where the indexable event wasn't being triggered when publishing a resource
+- Fixes to drafting and publishing of resources
+- Fixed an issue where `path` wasn't updating when updating a route
+
+### ⭐ Improvements
+
+- Slight optimisation for Elasticsearch and the fields it returns
+- Drafting and Publishing of a draft will now run in a transaction, you can also extend the drafting functionality in your plugins.
+- SKU uses `trim` when being saved
+- Languages have been refactored and simplified so now we only rely on `code`. The `lang` column has been replaced by `code` and the `iso` column has been removed.
+- When detecting the language to use for API responses, we now parse the `accept-language` header properly.
+### 🏗️ Additions
+
+- Added endpoint to get a payment provider via it's given ID
+- Added Stripe Payment Intents provider
+- Added a `RebuildTree` action and command for categories, so if your category tree is messed up you can run `candy:categories:rebuild`
+- Added `user/addresses` endpoint to get the current users saved addresses
+- Added initial report exporting logic, this will now run and exporter in the background and email you when ready to download.
+- Add some additional reports
+    - Average spending across customer groups
+    - Total spending across customer groups
+
+---
+
 # 0.3.8
 
 - [added] Added CategoryStoredEvent when editing categories
@@ -17,4 +115,4 @@ Add lockfile to .gitignore
 # 0.3.4
 
 - [changed] Changed `type` to `search_type` to be more explicit. Also `search_type` is no longer a required field and will default to a product search
-- [changed] Changed `includes` on search to `include`
+- [changed] Changed `includes` on search to `include`

composer.json

@@ -19,14 +19,15 @@
         "doctrine/dbal": "2.9.2",
         "ruflin/elastica": "^7.0",
         "spatie/laravel-permission": "^3.17",
+        "supportpal/accept-language-parser": "^0.1",
         "vinkla/hashids": "^9.0",
         "paypal/rest-api-sdk-php": "*",
         "laravel/helpers": "1.3.0",
         "neondigital/laravel-drafting": "dev-master",
         "neondigital/laravel-versioning": "dev-master",
         "staudenmeir/eloquent-has-many-deep": "^1.13",
         "laravel/legacy-factories": "^1.0.4",
-        "guzzlehttp/guzzle": "^7.1.0"
+        "guzzlehttp/guzzle": "^7.2.0"
     },
     "require-dev": {
         "fzaninotto/faker": "~1.4",

config/getcandy.php

@@ -58,6 +58,12 @@
         'table_columns' => [
             'name', 'reference', 'account_no', 'contact_email', 'type', 'account', 'order_total', 'delivery_total', 'zone', 'date',
         ],
+        'invoicing' => [
+            'pdf' => [
+                'pipelines' => [
+                ],
+            ],
+        ],
         'statuses' => [
 
             /*

database/factories/AssetFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+use Faker\Generator as Faker;
+use GetCandy\Api\Core\Assets\Models\Asset;
+
+/*
+|--------------------------------------------------------------------------
+| Model Factories
+|--------------------------------------------------------------------------
+|
+| This directory should contain each of the model factory definitions for
+| your application. Factories provide a convenient way to generate new
+| model instances for testing / seeding your application's database.
+|
+*/
+
+$factory->define(Asset::class, function (Faker $faker) {
+    return [
+        'location' => $faker->word,
+        'kind' => 'image',
+        'sub_kind' => 'jpg',
+        'width' => $faker->randomNumber,
+        'height' => $faker->randomNumber,
+        'title' => $faker->word,
+        'original_filename' => "{$faker->word}.jpg",
+        'caption' => $faker->word,
+        'size' => $faker->randomNumber,
+        'extension' => 'jpg',
+        'filename' => "{$faker->unique()->word}.jpg",
+    ];
+});

database/factories/AssetSourceFactory.php

@@ -0,0 +1,25 @@
+<?php
+
+use Faker\Generator as Faker;
+use GetCandy\Api\Core\Assets\Models\AssetSource;
+
+/*
+|--------------------------------------------------------------------------
+| Model Factories
+|--------------------------------------------------------------------------
+|
+| This directory should contain each of the model factory definitions for
+| your application. Factories provide a convenient way to generate new
+| model instances for testing / seeding your application's database.
+|
+*/
+
+$factory->define(AssetSource::class, function (Faker $faker) {
+    return [
+        'name' => $faker->word,
+        'handle' => $faker->word,
+        'disk' => 'public',
+        'default' => $faker->boolean,
+        'path' => $faker->word,
+    ];
+});

database/factories/AssociationGroupFactory.php

@@ -0,0 +1,25 @@
+<?php
+
+use Faker\Generator as Faker;
+use GetCandy\Api\Core\Associations\Models\AssociationGroup;
+use Illuminate\Support\Str;
+
+/*
+|--------------------------------------------------------------------------
+| Model Factories
+|--------------------------------------------------------------------------
+|
+| This directory should contain each of the model factory definitions for
+| your application. Factories provide a convenient way to generate new
+| model instances for testing / seeding your application's database.
+|
+*/
+
+$factory->define(AssociationGroup::class, function (Faker $faker) {
+    $name = $faker->unique()->company;
+
+    return [
+        'name' => $name,
+        'handle' => Str::slug($name),
+    ];
+});

database/factories/CategoryFactory.php

@@ -0,0 +1,25 @@
+<?php
+
+use Faker\Generator as Faker;
+use GetCandy\Api\Core\Categories\Models\Category;
+
+/*
+|--------------------------------------------------------------------------
+| Model Factories
+|--------------------------------------------------------------------------
+|
+| This directory should contain each of the model factory definitions for
+| your application. Factories provide a convenient way to generate new
+| model instances for testing / seeding your application's database.
+|
+*/
+
+$factory->define(Category::class, function (Faker $faker) {
+    return [
+        'attribute_data' => [
+            'name' => [
+                'en' => $faker->word,
+            ],
+        ],
+    ];
+});

database/factories/LanguageFactory.php

@@ -2,7 +2,6 @@
 
 use Faker\Generator as Faker;
 use GetCandy\Api\Core\Languages\Models\Language;
-use Illuminate\Support\Str;
 
 /*
 |--------------------------------------------------------------------------
@@ -16,12 +15,9 @@
 */
 
 $factory->define(Language::class, function (Faker $faker) {
-    $name = $faker->unique()->company;
-
     return [
-        'name' => $name,
-        'lang' => ucfirst($name),
-        'iso' => Str::slug($name),
+        'name' => $faker->unique()->country,
+        'code' => $faker->unique()->languageCode,
         'default' => $faker->boolean,
         'enabled' => $faker->boolean,
     ];

database/factories/ProductFactory.php

@@ -18,9 +18,7 @@
     return [
         'attribute_data' => [
             'name' => [
-                'webstore' => [
-                    'en' => $faker->name,
-                ],
+                'en' => $faker->name,
             ],
         ],
     ];

database/factories/RouteFactory.php

@@ -20,8 +20,8 @@
     return [
         'element_type' => Product::class,
         'element_id' => 1,
+        'language_id' => 1,
         'slug' => Str::slug($faker->word),
-        'path' => Str::slug($faker->word),
         'default' => $faker->boolean,
     ];
 });

database/factories/TaxFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+use Faker\Generator as Faker;
+use GetCandy\Api\Core\Taxes\Models\Tax;
+
+/*
+|--------------------------------------------------------------------------
+| Model Factories
+|--------------------------------------------------------------------------
+|
+| This directory should contain each of the model factory definitions for
+| your application. Factories provide a convenient way to generate new
+| model instances for testing / seeding your application's database.
+|
+*/
+
+$factory->define(Tax::class, function (Faker $faker) {
+    return [
+        'name' => $faker->word,
+        'percentage' => $faker->numberBetween(0, 20),
+        'default' => $faker->boolean,
+    ];
+});

database/migrations/2020_01_06_163333_add_set_null_on_delete_on_order_lines.php

@@ -1,6 +1,7 @@
 <?php
 
 use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\QueryException;
 use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 
@@ -13,11 +14,17 @@ class AddSetNullOnDeleteOnOrderLines extends Migration
      */
     public function up()
     {
+        try {
+            Schema::table('order_lines', function (Blueprint $table) {
+                $table->dropForeign('order_lines_product_variant_id_foreign');
+            });
+        } catch (QueryException $e) {
+            //
+        }
         Schema::table('order_lines', function (Blueprint $table) {
-            $table->dropForeign('order_lines_product_variant_id_foreign');
             $table->foreign('product_variant_id')
-            ->references('id')->on('product_variants')
-            ->onDelete('SET NULL');
+                ->references('id')->on('product_variants')
+                ->onDelete('SET NULL');
         });
     }
 

database/migrations/2021_02_05_093543_add_billing_shipping_company_name_to_orders.php

@@ -0,0 +1,38 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddBillingShippingCompanyNameToOrders extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up()
+    {
+        Schema::table('orders', function (Blueprint $table) {
+            if (Schema::hasColumn('orders', 'company_name')) {
+                $table->dropColumn('company_name');
+            }
+            if (! Schema::hasColumn('orders', 'billing_company_name')) {
+                $table->string('billing_company_name')->after('billing_email')->nullable()->index();
+            }
+            if (! Schema::hasColumn('orders', 'shipping_company_name')) {
+                $table->string('shipping_company_name')->after('billing_email')->nullable()->index();
+            }
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down()
+    {
+        Schema::table('orders', function (Blueprint $table) {
+            $table->string('company_name')->nullable();
+            $table->dropIfExists('billing_company_name');
+            $table->dropIfExists('shipping_company_name');
+        });
+    }
+}