video_info 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 456811952d85d6b9e52f876b2a599eb40f8b1cb7
-  data.tar.gz: f87c2d89023c932c91d99f32d0f8dd36ce236bf5
+  metadata.gz: 407deea14c1eab8be2324255ee49bde34affdf01
+  data.tar.gz: 2ef07eb9b3fe33504a9d31fe2e1bf27959f28ecf
 SHA512:
-  metadata.gz: 85fdd40ea59d64ea9e9705f796e40137d9fcec6083131de58f1b6bd690e1f1b278fc9f569c87e39e43e4b6306bca5989aaf79595f95770e7661baf22addb2aea
-  data.tar.gz: be70db584d9f01c9d14e26cc7b5cfe0feb28d2827b6545b7f36ca3c2ee5a1eb51683dd7979d9cc69210a6db69791aaae0ba99957ce92341bb0e363490fb65b3c
+  metadata.gz: c5ba823f42f0798b354b3caa08ad21605e6a0c1626c07336ef04d66bd822d876150982716b4b73dd07a6d26afc7a4ce3ebbdd538037cf86f786cf6b2329a4e1b
+  data.tar.gz: 9717f48d8ac0814af071a7eb568f1d5a420d06a2b78cfe903bf84f2f31035e10efe372216ea396cb1d0f7ae65e7f07e85946ea5dc9fd25dbb3d7bb41e2a04292

data/.gitignore

@@ -18,6 +18,7 @@ coverage
 rdoc
 pkg
 Gemfile.lock
+spec/fixtures/
 
 ## PROJECT::SPECIFIC
 .bundle/config

data/.travis.yml

@@ -1,12 +1,10 @@
 language: ruby
 bundler_args: --without tool
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
   - 2.2.0
   - jruby
   - rbx
 matrix:
   allow_failures:
     - rvm: rbx
+    - rvm: jruby

data/README.md

@@ -4,7 +4,7 @@
 
 Simple Ruby Gem to get video info from Dailymotion, VK, Vimeo (with playlist), Wistia and YouTube (with playlist).
 
-Tested against Ruby 1.9.3, 2.0.0, 2.1.0 and the latest versions of JRuby & Rubinius.
+Tested against Ruby 2.2.0 and the latest versions of JRuby & Rubinius.
 
 Install
 --------
@@ -16,6 +16,21 @@ gem install video_info
 Usage
 -----
 
