michaelbutler / phposh

src/Provider/Poshmark/DataParser.php

<?php

/*
 * This file is part of michaelbutler/phposh.
 * Source: https://github.com/michaelbutler/phposh
 *
 * (c) Michael Butler <michael@butlerpc.net>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file named LICENSE.
 */

namespace PHPosh\Provider\Poshmark;

use Symfony\Component\DomCrawler\Crawler;

class DataParser
{
    /**
     * Auto-detect the item id given a listing URL.
     *
     * @param string $listingUrl Listing URL such as /listing/Red-Pants-Gap-Jeans-5eaa834be23448c3438d...
     *
     * @return string Just the item id, such as 5eaa834be23448c3438d
     */
    public static function parseItemIdFromUrl(string $listingUrl): string
    {
        $parts = explode('-', $listingUrl);

        return array_pop($parts) ?: '';
    }

    /**
     * @return array [Price, Price, Price, Price] (orderTotal, poshmarkFee, earnings, tax)
     */
    public static function parseOrderPrices(Crawler $contentNode): array
    {
        // Parse out price information using a regex
        $pricesInfo = trim($contentNode->filter('.price-details')->text());
        $matches = [];
        preg_match(
            '/[\D.]+([\d.]+)[\D.]+([\d.]+)[\D.]+([\d.]+)[\D]+([\d]+\.[\d]+)/i',
            $pricesInfo,
            $matches
        );
        $orderTotal = $matches[1] ?? '0.00';
        $position = mb_strpos($pricesInfo, $orderTotal);
        $symbol = mb_substr($pricesInfo, $position - 1, 1);
        $orderTotal = $symbol . $orderTotal;
        $poshmarkFee = $symbol . $matches[2] ?? '0.00';
        $earnings = $symbol . $matches[3] ?? '0.00';
        $tax = $symbol . $matches[4] ?? '0.00';

        $orderTotal = Price::fromString($orderTotal);
        $poshmarkFee = Price::fromString($poshmarkFee);
        $earnings = Price::fromString($earnings);
        $tax = Price::fromString($tax);

        return [$orderTotal, $poshmarkFee, $earnings, $tax];
    }

    /**
     * Convert the JSON item data into an Item object.
     *
     * @param array $data Full JSON web response as a data array
     */
    public function parseOneItemResponseJson(array $data): Item
    {
        if (!isset($data['title']) && isset($data['data'])) {
            $itemData = $data['data'];
        } else {
            $itemData = $data;
        }
        $base_url = PoshmarkService::BASE_URL;
        $newItem = new Item();

        try {
            $dt = new \DateTime($itemData['created_at']);
        } catch (\Exception $e) {
            $dt = new \DateTime();
        }

        $currentPrice = new Price();
        $currentPrice->setCurrencyCode($itemData['price_amount']['currency_code'] ?? 'USD')
            ->setAmount($itemData['price_amount']['val'] ?? '0.00')
        ;

        $origPrice = new Price();
        $origPrice->setCurrencyCode($itemData['original_price_amount']['currency_code'] ?? 'USD')
            ->setAmount($itemData['original_price_amount']['val'] ?? '0.00')
        ;

        $newItem->setBrand($itemData['brand'] ?? '')
            ->setCreatedAt($dt)
            ->setPrice($currentPrice)
            ->setOrigPrice($origPrice)
            ->setSize($itemData['size'] ?: '')
            ->setId($itemData['id'] ?: '')
            ->setTitle($itemData['title'] ?: 'Unknown')
            ->setDescription($itemData['description'])
            ->setExternalUrl($base_url . '/listing/item-' . $itemData['id'])
            ->setImageUrl($itemData['picture_url'] ?: '')
            ->setRawData($itemData)
        ;

        return $newItem;
    }

