Merge pull request #1 from PokemonGoMap/develop

Update to latest dev

Author: smc87

LICENSE

@@ -629,8 +629,8 @@ to attach them to the start of each source file to most effectively
 state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
-    <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Live visualization of all the pokemon in your area... and more!
+    Copyright (C) 2017 PokemonGo-Map Team
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU Affero General Public License as published

config/config.ini.example

@@ -26,22 +26,26 @@
 #min-seconds-left:      # time that must be left on a spawn before considering it too late and skipping it (default 0)
 #status-name:           # enables writing status updates to the database - if you use multiple processes, each needs a unique value
 
-#Pokemon IV 
+# Pokemon IV
 #encounter:             # Set to true to start encounters to pull more info, like IVs or movesets. (default false)
 #encounter-delay:       # delay in seconds before starting an encounter. Must not be zero. (default 1)
 #encounter-whitelist:   # whitelist of pokemon ids to encounter. Syntax [id,id,id,id] (Do not use with blacklist)
 #encounter-blacklist:   # blacklist of pokemon ids to NOT encounter. Syntax [id,id,id,id] (Do not use with whitelist)
 
 # Misc
-#gmaps-key:             # your Google Maps API key
+#gmaps-key:             # Your Google Maps API key
 #proxy:                 # Proxy URL e.g. socks5://127.0.0.1:9050 or a list of proxies e.g. [socks5://127.0.0.1:9050,socks5://127.0.0.1:9050]
 #proxy-timeout:         # Timeout before proceeding with next proxy while checking if the proxy works, (default 5)
 #proxy-display:         # Used with -ps, full = display complete proxy address. Index = displays just the index for that proxy (default index)
 #proxy-file:            # Load proxy list from text file (one proxy per line), overrides #proxy
 #proxy-refresh:         # Period of proxy file reloading, in seconds. Works only with #proxy-file (0 to disable), (default 0)
 #proxy-rotation:        # Enable proxy rotation with account changing for search threads (none/round/random), (default='none')
-#webhook:               # webhook URL (including http://)
-#webhook-updates-only:  # only send updates to webhooks, (excludes gyms & non-lured pokéstops)
+#webhook:               # Webhook URL e.g. http://127.0.0.1:12345 or a list for multiple webhooks [http://127.0.0.1:1345,http://127.0.0.1:12346]
+#webhook-updates-only:  # Only send updates to webhooks (excludes gyms & non-lured pokéstops).
+#wh-retries:            # Number of times to retry sending webhook data on failure (default: 5).
+#wh-timeout:            # Timeout (in seconds) for webhook requests (default: 2).
+#wh-backoff-factor:     # Factor (in seconds) by which the delay until next retry will increase (default: 0.25).
+#wh-lfu-size:           # Webhook LFU cache max size (default: 1000).
 
 # Webserver settings
 #host:                  # address to listen on (default 127.0.0.1)
@@ -52,6 +56,6 @@
 #encrypt-lib:           # path to encrypt lib to be used instead of the shipped ones
 #status-page-password:  # enables and protects the /status page to view status of all workers
 
-#Uncomment a line when you want to change its default value (Remove # at the beginning)
-#Please ensure to leave a space after the : (example setting: value)
-#username, password, location and gmaps-key are required
+# Uncomment a line when you want to change its default value (Remove # at the beginning)
+# Please ensure to leave a space after the colon (:) (example setting: value)
+# Username, password, location and gmaps-key are required

docs/extras/commandline.md

@@ -194,7 +194,7 @@
       --db-threads DB_THREADS
                             Number of db threads; increase if the db queue falls
                             behind [env var: POGOMAP_DB_THREADS]
