Module: FilmOn::Services::VideoOnDemand

Included in:
Base
Defined in:
lib/film_on/services/video_on_demand.rb

Instance Method Summary collapse

Instance Method Details

#convert_genres(json) ⇒ Object

convert_genres: takes the raw JSON and converts it into a nice ruby array of objects



89
90
91
92
 
# File 'lib/film_on/services/video_on_demand.rb', line 89

def convert_genres(json)
  hash = JSON.parse(json)["response"]
  hash.map{|gen| FilmOn::Genre.new(gen)}
end

#convert_movie(json) ⇒ Object

convert_movie: takes the raw JSON and coverts it into a nice ruby object normal for use after storing the JSON in a caching mechanism



81
82
83
84
 
# File 'lib/film_on/services/video_on_demand.rb', line 81

def convert_movie(json)
  hash = JSON.parse(json)["response"]
  FilmOn::Movie.new(hash)
end

#convert_movies(json) ⇒ Object

convert_movies: takes the raw JSON and coverts it into a nice array of ruby objects normal for use after storing the JSON in a caching mechanism



71
72
73
74
 
# File 'lib/film_on/services/video_on_demand.rb', line 71

def convert_movies(json)
  hash = JSON.parse(json)["response"]
  hash.map{|movie| FilmOn::Movie.new(movie) }
end

#genres(opts = {}) ⇒ Object

Ref: www.filmon.com/page/api-vod



7
8
9
10
11
12
13
14
 
# File 'lib/film_on/services/video_on_demand.rb', line 7

def genres(opts={})
  return @genres if @genres && !opts[:json]
  json = get_vod("genres")
  if opts[:json]
    return json
  end
  @genres = convert_genres(json)
end

#movie(id, opts = {}) ⇒ Object

movie: retrieve a specific movie with a given id



56
57
58
59
60
61
62
63
64
 
# File 'lib/film_on/services/video_on_demand.rb', line 56

def movie(id, opts={})
  id = id.to_s
  return @movie[id] if @movie[id] && !opts[:json]
  json = get_vod("movie", {id: id})
  if opts[:json]
    return json
  end
  @movie[id] = convert_movie(json)
end

#movies(params = {}, opts = {}) ⇒ Object

movies: calls the vod/search and returns a list of movies filtered by the params i.e. film_on.movies(genre: “horror”) will return all horror movies

Params examples:

term: Set this to the word or term to search the catalog for. The FilmOn VOD API searches the title and synopses of catalog titles for a match. This parameter is required.

start_index: Set this to a zero-based offset into the list that results from the query. By using this with the max_results parameter, you can request successive pages of search results.

max_results: Set this to the maximum number of results to return. This number cannot be greater than 100. If you do not specify max_results, the default value is 25.

parent_id: search for episodes of specified series.

order_by: Order search results by one of following strategies: “relevance” or “date”

content_type: Filter and return search results only for specified content_type. Parameter value should be one of : “relevance” or “date”

genre: Filter and search for movies only in specified genre. Parameter value should be a slug of corresponding genre, retrieved from /api/vod/genres resource.



44
45
46
47
48
49
50
51
52
 
# File 'lib/film_on/services/video_on_demand.rb', line 44

def movies(params={}, opts={})
  key = Digest::MD5.hexdigest(params.to_s)
  return @vod_search[key] if @vod_search[key] && !opts[:json]
  json = get_vod("search", params)
  if opts[:json]
    return json
  end
  @vod_search[key] = convert_movies(json)
end