Add tests

Simplify existing one
Fix found issues
Add deprecations

Author: BoShurik

CHANGELOG.md

@@ -2,19 +2,17 @@
 
 All Notable changes to `PHP Telegram Bot Api` will be documented in this file
 
-## NEXT - YYYY-MM-DD
+## [Unreleased] - [YYYY-MM-DD]
 
 ### Added
-- Nothing
-
-### Deprecated
-- Nothing
+- Add `\TelegramBot\Api\Types\Venue` mapping (`foursquare_type`, `google_place_id`, `google_place_type`)
 
 ### Fixed
-- Nothing
+- Fix `\TelegramBot\Api\Collection\Collection::addItem` max count constraint (#333)
+- Fix `\TelegramBot\Api\Types\StickerSet` mapping
 
-### Removed
-- Nothing
-
-### Security
-- Nothing
+### Deprecated
+- Deprecate `\TelegramBot\Api\Botan` class
+- Deprecate `$trackerToken` parameter in `\TelegramBot\Api\BotApi::__construct`
+- Deprecate `$trackerToken` parameter in `\TelegramBot\Api\Events\EventCollection::__construct`
+- Deprecate `\TelegramBot\Api\Types\PollAnswer::getFrom` use `\TelegramBot\Api\Types\PollAnswer::getUser`

composer.json

@@ -38,6 +38,7 @@
     },
     "scripts": {
         "test": "vendor/bin/simple-phpunit --colors=always",
+        "coverage": "XDEBUG_MODE=coverage vendor/bin/simple-phpunit --coverage-html build/coverage",
         "cs-fix": "vendor/bin/php-cs-fixer fix --allow-risky=yes --diff --ansi",
         "cs-check": "vendor/bin/php-cs-fixer fix --allow-risky=yes --diff --ansi --dry-run"
     },

phpunit.xml.dist

@@ -19,4 +19,7 @@
             <directory suffix=".php">src/</directory>
         </whitelist>
     </filter>
+    <php>
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="999999" />
+    </php>
 </phpunit>

src/BotApi.php

@@ -191,6 +191,7 @@ public function __construct($token, $trackerToken = null)
         $this->token = $token;
 
         if ($trackerToken) {
+            @trigger_error(sprintf('Passing $trackerToken to %s is deprecated', self::class), \E_USER_DEPRECATED);
             $this->tracker = new Botan($trackerToken);
         }
     }

src/Botan.php

@@ -4,6 +4,9 @@
 
 use TelegramBot\Api\Types\Message;
 
