oh-my-embed 1.0.0

data/spec/fixtures/vcr_cassettes/youtube.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.youtube.com/oembed?format=json&url=http://www.youtube.com/watch?v=EErY75MXYXI
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Cache-Control:
+      - no-cache
+      X-Content-Type-Options:
+      - nosniff
+      X-Xss-Protection:
+      - 1; mode=block; report=https://www.google.com/appserve/security-bugs/log/youtube
+      Strict-Transport-Security:
+      - max-age=604800
+      P3p:
+      - CP="This is not a P3P policy! See http://support.google.com/accounts/answer/151657?hl=en
+        for more info."
+      Expires:
+      - Tue, 27 Apr 1971 19:44:06 EST
+      Date:
+      - Sun, 08 May 2016 09:52:44 GMT
+      Server:
+      - Ytfe_Worker
+      Alternate-Protocol:
+      - 443:quic
+      Alt-Svc:
+      - quic=":443"; ma=2592000; v="33,32,31,30,29,28,27,26,25"
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"author_name": "NyaAnimeParty", "author_url": "https:\/\/www.youtube.com\/user\/NyaAnimeParty",
+        "thumbnail_url": "https:\/\/i.ytimg.com\/vi\/EErY75MXYXI\/hqdefault.jpg",
+        "provider_name": "YouTube", "title": "Nyan Cat - 24 Hour Edition", "type":
+        "video", "version": "1.0", "height": 344, "thumbnail_height": 360, "width":
+        459, "thumbnail_width": 480, "provider_url": "https:\/\/www.youtube.com\/",
+        "html": "\u003ciframe width=\"459\" height=\"344\" src=\"https:\/\/www.youtube.com\/embed\/EErY75MXYXI?feature=oembed\"
+        frameborder=\"0\" allowfullscreen\u003e\u003c\/iframe\u003e"}'
+    http_version: 
+  recorded_at: Sun, 08 May 2016 09:52:44 GMT
+recorded_with: VCR 3.0.1

data/spec/oh_my_embed/crawler_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+class OhMyEmbed::Providers::BuildInDummy < OhMyEmbed::Provider
+  self.schemes = [
+    '//*.example.com/*'
+  ]
+end
+
+describe OhMyEmbed::Crawler do
+  let(:crawler) { OhMyEmbed::Crawler.new }
+  let(:url) { 'http://www.example.com/my-content' }
+
+  describe '#initialize' do
+    it 'holds the providers in a set' do
+      expect(crawler.providers).to be_a Set
+    end
+
+    it 'register the default providers with option all: true' do
+      expect_any_instance_of(OhMyEmbed::Crawler).to receive(:register_all_build_in_providers)
+
+      OhMyEmbed::Crawler.new all: true
+    end
+
+    it 'calls register with all given args' do
+      expect_any_instance_of(OhMyEmbed::Crawler).to receive(:register).with(:a)
+      expect_any_instance_of(OhMyEmbed::Crawler).to receive(:register).with(:b)
+
+      OhMyEmbed::Crawler.new :a, :b
+    end
+  end
+
+  describe '#register' do
+    it 'finds the provider by symbol and add it to the providers list' do
+      expect{ crawler.register(:build_in_dummy) }.to change{ crawler.providers.count }.from(0).to(1)
+      expect(crawler.providers.first).to be OhMyEmbed::Providers::BuildInDummy
+    end
+
+    it 'it add the provider class to the providers list' do
+      expect{ crawler.register(OhMyEmbed::Providers::BuildInDummy) }.to change{ crawler.providers.count }.from(0).to(1)
+      expect(crawler.providers.first).to be OhMyEmbed::Providers::BuildInDummy
+    end
+
+    it 'raises an error if no provider class found' do
+      expect{ crawler.register :yolo }.to raise_error OhMyEmbed::UnknownProvider
+    end
+  end
+
+  describe '#register_all_build_in_providers' do
+    it 'adds all the build-in providers' do
+      expect{ crawler.register_all_build_in_providers }.to change{ crawler.providers.count }
+      expect(crawler.providers.include?(OhMyEmbed::Providers::BuildInDummy)).to be true
+    end
+  end
+
+  describe '#build_in_providers' do
+    it 'returns a symbols array with all build in providers' do
+      build_in_providers = crawler.build_in_providers
+      expect(build_in_providers).to be_a Array
+      expect(build_in_providers.all?{ |p| p.is_a? Symbol }).to be true
+      expect(build_in_providers.include?(:BuildInDummy)).to be true
+    end
+  end
+
+  context 'crawler with a dummy provider' do
+    before do
+      crawler.register :build_in_dummy
+    end
+
+    describe '#fetch' do
+      it 'calls fetch on the found provider and return an OhMyEmbed::Response' do
+        expect(OhMyEmbed::Providers::BuildInDummy).to receive(:fetch).with(url).and_return(OhMyEmbed::Response.new(OhMyEmbed::Providers::BuildInDummy, url))
+        response = crawler.fetch(url)
+
+        expect(response).to be_a OhMyEmbed::Response
+      end
+    end
+
+    describe '#provider_for' do
+      it 'raises a OhMyEmbed::UnknownProvider error if nothing matched' do
+        expect{ crawler.provider_for('https://google.de/content') }.to raise_error OhMyEmbed::ProviderNotFound
+      end
+
+      it 'finds and return the matching provider' do
+        provider = crawler.provider_for(url)
+        expect(provider).to be OhMyEmbed::Providers::BuildInDummy
+      end
+    end
+
+    describe '#embeddable?' do
+      it 'returns true for an url that matches a provider schema' do
+        expect(crawler.embeddable?(url)).to be true
+      end
+
+      it 'returns false if no provider matches' do
+        expect(crawler.embeddable?('https://google.de/content')).to be false
+      end
+    end
+  end
+end

