ruby-oembed 0.14.1 → 0.15.0

data/spec/providers/code_pen_spec.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'OEmbed::Providers::CodePen' do
+  use_custom_vcr_casette('OEmbed_Providers_CodePen')
+  include OEmbedSpecHelper
+
+  let(:provider) { OEmbed::Providers::CodePen }
+
+  expected_valid_urls = %w(
+    https://codepen.io/maximakymenko/pen/mdbpeXm
+  )
+  expected_invalid_urls = %w(
+    https://codepen.com/maximakymenko/pen/mdbpeXm
+  )
+
+  it_should_behave_like(
+    "an OEmbed::Providers instance",
+    expected_valid_urls,
+    expected_invalid_urls
+  )
+end

data/spec/providers/facebook_post_spec.rb

@@ -0,0 +1,54 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'OEmbed::Providers::FacebookPost' do
+  use_custom_vcr_casette('OEmbed_Providers_FacebookPost')
+  include OEmbedSpecHelper
+
+  let(:provider) { OEmbed::Providers::FacebookPost }
+
+  expected_valid_urls = [
+    # A public "post" by a "page"
+    'https://www.facebook.com/rubyonrailstogo/posts/3610333842332884',
+    # A public "note"
+    'https://www.facebook.com/notes/facebook-app/welcome-to-the-facebook-blog/2207517130/',
+    # A specific photo
+    'https://www.facebook.com/tumocenter/photos/bc.AbpR7-R7Lu6GodUph_UNg1Ttn-k7Ni-M8X89Io4cWsYkK0OPde6MTVKHSiTNDEanWYkwQGyu-YwpNnS4MXUqeYen_ovuiBPQixaA-tjNBcVUFAMWPaxX-NU1mm2ovExEORQOdohcH339Xmxch3kbSPcJ/1084373708267461/',
+    # A photo in slideshow view
+    'https://www.facebook.com/photo/?fbid=3348617585198325&set=gm.1675022489341591',
+  ]
+  expected_invalid_urls = %w(
+    https://www.instagram.com/p/B9bOM-6Ax_d/?igshid=1mn51zsvrhoiq
+    https://www.facebook.com/381763475170840/videos/474308113397163/
+    https://www.facebook.com/groups/rordevelopers/permalink/1675022489341591/
+    https://www.facebook.com/business/news/tips-small-business-digital-tools-in-crisis-and-recovery-report-deloitte/
+  )
+
+  describe 'behaving like an OEmbed::Provider instance' do
+    it_should_behave_like(
+      "an OEmbed::Providers instance",
+      expected_valid_urls,
+      expected_invalid_urls
+    )
+  end
+
+  describe 'DEPRECATED: behaves like a custom OEmbed::Provider class for v0.14.0 backwards compatibility' do
+    around(:each) { |example|
+      # Always restore the provider's access_token to its previous value
+      # so that if the OEMBED_FACEBOOK_TOKEN env var is set, it's used correctly.
+      orig_access_token = provider.access_token
+      example.run
+      provider.access_token = orig_access_token
+    }
+    let(:access_token) { 'A_FAKE_TOKEN_FOR_TESTS' }
+    let(:provider_instance) { provider.new(access_token: access_token) }
+    let(:embed_url) { expected_valid_urls.first }
+
+    it 'sets the access_token' do
+      expect(provider_instance.access_token).to eq(access_token)
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider_instance).to include(embed_url)
+    end
+  end
+end

data/spec/providers/facebook_video_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'OEmbed::Providers::FacebookVideo' do
+  use_custom_vcr_casette('OEmbed_Providers_FacebookVideo')
+  include OEmbedSpecHelper
+
+  let(:provider) { OEmbed::Providers::FacebookVideo }
+
+  expected_valid_urls = %w(
+    https://www.facebook.com/381763475170840/videos/474308113397163/
+    https://www.facebook.com/osherove/videos/10157895173751223/
+  )
+  expected_invalid_urls = %w(
+    https://www.instagram.com/p/B9bOM-6Ax_d/?igshid=1mn51zsvrhoiq
+    https://www.facebook.com/rubyonrailstogo/posts/3610333842332884
+    https://www.facebook.com/groups/rordevelopers/permalink/1675022489341591/
+    https://www.facebook.com/business/news/tips-small-business-digital-tools-in-crisis-and-recovery-report-deloitte/
+  )
+
+  describe 'behaving like an OEmbed::Provider instance' do
+    it_should_behave_like(
+      "an OEmbed::Providers instance",
+      expected_valid_urls,
+      expected_invalid_urls
+    )
+  end
+
+  describe 'DEPRECATED: behaves like a custom OEmbed::Provider class for v0.14.0 backwards compatibility' do
+    around(:each) { |example|
+      # Always restore the provider's access_token to its previous value
+      # so that if the OEMBED_FACEBOOK_TOKEN env var is set, it's used correctly.
+      orig_access_token = provider.access_token
+      example.run
+      provider.access_token = orig_access_token
+    }
+    let(:access_token) { 'A_FAKE_TOKEN_FOR_TESTS' }
+    let(:provider_instance) { provider.new(access_token: access_token) }
+    let(:embed_url) { expected_valid_urls.first }
+
+    it 'sets the access_token' do
+      expect(provider_instance.access_token).to eq(access_token)
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider_instance).to include(embed_url)
+    end
+  end
+end

