film_snob 0.3.13 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e540dd00b0161a2fe79ce95e2abb04cb17370ee
-  data.tar.gz: ca75a3474f8708646a051f3f5de1bbbf8f129f95
+  metadata.gz: 1acb76c2c15e8ea0c82ec3aab3132d2b0e5b0f7c
+  data.tar.gz: 2a55b8d551947ceab6109a286110843d9cf6a6d9
 SHA512:
-  metadata.gz: 8944edd5a9572e080c14178f968fd584ec9a1c8c1f57e15cb4b93c86d4b1dcd306209f12d74dc30c26e0538f1499387d4da79415eed8d757bc1ab4a1829758bb
-  data.tar.gz: b7790ee53b97c0e9f86b1c009a80482b4ca8e4f5c8f12b623d729c76c4440501ce238d0d6df55d487c816dbd619596d4900ba32ec7871ad65c50f4a713f8220c
+  metadata.gz: 8f2ec020294584d776de1787c3ddf01d968757a7ad335cb1599005fb68d59c2f7ee62091421cf13fa7c8cb7a76ab4478618252de353fb53afd2c448f6c3a8996
+  data.tar.gz: 863ced2514af6a67874e11de5e896dc49c17a08404c94c18bf600c96caacc5c0851eed56ea73960ba4a6a157171717adde78bd33085f5056c0b4f6a79fc6a262

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+spec/cassettes/**/*.yml

data/.hound.yml

@@ -0,0 +1,3 @@
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,61 @@
+Style/CollectionMethods:
+  # Mapping from undesired method to desired_method
+  # e.g. to use `detect` over `find`:
+  #
+  # CollectionMethods:
+  #   PreferredMethods:
+  #     find: detect
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    reduce: 'inject'
+    detect: 'find'
+    select: 'find_all'
+
+# Disabling this because I don't love using the return keyword
+# and sometimes lines get long and difficult to read that way
+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
+
+# I don't want to write documentation for every class
+Style/Documentation:
+  Description: "Document classes and non-namespace modules."
+  Enabled: false
+
+# I will use the %r syntax even if there's only one slash
+Style/RegexpLiteral:
+  Description: >-
+                 Use %r for regular expressions matching more than
+                 `MaxSlashes` "/" characters.
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#percent-r"
+  MaxSlashes: 0
+  Enabled: true
+
+# I prefer raise to fail, so I'm disabling this one
+Style/SignalException:
+  Description: "Checks for proper usage of fail and raise."
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#fail-method"
+  Enabled: false
+
+# I prefer double quotes
+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: double_quotes
+
+# Expect a final blank line
+Style/TrailingBlankLines:
+  Description: "Checks trailing blank lines and final newline."
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#newline-eof"
+  Enabled: true
+  EnforcedStyle: final_blank_line
+
+# I like to use assignment in conditions
+Lint/AssignmentInCondition:
+  Description: "Don't use assignment in conditions."
+  StyleGuide: "https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition"
+  Enabled: false
+

data/.travis.yml

@@ -4,4 +4,12 @@ rvm:
   - 2.0.0
   - 2.1.0
   - 2.1.1
-before_install: 'gem install bundler -v 1.6'
+  - 2.1.2
+  - 2.1.3
+  - 2.1.4
+  - 2.1.5
+before_install: "gem install bundler -v 1.6"
+script:
+  - bundle exec rake
+  - bundle exec rubocop
+

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in film_snob.gemspec
 gemspec
