ruby-oembed 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5b49cbc24d498437a79986c23aa129502844807e5569038cc4a7e06877cfd0
-  data.tar.gz: 8e159677b5573eb78ee741ec327c6163cccacd87ed6c69407e588d19d0cf9673
+  metadata.gz: 2ce690eea65c79e7df55ec323c59bf8c2ec43c9b94c1f084ad558b70c392cef9
+  data.tar.gz: b964d57ad3902a1dc99911aecc7f7f566a89ce2b6fdaa22ab34763c01a4e8aba
 SHA512:
-  metadata.gz: b08a12d66076295e5a46182112bf3c62ca3ec7da449e0e2fbe65ef531232b3e5eef45ce46fa79ad6963b04cfe93bca0971f930cbc1076e899b591dd9584e3a7f
-  data.tar.gz: a51468e9dc43fa6f0e027259cabbb121eb231c5d70f76046642945755f392527a71a6e4c045d6a5e3a761d7b09089ddaa94e3655adb0b533c4ce7c7ca1d88079
+  metadata.gz: 5e694d02b886ff90fa2d14afcbaefeda99ab258e632d8126e0e2d61c308edb0eb3001cd517ce1342e3eea033d31eeca1a8016068392e406689ffb08c95242c02
+  data.tar.gz: 3aba0c2994ae8fa2b87a172e03dfb4a529eec7ccfabd393b2182a91822bb4856ae2409983d0cb3755a092a191729d0af84c755f14e384a3cd5a2ce9c80b814f6

data/CHANGELOG.rdoc

@@ -1,6 +1,11 @@
 = CHANGELOG
 
-== Unreleased (0.13.2)
+== Unreleased (0.14.1)
+
+
+== 0.14.0 - 5 November 2020
+
+* Add support for Facebook/Instragram access tokens; Pull #75 (Inge Jørgensen)
 
 == 0.13.1 - 25 May 2020
 

data/README.md