data/spec/providers/instagram_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'OEmbed::Providers::Instagram' do
+  use_custom_vcr_casette('OEmbed_Providers_Instagram')
+  include OEmbedSpecHelper
+
+  let(:provider) { OEmbed::Providers::Instagram }
+
+  expected_valid_urls = %w(
+    https://www.instagram.com/p/B9bOM-6Ax_d/?igshid=1mn51zsvrhoiq
+    https://instagram.com/p/B9bOM-6Ax_d/?igshid=1mn51zsvrhoiq
+    http://instagr.am/p/B9bOM-6Ax_d/?igshid=1mn51zsvrhoiq
+    https://www.instagram.com/tv/CCX-gcHArcJ/?igshid=1i0rst4jaz0j
+    https://www.instagram.com/reel/CIyNZQhH4DQ/?igshid=40rns9jda1ow
+  )
+  expected_invalid_urls = %w(
+    https://www.instagram.com/u/CCX-gcHArcJ/?igshid=1i0rst4jaz0j
+  )
+
+  describe 'behaving like an OEmbed::Provider instance' do
+    it_should_behave_like(
+      "an OEmbed::Providers instance",
+      expected_valid_urls,
+      expected_invalid_urls
+    )
+  end
+
+  describe 'DEPRECATED: behaves like a custom OEmbed::Provider class for v0.14.0 backwards compatibility' do
+    around(:each) { |example|
+      # Always restore the provider's access_token to its previous value
+      # so that if the OEMBED_FACEBOOK_TOKEN env var is set, it's used correctly.
+      orig_access_token = provider.access_token
+      example.run
+      provider.access_token = orig_access_token
+    }
+    let(:access_token) { 'A_FAKE_TOKEN_FOR_TESTS' }
+    let(:provider_instance) { provider.new(access_token: access_token) }
+    let(:embed_url) { expected_valid_urls.first }
+
+    it 'sets the access_token' do
+      expect(provider_instance.access_token).to eq(access_token)
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider_instance).to include(embed_url)
+    end
+  end
+end

data/spec/providers/slideshare_spec.rb

@@ -1,17 +1,10 @@
 require File.join(File.dirname(__FILE__), '../spec_helper')
-require 'support/shared_examples_for_providers'
 
 describe 'OEmbed::Providers::Slideshare' do
-  before(:all) do
-    VCR.insert_cassette('OEmbed_Providers_Slideshare')
-  end
-  after(:all) do
-    VCR.eject_cassette
-  end
-
+  use_custom_vcr_casette('OEmbed_Providers_Slideshare')
   include OEmbedSpecHelper
 