data/spec/oh_my_embed/provider_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+class DummyProvider < OhMyEmbed::Provider
+  self.provider_name = 'My Dummy Provider'
+  self.endpoint = 'https://www.example.com/api/oembed'
+  self.schemes = [
+    '//*.example.com/*',
+    'http://www.example.com/*/*',
+  ]
+  self.custom_mapping = {
+    'type' => 'custom_type'
+  }
+end
+
+describe OhMyEmbed::Provider do
+  describe '::regex' do
+    it 'returns a union regex to match both url schemes' do
+      regex = DummyProvider.regex
+      expect(regex).to match 'https://www.example.com/yolo'
+      expect(regex).to match 'http://www.example.com/x/y'
+    end
+  end
+
+  describe '::regexify' do
+    it 'does nothing with an Regexp object' do
+      regex = Regexp.new('.*')
+      expect(DummyProvider.regexify(regex)).to be regex
+    end
+
+    it 'creates a regular expression from string' do
+      result = DummyProvider.regexify(DummyProvider.schemes.last)
+      expect(result).to be_a Regexp
+      expect(result).to eq /^http:\/\/www\.example\.com\/(.*?)\/(.*?)$/i
+      expect(result).to match 'http://www.example.com/yolo/swag'
+    end
+
+    it 'prepends http and https if no protocol given' do
+      result = DummyProvider.regexify(DummyProvider.schemes.first)
+      expect(result).to be_a Regexp
+      expect(result).to eq /^(https:|http:)\/\/(.*?)\.example\.com\/(.*?)$/i
+      expect(result).to match 'https://rofl.example.com/yolo'
+    end
+  end
+
+  describe '#fetch' do
+    it 'requests the providers endpoint with correct params' do
+      stub = stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_return do |request|
+        params = CGI::parse(request.uri.query)
+        expect(params['format'].first).to eq 'json'
+        expect(params['url'].first).to eq 'http://example.com/my/content'
+
+        { body: '{}' }
+      end
+
+      DummyProvider.fetch('http://example.com/my/content')
+
+      expect(stub).to have_been_requested
+    end
+
+    it 'fails with an OhMyEmbed::NotFound on staus 404 (not found)' do
+      stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_return(status: [404, 'Not Found'])
+      expect{ DummyProvider.fetch('http://example.com/my/content') }.to raise_error OhMyEmbed::NotFound
+    end
+
+    it 'fails with an OhMyEmbed::PermissionDenied on staus 401 (unauthorized)' do
+      stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_return(status: [401, 'Unauthorized'])
+      expect{ DummyProvider.fetch('http://example.com/my/content') }.to raise_error OhMyEmbed::PermissionDenied
+    end
+
+    it 'fails with an OhMyEmbed::FormatNotSupportet on status 501 (not implemented)' do
+      stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_return(status: [501, 'Not Implemented'])
+      expect{ DummyProvider.fetch('http://example.com/my/content') }.to raise_error OhMyEmbed::FormatNotSupported
+    end
+
+    it 'fails with an OhMyEmbed::Error on request timeout' do
+      stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_timeout
+      expect{ DummyProvider.fetch('http://example.com/my/content') }.to raise_error OhMyEmbed::Error
+    end
+
+    it 'fails with an OhMyEmbed::ParseError if endpoint returns malformed json' do
+      stub_request(:get, /^https:\/\/www\.example\.com\/api\/oembed/).to_return(body: '<yolo this="is xml">')
+
+      expect{ DummyProvider.fetch('http://example.com/my/content') }.to raise_error OhMyEmbed::ParseError
+    end
+  end
+
+  describe '#mapping' do
+    it 'returns a hash where defaults merged with the custom mapping' do
+      expect(DummyProvider.mapping['type']).to eq 'custom_type'
+      expect(DummyProvider.mapping['provider_name']).to eq 'provider_name'
+    end
+  end
+
+  describe '#provider_name' do
+    it 'returns the provider name if given' do
+      expect(DummyProvider.provider_name).to eq 'My Dummy Provider'
+    end
+
+    it 'return the provider_name extracted from class name if no provider_name given' do
+      expect(OhMyEmbed::Provider.provider_name).to eq 'Provider'
+    end
+  end
+end

