film_on 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e337a6f5e24579677972f39b52b2cd3214a6ab43
-  data.tar.gz: 0637963eabb1d25c451be26e2db024b7b6808f0e
+  metadata.gz: 0e90957e7c38e5ca34508ffaaf3401086d13fd86
+  data.tar.gz: 72c2071448384b697a74d1dfd6655a0ec2e5d280
 SHA512:
-  metadata.gz: a4904487a19a2e9e4f27f4c04f9045ad0a132e638fa9c62cae1f211f155e172b208030fa354ddc4835c98c6af71769d51a8081a6306e0f13834ab247a5aa2830
-  data.tar.gz: 6d5c99daef0888fb10f81f26130faec795c58f28b521dfd5be40c172e6f61a435ca05e35aab9756ce3fdab17f48a8120fec55f95f8cebe308736a588c41dba3a
+  metadata.gz: 1729168b90f1197aa23946b7a9171f994434fe06976c54c5c645c394157710afb61d82e7ac1838ccb289eacd8061eeb38ffc27754e77f74c3e868ebe6598e937
+  data.tar.gz: c9689f75ed3fa79a49db0526c686aedc687abf6865a32e17c301bb1063c351d5d6d30831b5f07bb03cd7799899e41a658f35bdb412988be6b22921dd2f82e678

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/lib/film_on/models/genre.rb

@@ -0,0 +1,43 @@
+module FilmOn
+
+  # Genre is a group of movies bundled together
+  # such as "Sports" or "Horror"
+  # takes a raw hash and converts it into a nice ruby
+  # object
+
+  class Genre
+
+    Image = Struct.new(:type, :width, :height, :url)
+
+    attr_reader :id, :vendorka_id, :name, :slug, :position
+    attr_reader :content_count, :updated_at, :description, :images
+    attr_reader :standard_image, :retina_image
+
+    def initialize(hash)
+      @id = hash["id"]
+      @vendorka_id = hash["vendorka_id"]
+      @name = hash["name"]
+      @slug = hash["slug"]
+      @position = hash["position"]
+      @content_count = hash["content_count"]
+      @updated_at = hash["updated_at"]
+      @description = hash["description"]
+      @images = get_images(hash["images"])
+    end
+
+    def standard_image
+      images.select{|i| i.type == "logo"}.first
+    end
+
+    def retina_image
+      images.select{|i| i.type == "logo-retina"}.first
+    end
+
+    def get_images(imgs)
+      return [] unless imgs.is_a?(Array)
+      imgs.map{|img| Image.new(img["type"], img["width"], img["height"], img["url"]) }
+    end
+
+  end
+
+end

data/lib/film_on/services/video_on_demand.rb

@@ -2,11 +2,45 @@ module FilmOn
   module Services
     module VideoOnDemand
 
+      # Ref: http://www.filmon.com/page/api-vod
+
+      def genres(opts={})
+        return @genres if @genres && !opts[:json]
+        json = get_vod("genres")
+        if opts[:json]
+          return json
+        end
+        @genres = convert_genres(json)
+      end
+
       # 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.
+
       def movies(params={}, opts={})
         key = Digest::MD5.hexdigest(params.to_s)
         return @vod_search[key] if @vod_search[key] && !opts[:json]
@@ -49,6 +83,14 @@ module FilmOn
         FilmOn::Movie.new(hash)
       end
 
+      # convert_genres: takes the raw JSON
+      # and converts it into a nice ruby array of objects
+      #
+      def convert_genres(json)
+        hash = JSON.parse(json)["response"]
+        hash.map{|gen| FilmOn::Genre.new(gen)}
+      end
+
     end
   end
 end

data/lib/film_on.rb

@@ -7,6 +7,7 @@ require "film_on/models/channel"
 require "film_on/models/group"
 require "film_on/models/programme"
 require "film_on/models/movie"
+require "film_on/models/genre"
 
 module FilmOn
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: film_on
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Stuart Hanscombe
@@ -115,6 +115,7 @@ files:
 - lib/film_on.rb
 - lib/film_on/base.rb
 - lib/film_on/models/channel.rb
+- lib/film_on/models/genre.rb
 - lib/film_on/models/group.rb
 - lib/film_on/models/movie.rb
 - lib/film_on/models/programme.rb