Dev merge to master, PR

.gitignore

@@ -109,6 +109,8 @@ web/
 data/last-location*.json
 data/cells-*.json
 data/map-caught-*.json
+data/recent-forts-*.json
+user_web_catchable
 
 # Multiple config
 configs/*

CONTRIBUTORS.md

@@ -69,3 +69,4 @@
  * extink
  * Quantra
  * pmquan
+ * net8q

README.md

@@ -1,9 +1,16 @@
 # PokemonGo-Bot
 PokemonGo bot is a project created by the [PokemonGoF](https://github.com/PokemonGoF) team.
 
-The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Submit your PR's to `dev`.
+The project is currently setup in two main branches. `dev` also known as `beta` and `master` also known as `stable`. Make sure to submit your PR's to `dev`.
 
-If you need any help please don't create an issue here on github we have a great community on Slack, [Click here to join the chat!](https://pokemongo-bot.herokuapp.com). You can count on the community in #help channel.
+## Support
+Configuration issues/help - If you need any help please don't create an issue as we have a great community on Slack. You can count on the community in #help channel.
+ - [Click here to signup (first time only)](https://pokemongo-bot.herokuapp.com) 
+ - [Join if you're already a member](https://pokemongo-bot.slack.com/messages/general/). 
+
+[Bugs / Issues](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc) - If you discover a bug in the bot, please [search our issue tracker first](https://github.com/PokemonGoF/PokemonGo-Bot/issues?q=is%3Aissue+sort%3Aupdated-desc). If it hasn't been reported, please [create a new issue](https://github.com/PokemonGoF/PokemonGo-Bot/issues/new) and ensure you follow the template so that our team can assist you as quickly as possible
+
+[Feature Requests](http://feathub.com/PokemonGoF/PokemonGo-Bot) - If you have a great idea to improve the bot don't create an issue, use our [feature hub](http://feathub.com/PokemonGoF/PokemonGo-Bot). While you're there vote on other features to let the devs know what is most important to you
 
 ## Table of Contents
 - [Installation](https://github.com/PokemonGoF/PokemonGo-Bot/blob/dev/docs/installation.md)

configs/config.json.example

@@ -33,7 +33,7 @@
         "config": {
           "enabled": false,
           "min_interval": 10,
-          "stats": ["uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
+          "stats": ["username", "uptime", "stardust_earned", "xp_earned", "xp_per_hour", "stops_visited"],
           "terminal_log": true,
           "terminal_title": true
         }

docs/configuration_files.md

@@ -226,6 +226,7 @@ Key | Info
 **{iv_defense}** |  Individial Defense *(0-15)* of the current specific pokemon
 **{iv_stamina}** |  Individial Stamina *(0-15)* of the current specific pokemon
 **{iv_ads}**     |  Joined IV values in `(attack)/(defense)/(stamina)` format (*e.g. 4/12/9*, matches web UI format -- A/D/S)
+**{iv_ads_hex}** |  Joined IV values of `(attack)(defense)(stamina)` in HEX (*e.g. 4C9* for A/D/S = 4/12/9)
 **{iv_sum}**     |  Sum of the Individial Values *(0-45, e.g. 45 when 3 perfect 15 IVs)*
  |  **Basic Values of the pokemon (identical for all of one kind)**
 **{base_attack}**   |  Basic Attack *(40-284)* of the current pokemon kind

pokecli.py

@@ -43,6 +43,7 @@
 from pokemongo_bot.base_dir import _base_dir
 from pokemongo_bot.health_record import BotEvent
 from pokemongo_bot.plugin_loader import PluginLoader
+from pokemongo_bot.api_wrapper import PermaBannedException
 
 try:
     from demjson import jsonlint
@@ -64,11 +65,11 @@ class SIGINTRecieved(Exception): pass
 def main():
     bot = False
 
-    try:
-        def handle_sigint(*args):
-            raise SIGINTRecieved
-        signal.signal(signal.SIGINT, handle_sigint)
+    def handle_sigint(*args):
+        raise SIGINTRecieved
+    signal.signal(signal.SIGINT, handle_sigint)
 
+    try:
         logger.info('PokemonGO Bot v1.0')
         sys.stdout = codecs.getwriter('utf8')(sys.stdout)
         sys.stderr = codecs.getwriter('utf8')(sys.stderr)
@@ -102,7 +103,7 @@ def handle_sigint(*args):
                 while True:
                     bot.tick()
 
-            except (KeyboardInterrupt, SIGINTRecieved):
+            except KeyboardInterrupt:
                 bot.event_manager.emit(
                     'bot_exit',
                     sender=bot,
@@ -137,8 +138,24 @@ def handle_sigint(*args):
                 )
                 time.sleep(30)
 
+    except PermaBannedException:
+         bot.event_manager.emit(
+            'api_error',
+            sender=bot,
+            level='info',
+            formatted='Probably permabanned, Game Over ! Play again at https://club.pokemon.com/us/pokemon-trainer-club/sign-up/'
+         )
     except GeocoderQuotaExceeded:
         raise Exception("Google Maps API key over requests limit.")
+    except SIGINTRecieved:
+        if bot:
+            bot.event_manager.emit(
+                'bot_interrupted',
+                sender=bot,
+                level='info',
+                formatted='Bot caught SIGINT. Shutting down.'
+            )
+            report_summary(bot)
     except Exception as e:
         # always report session summary and then raise exception
         if bot:

pokemongo_bot/__init__.py

@@ -150,6 +150,7 @@ def _register_events(self):
 
         self.event_manager.register_event('bot_start')
         self.event_manager.register_event('bot_exit')
+        self.event_manager.register_event('bot_interrupted')
 
         # sleep stuff
         self.event_manager.register_event(

pokemongo_bot/api_wrapper.py

@@ -10,6 +10,9 @@
 
 from human_behaviour import sleep
 
+class PermaBannedException(Exception):
+    pass
+
 class ApiWrapper(PGoApi):
     def __init__(self):
         PGoApi.__init__(self)
@@ -77,6 +80,14 @@ def is_response_valid(self, result, request_callers):
         if not isinstance(result['responses'], dict):
             return False
 
+        try:
+            # Permaban symptom is empty response to GET_INVENTORY and status_code = 3
+            if result['status_code'] == 3 and 'GET_INVENTORY' in request_callers and not result['responses']['GET_INVENTORY']:
+                raise PermaBannedException
+        except KeyError:
+            # Still wrong
+            return False
+
         # the response can still programatically be valid at this point
         # but still be wrong. we need to check if the server did sent what we asked it
         for request_caller in request_callers:

pokemongo_bot/cell_workers/follow_path.py

@@ -19,7 +19,7 @@ def initialize(self):
 
         if self.path_start_mode == 'closest':
             self.ptr = self.find_closest_point_idx(self.points)
-        
+
         else:
             self.ptr = 0
 
@@ -83,7 +83,7 @@ def find_closest_point_idx(self, points):
             botlng = self.bot.api._position_lng
             lat = float(point['lat'])
             lng = float(point['lng'])
-            
+
             dist = distance(
                 botlat,
                 botlng,
@@ -98,6 +98,9 @@ def find_closest_point_idx(self, points):
         return return_idx
 
     def work(self):
+        last_lat = self.bot.api._position_lat
+        last_lng = self.bot.api._position_lng
+
         point = self.points[self.ptr]
         lat = float(point['lat'])
         lng = float(point['lng'])
@@ -115,11 +118,11 @@ def work(self):
                 is_at_destination = True
 
         else:
-            self.bot.api.set_position(lat, lng)
+            self.bot.api.set_position(lat, lng, 0)
 
         dist = distance(
-            self.bot.api._position_lat,
-            self.bot.api._position_lng,
+            last_lat,
+            last_lng,
             lat,
             lng
         )
@@ -132,4 +135,14 @@ def work(self):
             else:
                 self.ptr += 1
 
+        self.emit_event(
+            'position_update',
+            formatted="Walking from {last_position} to {current_position} ({distance} {distance_unit})",
+            data={
+                'last_position': (last_lat, last_lng, 0),
+                'current_position': (lat, lng, 0),
+                'distance': dist,
+                'distance_unit': 'm'
+            }
+        )
         return [lat, lng]

pokemongo_bot/cell_workers/follow_spiral.py

@@ -66,9 +66,19 @@ def _generate_spiral(starting_lat, starting_lng, step_size, step_limit):
         return coords
 
     def work(self):
+        last_lat = self.bot.api._position_lat
+        last_lng = self.bot.api._position_lng
+
         point = self.points[self.ptr]
         self.cnt += 1
 
+        dist = distance(
+            last_lat,
+            last_lng,
+            point['lat'],
+            point['lng']
+        )
+
         if self.bot.config.walk > 0:
             step_walker = StepWalker(
                 self.bot,
@@ -77,19 +87,12 @@ def work(self):
                 point['lng']
             )
 
-            dist = distance(
-                self.bot.api._position_lat,
-                self.bot.api._position_lng,
-                point['lat'],
-                point['lng']
-            )
-
             if self.cnt == 1:
                 self.emit_event(
                     'position_update',
                     formatted="Walking from {last_position} to {current_position} ({distance} {distance_unit})",
                     data={
-                        'last_position': self.bot.position,
+                        'last_position': (last_lat, last_lng, 0),
                         'current_position': (point['lat'], point['lng'], 0),
                         'distance': dist,
                         'distance_unit': 'm'
@@ -99,14 +102,20 @@ def work(self):
             if step_walker.step():
                 step_walker = None
         else:
-            self.bot.api.set_position(point['lat'], point['lng'])
-
-        if distance(
-                    self.bot.api._position_lat,
-                    self.bot.api._position_lng,
-                    point['lat'],
-                    point['lng']
-                ) <= 1 or (self.bot.config.walk > 0 and step_walker == None):
+            self.bot.api.set_position(point['lat'], point['lng'], 0)
+
+            self.emit_event(
+                'position_update',
+                formatted="Teleported from {last_position} to {current_position} ({distance} {distance_unit})",
+                data={
+                    'last_position': (last_lat, last_lng, 0),
+                    'current_position': (point['lat'], point['lng'], 0),
+                    'distance': dist,
+                    'distance_unit': 'm'
+                }
+            )
+
+        if dist <= 1 or (self.bot.config.walk > 0 and step_walker == None):
             if self.ptr + self.direction >= len(self.points) or self.ptr + self.direction <= -1:
                 self.direction *= -1
             if len(self.points) != 1:

pokemongo_bot/cell_workers/nickname_pokemon.py

@@ -1,9 +1,14 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
 import os
 import json
 from pokemongo_bot.base_task import BaseTask
 from pokemongo_bot.human_behaviour import sleep
 from pokemongo_bot.inventory import pokemons, Pokemon, Attack
 
+import re
+
 
 DEFAULT_IGNORE_FAVORITES = False
 DEFAULT_GOOD_ATTACK_THRESHOLD = 0.7
@@ -82,6 +87,7 @@ class NicknamePokemon(BaseTask):
     {iv_pct2}    IV perfection (in 00-99 format - 2 chars)
                     So 99 is best (it's a 100% perfection)
     {iv_pct1}    IV perfection (in 0-9 format - 1 char)
+    {iv_ads_hex} Joined IV values in HEX (e.g. 4C9)
 
     # Basic Values of the pokemon (identical for all of one kind)
     {base_attack}   Basic Attack (40-284) of the current pokemon kind
@@ -291,7 +297,8 @@ def _generate_new_nickname(self, pokemon, template):
         """
 
         # Filter template
-        template = template.lower().strip()
+        # only convert the keys to lowercase, leaving the format specifier alone
+        template = re.sub(r"{[\w_\d]*", lambda x:x.group(0).lower(), template).strip()
 
         # Individial Values of the current specific pokemon (different for each)
         iv_attack = pokemon.iv_attack
@@ -341,6 +348,8 @@ def _generate_new_nickname(self, pokemon, template):
             iv_stamina=iv_stamina,
             # Joined IV values like: 4/12/9
             iv_ads='/'.join(map(str, iv_list)),
+            # Joined IV values in HEX like: 4C9
+            iv_ads_hex = ''.join(map(lambda x: format(x, 'X'), iv_list)),
             # Sum of the Individial Values
             iv_sum=iv_sum,
             # IV perfection (in 000-100 format - 3 chars)

pokemongo_bot/cell_workers/pokemon_catch_worker.py

@@ -217,6 +217,7 @@ def _use_berry(self, berry_id, berry_count, encounter_id, catch_rate_by_ball, cu
             # softban?
             else:
                 new_catch_rate_by_ball = catch_rate_by_ball
+                self.bot.softban = True
                 self.emit_event(
                     'softban',
                     level='warning',

pokemongo_bot/cell_workers/recycle_items.py

@@ -12,8 +12,6 @@
 DEFAULT_MIN_EMPTY_SPACE = 6
 
 class RecycleItems(BaseTask):
-    SUPPORTED_TASK_API_VERSION = 1
-
     """
     Recycle undesired items if there is less than five space in inventory.
     You can use either item's name or id. For the full list of items see ../../data/items.json
@@ -40,6 +38,8 @@ class RecycleItems(BaseTask):
       }
     }
     """
+    SUPPORTED_TASK_API_VERSION = 1
+
 
     def initialize(self):
         self.items_filter = self.config.get('item_filter', {})
@@ -73,42 +73,41 @@ def should_run(self):
 
     def work(self):
         """
-        Discard items if necessary.
-        :return: Returns wether or not the task went well
+        Start the process of recycling items if necessary.
+        :return: Returns whether or not the task went well
         :rtype: WorkerResult
         """
-        # TODO: Use new inventory everywhere and then remove the inventory update
-        # Updating inventory
+
+        # TODO: Use new inventory everywhere and then remove this inventory update
         inventory.refresh_inventory()
+
         worker_result = WorkerResult.SUCCESS
         if self.should_run():
 
-            # For each user's item in inventory recycle it if needed
             for item_in_inventory in inventory.items().all():
-                amount_to_recycle = self.get_amount_to_recycle(item_in_inventory)
 
-                if self.item_should_be_recycled(item_in_inventory, amount_to_recycle):
+                if self.item_should_be_recycled(item_in_inventory):
+                    # Make the bot appears more human
                     action_delay(self.bot.config.action_wait_min, self.bot.config.action_wait_max)
-                    if ItemRecycler(self.bot, item_in_inventory, amount_to_recycle).work() == WorkerResult.ERROR:
+                    # If at any recycling process call we got an error, we consider that the result of this task is error too.
+                    if ItemRecycler(self.bot, item_in_inventory, self.get_amount_to_recycle(item_in_inventory)).work() == WorkerResult.ERROR:
                         worker_result = WorkerResult.ERROR
 
         return worker_result
 
-    def item_should_be_recycled(self, item, amount_to_recycle):
+    def item_should_be_recycled(self, item):
         """
         Returns a value indicating whether the item should be recycled.
-        :param amount_to_recycle:
-        :param item:
+        :param item: The Item to test
         :return: True if the title should be recycled; otherwise, False.
         :rtype: bool
         """
-        return (item.name in self.items_filter or str(
-            item.id) in self.items_filter) and amount_to_recycle > 0
+        return (item.name in self.items_filter or str(item.id) in self.items_filter) and self.get_amount_to_recycle(item) > 0
 
     def get_amount_to_recycle(self, item):
         """
         Determine the amount to recycle accordingly to user config
-        :param item: Item to determine the amount to recycle
+        :param item: Item to determine the amount to recycle.
         :return: The amount to recycle
         :rtype: int
         """