Ally 0.8
Métodos públicos | Campos de datos
Referencia de la Clase Ally::Ally

Clase que proporciona los metodos para acceder a las funcionalidades de series.ly. Más...

Métodos públicos

def __init__
 Constructor de la clase.
def parseUsuario
 Método para convertir XML en texto legible.
def comunicacion
 Método empleado para realizar la comunicación con la web.
def user_info
 Método para consultar la información de un usuario.
def user_misSeries
 Método que devuelve las series del usuario autenticado.
def user_misPelis
 Método que devuelve las películas del usuario autenticado.
def user_estado
 Método que devuelve si el usuario sigue conectado o no.
def user_notification
 Método que devuelve las películas y series pendientes por ver.
def notis_list
 Método que devuelve las notificaciones del usuario.
def toggle_noti
def buscar
 Método para buscar un termino de un tipo concreto.
def ficha_peli
 Método que devuelve la ficha de una película concreta.
def ficha_serie
 Método que devuelve la ficha de una serie concreta.
def caps_serie
 Método que devuelve los capítulos de una serie.
def links_cap
 Método que devuelve los links de un capítulo en concreto.
def cargar_enlace
 Método que muestra el enlace directo de un capítulo.
def cambiar_estado
 Método para cambiar de estado una película o una serie.
def marcar_episodio
 Método empleado para marcar un episodio como visto.
def puntuar
 Método para puntuar un determinado recurso.
def tops
 Método que devuelve ciertos tops.
def mostrar_comentarios
 Método empleado para mostrar los comentarios.
def puntuar_comentarios
 Método empleado para puntuar comentarios.
def nuevo_comentario
 Método para publicar un nuevo comentario.

Campos de datos

 auth_token
 Variable donde se guarda el token de autenticación.
 user_token
 Variable donde se guarda el token de usuario.

Descripción detallada

Clase que proporciona los metodos para acceder a las funcionalidades de series.ly.

Autor:
Ángel Luis Perales Gómez @ RdlP <angelluispg89@hotmail.com><angelluis.perales@um.es>
Versión:
0.80

LICENCIA

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details at http://www.gnu.org/copyleft/gpl.html


Documentación del constructor y destructor

def Ally::Ally::__init__ (   self,
  usuario,
  contrasena,
  idd,
  key 
)

Constructor de la clase.

El constructor llama a la función privada autenticación para obtener el token de autenticación y posteriomente llama a la función privada login para obtener el token de usuario.

Parámetros:
usuariousuario que se va a autenticar
contrasenacontraseña del usuario a autenticar
iddID de la aplicación
keyKey de la aplicación

Documentación de las funciones miembro

def Ally::Ally::buscar (   self,
  termino,
  tipo 
)

Método para buscar un termino de un tipo concreto.

Método para buscar un termino, siguiendo un tipo concreto (film, serie, user o all).

Parámetros:
terminotermino que se quiere buscar.
tipoTipo de recurso que se quiere buscar (film, serie, user o all).
Devuelve:
Devuelve una serie de listas dependiendo del tipo elegido. Si tipo=film, devuelve una lista de objetos Pelicula con la siguiente información: idFilm, title, year, genre, poster, thumb, small_thumbs. Si tipo=serie, devuelve una lista de objetos Serie con la siguiente información: idSerie, title, seasons, episodes, poster, thumb, small_thumb. Si tipo=user devuelve una lista de objetos Usuario con la siguiente información: nick, uid, nombre, avatar. Si tipo=all, devuelve un diccionario con 3 claves "serie, peli y user" y por cada clave una lista que contiene objetos Serie, Pelicula y Usuario respectivamente con la información detallada anteriormente.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::cambiar_estado (   self,
  idd,
  typee,
  status 
)

Método para cambiar de estado una película o una serie.

Este método se usa para cambiar de estado una serie o pelicula, por ejemplo: seguir una serie, poner como vista una película, etc...

Parámetros:
iddID de la serie o película.
typeeTipo de recurso: 0(serie) o 1(pleícula).
statusEstado al que se quiere actualizar el recurso: 3(vista), 2(pendiente), 1(siguiendo), -1(quitar de ms series).
Devuelve:
Dvuelve 1 si todo ha ido bien y 0 en caso contrario.
def Ally::Ally::caps_serie (   self,
  idSerie 
)

Método que devuelve los capítulos de una serie.

Devuelve los capítulos de una serie, indicando si se han visto o no.

Parámetros:
idSerieID de la serie que se puede encontrar en la busqueda
Devuelve:
Devuelve una lista de capitulos de la serie.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::cargar_enlace (   self,
  datos,
  i 
)

Método que muestra el enlace directo de un capítulo.

Parámetros:
datosDatos obtenidos en la función links_cap.
iIndica que links se quiere cargar de todos los que hay disponibles.
Devuelve:
Devuelve un links directo para ver el capítulo.
def Ally::Ally::comunicacion (   self,
  metodo,
  parametros,
  url 
)

Método empleado para realizar la comunicación con la web.

Parámetros:
metodoTipo de solicitud que se le hace a la web
parametrosParametros que se le pasan.
urlDirección a la que hacer la petición
def Ally::Ally::ficha_peli (   self,
  idFilm 
)

Método que devuelve la ficha de una película concreta.

Parámetros:
idFilmID de la película que se puede encontrar en la busqueda.
Devuelve:
Devuelve un objeto Ficha con información sobre la película, concretamente con la siguiente información: title, idd, synopsis, seriesly_score, participants_score, poster, thumb, small_thumb, year y links.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::ficha_serie (   self,
  idSerie 
)

