Merge pull request #1 from puentesarrin/typos

Fixed several typos.

Author: bodbdigr

restea/adapters/base.py

@@ -42,7 +42,7 @@ def get_routes(self, path='', iden=''):
 class BaseRequestWrapper(object):
     '''
     BaseRequestWrapper wraps the `restea.request.Request` objects to abstract
-    implementation bettween different frameworks
+    implementation between different frameworks
     '''
     def __init__(self, original_request):
         '''
@@ -64,7 +64,7 @@ def headers(self):
         '''
         Returns a headers dict
 
-        :returns: dict -- headers been send to server
+        :returns: dict -- received request headers
         '''
         raise NotImplementedError
 

restea/adapters/djangowrap.py

@@ -10,7 +10,7 @@
 
 class DjangoRequestWrapper(BaseRequestWrapper):
     '''
-    Object wrapping django request object.
+    Object wrapping Django request object.
     '''
     @property
     def method(self):
@@ -26,7 +26,7 @@ def headers(self):
         '''
         Returns a headers dict
 
-        :returns: dict -- headers been send to server
+        :returns: dict -- received request headers
         '''
         return self._original_request.META
 
@@ -51,8 +51,8 @@ def data(self):
 
 class DjangoResourceRouter(BaseResourceWrapper):
     '''
-    Wraps over django views, implements django view api and creates routing in
-    the django urlrouter format
+    Wraps over Django views, implements Django view API and creates routing in
+    the Django urlrouter format
     '''
 
     def wrap_request(self, request, *args, **kwargs):

restea/adapters/flaskwrap.py

@@ -9,7 +9,7 @@
 
 class FlaskRequestWrapper(BaseRequestWrapper):
     '''
-    Object wrapping flask request context.
+    Object wrapping Flask request context.
     '''
     @property
     def data(self):
@@ -34,7 +34,7 @@ def headers(self):
         '''
         Returns a headers dict
 
-        :returns: dict -- headers been send to server
+        :returns: dict -- received request headers
         '''
         return self._original_request.headers
 
@@ -50,14 +50,14 @@ def get(self, value):
 
 class FlaskResourceWrapper(BaseResourceWrapper):
     '''
-    FlaskResourceWrapper implements flask 'view' api for the
-    `restea.Resource` object, aka routing and return values in flask format
+    FlaskResourceWrapper implements Flask 'view' API for the
+    `restea.Resource` object, aka routing and return values in Flask format
     '''
     @property
     def app(self):
         '''
-        Returns current flask application
-        :returns: :class: `app.Flask` -- current flask app
+        Returns current Flask application
+        :returns: :class: `app.Flask` -- current Flask app
         '''
         return flask.current_app
 
@@ -83,7 +83,7 @@ def wrap_request(self, *args, **kwargs):
 
     def __adapt_path(self, path):
         '''
-        Adapts the path to math flask requirements for the url routes
+        Adapts the path to path Flask requirements for the url routes
 
         :param path: string -- route path
         :returns: string -- normalized route path

restea/errors.py

@@ -1,13 +1,13 @@
 class RestError(Exception):
     '''
-    Base rest error exception class. All other rest exception are derived from
-    RestError
+    Base rest error exception class. All other rest exceptions are derived from
+    RestError.
     '''
     def __init__(self, message, code=None):
         '''
         :param message: string -- exception message
-        :param code: int -- code of the error, optional. used to be returned
-        alongside meesage
+        :param code: int -- error code, optional. used to be returned
+        alongside message
         '''
         super(RestError, self).__init__(message)
         self.code = code
@@ -29,7 +29,7 @@ class ForbiddenError(RestError):
 
 class NotFoundError(RestError):
     '''
-    HTTP 404. Not found error
+    HTTP 404. Not found
     '''
     http_code = 404
 

restea/fields.py

@@ -8,7 +8,7 @@ class FieldSet(object):
     class Error(Exception):
         pass
 
