Fixed a whole bunch of stuff.

jordan-wright · jordan-wright · commit cf199beb9878 · 2017-01-18T21:43:06.000-06:00
diff --git a/gophish/api/__init__.py b/gophish/api/__init__.py
@@ -0,0 +1 @@
+from .api import APIEndpoint
diff --git a/gophish/api/api.py b/gophish/api/api.py
@@ -1,12 +1,14 @@
 import requests
 
+from gophish.models import Error
+
 '''
 api.py 
 
 Base API endpoint class that abstracts basic CRUD operations.
 '''
 
-class APIEndpoint:
+class APIEndpoint(object):
     """
     Represents an API endpoint for Gophish, containing common patterns
     for CRUD operations.
diff --git a/gophish/api/campaigns.py b/gophish/api/campaigns.py
@@ -1,12 +1,11 @@
 import json
 
-from gophish.error import Error
-from gophish.models import Campaign
+from gophish.models import Campaign, Error
 from gophish.api import APIEndpoint
 
 
 class API(APIEndpoint):
-    def __init__(self, api, endpoint='/campaigns'):
+    def __init__(self, api, endpoint='/api/campaigns'):
         """ Creates a new instance of the campaigns API """
 
         super(API, self).__init__(api, endpoint=endpoint, cls=Campaign)
diff --git a/gophish/api/groups.py b/gophish/api/groups.py
@@ -1,21 +1,22 @@
 from gophish.models import Group
+from gophish.api import APIEndpoint
 
 class API(APIEndpoint):
-    def __init__(self, api, endpoint='/groups'):
+    def __init__(self, api, endpoint='/api/groups'):
         super(API, self).__init__(api, endpoint=endpoint, cls=Group)
 
-    def get(group_id=None):
+    def get(self, group_id=None):
         """ Gets one or more groups """
         return super(API, self).get(resource_id=group_id)
 
-    def post(group):
+    def post(self, group):
         """ Creates a new group """
         return super(API, self).post(group)
 
-    def put(group):
+    def put(self, group):
         """ Edits a group """
         return super(API, self).put(group)
 
-    def delete(group_id):
+    def delete(self, group_id):
         """ Deletes a group by ID """
         return super(API, self).put(group_id)
diff --git a/gophish/api/pages.py b/gophish/api/pages.py
@@ -2,7 +2,7 @@
 from gophish.api import APIEndpoint
 
 class API(APIEndpoint):
-    def __init__(self, api, endpoint='/pages'):
+    def __init__(self, api, endpoint='/api/pages'):
         super(API, self).__init__(api, endpoint=endpoint, cls=Page)
 
     def get(self, page_id=None):
diff --git a/gophish/api/smtp.py b/gophish/api/smtp.py
@@ -1,8 +1,8 @@
-from gophish.api import APIEndpoint
 from gophish.models import SMTP
+from gophish.api import APIEndpoint
 
 class API(APIEndpoint):
-    def __init__(self, api, endpoint='/smtp'):
+    def __init__(self, api, endpoint='/api/smtp'):
         super(API, self).__init__(api, endpoint=endpoint, cls=SMTP)
 
     def get(self, smtp_id=None):
diff --git a/gophish/api/templates.py b/gophish/api/templates.py
@@ -2,7 +2,7 @@
 from gophish.api import APIEndpoint
 
 class API(APIEndpoint):
-    def __init__(self, api, endpoint='/templates'):
+    def __init__(self, api, endpoint='/api/templates'):
         super(API, self).__init__(api, endpoint=endpoint, cls=Template)
 
     def get(self, template_id=None):
diff --git a/gophish/client.py b/gophish/client.py
@@ -1,15 +1,33 @@
 import requests
 
+from gophish.api import (
+    campaigns,
+    groups,
+    pages,
+    smtp,
+    templates)
+
 DEFAULT_URL = 'http://localhost:3333'
 
-class Gophish:
-    def __init__(self, api_key, host=DEFAULT_URL):
+class GophishClient(object):
+    """ A standard HTTP REST client used by Gophish """
+    def __init__(self, api_key, host=DEFAULT_URL, **kwargs):
         self.api_key = api_key
         self.host = host
+        self._kwargs = kwargs
     
-    def __execute(path, method, data=None):
+    def execute(self, method, path, data=None):
         """ Executes a request to a given endpoint, returning the result """
 
-        url = "{}/{}".format(this.host, path)
-        response = requests.request(method, url, json=data)
-        return response.json()
+        url = "{}{}".format(self.host, path)
+        response = requests.request(method, url, params={"api_key": self.api_key}, json=data, **self._kwargs)
+        return response
+
+class Gophish(object):
+    def __init__(self, api_key, host=DEFAULT_URL, client=GophishClient, **kwargs):
+        self.client = client(api_key, host=host, **kwargs)
+        self.campaigns = campaigns.API(self.client)
+        self.groups = groups.API(self.client)
+        self.pages = pages.API(self.client)
+        self.smtp = smtp.API(self.client)
+        self.templates = templates.API(self.client)
diff --git a/gophish/models.py b/gophish/models.py
@@ -1,5 +1,11 @@
 from datetime import datetime
+
 import json as _json
+import dateutil.parser
+
+def parse_date(datestr):
+    """ Parses an ISO 8601 formatted date from Gophish """
+    return dateutil.parser.parse(datestr)
 
 class Model(object):
     def __init__(self):
@@ -51,36 +57,31 @@ class Result(Model):
             'position': None, 'ip': None, 'latitude': None, 'longitude': None,
             'status': None}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in Result.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
     @classmethod
     def parse(cls, json):
-        raise NotImplementedError
+        result = cls()
+        for key, val in json.items():
+            if key in cls.__valid_properties:
+                setattr(result, key, val)
 
 
 class TimelineEntry(object):
-    __valid_properties = ['email', 'time', 'message', 'details']
-
-    def __init__(entry):
-        for key, default in TimelineEntry.__valid_properties.items():
-            setattr(self, key, kwargs.get(key, default))
+    __valid_properties = {'email': None, 'time': None, 'message': None, 'details': None}
 
     @classmethod
     def parse(cls, json):
         entry = cls()
         for key, val in json.items():
-            if key == 'details':
+            if key == 'details' and val != "":
                 details = _json.loads(val)
                 setattr(entry, key, details)
             elif key in cls.__valid_properties:
                 setattr(entry, key, val)
 
-    @classmethod
-    def parse(cls, json):
-        raise NotImplementedError
-
 
 class User(Model):
     """ User contains the attributes for a member of a group
