# -*- coding: utf-8 -*-

###############################################################################
#
# CommitChunkedUpload
# Completes an upload initiated by the ChunkedUpload Choreo.
#
# Python versions 2.6, 2.7, 3.x
#
# Copyright 2014, Temboo 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.
#
#
###############################################################################

from temboo.core.choreography import Choreography
from temboo.core.choreography import InputSet
from temboo.core.choreography import ResultSet
from temboo.core.choreography import ChoreographyExecution

import json

class CommitChunkedUpload(Choreography):

    def __init__(self, temboo_session):
        """
        Create a new instance of the CommitChunkedUpload Choreo. A TembooSession object, containing a valid
        set of Temboo credentials, must be supplied.
        """
        super(CommitChunkedUpload, self).__init__(temboo_session, '/Library/Dropbox/FilesAndMetadata/CommitChunkedUpload')


    def new_input_set(self):
        return CommitChunkedUploadInputSet()

    def _make_result_set(self, result, path):
        return CommitChunkedUploadResultSet(result, path)

    def _make_execution(self, session, exec_id, path):
        return CommitChunkedUploadChoreographyExecution(session, exec_id, path)

class CommitChunkedUploadInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the CommitChunkedUpload
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_AccessTokenSecret(self, value):
        """
        Set the value of the AccessTokenSecret input for this Choreo. ((required, string) The Access Token Secret retrieved during the OAuth process.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('AccessTokenSecret', value)
    def set_AccessToken(self, value):
        """
        Set the value of the AccessToken input for this Choreo. ((required, string) The Access Token retrieved during the OAuth process.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('AccessToken', value)
    def set_AppKey(self, value):
        """
        Set the value of the AppKey input for this Choreo. ((required, string) The App Key provided by Dropbox (AKA the OAuth Consumer Key).)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('AppKey', value)
    def set_AppSecret(self, value):
        """
        Set the value of the AppSecret input for this Choreo. ((required, string) The App Secret provided by Dropbox (AKA the OAuth Consumer Secret).)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('AppSecret', value)
    def set_Locale(self, value):
        """
        Set the value of the Locale input for this Choreo. ((optional, string) The metadata returned on successful upload will have its size field translated based on the given locale.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('Locale', value)
    def set_Overwrite(self, value):
        """
        Set the value of the Overwrite input for this Choreo. ((optional, boolean) Indicates what happens when a file already exists at the specified path. If true (the default), the existing file will be overwritten. If false, the new file will be automatically renamed.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('Overwrite', value)
    def set_ParentRevision(self, value):
        """
        Set the value of the ParentRevision input for this Choreo. ((optional, string) The revision of the file you're editing. If this value matches the latest version of the file on the user's Dropbox, that file will be replaced, otherwise a new file will be created.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('ParentRevision', value)
    def set_Path(self, value):
        """
        Set the value of the Path input for this Choreo. ((required, string) The path to the file you want to write to (i.e. /RootFolder/SubFolder/MyFile.txt).)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('Path', value)
    def set_ResponseFormat(self, value):
        """
        Set the value of the ResponseFormat input for this Choreo. ((optional, string) The format that the response should be in. Can be set to xml or json. Defaults to json.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('ResponseFormat', value)
    def set_Root(self, value):
        """
        Set the value of the Root input for this Choreo. ((optional, string) Defaults to "auto" which automatically determines the root folder using your app's permission level. Other options are "sandbox" (App Folder) and "dropbox" (Full Dropbox).)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('Root', value)
    def set_UploadID(self, value):
        """
        Set the value of the UploadID input for this Choreo. ((required, string) Used to identify the chunked upload session you'd like to commit. This is returned from the ChunkedUpload Choreo.)
        """
        super(CommitChunkedUploadInputSet, self)._set_input('UploadID', value)

class CommitChunkedUploadResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the CommitChunkedUpload Choreo.
    The ResultSet object is used to retrieve the results of a Choreo execution.
    """

    def getJSONFromString(self, str):
        return json.loads(str)

    def get_Response(self):
        """
        Retrieve the value for the "Response" output from this Choreo execution. (The response from Dropbox. Corresponds to the ResponseFormat input. Defaults to json.)
        """
        return self._output.get('Response', None)

class CommitChunkedUploadChoreographyExecution(ChoreographyExecution):

    def _make_result_set(self, response, path):
        return CommitChunkedUploadResultSet(response, path)