-    #: error thrown in case misconfigured field, for istance if setting
+    #: error thrown in case misconfigured field, for instance if setting
     # can't be found for a given field
     class ConfigurationError(Exception):
         pass
@@ -46,9 +46,9 @@ def validate(self, data):
         '''
         Validates payload input
         :param data: dict -- input playload data to be validated
-        :raises restea.fields.FieldSet.Error: field validation faield
+        :raises restea.fields.FieldSet.Error: field validation failed
         :raises restea.fields.FieldSet.Error: required field missing
-        :raises restea.fields.FieldSet.ConfigurationError: misformed field
+        :raises restea.fields.FieldSet.ConfigurationError: badformed field
         :returns: dict -- validated data
         '''
         field_names = self.field_names
@@ -87,7 +87,7 @@ def set_name(self, name):
 
     def _validate_field(self, field_value):
         '''
-        Validates a field value. Shold be overriden in a child class
+        Validates a field value. Should be overriden in a child class
         :param field_name: string -- name of the field to be validated
         '''
         raise NotImplementedError
@@ -138,7 +138,9 @@ def _validate_field(self, field_value):
         try:
             return int(field_value)
         except (ValueError, TypeError):
-            raise FieldSet.Error('Field "{}" not a number'.format(self._name))
+            raise FieldSet.Error(
+                'Field "{}" is not a number'.format(self._name)
+            )
 
 
 class String(Field):
@@ -164,5 +166,7 @@ def _validate_field(self, field_value):
         :returns: string -- validated value
         '''
         if not isinstance(field_value, basestring):
-            raise FieldSet.Error('Field "{}" not a string'.format(self._name))
+            raise FieldSet.Error(
+                'Field "{}" is not a string'.format(self._name)
+            )
         return field_value

restea/formats.py

@@ -6,13 +6,13 @@
 
 class LoadError(Exception):
     '''
-    Error raiseed in case serializing or unserializing went wrong
+    Error raised in case serializing or unserializing went wrong
     '''
 
 
 class FormatterRegistry(type):
     '''
-    Registry metaclass. Registers all `restea.formats.BaseFormat` sublcasses
+    Registry metaclass. Registers all `restea.formats.BaseFormat` subclasses
     in _formatter_registry
     '''
     def __init__(cls, name, bases, dict):
@@ -30,10 +30,10 @@ class BaseFormatter(object):
     @classmethod
     def unserialize(cls, data):
         '''
-        Unserializes imcomming data (payload)
+        Unserializes incoming data (payload)
 
         :param data: string - raw data to be unserialized
-        :returns: dict -- respesenation of the data in python datastructure
+        :returns: dict -- respresentation of the data in Python data structure
         '''
         raise NotImplementedError
 
@@ -42,8 +42,8 @@ def serialize(cls, data):
         '''
         Serializes outgoing data
 
-        :param data: dict - python data structure to be serialized
-        :returns: string -- serialized respesenation of the data
+        :param data: dict - Python data structure to be serialized
+        :returns: string -- serialized representation of the data
         '''
         raise NotImplementedError
 
@@ -56,10 +56,10 @@ class JsonFormat(BaseFormatter):
     @classmethod
     def unserialize(cls, data):
         '''
-        Unserializes imcomming data (payload)
+        Unserializes incomming data (payload)
 
         :param data: string - raw data to be unserialized
-        :returns: dict -- respesenation of the data in python datastructure
+        :returns: dict -- representation of the data in Python data structure
         '''
         try:
             return json.loads(data)
@@ -71,8 +71,8 @@ def serialize(cls, data):
         '''
         Serializes outgoing data
 
-        :param data: dict - python data structure to be serialized
-        :returns: string -- serialized respesenation of the data
+        :param data: dict - Python data structure to be serialized
+        :returns: string -- serialized representation of the data
         '''
         try:
             return json.dumps(data)
@@ -82,7 +82,7 @@ def serialize(cls, data):
 
 def get_formatter(format_name):
     '''
