imdb_title 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adba25559e91ab2032f64e3f05fc62a3787a05d82ba4bba789b72d7f06ad2c76
-  data.tar.gz: 396cfdecd9b4ef7d98c92a122ff17cde27fa9db760db5547e5a666b11b328e80
+  metadata.gz: c93d7763c58767a3c60055a67d1d74aef8d90e9fe89cbd80a90b7105adbe0975
+  data.tar.gz: cf326e23a86e2dbc46c176216fff601b4f59ca0a21e58c6c1e4bc55877fd2538
 SHA512:
-  metadata.gz: 19702e3169519da7204d57a03763a5d8c2f66f512b840e89a554a90dd14a38f7cc1b7755844eb6f3806b9efd6fa5217a1c5801c8a5c53a081c73b6902111abdb
-  data.tar.gz: c59a7c0860725586d92599e2a76a40c89cf35ba35687ac66b5eee365ce31073521b54a1957ee25d79bb8c7a1d7bdeb2c57f530a245cd368fb39756d752206f78
+  metadata.gz: 02fae1cd0b1ebd2a26c7257469c45215fc1f9072e4980e6544ba1e88540ef239aa1137b1a9182c3e72795ee0e6610f2079ae5821e64b08b0aa4e244c656eb824
+  data.tar.gz: 31f483bb6bee4458a5897654f9f104d1b26f01d611f5226b980d3b8559567cabd50d70f8e891618739cbb047634a5e879f8e09318bc1d789f4888ebdae8f4300

data/lib/exceptions.rb

@@ -8,5 +8,5 @@ module IMDb
   class InvalidURL < Error; end
 
   # Will raise this error if URL is UNSUPPORTED title type
-  class UnSupportedType < InvalidURL; end
+  class UnSupportedMediaType < InvalidURL; end
 end

data/lib/imdb_title.rb

@@ -4,8 +4,9 @@
 require "nokogiri"
 require "httparty"
 
-# require all files & folders of this directory 'lib'
-Dir.glob(File.join(__dir__, "**", "*.rb"), &method(:require))
+# require all files & folders of the current directory 'lib'
+lib = __dir__
+Dir.glob(File.join(lib, "**", "*.rb")).sort.each(&method(:require))
 
 ##
 ##
@@ -22,88 +23,82 @@ Dir.glob(File.join(__dir__, "**", "*.rb"), &method(:require))
 #### ------- DETAILS ---------
 ###   9. Prodcution Companies
 ###   10. Release Date
-#### ------- TECHNICAL SPECS ---------
-###   11. Runtime
 ##
 ##
 ##
 
-# :reek:TooManyMethods
 module IMDb
-  # Extracts common data from titles - Movie, TV-shows, Episode, Game from imdb.com
+  # pass any Movie, TV-show, Episode or Game url from imdb.com
   class Title
-    # pass valid imdb title url
     def initialize(url)
       raise InvalidURL, "Please input a valid IMDb URL" unless valid?(url)
 
-      case title_type
+      case media_type
       when "video.movie" then extend Movie
       when "video.tv_show" then extend TvShow
       when "video.episode" then extend Episode
       when "video.other" then extend VideoGame
-      else raise UnSupportedTypeError, "Unknown title type"
+      else raise UnSupportedMediaType, "Unknown media type"
       end
     end
 
-    # returns list of casts
+    # lists all top cast (Array)
     def casts
-      split_these document.css("a[data-testid=title-cast-item__actor]").text
+      html = document.css("a[data-testid=title-cast-item__actor]")
+      return if html.empty?
+
+      html.map(&:text)
     end
 
-    # returns list of directors
+    # list of directors (Array)
     def directors
-      html = document.css("li[data-testid=title-pc-principal-credit]")
-      text = html.text
-      return unless text.include? "Director"
-
-      split_these html.css("ul").first.text
-    end
+      html = document.css("li[data-testid=title-pc-principal-credit]").first
+      return unless html.text.include? "Director"
 
-    # returns runtime of the title
-    def duration
-      inspect_this document.css("li[data-testid=title-techspec_runtime] div").text
+      html.css("div li").map(&:text)
     end
 
-    # returns list of genres
+    # list of genres (Array)
     def genres
-      split_these document.css("div[data-testid=genres]").text
+      document.css("div[data-testid=genres] div a").map(&:text)
     end
 
-    # returns a unique id set by imdb
+    # ID that differentiates each media type on imdb.com (String)
     def imdb_id
       document.css("meta[property*=pageConst]").attribute("content").value
     end
 
-    # returns number of users rated
+    # number of users rated (String)
     def popularity
       document.css("div[data-testid=hero-rating-bar__aggregate-rating] span div").last&.text
     end
 
-    # returns list of production companies
+    # list of production companies (Array/String)
     def production_companies
-      split_these document.css("li[data-testid=title-details-companies] li").text
+      document.css("li[data-testid=title-details-companies] li").map(&:text)
     end
 
-    # returns user average rating score
+    # average ratings (String)
     def ratings
       document.css("div[data-testid=hero-rating-bar__aggregate-rating__score] span").first&.text
     end
 
-    # returns release date
+    # the date it was release on (String)
     def release_date
-      inspect_this document.css("li[data-testid=title-details-releasedate] div").text
+      document.css("li[data-testid=title-details-releasedate] div").first&.text
     end
 
-    # returns short introduction of the title
+    # short introduction
     def tagline
