appengine/standard/endpoints/backend/main.py

# Copyright 2016 Google Inc.
#
# 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.

"""This is a sample Hello World API implemented using Google Cloud
Endpoints."""

# [START endpoints_imports]
import endpoints
from protorpc import message_types
from protorpc import messages
from protorpc import remote

# [END endpoints_imports]


# [START endpoints_messages]
class Greeting(messages.Message):
    """Greeting that stores a message."""

    message = messages.StringField(1)


class GreetingCollection(messages.Message):
    """Collection of Greetings."""

    items = messages.MessageField(Greeting, 1, repeated=True)


STORED_GREETINGS = GreetingCollection(
    items=[
        Greeting(message="hello world!"),
        Greeting(message="goodbye world!"),
    ]
)
# [END endpoints_messages]


# [START endpoints_greeting_api]
@endpoints.api(name="greeting", version="v1")
class GreetingApi(remote.Service):
    @endpoints.method(
        # This method does not take a request message.
        message_types.VoidMessage,
        # This method returns a GreetingCollection message.
        GreetingCollection,
        path="greetings",
        http_method="GET",
        name="greetings.list",
    )
    def list_greetings(self, unused_request):
        return STORED_GREETINGS

    # ResourceContainers are used to encapsuate a request body and url
    # parameters. This one is used to represent the Greeting ID for the
    # greeting_get method.
    GET_RESOURCE = endpoints.ResourceContainer(
        # The request body should be empty.
        message_types.VoidMessage,
        # Accept one url parameter: an integer named 'id'
        id=messages.IntegerField(1, variant=messages.Variant.INT32),
    )

    @endpoints.method(
        # Use the ResourceContainer defined above to accept an empty body
        # but an ID in the query string.
        GET_RESOURCE,
        # This method returns a Greeting message.
        Greeting,
        # The path defines the source of the URL parameter 'id'. If not
        # specified here, it would need to be in the query string.
        path="greetings/{id}",
        http_method="GET",
        name="greetings.get",
    )
    def get_greeting(self, request):
        try:
            # request.id is used to access the URL parameter.
            return STORED_GREETINGS.items[request.id]
        except (IndexError, TypeError):
            raise endpoints.NotFoundException(
                "Greeting {} not found".format(request.id)
            )

    # [END endpoints_greeting_api]

    # [START endpoints_multiply]
    # This ResourceContainer is similar to the one used for get_greeting, but
    # this one also contains a request body in the form of a Greeting message.
    MULTIPLY_RESOURCE = endpoints.ResourceContainer(
        Greeting,
        times=messages.IntegerField(2, variant=messages.Variant.INT32, required=True),
    )

    @endpoints.method(
        # This method accepts a request body containing a Greeting message
        # and a URL parameter specifying how many times to multiply the
        # message.
        MULTIPLY_RESOURCE,
        # This method returns a Greeting message.
        Greeting,
        path="greetings/multiply/{times}",
        http_method="POST",
        name="greetings.multiply",
    )
    def multiply_greeting(self, request):
        return Greeting(message=request.message * request.times)

    # [END endpoints_multiply]


# [START endpoints_auth_config]
WEB_CLIENT_ID = "replace this with your web client application ID"
ANDROID_CLIENT_ID = "replace this with your Android client ID"
IOS_CLIENT_ID = "replace this with your iOS client ID"
ANDROID_AUDIENCE = WEB_CLIENT_ID
ALLOWED_CLIENT_IDS = [
    WEB_CLIENT_ID,
    ANDROID_CLIENT_ID,
    IOS_CLIENT_ID,
    endpoints.API_EXPLORER_CLIENT_ID,
]
# [END endpoints_auth_config]


# [START endpoints_authed_greeting_api]
@endpoints.api(
    name="authed_greeting",
    version="v1",
    # Only allowed configured Client IDs to access this API.
    allowed_client_ids=ALLOWED_CLIENT_IDS,
    # Only allow auth tokens with the given audience to access this API.
    audiences=[ANDROID_AUDIENCE],
    # Require auth tokens to have the following scopes to access this API.
    scopes=[endpoints.EMAIL_SCOPE],
)
class AuthedGreetingApi(remote.Service):
    @endpoints.method(
        message_types.VoidMessage,
        Greeting,
        path="greet",
        http_method="POST",
        name="greet",
    )
    def greet(self, request):
        user = endpoints.get_current_user()
        user_name = user.email() if user else "Anonymous"
        return Greeting(message="Hello, {}".format(user_name))


# [END endpoints_authed_greeting_api]


# [START endpoints_api_server]
api = endpoints.api_server([GreetingApi, AuthedGreetingApi])
# [END endpoints_api_server]