1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
#require 'rubygems'
require 'yaml'
module OEmbed
# Allows OEmbed to perform tasks across several, registered, Providers
# at once.
class Providers
class << self
@@urls = {}
@@fallback = []
@@to_register = {}
# A Hash of all url schemes, where the keys represent schemes supported by
# all registered Provider instances and values are an Array of Providers
# that support that scheme.
def urls
@@urls
end
# Given one ore more Provider instances, register their url schemes for
# future get calls.
def register(*providers)
providers.each do |provider|
provider.urls.each do |url|
@@urls[url] ||= []
@@urls[url] << provider
end
end
end
# Given one ore more Provider instances, un-register their url schemes.
# Future get calls will not use these Providers.
def unregister(*providers)
providers.each do |provider|
provider.urls.each do |url|
if @@urls[url].is_a?(Array)
@@urls[url].delete(provider)
@@urls.delete(url) if @@urls[url].empty?
end
end
end
end
# 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)
register(*@@to_register[""])
including_sub_type.each do |sub_type|
register(*@@to_register[sub_type.to_s])
end
end
# Unregister all currently-registered Provider instances.
def unregister_all
@@urls = {}
@@fallback = []
end
# Takes an array of Provider instances or ProviderDiscovery
# Use this method to register fallback providers.
# When the raw or get methods are called, if the URL doesn't match
# any of the registerd url patters the fallback providers
# will be called (in order) with the URL.
#
# A common example:
# OEmbed::Providers.register_fallback(OEmbed::ProviderDiscovery, OEmbed::Providers::OohEmbed)
def register_fallback(*providers)
@@fallback += providers
end
# Returns an array of all registerd fallback Provider instances.
def fallback
@@fallback
end
# Returns a Provider instance who's url scheme matches the given url.
def find(url)
providers = @@urls[@@urls.keys.detect { |u| u =~ url }]
Array(providers).first || nil
end
# Finds the appropriate Provider for this url and return the raw response.
# @deprecated *Note*: This method will be made private in the future.
def raw(url, options = {})
provider = find(url)
if provider
provider.raw(url, options)
else
fallback.each do |p|
return p.raw(url, options) rescue OEmbed::Error
end
raise(OEmbed::NotFound)
end
end
# Finds the appropriate Provider for this url and returns an OEmbed::Response,
# using Provider#get.
def get(url, options = {})
provider = find(url)
if provider
provider.get(url, options)
else
fallback.each do |p|
return p.get(url, options) rescue OEmbed::Error
end
raise(OEmbed::NotFound)
end
end
private
# Takes an OEmbed::Provider instance and registers it so that when we call
# the register_all method, they all register. The sub_type can be be any value
# used to uniquely group providers. Official sub_types are:
# * nil: a normal provider
# * :aggregators: an endpoint for an OEmbed aggregator
def add_official_provider(provider_class, sub_type=nil)
raise TypeError, "Expected OEmbed::Provider instance but was #{provider_class.class}" \
unless provider_class.is_a?(OEmbed::Provider)
@@to_register[sub_type.to_s] ||= []
@@to_register[sub_type.to_s] << provider_class
end
end
# Custom providers:
# Provider for youtube.com
# http://apiblog.youtube.com/2009/10/oembed-support.html
#
# Options:
# * To get the iframe embed code
# OEmbed::Providers::Youtube.endpoint += "?iframe=1"
# * To get the flash/object embed code
# OEmbed::Providers::Youtube.endpoint += "?iframe=0"
# * To require https embed code
# OEmbed::Providers::Youtube.endpoint += "?scheme=https"
Youtube = OEmbed::Provider.new("https://www.youtube.com/oembed?scheme=https")
Youtube << "http://*.youtube.com/*"
Youtube << "https://*.youtube.com/*"
Youtube << "http://*.youtu.be/*"
Youtube << "https://*.youtu.be/*"
add_official_provider(Youtube)
# Provider for flickr.com
Flickr = OEmbed::Provider.new("https://www.flickr.com/services/oembed/")
Flickr << "http://*.flickr.com/*"
Flickr << "https://*.flickr.com/*"
Flickr << "http://flic.kr/*"
Flickr << "https://flic.kr/*"
add_official_provider(Flickr)
# Provider for viddler.com
# http://developers.viddler.com/documentation/services/oembed/
Viddler = OEmbed::Provider.new("http://lab.viddler.com/services/oembed/")
Viddler << "http://*.viddler.com/*"
add_official_provider(Viddler)
# Provider for qik.com
# http://qik.com/blog/qik-embraces-oembed-for-embedding-videos/
Qik = OEmbed::Provider.new("http://qik.com/api/oembed.{format}")
Qik << "http://qik.com/*"
Qik << "http://qik.com/video/*"
add_official_provider(Qik)
# Provider for revision3.com
Revision3 = OEmbed::Provider.new("http://revision3.com/api/oembed/")
Revision3 << "http://*.revision3.com/*"
add_official_provider(Revision3)
# Provider for hulu.com
Hulu = OEmbed::Provider.new("http://www.hulu.com/api/oembed.{format}")
Hulu << "http://www.hulu.com/watch/*"
add_official_provider(Hulu)
# Provider for vimeo.com
# https://developer.vimeo.com/apis/oembed
Vimeo = OEmbed::Provider.new("https://vimeo.com/api/oembed.{format}")
Vimeo << "http://*.vimeo.com/*"
Vimeo << "https://*.vimeo.com/*"
add_official_provider(Vimeo)
# Provider for twitter.com
# https://dev.twitter.com/rest/reference/get/statuses/oembed
Twitter = OEmbed::Provider.new("https://publish.twitter.com/oembed", :json)
Twitter << "https://*.twitter.com/*/status/*"
add_official_provider(Twitter)
# Provider for vine.co
# https://dev.twitter.com/web/vine/oembed
Vine = OEmbed::Provider.new("https://vine.co/oembed.{format}")
Vine << "http://*.vine.co/v/*"
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/*"
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")
Slideshare << 'http://*.slideshare.net/*/*'
Slideshare << 'https://*.slideshare.net/*/*'
Slideshare << 'http://*.slideshare.net/mobile/*/*'
Slideshare << 'https://*.slideshare.net/mobile/*/*'
add_official_provider(Slideshare)
# Provider for yfrog
# http://code.google.com/p/imageshackapi/wiki/OEMBEDSupport
Yfrog = OEmbed::Provider.new("https://www.yfrog.com/api/oembed", :json)
Yfrog << "http://yfrog.com/*"
add_official_provider(Yfrog)
# Provider for imgur.com
Imgur = OEmbed::Provider.new("https://api.imgur.com/oembed.{format}")
Imgur << "https://*.imgur.com/gallery/*"
Imgur << "http://*.imgur.com/gallery/*"
add_official_provider(Imgur)
# provider for mlg-tv
# http://tv.majorleaguegaming.com/oembed
MlgTv = OEmbed::Provider.new("http://tv.majorleaguegaming.com/oembed")
MlgTv << "http://tv.majorleaguegaming.com/video/*"
MlgTv << "http://mlg.tv/video/*"
add_official_provider(MlgTv)
# pownce.com closed in 2008
#Pownce = OEmbed::Provider.new("http://api.pownce.com/2.1/oembed.{format}")
#Pownce << "http://*.pownce.com/*"
#add_official_provider(Pownce)
# Provider for polleverywhere.com
PollEverywhere = OEmbed::Provider.new("http://www.polleverywhere.com/services/oembed/")
PollEverywhere << "http://www.polleverywhere.com/polls/*"
PollEverywhere << "http://www.polleverywhere.com/multiple_choice_polls/*"
PollEverywhere << "http://www.polleverywhere.com/free_text_polls/*"
add_official_provider(PollEverywhere)
# Provider for my.opera.com
# http://my.opera.com/devblog/blog/2008/12/02/embedding-my-opera-content-oembed
MyOpera = OEmbed::Provider.new("http://my.opera.com/service/oembed", :json)
MyOpera << "http://my.opera.com/*"
add_official_provider(MyOpera)
# Provider for clearspring.com
ClearspringWidgets = OEmbed::Provider.new("http://widgets.clearspring.com/widget/v1/oembed/")
ClearspringWidgets << "http://www.clearspring.com/widgets/*"
add_official_provider(ClearspringWidgets)
# Provider for nfb.ca
NFBCanada = OEmbed::Provider.new("http://www.nfb.ca/remote/services/oembed/")
NFBCanada << "http://*.nfb.ca/film/*"
add_official_provider(NFBCanada)
# Provider for scribd.com
Scribd = OEmbed::Provider.new("https://www.scribd.com/services/oembed")
Scribd << "http://*.scribd.com/*"
add_official_provider(Scribd)
# Provider for movieclips.com
MovieClips = OEmbed::Provider.new("http://movieclips.com/services/oembed/")
MovieClips << "http://movieclips.com/watch/*/*/"
add_official_provider(MovieClips)
# Provider for 23hq.com
TwentyThree = OEmbed::Provider.new("http://www.23hq.com/23/oembed")
TwentyThree << "http://www.23hq.com/*"
add_official_provider(TwentyThree)
# Provider for soundcloud.com
# http://developers.soundcloud.com/docs/oembed
SoundCloud = OEmbed::Provider.new("https://soundcloud.com/oembed", :json)
SoundCloud << "http://*.soundcloud.com/*"
SoundCloud << "https://*.soundcloud.com/*"
add_official_provider(SoundCloud)
# Provider for spotify.com
# https://twitter.com/nicklas2k/status/330094611202723840
# http://blog.embed.ly/post/45149936446/oembed-for-spotify
Spotify = OEmbed::Provider.new("https://embed.spotify.com/oembed/")
Spotify << "http://open.spotify.com/*"
Spotify << "https://open.spotify.com/*"
Spotify << "http://play.spotify.com/*"
Spotify << "https://play.spotify.com/*"
Spotify << /^spotify\:(.*?)/
add_official_provider(Spotify)
# Provider for skitch.com
# http://skitch.com/oembed/%3C/endpoint
Skitch = OEmbed::Provider.new("http://skitch.com/oembed")
Skitch << "http://*.skitch.com/*"
Skitch << "https://*.skitch.com/*"
add_official_provider(Skitch)
# Provider for tumblr.com
Tumblr = OEmbed::Provider.new("http://www.tumblr.com/oembed/1.0/", :json)
Tumblr << "http://*.tumblr.com/post/*"
Tumblr << "https://*.tumblr.com/post/*"
add_official_provider(Tumblr)
## Provider for clikthrough.com
# http://corporate.clikthrough.com/wp/?p=275
#Clickthrough = OEmbed::Provider.new("http://www.clikthrough.com/services/oembed/")
#Clickthrough << "http://*.clikthrough.com/theater/video/*"
#add_official_provider(Clickthrough)
## Provider for kinomap.com
# http://www.kinomap.com/#!oEmbed
#Kinomap = OEmbed::Provider.new("http://www.kinomap.com/oembed")
#Kinomap << "http://www.kinomap.com/*"
#add_official_provider(Kinomap)
# Provider for oohembed.com, which is a provider aggregator. See
# OEmbed::Providers::OohEmbed.urls for a full list of supported url schemas.
# Embed.ly has taken over the oohembed.com domain and as of July 20 all oohEmbed
# request will require you use an API key. For details on the transition see
# http://blog.embed.ly/oohembed
OohEmbed = OEmbed::Provider.new("http://oohembed.com/oohembed/", :json)
OohEmbed << "http://*.5min.com/Video/*" # micro-video host
OohEmbed << %r{http://(.*?).amazon.(com|co.uk|de|ca|jp)/(.*?)/(gp/product|o/ASIN|obidos/ASIN|dp)/(.*?)} # Online product shopping
OohEmbed << "http://*.blip.tv/*"
OohEmbed << "http://*.clikthrough.com/theater/video/*"
OohEmbed << "http://*.collegehumor.com/video:*" # Comedic & original videos
OohEmbed << "http://*.thedailyshow.com/video/*" # Syndicated show
OohEmbed << "http://*.dailymotion.com/*"
OohEmbed << "http://dotsub.com/view/*"
OohEmbed << "http://*.flickr.com/photos/*"
OohEmbed << "http://*.funnyordie.com/videos/*" # Comedy video host
OohEmbed << "http://video.google.com/videoplay?*" # Video hosting
OohEmbed << "http://www.hulu.com/watch/*"
OohEmbed << "http://*.kinomap.com/*"
OohEmbed << "http://*.livejournal.com/"
OohEmbed << "http://*.metacafe.com/watch/*" # Video host
OohEmbed << "http://*.nfb.ca/film/*"
OohEmbed << "http://*.photobucket.com/albums/*"
OohEmbed << "http://*.photobucket.com/groups/*"
OohEmbed << "http://*.phodroid.com/*/*/*" # Photo host
OohEmbed << "http://qik.com/*"
OohEmbed << "http://*.revision3.com/*"
OohEmbed << "http://*.scribd.com/*"
OohEmbed << "http://*.slideshare.net/*" # Share presentations online
OohEmbed << "http://*.twitpic.com/*" # Picture hosting for Twitter
OohEmbed << "http://twitter.com/*/statuses/*" # Mirco-blogging network
OohEmbed << "http://*.viddler.com/explore/*"
OohEmbed << "http://www.vimeo.com/*"
OohEmbed << "http://www.vimeo.com/groups/*/videos/*"
OohEmbed << "http://*.wikipedia.org/wiki/*" # Online encyclopedia
OohEmbed << "http://*.wordpress.com/*/*/*/*" # Blogging Engine & community
OohEmbed << "http://*.xkcd.com/*" # A hilarious stick figure comic
OohEmbed << %r{http://yfrog.(com|ru|com.tr|it|fr|co.il|co.uk|com.pl|pl|eu|us)/(.*?)} # image & video hosting
OohEmbed << "http://*.youtube.com/watch*"
# Provider for Embedly.com, which is a provider aggregator. See
# OEmbed::Providers::Embedly.urls for a full list of supported url schemas.
# http://embed.ly/docs/endpoints/1/oembed
#
# You can append your Embed.ly API key to the provider so that all requests are signed
# OEmbed::Providers::Embedly.endpoint += "?key=#{my_embedly_key}"
#
# 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|
Embedly << url
end
add_official_provider(Embedly, :aggregators)
end
end
|
