the_tv_db 0.0.5 → 0.0.6

data/README.md

@@ -1,4 +1,4 @@
-# TheTvDB [![Build Status](https://travis-ci.org/jassa/the_tv_db.png)](https://travis-ci.org/jassa/the_tv_db) [![Dependency Status](https://gemnasium.com/jassa/the_tv_db.png)](https://gemnasium.com/jassa/the_tv_db)
+# TheTvDB [![Build Status](https://travis-ci.org/jassa/the_tv_db.png)](https://travis-ci.org/jassa/the_tv_db) [![Dependency Status](https://gemnasium.com/jassa/the_tv_db.png)](https://gemnasium.com/jassa/the_tv_db) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jassa/the_tv_db)
 
 Ruby API Client for TheTvDB.com
 

data/lib/the_tv_db/client.rb

@@ -13,5 +13,5 @@ module TheTvDB
       Episode
     end
     
-  end # API
+  end # Client
 end # TheTvDB

data/lib/the_tv_db/episode.rb

@@ -2,6 +2,40 @@ module TheTvDB
   class Episode < API
     include Model
     
+    ATTRS_MAP = {
+      :id                      => "id",
+      :absolute_number         => "absolute_number",
+      :airs_after_season       => "airsafter_season",
+      :airs_before_episode     => "airsbefore_episode",
+      :airs_before_season      => "airsbefore_season",
+      :combined_episode_number => "Combined_episodenumber",
+      :combined_season         => "Combined_season",
+      :director                => "Director",
+      :dvd_chapter             => "DVD_chapter",
+      :dvd_disc_id             => "DVD_discid",
+      :dvd_episode_number      => "DVD_episodenumber",
+      :dvd_season              => "DVD_season",
+      :ep_img_flag             => "EpImgFlag",
+      :name                    => "EpisodeName",
+      :number                  => "EpisodeNumber",
+      :filename                => "filename",
+      :first_aired             => "FirstAired",
+      :guest_stars             => "GuestStars",
+      :imdb_id                 => "IMDB_ID",
+      :language                => "Language",
+      :last_updated            => "lastupdated",
+      :overview                => "Overview",
+      :production_code         => "ProductionCode",
+      :rating                  => "Rating",
+      :rating_count            => "RatingCount",
+      :season_id               => "seasonid",
+      :season_number           => "SeasonNumber",
+      :series_id               => "seriesid",
+      :writer                  => "Writer"
+    }.freeze
+    
+    attr_accessor *ATTRS_MAP.keys
+    
     class << self
       
       # Public: Find an episode by air date.
@@ -43,39 +77,5 @@ module TheTvDB
       alias :get :find
     end
     
-    ATTRS_MAP = {
-      :id                      => "id",
-      :absolute_number         => "absolute_number",
-      :airs_after_season       => "airsafter_season",
-      :airs_before_episode     => "airsbefore_episode",
-      :airs_before_season      => "airsbefore_season",
-      :combined_episode_number => "Combined_episodenumber",
-      :combined_season         => "Combined_season",
-      :director                => "Director",
-      :dvd_chapter             => "DVD_chapter",
-      :dvd_disc_id             => "DVD_discid",
-      :dvd_episode_number      => "DVD_episodenumber",
-      :dvd_season              => "DVD_season",
-      :ep_img_flag             => "EpImgFlag",
-      :name                    => "EpisodeName",
-      :number                  => "EpisodeNumber",
-      :filename                => "filename",
-      :first_aired             => "FirstAired",
-      :guest_stars             => "GuestStars",
-      :imdb_id                 => "IMDB_ID",
-      :language                => "Language",
-      :last_updated            => "lastupdated",
-      :overview                => "Overview",
-      :production_code         => "ProductionCode",
-      :rating                  => "Rating",
-      :rating_count            => "RatingCount",
-      :season_id               => "seasonid",
-      :season_number           => "SeasonNumber",
-      :series_id               => "seriesid",
-      :writer                  => "Writer"
-    }.freeze
-    
-    attr_accessor *ATTRS_MAP.keys
-    
-  end # Series
+  end # Episode
 end # TheTvDB

data/lib/the_tv_db/model.rb

@@ -3,15 +3,17 @@ module TheTvDB
     
     attr_accessor :klass
     
-    def initialize(params=nil)
+    def initialize(params=nil, &block)
       @klass = self.class
       self.attributes = params
+      
+      self.instance_eval(&block) if block_given?
     end
     
     def attributes=(params=nil)
       params.each do |attr, value|
         begin
-          self.public_send("#{klass::ATTRS_MAP.key(attr)}=", value)
+          self.public_send("#{attributes_map.key(attr)}=", value)
         rescue NoMethodError
           raise UnknownAttributeError, "unknown attribute: #{attr}"
         end
@@ -20,7 +22,7 @@ module TheTvDB
     
     def attributes
       attrs = {}
-      klass::ATTRS_MAP.keys.each do |name|
+      class_attributes.each do |name|
         attrs[name] = send(name)
       end
       attrs
@@ -28,7 +30,7 @@ module TheTvDB
     
     def inspect
       inspection = unless id.nil?
