Rename all class methods to lowercase

Author: Tom Hendrikx

MANIFEST.in

@@ -1,3 +1,3 @@
 include *.mdown *.txt
-recursive-include Mollie *.py *.pem
-prune examples
+recursive-include mollie *.py *.pem
+prune examples

README.md

@@ -48,7 +48,7 @@ Initializing the Mollie API client, and setting your API key.
 
 ```python
 mollie = Mollie.API.Client()
-mollie.setApiKey('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
+mollie.set_api_key('test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM')
 ```
 
 Creating a new payment.
@@ -67,7 +67,7 @@ Retrieving a payment.
 ```python
 payment = mollie.payments.get(payment['id'])
 
-if payment.isPaid():
+if payment.is_paid():
     print 'Payment received.'
 ```
 

examples/1-new-payment.py

@@ -22,7 +22,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         #
         # Generate a unique order number for this example. It is important to include this unique attribute

examples/10-customer-payment-history.py

@@ -20,7 +20,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         body = ''
 
@@ -49,7 +49,7 @@ def main():
         #
         # See: https://www.mollie.com/nl/docs/reference/customers/list-payments
         #
-        payments = mollie_client.customer_payments.withParentId(customer_id).all(offset=0, count=amount_of_payments_to_retrieve)
+        payments = mollie_client.customer_payments.with_parent_id(customer_id).all(offset=0, count=amount_of_payments_to_retrieve)
 
         body += '<p>Customer "%s" has %s payments</p>' % (customer['id'], payments['totalCount'])
 

examples/2-webhook-verification.py

@@ -20,7 +20,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         #
         # Retrieve the payment's current state.
@@ -37,17 +37,17 @@ def main():
         #
         database_write(order_nr, payment['status'])
 
-        if payment.isPaid():
+        if payment.is_paid():
             #
             # At this point you'd probably want to start the process of delivering the product to the customer.
             #
             return 'Paid'
-        elif payment.isPending():
+        elif payment.is_pending():
             #
             # The payment has started but is not complete yet.
             #
             return 'Pending'
-        elif payment.isOpen():
+        elif payment.is_open:
             #
             # The payment has not started yet. Wait for it.
             #

examples/4-ideal-payment.py

@@ -22,7 +22,7 @@ def main ():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie.setApiKey(api_key)
+        mollie.set_api_key(api_key)
 
 
         #

examples/5-payments-history.py

@@ -18,7 +18,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         #
         # Get the all payments for this API key ordered by newest.

examples/6-list-activated-methods.py

@@ -19,7 +19,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         #
         # Get the all the activated methods for this API key.

examples/7-new-customer.py

@@ -18,7 +18,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         #
         # See: https://www.mollie.com/nl/docs/reference/customers/create

examples/8-list-customers.py

@@ -18,7 +18,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         amount_of_customers_to_retrieve = 20
 

examples/9-create-customer-payment.py

@@ -22,7 +22,7 @@ def main():
         #
         api_key = os.environ.get('MOLLIE_API_KEY', 'test_test')
         mollie_client = mollie.api.Client()
-        mollie_client.setApiKey(api_key)
+        mollie_client.set_api_key(api_key)
 
         body = ''
 
@@ -53,7 +53,7 @@ def main():
         #
         # See: https://www.mollie.com/nl/docs/reference/customers/create-payment
         #
