Class: OEmbed::Provider

Inherits:
Object
  • Object
show all
Defined in:
lib/oembed/provider.rb

Overview

An OEmbed::Provider has information about an individual oEmbed enpoint.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint, format = OEmbed::Formatter.default) ⇒ Provider

Construct a new OEmbed::Provider instance, pointing at a specific oEmbed endpoint.

The endpoint should be a String representing the http URI of the Provider’s oEmbed endpoint. The endpoint String may also contain a #format portion. In actual requests to this Provider, this string will be replaced with a String representing the request format (e.g. “json”).

If give, the format should be the name of the default format for all request to this Provider (e.g. ‘json’). Defaults to OEmbed::Formatter.default

For example:

# If requests should be sent to:
# "http://my.service.com/oembed?format=#{OEmbed::Formatter.default}"
@provider = OEmbed::Provider.new("http://my.service.com/oembed")

# If requests should be sent to:
# "http://my.service.com/oembed.xml"
@xml_provider = OEmbed::Provider.new("http://my.service.com/oembed.{format}", :xml)

Raises:

  • (ArgumentError) 


46
47
48
49
50
51
52
53
 
# File 'lib/oembed/provider.rb', line 46

def initialize(endpoint, format = OEmbed::Formatter.default)
  endpoint_uri = URI.parse(endpoint.gsub(/[\{\}]/,'')) rescue nil
  raise ArgumentError, "The given endpoint isn't a valid http(s) URI: #{endpoint.to_s}" unless endpoint_uri.is_a?(URI::HTTP)
  
  @endpoint = endpoint
  @urls = []
  @format = format
end

Instance Attribute Details

#endpoint ⇒ Object

The String that is the http URI of the Provider’s oEmbed endpoint. This URL may also contain a {format} portion. In actual requests to this Provider, this string will be replaced with a string representing the request format (e.g. “json”).



9
10
11
 
# File 'lib/oembed/provider.rb', line 9

def endpoint
  @endpoint
end

#format ⇒ Object

The name of the default format for all request to this Provider (e.g. ‘json’).



12
13
14
 
# File 'lib/oembed/provider.rb', line 12

def format
  @format
end

#name ⇒ Object

Deprecated.

Note: This accessor currently isn’t used anywhere in the codebase.

The human-readable name of the Provider.



20
21
22
 
# File 'lib/oembed/provider.rb', line 20

def name
  @name
end

#url ⇒ Object

Deprecated.

Note: Added in a fork of the gem, a while back. I really would like

to get rid of it, though. –Marcos



24
25
26
 
# File 'lib/oembed/provider.rb', line 24

def url
  @url
end

#urls ⇒ Object

An Array of all URL schemes supported by this Provider.



15
16
17
 
# File 'lib/oembed/provider.rb', line 15

def urls
  @urls
end

Instance Method Details

#<<(url) ⇒ Object

Adds the given url scheme to this Provider instance. The url scheme can be either a String, containing wildcards specified with an asterisk, (see oembed.com/#section2.1 for details), or a Regexp.

For example:

@provider << "http://my.service.com/video/*"
@provider << "http://*.service.com/photo/*/slideshow"
@provider << %r{^http://my.service.com/((help)|(faq))/\d+[#\?].*}



64
65
66
67
68
69
70
71
72
 
# File 'lib/oembed/provider.rb', line 64

def <<(url)
  if !url.is_a?(Regexp)
    full, scheme, domain, path = *url.match(%r{([^:]*)://?([^/?]*)(.*)})
    domain = Regexp.escape(domain).gsub("\\*", "(.*?)").gsub("(.*?)\\.", "([^\\.]+\\.)?")
    path = Regexp.escape(path).gsub("\\*", "(.*?)")
    url = Regexp.new("^#{Regexp.escape(scheme)}://#{domain}#{path}")
  end
  @urls << url
end

#build(url, query = {}) ⇒ Object

Deprecated.

Note: This method will be made private in the future.

Raises:



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
 
# File 'lib/oembed/provider.rb', line 94

def build(url, query = {})
  raise OEmbed::NotFound, url unless include?(url)

  query = query.merge({:url=>url})
  # TODO: move this code exclusively into the get method, once build is private.
  this_format = (query[:format] ||= @format.to_s).to_s
  
  endpoint = @endpoint.clone

  if endpoint.include?("{format}")
    endpoint["{format}"] = this_format
    query.delete(:format)
  end

  query = "?" + query.inject("") do |memo, (key, value)|
    "#{key}=#{value}&#{memo}"
  end.chop

  URI.parse(endpoint + query).instance_eval do
    @format = this_format
    def format
      @format
    end
    self
  end
end

#get(url, query = {}) ⇒ Object

Send a request to the Provider endpoint to get information about the given url and return the appropriate OEmbed::Response.

The query parameter should be a Hash of values which will be sent as query parameters in this request to the Provider endpoint. The following special cases apply to the query Hash:

:format

overrides this Provider’s default request format.

:url

will be ignored, replaced by the url param.



82
83
84
85
 
# File 'lib/oembed/provider.rb', line 82

def get(url, query = {})
  query[:format] ||= @format
  OEmbed::Response.create_for(raw(url, query), self, url, query[:format].to_s)
end

#include?(url) ⇒ Boolean

Determine whether the given url is supported by this Provider by matching against the Provider’s URL schemes.

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/oembed/provider.rb', line 89

def include?(url)
  @urls.empty? || !!@urls.detect{ |u| u =~ url }
end

#raw(url, query = {}) ⇒ Object

Deprecated.

Note: This method will be made private in the future.



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
 
# File 'lib/oembed/provider.rb', line 122

def raw(url, query = {})
  uri = build(url, query)
  
  found = false
  max_redirects = 4
  until found
    host, port = uri.host, uri.port if uri.host && uri.port
    res = Net::HTTP.start(uri.host, uri.port) {|http| http.get(uri.request_uri) }
    res.header['location'] ? uri = URI.parse(res.header['location']) : found = true
    if max_redirects == 0
        found = true
    else
        max_redirects = max_redirects - 1
    end
  end
  
  case res
  when Net::HTTPNotImplemented
    raise OEmbed::UnknownFormat, format
  when Net::HTTPNotFound
    raise OEmbed::NotFound, url
  when Net::HTTPOK
    res.body
  else
    raise OEmbed::UnknownResponse, res && res.respond_to?(:code) ? res.code : 'Error'
  end
rescue StandardError
  # Convert known errors into OEmbed::UnknownResponse for easy catching
  # up the line. This is important if given a URL that doesn't support
  # OEmbed. The following are known errors:
  # * Net::* errors like Net::HTTPBadResponse
  # * JSON::JSONError errors like JSON::ParserError
  if defined?(::JSON) && $!.is_a?(::JSON::JSONError) || $!.class.to_s =~ /\ANet::/
    raise OEmbed::UnknownResponse, res && res.respond_to?(:code) ? res.code : 'Error'
  else
    raise $!
  end
end