http_content_type 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3bdaf6bde10e228f63867b5994cc3c9e1d6c514
-  data.tar.gz: 99274fe10583a1cbe8d04dd260874b29507ed8ec
+  metadata.gz: 423abcfd36ea5de5ddb56ef406aa65d20c51a2e3
+  data.tar.gz: 41ce1d5652424ebd802464a109a42e8e9e463fbd
 SHA512:
-  metadata.gz: 151838a3c37cb555a9de9aecfb3aa8fa774f75bd1ab30b67c295dbf2aa90ce66488c59120d34c138c99c5e94ddee7f7ad7627e6c915f3ee627a0d13a2e05581c
-  data.tar.gz: 7155b8a36f44e6d8e3000f7743573cd6acae8961acf2b034801aa4ce8391b4f372e3016cdbd7fff1bb87e9a0eaaffde51323b1114fe3c61650c5417091d5aa45
+  metadata.gz: a35dbb8bc55e95a17683f25167798a9090b81cc58c63aab0c8b139628e0ad0a8e71ce939d742a81779ce9ee2a750b54dffa7a28bbb10ec1aabc1d1dfb358fa29
+  data.tar.gz: 0921e556085c0d2428678114eab56c93cdcad58257649ae19efebf72b87e0ca1045ac18fa235d44bc0377aea2dafb44bcd02ca4e22774a52a4b53a04f1f30fbf

data/CHANGELOG.md

@@ -1,7 +1,20 @@
 ## Master
 
-### 0.0.1 - 4 September, 2013
+No changes.
+
+### 0.0.2 - 5 September, 2013 - ([@rymai][])
+
+- Handle redirections & url with query params.
+- Allow to pass options to `HttpContentType::Checker#initialize`.
+- New `:timeout` option to customize the read timeout for the `HEAD` request that checks the `Content-Type` header.
+- New `:expected_content_type` option to hardcode the expected `Content-Type`.
+- New `#error?` method to check if the request on the asset failed for any reason.
+- Default timeout is now 5 seconds (instead of 3).
+- Documentation added for all public methods using Yard.
+
+### 0.0.1 - 4 September, 2013 - ([@rymai][])
+
+- Initial release.
 
-- Initial release. ([@rymai][])
 <!--- The following link definition list is generated by PimpMyChangelog --->
-[@rymai]: https://github.com/rymai
+[@rymai]: https://github.com/rymai

data/lib/http_content_type.rb

@@ -1,2 +1,5 @@
 require 'http_content_type/version'
 require 'http_content_type/checker'
+
+module HttpContentType
+end

data/lib/http_content_type/checker.rb

@@ -3,66 +3,149 @@ require 'net/http'
 module HttpContentType
 
   class Checker
-    UNKNOWN_CONTENT_TYPE_RESPONSE = { 'found' => true, 'content-type' => 'unknown' }
-    FILE_NOT_FOUND_RESPONSE = { 'found' => false, 'content-type' => 'unknown' }
+    class TooManyRedirections < Exception; end
 
-    def initialize(asset_url)
+    DEFAULT_OPTIONS = {
+      timeout: 5
+    }
+
+    attr_accessor :expected_content_type, :options, :last_response
+
+    # Creates a `HttpContentType::Checker` object given an asset URL and
+    # options.
+    #
+    # @param asset_url [String] the asset URL
+    # @param opts [Hash] misc options
+    # @option opts [String] :timeout The read timeout for the `HEAD` request.
+    # @option opts [String] :expected_content_type The expected `Content-Type`
+    #   for the given `asset_url`.
+    # @return [HttpContentType::Checker] the `HttpContentType::Checker` object
+    def initialize(asset_url, opts = {})
       @asset_url = asset_url
+      @expected_content_type = opts.delete(:expected_content_type)
+      @options = DEFAULT_OPTIONS.merge(opts)
+    end
+
+    # Returns true if there was an error requesting the asset. Most common
+    # errors are `HTTPClientError`, `HTTPServerError`, `HTTPUnknownResponse`,
+    # `HttpContentType::TooManyRedirections`. Note that any other (less common)
+    # exceptions are catched as well.
+    #
+    # @return [Boolean] whether or not there was an error while requesting the
+    #   asset.
+    def error?
+      !_head[:error].nil?
     end
 
+    # Returns true if the asset was found (i.e. request returned an
+    # `Net::HTTPSuccess` response).
+    #
+    # Note: You should always check for `#error?` before checking for `#found?`
+    # to be sure you don't assume an asset doesn't exist when the request
+    # actually errored!
+    #
+    # @return [Boolean] whether or not the asset exists
     def found?