+

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/maxjacobson/film_snob.svg?branch=master)](https://travis-ci.org/maxjacobson/film_snob)
 [![Gem Version](https://badge.fury.io/rb/film_snob.svg)](http://badge.fury.io/rb/film_snob)
 [![Code Climate](https://codeclimate.com/github/maxjacobson/film_snob.png)](https://codeclimate.com/github/maxjacobson/film_snob)
+[![Test Coverage](https://codeclimate.com/github/maxjacobson/film_snob/badges/coverage.svg)](https://codeclimate.com/github/maxjacobson/film_snob)
 
 Helps parse URLs of web videos.
 
@@ -10,7 +11,7 @@ Helps parse URLs of web videos.
 
 Add this line to your application's Gemfile:
 
-    gem 'film_snob'
+    gem "film_snob"
 
 And then execute:
 
@@ -24,7 +25,7 @@ Or install it yourself as:
 
 ```ruby
 film = FilmSnob.new("https://www.youtube.com/watch?v=GwT3zH16w3s")
-film.watchable? #=> true
+film.embeddable? #=> true
 film.site       #=> :youtube
 film.id         #=> "GwT3zH16w3s"
 film.title      #=> "What Are You, The Coolest? With Robert Rodriguez"
@@ -57,10 +58,21 @@ The same methods work with all of these providers.
 
 Run `rake` to run all of the rspecs.
 
+## Code Style
+
+Run `rubocop` and try to keep the cops happy.
+
+## Questions?
+
+[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/maxjacobson/film_snob?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Ping me in [the Gitter chat room](https://gitter.im/maxjacobson/film_snob) or [create a GitHub issue](https://github.com/maxjacobson/film_snob/issues/new)
+
 ## Contributing
 
 1. Fork it ( https://github.com/maxjacobson/film_snob/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -am "Add some feature"`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+

data/Rakefile

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

data/film_snob.gemspec

@@ -1,15 +1,16 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'film_snob/version'
+require "film_snob/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "film_snob"
   spec.version       = FilmSnob::VERSION
   spec.authors       = ["Max Jacobson"]
   spec.email         = ["max@hardscrabble.net"]
-  spec.summary       = %q{Fetch embed codes for videos}
-  spec.description   = %q{Find information about URLs from video sites, such as the title and embed code of the video}
+  spec.summary       = "Fetch embed codes for videos"
+  spec.description   = "Find information about URLs from video sites, " \
+                       "such as the title and embed code of the video"
   spec.homepage      = "https://github.com/maxjacobson/film_snob"
   spec.license       = "MIT"
 
@@ -24,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock",  "~> 1.17"
   spec.add_development_dependency "vcr",      "~> 2.9"
   spec.add_development_dependency "pry",      "~> 0.9"
-
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.add_development_dependency "rubocop",  "~> 0.26.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.required_ruby_version = ">= 1.9.3"
 end
+

data/lib/film_snob/coub.rb

@@ -2,7 +2,6 @@ require "film_snob/video_site"
 
 class FilmSnob
   class Coub < VideoSite
-
     def self.valid_url_patterns
       [
         %r{https?://coub.com/view/(\w*)}
@@ -14,8 +13,8 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      'http://coub.com/api/oembed.json'
+      "http://coub.com/api/oembed.json"
     end
-
   end
 end
+

data/lib/film_snob/dailymotion.rb

@@ -2,11 +2,10 @@ require "film_snob/video_site"
 
 class FilmSnob
   class Dailymotion < VideoSite
-
     def self.valid_url_patterns
       [
         %r{https?://www.dailymotion.com/video/([\w\d\-_]+)},
-        %r{https?://touch.dailymotion.com/video/([\w\d\-_]+)},
+        %r{https?://touch.dailymotion.com/video/([\w\d\-_]+)}
       ]
     end
 
@@ -15,8 +14,8 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      'http://www.dailymotion.com/services/oembed'
+      "http://www.dailymotion.com/services/oembed"
     end
-
   end
 end
+

data/lib/film_snob/deprecated.rb

@@ -0,0 +1,13 @@
+class FilmSnob
+  module Deprecated
+    def deprecated_alias(previous, replacement, options)
+      define_method(previous) do |*args, &block|
+        Kernel.warn "WARNING: ##{previous} is deprecated and " \
+                    "will be removed in #{options[:removed_in]}. " \
+                    "Please use ##{replacement} instead."
+        send(replacement, *args, &block)
+      end
+    end
+  end
+end
+

data/lib/film_snob/exceptions.rb

@@ -2,3 +2,4 @@ class FilmSnob
   class NotSupportedURLError < StandardError; end
   class NotEmbeddableError < StandardError; end
 end
+

data/lib/film_snob/funny_or_die.rb

@@ -15,3 +15,4 @@ class FilmSnob
     end
   end
 end
+

data/lib/film_snob/hulu.rb

@@ -1,6 +1,5 @@
 class FilmSnob
   class Hulu < VideoSite
-
     def self.valid_url_patterns
       [
         %r{https?://(?:(?:www).)?hulu.com/watch/(\d+)}
@@ -8,12 +7,12 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      'http://www.hulu.com/api/oembed.json'
+      "http://www.hulu.com/api/oembed.json"
     end
 
     def clean_url
       @clean_url ||= "http://www.hulu.com/watch/#{id}"
     end
-
   end
 end
+

data/lib/film_snob/instagram.rb

@@ -10,7 +10,7 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      'http://api.instagram.com/oembed'
+      "http://api.instagram.com/oembed"
     end
 
     def clean_url
@@ -18,11 +18,20 @@ class FilmSnob
     end
 
     def html
-      # instagram's oembed response does not include html, so we need to construct it
+      # instagram's oembed response does not include html,
+      # so we need to construct it
       # but first we need to ensure that the response was good
       # which we do by checking for the presence of the title,
-      # which will raise an exception if it's not present
-      title && %{<iframe src="//instagram.com/p/#{id}/embed/" width="612" height="710" frameborder="0" scrolling="no" allowtransparency="true"></iframe>}
+      # which will raise an exception if it"s not present
+      title && constructed_html
+    end
+
+    private
+
+    def constructed_html
+      "<iframe src='//instagram.com/p/#{id}/embed/' width='612' height='710' " \
+      "frameborder='0' scrolling='no' allowtransparency='true'></iframe>"
     end
   end
 end
+

data/lib/film_snob/url_to_video.rb

@@ -8,7 +8,6 @@ require "film_snob/dailymotion"
 
 class FilmSnob
   class UrlToVideo
-
     VIDEO_SITES = [
       Vimeo,
       YouTube,
@@ -27,18 +26,18 @@ class FilmSnob
     end
 
     def video
-      site.nil?? nil : site.new(url, options)
+      site.nil? ? nil : site.new(url, options)
     end
 
     private
 
-      def site
-        @site ||= VIDEO_SITES.find do |site|
-          site.valid_url_patterns.any? do |pattern|
-            pattern.match(url)
-          end
+    def site
+      @site ||= VIDEO_SITES.find do |site|
+        site.valid_url_patterns.any? do |pattern|
+          pattern.match(url)
         end
       end
-
+    end
   end
 end
+

data/lib/film_snob/version.rb

@@ -1,3 +1,4 @@
 class FilmSnob
-  VERSION = "0.3.13"
+  VERSION = "0.4.0"
 end
+

data/lib/film_snob/video_site.rb

@@ -1,10 +1,9 @@
-require 'net/http'
-require 'json'
+require "net/http"
+require "json"
 
 class FilmSnob
   class VideoSite
     attr_reader :url, :options
-
     def initialize(url, options)
       @url = url
       @options = options
@@ -15,7 +14,7 @@ class FilmSnob
     end
 
     def site
-      @site ||= self.class.to_s.split('::').last.downcase.to_sym
+      @site ||= self.class.to_s.split("::").last.downcase.to_sym
     end
 
     def self.valid_url_patterns
@@ -23,7 +22,7 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      ''
+      ""
     end
 
     def self.http
@@ -33,7 +32,7 @@ class FilmSnob
     end
 
     def self.use_ssl?
-      'https' == uri.scheme
+      "https" == uri.scheme
     end
 
     def title
@@ -46,43 +45,43 @@ class FilmSnob
 
     private
 
-      def not_embeddable!
-        raise NotEmbeddableError, "#{clean_url} is not embeddable"
-      end
+    def not_embeddable!
+      raise NotEmbeddableError, "#{clean_url} is not embeddable"
+    end
 
-      def self.uri
-        URI.parse(oembed_endpoint)
-      end
+    def self.uri
+      URI.parse(oembed_endpoint)
+    end
 
-      def lookup(attribute)
-        oembed[attribute.to_s] || not_embeddable!
-      end
+    def lookup(attribute)
+      oembed[attribute.to_s] || not_embeddable!
+    end
 
-      def matching_pattern
-        self.class.valid_url_patterns.find do |pattern|
-          pattern.match(url)
-        end
+    def matching_pattern
+      self.class.valid_url_patterns.find do |pattern|
+        pattern.match(url)
       end
+    end
 
-      def oembed
-        @oembed ||= JSON.parse response.body
-      rescue
-        @oembed = {}
-      end
+    def oembed
+      @oembed ||= JSON.parse response.body
+    rescue
+      @oembed = {}
+    end
 
-      def response
-        self.class.http.request get
-      end
+    def response
+      self.class.http.request get
+    end
 
-      def get
-        Net::HTTP::Get.new uri.request_uri
-      end
+    def get
+      Net::HTTP::Get.new uri.request_uri
+    end
 
-      def uri
-        URI(self.class.oembed_endpoint).tap do |uri|
-          uri.query = URI.encode_www_form({ url: clean_url }.merge(options))
-        end
+    def uri
+      URI(self.class.oembed_endpoint).tap do |uri|
+        uri.query = URI.encode_www_form({ url: clean_url }.merge(options))
       end
-
+    end
   end
 end
+

data/lib/film_snob/vimeo.rb

@@ -2,7 +2,6 @@ require "film_snob/video_site"
 
 class FilmSnob
   class Vimeo < VideoSite
-
     def self.valid_url_patterns
       [
         %r{https?://vimeo.com/(\d{1,})},
@@ -16,8 +15,8 @@ class FilmSnob
     end
 
     def self.oembed_endpoint
-      'http://vimeo.com/api/oembed.json'
+      "http://vimeo.com/api/oembed.json"
     end
-
   end
 end
+

data/lib/film_snob/youtube.rb

@@ -1,20 +1,22 @@
 class FilmSnob
   class YouTube < VideoSite
-
     def self.valid_url_patterns
       [
-        %r{https?://(?:(?:www|m).)?youtube.com/watch\?(?:feature=[\w\.]+&)?v=([\w\d\-_]+)},
+        %r{
+          https?://(?:(?:www|m).)?youtube.com/watch\?
+          (?:feature=[\w\.]+&)?v=([\w\d\-_]+)
+        }x,
         %r{https?://(?:(?:www|m).)?youtu.be/([\w\d\-_]+)}
       ]
     end
 
     def self.oembed_endpoint
-      'https://www.youtube.com/oembed'
+      "https://www.youtube.com/oembed"
     end
 
     def clean_url
       @clean_url ||= "https://www.youtube.com/watch?v=#{id}"
     end
-
   end
 end
+

data/lib/film_snob.rb

@@ -1,19 +1,24 @@
 require "film_snob/version"
 require "film_snob/url_to_video"
 require "film_snob/exceptions"
+require "film_snob/deprecated"
 
 class FilmSnob
   attr_reader :url
 
-  def initialize(url, options={})
+  extend Deprecated
+
+  def initialize(url, options = {})
     @url = url
     @video = UrlToVideo.new(url, options).video
   end
 
-  def watchable?
+  def embeddable?
     !@video.nil?
   end
 
+  deprecated_alias :watchable?, :embeddable?, removed_in: "v1.0.0"
+
   def method_missing(message)
     if delegated_video_methods.include?(message)
       video.send(message)
@@ -24,17 +29,16 @@ class FilmSnob
 
   private
 
-    def video
-      if watchable?
-        @video
-      else
-        raise NotSupportedURLError, "#{url} is not a supported URL"
-      end
-    end
-
-    def delegated_video_methods
-      [:site, :id, :clean_url, :title, :html]
+  def video
+    if embeddable?
+      @video
+    else
+      raise NotSupportedURLError, "#{url} is not a supported URL"
     end
+  end
 
+  def delegated_video_methods
+    [:site, :id, :clean_url, :title, :html]
+  end
 end
 

data/spec/deprecated_spec.rb

@@ -0,0 +1,32 @@
+require_relative "spec_helper"
+
+class FilmSnob
+  describe Deprecated do
+
+    class Dog
+      extend Deprecated
+
+      deprecated_alias :woof, :bark, removed_in: "v4.0.0"
+
+      def bark
+        "bark"
+      end
+    end
+
+    let(:milo) { Dog.new }
+
+    describe "deprecated_alias" do
+      it "does not interfere with the current method" do
+        expect(Kernel).to_not receive(:warn)
+        milo.bark
+      end
+
+      it "creates an alias" do
+        expect(milo).to respond_to :woof
+        expect(Kernel).to receive(:warn)
+        expect(milo.woof).to eq "bark"
+      end
+    end
+  end
+end
+