Add costume to Pokemon and costume/form to GymPokemon. (#2461)

* Introduced Costume to Pokemon & GymPokemon, Introduced Form to GymPokemon

* Switched DB changes to migrate()

* Updated Form to always check, not just for 201.
Fixed call for Costume & Form in Gym lookup

* Removing 'pokemon_data' from string

docs/extras/webhooks.md

@@ -226,6 +226,7 @@ A `pokemon` event is sent every time RocketMap detects that a Pokémon has spawn
 | `gender`                | The Pokémon's gender<sup>1</sup>                                    |       `2` |
 | `cp`                    | The Pokémon's CP<sup>2</sup>                                          |      `""` |
 | `form`                  | The Pokémon's form<sup>2</sup>                                        |      `""` |
+| `costume`               | The Pokémon's costume id<sup>2</sup>                                  |	     `""` |
 | `individual_attack`     | The Pokémon's attack IV<sup>2</sup>                                   |      `""` |
 | `individual_defense`    | The Pokémon's defence IV<sup>2</sup>                                  |      `""` |
 | `individual_stamina`    | The Pokémon's stamina IV<sup>2</sup>                                  |      `""` |
@@ -338,6 +339,7 @@ A `gym-info` event is sent whenever RocketMap fetches a gym's details.
 | `height`                   | The Pokémon's height                              | `1.746612787246704` |
 | `weight`                   | The Pokémon's weight                              | `51.84344482421875` |
 | `form`                     | The Pokémon's form                                       |          `0` |
+| `costume`                  | The Pokémon's costume                                    |          `0` |
 | `iv_attack`                | The Pokémon's attack IV                                  |         `12` |
 | `iv_defense`               | The Pokémon's defense IV                                 |         `14` |
 | `iv_stamina`               | The Pokémon's stamina IV                                 |         `14` |

pogom/models.py

@@ -39,8 +39,7 @@
 args = get_args()
 flaskDb = FlaskDB()
 cache = TTLCache(maxsize=100, ttl=60 * 5)
-
-db_schema_version = 24
+db_schema_version = 25
 
 
 class MyRetryDB(RetryOperationalError, PooledMySQLDatabase):
@@ -122,6 +121,7 @@ class Pokemon(LatLongModel):
     weight = FloatField(null=True)
     height = FloatField(null=True)
     gender = SmallIntegerField(null=True)
+    costume = SmallIntegerField(null=True)
     form = SmallIntegerField(null=True)
     last_modified = DateTimeField(
         null=True, index=True, default=datetime.utcnow)
@@ -502,6 +502,8 @@ def get_gyms(swLat, swLng, neLat, neLng, timestamp=0, oSwLat=None,
                            GymMember.deployment_time,
                            GymMember.last_scanned,
                            GymPokemon.pokemon_id,
+                           GymPokemon.costume,
+                           GymPokemon.form,
                            Trainer.name.alias('trainer_name'),
                            Trainer.level.alias('trainer_level'))
                        .join(Gym, on=(GymMember.gym_id == Gym.gym_id))
@@ -584,6 +586,8 @@ def get_gym(id):
                            GymPokemon.iv_attack,
                            GymPokemon.iv_defense,
                            GymPokemon.iv_stamina,
+                           GymPokemon.costume,
+                           GymPokemon.form,
                            Trainer.name.alias('trainer_name'),
                            Trainer.level.alias('trainer_level'))
                    .join(Gym, on=(GymMember.gym_id == Gym.gym_id))
@@ -1698,6 +1702,8 @@ class GymPokemon(BaseModel):
     iv_defense = SmallIntegerField(null=True)
     iv_stamina = SmallIntegerField(null=True)
     iv_attack = SmallIntegerField(null=True)
+    costume = SmallIntegerField(null=True)
+    form = SmallIntegerField(null=True)
     last_seen = DateTimeField(default=datetime.utcnow)
 
 
@@ -2005,14 +2011,10 @@ def parse_map(args, map_dict, scan_coords, scan_location, db_update_queue,
                 'height': None,
                 'weight': None,
                 'gender': p.pokemon_data.pokemon_display.gender,
-                'form': None
+                'costume': p.pokemon_data.pokemon_display.costume,
+                'form': p.pokemon_data.pokemon_display.form
             }
 
-            # Check for Unown's alphabetic character.
-            if pokemon_id == 201:
-                pokemon[p.encounter_id]['form'] = (p.pokemon_data
-                                                    .pokemon_display.form)
-
             # We need to check if exist and is not false due to a request error
             if pokemon_info:
                 pokemon[p.encounter_id].update({
@@ -2517,6 +2519,8 @@ def parse_gyms(args, gym_responses, wh_update_queue, db_update_queue):
                 'iv_defense': pokemon.individual_defense,
                 'iv_stamina': pokemon.individual_stamina,
                 'iv_attack': pokemon.individual_attack,
+                'costume': pokemon.pokemon_display.costume,
+                'form': pokemon.pokemon_display.form,
                 'last_seen': datetime.utcnow(),
             }
 
@@ -3226,6 +3230,18 @@ def database_migrate(db, old_ver):
                                ('disappear_time', 'pokemon_id'), False)
         )
 
+    if old_ver < 25:
+        migrate(
+            # Add `costume` column to `pokemon`
+            migrator.add_column('pokemon', 'costume',
+                                SmallIntegerField(null=True)),
+            # Add `form` column to `gympokemon`
+            migrator.add_column('gympokemon', 'form',
+                                SmallIntegerField(null=True)),
+            # Add `costume` column to `gympokemon`
+            migrator.add_column('gympokemon', 'costume',
+                                SmallIntegerField(null=True)))
+
     # Always log that we're done.
     log.info('Schema upgrade complete.')
     return True