-      _head['found']
+      _head[:found]
     end
 
-    def expected_content_type
-      @expected_content_type ||= case File.extname(@asset_url).sub(/^\./, '')
-                                 when 'mp4', 'm4v', 'mov'
-                                   'video/mp4'
-                                 when 'webm'
-                                   'video/webm'
-                                 when 'ogv', 'ogg'
-                                   'video/ogg'
-                                 else
-                                   'unknown'
-                                 end
+    # Returns true if the asset's `Content-Type` is valid according to its
+    # extension.
+    #
+    # Note: This always returns true if `#error?` or `#found?` return true so
+    # be sure to check for `#found?` before checking for
+    # `#valid_content_type?`!
+    #
+    # @return [Boolean] whether or not the asset exists
+    def valid_content_type?
+      error? || !found? || content_type == expected_content_type
     end
 
+    # Returns the `Content-Type` for the actually requested URL.
+    #
+    # Note: If the original URL included query parameters or redirected on
+    # another URL, the `Content-Type` is the one for the actually requested URL
+    # without the query parameters.
+    #
+    # @return [String] the `Content-Type` for the actual asset URL.
+    # @see #expected_content_type
     def content_type
-      _head['content-type']
+      _head[:content_type]
     end
 
-    def valid_content_type?
-      content_type == expected_content_type
+    # Returns the expected `Content-Type` for the actually requested URL, based
+    # on its extension or the `:expected_content_type` option passed when
+    # instantiating the `HttpContentType::Checker` object.
+    #
+    # @return [String] the expected `Content-Type` for the actual asset URL.
+    # @see #content_type
+    def expected_content_type
+      @expected_content_type ||= begin
+        case File.extname(_head[:uri].path).sub(/^\./, '')
+        when 'mp4', 'm4v', 'mov'
+          'video/mp4'
+        when 'webm'
+          'video/webm'
+        when 'ogv', 'ogg'
+          'video/ogg'
+        else
+          'unknown'
+        end
+      end
     end
 
     private
 
-    def _clean_uri
-      @_clean_uri ||= URI.parse(URI.escape(@asset_url))
+    def _head
+      @head ||= _fetch(@asset_url)
     end
 
-    def _head_options
-      @_head_options ||= { use_ssl: _clean_uri.scheme == 'https', read_timeout: 3 }
+    def _connection_options(uri)
+      @_connection_options ||= { use_ssl: uri.scheme == 'https', read_timeout: options[:timeout] }
     end
 
-    def _head
-      @response ||= begin
-        response = Net::HTTP.start(_clean_uri.host, _clean_uri.port, _head_options) do |http|
-          http.head(_clean_uri.path)
-        end
+    def _fetch(url, limit = 10)
+      raise TooManyRedirections if limit == 0
 
-        case response
-        when Net::HTTPSuccess, Net::HTTPRedirection
-          { 'found' => true, 'content-type' => response['content-type'] }
-        when Net::HTTPClientError
-          FILE_NOT_FOUND_RESPONSE
-        else
-          UNKNOWN_CONTENT_TYPE_RESPONSE
-        end
+      uri ||= URI.parse(URI.escape(url))
+      @last_response = Net::HTTP.start(uri.host, uri.port, _connection_options(uri)) do |http|
+        req = Net::HTTP::Head.new(uri.request_uri)
+        http.request(req)
+      end
 
-      rescue
-        UNKNOWN_CONTENT_TYPE_RESPONSE
+      case @last_response
+      when Net::HTTPSuccess
+        _found_response(uri, @last_response)
+      when Net::HTTPRedirection
+        _fetch(@last_response['location'], limit - 1)
+      when HTTPClientError
+        _not_found_response(uri, @last_response)
+      else
+        _errored_response(uri, @last_response)
       end
+
+    rescue => ex
+      puts "Exception from HttpContentType::Checker#_fetch('#{uri}', #{limit}):"
+      puts ex
+      _errored_response(@last_response, error: ex)
+    end
+
+    def _found_response(uri, http_response)
+      _base_response(uri).merge(found: true, error: nil, content_type: http_response['content-type'])
+    end
+
+    def _not_found_response(uri, http_response)
+      _base_response(uri).merge(found: false, error: nil, content_type: 'unknown')
+    end
+
+    def _errored_response(uri, http_response, opts = {})
+      error = opts[:error] || "#{http_response.code}: #{http_response.message}"
+
+      _base_response(uri).merge(found: false, error: error, content_type: 'unknown')
+    end
+
+    def _base_response(uri)
+      { uri: uri }
     end
 
   end