-    Factory method returning format class based on it's name
+    Factory method returning format class based on its name
     :param format_name: string -- name of the format
     :returns: either subclass :class: `restea.formats.BaseFormatter` or None
     '''

restea/resource.py

@@ -8,7 +8,7 @@
 
 class Resource(object):
     '''
-    Resoruce class implements all the logic of mapping HTTP methods to
+    Resource class implements all the logic of mapping HTTP methods to
     methods and error handling
     '''
 
@@ -26,7 +26,7 @@ def __init__(self, request, formatter):
         sublcass -- request wrapper object
 
         :param formatter: :class: `restea.formats.BaseFormatter` subclass --
-        formatter class implmementing serialization and unserialization of
+        formatter class implementing serialization and unserialization of
         the data
         '''
         if not hasattr(self, 'fields'):
@@ -40,15 +40,15 @@ def _iden_required(self, method_name):
         Checks if given method requires iden
 
         :param method_name: string -- name of method on a resrouce
-        :returns: bool - boolean value of whatever iden needed or not
+        :returns: bool - boolean value of whatever iden is needed or not
         '''
         return method_name not in ('list', 'create')
 
     def _apply_decorators(self, method):
         '''
         Returns method decorated with decorators specified in self.decorators
         :param method: -- resource method
-        :returns: method derocated
+        :returns: decorated method
         '''
         if not hasattr(self, 'decorators'):
             return method
@@ -65,7 +65,7 @@ def _get_method_name(self, has_iden):
         :param has_iden: specifies if requested url has iden (i.e /res/ vs
         /res/1)
         :raises errors.MethodNotAllowedError: if HTTP method is not supprted
-        :returns: string - name of the resorce method name
+        :returns: string - name of the resource method name
         '''
         method = self.request.method
         method = self.request.headers.get(
@@ -97,7 +97,7 @@ def _get_method_name(self, has_iden):
     @property
     def _is_valid_formatter(self):
         '''
-        Returns is self.fomatter refers to a valid formatter class object
+        Returns is self.formatter refers to a valid formatter class object
         :returns: bool
         '''
         return (
@@ -125,7 +125,7 @@ def _get_method(self, method_name):
         :param method_name: string -- name of the method
         :raises errors.BadRequestError: method is not implemented for a given
         resource
-        :returns: -- method of the rest resource object
+        :returns: -- method of the REST resource object
         '''
         method_exists = hasattr(self, method_name)
         if not method_exists:
@@ -140,7 +140,7 @@ def _get_payload(self):
         Returns a validated and parsed payload data for request
 
         :raises restea.errors.BadRequestError: unparseable data
-        :raises restea.errors.BadRequestError: payload is not mapable
+        :raises restea.errors.BadRequestError: payload is not mappable
         :raises restea.errors.BadRequestError: validation of fields not passed
         :returns: dict - validated data passed to resource
         '''
@@ -173,7 +173,7 @@ def process(self, *args, **kwargs):
 
         :raises restea.errors.BadRequestError: wrong self.formatter type
         :raises restea.errors.ServerError: Some unhandled exception in
-        resrouce method implementation or formatter serialization error
+        resource method implementation or formatter serialization error
 
         :returns: string -- serialized data to be returned to client
         '''
@@ -198,14 +198,15 @@ def process(self, *args, **kwargs):
         try:
             return self.formatter.serialize(res)
         except formats.LoadError:
-            raise errors.ServerError('Service can\'t respond in this format')
+            raise errors.ServerError('Service can\'t respond with this format')
 
     def dispatch(self, *args, **kwargs):
         '''
         Dispatches the request and handles exception to return data, status
         and content type
 
-        :retruns: tuple -- 3 element tuple: result, http code and content type
+        :returns: tuple -- 3 element tuple: result, HTTP status code and
+        content type
         '''
         try:
             return (