Source code for pyfarm.agent.http.api.base

# No shebang line, this module is meant to be imported
#
# Copyright 2014 Oliver Palmer
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Base
++++

Contains the base resources used for building up the root
of the agent's api.
"""

try:
    from httplib import OK
except ImportError:  # pragma: no cover
    from http.client import OK

from pyfarm.agent.config import config
from pyfarm.agent.http.core.resource import Resource
from pyfarm.agent.utility import dumps, request_from_master


class APIResource(Resource):
    """Base class for all api resources"""
    isLeaf = True

    # Content-Type header
    ALLOWED_CONTENT_TYPE = frozenset(["application/json", None])
    DEFAULT_CONTENT_TYPE = frozenset(["application/json"])

    # Accept headers
    ALLOWED_ACCEPT = frozenset(["*/*", "application/json", None])
    DEFAULT_ACCEPT = frozenset(["application/json"])


class APIRoot(APIResource):
    isLeaf = False


class Versions(APIResource):
    """
    Returns a list of api versions which this agent will support

    .. http:get:: /api/v1/versions/ HTTP/1.1

        **Request**

        .. sourcecode:: http

            GET /api/v1/versions/HTTP/1.1
            Accept: application/json

        **Response**

        .. sourcecode:: http

            HTTP/1.1 200 OK
            Content-Type: application/json

            {
                "versions": [1]
            }

    """
    isLeaf = True

    def get(self, **kwargs):
        request = kwargs.get("request")

        if request is not None and request_from_master(request):
            config.master_contacted()

        return dumps(versions=[1]), OK