data/lib/http_content_type/version.rb

@@ -1,3 +1,3 @@
 module HttpContentType
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/http_content_type/checker_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+
+require 'http_content_type/checker'
+
+describe HttpContentType::Checker do
+  let(:checker) { described_class.new('http://foo.com/bar.mp4') }
+  subject { checker }
+
+  describe '#initialize' do
+    it 'has default options' do
+      expect(checker.options[:timeout]).to eq 5
+    end
+
+    describe ':timeout options' do
+      it 'is customizable' do
+        checker = described_class.new('http://foo.com/bar.mp4', timeout: 10)
+
+        expect(checker.options[:timeout]).to eq 10
+      end
+    end
+
+    describe ':expected_content_type options' do
+      it 'is customizable' do
+        checker = described_class.new('http://foo.com/dynamic_asset.php', expected_content_type: 'video/mp4')
+
+        expect(checker.expected_content_type).to eq 'video/mp4'
+      end
+    end
+  end
+
+  describe '#error?' do
+    context 'asset do not return an error' do
+      before { checker.stub(:_head).and_return({ found: false, error: nil }) }
+
+      it 'return false' do
+        checker.should_not be_error
+      end
+    end
+
+    context 'asset returns an error' do
+      before { checker.stub(:_head).and_return({ found: false, error: true }) }
+
+      it 'return true' do
+        checker.should be_error
+      end
+    end
+  end
+
+  describe '#found?' do
+    context 'asset is not found' do
+      before { checker.stub(:_head).and_return({ found: false }) }
+
+      it 'return false' do
+        checker.should_not be_found
+      end
+    end
+
+    context 'asset is found' do
+      before { checker.stub(:_head).and_return({ found: true, content_type: 'video/mp4' }) }
+
+      it 'return true' do
+        checker.should be_found
+      end
+    end
+  end
+
+  describe '#expected_content_type' do
+    context '.mp4 video' do
+      subject { described_class.new('http://foo.com/bar.mp4') }
+      its(:expected_content_type) { eq 'video/mp4' }
+    end
+
+    context '.mp4 video with query params' do
+      subject { described_class.new('http://foo.com/bar.mp4?foo=bar') }
+      its(:expected_content_type) { eq 'video/mp4' }
+    end
+
+    context 'given a hardcoded content-type' do
+      subject { described_class.new('http://foo.com/dynamic_asset.php', expected_content_type: 'video/mp4') }
+      its(:expected_content_type) { eq 'video/mp4' }
+    end
+
+    context '.m4v video' do
+      subject { described_class.new('http://foo.com/bar.m4v') }
+      its(:expected_content_type) { eq 'video/mp4' }
+    end
+
+    context '.mov video' do
+      subject { described_class.new('http://foo.com/bar.mov') }
+      its(:expected_content_type) { eq 'video/mp4' }
+    end
+
+    context '.webm video' do
+      subject { described_class.new('http://foo.com/bar.webm') }
+      its(:expected_content_type) { eq 'video/webm' }
+    end
+
+    context '.ogg video' do
+      subject { described_class.new('http://foo.com/bar.ogg') }
+      its(:expected_content_type) { eq 'video/ogg' }
+    end
+
+    context '.ogv video' do
+      subject { described_class.new('http://foo.com/bar.ogv') }
+      its(:expected_content_type) { eq 'video/ogg' }
+    end
+  end
+
+  describe '#content_type' do
+    context 'fake asset has valid content type' do
+      before { checker.stub(:_head).and_return({ found: true, content_type: 'video/mp4' }) }
+
+      it 'returns the actual content type' do
+        expect(checker.content_type).to eq 'video/mp4'
+      end
+    end
+
+    context 'real asset has valid content type' do
+      let(:checker) { described_class.new('http://player.vimeo.com/external/51920681.hd.mp4?s=70273279a571e027c54032e70db61253') }
+
+      it 'returns the actual content type' do
+        expect(checker.content_type).to eq 'video/mp4'
+      end
+    end
+  end
+
+  describe '#valid_content_type?' do
+    context 'asset cannot be found and returns an error' do
+      before { checker.stub(:_head).and_return({ uri: URI('http://foo.com/bar.mp4'), found: false, error: true }) }
+      it { be_valid_content_type }
+    end
+
+    context 'asset cannot be found and do not return an error', :focus do
+      before { checker.stub(:_head).and_return({ uri: URI('http://foo.com/bar.mp4'), found: false, error: nil }) }
+      it { be_valid_content_type }
+    end
+
+    context 'asset is found without an error with valid content type', :focus do
+      before { checker.stub(:_head).and_return({ uri: URI('http://foo.com/bar.mp4'), found: true, error: nil, content_type: 'video/mp4'  }) }
+      it { be_valid_content_type }
+    end
+
+    context 'asset is found without an error with invalid content type', :focus do
+      before { checker.stub(:_head).and_return({ uri: URI('http://foo.com/bar.mov'), found: true, error: nil, content_type: 'video/mov'  }) }
+      it { be_valid_content_type }
+    end
+  end
+
+  describe '#_fetch' do
+    context 'too many redirections' do
+      let(:response) do
+        Net::HTTPRedirection.new('1.1', 302, '').tap do |res|
+          res['content-type'] = 'foo/bar'
+          res['location'] = 'http://domain.com/video.mp4'
+        end
+      end
+      before { Net::HTTP.any_instance.stub(:request).and_return(response) }
+
+      it 'raise a TooManyRedirections exception' do
+        expect { checker.send(:_fetch, 'http://domain.com/video.mp4') }.to raise_error(HttpContentType::TooManyRedirections)
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_content_type
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rémy Coutable
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ files:
 - CHANGELOG.md
 - LICENSE.md
 - README.md
