Class: YouTubeIt::Request::VideoSearch

Inherits:
BaseSearch
  • Object
show all
Includes:
FieldSearch
Defined in:
lib/youtube_it/request/video_search.rb

Overview

:nodoc:

Constant Summary

ONLY_EMBEDDABLE =
5

Instance Attribute Summary (collapse)

Attributes inherited from BaseSearch

#url

Instance Method Summary (collapse)

Methods included from FieldSearch

#default_fields, #fields_to_params, #formatted_date

Constructor Details

- (VideoSearch) initialize(params = {})

Returns a new instance of VideoSearch



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
# File 'lib/youtube_it/request/video_search.rb', line 32

def initialize(params={})
  # Initialize our various member data to avoid warnings and so we'll
  # automatically fall back to the youtube api defaults
  @max_results, @order_by,
  @offset, @query,
  @response_format, @video_format,
  @safe_search, @author, @lang,
  @duration, @time, @hd, @caption,
  @uploader, @region, @location, @location_radius, @paid_content = nil
  @url = base_url
  @dev_key = params[:dev_key] if params[:dev_key]

  # Return a single video (base_url + /T7YazwP8GtY)
  return @url << "/" << params[:video_id] << "?v=#{YouTubeIt::API_VERSION}" if params[:video_id]

  @url << "/-/" if (params[:categories] || params[:tags])
  @url << categories_to_params(params.delete(:categories)) if params[:categories]
  @url << tags_to_params(params.delete(:tags)) if params[:tags]

  set_instance_variables(params)

  if( params[ :only_embeddable ] )
    @video_format = ONLY_EMBEDDABLE
  end

  @url << build_query_params(to_youtube_params)
  @url << fields_to_params(params.delete(:fields)) if params[:fields]
end

Instance Attribute Details

- (Object) author (readonly)

Returns the value of attribute author



18
19
20
# File 'lib/youtube_it/request/video_search.rb', line 18

def author
  @author
end

- (Object) caption (readonly)

Returns the value of attribute caption



24
25
26
# File 'lib/youtube_it/request/video_search.rb', line 24

def caption
  @caption
end

- (Object) categories (readonly)

Returns the value of attribute categories



15
16
17
# File 'lib/youtube_it/request/video_search.rb', line 15

def categories
  @categories
end

- (Object) duration (readonly)

Returns the value of attribute duration



21
22
23
# File 'lib/youtube_it/request/video_search.rb', line 21

def duration
  @duration
end

- (Object) hd (readonly)

Returns the value of attribute hd



23
24
25
# File 'lib/youtube_it/request/video_search.rb', line 23

def hd
  @hd
end

- (Object) lang (readonly)

lt



19
20
21
# File 'lib/youtube_it/request/video_search.rb', line 19

def lang
  @lang
end

- (Object) location (readonly)

Returns the value of attribute location



28
29
30
# File 'lib/youtube_it/request/video_search.rb', line 28

def location
  @location
end

- (Object) location_radius (readonly)

Returns the value of attribute location_radius



29
30
31
# File 'lib/youtube_it/request/video_search.rb', line 29

def location_radius
  @location_radius
end

- (Object) max_results (readonly)

Returns the value of attribute max_results



9
10
11
# File 'lib/youtube_it/request/video_search.rb', line 9

def max_results
  @max_results
end

- (Object) offset (readonly)

Returns the value of attribute offset



11
12
13
# File 'lib/youtube_it/request/video_search.rb', line 11

def offset
  @offset
end

- (Object) order_by (readonly)

Returns the value of attribute order_by



10
11
12
# File 'lib/youtube_it/request/video_search.rb', line 10

def order_by
  @order_by
end

Returns the value of attribute paid_content



27
28
29
# File 'lib/youtube_it/request/video_search.rb', line 27

def paid_content
  @paid_content
end

- (Object) query (readonly)

Returns the value of attribute query



12
13
14
# File 'lib/youtube_it/request/video_search.rb', line 12

def query
  @query
end

- (Object) region (readonly)

Returns the value of attribute region



26
27
28
# File 'lib/youtube_it/request/video_search.rb', line 26

def region
  @region
end

- (Object) response_format (readonly)

Returns the value of attribute response_format



13
14
15
# File 'lib/youtube_it/request/video_search.rb', line 13

def response_format
  @response_format
end

- (Object) restriction (readonly)

Returns the value of attribute restriction



20
21
22
# File 'lib/youtube_it/request/video_search.rb', line 20

def restriction
  @restriction
end

- (Object) safe_search (readonly)

max_results orderby, ([relevance], viewCount, published, rating) start-index vq alt, ([atom], rss, json) /-/tag1/tag2 /-/Category1/Category2 format (1=mobile devices) safeSearch (none, [moderate], strict)



17
18
19
# File 'lib/youtube_it/request/video_search.rb', line 17

def safe_search
  @safe_search
end

- (Object) tags (readonly)

Returns the value of attribute tags



14
15
16
# File 'lib/youtube_it/request/video_search.rb', line 14

def tags
  @tags
end

- (Object) time (readonly)

Returns the value of attribute time



22
23
24
# File 'lib/youtube_it/request/video_search.rb', line 22

def time
  @time
end

- (Object) uploader (readonly)

Returns the value of attribute uploader



25
26
27
# File 'lib/youtube_it/request/video_search.rb', line 25

def uploader
  @uploader
end

- (Object) video_format (readonly)

Returns the value of attribute video_format



16
17
18
# File 'lib/youtube_it/request/video_search.rb', line 16

def video_format
  @video_format
end