data/spec/oh_my_embed/providers/facebook_post_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe OhMyEmbed::Providers::FacebookPost do
+  let(:provider) { OhMyEmbed::Providers::FacebookPost }
+  let(:content_url) { 'https://www.facebook.com/FacebookDeutschland/posts/10153796066380932' }
+
+  it 'the content_url matches the schema' do
+    expect(provider.regex).to match content_url
+  end
+
+  describe 'fetching' do
+    it 'returns a rich response with required attributes' do
+      VCR.use_cassette('facebook_posts') do
+        response = provider.fetch(content_url)
+
+        expect(response).to be_a OhMyEmbed::Response
+
+        expect(response.type).to eq :rich
+
+        expect(response.provider_name).to eq 'Facebook'
+        expect(response.provider_url).to eq 'https://www.facebook.com'
+
+        expect(response.url).to eq content_url
+
+        expect(response.title).to be nil
+
+        expect(response.author).to eq({
+          name: 'Facebook',
+          url: 'https://www.facebook.com/FacebookDeutschland/',
+        })
+
+        expect(response.thumbnail).to be nil
+
+        expect(response.embed[:html]).to be_a String
+        expect(response.embed[:width]).to eq 552
+        expect(response.embed[:height]).to be nil
+      end
+    end
+  end
+end

data/spec/oh_my_embed/providers/facebook_video_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe OhMyEmbed::Providers::FacebookVideo do
+  let(:provider) { OhMyEmbed::Providers::FacebookVideo }
+  let(:content_url) { 'https://www.facebook.com/facebook/videos/10153231379946729/' }
+
+  it 'the content_url matches the schema' do
+    expect(provider.regex).to match content_url
+  end
+
+  describe 'fetching' do
+    it 'returns a video response with required attributes' do
+      VCR.use_cassette('facebook_videos') do
+        response = provider.fetch(content_url)
+
+        expect(response).to be_a OhMyEmbed::Response
+
+        expect(response.type).to eq :video
+
+        expect(response.provider_name).to eq 'Facebook'
+        expect(response.provider_url).to eq 'https://www.facebook.com'
+
+        expect(response.url).to eq content_url
+
+        expect(response.title).to be nil
+
+        expect(response.author).to eq({
+          name: 'Facebook',
+          url: 'https://www.facebook.com/facebook/',
+        })
+
+        expect(response.thumbnail).to be nil
+
+        expect(response.embed[:html]).to be_a String
+        expect(response.embed[:width]).to eq 500
+        expect(response.embed[:height]).to eq 281
+      end
+    end
+  end
+end

