add simple example

better handling for model strings

Author: dakra

README.rst

@@ -1,7 +1,25 @@
 atomx api README
 ================
 
-This module let's you easlily
+Simple interface for the atomx rest api.
+
+Example Usage:
+--------------
+
+.. code-block:: python
+
+    from atomx import Atomx
+
+    api = Atomx('daniel@atomx.com', 'password')
+    creatives = api.get('Creatives', limit=10)
+
+    for creative in creatives:
+        print('Creative ID: {c.id}, state: {c.state},'
+              'name: {c.name}, title: {c.title}'.format(c=creative))
+
+    creative = creatives[0]
+    creative.title = 'shiny new title'
+    creative.save()
 
 
 Installation

atomx/__init__.py

@@ -3,6 +3,7 @@
 import requests
 from .version import API_VERSION, VERSION
 from . import models
+from .utils import get_model_name
 from .exceptions import (
     APIError,
     ModelNotFoundError,
@@ -48,7 +49,8 @@ def search(self, query):
         return r.json()['search']
 
     def get(self, model, **kwargs):
-        if model not in dir(models):
+        model = get_model_name(model)
+        if not model:
             raise ModelNotFoundError()
         r = self.session.get(self.api_endpoint + model, params=kwargs)
         if not r.ok:

atomx/utils.py

@@ -0,0 +1,36 @@
+from . import models
+
+def get_model_name(name):
+    """Checks that :param:`name` is a valid model.
+    Converts plural `name` to capitalized singular form and '-' or '_' separation to camelCase.
+    Returns the name of the model if found, False otherwise.
+    E.g.
+
+    >>> check_model_name("countries")
+    "Country"
+    >>> check_model_name("ADVERTISERS")
+    "Advertiser"
+    >>> check_model_name("conversion-pixels")
+    "ConversionPixel"
+    >>> check_model_name("operating_system")
+    "OperatingSystem"
+    >>> check_model_name("InvalidModel")
+    False
+
+    :param str name: model name to convert
+    :return: name of the model or False
+    """
+    if '-' in name:
+        model_name = ''.join(m.capitalize() for m in name.split('-'))
+    elif '_' in name:
+        model_name = ''.join(m.capitalize() for m in name.split('_'))
+    else:
+        model_name = name.capitalize()
+
+    if model_name.endswith('ies'):  # change e.g. Countries to Countr*y*
+        model_name = model_name[:-3]+'y'
+    else:
+        model_name = model_name.rstrip('s')
+    if model_name in dir(models):
+        return model_name
+    return False