Skip to content

INFO.md

Latest commit

 

History

History
214 lines (148 loc) · 4.74 KB

INFO.md

File metadata and controls

214 lines (148 loc) · 4.74 KB

Info

I. Making a Request

Using PSR-17 RequestFactoryInterface to create the Request that could be sent with any PSR-18 Client like Guzzle HTTP, Symfony HTTP or Laminas HTTP.

Using a simple php array:

// Creating the payload by using a simple php array 
$array = [
    'userName'     => 'testUser',
    'password'     => 'password',
    'sender'       => [],
    'recipient'    => [],
    'service'      => [],
    'payment'      => [],
    'shipmentNote' => 'Some test note'
];

... or using the model

// Creating the payload by using Speedy Model 
$object = new CreateShipmentRequest(
    new ShipmentSender(),
    new ShipmentRecipient(),
    new ShipmentService(),
    new ShipmentPayment(),
);

// Convert the object into array
$array = $object->toArray();

Sending the request

// Any PSR-18 HTTP Client can be used
$client = new GuzzleHttp\Client();

// The factory will create a PSR-7 request
/** @var \Psr\Http\Message\RequestInterface $request */
$request = (new GetContractClientsRequestFactory())($array);

/** @var \Psr\Http\Message\ResponseInterface $response */
$response = $client->sendRequest($request);

$json = $response->getBody()->getContents();

II. Using Responses

You can use the Speedy decorator, and then you can use object-oriented way to interact with the payload:

$config = new Configuration('userName', 'password', 'language');
$speedy = new Speedy($config, $client);
    
/** @var CreateShipmentRequest $request */
$request = new ContractClientRequest();
    
/** @var CreateShipmentResponse $response */
$response = $speedy->getContractClient($request);

$id       = $response->getId();    // Shipment id
$price    = $response->getPrice(); // Shipment Price
$total    = $price->getTotal();    // Total amount (amount + vat) in customer’s currency.
$currency = $price->getCurrency(); // Customer currency code
<?php declare(strict_types=1);

use VasilDakov\Speedy\Speedy;
use GuzzleHttp\Client;
use Laminas\Diactoros\RequestFactory;

/** @var Configuration $configuration */
$configuration = new Configuration('username', 'password', 'language');

/** @var \Psr\Http\Client\ClientInterface $client */
$client = new Client();

/** @var \Psr\Http\Message\RequestFactoryInterface $factory */
$factory = new RequestFactory();

$speedy = new Speedy($configuration, $client, $factory);

$response = $speedy->getContractClient(new GetContractClientsRequest());

Services

Calculation Service

Client Service

use VasilDakov\Speedy\Client;

/** @var Client\GetContractClientsRequest $request */
$request = new Client\GetContractClientsRequest();

/** @var Client\GetContractClientsResponse $response */
$response = $speedy->getContractClients($request);

/** @var Client\Client[] $clients */
$clients = $response->getClients();

Location Service

Print Service

Shipment Service

use VasilDakov\Speedy\Shipment;

$shipmentRequest = new \VasilDakov\Speedy\Service\Shipment\CreateShipmentRequest(
    new \VasilDakov\Speedy\Service\Shipment\ShipmentRecipient(),
    new \VasilDakov\Speedy\Service\Shipment\ShipmentSender(),
    new \VasilDakov\Speedy\Service\Shipment\ShipmentService()
);

$response = $speedy->createShipment($shipmentRequest);

$id = $response->getId();
$parcels = $response->getParcels();
$shipmentPrice = $response->getShipmentPrice();

Track Service

Create Shipment Request

Docker

Build the image

$ docker build -t speedy .

Run the container

$ docker run -d --name speedy speedy

or start the container with mounted volume

$ docker run -it --rm --name speedy -v "$PWD":/usr/src/speedy -w /usr/src/speedy -d speedy
$ docker run -it --rm --name speedy -v //c/speedy:/usr/src/speedy -d speedy

List the containers

$ docker ps -a
CONTAINER ID   IMAGE                   COMMAND                  CREATED          STATUS                     PORTS                                        NAMES
2cfa293ddd1f   e8e013e6db1a            "docker-php-entrypoi…"   5 minutes ago    Up 5 minutes               9000/tcp                                     speedy

Run bash in speedy container

$ docker exec -it speedy bash

Stop and remove container

$ docker stop speedy
$ docker rm speedy

Rebuild the container

$ docker build --no-cache -t speedy .

A successful Git branching model

  1. Creating a feature branch
$ git checkout -b feature/the-feature-branch develop
$ git push --set-upstream origin feature/the-feature-branch
  1. Incorporating a finished feature on develop
$ git checkout develop
$ git merge --no-ff feature/the-feature-branch
$ git branch -d feature/the-feature-branch
$ git push origin develop
  1. Deleting a remote branch
$ git push origin -d feature/the-feature-branch