the_whos 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd95eec1c0a3845af7bcf884e9022693a701a9a97688205947c847c9f84cdeba
-  data.tar.gz: 6b8ae647c2f6c993a03b349a62e33eaf137c83b7850ae40bfdf9f964b834dad6
+  metadata.gz: efef1a42a9f50968dd8683b5a29ea53fab0ec278d5f3fd9f8c68f975ce6c7e20
+  data.tar.gz: 3bdddb360d69721d455d4540770806ff9b6f2d983ae6be47f022941c0d323f5d
 SHA512:
-  metadata.gz: fbadc47b16fde1f47b6cb4a149069f553015d12e65cc6346c831d322555addfa7bfd94c12e313dc9625dd7a5579ee9acf9626a627495fb282e370b6bbfd390c9
-  data.tar.gz: 433e92edccc3f1a68e76089be90bfd7746c59a88c0a19b7610fe3a0124470bf77a19f0fbc1619a186261aed008ecae2b51e41b7d5fa4979dc17d439672ce5834
+  metadata.gz: fe314d6e22f094fdd5039cc0b06f3a69435bbc17110d0922e9f82022d49e2ce7d67da945230497ce8faf0db823de2f6dd897faf0ec7bf6823e2430b49bd02b44
+  data.tar.gz: 25305b7caf50d87d84dbec1468642234f403828e5311511253ca8b58eea63f0f3fb4880990782a39f2e132f6ae84ea1fde6ae09752e71d32d598758ea2a791a0

data/README.md

@@ -0,0 +1,133 @@
+# The Whos
+
+## Instalacion
+Instalar a través de Rubygems
+```
+gem install the_whos
+```
+Accede a la biblioteca en Ruby:
+```
+require 'the_whos'
+```
+## Api Key IMDB
+Para poder realizar llamadas se requiere ingresar la clave de la api de IMDB, para obtener una clave gratuita tiene que registrase en el sitio de la API, [IMDB API](https://imdb-api.com/Identity/Account/Register), las cuentas gratuitas tienen un límite de 100 consultas por día.
+Pará poder utilizar la clave se tiene que pasar el valor en la línea de comandos antes de ejecutar el script.
+```
+$ ruby example.rb  k_12345678
+```
+## Class Title
+Esta clase se encarga de almacenar la información de la llamada de los títulos.
+Pará instancia el objeto se puede hacer a través de `Title.new` o `TheWhos.create` pasando como parámetro el ID de el título de IMDB.
+```
+movie = Title.new('tt0088763')
+
+movie = TheWhos.create('tt0088763')
+```
+### Método id
+Devuelve el ID del título.
+```
+movie = Title.new('tt0088763')
+movie.id
+
+# => "tt0088763"
+```
+### Método title
+Devuelve el título.
+```
+movie = Title.new('tt0088763')
+movie.title
+
+# => "Back to the Future"
+```
+### Método cast
+Devuelve un array con los 10 actores principales
+```
+movie = Title.new('tt0088763')
+movie.cast
+```
+### Método fullcast
+Devuelve un array con el reparto completo del título.
+```
+movie = Title.new('tt0088763')
+movie.fullcast
+```
+### Método plot
+Devuelve la sinopsis del título, se puede pasar como valor el idioma en el que se desee la respuesta, el valor por defecto es en inglés.
+```
+movie = Title.new('tt0088763')
+movie.plot('es')
+```
+
+## Class Actor
+Esta clase se encarga de almacenar la información de la llamada de los actores.
+Pará instancia el objeto se puede hacer a través de `Actor.new` o `TheWhos.create` pasando como parámetro el ID de el actor de IMDB.
+```
+fox = Actor.new('nm0000150')
+
+fox = TheWhos.create('nm0000150')
+```
+### Método id
+Devuelve el ID del actor.
+```
+fox = Actor.new('nm0000150')
+fox.id
+
+# => "nm0000150"
+```
+### Método name
+Devuelve el nombre del actor.
+```
+fox = Actor.new('nm0000150')
+fox.name
+
+# => "Michael J. Fox"
+```
+### Método known
+Devuelve un array de las películas mas conocidas del actor.
+```
+fox = Actor.new('nm0000150')
+fox.known
+```
+
+### Método cast
+Devuelve todas las películas en las que el actor a participado.
+```
+fox = Actor.new('nm0000150')
+fox.cast
+```
+
+## Class TheWhos
+Está es la clase principal para trabajar con la información obtenida de las consultas la api de IMDB.
+### Método create
+Con este método se puede instanciar un objeto, detecta automáticamente si es una película o un actor y crea la clase correspondiente.
+```
+movie = TheWhos.create('tt0088763')
+fox = TheWhos.create('nm0000150')
+```
+### Método search_title
+Devuelve un array con el ID y título de la películas que coincidan con el parámetro.
+```
+rest = TheWhos.search_title('back to the future')
+```
+### Método search_actor
+Devuelve un array con el ID y nombre del actor que coincida con el parámetro.
+```
+rest = TheWhos.search_actor('michael fox')
+```
+### Método match_actor
+Devuelve un array con el ID y nombre de los actores que coincidan entre dos películas, si es que lo hay, se puede pasar como parámetro el ID del título de IMDB o un objeto ya instansiado de una película.
+```
+match = TheWhos.match_actor ('tt0088763','tt0101272')
+```
+### Método match_title
+Devuelve un array con el ID y nombre de las películas que coincidan entre dos actores, si es que lo hay, se puede pasar como parámetro el ID del actor de IMDB o un objeto ya instanciado de un actor.
+```
+match = TheWhos.match_title ('nm0000150', 'nm0000502')
+```
+### Método who
+Devuelve el personaje que interpreta un actor en una película, si es que actúa en esa película, se puede pasar como parámetros los ID de IMDB o los objetos ya instanciados.
+```
+charater = TheWhos.who ('tt0088763', 'nm0000150')
+
+# => "Marty McFly"
+```

metadata

@@ -1,26 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: the_whos
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Ramiro Eloisa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies: []
 description: |-
-  Trabaja con los ID de IMDB para devolver en forma de array informacion como:
-                    - los actores en una película y su sinopsis
-                    - las películas de un actor
-                    -las coincidencia entre pellicas y entre actores.
+  Trabaja con los ID de IMDB para devolver en forma de array informacion como:/n
+                    - los actores en una película y su sinopsis/n
+                    - las películas de un actor/n
+                    - las coincidencia entre películas y entre actores.
 email: ram.eloisalg@egmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: 
+files:
+- README.md
+homepage: https://github.com/RamEloisa/the_whos.git
 licenses:
 - MIT
 metadata: {}