⬆️ Use mrkriskrisu/ereceipt v0.1 interfaces (#6)

Author: MrKrisKrisu

.github/workflows/php.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [ 7.4, 8.0, 8.1 ]
+        php: [ 8.1 ]
         dependency-version: [ prefer-stable ]
 
     steps:

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Kristian Stöckel
+Copyright (c) 2022 Kristian Stöckel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -10,27 +10,40 @@ $ composer require mrkriskrisu/rewe-ereceipt-parser
 ```
 
 ## Example Usage
+
 ```php
 <?php
 require 'vendor/autoload.php';
 
-use REWEParser\Parser;
+use K118\Receipt\REWE\Parser;
 
 $receipt = Parser::parseFromPDF('receipt.pdf');
 
-echo "You've paid " . $receipt->getTotal() . " Euros.";
+echo "You've paid " . $receipt->getTotalPrice() . " Euros.";
 ```
 
 ## Requirements
-If you want to use the build in PDF Parser you need to install ``pdftotext`` in your system. 
-But don't worry, you can use your own PDF to Text Software if you want and give it to 
-the eReceipt-Parser via the ``Parser::parseFromText($text)`` function.
+
+If you want to use the build in PDF Parser you need to install ``pdftotext`` in your system. But don't worry, you can
+use your own PDF to Text Software if you want and give it to the eReceipt-Parser via
+the ``Parser::parseFromText($text)`` function.
 
 ## Get the eReceipt
-To get your digital Receipt at REWE you need to register at rewe.de and connect your 
-bonus card (PAYBACK) to the account. Then you can activate the "eBon" in the settings 
-and you'll receive the receipt after every purchase via Mail.
+
+To get your digital Receipt at REWE you need to register at rewe.de and connect your bonus card (PAYBACK) to the
+account. Then you can activate the "eBon" in the settings and you'll receive the receipt after every purchase via Mail.
 
 ## Contribution
-I'm glad that you want to help this library to be perfect. 
-Just do your magic und make a Pull Request. ✨
+
+I'm glad that you want to help this library to be perfect. Just do your magic und make a Pull Request. ✨
+
+## Related
+
+- [eReceipt](https://github.com/MrKrisKrisu/eReceipt) - PHP interfaces for all eReceipt libraries libraries
+
+- [eReceipt Parser](https://github.com/MrKrisKrisu/eReceipt-Parser) - PHP library which combines all of the following
+  libraries
+
+- [eReceipt Parser for Lidl](https://github.com/MrKrisKrisu/Lidl-eReceipt-Parser)
+
+- [eReceipt Parser for Edeka](https://github.com/MrKrisKrisu/EDEKA-eReceipt-Parser)

composer.json

@@ -10,13 +10,13 @@
     }
   ],
   "require": {
-    "php": "^7.4 || ^8.0",
+    "php": "^8.1",
     "spatie/pdf-to-text": "^1.3",
-    "nesbot/carbon": "^2.38"
+    "mrkriskrisu/ereceipt": "^0.1.0"
   },
   "autoload": {
     "psr-4": {
-      "REWEParser\\": "src/"
+      "K118\\Receipt\\REWE\\": "src/"
     }
   },
   "require-dev": {

examples/parseFromPDF.php

@@ -1,8 +1,8 @@
-<?php
+<?php declare(strict_types=1);
 
-use REWEParser\Exception\ReceiptParseException;
-use REWEParser\Parser;
 use Spatie\PdfToText\Exceptions\PdfNotFound;
+use K118\Receipt\REWE\Parser;
+use K118\Receipt\Format\Exception\ReceiptParseException;
 
 require_once '../vendor/autoload.php';
 

src/Address.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace K118\Receipt\REWE;
+
+class Address implements \K118\Receipt\Format\Models\Address {
+
+    private ?string $street;
+    private ?string $postalCode;
+    private ?string $city;
+    private ?string $country;
+
+    public function __construct(string $street = null, string $postalCode = null, string $city = null, string $country = null) {
+        $this->street     = $street;
+        $this->postalCode = $postalCode;
+        $this->city       = $city;
+        $this->country    = $country;
+    }
+
+    public function getStreet(): ?string {
+        return $this->street;
+    }
+
+    public function getPostalCode(): ?string {
+        return $this->postalCode;
+    }
+
+    public function getCity(): ?string {
+        return $this->city;
+    }
+
+    public function getCountry(): ?string {
+        return $this->country;
+    }
+}

src/Exception/PositionNotFoundException.php

@@ -1,6 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 
-namespace REWEParser\Exception;
+namespace K118\Receipt\REWE\Exception;
 
 use Exception;
 

src/Exception/ReceiptParseException.php

@@ -1,6 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 
-namespace REWEParser;
+namespace K118\Receipt\REWE;
 
 use Spatie\PdfToText\Exceptions\PdfNotFound;
 use Spatie\PdfToText\Pdf;

src/Parser.php

@@ -1,97 +1,82 @@
-<?php
+<?php declare(strict_types=1);
 
-namespace REWEParser;
+namespace K118\Receipt\REWE;
 
-use REWEParser\Exception\ReceiptParseException;
+use K118\Receipt\Format\Exception\ReceiptParseException;
+use K118\Receipt\Format\Models\Receipt;
 
-class Position {
+class Position implements \K118\Receipt\Format\Models\Position {
 
-    private $name;
-    private $priceTotal;
-    private $priceSingle;
-    private $taxCode;
+    private Receipt $receipt;
 
-    private $weight;
-    private $amount;
+    private string  $name;
+    private ?float  $priceTotal;
+    private ?float  $priceSingle;
+    private ?string $taxCode;
+    private ?float  $quantity;
 
-    /**
-     * The name of the product.
-     *
-     * @return string|NULL
-     */
-    public function getName(): ?string {
+    public function __construct(Receipt $receipt, string $name = null, float $priceTotal = null, float $priceSingle = null, string $taxCode = null, float $quantity = null) {
+        $this->receipt     = $receipt;
+        $this->name        = $name;
+        $this->priceTotal  = $priceTotal;
+        $this->priceSingle = $priceSingle;
+        $this->taxCode     = $taxCode;
+        $this->quantity    = $quantity;
+    }
+
+    public function getName(): string {
         return $this->name;
     }
 
     /**
-     * The total sum of the position
-     *
-     * @return float
-     * @throws ReceiptParseException
+     * The Tax Code of the position (e.g. "A" or "B")
+     * @return string|NULL
+     * @todo support tax amount
      */
-    public function getPriceTotal(): float {
-        if($this->priceTotal !== null) {
-            return $this->priceTotal;
-        }
-        if($this->priceSingle !== null && $this->amount !== null) {
-            return $this->priceSingle * $this->amount;
-        }
-        if($this->priceSingle !== null && $this->weight !== null) {
-            return $this->priceSingle * $this->weight;
-        }
-        throw new ReceiptParseException();
+    public function getTaxCode(): ?string {
+        return $this->taxCode;
+    }
+
+    public function getReceipt(): Receipt {
+        return $this->receipt;
     }
 
     /**
-     * The single value for one unit of the product
-     *
-     * @return float
      * @throws ReceiptParseException
      */
-    public function getPriceSingle(): float {
+    public function getSinglePrice(): float {
         if($this->priceSingle !== null) {
             return $this->priceSingle;
         }
-        if($this->priceTotal !== null && $this->amount !== null) {
-            return $this->priceTotal / $this->amount;
-        }
-        if($this->priceTotal !== null && $this->weight !== null) {
-            return $this->priceTotal / $this->weight;
+        if($this->priceTotal !== null && $this->quantity !== null) {
+            return $this->priceTotal / $this->quantity;
         }
         if($this->priceTotal !== null) {
             return $this->priceTotal;
         }
         throw new ReceiptParseException();
     }
 
-    /**
-     * The Tax Code of the position (e.g. "A" or "B")
-     *
-     * @return string|NULL
-     */
-    public function getTaxCode(): ?string {
-        return $this->taxCode;
+    public function getQuantity(): float {
+        return $this->quantity ?? 1.0;
     }
 
     /**
-     * The weight of the position (if the product is weightable)
-     *
-     * @return float|NULL
+     * @throws ReceiptParseException
      */
-    public function getWeight(): ?float {
-        return $this->weight;
+    public function getTotalPrice(): float {
+        if($this->priceTotal !== null) {
+            return $this->priceTotal;
+        }
+        if($this->priceSingle !== null && $this->quantity !== null) {
+            return $this->priceSingle * $this->quantity;
+        }
+        throw new ReceiptParseException();
     }
 
-    /**
-     * The amount of the position (if the product is countable)
-     *
-     * @return int|NULL
-     */
-    public function getAmount(): ?int {
-        if($this->amount === null && $this->weight === null) {
-            return 1;
-        }
-        return $this->amount;
+    public function getTax(): float {
+        // TODO: Implement getTax() method.
+        return -1;
     }
 
     public function setName(string $name): void {
@@ -110,12 +95,7 @@ public function setTaxCode(string $taxCode): void {
         $this->taxCode = $taxCode;
     }
 
-    public function setWeight(float $weight): void {
-        $this->weight = $weight;
-    }
-
-    public function setAmount(int $amount): void {
-        $this->amount = $amount;
+    public function setQuantity(float $quantity): void {
+        $this->quantity = $quantity;
     }
-
 }