-      -wh [WEBHOOKS [WEBHOOKS ...]], --webhook [WEBHOOKS [WEBHOOKS ...]]
+      -wh [WEBHOOKS [-wh WEBHOOKS ...]], --webhook [WEBHOOKS [--webhook WEBHOOKS ...]]
                             Define URL(s) to POST webhook information to [env var:
                             POGOMAP_WEBHOOK]
       -gi, --gym-info       Get all details about gyms (causes an additional API

pogom/models.py

@@ -242,9 +242,9 @@ def get_seen(cls, timediff):
     @classmethod
     def get_appearances(cls, pokemon_id, timediff):
         '''
-        :param pokemon_id: id of pokemon that we need appearances for
+        :param pokemon_id: id of Pokemon that we need appearances for
         :param timediff: limiting period of the selection
-        :return: list of  pokemon  appearances over a selected period
+        :return: list of Pokemon appearances over a selected period
         '''
         if timediff:
             timediff = datetime.utcnow() - timediff
@@ -262,7 +262,7 @@ def get_appearances(cls, pokemon_id, timediff):
     @classmethod
     def get_appearances_times_by_spawnpoint(cls, pokemon_id, spawnpoint_id, timediff):
         '''
-        :param pokemon_id: id of pokemon that we need appearances times for
+        :param pokemon_id: id of Pokemon that we need appearances times for
         :param spawnpoint_id: spawnpoing id we need appearances times for
         :param timediff: limiting period of the selection
         :return: list of time appearances over a selected period
@@ -382,7 +382,7 @@ def get_spawnpoints_in_hex(cls, center, steps):
             # examples: time    shifted
             #           0       (   0 + 2700) = 2700 % 3600 = 2700 (0th minute to 45th minute, 15 minutes prior to appearance as time wraps around the hour.)
             #           1800    (1800 + 2700) = 4500 % 3600 =  900 (30th minute, moved to arrive at 15th minute.)
-            # todo: this DOES NOT ACCOUNT for pokemons that appear sooner and live longer, but you'll _always_ have at least 15 minutes, so it works well enough.
+            # todo: this DOES NOT ACCOUNT for Pokemon that appear sooner and live longer, but you'll _always_ have at least 15 minutes, so it works well enough.
             location['time'] = cls.get_spawn_time(location['time'])
 
         return filtered
@@ -1016,7 +1016,7 @@ class SpawnPoint(BaseModel):
     # for example, a 30 minute spawn is 'hhss'
     kind = CharField(max_length=4, default='hhhs')
 
-    # links shows whether a pokemon encounter id changes between quartiles or stays the same
+    # links shows whether a Pokemon encounter id changes between quartiles or stays the same
     # both 1x45 and 1x60h3 have the kind of 'sssh', but the different links shows when the
     # encounter id changes
     # same encounter id is shared between two quartiles, links shows a '+',
@@ -1031,7 +1031,7 @@ class SpawnPoint(BaseModel):
     missed_count = IntegerField(default=0)
 
     # next 2 fields are to narrow down on the valid TTH window
-    # seconds after the hour of the latest pokemon seen time within the hour
+    # seconds after the hour of the latest Pokemon seen time within the hour
     latest_seen = IntegerField()
 
     # seconds after the hour of the earliest time wasn't seen after an appearance
@@ -1275,7 +1275,7 @@ def classify(cls, sp, scan_loc, now_secs, sighting=None):
         # same: whether encounter ID was same or different over that time}
 
         # for 60 min spawns ('ssss'), the largest gap doesn't give the earliest spawn point,
-        # because a pokemon is always there
+        # because a Pokemon is always there
         # use the union of all intervals where the same encounter ID was seen to find the latest_seen
         # If a different encounter ID was seen, then the complement of that interval was the same
         # ID, so union that complement as well
@@ -1444,7 +1444,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
     sp_id_list = []
     now_secs = date_secs(now_date)
 
-    # consolidate the individual lists in each cell into one list of pokemon and a list of forts
+    # consolidate the individual lists in each cell into one list of Pokemon and a list of forts
     cells = map_dict['responses']['GET_MAP_OBJECTS']['map_cells']
     for cell in cells:
         nearby_pokemons += cell.get('nearby_pokemons', [])
@@ -1457,7 +1457,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
     # Check for a 0/0/0 bad scan
     # If we saw nothing and there should be visible forts, it's bad
     if not len(wild_pokemon) and not len(forts) and ScannedLocation.visible_forts(step_location):
-        log.warning('Bad scan. Parsing found 0/0/0 pokemons/pokestops/gyms')
+        log.warning('Bad scan. Parsing found 0/0/0 Pokemon/pokestops/gyms')
         log.info('Common causes: captchas, IP bans, or using -ng and -nk arguments')
         return {
             'count': 0,
@@ -1467,8 +1467,8 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
         }
 
     if not len(nearby_pokemons) and not len(wild_pokemon):
-        log.warning('Nothing on nearby_pokemons or wild. Speed violation?')
-        log.info("Common causes: not using -speed, deleting or dropping the WorkerStatus table without waiting before restarting, or there really aren't any pokemon in 200m")
+        log.warning('No nearby or wild Pokemon. Speed violation?')
+        log.info("Common causes: not using -speed, deleting or dropping the WorkerStatus table without waiting before restarting, or there really aren't any Pokemon in 200m")
 
     scan_loc = ScannedLocation.get_by_loc(step_location)
     done_already = scan_loc['done']
@@ -1483,7 +1483,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
                  .where((Pokemon.disappear_time > datetime.utcnow()) & (Pokemon.encounter_id << encounter_ids))
                  .dicts())
 
-        # Store all encounter_ids and spawnpoint_id for the pokemon in query (all thats needed to make sure its unique).
+        # Store all encounter_ids and spawnpoint_id for the Pokemon in query (all thats needed to make sure its unique).
         encountered_pokemon = [(p['encounter_id'], p['spawnpoint_id']) for p in query]
 
         for p in wild_pokemon:
@@ -1511,7 +1511,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
                     sighting['tth_secs'] = d_t_secs
 
                     # only update when TTH is seen for the first time
-                    # just before pokemon migrations, Niantic sets all TTH to the exact time of the migration
+                    # just before Pokemon migrations, Niantic sets all TTH to the exact time of the migration
                     # not the normal despawn time
                     sp['latest_seen'] = d_t_secs
                     sp['earliest_unseen'] = d_t_secs
@@ -1536,7 +1536,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
             sp['last_scanned'] = datetime.utcfromtimestamp(p['last_modified_timestamp_ms'] / 1000.0)
 
             if (b64encode(str(p['encounter_id'])), p['spawn_point_id']) in encountered_pokemon:
-                # If pokemon has been encountered before dont process it.
+                # If Pokemon has been encountered before don't process it.
                 skipped += 1
                 continue
 
@@ -1642,7 +1642,7 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
                         'enabled': f['enabled'],
                         'latitude': f['latitude'],
                         'longitude': f['longitude'],
-                        'last_modified': f['last_modified_timestamp_ms'],
+                        'last_modified_time': f['last_modified_timestamp_ms'],
                         'lure_expiration': l_e,
                         'active_fort_modifier': active_fort_modifier
                     }))
@@ -1691,12 +1691,13 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
                         f['last_modified_timestamp_ms'] / 1000.0),
                 }
 
-    log.info('Parsing found %d pokemons, %d pokestops, and %d gyms.',
+    log.info('Parsing found %d Pokemon, %d nearby, %d pokestops, and %d gyms.',
              len(pokemons) + skipped,
+             len(nearby_pokemons),
              len(pokestops) + stopsskipped,
              len(gyms))
 
-    log.debug('Skipped %d Pokemons and %d pokestops.', skipped, stopsskipped)
+    log.debug('Skipped %d Pokemon and %d pokestops.', skipped, stopsskipped)
 
     # look for spawnpoints within scan_loc that are not here to see if can narrow down tth window
     for sp in ScannedLocation.linked_spawn_points(scan_loc['cellid']):
@@ -1709,13 +1710,13 @@ def parse_map(args, map_dict, step_location, db_update_queue, wh_update_queue, a
             if clock_between(endpoints[0], now_secs, endpoints[1]):
                 sp['missed_count'] += 1
                 spawn_points[sp['id']] = sp
-                log.warning('%s kind spawnpoint %s has no pokemon %d times in a row',
+                log.warning('%s kind spawnpoint %s has no Pokemon %d times in a row',
                             sp['kind'], sp['id'], sp['missed_count'])
                 log.info('Possible causes: Still doing initial scan, or super rare double spawnpoint during hidden period, or Niantic has removed spawnpoint')
 
         if (not SpawnPoint.tth_found(sp) and scan_loc['done'] and
                 (sp['earliest_unseen'] - sp['latest_seen'] - args.spawn_delay) % 3600 < 60):
-            log.warning('Spawnpoint %s was unable to locate a TTH, with only %ss after pokemon last seen',
+            log.warning('Spawnpoint %s was unable to locate a TTH, with only %ss after Pokemon last seen',
                         sp['id'], (sp['earliest_unseen'] - sp['latest_seen']) % 3600)
             log.info('Embiggening search for TTH by 15 minutes to try again')
             if sp['id'] not in sp_id_list:
@@ -1914,7 +1915,7 @@ def clean_db_loop(args):
                      .where(Pokestop.lure_expiration < datetime.utcnow()))
             query.execute()
 
-            # If desired, clear old pokemon spawns.
+            # If desired, clear old Pokemon spawns.
             if args.purge_data > 0:
                 query = (Pokemon
                          .delete()
@@ -2041,7 +2042,7 @@ def database_migrate(db, old_ver):
         db.drop_tables([ScannedLocation])
 
     if old_ver < 5:
-        # Some pokemon were added before the 595 bug was "fixed".
+        # Some Pokemon were added before the 595 bug was "fixed".
         # Clean those up for a better UX.
         query = (Pokemon
                  .delete()