Partial: Remove encodings and future imports.

Author: Poogles

flask_restplus/__about__.py

@@ -0,0 +1,2 @@
+__version__ = '0.13.1.dev'
+__description__ = 'Fully featured framework for fast, easy and documented API development with Flask'

flask_restplus/_http.py

@@ -0,0 +1,140 @@
+"""
+This file is backported from Python 3.5 http built-in module.
+"""
+
+from enum import IntEnum
+
+
+class HTTPStatus(IntEnum):
+    """HTTP status codes and reason phrases
+
+    Status codes from the following RFCs are all observed:
+
+        * RFC 7231: Hypertext Transfer Protocol (HTTP/1.1), obsoletes 2616
+        * RFC 6585: Additional HTTP Status Codes
+        * RFC 3229: Delta encoding in HTTP
+        * RFC 4918: HTTP Extensions for WebDAV, obsoletes 2518
+        * RFC 5842: Binding Extensions to WebDAV
+        * RFC 7238: Permanent Redirect
+        * RFC 2295: Transparent Content Negotiation in HTTP
+        * RFC 2774: An HTTP Extension Framework
+    """
+    def __new__(cls, value, phrase, description=''):
+        obj = int.__new__(cls, value)
+        obj._value_ = value
+
+        obj.phrase = phrase
+        obj.description = description
+        return obj
+
+    def __str__(self):
+        return str(self.value)
+
+    # informational
+    CONTINUE = 100, 'Continue', 'Request received, please continue'
+    SWITCHING_PROTOCOLS = (101, 'Switching Protocols',
+            'Switching to new protocol; obey Upgrade header')
+    PROCESSING = 102, 'Processing'
+
+    # success
+    OK = 200, 'OK', 'Request fulfilled, document follows'
+    CREATED = 201, 'Created', 'Document created, URL follows'
+    ACCEPTED = (202, 'Accepted',
+        'Request accepted, processing continues off-line')
+    NON_AUTHORITATIVE_INFORMATION = (203,
+        'Non-Authoritative Information', 'Request fulfilled from cache')
+    NO_CONTENT = 204, 'No Content', 'Request fulfilled, nothing follows'
+    RESET_CONTENT = 205, 'Reset Content', 'Clear input form for further input'
+    PARTIAL_CONTENT = 206, 'Partial Content', 'Partial content follows'
+    MULTI_STATUS = 207, 'Multi-Status'
+    ALREADY_REPORTED = 208, 'Already Reported'
+    IM_USED = 226, 'IM Used'
+
+    # redirection
+    MULTIPLE_CHOICES = (300, 'Multiple Choices',
+        'Object has several resources -- see URI list')
+    MOVED_PERMANENTLY = (301, 'Moved Permanently',
+        'Object moved permanently -- see URI list')
+    FOUND = 302, 'Found', 'Object moved temporarily -- see URI list'
+    SEE_OTHER = 303, 'See Other', 'Object moved -- see Method and URL list'
+    NOT_MODIFIED = (304, 'Not Modified',
+        'Document has not changed since given time')
+    USE_PROXY = (305, 'Use Proxy',
+        'You must use proxy specified in Location to access this resource')
+    TEMPORARY_REDIRECT = (307, 'Temporary Redirect',
+        'Object moved temporarily -- see URI list')
+    PERMANENT_REDIRECT = (308, 'Permanent Redirect',
+        'Object moved temporarily -- see URI list')
+
+    # client error
+    BAD_REQUEST = (400, 'Bad Request',
+        'Bad request syntax or unsupported method')
+    UNAUTHORIZED = (401, 'Unauthorized',
+        'No permission -- see authorization schemes')
+    PAYMENT_REQUIRED = (402, 'Payment Required',
+        'No payment -- see charging schemes')
+    FORBIDDEN = (403, 'Forbidden',
+        'Request forbidden -- authorization will not help')
+    NOT_FOUND = (404, 'Not Found',
+        'Nothing matches the given URI')
+    METHOD_NOT_ALLOWED = (405, 'Method Not Allowed',
+        'Specified method is invalid for this resource')
+    NOT_ACCEPTABLE = (406, 'Not Acceptable',
+        'URI not available in preferred format')
+    PROXY_AUTHENTICATION_REQUIRED = (407,
+        'Proxy Authentication Required',
+        'You must authenticate with this proxy before proceeding')
+    REQUEST_TIMEOUT = (408, 'Request Timeout',
+        'Request timed out; try again later')
+    CONFLICT = 409, 'Conflict', 'Request conflict'
+    GONE = (410, 'Gone',
+        'URI no longer exists and has been permanently removed')
+    LENGTH_REQUIRED = (411, 'Length Required',
+        'Client must specify Content-Length')
+    PRECONDITION_FAILED = (412, 'Precondition Failed',
+        'Precondition in headers is false')
+    REQUEST_ENTITY_TOO_LARGE = (413, 'Request Entity Too Large',
+        'Entity is too large')
+    REQUEST_URI_TOO_LONG = (414, 'Request-URI Too Long',
+        'URI is too long')
+    UNSUPPORTED_MEDIA_TYPE = (415, 'Unsupported Media Type',
+        'Entity body in unsupported format')
+    REQUESTED_RANGE_NOT_SATISFIABLE = (416,
+        'Requested Range Not Satisfiable',
+        'Cannot satisfy request range')
+    EXPECTATION_FAILED = (417, 'Expectation Failed',
+        'Expect condition could not be satisfied')
+    UNPROCESSABLE_ENTITY = 422, 'Unprocessable Entity'
+    LOCKED = 423, 'Locked'
+    FAILED_DEPENDENCY = 424, 'Failed Dependency'
+    UPGRADE_REQUIRED = 426, 'Upgrade Required'
+    PRECONDITION_REQUIRED = (428, 'Precondition Required',
+        'The origin server requires the request to be conditional')
+    TOO_MANY_REQUESTS = (429, 'Too Many Requests',
+        'The user has sent too many requests in '
+        'a given amount of time ("rate limiting")')
+    REQUEST_HEADER_FIELDS_TOO_LARGE = (431,
+        'Request Header Fields Too Large',
+        'The server is unwilling to process the request because its header '
+        'fields are too large')
+
+    # server errors
+    INTERNAL_SERVER_ERROR = (500, 'Internal Server Error',
+        'Server got itself in trouble')
+    NOT_IMPLEMENTED = (501, 'Not Implemented',
+        'Server does not support this operation')
+    BAD_GATEWAY = (502, 'Bad Gateway',
+        'Invalid responses from another server/proxy')
+    SERVICE_UNAVAILABLE = (503, 'Service Unavailable',
+        'The server cannot process the request due to a high load')
+    GATEWAY_TIMEOUT = (504, 'Gateway Timeout',
+        'The gateway server did not receive a timely response')
+    HTTP_VERSION_NOT_SUPPORTED = (505, 'HTTP Version Not Supported',
+        'Cannot fulfill request')
+    VARIANT_ALSO_NEGOTIATES = 506, 'Variant Also Negotiates'
+    INSUFFICIENT_STORAGE = 507, 'Insufficient Storage'
+    LOOP_DETECTED = 508, 'Loop Detected'
+    NOT_EXTENDED = 510, 'Not Extended'
+    NETWORK_AUTHENTICATION_REQUIRED = (511,
+        'Network Authentication Required',
+        'The client needs to authenticate to gain network access')