-        payment = mollie_client.customer_payments.withParentId(customer_id).create({
+        payment = mollie_client.customer_payments.with_parent_id(customer_id).create({
             'amount':      {'currency': 'EUR', 'value': '100.00'},  # Create some variety in the payment amounts
             'description': 'My first API payment',
             'webhookUrl':  flask.request.url_root + '2-webhook-verification?order_nr=' + str(order_nr),

mollie/api/client.py

@@ -27,20 +27,20 @@ class Client(object):
     ])
 
     @staticmethod
-    def validateApiEndpoint(api_endpoint):
+    def validate_api_endpoint(api_endpoint):
         return api_endpoint.strip().rstrip('/')
 
     @staticmethod
-    def validateApiKey(api_key):
+    def validate_api_key(api_key):
         api_key = api_key.strip()
         if not re.compile(r'^(live|test)_\w+$').match(api_key):
             raise Error('Invalid API key: "%s". An API key must start with "test_" or "live_".' % api_key)
         return api_key
 
     def __init__(self, api_key=None, api_endpoint=None):
-        self.api_endpoint = self.validateApiEndpoint(api_endpoint or self.API_ENDPOINT)
+        self.api_endpoint = self.validate_api_endpoint(api_endpoint or self.API_ENDPOINT)
         self.api_version = self.API_VERSION
-        self.api_key = self.validateApiKey(api_key) if api_key else None
+        self.api_key = self.validate_api_key(api_key) if api_key else None
         self.payments = resources.Payments(self)
         self.payment_refunds = resources.PaymentRefunds(self)
         self.payment_chargebacks = resources.PaymentChargebacks(self)
@@ -53,22 +53,22 @@ def __init__(self, api_key=None, api_endpoint=None):
         self.customer_subscriptions = resources.CustomerSubscriptions(self)
         self.customer_payments = resources.CustomerPayments(self)
 
-    def getApiEndpoint(self):
+    def get_api_endpoint(self):
         return self.api_endpoint
 
-    def setApiEndpoint(self, api_endpoint):
-        self.api_endpoint = self.validateApiEndpoint(api_endpoint)
+    def set_api_endpoint(self, api_endpoint):
+        self.api_endpoint = self.validate_api_endpoint(api_endpoint)
 
-    def setApiKey(self, api_key):
-        self.api_key = self.validateApiKey(api_key)
+    def set_api_key(self, api_key):
+        self.api_key = self.validate_api_key(api_key)
 
-    def getCACert(self):
+    def get_cacert(self):
         cacert = pkg_resources.resource_filename('mollie.api', 'cacert.pem')
         if not cacert or len(cacert) < 1:
             raise Error('Unable to load cacert.pem')
         return cacert
 
-    def performHttpCall(self, http_method, path, data=None, params=None):
+    def perform_http_call(self, http_method, path, data=None, params=None):
         if not self.api_key:
             raise Error('You have not set an API key. Please use setApiKey() to set the API key.')
         url = '%s/%s/%s' % (self.api_endpoint, self.api_version, path)
@@ -82,7 +82,7 @@ def performHttpCall(self, http_method, path, data=None, params=None):
         try:
             response = requests.request(
                 http_method, url,
-                verify=self.getCACert(),
+                verify=self.get_cacert(),
                 headers={
                     'Accept': 'application/json',
                     'Authorization': 'Bearer ' + self.api_key,

mollie/api/objects/base.py

@@ -1,6 +1,6 @@
 class Base(dict):
 
-    def getProperty(self, name):
+    def _get_property(self, name):
         """Return the named property from dictionary values."""
         if not self[name]:
             return None

mollie/api/objects/customer.py

@@ -4,32 +4,32 @@
 class Customer(Base):
     @property
     def id(self):
-        return self.getProperty('id')
+        return self._get_property('id')
 
     @property
     def name(self):
-        return self.getProperty('name')
+        return self._get_property('name')
 
     @property
     def email(self):
-        return self.getProperty('email')
+        return self._get_property('email')
 
     @property
     def locale(self):
-        return self.getProperty('locale')
+        return self._get_property('locale')
 
     @property
     def metadata(self):
-        return self.getProperty('metadata')
+        return self._get_property('metadata')
 
     @property
     def mode(self):
-        return self.getProperty('mode')
+        return self._get_property('mode')
 
     @property
     def resource(self):
-        return self.getProperty('resource')
+        return self._get_property('resource')
 
     @property
-    def createdAt(self):
-        return self.getProperty('createdAt')
+    def created_at(self):
+        return self._get_property('createdAt')

mollie/api/objects/list.py

@@ -6,11 +6,11 @@ def __init__(self, result, object_type):
         Base.__init__(self, result)
         self.object_type = object_type
 
-    def getResourceName(self):
+    def get_resource_name(self):
         return self.object_type.__name__.lower() + 's'
 
     def __iter__(self):
-        for item in self['_embedded'][self.getResourceName()]:
+        for item in self['_embedded'][self.get_resource_name()]:
             yield self.object_type(item)
 
     @property
@@ -19,7 +19,7 @@ def count(self):
             return None
         return int(self['count'])
 
-    def getOffset(self):
+    def get_offset(self):
         if 'offset' not in self:
             return None
         return self['offset']

mollie/api/objects/mandate.py

@@ -6,11 +6,11 @@ class Mandate(Base):
     STATUS_VALID   = 'valid'
     STATUS_INVALID = 'invalid'
 
-    def isPending(self):
+    def is_pending(self):
         return self['status'] == self.STATUS_PENDING
 
-    def isValid(self):
+    def is_valid(self):
         return self['status'] == self.STATUS_VALID
 
-    def isInvalid(self):
+    def is_invalid(self):
         return self['status'] == self.STATUS_INVALID

mollie/api/objects/method.py

@@ -20,38 +20,40 @@ class Method(Base):
 
     @property
     def description(self):
-        return self.getProperty('description')
+        return self._get_property('description')
 
     @property
     def id(self):
-        return self.getProperty('id')
+        return self._get_property('id')
 
     @property
     def image_size1x(self):
-        images = self.getProperty('image')
+        images = self._get_property('image')
         if 'size1x' not in images:
             return None
         return images['size1x']
 
     @property
     def image_size2x(self):
-        images = self.getProperty('image')
+        images = self._get_property('image')
         if 'size2x' not in images:
             return None
         return images['size2x']
 
     @property
     def issuers(self):
-        issuers = self.getProperty('issuers')
+        issuers = self._get_property('issuers')
         if issuers:
             return [Issuer(x) for x in issuers]
 
     def getMinimumAmount(self):
+        # TODO check for obsoletion
         if not self['amount'] or 'minimum' not in self['amount']:
             return None
         return float(self['amount']['minimum'])
 
     def getMaximumAmount(self):
+        # TODO check for obsoletion
         if not self['amount'] or 'maximum' not in self['amount']:
             return None
         return float(self['amount']['maximum'])