-        klass::ATTRS_MAP.keys.collect { |name|
+        class_attributes.collect { |name|
           "#{name}: #{attribute_for_inspect(name)}"
         }.compact.join(", ")
        else
@@ -49,5 +51,13 @@ module TheTvDB
       end
     end
     
+    def attributes_map
+      klass::ATTRS_MAP
+    end
+    
+    def class_attributes
+      attributes_map.keys
+    end
+    
   end # Model
 end # TheTvDB

data/lib/the_tv_db/response/unzip.rb

@@ -1,27 +1,12 @@
-require 'zip/zip'
-
 module TheTvDB
   class Response::Unzip < Faraday::Response::Middleware
 
     def on_complete(env)
-      env[:body] = unzip(env[:body]) if env[:response_headers]["content-type"] == "application/zip"      
-      super
-    end
-    
-    def unzip(body)
-      zipped = Tempfile.new('thetvdb.com')
-      begin
-        zipped.write(body.force_encoding("utf-8"))
-        unzipped = ::Zip::ZipFile.new(zipped)
-        files = {}
-        unzipped.each do |file|
-          files[file.name] = file.get_input_stream.read
-        end
-        files
-      ensure
-        zipped.close
-        zipped.unlink
+      if env[:response_headers]["content-type"] == "application/zip"
+        env[:body] = TheTvDB::Zip.inflate(env[:body])
       end
+      
+      super
     end
 
   end # Response::Unzip

data/lib/the_tv_db/series.rb

@@ -1,42 +1,6 @@
 module TheTvDB
   class Series < API
     include Model
-
-    class << self
-      def search(name, lang="en")
-        data = request("GetSeries.php", { seriesname: name, language: lang })["Data"]
-        return [] if data.nil?
-        
-        series = data["Series"]
-        
-        case series
-        when Hash
-          [ Series::Collection.new(series) ]
-        when Array
-          series.collect { |serie| Series::Collection.new(serie) }
-        else
-          []
-        end
-      end
-      
-      def find(id, lang="en")
-        if TheTvDB.api_key
-          files = request("#{TheTvDB.api_key}/series/#{id}/all/#{lang}.zip")
-          data = files["#{lang}.xml"].fetch("Data")
-          record = new(data["Series"])
-          record.episodes = data["Episode"]
-          record.banners = files["banners.xml"]["Banners"]["Banner"]
-          record.actors = files["actors.xml"]["Actors"]["Actor"]
-        else
-          data = request("/data/series/#{id}/all/").fetch("Data")
-          record = new(data["Series"])
-          record.episodes = data["Episode"]
-        end
-        
-        return record
-      end
-      alias :get :find
-    end
     
     ATTRS_MAP = {
       :id               => "id",
@@ -67,6 +31,51 @@ module TheTvDB
     }.freeze
     
     attr_accessor *ATTRS_MAP.keys, :episodes, :banners, :actors
+
+    class << self
+      def search(name, lang="en")
+        data = request("GetSeries.php", { seriesname: name, language: lang })["Data"]
+        return [] if data.nil?
+        
+        series = data["Series"]
+        
+        case series
+        when Hash
+          [ Series::Collection.new(series) ]
+        when Array
+          series.collect { |serie| Series::Collection.new(serie) }
+        else
+          []
+        end
+      end
+      
+      def find(id, lang="en")
+        format = TheTvDB.api_key ? :zip : :xml
+        send("get_#{format}_by_id", id, lang)
+      end
+      alias :get :find
+      
+      private
+      
+      def get_xml_by_id(id, lang)
+        data = request("/data/series/#{id}/all/").fetch("Data")
+        record = new(data["Series"]) do |r|
+          r.episodes = data["Episode"]
+        end
+      end
+      
+      def get_zip_by_id(id, lang)
+        files = request("#{TheTvDB.api_key}/series/#{id}/all/#{lang}.zip")
+        data = files["#{lang}.xml"].fetch("Data")
+        record = new(data["Series"]) do |r|
+          r.episodes = data["Episode"]
+          r.banners  = files["banners.xml"]["Banners"]["Banner"]
+          r.actors   = files["actors.xml"]["Actors"]["Actor"]
+        end
+      rescue ::Zip::ZipError
+        get_xml_by_id(id, lang)
+      end
+    end
     
     def episodes=(episodes)
       @episodes = case episodes

data/lib/the_tv_db/utils/zip.rb

@@ -0,0 +1,36 @@
+require 'zip/zip'
+
+module TheTvDB
+  module Zip
+    
+    class << self
+    
+      # Decompresses string.
+      def inflate(string)
+        entries = {}
+        deflated = deflate(string)
+        deflated.each do |entry|
+          entries[entry.name] = entry.get_input_stream.read
+        end
+        entries
+      ensure
+        tmp.close
+        tmp.unlink
+      end
+      
+      # Compresses the given string.
+      def deflate(string)
+        tmp.write(string.force_encoding("utf-8"))
+        ::Zip::ZipFile.new(tmp)
+      end
+ 
+      private
+
+      def tmp
+        @tmp ||= Tempfile.new('thetvdb.com')
+      end
+  
+    end
+
+  end # Zip
+end # TheTvDB

data/lib/the_tv_db/version.rb

@@ -1,3 +1,3 @@
 module TheTvDB
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/the_tv_db.rb

@@ -1,6 +1,6 @@
-require "the_tv_db/core_ext/string"
-require "the_tv_db/version"
+require 'the_tv_db/utils/zip'
 require "the_tv_db/errors"
+require "the_tv_db/version"
 require "the_tv_db/api"
 require "the_tv_db/model"
 require "the_tv_db/client"

data/spec/the_tv_db/episode_spec.rb

@@ -13,11 +13,11 @@ describe TheTvDB::Episode do
       let(:episodes) { api.episodes.find("82066", "2012-11-16") }
       
       it "returns an array" do
-        episodes == Array
+        episodes.class.should == Array
       end
       
       it "instantiates episode objects" do
-        episodes.first == TheTvDB::Episode
+        episodes.first.class.should == TheTvDB::Episode
       end
     end
     

data/spec/the_tv_db/series_spec.rb

@@ -4,6 +4,7 @@ describe TheTvDB::Series do
   let(:api) { TheTvDB.new }
     
   context ".search" do
+    
     it "returns an empty array when no results" do
       stub_get("GetSeries.php?language=en&seriesname=asdf").
         to_return(:status => 200, :body => fixture("series/empty.xml"))
@@ -43,10 +44,12 @@ describe TheTvDB::Series do
     end
     
     context "when api key is provided" do
-      before(:all) do
-        body = TheTvDB::Response::Unzip.new.unzip(fixture("series/en.zip"))
+      before :all do
         stub_get("ASDF01234F0AF1368/series/82066/all/en.zip").
-          to_return(:status => 200, :body => body)
+          to_return(:status => 200, 
+                    :body => fixture("series/en.zip"), 
+                    :headers => { "content-type" => "application/zip" })
+
         api = TheTvDB.new(:api_key => "ASDF01234F0AF1368")
         @series = api.series.find("82066")
       end

data/the_tv_db.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_dependency "faraday",   "~> 0.8.4"
-  gem.add_dependency "ox",        "~> 1.6.6"
+  gem.add_dependency "ox",        "~> 1.6.8"
   gem.add_dependency "multi_xml", "~> 0.5.1"
   gem.add_dependency "rubyzip",   "~> 0.9.9"
   
-  gem.add_development_dependency "rspec", "~> 2.11.0"
-  gem.add_development_dependency "webmock", "~> 1.8.11"
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+  gem.add_development_dependency "webmock", "~> 1.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_tv_db
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70129673485720 !ruby/object:Gem::Requirement
+  requirement: &70353122973600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *70129673485720
+  version_requirements: *70353122973600
 - !ruby/object:Gem::Dependency
   name: ox
-  requirement: &70129673485220 !ruby/object:Gem::Requirement
+  requirement: &70353122973100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 1.6.8
   type: :runtime
   prerelease: false
-  version_requirements: *70129673485220
+  version_requirements: *70353122973100
 - !ruby/object:Gem::Dependency
   name: multi_xml
-  requirement: &70129673484760 !ruby/object:Gem::Requirement
+  requirement: &70353122972640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *70129673484760
+  version_requirements: *70353122972640
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &70129673484300 !ruby/object:Gem::Requirement
+  requirement: &70353122972180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,29 +54,29 @@ dependencies:
         version: 0.9.9
   type: :runtime
   prerelease: false
-  version_requirements: *70129673484300
+  version_requirements: *70353122972180
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70129673483840 !ruby/object:Gem::Requirement
+  requirement: &70353122971720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.12.0
   type: :development
   prerelease: false
-  version_requirements: *70129673483840
+  version_requirements: *70353122971720
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70129673483380 !ruby/object:Gem::Requirement
+  requirement: &70353122971260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.11
+        version: 1.9.0
   type: :development
   prerelease: false
-  version_requirements: *70129673483380
+  version_requirements: *70353122971260
 description: Ruby API Client for TheTvDB.com
 email:
 - javier@tractical.com
@@ -95,7 +95,6 @@ files:
 - lib/the_tv_db/api.rb
 - lib/the_tv_db/client.rb
 - lib/the_tv_db/connection.rb
-- lib/the_tv_db/core_ext/string.rb
 - lib/the_tv_db/episode.rb
 - lib/the_tv_db/errors.rb
 - lib/the_tv_db/model.rb
@@ -105,6 +104,7 @@ files:
 - lib/the_tv_db/response/xmlize.rb
 - lib/the_tv_db/series.rb
 - lib/the_tv_db/series/collection.rb
+- lib/the_tv_db/utils/zip.rb
 - lib/the_tv_db/version.rb
 - spec/fixtures/episodes/air_date.xml
 - spec/fixtures/episodes/api_key.xml

data/lib/the_tv_db/core_ext/string.rb

@@ -1,12 +0,0 @@
-class String  
-  # Makes an underscored, lowercase form from the expression in the string.
-  def underscore
-    word = self.dup
-    word.gsub!('::', '/')
-    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
-    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-    word.tr!("-", "_")
-    word.downcase!
-    word
-  end
-end