tvdbjson 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f31635d50ebac2a73984a6a67ff90ada68e1e64
-  data.tar.gz: 556dad6d367076be42d09893689777e9a2363938
+  metadata.gz: c8d402112883f10ef7fde9d3f7b3b2094f511253
+  data.tar.gz: 59bdbe4dab687f6c6fcff256d7d331dcd6d7fa3c
 SHA512:
-  metadata.gz: c278a1a3ad4341da93bb431bd87c328d61e4ead7fb5470f85ca417b32076b02e1a444289e55d5476158ae31cc173dd9c34c935d5faff2a61a50d4b5d7adaa509
-  data.tar.gz: e7b45149f67cc04141adc869c572bd81c78f382ce6c325861cc5df17433040e8f1507a36fba54de38983a5d319faff2bf77dd3da236cb4ba76d04f353703f2f0
+  metadata.gz: 69585683eef478df42459d47ac9cc667d88e93a52e3463e658aa1ff0b17a1b99e24eda0d193a16c2c2a50d4edda7e721554148a75efd562ca0b83e7d148d7dcc
+  data.tar.gz: 740017e3bdd296f850a130820ed1193a974d626a05513e7806ce48b7f62624cbb15257aa58baead652b5cc6a8024bc08a4241832c7b79aee43a83714fc88b7b8

data/README.md

@@ -5,7 +5,7 @@ A super-unofficial Ruby Gem for thetvdb.com ['swagger' api](https://api.thetvdb.
 
 ### Install the gem
 
-Visit [rubygems](https://rubygems.org/gems/thetvdbjson) for instructions on how to install this gem via the command line, or for how to include it in your gemfile.
+Visit [rubygems](https://rubygems.org/gems/tvdbjson) for instructions on how to install this gem via the command line, or for how to include it in your gemfile.
 
 ### Create some environment variables
 [Create an account](https://www.thetvdb.com/?tab=register) and [register for your API Key](https://www.thetvdb.com/?tab=apiregister) on thetvdb.com
@@ -66,6 +66,7 @@ You're going to need to read the source for full details, as this gem is a work
   search_options = { :series_id => game_of_thrones.id, :type => "season", :subkey => 5 }
   image_results = Tvdbjson::Image.search_by_series_and_season(search_options, auth)
 
+# Or graphical fanart of a Television series (the other option being text)
   search_options = { :series_id => game_of_thrones.id, :type => "fanart", :subkey => "graphical" }
   image_results = Tvdbjson::Image.search_by_series_and_season(search_options, auth)
 
@@ -73,6 +74,10 @@ You're going to need to read the source for full details, as this gem is a work
   search_query = { :series_id => game_of_thrones.id, :season_number => 6, :episode_number => 9 }
   episode_results = Tvdbjson::Episode.search_by_season_and_episode(search_query,auth)
 
+# Return all episodes, on all pages for a series (may take a while)
+  search_options = { :series_id => game_of_thrones.id }
+  episode_results = Tvdbjson::Episode.all_episodes(search_options,auth)
+
 ```
 
 ## License

data/lib/tvdbjson/episode.rb

@@ -1,3 +1,4 @@
+require "pry-byebug"
 module Tvdbjson
   class Episode
     include Tvdbjson::Hashable
@@ -15,6 +16,43 @@ module Tvdbjson
       @overview       = options[:overview]
     end
 
+    def self.all_episodes(options = {}, authentication)
+      raise Tvdbjson::RequiredSeriesIdMissingError if !options[:series_id]
+      raise Tvdbjson::AuthenticationObjectMissingError unless authentication.kind_of?(Tvdbjson::Authentication)
+
+      hash = {
+        :method       => "GET",
+        :uri          => "/series/#{options[:series_id]}/episodes",
+        :params       => { "page" => 1 }
+      }
+
+      # Create an empty array for all episodes
+      arr = []
+
+      # Receive the first page of results
+      response = send_authenticated_request(hash, authentication)
+
+      # Store the Page count to retrieve additional pages in the future
+      page_count = get_page_count_from_response(response)
+
+      # Whilst we have the response object for page 1, let's add it to our array
+      arr.concat( Episode.from_response(response,options[:series_id]) )
+
+      # Now to process the additional pages (starting with page 2)
+      (2..page_count).each do |page_number|
+        hash = {
+          :method       => "GET",
+          :uri          => "/series/#{options[:series_id]}/episodes",
+          :params       => { "page" => page_number }
+        }
+        response = send_authenticated_request(hash, authentication)
+        arr.concat( Episode.from_response(response,options[:series_id]) )
+      end
+
+      arr
+
+    end
+
     def self.search_by_season_and_episode(options = {}, authentication)
       raise Tvdbjson::RequiredSeriesIdMissingError if !options[:series_id]
       raise Tvdbjson::RequiredSearchParamMissingError if !options[:season_number]
@@ -54,5 +92,9 @@ module Tvdbjson
       results_array
     end
 
+    def self.get_page_count_from_response(response)
+      response.parsed_response["links"]["last"]
+    end
+
   end
 end

data/lib/tvdbjson/version.rb

@@ -1,3 +1,3 @@
 module Tvdbjson
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tvdbjson
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Tennant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug