Class: OEmbed::Response

Inherits:

Object

• Object
• OEmbed::Response

show all

Defined in:

lib/oembed/response.rb,
lib/oembed/response/rich.rb,
lib/oembed/response/link.rb,
lib/oembed/response/photo.rb,
lib/oembed/response/video.rb

Overview

@response.type #=> 'rich'
@response.field('width') #=> '500'
@response.width #=> '500'

Defined Under Namespace

Classes: Link, Photo, Rich, Video

Instance Attribute Summary (collapse)

• - (Object) fields readonly

  An Hash of data (probably from a Provider) just as it was parsed.

• - (Object) format readonly

  The name of the format used get this data from the Provider (e.g. 'json').

• - (Object) provider readonly

  The Provider instance that generated this Response.

• - (Object) request_url readonly

  The URL that was sent to the provider, that this Response contains data about.

Class Method Summary (collapse)

• + (Object) create_for(raw, provider, url, format)

  Create a new Response instance of the correct type given raw which is data from the provider, about the url, in the given format that needs to be decoded.

Instance Method Summary (collapse)

• - (Object) field(key)

  The String value associated with this key.

• - (Response) initialize(fields, provider, url = nil, format = nil) constructor

  A new instance of Response.

• - (Boolean) link?

  Returns true if this is an oEmbed link response.

• - (Boolean) photo?

  Returns true if this is an oEmbed photo response.

• - (Boolean) rich?

  Returns true if this is an oEmbed rich response.

• - (Boolean) video?

  Returns true if this is an oEmbed video response.

40
41
42
43
44
45
46

# File 'lib/oembed/response.rb', line 40

def initialize(fields, provider, url=nil, format=nil)
  @fields = fields
  @provider = provider
  @request_url = url
  @format = format
  define_methods!
end

12
13
14

# File 'lib/oembed/response.rb', line 12

def fields
  @fields
end

21
22
23

# File 'lib/oembed/response.rb', line 21

def format
  @format
end

15
16
17

# File 'lib/oembed/response.rb', line 15

def provider
  @provider
end

18
19
20

# File 'lib/oembed/response.rb', line 18

def request_url
  @request_url
end

26
27
28
29
30
31
32
33
34
35
36
37
38

# File 'lib/oembed/response.rb', line 26

def self.create_for(raw, provider, url, format)
  fields = OEmbed::Formatter.decode(format, raw)

  resp_type = case fields['type']
    when 'photo' then OEmbed::Response::Photo
    when 'video' then OEmbed::Response::Video
    when 'link'  then OEmbed::Response::Link
    when 'rich'  then OEmbed::Response::Rich
    else              self
  end

  resp_type.new(fields, provider, url, format)
end

# The following calls the Object#clone method
@response.clone #=> #<OEmbed::Response:...

# The following returns the value given by the Provider
@response.field(:clone) #=> 'true'

58
59
60

# File 'lib/oembed/response.rb', line 58

def field(key)
  @fields[key.to_s].to_s
end

73
74
75

# File 'lib/oembed/response.rb', line 73

def link?
  is_a?(OEmbed::Response::Link)
end

68
69
70

# File 'lib/oembed/response.rb', line 68

def photo?
  is_a?(OEmbed::Response::Photo)
end

78
79
80

# File 'lib/oembed/response.rb', line 78

def rich?
  is_a?(OEmbed::Response::Rich)
end

63
64
65

# File 'lib/oembed/response.rb', line 63

def video?
  is_a?(OEmbed::Response::Video)
end