    /**
     * @return Order[]
     */
    public function parseOrdersPagePartialResponse(string $html): array
    {
        $crawler = new Crawler($html);
        $items = $crawler->filter('a.item');
        $retItems = $items->each(static function (Crawler $node, $i) {

The parameter $i is not used and could be removed.

            $order = new Order();
            $price = Price::fromString($node->filter('.price .value')->first()->text());
            $path = $node->attr('href');
            $parts = explode('/', $path);
            $id = array_pop($parts);
            // Multi-item orders will not have a size here
            $sizeNode = $node->filter('.size .value');
            $count = 1;
            $badge = $node->filter('.badge-con .badge');
            if ($badge->count() > 0) {
                $count = $badge->first()->text();
            }
            $order->setTitle($node->filter('.title')->eq(0)->text())
                ->setId($id)
                ->setUrl(PoshmarkService::BASE_URL . $path)
                ->setImageUrl($node->filter('img.item-pic')->first()->attr('src'))

It seems like $node->filter('img.item-pic')->first()->attr('src') can also be of type null; however, parameter $imageUrl of PHPosh\Provider\Poshmark\Order::setImageUrl() does only seem to accept string, maybe add an additional type check?

                ->setSize($sizeNode->count() > 0 ? $sizeNode->first()->text() : '')
                ->setBuyerUsername($node->filter('.seller .value')->first()->text())
                ->setOrderTotal($price)
                ->setOrderStatus($node->filter('.status .value')->first()->text())
                ->setItemCount($count)

It seems like $count can also be of type string; however, parameter $itemCount of PHPosh\Provider\Poshmark\Order::setItemCount() does only seem to accept integer, maybe add an additional type check?

            ;

            return $order;
        });

        return $retItems;
    }

    /**
     * This parses the full order details and also makes HTTP requests for the full individual item details.
     *
     * @param string $html  HTML content of the order details page, or at least the main content block of it
     * @param Item[] $items Items to assign to the order
     */
    public function parseFullOrderResponseHtml(string $orderId, string $html, array $items): Order
    {
        $crawler = new Crawler($html);
        $contentNode = $crawler->filter('.order-main-con');

        $order = new Order();
        $order->setItems($items);

        [$orderTotal, $poshmarkFee, $earnings, $tax] = self::parseOrderPrices($contentNode);

        $count = count($items);
        $multiItemOrder = $count > 1;

        $title = $multiItemOrder ?
            sprintf('Order %s (%d items)', $orderId, count($items)) :
            $items[0]->getTitle();

        $dateAndUser = $contentNode->filter('.order-details')->html('');
        $dateAndUser = str_replace("\n", ' ', $this->dumbHtmlTagReplacement($dateAndUser));
        $matches = [];
        preg_match(
            '/Date: *([\S]+) *Order #: *([\S]+) *Buyer: *([\S]+)\b/i',
            $dateAndUser,
            $matches
        );
        $orderDate = trim($matches[1] ?? null);
        $buyerName = trim($matches[3] ?? 'Unknown');

        $orderDate = new \DateTime($orderDate);

        $orderStatus = $contentNode->filter('.status-desc')->text();

        $matches = [];
        preg_match('/Status:([A-Z ]+)/i', $orderStatus, $matches);
        $orderStatus = trim($matches[1] ?? 'Unknown');

        $order->setTitle($title)
            ->setId($orderId)
            ->setUrl(PoshmarkService::BASE_URL . '/order/sales/' . $orderId)
            ->setImageUrl($items[0]->getImageUrl())
            ->setSize('')
            ->setBuyerUsername($buyerName)
            ->setOrderTotal($orderTotal)
            ->setEarnings($earnings)
            ->setPoshmarkFee($poshmarkFee)
            ->setTaxes($tax)
            ->setOrderStatus($orderStatus)
            ->setItemCount($count)
            ->setOrderDate($orderDate)
        ;

        $order->setShippingLabelPdf(
            sprintf('%s/order/sales/%s/download_shipping_label_link', PoshmarkService::BASE_URL, $orderId)
        );

        return $order;
    }

    /**
     * Like the built-in strip_tags(), except it replaces each tag with a whitespace char " ".
     * This makes it easier to find individual words.
     * Example:
     * Input: <p>Hello</p><div>World!</div>
     * This method output: Hello World!
     * strip_tags output: HelloWorld!
     */
    private function dumbHtmlTagReplacement(string $string): string
    {
        $string = str_replace('>', '> ', $string);

        return strip_tags($string);
    }
}