video_info 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2cda17be09315cfde97837ef1d83079603b078c
-  data.tar.gz: 348006204240253cb21171460f6ece7233a7a7bb
+  metadata.gz: 18c94c937caae05276816dd3ed8ebe10df074b0b
+  data.tar.gz: 61a33b65f281e74192fd355574616281b2ef2eb9
 SHA512:
-  metadata.gz: 8a9698723a90069f7384a468dc2e4e7966dd24a45fa089d9db4fd12875fcbd692b883479cd7b35799e47a4fea45044a738d3289742cac52a380eb180620b5974
-  data.tar.gz: 9790babb47a770171278319207be12d69186e42b7cda66ab2914f3b62d127600584ef88d1711836a037aab44cb98d2602b587ca1bd4d0d2bbda427b172583924
+  metadata.gz: 06a186d5c3fea88716f226090c797a82bbee92f1180683b5963fc96684d87c37b2eb6b25b18a2016eeca714023c7c86f3c0b558dce3dbc0881bad507c4917d07
+  data.tar.gz: 99f37329ca0c12666afd6f58e9f68af88dc62fe8d62a67ec542a074569bdd1b311c1f21fd86a56eb20ee1a7be4f8a576ffdd372050f808b439e3d8bb9f69d201

data/.gitignore

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

data/.rubocop.yml

@@ -1,2 +1,243 @@
-StringLiterals:
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "db/schema.rb"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
   EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 sudo: false
-bundler_args: --without tool
+dist: trusty
+cache: bundler
 rvm:
-  - 2.2.0
-  - jruby
-  - rbx
-matrix:
-  allow_failures:
-    - rvm: rbx
-    - rvm: jruby
+  - 2.2.4
+  - 2.3.0
+  - jruby-head
+  - rbx-2
+jdk:
+  - oraclejdk8
 before_install:
+  - gem install bundler
   - gem update bundler

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+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
+* 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, 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,4 +1,4 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in video_info.gemspec
 gemspec

data/Guardfile

@@ -2,7 +2,7 @@
 # More info at http://github.com/guard/guard#readme
 
 guard 'rspec', keep_failed: false do
-  watch('spec/spec_helper.rb') { "spec" }
+  watch('spec/spec_helper.rb') { 'spec' }
   watch(%r{lib/(.+)\.rb})      { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{spec/.+_spec\.rb})
 end

data/README.md

@@ -4,7 +4,15 @@
 
 Simple Ruby Gem to get video info from Dailymotion, VK, Vimeo, Wistia and YouTube (with playlist).
 
-Tested against Ruby 2.2.0 and the latest versions of JRuby & Rubinius.
+Tested against Ruby 2.3.0, 2.2.4, and the latest versions of JRuby & Rubinius.
+
+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
 --------
@@ -53,6 +61,9 @@ video = VideoInfo.new("http://vimeo.com/898029")
 # video.provider         => 'Vimeo'
 # video.title            => 'Cherry Bloom - King Of The Knife'
 # video.description      => 'The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net'
+# video.author           => 'Octave Zangs'
+# video.author_thumbnail => 'https://i.vimeocdn.com/portrait/2577152_75x75.jpg'
+# video.author_url       => 'https://vimeo.com/octave'
 # video.keywords         => 'alternative, bloom, cherry, clip, drum, guitar, king, knife, of, Paris-Forum, rock, the, tremplin'
 # video.duration         => 175 (in seconds)
 # video.date             => Mon Apr 14 13:10:39 +0200 2008
@@ -78,11 +89,27 @@ video = VideoInfo.new("http://fast.wistia.com/embed/medias/pxonqr42is")
 # video.embed_url        => '//fast.wistia.net/embed/iframe/pxonqr42is'
 # video.embed_code       => "<iframe src='//fast.wistia.net/embed/iframe/pxonqr42is' frameborder='0'></iframe>"
 