Método que devuelve la ficha de una serie concreta.

Parámetros:
idSerieID de la serie que se puede encontrar en la busqueda.
Devuelve:
Devuelve un objeto Ficha con ifnromación sobre la serie, concretamente la siguiente información: title, idd, synopsis, seriesly_score, participants_score, poster, thumb, small_thumb, self (una referencia a esta clase para poder usar el método getCapitulos) y idSerie.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::links_cap (   self,
  idCap 
)

Método que devuelve los links de un capítulo en concreto.

Parámetros:
idCapID del capítulo, puede ser obtenido en caps_serie.
Devuelve:
Devuelve una lista de links del capítulo.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::marcar_episodio (   self,
  idCap,
  action 
)

Método empleado para marcar un episodio como visto.

Parámetros:
idCapID del capitulo se puede conseguir en el método caps_serie.
actionAcción que quieres realizar: 1(Marcar episodio), 0(Desmarcar Episodio)
Devuelve:
Devuelve 1 si todo ha ido bien y 0 en caso contrario.
def Ally::Ally::mostrar_comentarios (   self,
  idd,
  media 
)

Método empleado para mostrar los comentarios.

Parámetros:
iddID del recurso que se quiere consultar sus comentarios.
mediaTipo de recurso (user, serie, peli).
Devuelve:
Devuelve los comentarios del recurso seleccionado en el parámetro media.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::notis_list (   self)

Método que devuelve las notificaciones del usuario.

Devuelve:
Devuelve las notificaciones del usuario.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::nuevo_comentario (   self,
  text,
  idd,
  media 
)

Método para publicar un nuevo comentario.

Parámetros:
textTexto del comentario.
iddID del recurso a comentar.
mediaIndica el tipo de recurso (serie, user, peli, subcomment).
Devuelve:
Devuelve 1 si todo ha ido bien y 0 en caso contrario
def Ally::Ally::parseUsuario (   self,
  usuario_data 
)

Método para convertir XML en texto legible.

Parámetros:
usuario_dataRecibe el texto XML en bruto
Devuelve:
Devuelve un diccionario con todos los campos de información del usuario
Obsoleto:
Esta función está obsoleta puesto que ahora la información se recibe por JSON
def Ally::Ally::puntuar (   self,
  idd,
  tipus,
  rating 
)

Método para puntuar un determinado recurso.

Parámetros:
iddID del recurso que se quiere puntuar
tipusTipo del recurso: 0(serie), 1(pelicula)
ratingPuntuación a dar (del 1 al 5)
Devuelve:
Devuelve 1 si todo ha ido bien y 0 en caso contrario.
def Ally::Ally::puntuar_comentarios (   self,
  idd,
  value 
)

Método empleado para puntuar comentarios.

Parámetros:
iddID del comentario a puntuar
value1 si se va a votar a favor y 2 en caso contrario.
Devuelve:
Devuelve 1 si todo ha ido bien.
def Ally::Ally::tops (   self,
  idd 
)

Método que devuelve ciertos tops.

Parámetros:
iddTipo del recurso que quieremos consultar su top: 1(series más votadas), 2(Pelis más vistas), 3(Ultimas pelis modificadas)
Devuelve:
Devuelve distinta información dependiendo del idd que se le pase. Si idd=1(series más votadas) entonces devolverá una lista de objetos Serie con la siguiente información: title, idSerie, votos. Si idd=2(pelis más vistas) entonces devolverá una lista de objetos Pelicula con la siguiente información: title, idFilm. Si idd=3(ultimas películas) entonces devolverá una lista de objetos Pelicula con la siguiente información: title, idFilm, any.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::user_estado (   self)

Método que devuelve si el usuario sigue conectado o no.

Devuelve:
Devuelve 1 si el usuario sigue conectado y 0 en caso contrario.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::user_info (   self,
  uid = "" 
)

Método para consultar la información de un usuario.

Método para consultar la información de un usuario, si el uid no se especifica entonces devuelve la información del usuario que hace la llamada al método.

Parámetros:
uidUID del usuario a consultar, si se deja en blanco, se consulta la información del usuario que hace la llamada al método.
Devuelve:
Devuelve un objeto Usuario, exactamente con la siguiente información: nick, uid, points, invitations, avatar, badges, friends y followers. En el caso de que se produzca un error devuelve None.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::user_misPelis (   self)

Método que devuelve las películas del usuario autenticado.

Devuelve:
Devuelve una lista de objetos Pelicula con la siguiente información: idFilm, title, year, genre, poster, thumb, small_thumb, status.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::user_misSeries (   self)

Método que devuelve las series del usuario autenticado.

Devuelve:
Devuelve una lista de objetos Serie con la siguiente información: idSerie, title, seasons, episodes, poster, thumb, small_thumb, status, self(una referencia a Ally) para poder llamar a la función getCapitulos desde los objetos Serie.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.
def Ally::Ally::user_notification (   self)

Método que devuelve las películas y series pendientes por ver.

Devuelve:
Devuelve 2 lista de objetos, una de objetos Serie y otra de objetos Pelicula, Los objeto Serie contienen la siguiente información: idSerie, title el capítulo que toca por ver, el número del capítulo que toca por ver y el estado pendiente. Los objetos Pelicula contienen la siguiente información: idFilm, title y el estado pendiente.
Excepciones:
ValueErrorSe produce una excepción ValueError si los datos no pueden ser decodificados.

Documentación de los campos

Variable donde se guarda el token de autenticación.

Variable donde se guarda el token de usuario.


La documentación para esta clase fue generada a partir del siguiente fichero:
 Todo Estructuras de Datos Funciones Variables