@@ -89,7 +90,7 @@ class User(Model):
             'id': None, 'first_name': None, 'last_name': None, 'email': None,
             'position': None}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in User.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
@@ -104,7 +105,7 @@ class Group(Model):
             'id': None, 'name': None, 'modified_date': datetime.now(),
             'targets': []}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in Group.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
@@ -117,7 +118,7 @@ def parse(cls, json):
                 setattr(group, key, users)
             elif key == 'modified_date':
                 setattr(group, key, parse_date(val))
-            elif key in Group.__valid_properties:
+            elif key in cls.__valid_properties:
                 setattr(group, key, val)
         return group
 
@@ -128,7 +129,7 @@ class SMTP(Model):
         'from_address': None, 'ignore_cert_errors' : False,
         'modified_date': datetime.now()}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in SMTP.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
@@ -138,7 +139,7 @@ def parse(cls, json):
         for key, val in json.items():
             if key == 'modified_date':
                 setattr(smtp, key, parse_date(val))
-            elif key in SMTP.__valid_properties:
+            elif key in cls.__valid_properties:
                 setattr(smtp, key, val)
         return smtp
 
@@ -148,7 +149,7 @@ class Template(Model):
         'id': None, 'name': None, 'text': None, 'html': None,
         'modified_date': datetime.now(), 'subject': None, 'attachments': []}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in Template.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
@@ -162,7 +163,7 @@ def parse(cls, json):
                 attachments = [
                         Attachment.parse(attachment) for attachment in val]
                 setattr(template, key, attachments)
-            elif key in Template.__valid_properties:
+            elif key in cls.__valid_properties:
                 setattr(template, key, val)
 
 
@@ -172,7 +173,7 @@ class Page(Model):
         'capture_credentials': False, 'capture_passwords': False,
         'redirect_url': None}
 
-    def __init__(**kwargs):
+    def __init__(self, **kwargs):
         for key, default in Page.__valid_properties.items():
             setattr(self, key, kwargs.get(key, default))
 
@@ -182,5 +183,22 @@ def parse(cls, json):
         for key, val in json.items():
             if key == 'modified_date':
                 setattr(page, key, parse_date(val))
-            elif key in Page.__valid_properties:
+            elif key in cls.__valid_properties:
                 setattr(page, key, val)
+
+class Attachment(Model):
+    __valid_properties = {}
+
+    @classmethod
+    def parse(cls, json):
+        return cls()
+
+class Error(Model):
+    __valid_properties = {'message', 'success', 'data'}
+
+    @classmethod
+    def parse(cls, json):
+        error = cls()
+        for key, val in json.items():
+            if key in cls.__valid_properties:
+                setattr(error, key, val)
