thetvdb_party 0.0.13.pre → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce7a724e350ab2d80b5e574e8a796e804d878bf7
-  data.tar.gz: 5a4c17f77cd912885baca62f0af0a1350a3848c4
+  metadata.gz: 8472d976bd85da62543a93220c01863222a780f4
+  data.tar.gz: 206d4ec2214ef2c0cdf80751a83bb175b2ba0533
 SHA512:
-  metadata.gz: f9aa0d56803fd445b98eeb30d9ff4dff8694203bfcaea746cf36411727ac05d67fbdd3b21c67a5b39ff27cc39cb93bca2610d5a0b74db06d143f247bc1347f27
-  data.tar.gz: d0effd5dc336ac05356c698f156b4d82e7b8c584fd42db41f31a9c2494a40b4d6d3b904b6b3ffbac1bcf546613e225963016b21d0b63ddad22ce035923f2c8c4
+  metadata.gz: 60de102168d193eb91044c38579a99bbc4d2eb13b5f30d1d0500452633412650f2d226682bac4823a4f8bc1e5b67e3a8e64db64383a33219557ba3fa8b44ff86
+  data.tar.gz: e4476c01fa35228441a03d046c2f29d45d6f94f3a85279786b1c62a093df1fea2a653d67b214f00e5036a0a80567c352d98622470fb8b2fee89c200fd312fd21

data/.gitignore

@@ -215,3 +215,6 @@ ModelManifest.xml
 *.a
 *.gem
 mkmf.log
+
+# Ignore environment file 
+.env.yml

data/Sample Environment Configuration.yml

@@ -0,0 +1,10 @@
+# Rename this file to .env.yml
+# Add account settings and API keys here.
+# This file should be listed in .gitignore to keep your settings secret!
+# Each entry gets set as a local environment variable.
+# This file overrides ENV variables in the Unix shell.
+# For example, setting:
+# GMAIL_USERNAME: 'Your_Gmail_Username'
+# makes 'Your_Gmail_Username' available as ENV["GMAIL_USERNAME"]
+
+TVDB_API_KEY: '<YOUR API KEY>'

data/lib/thetvdb_party.rb

@@ -1,6 +1,8 @@
 require 'httparty'
+require 'zip'
 
 require 'thetvdb_party/baseseriesrecord'
+require 'thetvdb_party/fullseriesrecord'
 require 'thetvdb_party/baseepisoderecord'
 require 'thetvdb_party/client'
 require 'thetvdb_party/searchseriesrecord'
@@ -9,6 +11,7 @@ require 'thetvdb_party/banner'
 require 'thetvdb_party/version'
 require 'thetvdb_party/banner'
 require 'thetvdb_party/actor'
+require 'thetvdb_party/all'
 
 # thetvdb_party gem root namespace
 module TheTvDbParty

data/lib/thetvdb_party/all.rb

@@ -1,34 +1,40 @@
 module TheTvDbParty
   class AllSeriesInformation
 
-    attr_reader :actors, :banners, :series, :episodes
-    
-    def initialize(client, zip_file)
+    attr_reader :client, :actors, :banners, :full_series_record
+
+    def initialize(client, zip_buffer)
       @client = client
 
-      unzip_file(zip_file)
+      unzip_file(zip_buffer)
 
     end
 
     private
-    def unzip_file(zip_file)
-      @series = BaseSeriesRectord.new(@client, zip_file.glob("Series").input_stream.read)
+    def unzip_file(zip_buffer)
       @actors = []
       @banners = []
-      @episodes = []
-  
-      zip_file.glob("Actors").each do |actor|
-        @actors << Actor.new(@client, actor.input_stream.read)
-      end
-  
-      zip_file.glob("Banners").each do |banner|
-        @banners << Banner.new(@client, banner.input_stream.read)
-      end
-  
-      zip_file.glob("Episode").each do |episode|
-        @episodes << Episode.new(@client, episode.input_stream.read)
+
+      zip_file = Zip::InputStream.open(StringIO.new(zip_buffer))
+
+      while entry = zip_file.get_next_entry
+        case entry.name
+          when "en.xml"
+            full_hash = MultiXml.parse(entry.get_input_stream.read)
+            @full_series_record = FullSeriesRecord.new(@client, full_hash["Data"])
+          when "actors.xml"
+            actors_hash = MultiXml.parse(entry.get_input_stream.read)
+
+            actors_hash["Actors"]["Actor"].each do |a|
+              actors << Actor.new(@client, a)
+            end if actors_hash["Actors"]
+          when "banners.xml"
+            banners_hash = MultiXml.parse(entry.get_input_stream.read)
+            banners_hash["Banners"]["Banner"].each do |b|
+              banners << Banner.new(@client, b)
+            end if banners_hash["Banners"]
+        end
       end
-  
     end
   end
 end

data/lib/thetvdb_party/baseseriesrecord.rb

@@ -121,6 +121,10 @@ module TheTvDbParty
       @client.get_series_actors @seriesid
     end
 
+    def get_full_series_record
+      @client.get_full_series_record @seriesid
+    end
+
     private
     def read_hash_values
       begin

