video_info 3.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5bcfd93f9cf4782cb70fdaabbbfeb95b6e054e2403c772fce72834d1f302d81
-  data.tar.gz: 99614494315f07c9049b67a30ceb7410882b860030faa3290e0eab9ea1711938
+  metadata.gz: b389a80be182106eeba217bf53d64801d78c9e95110e39c136d53af11dd813fe
+  data.tar.gz: 6dc99daeaafd264ef991232c85fa5bc6b4c3713d8ef83895e48bc6f27a461d61
 SHA512:
-  metadata.gz: dd789c89161544b5c10cca61e87f9ca1cb4ce42741bda74f22ccc0ffd47d3715c6954ce6b8581c23e3aa13f92f3d42ed3eea9053aca807a8415a74b41f2d0b43
-  data.tar.gz: a52184b867d403f45f703092a82b2ac9f1b059773cc9efbb596ebf3ede90707c10ceed9e1d58385b28ad8d46cf07a7ea47f90972d0d0bfa454e6053a991a09ba
+  metadata.gz: 91095899474824019cc2fa55f128fd20c3fe288aa558de950abc2ea39f2546cdfb68597992e1abad1f6294ea9deb49c190ce8676bcb036cbb2d82ee6177082d6
+  data.tar.gz: d0a09d7f75591250157f8d4c2e9996a7072db3f41bf1fed92adf8235066c535147f7c1d4f0b5451aec16673c33635577e2bfb0d5c29cf5a901bcabb51b0abcd7

data/.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+permissions:
+  checks: write
+  contents: read
+
+env:
+  YOUTUBE_API_KEY: ${{ secrets.YOUTUBE_API_KEY }}
+  VIMEO_ACCESS_TOKEN: ${{ secrets.VIMEO_ACCESS_TOKEN }}
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2', 'head']
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Publish code coverage
+        uses: paambaati/codeclimate-action@v3.2.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageLocations: ${{ github.workspace }}/coverage/coverage.json:simplecov
+  linter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: StandardRB Linter
+        uses: amoeba/standardrb-action@v4
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.gitignore

@@ -19,10 +19,10 @@ rdoc
 pkg
 Gemfile.lock
 *.gem
+tmp/*
 
 ## PROJECT::SPECIFIC
 .bundle/config
 vendor/bundle/
-
 .ruby-version
 bin

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CONTRIBUTING.md

@@ -1,11 +1,11 @@
-Contributing
---------
+# Contributing
 
 The guidelines for contributions are as follows:
-* Make sure you include comprehensive specs for new features and bug-fixes
-* Make sure all of the specs pass by running `rspec` in the root project directory. Pull requests with failing tests will not be merged.
-* Make sure there are no style issues by running `rubocop` in the root project directory. Pull requests with style issues will not be merged
+
+* Make sure you include comprehensive specs for new features and bug-fixes.
+* Make sure all of the specs pass by running `bundle exec rspec` in the root project directory. Pull requests with failing tests will not be merged.
+* Make sure there are no code style issues by running `bundle exec standardrb` in the root project directory. Pull requests with style issues will not be merged.
 * Optimally, you should create a separate branch to make rebasing with `master` simpler if other work gets merged in before your patch does.
-* In bug reports, post the outputs of `VideoInfo::VERSION` and `ruby --version`
+* In bug reports, post the outputs of `VideoInfo::VERSION` and `ruby --version`.
 * In bug reports, provide detailed and clear reproduction steps. Optimally, provide some sample code.
 * In bug reports, try to test against the `master` branch. If the bug does not exist in `master`, it is most likely known and a fix will be in the next release.

data/Gemfile

@@ -1,11 +1,3 @@
-source 'http://rubygems.org'
+source "http://rubygems.org"
 
-# Specify your gem's dependencies in video_info.gemspec
 gemspec
-
-gem 'coveralls', require: false
-
-group :tool do
-  gem 'ruby_gntp'
-  gem 'guard-rspec'
-end

data/README.md

@@ -1,28 +1,36 @@
 # VideoInfo
 
-[![Gem Version](https://badge.fury.io/rb/video_info.svg)](http://badge.fury.io/rb/video_info) [![Build Status](https://github.com/thibaudgg/video_info/workflows/Ruby%20Unit%20Tests/badge.svg?branch=master)](https://github.com/thibaudgg/video_info/actions?query=workflow%3A%22Ruby+Unit+Tests%22) [![Code Climate](https://codeclimate.com/github/thibaudgg/video_info.svg)](https://codeclimate.com/github/thibaudgg/video_info) [![Coverage Status](https://coveralls.io/repos/thibaudgg/video_info/badge.svg?branch=master)](https://coveralls.io/r/thibaudgg/video_info) [![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)
+[![Gem Version](https://badge.fury.io/rb/video_info.svg)](http://badge.fury.io/rb/video_info)
+[![CI](https://github.com/thibaudgg/video_info/actions/workflows/ci.yml/badge.svg)](https://github.com/thibaudgg/video_info/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1f03474bdb81e735002c/maintainability)](https://codeclimate.com/github/thibaudgg/video_info/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1f03474bdb81e735002c/test_coverage)](https://codeclimate.com/github/thibaudgg/video_info/test_coverage)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 Simple Ruby Gem to get video info from Dailymotion, Vimeo, Wistia and YouTube (with playlist).
 
-Tested against Ruby 2.5.x, 2.6.x and 2.7.x.
+Tested against Ruby 2.7, 3.0, 3.1 and 3.2.
+
+## Features
 
-Features
---------
 * Simple, single-function API that returns a simple data structure
 * Has a mere three gem dependencies
 * Automatic fallback to scrapers when required API keys aren't provided
 * Fetches metadata on the video, including title, duration, upload date, description, keywords, thumbnail, and dimensions
 * Fetches metadata on the author, including name, thumbnail, and channel/profile URL
 
-Install
---------
+## Install
 
-``` bash
+```bash
 gem install video_info
 ```
 
-Usage
------
+Or add to the Gemfile:
+
+```bash
+gem 'video_info'
+```
+
+## Usage
 
 ### Note for YouTube and Vimeo usage!
 
@@ -30,19 +38,20 @@ Youtube and Vimeo have recently updated their APIs to require API keys.
 
 Scrapers has been implemented for both Youtube and Vimeo. However, the Youtube scraper can only get the date the video was posted, while the API is able to get the date and the exact time the video was posted. You may also wish to use the API to protect against potential HTML changes that could break the scrapers.
 
-To get a Youtube API key, [follow the instructions here](https://developers.google.com/youtube/registering_an_application)
+**How to get these API keys**
 
-After generating a Youtube API key it is necessary to enable the YouTube Data API for the project which your API key was generated [enable Youtube Data API here](https://console.developers.google.com/apis/library/youtube.googleapis.com)
-
-To get a Vimeo API key, [follow the instructions here](https://developer.vimeo.com/api/start)
+- To get a Youtube API key, [follow the instructions here](https://developers.google.com/youtube/registering_an_application). After generating a Youtube API key it is necessary to enable the YouTube Data API for the project which your API key was generated [enable Youtube Data API here](https://console.developers.google.com/apis/library/youtube.googleapis.com).
+- To get a Vimeo API key, [follow the instructions here](https://developer.vimeo.com/api/start).
 
 To set the API keys, do the following:
-``` ruby
+
+```ruby
 VideoInfo.provider_api_keys = { youtube: 'YOUR_YOUTUBE_API_KEY', vimeo: 'YOUR_VIMEO_API_KEY' }
 ```
 
+### Basic Usage
 
-``` ruby
+```ruby
 video = VideoInfo.new('http://www.dailymotion.com/video/x7lni3')
 # video.available?       => true
 # video.video_id         => 'x7lni3'
@@ -56,6 +65,7 @@ video = VideoInfo.new('http://www.dailymotion.com/video/x7lni3')
 # video.thumbnail_large  => 'http://s2.dmcdn.net/BgWxI/x720-YcV.jpg'
 # video.embed_url        => 'http://www.dailymotion.com/embed/video/x7lni3'
 # video.embed_code       => "<iframe src='//www.dailymotion.com/embed/video/x7lni3' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
+# video.stats            => {"views_total"=>10342797, "likes_total"=>3850}
 
 video = VideoInfo.new("http://vimeo.com/898029")
 # video.available?       => true
@@ -76,6 +86,7 @@ video = VideoInfo.new("http://vimeo.com/898029")
 # video.thumbnail_large  => 'http://b.vimeocdn.com/ts/343/731/34373130_640.jpg'
 # video.embed_url        => 'http://player.vimeo.com/video/898029'
 # video.embed_code       => "<iframe src='//player.vimeo.com/video/898029?title=0&amp;byline=0&amp;portrait=0&amp;autoplay=0' frameborder='0'></iframe>"
+# video.stats            => {"plays"=>630, "likes"=>3, "comments"=>0}
 
 video = VideoInfo.new("http://fast.wistia.com/embed/medias/pxonqr42is")
 # video.available?       => true
@@ -107,6 +118,7 @@ video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4")
 # video.thumbnail_large  => 'http://i.ytimg.com/vi/mZqGqE0D0n4/hqdefault.jpg'
 # video.embed_url        => 'http://www.youtube.com/embed/mZqGqE0D0n4'
 # video.embed_code       => "<iframe src='//www.youtube.com/embed/mZqGqE0D0n4' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
+# video.stats            => {"viewCount"=>"8297", "likeCount"=>"66", "favoriteCount"=>"0", "commentCount"=>"5"}
 
 playlist = VideoInfo.new("http://www.youtube.com/playlist?p=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr")
 # playlist.available?          => true
@@ -135,29 +147,29 @@ You can also use the `valid_url?` helper to check if a given url is valid in som
 => false
 ```
 
-Options
--------
+### Options
 
-``` ruby
+```ruby
 video = VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4', 'User-Agent' => 'My YouTube Mashup Robot/1.0')
 video = VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4', 'Referer'    => 'http://my-youtube-mashup.com/')
 video = VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4', 'Referer'    => 'http://my-youtube-mashup.com/',
                                                                     'User-Agent' => 'My YouTube Mashup Robot/1.0')
 ```
+
 You can also use **symbols** instead of strings (any non-word (`/[^a-z]/i`) character would be converted to hyphen).
 
-``` ruby
+```ruby
 video = VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4', referer: 'http://my-youtube-mashup.com/',
                                                                     user_agent: 'My YouTube Mashup Robot/1.0')
 ```
 
 User-Agent when empty defaults to "VideoInfo/VERSION" - where version is current VideoInfo version, e.g. **"VideoInfo/0.2.7"**.
 
-It supports all openURI header fields (options), for more information see: [openURI DOCS](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/open-uri/rdoc/OpenURI.html)
+It supports all `OpenURI` header fields (options), for more information see: [OpenURI docs](https://ruby-doc.org/3.2.0/stdlibs/open-uri/OpenURI.html).
 
 You can also include an `iframe_attributes` or `url_attributes` hash to the `embed_code` method to include arbitrary attributes in the iframe embed code or as additional URL params:
 
-``` ruby
+```ruby
 VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4').embed_code(iframe_attributes: { width: 800, height: 600, 'data-key' => 'value' })
 => '<iframe src="//www.youtube.com/embed/mZqGqE0D0n4" frameborder="0" allowfullscreen="allowfullscreen" width="800" height="600" data-key="value"></iframe>'
 
@@ -167,29 +179,29 @@ VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4').embed_code(url_attri
 
 If you would like to disable certain providers, you can do so by modifying the class variable `disable_providers`:
 
-``` ruby
+```ruby
 VideoInfo.disable_providers = %w[YouTube] # disable YouTube
 VideoInfo.disable_providers = %w[Vimeo YouTube] # disable Vimeo and Youtube
 VideoInfo.disable_providers = [] # enable all providers
 ```
 
-Note: `disable_providers` is case-insensitive. Attempting to use a disabled provider will raise a UrlError, just like attempting to use a
-non-video URL.
+**NOTE:** `disable_providers` is case-insensitive. Attempting to use a disabled provider will raise a UrlError, just like attempting to use a non-video URL.
+
+## Contributing
 
+Please read [the contributing guidelines](CONTRIBUTING.md).
 
-Author
-------
+### Author
 
 [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
 
-Maintainers
------------
+### Maintainers
 
 - [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
-- [Vincent Heuken](https://github.com/vheuken) ([@vheuken](https://github.com/vheuken))
-- [João Vieira](https://github.com/joaocv3) ([@joaocv3](https://github.com/joaocv3))
+- [Vincent Heuken](https://github.com/vheuken)
+- [João Vieira](https://github.com/joaocv3)
+- [Marc Anguera](https://github.com/markets)
 
-Contributors
-------------
+### Contributors
 
 [https://github.com/thibaudgg/video_info/graphs/contributors](https://github.com/thibaudgg/video_info/graphs/contributors)

data/Rakefile

@@ -1,5 +1,6 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+
 task default: :spec

data/lib/video_info/provider.rb

@@ -1,10 +1,12 @@
-require 'open-uri'
-require 'json'
-require 'uri'
+require "open-uri"
+require "json"
+require "uri"
+require "net/http"
+require "openssl"
 
 class VideoInfo
   class Provider
-    attr_accessor :url, :options, :iframe_attributes, :video_id
+    attr_accessor :url, :options, :video_id
     attr_writer :data
 
     def initialize(url, options = {})
@@ -15,7 +17,7 @@ class VideoInfo
 
     def self.usable?(_url)
       raise NotImplementedError.new(
-        'Provider class must implement .usable? public method'
+        "Provider class must implement .usable? public method"
       )
     end
 
@@ -26,7 +28,7 @@ class VideoInfo
         _default_iframe_attributes.merge(iframe_attributes)
       )
 
-      "<iframe #{iframe_attrs.reject(&:empty?).join(' ')}></iframe>"
+      "<iframe #{iframe_attrs.reject(&:empty?).join(" ")}></iframe>"
     end
 
     def data
@@ -34,7 +36,7 @@ class VideoInfo
     end
 
     def available?
-      !%w[403 404 400].include?(_response_code)
+      !%w[403 404 400 451 401].include?(_response_code)
     end
 
     def thumbnail
@@ -51,13 +53,17 @@ class VideoInfo
       nil
     end
 
+    def stats
+      {}
+    end
+
     private
 
     def _response_code
       uri = URI.parse(_api_url)
       http = Net::HTTP.new(uri.host, uri.port)
 
-      if uri.scheme == 'https'
+      if uri.scheme == "https"
         _https_response_code(http)
       else
         _http_response_code(http)
@@ -78,7 +84,7 @@ class VideoInfo
 
     def _clean_options(options)
       options =
-        { 'User-Agent' => "VideoInfo/#{VideoInfo::VERSION}" }.merge(options)
+        {"User-Agent" => "VideoInfo/#{VideoInfo::VERSION}"}.merge(options)
       options.dup.each do |key, value|
         if _not_openuri_option_symbol?(key)
           options[_http_header_field(key)] = value
@@ -92,16 +98,16 @@ class VideoInfo
       _set_data_from_api_impl(api_url)
     rescue OpenURI::HTTPError, *NetHttpTimeoutErrors.all => e
       if e.instance_of?(OpenURI::HTTPError) &&
-         e.respond_to?(:io) &&
-         e.io.respond_to?(:status)
+          e.respond_to?(:io) &&
+          e.io.respond_to?(:status)
         response_code = e.io.status[0]
-        if response_code == '400'
-          log_warn('your API key is probably invalid. Please verify it.')
+        if response_code == "400"
+          log_warn("Your API key is probably invalid. Please verify it.")
         end
       end
 
-      msg = 'unexpected network error while
-            fetching information about the video'
+      msg = "Unexpected network error while fetching information about the video"
+      msg << " (response code: #{response_code})" if defined?(response_code)
       raise VideoInfo::HttpError.new(msg)
     end
 
@@ -110,16 +116,16 @@ class VideoInfo
     end
 
     def _set_data_from_api_impl(api_url)
-      uri = URI.open(api_url, options)
-      JSON.load(uri.read)
+      uri = URI.parse(api_url)
+      JSON.parse(uri.read(options))
     end
 
     def _not_openuri_option_symbol?(key)
-      key.is_a?(Symbol) && !OpenURI::Options.keys.include?(key)
+      key.is_a?(Symbol) && !OpenURI::Options.key?(key)
     end
 
     def _http_header_field(key)
-      key.to_s.split(/[^a-z]/i).map(&:capitalize).join('-')
+      key.to_s.split(/[^a-z]/i).map(&:capitalize).join("-")
     end
 
     def _set_video_id_from_url
@@ -135,13 +141,13 @@ class VideoInfo
 
     def _url_regex
       raise NotImplementedError.new(
-        'Provider class must implement #_url_regex private method'
+        "Provider class must implement #_url_regex private method"
       )
     end
 
     def _api_url
       raise NotImplementedError.new(
-        'Provider class must implement #_api_url private method'
+        "Provider class must implement #_api_url private method"
       )
     end
 
@@ -156,7 +162,7 @@ class VideoInfo
 
     def _hash_to_attributes(hash)
       return unless hash.is_a?(Hash)
-      hash.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
+      hash.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
     end
 
     def _hash_to_params(hash)

data/lib/video_info/providers/dailymotion.rb

@@ -2,11 +2,11 @@ class VideoInfo
   module Providers
     class Dailymotion < Provider
       def self.usable?(url)
-        url =~ /(dai(?:\.ly|lymotion\.com))/
+        url.match?(/(dai(?:\.ly|lymotion\.com))/)
       end
 
       def provider
-        'Dailymotion'
+        "Dailymotion"
       end
 
       %w[title description duration].each do |method|
@@ -18,19 +18,19 @@ class VideoInfo
       end
 
       def author
-        data['owner.screenname']
+        data["owner.screenname"]
       end
 
       def author_url
-        data['owner.url']
+        data["owner.url"]
       end
 
       def author_thumbnail
-        data['owner.avatar_60_url']
+        data["owner.avatar_60_url"]
       end
 
       def keywords
-        data['tags']
+        data["tags"]
       end
 
       def embed_url
@@ -38,23 +38,30 @@ class VideoInfo
       end
 
       def date
-        Time.at(data['created_time']).utc
+        Time.at(data["created_time"]).utc
       end
 
       def thumbnail_small
-        data['thumbnail_60_url']
+        data["thumbnail_60_url"]
       end
 
       def thumbnail_medium
-        data['thumbnail_240_url']
+        data["thumbnail_240_url"]
       end
 
       def thumbnail_large
-        data['thumbnail_720_url']
+        data["thumbnail_720_url"]
       end
 
       def view_count
-        data['views_total'].to_i
+        data["views_total"].to_i
+      end
+
+      def stats
+        {
+          "views_total" => view_count,
+          "likes_total" => data["likes_total"].to_i
+        }
       end
 
       private
@@ -68,11 +75,11 @@ class VideoInfo
       end
 
       def _url_regex
-        %r{dai(?:\.ly|lymotion\.com\/(?:embed\/)?video)\/([a-zA-Z0-9]*)}
+        %r{dai(?:\.ly|lymotion\.com/(?:embed/)?video)/([a-zA-Z0-9]*)}
       end
 
       def _api_base
-        'api.dailymotion.com'
+        "api.dailymotion.com"
       end
 
       def _api_path
@@ -81,10 +88,10 @@ class VideoInfo
 
       def _api_url
         "https://#{_api_base}#{_api_path}?" \
-        'fields=id,title,description,duration,created_time,' \
-        'url,views_total,tags,thumbnail_url,thumbnail_720_url,' \
-        'owner.url,owner.screenname,owner.avatar_60_url,' \
-        'thumbnail_240_url,thumbnail_60_url'
+        "fields=id,title,description,duration,created_time," \
+        "url,views_total,tags,thumbnail_url,thumbnail_720_url," \
+        "owner.url,owner.screenname,owner.avatar_60_url," \
+        "thumbnail_240_url,thumbnail_60_url,likes_total"
       end
 
       def _default_iframe_attributes
@@ -92,7 +99,7 @@ class VideoInfo
       end
 
       def _default_url_attributes
-        { autoplay: 0 }
+        {autoplay: 0}
       end
     end
   end

data/lib/video_info/providers/vimeo.rb

@@ -1,5 +1,5 @@
-require_relative 'vimeo_api'
-require_relative 'vimeo_scraper'
+require_relative "vimeo_api"
+require_relative "vimeo_scraper"
 
 class VideoInfo
   module Providers
@@ -15,11 +15,11 @@ class VideoInfo
       end
 
       def self.usable?(url)
-        url =~ %r{(vimeo\.com\/(?!album|hubnut\/album).*)}
+        url.match?(%r{(vimeo\.com/(?!album|hubnut/album|user\d+/?\z).*)})
       end
 
       def provider
-        'Vimeo'
+        "Vimeo"
       end
 
       def embed_url
@@ -30,10 +30,10 @@ class VideoInfo
 
       def _url_regex
         %r{.*\.com&&
-        |\/(?:(?:groups\/[^\/]+\/videos\/)
-        |(?:ondemand|channels)(?:(?:\/less\/)
-        |(?:user[0-9]+\/review\/)?([0-9]+).*
-        |(?:\/\w*\/))|(?:video\/))?([0-9]+).*$
+        |/(?:(?:groups/[^/]+/videos/)
+        |(?:ondemand|channels)(?:(?:/less/)
+        |(?:user[0-9]+/review/)?([0-9]+).*
+        |(?:/\w*/))|(?:video/))?([0-9]+).*$
         }x
       end
 
@@ -42,10 +42,10 @@ class VideoInfo
       end
 
       def _default_url_attributes
-        { title: 0,
-          byline: 0,
-          portrait: 0,
-          autoplay: 0 }
+        {title: 0,
+         byline: 0,
+         portrait: 0,
+         autoplay: 0}
       end
     end
   end