+/**
+ * @deprecated
+ */
 class Botan
 {
     /**

src/Client.php

@@ -44,6 +44,9 @@ class Client
      */
     public function __construct($token, $trackerToken = null)
     {
+        if ($trackerToken) {
+            @trigger_error(sprintf('Passing $trackerToken to %s is deprecated', self::class), \E_USER_DEPRECATED);
+        }
         $this->api = new BotApi($token);
         $this->events = new EventCollection($trackerToken);
     }

src/Collection/Collection.php

@@ -28,7 +28,7 @@ class Collection
      */
     public function addItem(CollectionItemInterface $item, $key = null)
     {
-        if ($this->maxCount > 0 && $this->count() + 1 >= $this->maxCount) {
+        if ($this->maxCount > 0 && $this->count() + 1 > $this->maxCount) {
             throw new ReachedMaxSizeException("Maximum collection items count reached. Max size: {$this->maxCount}");
         }
 

src/Events/EventCollection.php

@@ -31,6 +31,7 @@ class EventCollection
     public function __construct($trackerToken = null)
     {
         if ($trackerToken) {
+            @trigger_error(sprintf('Passing $trackerToken to %s is deprecated', self::class), \E_USER_DEPRECATED);
             $this->tracker = new Botan($trackerToken);
         }
     }

src/Types/Payments/ShippingAddress.php

@@ -60,14 +60,14 @@ class ShippingAddress extends BaseType
     /**
      * Second line for the address
      *
-     * @var integer
+     * @var string
      */
     protected $streetLine2;
 
     /**
      * Address post code
      *
-     * @var integer
+     * @var string
      */
     protected $postCode;
 
@@ -145,7 +145,7 @@ public function setStreetLine1($streetLine1)
 
     /**
      * @author MY
-     * @return int
+     * @return string
      */
     public function getStreetLine2()
     {
@@ -154,7 +154,7 @@ public function getStreetLine2()
 
     /**
      * @author MY
-     * @param int $streetLine2
+     * @param string $streetLine2
      */
     public function setStreetLine2($streetLine2)
     {
@@ -163,7 +163,7 @@ public function setStreetLine2($streetLine2)
 
     /**
      * @author MY
-     * @return int
+     * @return string
      */
     public function getPostCode()
     {
@@ -172,7 +172,7 @@ public function getPostCode()
 
     /**
      * @author MY
-     * @param int $postCode
+     * @param string $postCode
      */
     public function setPostCode($postCode)
     {

src/Types/PollAnswer.php

@@ -82,19 +82,15 @@ public function setUser(User $from)
     }
 
     /**
+     * @deprecated
+     *
      * @return User
      */
     public function getFrom()
     {
-        return $this->getUser();
-    }
+        @trigger_error(sprintf('Access user with %s is deprecated, use "%s::getUser" method', __METHOD__, __CLASS__), \E_USER_DEPRECATED);
 
-    /**
-     * @param User $from
-     */
-    public function setFrom(User $from)
-    {
-        return $this->setUser($from);
+        return $this->getUser();
     }
 
     /**

src/Types/ReplyKeyboardMarkup.php

@@ -65,7 +65,7 @@ class ReplyKeyboardMarkup extends BaseType
      */
     protected $selective;
 
-    public function __construct($keyboard, $oneTimeKeyboard = null, $resizeKeyboard = null, $selective = null)
+    public function __construct($keyboard = [], $oneTimeKeyboard = null, $resizeKeyboard = null, $selective = null)
     {
         $this->keyboard = $keyboard;
         $this->oneTimeKeyboard = $oneTimeKeyboard;

src/Types/ReplyKeyboardRemove.php

@@ -48,9 +48,9 @@ class ReplyKeyboardRemove extends BaseType
      */
     protected $selective;
 
-    public function __construct($remove_keyboard = true, $selective = false)
+    public function __construct($removeKeyboard = true, $selective = false)
     {
-        $this->removeKeyboard = $remove_keyboard;
+        $this->removeKeyboard = $removeKeyboard;
         $this->selective = $selective;
     }
 
@@ -63,11 +63,11 @@ public function getRemoveKeyboard()
     }
 
     /**
-     * @param bool $remove_keyboard
+     * @param bool $removeKeyboard
      */
-    public function setRemoveKeyboard($remove_keyboard)
+    public function setRemoveKeyboard($removeKeyboard)
     {
-        $this->removeKeyboard = $remove_keyboard;
+        $this->removeKeyboard = $removeKeyboard;
     }
 
     /**

src/Types/Sticker.php

@@ -36,15 +36,15 @@ class Sticker extends BaseType implements TypeInterface
      */
     protected static $map = [
         'file_id' => true,
+        'file_unique_id' => true,
+        'type' => true,
         'width' => true,
         'height' => true,
-        'thumb' => PhotoSize::class,
-        'file_size' => true,
-        'type' => true,
-        'file_unique_id' => true,
-        'premium_animation' => true,
         'is_animated' => true,
         'is_video' => true,
+        'thumb' => PhotoSize::class,
+        'file_size' => true,
+        'premium_animation' => File::class,
         'emoji' => true,
         'set_name' => true,
         'mask_position' => MaskPosition::class,

src/Types/StickerSet.php

@@ -32,8 +32,8 @@ class StickerSet extends BaseType implements TypeInterface
         'sticker_type' => true,
         'is_animated' => true,
         'is_video' => true,
-        'stickers' => true,
-        'thumb' => true,
+        'stickers' => ArrayOfSticker::class,
+        'thumb' => PhotoSize::class,
     ];
 
     /**

src/Types/Venue.php

@@ -36,6 +36,9 @@ class Venue extends BaseType implements TypeInterface
         'title' => true,
         'address' => true,
         'foursquare_id' => true,
+        'foursquare_type' => true,
+        'google_place_id' => true,
+        'google_place_type' => true,
     ];
 
     /**
@@ -66,6 +69,27 @@ class Venue extends BaseType implements TypeInterface
      */
     protected $foursquareId;
 
+    /**
+     * Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)
+     *
+     * @var string
+     */
+    protected $foursquareType;
+
+    /**
+     * Optional. Google Places identifier of the venue
+     *
+     * @var string
+     */
+    protected $googlePlaceId;
+
+    /**
+     * Optional. Google Places type of the venue.
+     *
+     * @var string
+     */
+    protected $googlePlaceType;
+
     /**
      * @return Location
      */
@@ -129,4 +153,52 @@ public function setFoursquareId($foursquareId)
     {
         $this->foursquareId = $foursquareId;
     }
+
+    /**
+     * @return string
+     */
+    public function getFoursquareType()
+    {
+        return $this->foursquareType;
+    }
+
+    /**
+     * @param string $foursquareType
+     */
+    public function setFoursquareType($foursquareType)
+    {
+        $this->foursquareType = $foursquareType;
+    }
+
+    /**
+     * @return string
+     */
+    public function getGooglePlaceId()
+    {
+        return $this->googlePlaceId;
+    }
+
+    /**
+     * @param string $googlePlaceId
+     */
+    public function setGooglePlaceId($googlePlaceId)
+    {
+        $this->googlePlaceId = $googlePlaceId;
+    }
+
+    /**
+     * @return string
+     */
+    public function getGooglePlaceType()
+    {
+        return $this->googlePlaceType;
+    }
+
+    /**
+     * @param string $googlePlaceType
+     */
+    public function setGooglePlaceType($googlePlaceType)
+    {
+        $this->googlePlaceType = $googlePlaceType;
+    }
 }