-  let(:provider_class) { OEmbed::Providers::Slideshare }
+  let(:provider) { OEmbed::Providers::Slideshare }
 
   expected_valid_urls = (
     %w(https:// http://).map do |protocol|

data/spec/providers/tik_tok_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'OEmbed::Providers::TikTok' do
+  use_custom_vcr_casette('OEmbed_Providers_TikTok')
+  include OEmbedSpecHelper
+
+  let(:provider) { OEmbed::Providers::TikTok }
+
+  expected_valid_urls = [
+    # Specific videos
+    'https://www.tiktok.com/@sowylie/video/6903556111169899781',
+    'https://www.tiktok.com/@cassidoo/video/6841722789502749957',
+  ]
+  expected_invalid_urls = [
+    # An author's page
+    'https://www.tiktok.com/@sowylie',
+    # The safety page/docs
+    'https://www.tiktok.com/safety?lang=en',
+  ]
+
+  it_should_behave_like(
+    "an OEmbed::Providers instance",
+    expected_valid_urls,
+    expected_invalid_urls
+  )
+end

data/spec/providers/twitter_spec.rb

@@ -1,17 +1,10 @@
 require File.join(File.dirname(__FILE__), '../spec_helper')
-require 'support/shared_examples_for_providers'
 
 describe 'OEmbed::Providers::Twitter' do
-  before(:all) do
-    VCR.insert_cassette('OEmbed_Providers_Twitter')
-  end
-  after(:all) do
-    VCR.eject_cassette
-  end
-
+  use_custom_vcr_casette('OEmbed_Providers_Twitter')
   include OEmbedSpecHelper
 
-  let(:provider_class) { OEmbed::Providers::Twitter }
+  let(:provider) { OEmbed::Providers::Twitter }
 
   expected_valid_urls = %w(
     https://twitter.com/RailsGirlsSoC/status/702136612822634496
@@ -34,7 +27,7 @@ describe 'OEmbed::Providers::Twitter' do
         describe ".get" do
           it "should encounter a 400 error" do
             expect {
-              provider_class.get(valid_url, :format=>:xml)
+              provider.get(valid_url, format: :xml)
             }.to raise_error(OEmbed::UnknownResponse, /\b400\b/)
           end
         end

data/spec/providers/youtube_spec.rb

@@ -1,16 +1,10 @@
 require File.join(File.dirname(__FILE__), '../spec_helper')
 
 describe 'OEmbed::Providers::Youtube' do
-  before(:all) do
-    VCR.insert_cassette('OEmbed_Providers_Youtube')
-  end
-  after(:all) do
-    VCR.eject_cassette
-  end
-
+  use_custom_vcr_casette('OEmbed_Providers_Youtube')
   include OEmbedSpecHelper
 
-  let(:provider_class) { OEmbed::Providers::Youtube }
+  let(:provider) { OEmbed::Providers::Youtube }
 
   expected_valid_urls = %w(
     https://www.youtube.com/watch?v=pO5L6vXtxsI
@@ -34,7 +28,7 @@ describe 'OEmbed::Providers::Youtube' do
 
       it "should throw an UnknownResponse error" do
         expect {
-          provider_class.get(invalid_url)
+          provider.get(invalid_url)
         }.to raise_error(OEmbed::UnknownResponse, /403/)
       end
     end

data/spec/providers_spec.rb

@@ -17,7 +17,7 @@ describe OEmbed::Providers do
   end
 
   describe ".register" do
-    it "should register providers" do
+    it "should register multiple providers at once" do
       expect(OEmbed::Providers.urls).to be_empty
 
       OEmbed::Providers.register(@flickr, @qik)
@@ -35,11 +35,20 @@ describe OEmbed::Providers do
       end
     end
 
-    it "should find by URLs" do
-      OEmbed::Providers.register(@flickr, @qik) # tested in "should register providers"
+    it "should register providers with missing required_query_params" do
+      expect(OEmbed::Providers.urls).to be_empty
 
-      expect(OEmbed::Providers.find(example_url(:flickr))).to eq(@flickr)
-      expect(OEmbed::Providers.find(example_url(:qik))).to eq(@qik)
+      provider = OEmbed::Provider.new("http://foo.com/oembed", required_query_params: { send_with_query: nil })
+      provider << 'http://media.foo.com/*'
+
+      OEmbed::Providers.register(provider)
+
+      expect(OEmbed::Providers.urls.keys).to eq(provider.urls)
+
+      provider.urls.each do |regexp|
+        expect(OEmbed::Providers.urls).to have_key(regexp)
+        expect(OEmbed::Providers.urls[regexp]).to include(provider)
+      end
     end
   end
 
@@ -122,6 +131,134 @@ describe OEmbed::Providers do
 	#    and_return(valid_response(:object))
   #end
 
+  describe "#find" do
+    let(:url_scheme) { 'http://media.foo.com/*' }
+    let(:providerA) {
+      p = OEmbed::Provider.new("http://a.foo.com/oembed")
+      p << url_scheme
+      p
+    }
+    let(:providerB) {
+      p = OEmbed::Provider.new("http://b.foo.com/oembed")
+      p << url_scheme
+      p
+    }
+
+    let(:url_to_find) { 'http://media.foo.com/which-one?' }
+    subject { OEmbed::Providers.find(url_to_find) }
+
+    context "when there registered providers are distinct" do
+      before { OEmbed::Providers.register(@flickr, @qik, providerA) }
+
+      it "should find providerA" do
+        should eq(providerA)
+      end
+
+      it "should find by any of the registered providers by URL" do
+        expect(OEmbed::Providers.find(example_url(:flickr))).to eq(@flickr)
+        expect(OEmbed::Providers.find(example_url(:qik))).to eq(@qik)
+      end
+    end
+
+    context "when the registered provider has missing required_query_params" do
+      let(:providerA) {
+        p = OEmbed::Provider.new("http://a.foo.com/oembed", required_query_params: { send_with_query: false })
+        p << url_scheme
+        p
+      }
+      before { OEmbed::Providers.register(providerA) }
+
+      it "should NOT find the provider" do
+        should be_nil
+      end
+
+      context "but then later has the required_query_param set" do
+        it "should find providerA" do
+          providerA.send_with_query = 'a non-blank val'
+
+          should eq(providerA)
+        end
+      end
+    end
+
+    context "when multiple providers match the same URL" do
+      it "should find one match" do
+        OEmbed::Providers.register(providerA, providerB)
+
+        should eq(providerA).or eq(providerB)
+      end
+
+      context "when providerA has missing required_query_params" do
+        let(:providerA) {
+          p = OEmbed::Provider.new("http://a.foo.com/oembed", required_query_params: { send_with_query: false })
+          p << url_scheme
+          p
+        }
+
+        it "should find the provider with satisfied required_query_params" do
+          OEmbed::Providers.register(providerA, providerB)
+
+          should eq(providerB)
+        end
+
+        it "should find the provider with satisfied required_query_params, regardless of register order" do
+          OEmbed::Providers.register(providerB, providerA)
+
+          should eq(providerB)
+        end
+      end
+
+      context "when providerA has satisfied required_query_params" do
+        let(:providerA) {
+          p = OEmbed::Provider.new("http://a.foo.com/oembed", required_query_params: { send_with_query: false })
+          p.send_with_query = 'a non-blank value'
+          p << url_scheme
+          p
+        }
+
+        it "should find one match" do
+          OEmbed::Providers.register(providerA, providerB)
+
+          should eq(providerA).or eq(providerB)
+        end
+
+        it "should find one match, regardless of register order" do
+          OEmbed::Providers.register(providerB, providerA)
+
+          should eq(providerA).or eq(providerB)
+        end
+      end
+
+      context "but with slightly different URL schemes" do
+        let(:url_to_find) { 'http://media.foo.com/video/which-one?' }
+        let(:broad_url_scheme) { 'http://media.foo.com/*' }
+        let(:specific_url_scheme) { 'http://media.foo.com/video/*' }
+        let(:providerA) {
+          p = OEmbed::Provider.new("http://a.foo.com/oembed")
+          p << broad_url_scheme
+          p
+        }
+        let(:providerB) {
+          p = OEmbed::Provider.new("http://a.foo.com/oembed")
+          p << specific_url_scheme
+          p
+        }
+
+        it "should find one match" do
+          OEmbed::Providers.register(providerA, providerB)
+
+          should eq(providerA).or eq(providerB)
+        end
+
+        it "should find one match, regardless of register order" do
+          OEmbed::Providers.register(providerB, providerA)
+
+          should eq(providerA).or eq(providerB)
+        end
+      end
+    end
+  end
+
   describe "#raw and #get" do
     it "should bridge #get and #raw to the right provider" do
       OEmbed::Providers.register_all
@@ -213,13 +350,16 @@ describe OEmbed::Providers do
     describe 'register_access_token_providers' do
       describe 'tokens[:facebook]' do
         let(:access_token) { 'my-fake-access-token' }
+        let(:provider) { OEmbed::Providers::FacebookPost }
         let(:embed_url) { 'https://www.facebook.com/exampleuser/posts/1234567890' }
 
         around(:each) do |each|
           previous_value = ENV['OEMBED_FACEBOOK_TOKEN']
           ENV['OEMBED_FACEBOOK_TOKEN'] = nil
+          provider.access_token = nil
           each.run
           ENV['OEMBED_FACEBOOK_TOKEN'] = previous_value
+          provider.access_token = previous_value
           OEmbed::Providers.unregister_all
         end
 
@@ -230,7 +370,8 @@ describe OEmbed::Providers do
             OEmbed::Providers.register_all
           end
 
-          it { is_expected.to_not be_a(OEmbed::Providers::FacebookPost) }
+          it { is_expected.to_not eql(provider) }
+          it { is_expected.to eq(nil) }
         end
 
         context 'when access token is provided to register_all' do
@@ -238,22 +379,16 @@ describe OEmbed::Providers do
             OEmbed::Providers.register_all(access_tokens: { facebook: access_token })
           end
 
-          it { is_expected.to be_a(OEmbed::Providers::FacebookPost) }
+          it { is_expected.to eql(provider) }
         end
 
-        context 'when access token is set as an environment variable' do
+        context 'when access token is set ahead of time' do
           before do
-            ENV['OEMBED_FACEBOOK_TOKEN'] = access_token
+            provider.access_token = access_token
             OEmbed::Providers.register_all
           end
 
-          it { is_expected.to be_a(OEmbed::Providers::FacebookPost) }
-        end
-
-        context 'without access token' do
-          before { OEmbed::Providers.register_all }
-
-          it { is_expected.to eq(nil) }
+          it { is_expected.to eql(provider) }
         end
       end
     end