WIP - added /customer endpoint

Author: tylerjnap

.gitignore

@@ -87,3 +87,6 @@ ENV/
 
 # Rope project settings
 .ropeproject
+
+# DS_Store
+**/.DS_Store

README.rst

@@ -92,6 +92,7 @@ We currently expose the following resources to manage:
 * `Accounts`_
 * `Merchants`_
 * `Orders`_
+* `Customers`_
 
 Accounts
 ~~~~~~~~
@@ -173,7 +174,7 @@ Create
     from pybutton import Client
 
     client = Client('sk-XXX')
-    
+
     hashed_email = hashlib.sha256('user@example.com'.lower().strip()).hexdigest()
 
     response = client.orders.create({
@@ -235,6 +236,44 @@ Delete
     print(response)
     # <class pybutton.Response >
 
+Customers
+~~~~~~
+
+Create
+''''''
+
+.. code:: python
+
+    import hashlib
+    from pybutton import Client
+
+    client = Client('sk-XXX')
+
+    hashed_email = hashlib.sha256('user@example.com'.lower().strip()).hexdigest()
+
+    response = client.customers.create({
+        'id': 'customer-1234',
+        'email_sha256': hashed_email,
+        'advertising_id': '6E82078A-8146-4BA4-AC5B-76104861E61A',
+    })
+
+    print(response)
+    # <class pybutton.Response id: 'customer-1234', ...>
+
+Get
+'''
+
+.. code:: python
+
+    from pybutton import Client
+
+    client = Client('sk-XXX')
+
+    response = client.customers.get('customer-XXX')
+
+    print(response)
+    # <class pybutton.Response id: customer-XXX, segments:[], ...>
+
 Response
 --------
 

pybutton/client.py

@@ -4,6 +4,7 @@
 from __future__ import unicode_literals
 
 from pybutton.resources import Accounts
+from pybutton.resources import Customers
 from pybutton.resources import Merchants
 from pybutton.resources import Orders
 from pybutton.error import ButtonClientError
@@ -53,6 +54,7 @@ def __init__(self, api_key, config=None):
         self.orders = Orders(api_key, config)
         self.accounts = Accounts(api_key, config)
         self.merchants = Merchants(api_key, config)
+        self.customers = Customers(api_key, config)
 
 
 def config_with_defaults(config):

pybutton/resources/__init__.py

@@ -4,11 +4,13 @@
 from __future__ import unicode_literals
 
 from pybutton.resources.accounts import Accounts
+from pybutton.resources.customers import Customers
 from pybutton.resources.merchants import Merchants
 from pybutton.resources.orders import Orders
 
 __all__ = [
     Accounts,
+    Customers,
     Merchants,
     Orders
 ]

pybutton/resources/customers.py

@@ -0,0 +1,62 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from pybutton.resources.resource import Resource
+
+
+class Customers(Resource):
+    '''Manages interacting with Button Customers via the Button API
+
+    See Resource for class docstring.
+
+    '''
+
+    def _path(self, customer_id=None):
+        '''Format a url path
+
+        Args:
+            customer_id (str) optional: A Button customer id ('customer-XXX')
+
+        Returns:
+            (str): The formatted path
+
+        '''
+
+        if customer_id:
+            return '/v1/customers/{0}'.format(customer_id)
+        else:
+            return '/v1/customers'
+
+    def get(self, customer_id):
+        '''Get a customer
+
+        Args:
+            customer_id (str) : A Button customer id ('customer-XXX')
+
+        Raises:
+            pybutton.ButtonClientError
+
+        Returns:
+            (pybutton.Response) The API response
+
+        '''
+
+        return self.api_get(self._path(customer_id))
+
+    def create(self, customer):
+        '''Create an customer
+
+        Args:
+            customer (dict): A dict representing the attributes of an customer
+
+        Raises:
+            pybutton.ButtonClientError
+
+        Returns:
+            (pybutton.Response) The API response
+
+        '''
+
+        return self.api_post(self._path(), customer)

pybutton/test/resources/customers_test.py

@@ -0,0 +1,52 @@
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from unittest import TestCase
+from mock import Mock
+from mock import patch
+
+from pybutton.resources import Customers
+
+config = {
+    'hostname': 'api.usebutton.com',
+    'secure': True,
+    'port': 443,
+    'timeout': None,
+}
+
+
+class CustomersTestCase(TestCase):
+
+        def test_path(self):
+            customer = Customers('sk-XXX', config)
+            self.assertEqual(customer._path(), '/v1/customers')
+            self.assertEqual(customer._path('customer-1'), '/v1/customers/customer-1')
+
+        def test_get(self):
+            customer = Customers('sk-XXX', config)
+            customer_response = {'a': 1}
+
+            api_get = Mock()
+            api_get.return_value = customer_response
+
+            with patch.object(customer, 'api_get', api_get):
+                response = customer.get('customer-XXX')
+
+            self.assertEqual(response, customer_response)
+            api_get.assert_called_with('/v1/customers/customer-XXX')
+
+        def test_create(self):
+            customer = Customers('sk-XXX', config)
+            customer_payload = {'b': 2}
+            customer_response = {'a': 1}
+
+            api_post = Mock()
+            api_post.return_value = customer_response
+
+            with patch.object(customer, 'api_post', api_post):
+                response = customer.create(customer_payload)
+
+            self.assertEqual(response, customer_response)
+            api_post.assert_called_with('/v1/customers', customer_payload)

pybutton/version.py

@@ -1 +1 @@
-VERSION = '2.3.0'
+VERSION = '2.4.0'