the_whos 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2757400666285928526c47ef20e9b0983fe057d63ccebb62f5b9910bb8359927
-  data.tar.gz: 5a0ed60aea6d27f942ba6938b4a0b7617d23b40cb41665c1a610c92dbc3e986e
+  metadata.gz: 63d8e0a82d506323c21e392b3235e3edb376643af66fddb5082db0c7ce0530ae
+  data.tar.gz: bfccf963c024532de1b0d357efb1344590d601fec6709687760e07109b198df3
 SHA512:
-  metadata.gz: 472bb15773e6e7390ce9a26f8796e56e83e219aad9a7ad4412f62a890b53bc38946b502362074de69d7195534607771b6ceb5a3dc9eba255198e3a79fa8490ac
-  data.tar.gz: abd498d00fec17ade1038ad895988930d3dd0cc5ac870047679a18e36b7dd0a6a9070ebbc2ec203d9d14f0599c652487f5a76ba51f61eecfe64fda31079d61ce
+  metadata.gz: 1785bb18ee55419c9a44174da9cfff830282c5aa6ead5fb1c682ba35d7ddf2e5f0d48022d5870e9168ecd4f2595fc7c9f7b5c5794b4d0c00ffae822a0b80aedb
+  data.tar.gz: ffea712f8144ba7d0c150cccc13d9ba0db8ab8dd8a86a885688f8f8a6ff6c83152777f9e97f7b4d067c4eae39f6eaf5a6c1076457039edc8d815376e687e6458

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"
+```

data/lib/the_whos.rb

@@ -1,5 +1,5 @@
-require_relative 'title'
-require_relative 'actor'
+require_relative 'the_whos/title'
+require_relative 'the_whos/actor'
 
 class TheWhos
   @key_imdb = ARGV[0]
@@ -40,7 +40,7 @@ class TheWhos
     return results
   end
 
-  def self.match_title(title_a, title_b)
+  def self.match_actor(title_a, title_b)
     if title_a.class == String
       title_a = Title.new(title_a)
     end
@@ -62,7 +62,7 @@ class TheWhos
     end
   end
 
-  def self.match_actor(actor_a, actor_b)
+  def self.match_title(actor_a, actor_b)
     if actor_a.class == String
       actor_a = Actor.new(actor_a)
     end

metadata

@@ -1,28 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: the_whos
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 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:
-- lib/actor.rb
+- README.md
 - lib/the_whos.rb
-- lib/title.rb
+- lib/the_whos/actor.rb
+- lib/the_whos/title.rb
 homepage: https://github.com/RamEloisa/the_whos.git
 licenses:
 - MIT