film_on 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4787ad8b4cebe28bc0697fdd716a4c1a585a12b5
-  data.tar.gz: dd0e52bf341b6458aebeac666a3a18dd3f983722
+  metadata.gz: 0a748636163db9e9fb0332d005515c3af6bd4a86
+  data.tar.gz: 21a48ee2990b1dbbe7fbdd6664235eb1b5326a66
 SHA512:
-  metadata.gz: ceb65b48a1bf538e31fd72934a794d1ee27f5205a2e77d8f469e16aa70d97e26ad8f06dc74d639cc9ad5c296fe9d04d80a4c1d62ddbb9591dbeab09903df7e09
-  data.tar.gz: 108a188e016bcaf4e3b42ef0c544c54755629f6c8a506e2b7b6a308890ca558ee809db4aec9337e3dc08a2a6dd1619873078ec0c4b2d123ab8343f2dce0dab28
+  metadata.gz: dd525415f8aaa93246da1979c9e66891b291faf79c19f8c8acbe88b3ba367ea32dc819e33e8c7477c38d5b091930d5f17c6d4bec24769a2c5abe897eac6e2eea
+  data.tar.gz: ef62a9e866c5e382a81ac62e5309471d569872aeb27a5f44e8a6d3fdc56ae7c05ea7437606e978a9270c7387f2b468ab48236381107e6f71f213c323768a22f0

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/lib/film_on/services/video_on_demand.rb

@@ -2,6 +2,14 @@ module FilmOn
   module Services
     module VideoOnDemand
 
+      # VodSearchResult: Struct to handle the response from the search, which includes
+      # an array of movies, as well as the actual number returned (total)
+      # and the overall total for the seach result (total_found)
+      # to get the array of movies we have to do
+      # film_on.vod_search.movies
+      #
+      VodSearchResult = Struct.new(:total, :total_found, :movies)
+
       # Ref: http://www.filmon.com/page/api-vod
 
       def genres(opts={})
@@ -13,10 +21,12 @@ module FilmOn
         @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
+      # vod_search: calls the vod/search and returns
+      # a list of movies filtered by the params and the number returned (total) and the total number for the search (total_found)
+      # i.e.
+      # film_on.vod_search(genre: "horror").movies => will return all horror movies
+      # film_on.vod_search(genre: "horror").total => will return the number of movies return from the feed
+      # film_on.vod_search(genre: "horror").total_found => will return the total number of movies available with the given params (useful for pagination)
       #
       ## Params examples:
       #
@@ -41,14 +51,14 @@ module FilmOn
       # 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={})
+      def vod_search(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)
+        @vod_search[key] = convert_vod_search(json)
       end
 
       # movie: retrieve a specific movie with a given id
@@ -63,14 +73,18 @@ module FilmOn
         @movie[id] = convert_movie(json)
       end
 
-      # 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
+      # convert_vod_search: takes the raw JSON
+      # and coverts it into an object, which includes
+      # the total, total_found and a nice array of movies as ruby objects
+      # normally for use after storing the JSON in a caching mechanism
       #
-      def convert_movies(json)
-        hash = JSON.parse(json)["response"]
-        hash.map{|movie| FilmOn::Movie.new(movie) }
+      def convert_vod_search(json)
+        hash = JSON.parse(json)
+        VodSearchResult.new(
+           hash["total"],
+           hash["total_found"],
+           hash["response"].map{|movie| FilmOn::Movie.new(movie) }
+        )
       end
 
       # convert_movie: takes the raw JSON

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: film_on
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Stuart Hanscombe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler