imdb_title 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2fc3cac635deca895d0d4189f92b175b023091c7e69e5fd6adb96802c6ad5a2
+  data.tar.gz: 949e0fc71c0ff76bf11dcf29b1770a7674c8976b8cc728dea6da89da2b60772f
+SHA512:
+  metadata.gz: fa0263da758fc96f977e4b0065df386f646b1686bd96c14dfeba2f748936ef06c372ef50cf2e96f2de4749cbe99d4f691abf818d2fc99b06017f8d2c10bafeaa
+  data.tar.gz: 74379acd1efe8174758e61f37af49ba8733ea1abcce7dc562fbcae9c8fddd6d06fd3c5e6c94c5fdf1bd0ef20d39465b5c581ca0a01d4d259f2db78d358bbd637

data/lib/imdb/exceptions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module IMDb
+  # All custom errors will inherit from this class
+  class Error < StandardError; end
+
+  # 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/titles/episode.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###    All features are available from Base class
+
+##
+##
+##
+
+# features exclusive to Episode title type
+module Episode
+end

data/lib/imdb/titles/movie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###    All features are available from Base class
+
+#### ------- BOX OFFICE ---------
+###   12. Budget
+###   13. Gross Worldwide (Revenue)
+##
+##
+##
+
+# features exclusive to Movie title type
+module Movie
+  # returns budget price of the movie
+  def budget
+    document.css("li[data-testid=title-boxoffice-budget] div").text[/\$\S+/]
+  end
+
+  # returns revenue price of the movie
+  def revenue
+    inspect_this document.css("li[data-testid=title-boxoffice-cumulativeworldwidegross] div").text
+  end
+end

data/lib/imdb/titles/tv_show.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###    All features are available from Base class
+
+##
+##
+##
+
+# features exclusive to Tv-Show title type
+module TvShow
+end

data/lib/imdb/titles/video_game.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###    All features are available from Base class
+
+##
+##
+##
+
+# features exclusive to Video Game title 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

data/lib/imdb.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require "require_all"
+require "nokogiri"
+require "httparty"
+require_all "lib/imdb/"
+
+##
+##
+##
+###### ---------------- List of features/data avialable to extract -----------------------
+###   1. Cast
+###   2. Director
+###   3. Genres
+###   4. IMDb ID
+###   5. Popularity
+###   6. Ratings
+###   7. Title
+###   8. Tagline
+#### ------- 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
+  class Title
+    # pass valid imdb title url
+    def initialize(url)
+      raise InvalidURL, "Please input a valid IMDb URL" unless valid?(url)
+
+      case title_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
+    def casts
+      split_these document.css("a[data-testid=title-cast-item__actor]").text
+    end
+
+    # returns list of directors
+    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
+
+    # returns runtime of the title
+    def duration
+      inspect_this document.css("li[data-testid=title-techspec_runtime] div").text
+    end
+
+    # returns list of genres
+    def genres
+      split_these document.css("div[data-testid=genres]").text
+    end
+
+    # returns a unique id set by imdb
+    def imdb_id
+      document.css("meta[property*=pageConst]").attribute("content").value
+    end
+
+    # returns number of users rated
+    def popularity
+      document.css("div[data-testid=hero-rating-bar__aggregate-rating] span div").last&.text
+    end
+
+    # returns list of production companies
+    def production_companies
+      split_these document.css("li[data-testid=title-details-companies] li").text
+    end
+
+    # returns user average rating score
+    def ratings
+      document.css("div[data-testid=hero-rating-bar__aggregate-rating__score] span").first&.text
+    end
+
+    # returns release date
+    def release_date
+      inspect_this document.css("li[data-testid=title-details-releasedate] div").text
+    end
+
+    # returns short introduction of the title
+    def tagline
+      inspect_this document.css("span[data-testid=plot-xl]").text
+    end
+
+    # returns name of the title
+    def title
+      document.css("h1").text
+    end
+
+    def url
+      document.css("meta[property*=url]").attribute("content").value
+    end
+
+    private
+
+    attr_reader :document
+
+    # checks IMDb id from URL (dosen't 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
+      document.css("meta[property*=type]").attribute("content").value
+    end
+
+    # validates domain name, slug & IMDb ID length and returns title page
+    def valid?(url)
+      url.match?("https://www.imdb.com/title/tt#{/\d+{7,}/i}") && correct_id?(url)
+    end
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: imdb_title
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Juzer Shakir
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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
+      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.
+email: juzershakir.webdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/imdb.rb
+- lib/imdb/exceptions.rb
+- lib/imdb/titles/episode.rb
+- lib/imdb/titles/movie.rb
+- lib/imdb/titles/tv_show.rb
+- lib/imdb/titles/video_game.rb
+homepage: https://github.com/JuzerShakir/imdb
+licenses:
+- MIT
+- GPL-2.0
+metadata:
+  source_code_uri: https://github.com/JuzerShakir/imdb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Access info of any Movie, Tv Show, Episode or Game from imdb.com
+test_files: []