data/spec/oh_my_embed/providers/flickr_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe OhMyEmbed::Providers::Flickr do
+  let(:provider) { OhMyEmbed::Providers::Flickr }
+  let(:content_url) { 'https://www.flickr.com/photos/66038491@N06/26861401435/in/explore-2016-05-07/' }
+
+  it 'the content_url matches the schema' do
+    expect(provider.regex).to match content_url
+  end
+
+  describe 'fetching' do
+    it 'returns a photo response with required attributes' do
+      VCR.use_cassette('flickr') do
+        response = provider.fetch(content_url)
+
+        expect(response).to be_a OhMyEmbed::Response
+
+        expect(response.type).to eq :photo
+
+        expect(response.provider_name).to eq 'Flickr'
+        expect(response.provider_url).to eq 'https://www.flickr.com/'
+
+        expect(response.url).to eq 'https://farm8.staticflickr.com/7231/26861401435_c1dbfe8703_b.jpg'
+
+        expect(response.title).to eq 'T-21'
+
+        expect(response.author).to eq({
+          name: 'BeyondBrickz',
+          url: 'https://www.flickr.com/photos/66038491@N06/',
+        })
+
+        expect(response.thumbnail).to eq({
+          url: 'https://farm8.staticflickr.com/7231/26861401435_c1dbfe8703_q.jpg',
+          width: 150,
+          height: 150,
+        })
+
+        expect(response.embed[:html]).to be_a String
+        expect(response.embed[:width]).to eq '1024'
+        expect(response.embed[:height]).to eq '629'
+      end
+    end
+  end
+end

data/spec/oh_my_embed/providers/instagram_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe OhMyEmbed::Providers::Instagram do
+  let(:provider) { OhMyEmbed::Providers::Instagram }
+  let(:content_url) { 'http://instagr.am/p/fA9uwTtkSN' }
+
+  it 'the content_url matches the schema' do
+    expect(provider.regex).to match content_url
+  end
+
+  describe 'fetching' do
+    it 'returns a rich response with required attributes' do
+      VCR.use_cassette('instagram') do
+        response = provider.fetch(content_url)
+
+        expect(response).to be_a OhMyEmbed::Response
+
+        expect(response.type).to eq :rich
+
+        expect(response.provider_name).to eq 'Instagram'
+        expect(response.provider_url).to eq 'https://www.instagram.com'
+
+        expect(response.url).to eq content_url
+
+        expect(response.title).to eq 'Wii Gato (Lipe Sleep)'
+
+        expect(response.author).to eq({
+          name: 'diegoquinteiro',
+          url: 'https://www.instagram.com/diegoquinteiro',
+        })
+
+        expect(response.thumbnail).to eq({
+          url: 'https://scontent-fra3-1.cdninstagram.com/t51.2885-15/e15/11358196_1472850273007829_614249870_n.jpg?ig_cache_key=NTU4NzE3ODQ3NTk3MzY4NDYx.2',
+          width: 640,
+          height: 640,
+        })
+
+        expect(response.embed[:html]).to be_a String
+        expect(response.embed[:width]).to eq 658
+        expect(response.embed[:height]).to be nil
+      end
+    end
+  end
+end

data/spec/oh_my_embed/providers/kickstarter_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe OhMyEmbed::Providers::Kickstarter do
+  let(:provider) { OhMyEmbed::Providers::Kickstarter }
+  let(:content_url) { 'https://www.kickstarter.com/projects/531257408/professional-3-stage-knife-sharpener?ref=category_popular' }
+
+  it 'the content_url matches the schema' do
+    expect(provider.regex).to match content_url
+  end
+
+  describe 'fetching' do
+    it 'returns a rich response with required attributes' do
+      VCR.use_cassette('kickstarter') do
+        response = provider.fetch(content_url)
+
+        expect(response).to be_a OhMyEmbed::Response
+
+        expect(response.type).to eq :rich
+
+        expect(response.provider_name).to eq 'Kickstarter'
+        expect(response.provider_url).to eq 'https://www.kickstarter.com/'
+
+        expect(response.url).to eq content_url
+
+        expect(response.title).to eq 'Professional 3 Stage Knife Sharpener'
+
+        expect(response.author).to eq({
+          name: 'Kongqiang',
+          url: 'https://www.kickstarter.com/profile/531257408',
+        })
+
+        expect(response.thumbnail).to eq({
+          url: 'https://ksr-ugc.imgix.net/projects/2452435/photo-original.jpg?w=560&h=315&fit=fill&bg=FFFFFF&v=1461877181&auto=format&q=92&s=aae8e61c91e611fd27cc2db1c25a8916',
+          width: 560,
+          height: 315,
+        })
+
+        expect(response.embed[:html]).to be_a String
+        expect(response.embed[:width]).to eq 480
+        expect(response.embed[:height]).to eq 270
+      end
+    end
+  end
+end