+video = VideoInfo.new('http://vk.com/video39576223_108370515')
+# video.available?       => true
+# video.provider         => "Vkontakte"
+# video.video_id         => "108370515"
+# video.author           => "Alexander Maslov"
+# video.author_thumbnail => "https://pp.vk.me/c624521/v624521223/3c288/lVcVW7LNnrQ.jpg"
+# video.author_url       => "https://vk.com/videos39576223"
+# video.title            => "Я уточка)))))"
+# video.description      => "это ВЗРЫВ МОЗГА!!!<br>Просто отвал башки..."
+# video.duration         => 183 (in seconds)
+# video.embed_url        => "//vk.com/video_ext.php?oid=39576223&id=108370515&hash=15184dbd085c47af"
+# video.embed_code       => "<iframe src=\"//vk.com/video_ext.php?oid=39576223&id=108370515&hash=15184dbd085c47af\" frameborder=\"0\" allowfullscreen=\"allowfullscreen\"></iframe>"
+
 video = VideoInfo.new("http://www.youtube.com/watch?v=mZqGqE0D0n4")
 # video.available?       => true
 # video.video_id         => 'mZqGqE0D0n4'
 # video.provider         => 'YouTube'
 # video.title            => 'Cherry Bloom - King Of The Knife'
+# video.author           => 'Cherry Bloom'
+# video.author_thumbnail => 'https://yt3.ggpht.com/-7rhnfdQaI3k/AAAAAAAAAAI/AAAAAAAAAAA/eMJZ5HBukCQ/s88-c-k-no/photo.jpg'
+# video.author_url       => 'https://www.youtube.com/channel/UCzxQk-rZGowoqMBKxGD5jSA'
 # video.description      => 'The first video from the upcoming album Secret Sounds, to download in-stores April 14. Checkout http://www.cherrybloom.net'
 # video.duration         => 175 (in seconds)
 # video.date             => Sat Apr 12 22:25:35 UTC 2008
@@ -97,12 +124,16 @@ playlist = VideoInfo.new("http://www.youtube.com/playlist?p=PL9hW1uS6HUftLdHI6RI
 # playlist.playlist_id         => 'PL9hW1uS6HUftLdHI6RIsaf'
 # playlist.provider            => 'YouTube'
 # playlist.title               => 'YouTube Policy and Copyright'
+# playlist.author              => 'YouTube Help'
+# playlist.author_thumbnail    => 'https://yt3.ggpht.com/-ni_VaN38-AE/AAAAAAAAAAI/AAAAAAAAAAA/bJCTTfihBl0/s100-c-k-no/photo.jpg'
+# playlist.author_url          => 'https://www.youtube.com/user/YouTubeHelp'
 # playlist.thumbnail_small     => 'http://i.ytimg.com/vi/8b0aEoxqqC0/default.jpg'
 # playlist.thumbnail_medium    => 'http://i.ytimg.com/vi/8b0aEoxqqC0/mqdefault.jpg'
 # playlist.thumbnail_large     => 'http://i.ytimg.com/vi/8b0aEoxqqC0/hqdefault.jpg'
 # playlist.embed_url           => 'http://www.youtube.com/embed/videoseries?list=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr'
 # playlist.embed_code          => "<iframe src='//www.youtube.com/embed/videoseries?list=PL9hW1uS6HUftLdHI6RIsaf-iXTm09qnEr' frameborder='0' allowfullscreen='allowfullscreen'></iframe>"
 # playlist.videos              => [VideoInfo.new('http://www.youtube.com/watch?v=_Bt3-WsHfB0'), VideoInfo.new('http://www.youtube.com/watch?v=9g2U12SsRns'), VideoInfo.new('http://www.youtube.com/watch?v=8b0aEoxqqC0'), VideoInfo.new('http://www.youtube.com/watch?v=6c3mHikRz0I'), VideoInfo.new('http://www.youtube.com/watch?v=OQVHWsTHcoc')]
+```
 
 Options
 -------
@@ -145,6 +176,7 @@ 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
 ------
 
@@ -154,6 +186,7 @@ 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

data/lib/video_info.rb

@@ -11,6 +11,22 @@ class VideoInfo
 
   class << self
     attr_writer :logger
+    attr_accessor :disable_providers, :provider_api_keys
+
+    def disable_providers
+      @disable_providers || []
+    end
+
+    def provider_api_keys
+      @provider_api_keys || {}
+    end
+
+    def 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
 
     def logger
       @logger ||= Logger.new($stdout).tap do |lgr|
@@ -24,18 +40,21 @@ class VideoInfo
   PROVIDERS = %w[
     Dailymotion Vkontakte Wistia
     Vimeo Youtube YoutubePlaylist
-  ]
+  ].freeze
   PROVIDERS.each { |p| require "video_info/providers/#{p.downcase}" }
 
   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,
+                 :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, :author, :author_thumbnail, :author_url
   def_delegators :@provider, :data=
 
   def initialize(url, options = {})
@@ -57,29 +76,6 @@ 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