the_whos 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfd529a33d973fde62db77abf0268dd2168fb99e86e00364b56869d5e86821a9
-  data.tar.gz: 45a925750f8a4913309891ae0489a71f2c7cdd416a32c2f59cbba607315ef2e7
+  metadata.gz: 5fa5b573c4c22634ced5ecc74dda59a437367afab33fc235f2466ae629361bec
+  data.tar.gz: adad628b0f3cac1216e7cc515b8247e85116e281c061aa099ff7b901ca45a3c0
 SHA512:
-  metadata.gz: 4b690a81feac634e293fc0c64bfe104d5cc73f254d374f656b2e916e27c1ad7767ef5e1edcdf30d8269eae87fd7e72035ec91bcd05e68811a0699b281245d0fe
-  data.tar.gz: 26c4c100e45b80b5ee44db7c204251c6be4069e9cb69d565ad2e0a71ad382b969138f7fd526806824d7f3289327c54ed5e4f9241f4f46478b93e11838bb146d7
+  metadata.gz: 16a09550fa24191ffe86350e6cb9f6dfcef58c2e0965c6655a6515fce3efea8f5c7f78242f93eba68fa46dbfd7808995f8d3148b7659be0f3c7987a229e8b6ee
+  data.tar.gz: a1bb5ebead1ec6341f97152c310865087b2246bbcc4bd2660978fefaf84e43e61783a091573c5f493a402e55d036e8ef5697af437dc6e59dd5b818e7b6878371

data/README.md

@@ -0,0 +1,124 @@
+# 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_whos
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Ramiro Eloisa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Trabaja con los ID de IMDB para devolver en forma de array informacion como:
@@ -20,8 +20,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/the_whos.rb
-homepage: 
+- README.md
+homepage: https://github.com/RamEloisa/the_whos.git
 licenses:
 - MIT
 metadata: {}

data/lib/the_whos.rb

@@ -1,103 +0,0 @@
-require_relative 'title'
-require_relative 'actor'
-
-class TheWhos
-  @key_imdb = ARGV[0]
-
-  def self.create(id)
-    if id.chr == 't'
-      return Title.new(id)
-    elsif id.chr == 'n'
-      return Actor.new(id)
-    else
-      return 'Error'
-    end
-  end
-
-  def self.search_title(expression)
-    expression = expression.gsub(' ', '@')
-    url = "https://imdb-api.com/en/API/SearchTitle/#{@key_imdb}/#{expression}"
-    response = RestClient.get url
-    r_json = JSON.parse response.to_str
-    arr_search = r_json['results'].to_a
-    results = Array.new
-    arr_search.size.times do |i|
-      results << {id: "#{arr_search[i]['id']}", title: "#{arr_search[i]['title']}"}
-    end
-    return results
-  end
-
-  def self.search_actor(expression)
-    expression = expression.gsub(' ', '@')
-    url = "https://imdb-api.com/en/API/SearchName/#{@key_imdb}/#{expression}"
-    response = RestClient.get url
-    r_json = JSON.parse response.to_str
-    arr_search = r_json['results'].to_a
-    results = Array.new
-    arr_search.size.times do |i|
-      results << {id: "#{arr_search[i]['id']}", title: "#{arr_search[i]['title']}"}
-    end
-    return results
-  end
-
-  def self.match_title(title_a, title_b)
-    if title_a.class == String
-      title_a = Title.new(title_a)
-    end
-    if title_b.class == String
-      title_b = Title.new(title_b)
-    end
-    match = Array.new
-    title_a.fullcast.each do |actor_a|
-      title_b.fullcast.each do |actor_b|
-        if actor_a[:id] == actor_b[:id]
-          match << "#{actor_a[:actor].to_s} (#{actor_a[:id]})"
-        end
-      end
-    end
-    if match.empty? == true
-      return 'Not Match'
-    else
-      return match
-    end
-  end
-
-  def self.match_actor(actor_a, actor_b)
-    if actor_a.class == String
-      actor_a = Actor.new(actor_a)
-    end
-    if actor_b.class == String
-      actor_b = Actor.new(actor_b)
-    end
-    match = Array.new
-    actor_a.cast.each do |title_a|
-      actor_b.cast.each do |title_b|
-        if title_a[:id] == title_b[:id]
-          match << "#{title_a[:title]} (#{title_a[:id]})"
-        end
-      end
-    end
-    if match.empty? == true
-      return 'Not Match'
-    else
-      return match
-    end
-  end
-
-  def self.who(title, actor)
-    if title.class == String
-      title = Title.new(title)
-    end
-    if actor.class == String
-      actor = Actor.new(actor)
-    end
-    title.fullcast.each do |cast|
-      if cast[:id] == actor.id
-        return cast[:character]
-      end
-    end
-    return 'not appear'
-  end
-
-
-end