imdb_title 0.0.9 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f44608ead04c5297b68d40fb20f21a9b901b14d0858e39d67564298887ac15e
-  data.tar.gz: 0f49f0182eada0524d13eefe73eef7c073e0c6ab99a678b781db41a9e7643868
+  metadata.gz: d800873fb8e5ce95526320f79336bf3ddee8ba46646f7fb92964f73ea4273cf4
+  data.tar.gz: 5c4e4147d480b343bcc64f46ba60dd70bf277fd114f3a54673d73aeea54d40b7
 SHA512:
-  metadata.gz: bf11fcede9ae7f8aac511843a9b6a0c0548032674ca20fcce190327140913412fdc38601b05fa24c9d3915597eecacc86530bb993543412b0f8500563ff8273d
-  data.tar.gz: f48939fae4617ae808c765dc5d4026c65c683eaee22ef2e287138315f404c016ca0dd3de845653d1b6c2e4c752699a2df36e92353d6c4dee77e79ba93a1f338e
+  metadata.gz: 99e7b36f91aab41560f6a788ee59668cadcb79f57a58202041649ae40abfd8fe89e0d2c415622ec3cd2afc02fc8fdda0d98a98c2cbdd34d09484ec35f029f045
+  data.tar.gz: c67c2ca7d45a26610269c61b81166849f26b1f9768f90bcc47722ec50b4e4f0e722bd548e3c569b2e170adc37572177e58a966016f19ee85c3bfc8f064c251fc

data/lib/exceptions.rb

@@ -6,7 +6,4 @@ module IMDb
 
   # Will raise this error for incorrect url input
   class InvalidURL < Error; end
-
-  # Will raise this error if URL is UNSUPPORTED title type
-  class UnSupportedType < 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")).sort.each(&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,81 @@ Dir.glob(File.join(__dir__, "**", "*.rb")).sort.each(&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"
       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.match?(/Director|Creator/)
 
-    # 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 +106,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.9
+  version: 0.0.11
 platform: ruby
 authors:
 - Juzer Shakir
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2023-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -44,46 +44,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.15.4
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.4
-- !ruby/object:Gem::Dependency
-  name: standard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.31'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.31.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.31'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.31.1
 description: |2
       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.
@@ -94,6 +54,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