data/lib/thetvdb_party/client.rb

@@ -179,17 +179,33 @@ module TheTvDbParty
 
     def get_series_all(seriesid)
       unless @language
-        request_url = "#{@apikey}/series/#{seriesid}/all"
+        request_url = "#{@apikey}/series/#{seriesid}/all/en.zip"
       else
         request_url = "#{@apikey}/series/#{seriesid}/all/#{@language}.zip"
       end
 
+      request_url = URI.join(BASE_URL, 'api/', request_url)
       resp = self.class.get(request_url)
 
-      return nil unless resp.body.extname == ".zip"
+      return nil unless resp.body
+
+      AllSeriesInformation.new(self, resp.body)
+
+    end
+
+    def get_full_series_record(seriesid)
+      unless @language
+        request_url = "#{@apikey}/series/#{seriesid}/all"
+      else
+        request_url = "#{@apikey}/series/#{seriesid}/all/#{@language}.xml"
+      end
+      request_url = URI.join(BASE_URL, 'api/', request_url)
+
+      resp = self.class.get(request_url).parsed_response
 
-      AllSeriesInformation.new(@client, resp.body)
+      return nil unless resp["Data"]
 
+      FullSeriesRecord.new self, resp["Data"]
     end
 
     private

data/lib/thetvdb_party/fullseriesrecord.rb

@@ -0,0 +1,20 @@
+module TheTvDbParty
+  class FullSeriesRecord < BaseSeriesRecord
+
+    attr_reader :episodes
+
+    def initialize(client, hashValues)
+      super client, hashValues["Series"]
+
+      episodesHashValue = hashValues["Episode"]
+      case episodesHashValue
+        when Array
+          @episodes = episodesHashValue.map { |episodeHashValues| BaseEpisodeRecord.new client, episodeHashValues }
+        when Hash
+          @episodes = [ BaseEpisodeRecord.new(client, episodesHashValue) ]
+        else
+          @episodes = []
+      end
+    end
+  end
+end

data/lib/thetvdb_party/searchseriesrecord.rb

@@ -52,6 +52,10 @@ module TheTvDbParty
       @client.get_base_series_record @seriesid
     end
 
+    def get_full_series_record
+      @client.get_full_series_record @seriesid
+    end
+
     private
     def read_hash_values
       begin

data/lib/thetvdb_party/version.rb

@@ -1,4 +1,4 @@
 module TheTvDbParty
   # The current version of the *thetvdb_party* gem
-  VERSION = "0.0.13.pre"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause
@@ -16,6 +18,7 @@
 # users commonly want.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate
   # assertion/expectation library such as wrong or the stdlib/minitest
@@ -40,6 +43,11 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
+  env_file = '.env.yml'
+  YAML.load(File.open(env_file)).each do |key, value|
+    ENV[key.to_s] = value
+  end if File.exist?(env_file)
+
 # The settings below are suggested to provide a good initial experience
 # with RSpec, but feel free to customize to your heart's content.
 =begin

data/spec/thetvdb_party/all_spec.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'thetvdb_party'
+
+describe 'TheTvDbParty::AllSeriesInformation' do
+
+  before(:each) do
+    @client = TheTvDbParty::Client.new(ENV["TVDB_API_KEY"])
+    results = @client.search('The Big Bang Theory')
+    @all_series_info = @client.get_series_all(results.first.seriesid)
+    expect(@all_series_info).to_not be_nil
+  end
+
+
+  it 'should have a valid client' do
+    expect(@all_series_info.client).to be_an_instance_of(TheTvDbParty::Client)
+  end
+
+  it 'should contain a series class' do
+    expect(@all_series_info.full_series_record).to be_an_instance_of(TheTvDbParty::FullSeriesRecord)
+  end
+
+  it 'should contain a list of banner classes' do
+    expect(@all_series_info.banners).to  be_an_instance_of(Array)
+    @all_series_info.banners.each do |b|
+      expect(b).to be_an_instance_of(TheTvDbParty::Banner)
+    end
+  end
+end

data/spec/thetvdb_party/fullseriesrecord_spec.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+require 'thetvdb_party'
+
+describe 'TheTvDbParty::FullSeriesRecord' do
+
+  it 'should have an empty episode list if no episodes are specified' do
+    record = TheTvDbParty::FullSeriesRecord.new nil, { "Series" => {  } }
+    expect(record.episodes).to be_an(Array)
+    expect(record.episodes).to be_empty
+  end
+
+  it 'should have a single entry episode list, if only one Episode is specified' do
+    record = TheTvDbParty::FullSeriesRecord.new nil, { "Series" => {  }, "Episode" => { } }
+    expect(record.episodes).to be_an(Array)
+    expect(record.episodes.length).to eq 1
+    record.episodes.each { |episode_record| expect(episode_record).to be_a(TheTvDbParty::BaseEpisodeRecord) }
+  end
+
+  it 'should have multiple entries in the episode list, if more than one Episode is specified' do
+    record = TheTvDbParty::FullSeriesRecord.new nil, { "Series" => {  }, "Episode" => [ { }, { } ] }
+    expect(record.episodes).to be_an(Array)
+    expect(record.episodes.length).to be > 1
+    record.episodes.each { |episode_record| expect(episode_record).to be_a(TheTvDbParty::BaseEpisodeRecord) }
+  end
+
+  it 'should not instantiate when constructed with nil hash values' do
+    expect { TheTvDbParty::FullSeriesRecord.new nil, nil }.to raise_error
+  end
+
+  it 'should not instantiate when constructed with a hash missing the Series tag' do
+    expect { TheTvDbParty::FullSeriesRecord.new nil, { } }.to raise_error
+  end
+end