+## Note for YouTube usage!
+Youtube recently updated their API to require an API key.
+
+To get around this, a scraper was implemented. However, the 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 scraper.
+
+To get an API key, [follow the instructions here](https://developers.google.com/youtube/registering_an_application)
+
+To set the API key, do the following:
+``` ruby
+VideoInfo.provider_api_keys = { youtube: 'YOUR_API_KEY' }
+```
+
+
 ``` ruby
 video = VideoInfo.new('http://www.dailymotion.com/video/x7lni3')
 # video.available?       => true
@@ -131,13 +146,29 @@ VideoInfo.new('http://www.youtube.com/watch?v=mZqGqE0D0n4').embed_code(iframe_at
 => '<iframe src="//www.youtube.com/embed/mZqGqE0D0n4?autoplay=1" frameborder="0" allowfullscreen="allowfullscreen"></iframe>'
 ```
 
+If you would like to disable certain providers, you can do so by modifying the class variable `disable_providers`:
+
+``` 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.
+
 Author
 ------
 
 [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
 
+Maintainers
+-----------
+
+[Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](https://twitter.com/thibaudgg))
+[Vincent Heuken](https://github.com/vheuken) ([@vheuken](https://github.com/vheuken))
+
 Contributors
 ------------
 
 [https://github.com/thibaudgg/video_info/graphs/contributors](https://github.com/thibaudgg/video_info/graphs/contributors)
-

data/lib/video_info.rb

@@ -17,11 +17,14 @@ class VideoInfo
   def_delegators :@provider, :provider, :video_id, :video_owner, :url, :data
   def_delegators :@provider, :title, :description, :keywords, :view_count
   def_delegators :@provider, :date, :duration, :width, :height
+  def_delegators :@provider, :thumbnail
   def_delegators :@provider, :thumbnail_small, :thumbnail_medium, :thumbnail_large
   def_delegators :@provider, :embed_code, :embed_url
   def_delegators :@provider, :available?
   def_delegators :@provider, :playlist_id, :videos
-
+  def_delegators :@provider, :author, :author_thumbnail
+  def_delegators :@provider, :data=
+  
   def initialize(url, options = {})
     @provider = _select_provider(url, options)
   end
@@ -41,11 +44,44 @@ class VideoInfo
     url == other.url && video_id == other.video_id
   end
 
+  @@provider_api_keys = {}
+
+  def self.provider_api_keys
+    @@provider_api_keys
+  end
+
+  def self.provider_api_keys=(api_keys)
+    api_keys.keys.each do |key|
+      raise ArgumentError, 'Key must be a symbol!' unless key.is_a?(Symbol)
+    end
+    @@provider_api_keys = api_keys
+  end
+
+  @@disable_providers = []
+
+  def self.disable_providers
+    @@disable_providers
+  end
+
+  def self.disable_providers=(providers)
+    @@disable_providers = providers
+  end
+
+  def self.disabled_provider?(provider)
+    disable_providers.map(&:downcase).include?(provider.downcase)
+  end
+
   private
 
   def _select_provider(url, options)
     if provider_const = _providers_const.detect { |p| p.usable?(url) }
-      provider_const.new(url, options)
+      const_provider = provider_const.new(url, options)
+
+      if defined?(const_provider.provider) && const_provider.provider
+        ensure_enabled_provider(const_provider.provider)
+      end
+
+      const_provider
     else
       raise UrlError, "Url is not usable by any Providers: #{url}"
     end
@@ -54,4 +90,10 @@ class VideoInfo
   def _providers_const
     PROVIDERS.map { |p| Providers.const_get(p) }
   end
+
+  def ensure_enabled_provider(provider)
+    if self.class.disabled_provider?(provider)
+      raise UrlError, "#{provider} is disabled"
+    end
+  end
 end

data/lib/video_info/provider.rb

@@ -39,8 +39,25 @@ class VideoInfo
     private
 
     def _response_code
-      response = nil
-      Net::HTTP.start(_api_base, 80) { |http| response = http.head(_api_path) }
+      uri = URI.parse(_api_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if (uri.scheme == 'https')
+        _https_response_code(http)
+      else
+        _http_response_code(http)
+      end
+    end
+
+    def _http_response_code(http)
+      response = http.head(_api_path, @options)
+      response.code
+    end
+
+    def _https_response_code(http)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.head(_api_path, @options)
       response.code
     end
 
@@ -56,8 +73,8 @@ class VideoInfo
       options
     end
 
-    def _set_data_from_api
-      uri = open(_api_url, options)
+    def _set_data_from_api(api_url = _api_url)
+      uri = open(api_url, options)
       MultiJson.load(uri.read)
     end
 

data/lib/video_info/providers/vimeo.rb

@@ -9,7 +9,11 @@ class VideoInfo
         'Vimeo'
       end
 
-      %w[title description thumbnail_small thumbnail_medium thumbnail_large].each do |method|
+      def api_key
+        VideoInfo.provider_api_keys[:vimeo]
+      end
+
+      %w[description].each do |method|
         define_method(method) { _video[method] }
       end
 
@@ -17,8 +21,50 @@ class VideoInfo
         define_method(method) { _video[method].to_i }
       end
 
+      def title
+        _video['name']
+      end
+
+      def author
+        _video['user']['name']
+      end
+
+      def author_thumbnail_id
+        author_uri = _video['user']['pictures']['uri']
+        @author_thumbnail_id ||= _parse_picture_id(author_uri)
+      end
+
+      def author_thumbnail(width = 75)
+        "https://i.vimeocdn.com/portrait/#{author_thumbnail_id}_#{width}x#{width}.jpg"
+      end
+
+      def thumbnail_id
+        @thumbnail_id ||= _parse_picture_id(_video['pictures']['uri'])
+      end
+
+      def thumbnail(width = 200, height = nil)
+        base_uri = "https://i.vimeocdn.com/video/#{thumbnail_id}"
+        height ? base_uri + "_#{width}x#{height}.jpg" : base_uri + "_#{width}.jpg"
+      end
+
+      def thumbnail_small
+        thumbnail(100, 75)
+      end
+
+      def thumbnail_medium
+        thumbnail(200, 150)
+      end
+
+      def thumbnail_large
+        thumbnail(640)
+      end
+
       def keywords
-        _video['tags']
+        keywords_array.join(', ')
+      end
+
+      def keywords_array
+        _video['tags'].map { |t| t['tag'] }
       end
 
       def embed_url
@@ -26,33 +72,55 @@ class VideoInfo
       end
 
       def date
-        Time.parse(_video['upload_date'], Time.now.utc).utc
+        Time.parse(_video['created_time'], Time.now.utc).utc
       end
 
       def view_count
-        _video['stats_number_of_plays'].to_i
+        _video['stats']['plays'].to_i
       end
 
       private
 
+      def _clean_options(options)
+        headers = [super, _authorization_headers, _api_version_headers]
+        headers.inject(&:merge)
+      end
+
+      def _api_version
+        '3.2'
+      end
+
+      def _authorization_headers
+        { 'Authorization' => "bearer #{api_key}" }
+      end
+
+      def _api_version_headers
+        { 'Accept' => "application/vnd.vimeo.*+json;version=#{_api_version}" }
+      end
+
       def _video
-        data && data.first
+        data
       end
 
       def _url_regex
-        /.*\.com\/(?:(?:groups\/[^\/]+\/videos\/)|(?:ondemand|channels)(?:(?:\/less\/)|(?:\/\w*\/))|(?:video\/))?([0-9]+).*$/
+        /.*\.com&&
+        |\/(?:(?:groups\/[^\/]+\/videos\/)
+        |(?:ondemand|channels)(?:(?:\/less\/)
+        |(?:user[0-9]+\/review\/)?([0-9]+).*
+        |(?:\/\w*\/))|(?:video\/))?([0-9]+).*$
+        /x
       end
 
       def _api_base
-        'vimeo.com'
+        'api.vimeo.com'
       end
 
       def _api_path
-        "/api/v2/video/#{video_id}.json"
+        "/videos/#{video_id}"
       end
 
       def _api_url
-        "http://#{_api_base}#{_api_path}"
+        "https://#{_api_base}#{_api_path}"
       end
 
       def _default_iframe_attributes
@@ -65,6 +133,10 @@ class VideoInfo
           portrait: 0,
           autoplay: 0 }
       end
+
+      def _parse_picture_id(uri)
+        /\/pictures\/(\d+)/.match(uri)[1]
+      end
     end
   end
 end

data/lib/video_info/providers/vimeoplaylist.rb

@@ -8,8 +8,10 @@ class VideoInfo
       end
 
       def videos
-        _playlist_video_ids.map do |entry_id|
-          VideoInfo.new("http://vimeo.com/#{entry_id}")
+        @videos ||= _data_videos.map do |video_data|
+          video = Vimeo.new(video_data['link'])
+          video.data = video
+          video
         end
       end
 
@@ -17,7 +19,7 @@ class VideoInfo
         "//player.vimeo.com/hubnut/album/#{playlist_id}"
       end
 
-      %w[width height date keywords duration view_count].each do |method|
+      %w[width height keywords view_count].each do |method|
         define_method(method) { nil }
       end
 
@@ -32,15 +34,19 @@ class VideoInfo
       end
 
       def _api_path
-        "/api/v2/album/#{video_id}/info.json"
+        "/albums/#{playlist_id}"
+      end
+
+      def _api_path_album_videos
+        "/albums/#{playlist_id}/videos"
       end
 
       def _api_videos_path
-        "/api/v2/album/#{video_id}/videos.json"
+        "/videos/#{video_id}"
       end
 
       def _api_videos_url
-        "http://#{_api_base}#{_api_videos_path}"
+        "https://#{_api_base}#{_api_path_album_videos}"
       end
 
       def _data_videos
@@ -49,13 +55,8 @@ class VideoInfo
 
       def _set_videos_from_api
         uri = open(_api_videos_url, options)
-        MultiJson.load(uri.read)
-      end
-
-      def _playlist_video_ids
-        _data_videos.map do |entry|
-          entry['id']
-        end
+        json = MultiJson.load(uri.read)
+        json['data']
       end
     end
   end

data/lib/video_info/providers/vkontakte.rb

@@ -104,7 +104,7 @@ class VideoInfo
         ).encode(
           'UTF-8', undef: :replace
         )
-        !!title.index('Ошибка')
+        !!title.index('Error | VK')
       end
 
       def _get_response_code(response)

data/lib/video_info/providers/youtube.rb

@@ -1,6 +1,20 @@
+require 'iso8601'
+require_relative 'youtube_api'
+require_relative 'youtube_scraper'
+
 class VideoInfo
   module Providers
     class Youtube < Provider
+      def initialize(url, options = {})
+        if VideoInfo.provider_api_keys[:youtube].nil?
+          extend YoutubeScraper
+        else
+          extend YoutubeAPI
+        end
+
+        super(url, options)
+      end
+
       def self.usable?(url)
         url =~ /(youtube\.com\/(?!playlist|embed\/videoseries).*)|(youtu\.be)/
       end
@@ -9,48 +23,27 @@ class VideoInfo
         'YouTube'
       end
 
-      def title
-        _video_entry['title']['$t']
-      end
-
-      %w[description keywords].each do |method|
-        define_method(method) { _video_media_group["media$#{method}"]['$t'] }
-      end
-
       %w[width height].each do |method|
         define_method(method) { nil }
       end
 
-      def duration
-        _video_media_group['yt$duration']['seconds'].to_i
-      end
-
       def embed_url
         "//www.youtube.com/embed/#{video_id}"
       end
 
-      def date
-        Time.parse(_video_entry['published']['$t'], Time.now.utc)
-      end
-
       def thumbnail_small
-        _video_thumbnail(0)
+        return "https://i.ytimg.com/vi/#{video_id}/default.jpg" unless _video_snippet['thumbnails']
+        _video_snippet['thumbnails']['default']['url']
       end
 
       def thumbnail_medium
-        _video_thumbnail(1)
+        return "https://i.ytimg.com/vi/#{video_id}/mqdefault.jpg" unless _video_snippet['thumbnails']
+        _video_snippet['thumbnails']['medium']['url']
       end
 
       def thumbnail_large
-        _video_thumbnail(2)
-      end
-
-      def view_count
-        if _video_entry['yt$statistics']
-          _video_entry['yt$statistics']['viewCount'].to_i
-        else
-          0
-        end
+        return "https://i.ytimg.com/vi/#{video_id}/hqdefault.jpg" unless _video_snippet['thumbnails']
+        _video_snippet['thumbnails']['high']['url']
       end
 
       private
@@ -59,18 +52,6 @@ class VideoInfo
         /(?:youtube(?:-nocookie)?\.com\/(?:[^\/]+\/.+\/|(?:v|e(?:mbed)?)\/|.*[?&]v=)|youtu\.be\/)([^"&?\/ ]{11})/i
       end
 
-      def _api_base
-        "gdata.youtube.com"
-      end
-
-      def _api_path
-        "/feeds/api/videos/#{video_id}?v=2&alt=json"
-      end
-
-      def _api_url
-        "http://#{_api_base}#{_api_path}"
-      end
-
       def _default_iframe_attributes
         { allowfullscreen: 'allowfullscreen' }
       end
@@ -78,18 +59,6 @@ class VideoInfo
       def _default_url_attributes
         {}
       end
-
-      def _video_entry
-        data['entry']
-      end
-
-      def _video_media_group
-        data['entry']['media$group']
-      end
-
-      def _video_thumbnail(id)
-        _video_entry['media$group']['media$thumbnail'][id]['url']
-      end
     end
   end
 end