@@ -34,6 +34,26 @@ resource.html #=> <<-HTML
 HTML
 ```
 
+### Providers requiring an access token
+
+Some built-in providers require authorization in order to work. These providers won't be registered unless an access token is provided. You can either pass access tokens to the `register_app` method.
+
+```ruby
+OEmbed::Providers.register_all(access_tokens: { facebook: @my_facebook_token })
+```
+
+Or you can provide access tokens via environment variable
+```ruby
+ENV['OEMBED_FACEBOOK_TOKEN'] #=> 'my-access-token'
+OEmbed::Providers.register_all
+```
+
+#### Currently supported access tokens
+
+| access_token | environment variable    | Associaed Providers |
+|--------------|-------------------------|---------------------|
+| `:facebook`  | `OEMBED_FACEBOOK_TOKEN` | `FacebookPost`, `FacebookVideo`, `Instagram` |
+
 ## Custom Providers
 
 If you'd like to use a provider that isn't included in the library, it's easy to create one. Just provide the oEmbed API endpoint and URL scheme(s).

data/lib/oembed/providers.rb

@@ -1,6 +1,10 @@
 require 'rubygems'
 require 'yaml'
 
+require 'oembed/providers/facebook_post'
+require 'oembed/providers/facebook_video'
+require 'oembed/providers/instagram'
+
 module OEmbed
   # Allows OEmbed to perform tasks across several, registered, Providers
   # at once.
@@ -44,8 +48,11 @@ module OEmbed
       # Register all Providers built into this gem.
       # The including_sub_type parameter should be one of the following values:
       # * :aggregators: also register provider aggregator endpoints, like Embedly
-      def register_all(*including_sub_type)
+      # The access_token keys can be one of the following:
+      # * :facebook: See https://developers.facebook.com/docs/instagram/oembed#access-tokens
+      def register_all(*including_sub_type, access_tokens: {})
         register(*@@to_register[""])
+        register_access_token_providers(access_tokens)
         including_sub_type.each do |sub_type|
           register(*@@to_register[sub_type.to_s])
         end
@@ -122,6 +129,20 @@ module OEmbed
         @@to_register[sub_type.to_s] ||= []
         @@to_register[sub_type.to_s] << provider_class
       end
+
+      # Takes a Hash of tokens, and registers providers that use the given tokens.
+      # Also supports "OEMBED_*_TOKEN" environment variables.
+      # Currently supported tokens:
+      # * facebook: See https://developers.facebook.com/docs/instagram/oembed#access-tokens
+      def register_access_token_providers(access_tokens)
+        tokens = { facebook: ENV['OEMBED_FACEBOOK_TOKEN'] }.merge(access_tokens)
+
+        if tokens[:facebook]
+          register OEmbed::Providers::FacebookPost.new(access_token: tokens[:facebook])
+          register OEmbed::Providers::FacebookVideo.new(access_token: tokens[:facebook])
+          register OEmbed::Providers::Instagram.new(access_token: tokens[:facebook])
+        end
+      end
     end
 
     # Custom providers:
@@ -201,42 +222,6 @@ module OEmbed
     Vine << "https://*.vine.co/v/*"
     add_official_provider(Vine)
 
-    # Provider for instagram.com
-    # https://instagr.am/developer/embedding/
-    Instagram = OEmbed::Provider.new("https://api.instagram.com/oembed", :json)
-    Instagram << "http://instagr.am/p/*"
-    Instagram << "http://instagram.com/p/*"
-    Instagram << "http://www.instagram.com/p/*"
-    Instagram << "https://instagr.am/p/*"
-    Instagram << "https://instagram.com/p/*"
-    Instagram << "https://www.instagram.com/p/*"
-    Instagram << "http://instagr.am/tv/*"
-    Instagram << "http://instagram.com/tv/*"
-    Instagram << "http://www.instagram.com/tv/*"
-    Instagram << "https://instagr.am/tv/*"
-    Instagram << "https://instagram.com/tv/*"
-    Instagram << "https://www.instagram.com/tv/*"
-    add_official_provider(Instagram)
-
-    # Providers for Facebook Posts & Videos
-    # https://developers.facebook.com/docs/plugins/oembed-endpoints
-    FacebookPost = OEmbed::Provider.new('https://www.facebook.com/plugins/post/oembed.json/', :json)
-    FacebookPost << 'https://www.facebook.com/*/posts/*'
-    FacebookPost << 'https://www.facebook.com/*/activity/*'
-    FacebookPost << 'https://www.facebook.com/photo*'
-    FacebookPost << 'https://www.facebook.com/photos*'
-    FacebookPost << 'https://www.facebook.com/*/photos*'
-    FacebookPost << 'https://www.facebook.com/permalink*'
-    FacebookPost << 'https://www.facebook.com/media*'
-    FacebookPost << 'https://www.facebook.com/questions*'
-    FacebookPost << 'https://www.facebook.com/notes*'
-    add_official_provider(FacebookPost)
-
-    FacebookVideo = OEmbed::Provider.new('https://www.facebook.com/plugins/video/oembed.json/', :json)
-    FacebookVideo << 'https://www.facebook.com/*/videos/*'
-    FacebookVideo << 'https://www.facebook.com/video*'
-    add_official_provider(FacebookVideo)
-
     # Provider for slideshare.net
     # http://www.slideshare.net/developers/oembed
     Slideshare = OEmbed::Provider.new("https://www.slideshare.net/api/oembed/2")
@@ -422,7 +407,7 @@ module OEmbed
     Noembed = OEmbed::Provider.new("https://noembed.com/embed")
     # Add all known URL regexps for Noembed.
     # To update this list run `rake oembed:update_noembed`
-    YAML.load_file(File.join(File.dirname(__FILE__), "/providers/noembed_urls.yml")).each do |url|
+    YAML.load_file(File.join(File.dirname(__FILE__), "/providers/aggregators/noembed_urls.yml")).each do |url|
       Noembed << Regexp.new(url)
     end
     add_official_provider(Noembed, :aggregators)
@@ -437,7 +422,7 @@ module OEmbed
     # If you don't yet have an API key you'll need to sign up here: http://embed.ly/pricing
     Embedly = OEmbed::Provider.new("http://api.embed.ly/1/oembed")
     # Add all known URL regexps for Embedly. To update this list run `rake oembed:update_embedly`
-    YAML.load_file(File.join(File.dirname(__FILE__), "/providers/embedly_urls.yml")).each do |url|
+    YAML.load_file(File.join(File.dirname(__FILE__), "/providers/aggregators/embedly_urls.yml")).each do |url|
       Embedly << url
     end
     add_official_provider(Embedly, :aggregators)

data/lib/oembed/providers/facebook_post.rb

@@ -0,0 +1,25 @@
+module OEmbed
+  class Providers
+    # Provider for Facebook posts
+    class FacebookPost < OEmbed::Provider
+      def initialize(access_token:)
+        super("https://graph.facebook.com/v8.0/oembed_post?access_token=#{access_token}", :json)
+        register_urls!
+      end
+
+      private
+
+      def register_urls!
+        ['https://www.facebook.com/*/posts/*',
+         'https://www.facebook.com/*/activity/*',
+         'https://www.facebook.com/photo*',
+         'https://www.facebook.com/photos*',
+         'https://www.facebook.com/*/photos*',
+         'https://www.facebook.com/permalink*',
+         'https://www.facebook.com/media*',
+         'https://www.facebook.com/questions*',
+         'https://www.facebook.com/notes*'].each { |u| self << u }
+      end
+    end
+  end
+end

data/lib/oembed/providers/facebook_video.rb

@@ -0,0 +1,18 @@
+module OEmbed
+  class Providers
+    # Provider for Facebook videos
+    class FacebookVideo < OEmbed::Provider
+      def initialize(access_token:)
+        super("https://graph.facebook.com/v8.0/oembed_video?access_token=#{access_token}", :json)
+        register_urls!
+      end
+
+      private
+
+      def register_urls!
+        ['https://www.facebook.com/*/videos/*',
+         'https://www.facebook.com/video*'].each { |u| self << u }
+      end
+    end
+  end
+end

data/lib/oembed/providers/instagram.rb

@@ -0,0 +1,28 @@
+module OEmbed
+  class Providers
+    # Provider for instagram.com
+    class Instagram < OEmbed::Provider
+      def initialize(access_token:)
+        super("https://graph.facebook.com/v8.0/instagram_oembed?access_token=#{access_token}", :json)
+        register_urls!
+      end
+
+      private
+
+      def register_urls!
+        ["http://instagr.am/p/*",
+         "http://instagram.com/p/*",
+         "http://www.instagram.com/p/*",
+         "https://instagr.am/p/*",
+         "https://instagram.com/p/*",
+         "https://www.instagram.com/p/*",
+         "http://instagr.am/tv/*",
+         "http://instagram.com/tv/*",
+         "http://www.instagram.com/tv/*",
+         "https://instagr.am/tv/*",
+         "https://instagram.com/tv/*",
+         "https://www.instagram.com/tv/*"].each { |u| self << u }
+      end
+    end
+  end
+end

data/lib/oembed/version.rb

@@ -1,8 +1,8 @@
 module OEmbed
   class Version
     MAJOR = 0
-    MINOR = 13
-    PATCH = 1
+    MINOR = 14
+    PATCH = 0
     STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
 
     class << self

data/lib/tasks/oembed.rake

@@ -8,7 +8,7 @@ begin
     task :update_noembed do
       # Details at http://api.embed.ly/docs/service
       json_uri = URI.parse("https://noembed.com/providers")
-      yaml_path = File.join(File.dirname(__FILE__), "../oembed/providers/noembed_urls.yml")
+      yaml_path = File.join(File.dirname(__FILE__), "../oembed/providers/aggregators/noembed_urls.yml")
 
       services = JSON.parse(json_uri.read)
 
@@ -25,7 +25,7 @@ begin
     task :update_embedly do
       # Details at http://api.embed.ly/docs/service
       json_uri = URI.parse("http://api.embed.ly/1/services")
-      yaml_path = File.join(File.dirname(__FILE__), "../oembed/providers/embedly_urls.yml")
+      yaml_path = File.join(File.dirname(__FILE__), "../oembed/providers/aggregators/embedly_urls.yml")
 
       services = JSON.parse(json_uri.read)
 

data/spec/providers/facebook_spec.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), '../spec_helper')
+
+describe 'Facebook providers' do
+  let(:access_token) { 'my-fake-access-token' }
+
+  describe 'FacebookPost provider' do
+    let(:provider) { OEmbed::Providers::FacebookPost.new(access_token: access_token) }
+    let(:embed_url) { 'https://www.facebook.com/exampleuser/posts/1234567890' }
+
+    it 'sets the endpoint URL' do
+      expect(provider.endpoint).to(
+        eq("https://graph.facebook.com/v8.0/oembed_post?access_token=#{access_token}")
+      )
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider).to include(embed_url)
+    end
+  end
+
+  describe 'FacebookVideo provider' do
+    let(:provider) { OEmbed::Providers::FacebookVideo.new(access_token: access_token) }
+    let(:embed_url) { 'https://www.facebook.com/exampleuser/videos/1234567890' }
+
+    it 'sets the endpoint URL' do
+      expect(provider.endpoint).to(
+        eq("https://graph.facebook.com/v8.0/oembed_video?access_token=#{access_token}")
+      )
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider).to include(embed_url)
+    end
+  end
+
+  describe 'Instagram provider' do
+    let(:provider) { OEmbed::Providers::Instagram.new(access_token: access_token) }
+    let(:embed_url) { 'https://www.instagram.com/p/r4nd0m1mg/' }
+
+    it 'sets the endpoint URL' do
+      expect(provider.endpoint).to(
+        eq("https://graph.facebook.com/v8.0/instagram_oembed?access_token=#{access_token}")
+      )
+    end
+
+    it 'recognizes embed URLs' do
+      expect(provider).to include(embed_url)
+    end
+  end
+end

data/spec/providers_spec.rb

@@ -210,6 +210,54 @@ describe OEmbed::Providers do
       end
     end
 
+    describe 'register_access_token_providers' do
+      describe 'tokens[:facebook]' do
+        let(:access_token) { 'my-fake-access-token' }
+        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
+          each.run
+          ENV['OEMBED_FACEBOOK_TOKEN'] = previous_value
+          OEmbed::Providers.unregister_all
+        end
+
+        subject { OEmbed::Providers.find(embed_url) }
+
+        context 'when NO access token is provided' do
+          before do
+            OEmbed::Providers.register_all
+          end
+
+          it { is_expected.to_not be_a(OEmbed::Providers::FacebookPost) }
+        end
+
+        context 'when access token is provided to register_all' do
+          before do
+            OEmbed::Providers.register_all(access_tokens: { facebook: access_token })
+          end
+
+          it { is_expected.to be_a(OEmbed::Providers::FacebookPost) }
+        end
+
+        context 'when access token is set as an environment variable' do
+          before do
+            ENV['OEMBED_FACEBOOK_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) }
+        end
+      end
+    end
+
     describe 'add_official_provider' do
       it "should register a new official provider" do
         expect(defined?(OEmbed::Providers::Fake)).to_not be

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-oembed
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Magnus Holm
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -79,9 +79,12 @@ files:
 - lib/oembed/provider.rb
 - lib/oembed/provider_discovery.rb
 - lib/oembed/providers.rb
-- lib/oembed/providers/embedly_urls.yml
-- lib/oembed/providers/noembed_urls.yml
-- lib/oembed/providers/oohembed_urls.yml
+- lib/oembed/providers/aggregators/embedly_urls.yml
+- lib/oembed/providers/aggregators/noembed_urls.yml
+- lib/oembed/providers/aggregators/oohembed_urls.yml
+- lib/oembed/providers/facebook_post.rb
+- lib/oembed/providers/facebook_video.rb
+- lib/oembed/providers/instagram.rb
 - lib/oembed/response.rb
 - lib/oembed/response/link.rb
 - lib/oembed/response/photo.rb
@@ -105,6 +108,7 @@ files:
 - spec/formatter_spec.rb
 - spec/provider_discovery_spec.rb
 - spec/provider_spec.rb
+- spec/providers/facebook_spec.rb
 - spec/providers/slideshare_spec.rb
 - spec/providers/twitter_spec.rb
 - spec/providers_spec.rb
@@ -121,7 +125,7 @@ rdoc_options:
 - "--main"
 - README.rdoc
 - "--title"
-- ruby-oembed-0.13.1
+- ruby-oembed-0.14.0
 - "--inline-source"
 - "--exclude"
 - tasks
@@ -139,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: oEmbed for Ruby
@@ -158,6 +162,7 @@ test_files:
 - spec/formatter_spec.rb
 - spec/provider_discovery_spec.rb
 - spec/provider_spec.rb
+- spec/providers/facebook_spec.rb
 - spec/providers/slideshare_spec.rb
 - spec/providers/twitter_spec.rb
 - spec/providers_spec.rb