-      inspect_this document.css("span[data-testid=plot-xl]").text
+      document.css("span[data-testid=plot-xl]").first&.text
     end
 
-    # returns name of the title
+    # name or title
     def title
       document.css("h1").text
     end
 
+    # full url
     def url
       document.css("meta[property*=url]").attribute("content").value
     end
@@ -112,37 +107,18 @@ module IMDb
 
     attr_reader :document
 
-    # checks IMDb id from URL (dosen't return 404 Error Page)
+    # checks IMDb id from URL (should not return 404 Error Page)
     def correct_id?(url)
       response = HTTParty.get(url, {headers: {"User-Agent" => "Httparty"}})
       @document = Nokogiri::HTML(response.body)
       document.title != "404 Error - IMDb"
     end
 
-    # :reek:UtilityFunction
-    # returns proper output
-    def inspect_this(input)
-      if input.empty?
-        nil
-      elsif input.length == 1
-        input.join
-      else
-        input
-      end
-    end
-
-    # spilits camel case names to array
-    def split_these(names)
-      list = names.split(/(?<=[a-z)])(?=[A-Z])/)
-      inspect_this(list)
-    end
-
-    # returns type of title
-    def title_type
+    def media_type
       document.css("meta[property*=type]").attribute("content").value
     end
 
-    # validates domain name, slug & IMDb ID length and returns title page
+    # validates domain name, slug, IMDb ID & its length
     def valid?(url)
       url.match?("https://www.imdb.com/title/tt#{/\d+{7,}/i}") && correct_id?(url)
     end

data/lib/non_interactive.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###    All features are available from Title class
+
+##  1. duration
+##
+##
+
+# features exclusive to Movies, Tv-Shows & Episode media type
+module NonInteractive
+  # returns runtime of the media
+  def duration
+    document.css("li[data-testid=title-techspec_runtime] div").first&.text
+  end
+
+  # define streaming_on method that returns on which platform the media is streaming
+end

data/lib/titles/episode.rb

@@ -4,12 +4,12 @@
 ##
 ##
 ###### ---------------- List of features/data avialable to extract -----------------------
-###    All features are available from Base class
-
+###    All features are available from Title class
 ##
 ##
 ##
 
-# features exclusive to Episode title type
+# features exclusive to Episode media type
 module Episode
+  prepend NonInteractive
 end

data/lib/titles/movie.rb

@@ -4,8 +4,7 @@
 ##
 ##
 ###### ---------------- List of features/data avialable to extract -----------------------
-###    All features are available from Base class
-
+###    All features are available from Title class
 #### ------- BOX OFFICE ---------
 ###   12. Budget
 ###   13. Gross Worldwide (Revenue)
@@ -13,15 +12,17 @@
 ##
 ##
 
-# features exclusive to Movie title type
+# features exclusive to Movie media type
 module Movie
-  # returns budget price of the movie
+  prepend NonInteractive
+
+  # budget (String)
   def budget
     document.css("li[data-testid=title-boxoffice-budget] div").text[/\$\S+/]
   end
 
-  # returns revenue price of the movie
+  # revenue / Gross Worldwide (String)
   def revenue
-    inspect_this document.css("li[data-testid=title-boxoffice-cumulativeworldwidegross] div").text
+    document.css("li[data-testid=title-boxoffice-cumulativeworldwidegross] div").first&.text
   end
 end

data/lib/titles/tv_show.rb

@@ -4,12 +4,12 @@
 ##
 ##
 ###### ---------------- List of features/data avialable to extract -----------------------
-###    All features are available from Base class
-
+###    All features are available from Title class
 ##
 ##
 ##
 
-# features exclusive to Tv-Show title type
+# features exclusive to Tv-Show media type
 module TvShow
+  prepend NonInteractive
 end

data/lib/titles/video_game.rb

@@ -4,18 +4,11 @@
 ##
 ##
 ###### ---------------- List of features/data avialable to extract -----------------------
-###    All features are available from Base class
-
+###    All features are available from Title class
 ##
 ##
 ##
 
-# features exclusive to Video Game title type
+# features exclusive to Video Game media type
 module VideoGame
-  # remove duration instance method as its not relevant for the game object
-  def self.extended(obj)
-    obj.class.instance_eval do
-      undef_method :duration
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imdb_title
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Juzer Shakir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -85,9 +85,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.31.1
 description: |2
-      Want to know everything about your favorite movies, TV shows, episodes, and games?
-      Look no further than our data extraction tool! All the information you need such as
-      title, tagline, ratings, casts, productions, etc will be a method call away.
+      Extract useful information about your favorite Movies, TV shows, Episodes, or Games
+      with our data extraction library. All the information you need is a method call away.
 email: juzershakir.webdev@gmail.com
 executables: []
 extensions: []
@@ -95,6 +94,7 @@ extra_rdoc_files: []
 files:
 - lib/exceptions.rb
 - lib/imdb_title.rb
+- lib/non_interactive.rb
 - lib/titles/episode.rb
 - lib/titles/movie.rb
 - lib/titles/tv_show.rb
@@ -102,9 +102,10 @@ files:
 homepage: https://github.com/JuzerShakir/imdb
 licenses:
 - MIT
-- GPL-2.0
 metadata:
   source_code_uri: https://github.com/JuzerShakir/imdb
+  changelog_uri: https://github.com/JuzerShakir/imdb/CHANGELOG.md
+  bug_tracker_uri: https://github.com/JuzerShakir/imdb/Issues
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -113,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="