addons wrapped.

Author: Kenneth Reitz

heroku/api.py

@@ -8,7 +8,8 @@
 """
 
 import requests
-
+from .compat import json
+from .models import *
 
 HEROKU_URL = 'https://api.heroku.com'
 
@@ -54,8 +55,41 @@ def _verify_api_key(self):
         return self._api_key_verified
 
     def _url_for(self, *args):
+        args = map(str, args)
         return '/'.join([self._heroku_url] + list(args))
 
+    @staticmethod
+    def _resource_serialize(o):
+        """Returns JSON serialization of given object."""
+        return json.dumps(o)
+
+    @staticmethod
+    def _resource_deserialize(s):
+        """Returns dict deserialization of a given JSON string."""
+
+        try:
+            return json.loads(s)
+        except ValueError:
+            raise ResponseError('The API Response was not valid.')
+
+
+    def _get_resource(self, resource, obj, **kwargs):
+
+        r = self._http_resource('GET', resource, params=kwargs)
+        item = self._resource_deserialize(r.content)
+
+        return obj.new_from_dict(item, gh=self)
+
+
+    def _get_resources(self, resource, obj, **kwargs):
+
+        url = self._url_for(resource)
+        r = self._s.get(url, params=kwargs)
+
+        d_items = self._resource_deserialize(r.content)
+
+        return [obj.new_from_dict(item, h=self) for item in d_items]
+
 
 class Heroku(HerokuCore):
     """The main Heroku class."""
@@ -66,6 +100,10 @@ def __init__(self):
     def __repr__(self):
         return '<heroku-client at 0x%x>' % (id(self))
 
+    def addons(self):
+        # r = self._s.get(self._url_for('addons'))
+        return self._get_resources(('addons'), Addon)
+
     def apps(self):
         print self._url_for('apps')
 

heroku/compat.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+"""
+heroku.compat
+~~~~~~~~~~~~~
+
+Compatiblity for heroku.py.
+"""
+
+try:
+    import json
+except ImportError:
+    import simplejson as json

heroku/helpers.py

@@ -0,0 +1,118 @@
+# -*- coding: utf-8 -*-
+
+"""
+heroku.helpers
+~~~~~~~~~~~~~~
+
+This module contians the helpers.
+"""
+
+from datetime import datetime
+
+from dateutil.parser import parse as parse_datetime
+
+def is_collection(obj):
+    """Tests if an object is a collection."""
+
+    col = getattr(obj, '__getitem__', False)
+    val = False if (not col) else True
+
+    if isinstance(obj, basestring):
+        val = False
+
+    return val
+
+
+
+# from kennethreitz/python-github3
+def to_python(obj,
+    in_dict,
+    str_keys=None,
+    date_keys=None,
+    int_keys=None,
+    object_map=None,
+    bool_keys=None, **kwargs):
+    """Extends a given object for API Consumption.
+
+    :param obj: Object to extend.
+    :param in_dict: Dict to extract data from.
+    :param string_keys: List of in_dict keys that will be extracted as strings.
+    :param date_keys: List of in_dict keys that will be extrad as datetimes.
+    :param object_map: Dict of {key, obj} map, for nested object results.
+    """
+
+    d = dict()
+
+    if str_keys:
+        for in_key in str_keys:
+            d[in_key] = in_dict.get(in_key)
+
+    if date_keys:
+        for in_key in date_keys:
+            in_date = in_dict.get(in_key)
+            try:
+                out_date = datetime.strptime(in_date, '%Y-%m-%dT%H:%M:%SZ')
+            except TypeError:
+                out_date = None
+
+            d[in_key] = out_date
+
+    if int_keys:
+        for in_key in int_keys:
+            if (in_dict is not None) and (in_dict.get(in_key) is not None):
+                d[in_key] = int(in_dict.get(in_key))
+
+    if bool_keys:
+        for in_key in bool_keys:
+            if in_dict.get(in_key) is not None:
+                d[in_key] = bool(in_dict.get(in_key))
+
+    if object_map:
+        for (k, v) in object_map.items():
+            if in_dict.get(k):
+                d[k] = v.new_from_dict(in_dict.get(k))
+
+    obj.__dict__.update(d)
+    obj.__dict__.update(kwargs)
+
+    # Save the dictionary, for write comparisons.
+    # obj._cache = d
+    # obj.__cache = in_dict
+
+    return obj
+
+
+# from kennethreitz/python-github3
+def to_api(in_dict, int_keys=None, date_keys=None, bool_keys=None):
+    """Extends a given object for API Production."""
+
+    # Cast all int_keys to int()
+    if int_keys:
+        for in_key in int_keys:
+            if (in_key in in_dict) and (in_dict.get(in_key, None) is not None):
+                in_dict[in_key] = int(in_dict[in_key])
+
+    # Cast all date_keys to datetime.isoformat
+    if date_keys:
+        for in_key in date_keys:
+            if (in_key in in_dict) and (in_dict.get(in_key, None) is not None):
+
+                _from = in_dict[in_key]
+
+                if isinstance(_from, basestring):
+                    dtime = parse_datetime(_from)
+
+                elif isinstance(_from, datetime):
+                    dtime = _from
+
+                in_dict[in_key] = dtime.isoformat()
+
+            elif (in_key in in_dict) and in_dict.get(in_key, None) is None:
+                del in_dict[in_key]
+
+    # Remove all Nones
+    for k, v in in_dict.items():
+        if v is None:
+            del in_dict[k]
+
+    return in_dict

heroku/models.py

@@ -7,14 +7,60 @@
 This module contains the models that comprise the Heroku API.
 """
 
+from .helpers import to_python, to_api
+
 class BaseResource(object):
+
+    _strs = []
+    _ints = []
+    _dates = []
+    _bools = []
+    _map = {}
+    # _writeable = []
+    # _cache = {}
+
     def __init__(self):
+        self._bootstrap()
         super(BaseResource, self).__init__()
 
+    def _bootstrap(self):
+        """Bootstraps the model object based on configured values."""
+
+        for attr in self._keys():
+            setattr(self, attr, None)
+
+    def _keys(self):
+        return self._strs + self._ints + self._dates + self._bools + self._map.keys()
+
+    def dict(self):
+        d = dict()
+        for k in self.keys():
+            d[k] = self.__dict__.get(k)
+
+        return d
+
+
+    @classmethod
+    def new_from_dict(cls, d, h=None):
+
+        return to_python(
+            obj=cls(), in_dict=d,
+            str_keys = cls._strs,
+            int_keys = cls._ints,
+            date_keys = cls._dates,
+            bool_keys = cls._bools,
+            object_map = cls._map,
+            _h = h
+        )
+
 
 class Addon(BaseResource):
-    def __init__(self):
-        super(App, self).__init__()
+
+    _strs = ['name', 'description', 'url', 'state']
+    _bools = ['beta',]
+
+    def __repr__(self):
+        return "<addon '%s'>" % (self.name)
 
 
 class App(BaseResource):