started refactor to new class structure

Author: callum-oakley

.gitignore

@@ -15,6 +15,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.eggs/
 
 pip-log.txt
 pip-delete-this-directory.txt

Makefile

@@ -1,5 +1,5 @@
 
 publish:
-	python setup.py sdist bdist_wheel upload
+    python setup.py sdist bdist_wheel upload
 
 .PHONY: publish

README.md

@@ -388,7 +388,7 @@ Get the list of channels in an application | *✔*
 Get the state of a single channel          | *✔*
 Get a list of users in a presence channel  | *✔*
 WebHook validation                         | *✔*
-Heroku add-on support						   | *✔*
+Heroku add-on support                           | *✔*
 Debugging & Logging                        | *✔*
 Cluster configuration                      | *✔*
 Timeouts                                   | *✔*
@@ -402,7 +402,7 @@ These are helpers that have been implemented to to ensure interactions with the
 
 Helper Functionality                     | Supported
 -----------------------------------------| :-------:
-Channel name validation 					 | ✔
+Channel name validation                      | ✔
 Limit to 10 channels per trigger         | ✔
 Limit event name length to 200 chars     | ✔
 

pusher/aiohttp.py

@@ -6,12 +6,12 @@
 from pusher.http import process_response
 
 class AsyncIOBackend:
-    def __init__(self, config):
+    def __init__(self, client):
         """Adapter for the requests module.
 
-        :param config:  pusher.Pusher object
+        :param client:  pusher.Client object
         """
-        self.config = config
+        self.client = client
         self.conn = aiohttp.TCPConnector()
 
     def send_request(self, request):
@@ -23,7 +23,7 @@ def send_request(self, request):
 
         response = yield from asyncio.wait_for(
             aiohttp.request(method, url, params=params, data=data, headers=headers, connector=self.conn),
-            timeout=self.config.timeout
+            timeout=self.client.timeout
         )
         body = yield from response.read_and_close()
         return process_response(response.status, body.decode('utf8'))

pusher/client.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+
+from .util import ensure_text, app_id_re
+
+import six
+
+class Client(object):
+
+    def __init__(self, app_id, key, secret, ssl=True, host=None, port=None, timeout=5, cluster=None,
+                                json_encoder=None, json_decoder=None, backend=None, **backend_options):
+        if backend is None:
+              from .requests import RequestsBackend
+              backend = RequestsBackend
+
+        self._app_id = ensure_text(app_id, "app_id")
+        if not app_id_re.match(self._app_id):
+              raise ValueError("Invalid app id")
+
+        self._key = ensure_text(key, "key")
+        self._secret = ensure_text(secret, "secret")
+
+        if not isinstance(ssl, bool):
+              raise TypeError("SSL should be a boolean")
+        self._ssl = ssl
+
+        if port and not isinstance(port, six.integer_types):
+              raise TypeError("port should be an integer")
+        self._port = port or (443 if ssl else 80)
+
+        if not isinstance(timeout, six.integer_types):
+              raise TypeError("timeout should be an integer")
+        self._timeout = timeout
+        self._json_encoder = json_encoder
+        self._json_decoder = json_decoder
+
+        self.http = backend(self, **backend_options)
+
+    @property
+    def app_id(self):
+        return self._app_id
+
+    @property
+    def key(self):
+        return self._key
+
+    @property
+    def secret(self):
+        return self._secret
+
+    @property
+    def host(self):
+        return self._host
+
+    @property
+    def port(self):
+        return self._port
+
+    @property
+    def timeout(self):
+        return self._timeout
+
+    @property
+    def ssl(self):
+        return self._ssl
+
+    @property
+    def scheme(self):
+        return 'https' if self.ssl else 'http'

pusher/config.py

@@ -10,8 +10,8 @@ class GAEBackend(object):
   """Adapter for the URLFetch Module. Necessary for using this library with Google
   App Engine"""
 
-  def __init__(self, config, **options):
-    self.config = config
+  def __init__(self, client, **options):
+    self.client = client
     self.options = options
 
   def send_request(self, request):
@@ -20,7 +20,7 @@ def send_request(self, request):
       headers=request.headers,
       method=request.method,
       payload=request.body,
-      deadline=self.config.timeout,
+      deadline=self.client.timeout,
       **self.options
     )
     return process_response(resp.status_code, resp.content)

pusher/gae.py

@@ -15,15 +15,15 @@
 GET, POST, PUT, DELETE = "GET", "POST", "PUT", "DELETE"
 
 class RequestMethod(object):
-    def __init__(self, pusher, f):
-        self.pusher = pusher
+    def __init__(self, client, f):
+        self.client = client
         self.f = f
 
     def __call__(self, *args, **kwargs):
