Merge pull request #29 from grayloon/customer-group-pricing

Ability to store and sync tier pricing

Author: ahinkle

composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php": "^7.4",
         "doctrine/dbal": "^2.9|^3.0",
-        "grayloon/laravel-magento-api": "0.*",
+        "grayloon/laravel-magento-api": "0.x",
         "guzzlehttp/guzzle": "^7.0",
         "illuminate/support": "^8.0"
     },

src/Console/SyncMagentoCustomerGroups.php

@@ -0,0 +1,83 @@
+<?php
+
+namespace Grayloon\MagentoStorage\Console;
+
+use Exception;
+use Grayloon\Magento\Magento;
+use Grayloon\MagentoStorage\Models\MagentoCustomerGroup;
+use Grayloon\MagentoStorage\Support\HasMagentoCustomerGroups;
+use Illuminate\Console\Command;
+
+class SyncMagentoCustomerGroups extends Command
+{
+    use HasMagentoCustomerGroups;
+
+    protected $signature = 'magento:sync-customer-groups';
+    protected $description = 'Syncs the Magento Customer Groups from the Magento API.';
+
+    protected $bar;
+    protected $count;
+    protected $pages;
+    protected $pageSize = 100;
+    protected $magento;
+
+    public function handle(Magento $magento)
+    {
+        $this->magento = $magento;
+
+        $this->info('Retrieving Magento Customer Groups from Magento...');
+        $this->resolveTotalGroups();
+        $this->info("{$this->count} Groups Found.");
+
+        if (! $this->count) {
+            return $this->error('No Customer Groups found. Sync Customer Group cancelled.');
+        }
+
+        $this->newLine();
+        $this->bar->start();
+
+        for ($currentPage = 1; $this->pages > $currentPage; $currentPage++) {
+            $groups = $this->magento->api('customerGroups')
+                ->search($this->pageSize, $currentPage);
+
+            if (! $groups->ok()) {
+                throw new Exception('Unable to locate Customer Groups.');
+            }
+
+            $this->updateOrCreateCustomerGroups($groups->json());
+        }
+
+        $this->bar->finish();
+        $this->newLine();
+        $this->newLine();
+        $this->info(MagentoCustomerGroup::count() . ' groups synced from the Magento API to your application.');
+    }
+
+    /**
+     * The total count of Customer Groups.
+     *
+     * @throws \Exception
+     * @return $this
+     */
+    protected function resolveTotalGroups()
+    {
+        if (config('magento.store_code')) {
+            $this->newLine();
+            $this->info('Default Store Code: "'. config('magento.store_code') .'" is configured in your env.');
+            $this->info('We will only sync those customer groups associated with "'. config('magento.store_code') .'".');
+        }
+
+        $groups = $this->magento->api('customerGroups')->search();
+
+        if (! $groups->ok() || ! isset($groups->json()['total_count'])) {
+            throw new Exception('Unable to locate Customer Groups.');
+        }
+
+        $this->count = $groups->json()['total_count'];
+        $this->bar = $this->output
+            ->createProgressBar($this->count);
+        $this->pages = ceil(($this->count / $this->pageSize) + 1);
+
+        return $this;
+    }
+}

src/Database/Factories/MagentoCustomerGroupFactory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Grayloon\MagentoStorage\Database\Factories;
+
+use Grayloon\MagentoStorage\Models\MagentoCustomerGroup;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class MagentoCustomerGroupFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = MagentoCustomerGroup::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'code' => $this->faker->company,
+            'tax_class_id' => $this->faker->randomNumber(),
+            'tax_class_name' => $this->faker->catchPhrase,
+        ];
+    }
+}

src/Database/Factories/MagentoTierPriceFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Grayloon\MagentoStorage\Database\Factories;
+
+use Grayloon\MagentoStorage\Models\MagentoTierPrice;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class MagentoTierPriceFactory extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = MagentoTierPrice::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+            'magento_product_id'   => MagentoProductFactory::new(),
+            'customer_group_id'    => MagentoCustomerGroupFactory::new(),
+            'value'                => $this->faker->randomFloat(2, 1, 500),
+            'quantity'             => $this->faker->numberBetween(1, 100),
+            'extension_attributes' => [],
+        ];
+    }
+}

src/Database/Migrations/2021_05_20_134208_create_magento_customer_groups_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateMagentoCustomerGroupsTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('magento_customer_groups', function (Blueprint $table) {
+            $table->id();
+            $table->string('code');
+            $table->bigInteger('tax_class_id');
+            $table->string('tax_class_name');
+            $table->timestamps();
+            $table->timestamp('synced_at')->useCurrent();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('magento_customer_groups');
+    }
+}

src/Database/Migrations/2021_05_20_211536_create_magento_tier_prices_table.php

@@ -0,0 +1,26 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class CreateMagentoTierPricesTable extends Migration
+{
+    public function up()
+    {
+        Schema::create('magento_tier_prices', function (Blueprint $table) {
+            $table->id();
+            $table->bigInteger('magento_product_id')->index();
+            $table->bigInteger('customer_group_id')->index();
+            $table->decimal('value', 15, 4)->default(0.00);
+            $table->integer('quantity')->default(0);
+            $table->text('extension_attributes')->nullable();
+            $table->timestamps();
+        });
+    }
+
+    public function down()
+    {
+        Schema::dropIfExists('magento_tier_prices');
+    }
+}

src/Jobs/SyncMagentoProductCategory.php

@@ -2,14 +2,14 @@
 
 namespace Grayloon\MagentoStorage\Jobs;
 
+use Grayloon\MagentoStorage\Models\MagentoCategory;
+use Grayloon\MagentoStorage\Models\MagentoProduct;
+use Grayloon\MagentoStorage\Models\MagentoProductCategory;
 use Illuminate\Bus\Queueable;
-use Illuminate\Queue\SerializesModels;
-use Illuminate\Queue\InteractsWithQueue;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
-use Grayloon\MagentoStorage\Models\MagentoProduct;
-use Grayloon\MagentoStorage\Models\MagentoCategory;
-use Grayloon\MagentoStorage\Models\MagentoProductCategory;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
 
 class SyncMagentoProductCategory implements ShouldQueue
 {

src/MagentoStorageServiceProvider.php

@@ -84,6 +84,7 @@ public function register()
             Console\SyncMagentoCustomAttributeTypesCommand::class,
             Console\SyncMagentoWebsitesCommand::class,
             Console\MagentoCleanAttributesCommand::class,
+            Console\SyncMagentoCustomerGroups::class,
         ]);
     }
 }

src/Models/MagentoCustomer.php

@@ -59,4 +59,14 @@ public function addresses()
     {
         return $this->hasMany(MagentoCustomerAddress::class, 'customer_id');
     }
+
+    /**
+     * The Group ID belongs to the Magento Customer Group.
+     *
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
+    public function customerGroup()
+    {
+        return $this->belongsTo(MagentoCustomerGroup::class, 'group_id');
+    }
 }

src/Models/MagentoCustomerGroup.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Grayloon\MagentoStorage\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class MagentoCustomerGroup extends Model
+{
+    use HasFactory;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'code',
+        'tax_class_id',
+        'tax_class_name',
+        'synced_at',
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'synced_at' => 'datetime',
+    ];
+}