flask_restplus/postman.py

@@ -0,0 +1,189 @@
+from time import time
+from uuid import uuid5, NAMESPACE_URL
+
+from six import iteritems
+from six.moves.urllib.parse import urlencode
+
+
+def clean(data):
+    '''Remove all keys where value is None'''
+    return dict((k, v) for k, v in iteritems(data) if v is not None)
+
+
+DEFAULT_VARS = {
+    'string': '',
+    'integer': 0,
+    'number': 0,
+}
+
+
+class Request(object):
+    '''Wraps a Swagger operation into a Postman Request'''
+    def __init__(self, collection, path, params, method, operation):
+        self.collection = collection
+        self.path = path
+        self.params = params
+        self.method = method.upper()
+        self.operation = operation
+
+    @property
+    def id(self):
+        seed = str(' '.join((self.method, self.url)))
+        return str(uuid5(self.collection.uuid, seed))
+
+    @property
+    def url(self):
+        return self.collection.api.base_url.rstrip('/') + self.path
+
+    @property
+    def headers(self):
+        headers = {}
+        # Handle content-type
+        if self.method != 'GET':
+            consumes = self.collection.api.__schema__.get('consumes', [])
+            consumes = self.operation.get('consumes', consumes)
+            if len(consumes):
+                headers['Content-Type'] = consumes[-1]
+
+        # Add all parameters headers
+        for param in self.operation.get('parameters', []):
+            if param['in'] == 'header':
+                headers[param['name']] = param.get('default', '')
+
+        # Add security headers if needed (global then local)
+        for security in self.collection.api.__schema__.get('security', []):
+            for key, header in iteritems(self.collection.apikeys):
+                if key in security:
+                    headers[header] = ''
+        for security in self.operation.get('security', []):
+            for key, header in iteritems(self.collection.apikeys):
+                if key in security:
+                    headers[header] = ''
+
+        lines = [':'.join(line) for line in iteritems(headers)]
+        return '\n'.join(lines)
+
+    @property
+    def folder(self):
+        if 'tags' not in self.operation or len(self.operation['tags']) == 0:
+            return
+        tag = self.operation['tags'][0]
+        for folder in self.collection.folders:
+            if folder.tag == tag:
+                return folder.id
+
+    def as_dict(self, urlvars=False):
+        url, variables = self.process_url(urlvars)
+        return clean({
+            'id': self.id,
+            'method': self.method,
+            'name': self.operation['operationId'],
+            'description': self.operation.get('summary'),
+            'url': url,
+            'headers': self.headers,
+            'collectionId': self.collection.id,
+            'folder': self.folder,
+            'pathVariables': variables,
+            'time': int(time()),
+        })
+
+    def process_url(self, urlvars=False):
+        url = self.url
+        path_vars = {}
+        url_vars = {}
+        params = dict((p['name'], p) for p in self.params)
+        params.update(dict((p['name'], p) for p in self.operation.get('parameters', [])))
+        if not params:
+            return url, None
+        for name, param in iteritems(params):
+            if param['in'] == 'path':
+                url = url.replace('{%s}' % name, ':%s' % name)
+                path_vars[name] = DEFAULT_VARS.get(param['type'], '')
+            elif param['in'] == 'query' and urlvars:
+                default = DEFAULT_VARS.get(param['type'], '')
+                url_vars[name] = param.get('default', default)
+        if url_vars:
+            url = '?'.join((url, urlencode(url_vars)))
+        return url, path_vars
+
+
+class Folder(object):
+    def __init__(self, collection, tag):
+        self.collection = collection
+        self.tag = tag['name']
+        self.description = tag['description']
+
+    @property
+    def id(self):
+        return str(uuid5(self.collection.uuid, str(self.tag)))
+
+    @property
+    def order(self):
+        return [
+            r.id for r in self.collection.requests
+            if r.folder == self.id
+        ]
+
+    def as_dict(self):
+        return clean({
+            'id': self.id,
+            'name': self.tag,
+            'description': self.description,
+            'order': self.order,
+            'collectionId': self.collection.id
+        })
+
+
+class PostmanCollectionV1(object):
+    '''Postman Collection (V1 format) serializer'''
+    def __init__(self, api, swagger=False):
+        self.api = api
+        self.swagger = swagger
+
+    @property
+    def uuid(self):
+        return uuid5(NAMESPACE_URL, self.api.base_url)
+
+    @property
+    def id(self):
+        return str(self.uuid)
+
+    @property
+    def requests(self):
+        if self.swagger:
+            # First request is Swagger specifications
+            yield Request(self, '/swagger.json', {}, 'get', {
+                'operationId': 'Swagger specifications',
+                'summary': 'The API Swagger specifications as JSON',
+            })
+        # Then iter over API paths and methods
+        for path, operations in iteritems(self.api.__schema__['paths']):
+            path_params = operations.get('parameters', [])
+
+            for method, operation in iteritems(operations):
+                if method != 'parameters':
+                    yield Request(self, path, path_params, method, operation)
+
+    @property
+    def folders(self):
+        for tag in self.api.__schema__['tags']:
+            yield Folder(self, tag)
+
+    @property
+    def apikeys(self):
+        return dict(
+            (name, secdef['name'])
+            for name, secdef in iteritems(self.api.__schema__.get('securityDefinitions'))
+            if secdef.get('in') == 'header' and secdef.get('type') == 'apiKey'
+        )
+
+    def as_dict(self, urlvars=False):
+        return clean({
+            'id': self.id,
+            'name': ' '.join((self.api.title, self.api.version)),
+            'description': self.api.description,
+            'order': [r.id for r in self.requests if not r.folder],
+            'requests': [r.as_dict(urlvars=urlvars) for r in self.requests],
+            'folders': [f.as_dict() for f in self.folders],
+            'timestamp': int(time()),
+        })