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

###############################################################################
#
# FilterByItems
# Retrieves the stats for just a single item for the type you are requesting.
#
# 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 FilterByItems(Choreography):

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


    def new_input_set(self):
        return FilterByItemsInputSet()

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

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

class FilterByItemsInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the FilterByItems
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_Item(self, value):
        """
        Set the value of the Item input for this Choreo. ((required, string) Use this input to get the stats for just a single item for the type you are requesting (i.e. type=links-domains and item=google.com).)
        """
        super(FilterByItemsInputSet, self)._set_input('Item', value)
    def set_Limit(self, value):
        """
        Set the value of the Limit input for this Choreo. ((optional, integer) The maximum number of results that will be returned. Defaults to 10.)
        """
        super(FilterByItemsInputSet, self)._set_input('Limit', value)
    def set_Output(self, value):
        """
        Set the value of the Output input for this Choreo. ((optional, string) What format you want the returned data to be in. Accepted values: xml, php, json, csv. Defaults to 'xml'.)
        """
        super(FilterByItemsInputSet, self)._set_input('Output', value)
    def set_SiteID(self, value):
        """
        Set the value of the SiteID input for this Choreo. ((required, integer) Your request must include the site's ID that you want to access data from. Available from your site preferences page.)
        """
        super(FilterByItemsInputSet, self)._set_input('SiteID', value)
    def set_SiteKey(self, value):
        """
        Set the value of the SiteKey input for this Choreo. ((required, string) The unique key assigned to you when you first register with Clicky. Available from your site preferences page.)
        """
        super(FilterByItemsInputSet, self)._set_input('SiteKey', value)
    def set_Type(self, value):
        """
        Set the value of the Type input for this Choreo. ((required, string) The type of data you want to retrieve. Can be a comma-separated list of types (i.e. visitors,countries,searches).)
        """
        super(FilterByItemsInputSet, self)._set_input('Type', value)

class FilterByItemsResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the FilterByItems 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 Clicky formatted as specified in the Output parameter. Default is XML.)
        """
        return self._output.get('Response', None)

class FilterByItemsChoreographyExecution(ChoreographyExecution):

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