Refactor/exceptions (#175)

* refactor and put `to_pymilo_issue` method implementation into `PymiloException` class instead of concrete classes

* `autopep8.sh` applied

* `CHANGELOG.md` updated

Author: AHReccese

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ### Added
 ### Changed
+- `to_pymilo_issue` function in `PymiloException`
 - `valid_url_valid_file` testcase added in `test_exceptions.py`
 - `valid_url_valid_file` function in `import_exceptions.py`
 - `StandardPayload` in `RESTServerCommunicator`

pymilo/exceptions/deserialize_exception.py

@@ -64,30 +64,3 @@ def to_pymilo_log(self):
         if self.meta_data['error_type'] == DeserializationErrorTypes.CORRUPTED_JSON_FILE:
             pymilo_report['object']['json_file'] = self.meta_data['json_file']
         return pymilo_report
-
-    def to_pymilo_issue(self):
-        """
-        Generate an issue form from the populated error.
-
-        :return: issue form of the associated error as a string
-        """
-        pymilo_report = self.to_pymilo_log()
-        help_request = """
-        \n\nIn order to help us enhance Pymilo's functionality, please open an issue associated with this error and put the message below inside.\n
-        """
-        description = "#### Description\n Pymilo Import failed."
-        steps_to_produce = "#### Steps/Code to Reproduce\n It is auto-reported from the pymilo logger."
-        expected_behavior = "#### Expected Behavior\n A successful Pymilo Import."
-        actual_behavior = "#### Actual Behavior\n Pymilo Import failed."
-        operating_system = "#### Operating System\n {os}".format(
-            os=pymilo_report['os']['full-description'])
-        python_version = "#### Python Version\n {python_version}".format(
-            python_version=pymilo_report['versions']["python-version"])
-        pymilo_version = "#### PyMilo Version\n {pymilo_version}".format(
-            pymilo_version=pymilo_report['versions']["pymilo-version"])
-        gathered_data = "#### Logged Data\n {logged_data}".format(
-            logged_data=str(pymilo_report))
-
-        full_issue_form = help_request + description + steps_to_produce + expected_behavior + \
-            actual_behavior + operating_system + python_version + pymilo_version + gathered_data
-        return full_issue_form

pymilo/exceptions/pymilo_exception.py

@@ -27,7 +27,6 @@ def __init__(self, message, meta_data):
         self.message = message
         self.meta_data = meta_data
 
-    # collect All pymilo related data.
     def to_pymilo_log(self):
         """
         Generate a comprehensive report of the populated error.
@@ -59,13 +58,33 @@ def to_pymilo_log(self):
 
         return pymilo_report
 
-    @abstractmethod
     def to_pymilo_issue(self):
         """
         Generate an issue form from the populated error.
 
         :return: issue form of the associated error as string
         """
+        pymilo_report = self.to_pymilo_log()
+        help_request = """
+        \n\nIn order to help us enhance Pymilo's functionality, please open an issue associated with this error and put the message below inside.\n
+        """
+        associated_pymilo_class = "Export" if "Serialization" in self.message else "Import"
+        description = "#### Description\n Pymilo {pymilo_class} failed.".format(pymilo_class=associated_pymilo_class)
+        steps_to_produce = "\n#### Steps/Code to Reproduce\n It is auto-reported from the pymilo logger."
+        expected_behavior = "\n#### Expected Behavior\n A successful Pymilo {pymilo_class}.".format(
+            pymilo_class=associated_pymilo_class)
+        actual_behavior = "\n#### Actual Behavior\n Pymilo {pymilo_class} failed.".format(
+            pymilo_class=associated_pymilo_class)
+        operating_system = "#### Operating System\n {os}".format(os=pymilo_report['os']['full-description'])
+        python_version = "#### Python Version\n {python_version}".format(
+            python_version=pymilo_report['versions']["python-version"])
+        pymilo_version = "#### PyMilo Version\n {pymilo_version}".format(
+            pymilo_version=pymilo_report['versions']["pymilo-version"])
+        gathered_data = "#### Logged Data\n {logged_data}".format(logged_data=str(pymilo_report))
+
+        full_issue_form = help_request + description + steps_to_produce + expected_behavior + \
+            actual_behavior + operating_system + python_version + pymilo_version + gathered_data
+        return full_issue_form
 
     def __str__(self):
         """

pymilo/exceptions/serialize_exception.py

@@ -53,30 +53,3 @@ def to_pymilo_log(self):
         pymilo_report = super().to_pymilo_log()
         # TODO add any serializable field to `object` field of pymilo_report
         return pymilo_report
-
-    def to_pymilo_issue(self):
-        """
-        Generate an issue form from the populated error.
-
-        :return: issue form of the associated error as string
-        """
-        pymilo_report = self.to_pymilo_log()
-        help_request = """
-        \n\nIn order to help us enhance Pymilo's functionality, please open an issue associated with this error and put the message below inside.\n
-        """
-        description = "#### Description\n Pymilo Export failed."
-        steps_to_produce = "\n#### Steps/Code to Reproduce\n It is auto-reported from the pymilo logger."
-        expected_behavior = "\n#### Expected Behavior\n A successful Pymilo Export."
-        actual_behavior = "\n#### Actual Behavior\n Pymilo Export failed."
-        operating_system = "#### Operating System\n {os}".format(
-            os=pymilo_report['os']['full-description'])
-        python_version = "#### Python Version\n {python_version}".format(
-            python_version=pymilo_report['versions']["python-version"])
-        pymilo_version = "#### PyMilo Version\n {pymilo_version}".format(
-            pymilo_version=pymilo_report['versions']["pymilo-version"])
-        gathered_data = "#### Logged Data\n {logged_data}".format(
-            logged_data=str(pymilo_report))
-
-        full_issue_form = help_request + description + steps_to_produce + expected_behavior + \
-            actual_behavior + operating_system + python_version + pymilo_version + gathered_data
-        return full_issue_form