-- spec/http_content_type/checker_spec.rb
+- spec/lib/http_content_type/checker_spec.rb
 - spec/spec_helper.rb
 homepage: http://rubygems.org/gems/http_content_type
 licenses:
@@ -79,5 +79,6 @@ signing_key:
 specification_version: 4
 summary: Check the Content-Type of any HTTP-accessible asset.
 test_files:
-- spec/http_content_type/checker_spec.rb
+- spec/lib/http_content_type/checker_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/http_content_type/checker_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-
-require 'http_content_type/checker'
-
-describe HttpContentType::Checker do
-  let(:checker) { described_class.new('http://foo.com/bar.mp4') }
-
-  describe '#found?' do
-    context 'asset is not found' do
-      before { checker.stub(:_head).and_return({ 'found' => false }) }
-
-      it 'return false' do
-        checker.should_not be_found
-      end
-    end
-
-    context 'asset is found' do
-      before { checker.stub(:_head).and_return({ 'found' => true, 'content-type' => 'video/mp4' }) }
-
-      it 'return true' do
-        checker.should be_found
-      end
-    end
-  end
-
-  describe '#expected_content_type' do
-    context '.mp4 video' do
-      subject { described_class.new('http://foo.com/bar.mp4') }
-      its(:expected_content_type) { eq 'video/mp4' }
-    end
-
-    context '.m4v video' do
-      subject { described_class.new('http://foo.com/bar.m4v') }
-      its(:expected_content_type) { eq 'video/mp4' }
-    end
-
-    context '.mov video' do
-      subject { described_class.new('http://foo.com/bar.mov') }
-      its(:expected_content_type) { eq 'video/mp4' }
-    end
-
-    context '.webm video' do
-      subject { described_class.new('http://foo.com/bar.webm') }
-      its(:expected_content_type) { eq 'video/webm' }
-    end
-
-    context '.ogg video' do
-      subject { described_class.new('http://foo.com/bar.ogg') }
-      its(:expected_content_type) { eq 'video/ogg' }
-    end
-
-    context '.ogv video' do
-      subject { described_class.new('http://foo.com/bar.ogv') }
-      its(:expected_content_type) { eq 'video/ogg' }
-    end
-  end
-
-  describe '#content_type' do
-    context 'asset has valid content type' do
-      before { checker.stub(:_head).and_return({ 'found' => true, 'content-type' => 'video/mp4' }) }
-
-      it 'returns the actual content type' do
-        expect(checker.content_type).to eq 'video/mp4'
-      end
-    end
-  end
-
-  describe '#valid_content_type?' do
-    context 'asset has valid content type' do
-      before { checker.stub(:_head).and_return({ 'found' => true, 'content-type' => 'video/mp4' }) }
-
-      it 'returns true' do
-        checker.should be_valid_content_type
-      end
-    end
-
-    context 'asset has invalid content type' do
-      before { checker.stub(:_head).and_return({ 'found' => true, 'content-type' => 'video/mov' }) }
-
-      it 'returns false' do
-        checker.should_not be_valid_content_type
-      end
-    end
-  end
-
-end