-        return self.pusher.http.send_request(self.make_request(*args, **kwargs))
+        return self.client.http.send_request(self.make_request(*args, **kwargs))
 
     def make_request(self, *args, **kwargs):
-        return self.f(self.pusher, *args, **kwargs)
+        return self.f(self.client, *args, **kwargs)
 
 def doc_string(doc):
     def decorator(f):
@@ -59,15 +59,15 @@ class Request(object):
     An instance of that object is passed to the backend's send_request method
     for each request.
 
-    :param config: an instance of pusher.Pusher
+    :param client: an instance of pusher.Client
     :param method: HTTP method as a string
     :param path: The target path on the destination host
     :param params: Query params or body depending on the method
     """
-    def __init__(self, config, method, path, params=None):
+    def __init__(self, client, method, path, params=None):
         if params is None:
             params = {}
-        self.config = config
+        self.client = client
         self.method = method
         self.path = path
         self.params = copy.copy(params)
@@ -84,7 +84,7 @@ def __init__(self, config, method, path, params=None):
     def _generate_auth(self):
         self.body_md5 = hashlib.md5(self.body).hexdigest()
         self.query_params.update({
-            'auth_key': self.config.key,
+            'auth_key': self.client.key,
             'body_md5': six.text_type(self.body_md5),
             'auth_version': '1.0',
             'auth_timestamp': '%.0f' % time.time()
@@ -96,7 +96,7 @@ def _generate_auth(self):
             make_query_string(self.query_params)
         ])
 
-        self.query_params['auth_signature'] = sign(self.config.secret, auth_string)
+        self.query_params['auth_signature'] = sign(self.client.secret, auth_string)
 
     @property
     def query_string(self):
@@ -112,7 +112,7 @@ def url(self):
 
     @property
     def base_url(self):
-        return "%s://%s:%s" % (self.config.scheme, self.config.host, self.config.port)
+        return "%s://%s:%s" % (self.client.scheme, self.client.host, self.client.port)
 
     @property
     def headers(self):

pusher/http.py

@@ -1,4 +1,4 @@
-from .config import Config
+from .client import Client
 from .http import POST, Request, request_method
 from .util import ensure_text
 
@@ -9,37 +9,35 @@
 GCM_TTL = 241920
 WEBHOOK_LEVELS = ['INFO', 'DEBUG', '']
 
-class NotificationClient(Config):
-
-	def __init__(self, app_id, key, secret, ssl=True, host=None, port=None, timeout=5, cluster=None,
-				 json_encoder=None, json_decoder=None, backend=None, **backend_options):
-
-		super(NotificationClient, self).__init__(
-			app_id, key, secret, ssl,
-			host, port, timeout, cluster,
-			json_encoder, json_decoder, backend,
-			**backend_options)
-
-		if host:
-			self._host = ensure_text(host, "host")
-		else:
-			self._host = DEFAULT_HOST
-
-
-	@request_method
-	def notify(self, interests, notification):
-		if not isinstance(interests, list) and not isinstance(interests, set):
-			raise TypeError("Interests must be a list or a set")
-
-		if len(interests) is 0:
-			raise ValueError("Interests must not be empty")
-
-		if not isinstance(notification, dict):
-			raise TypeError("Notification must be a dictionary")
-
-		params = {
-			'interests': interests,
-		}
-		params.update(notification)
-		path =  "/%s/%s/apps/%s/notifications" % (API_PREFIX, API_VERSION, self.app_id)
-		return Request(self, POST, path, params)
+class NotificationClient(Client):
+    def __init__(self, app_id, key, secret, ssl=True, host=None, port=None, timeout=5, cluster=None,
+                 json_encoder=None, json_decoder=None, backend=None, **backend_options):
+        super(NotificationClient, self).__init__(
+            app_id, key, secret, ssl,
+            host, port, timeout, cluster,
+            json_encoder, json_decoder, backend,
+            **backend_options)
+
+        if host:
+            self._host = ensure_text(host, "host")
+        else:
+            self._host = DEFAULT_HOST
+
+
+    @request_method
+    def notify(self, interests, notification):
+        if not isinstance(interests, list) and not isinstance(interests, set):
+            raise TypeError("Interests must be a list or a set")
+
+        if len(interests) is 0:
+            raise ValueError("Interests must not be empty")
+
+        if not isinstance(notification, dict):
+            raise TypeError("Notification must be a dictionary")
+
+        params = {
+            'interests': interests,
+        }
+        params.update(notification)
+        path =  "/%s/%s/apps/%s/notifications" % (API_PREFIX, API_VERSION, self.app_id)
+        return Request(self, POST, path, params)