Makes the order operation 'deliver' available.

[bogdan202]

Reason for this PR

The current PR makes the order operation 'deliver' available.
https://developer.shopping-feed.com/api/95a3d1e32e9c7-deliver-an-order

What does the PR do

It adds the operation 'deliver' to the list of allowed ones

[KevinFrydman]

Hi, you need to add also a new method in this class :

public function deliver($reference, $channelName)
    {
        $this->addOperation(
            $reference,
            $channelName,
            self::TYPE_DELIVER
        );

        return $this;
    }

And make some tests in the OrderOperationTest class

[bogdan202]

I see, but I would like to point out that the parameters 'reference' and 'channelName' aren't required by API anymore. Instead, the parameter 'id' should be sent. I think all methods in this class should be adapted to the new API.
Do you agree?

[mdumoulin]

Hi @bogdan202, thanks for the PR. In addition to Kevin's feedback, can you add a section in documentation here please : https://github.com/shoppingflux/php-sdk/blob/master/docs/manual/resources/order.md#refund

[mdumoulin]

I see, but I would like to point out that the parameters 'reference' and 'channelName' aren't required by API anymore. Instead, the parameter 'id' should be sent. I think all methods in this class should be adapted to the new API. Do you agree?

Yes, you are right. This version was meant to be compatible to be integrated by old modules. It would be a good step towards the migration if the SDK could manage order's ID in addition to channel's name & order's reference.

[mdumoulin]

However, I am not favorable to proposed implementation because it breaks the object consistency & it only manage IDs for deliver operation. We are a bit annoyed here, because the number of parameter has to change from OrderOperation::<operation>($reference, $channelName, $operationParams...) to OrderOperation::<operation>($id, $operationParams...).

My recommandation would probably to create a new OrderOperation object with fixed signatures and deprecate the actual one. SDK user would be able to use the new object if he want. I can understand that is much more work than your need here.

For now, I suggest you to keep the object consitency with channel name & reference, and if you need to use IDs, to manage it on your own. I will check on my side if we can schedule to update SDK soon to manage order's ID. However, I can't give you any date yet.

[bogdan202]

@mdumoulin, the following implementation of the method deliver is ok for you?

public function deliver($reference, $channelName, $id): self
{
        $this->addOperation(
            $reference,
            $channelName,
            self::TYPE_DELIVER,
            [
                'id' => $id,
            ]
        );

        return $this;
    }

[mdumoulin]

No, because it should be either $reference and $channelName; or $id. The only suitable solution to implement it in actual object is :

public function deliver($reference, $channelName): self
{
    $this->addOperation(
        $reference, 
        $channelName, 
        self::TYPE_DELIVER
    );

    return $this;
}

A possible solution to manage ID would be to create another OrderOperation object. In short it could be something like that :

<?php

namespace ShoppingFeed\Sdk\Api\Order;

use ShoppingFeed\Sdk\Operation\AbstractBulkOperation;

class Operation extends AbstractBulkOperation
{
    public function deliver(OrderIdentifier $id): self
    {
        $this->addOperation(
            $id,
            self::TYPE_DELIVER
        );

        return $this;
    }
}

interface OrderIdentifier
{
    public function toArray(): array;
}

class Id implements OrderIdentifier
{
    private $id;

    public function __construct(int $id)
    {
        $this->id = $id;
    }

    public function toArray(): array
    {
        return [
            'id' => $this->id,
        ];
    }
}

class Reference implements OrderIdentifier
{
    private $channelName;

    private $reference;

    public function __construct(string $channelName, string $reference)
    {
        $this->channelName = $channelName;
        $this->reference = $reference;
    }

    public function toArray(): array
    {
        return [
            'channelName' => $this->channelName,
            'reference'   => $this->reference,
        ];
    }
}

[mdumoulin]

Another PR has been opened : #119