Source code for pontoon.lib.Action

# -*- coding: utf-8 -*-
from time import sleep

from .baseapi import BaseAPI


class Action(BaseAPI):
    def __init__(self, *args, **kwargs):
        self.id = None
        self.token = None
        self.status = None
        self.type = None
        self.started_at = None
        self.completed_at = None
        self.resource_id = None
        self.resource_type = None
        self.region = None
        self.region_slug = None
        # Custom, not provided by the json object.
        self.droplet_id = None

        super(Action, self).__init__(*args, **kwargs)

    @classmethod
    def get_object(cls, api_token, action_id, mocked):
        """
            Class method that will return a Action object by ID.
        """
        action = cls(token=api_token, id=action_id, mocked=mocked)
        action.mock_data = "actions/ipv6_completed.json"
        action.load_directly()
        return action

    def load_directly(self):
        self.mock_data = "actions/ipv6_completed.json"
        action = self.get_data("actions/%s" % self.id)
        if action:
            action = action[u'action']
            # Loading attributes
            for attr in action.keys():
                setattr(self, attr, action[attr])

    def load(self):
        self.mock_data = "actions/ipv6_completed.json"
        action = self.get_data(
            "droplets/%s/actions/%s" % (
                self.droplet_id,
                self.id
            )
        )
        if action:
            action = action[u'action']
            # Loading attributes
            for attr in action.keys():
                setattr(self, attr, action[attr])

    def wait(self, update_every_seconds=1):
        """
            Wait until the action is marked as completed or with an error.
            It will return True in case of success, otherwise False.

            Optional Args:
                update_every_seconds - int : number of seconds to wait before
                    checking if the action is completed.
        """
        while self.status == u'in-progress':
            sleep(update_every_seconds)
            self.load()

        return self.status == u'completed'

    def __str__(self):
        return "%s %s [%s]" % (self.id, self.type, self.status)