data/spec/thetvdb_party_spec.rb

@@ -19,4 +19,19 @@ describe 'TheTvDbParty' do
       expect(base_series_record.seriesid).to eq result_record.seriesid
     end
   end
+
+  it 'should find the Full Series Record for search results and this should include an episode list' do
+    client = TheTvDbParty::Client.new(ENV["TVDB_API_KEY"])
+    pending "No API key available, test cannot run. Configure .env file to include an api key." unless client.apikey
+    client.search("The Mentalist").each do |result_record|
+      expect(result_record).to be_a TheTvDbParty::SearchSeriesRecord
+      full_series_record = result_record.get_full_series_record
+      expect(full_series_record).to be_a TheTvDbParty::FullSeriesRecord
+      expect(full_series_record.seriesid).to eq result_record.seriesid
+      expect(full_series_record.episodes.length).to be > 0
+      full_series_record.episodes.each do |base_episode_record|
+        expect(base_episode_record.seriesid).to eq full_series_record.seriesid
+      end
+    end
+  end
 end

data/thetvdb_party.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |spec|
   spec.email         = ["fredrik.rasch@gmail.com", "tim.teige91@gmail.com", "peterme@peterme.net"]
   spec.summary       = "Ruby Gem for accessing the TheTVDB programmers API"
   spec.description   = <<-EOF
-    NOTE: This Gem is currently in its pre-alpha development stadium and currently only supports minimal capability.
     The thetvdb_party gem accesses the TheTvDB programmers API as it is described on \"http://thetvdb.com/wiki/index.php/Programmers_API\".
     It uses compression to minimize bandwith when accessing Full Series Records.
     EOF
@@ -29,6 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "coderay", "~> 1.1"
 
-  spec.add_dependency "httparty", "~> 0.6"
   spec.add_dependency "rubyzip", "~> 1.1"
+  spec.add_dependency "httparty", "~> 0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thetvdb_party
 version: !ruby/object:Gem::Version
-  version: 0.0.13.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Fredrik Høisæther Rasch
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-27 00:00:00.000000000 Z
+date: 2015-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,35 +71,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rubyzip
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0.6'
 description: |2
-      NOTE: This Gem is currently in its pre-alpha development stadium and currently only supports minimal capability.
       The thetvdb_party gem accesses the TheTvDB programmers API as it is described on "http://thetvdb.com/wiki/index.php/Programmers_API".
       It uses compression to minimize bandwith when accessing Full Series Records.
 email:
@@ -117,6 +116,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Sample Environment Configuration.yml
 - lib/thetvdb_party.rb
 - lib/thetvdb_party/actor.rb
 - lib/thetvdb_party/all.rb
@@ -124,14 +124,17 @@ files:
 - lib/thetvdb_party/baseepisoderecord.rb
 - lib/thetvdb_party/baseseriesrecord.rb
 - lib/thetvdb_party/client.rb
+- lib/thetvdb_party/fullseriesrecord.rb
 - lib/thetvdb_party/searchseriesrecord.rb
 - lib/thetvdb_party/version.rb
 - spec/spec_helper.rb
 - spec/thetvdb_party/actor_spec.rb
+- spec/thetvdb_party/all_spec.rb
 - spec/thetvdb_party/banner_spec.rb
 - spec/thetvdb_party/baseepisoderecord_spec.rb
 - spec/thetvdb_party/baseseriesrecord_spec.rb
 - spec/thetvdb_party/client_spec.rb
+- spec/thetvdb_party/fullseriesrecord_spec.rb
 - spec/thetvdb_party/searchseriesrecord_spec.rb
 - spec/thetvdb_party_spec.rb
 - thetvdb_party.gemspec
@@ -155,9 +158,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -167,10 +170,12 @@ summary: Ruby Gem for accessing the TheTVDB programmers API
 test_files:
 - spec/spec_helper.rb
 - spec/thetvdb_party/actor_spec.rb
+- spec/thetvdb_party/all_spec.rb
 - spec/thetvdb_party/banner_spec.rb
 - spec/thetvdb_party/baseepisoderecord_spec.rb
 - spec/thetvdb_party/baseseriesrecord_spec.rb
 - spec/thetvdb_party/client_spec.rb
+- spec/thetvdb_party/fullseriesrecord_spec.rb
 - spec/thetvdb_party/searchseriesrecord_spec.rb
 - spec/thetvdb_party_spec.rb
 has_rdoc: