thetvdb_mapper 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ede54fbc1b8f301492dffe4b0e4cf437aa2dff18
-  data.tar.gz: 4fa1c97f5dfc76c201de14b546dcc8e8f6f8c7a6
+  metadata.gz: ddd665856a536718f13177e8c4c018f9a1f3eaa9
+  data.tar.gz: 67f691983facc4d15e2226df5680dd007e29f88f
 SHA512:
-  metadata.gz: 5160079ad7df3fb5783774d05f06e3626b736dd6fed7701628700177caed4f447c48c52f840db6f1bf278ed80fa8440de2a83f4273e4c6ce0a60d4896ea029c8
-  data.tar.gz: f0d4b7e8460b0cfaf0ae5f39b911b11bb4ce3ec18bb825da003a3869269d33bfbb719b6b3e26d65798acba5e0af5aef729a9104bfb5852c4cc5c2f5e132cf7ee
+  metadata.gz: 587bf6d15b9874b4a37aca30c0d077d7a8e364eab1494d80aeef078ace628c05b8dbf9687e9054f5363993bbf1c4ba9abd34ef4bd7ffd238bbec03ac024c0db7
+  data.tar.gz: dac0f4b0b37568af7519a7437245ead7b5a71f3409c512fd9c8208cf081a010d697c273b958a6550637682b815a6dac0608b8d8298f653bee8c1ef0a96a0f79f

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
-script: 'bundle exec rspec spec/units && bundle exec rspec spec/functionals && bundle exec rspec spec/units'
+script: 'bundle exec rspec spec/functionals'
 rvm:
   - 1.9.3
   - 2.0.0

data/README.md

@@ -6,7 +6,7 @@
 
 # ThetvdbMapper
 
-Fetch data from thetvdb.com and mapping to common hash, where keys are symbols and underline.
+ThetvdbMapper mapping and normalizing keys in hash data provided by ThetvdbApi.
 
 ## Installation
 
@@ -22,22 +22,13 @@ Or install it yourself as:
 
     $ gem install thetvdb_mapper
 
-## Configuration
-
-```ruby
-ThetvdbApi::Configuration.configure do |config|
-  config.api_key = '......'
-end
-```
-
 ## Usage
 
 ```ruby
-ThetvdbMapper::Actor.new(series_id).data # return actors
-ThetvdbMapper::Banners.new(series_id).data # return banners hash (not image)
-ThetvdbMapper::Episode.new(episode_id).data # return episode
-ThetvdbMapper::FullSeries.new(series_id).data # return series with all episodes
-ThetvdbMapper::Series.new(series_id).data # return series
+ThetvdbMapper::Actor.new(data)
+ThetvdbMapper::Banners.new(data)
+ThetvdbMapper::Episode.new(data)
+ThetvdbMapper::Series.new(data)
 ```
 
 ## Contributing

data/lib/thetvdb_mapper.rb

@@ -1,18 +1,12 @@
+require 'hashie'
+
 module ThetvdbMapper
   module Mapping; end
 end
 
 require 'thetvdb_mapper/version'
-require 'thetvdb_mapper/fetcher'
-require 'thetvdb_mapper/mapping/base'
-require 'thetvdb_mapper/mapping/actor'
-require 'thetvdb_mapper/mapping/banner'
-require 'thetvdb_mapper/mapping/episode'
-require 'thetvdb_mapper/mapping/series'
-require 'thetvdb_mapper/mapping/string_list'
 require 'thetvdb_mapper/base'
-require 'thetvdb_mapper/actors'
-require 'thetvdb_mapper/banners'
+require 'thetvdb_mapper/actor'
+require 'thetvdb_mapper/banner'
 require 'thetvdb_mapper/episode'
-require 'thetvdb_mapper/full_series'
 require 'thetvdb_mapper/series'

data/lib/thetvdb_mapper/actor.rb

@@ -0,0 +1,7 @@
+class ThetvdbMapper::Actor < ThetvdbMapper::Base
+  property :id,         from: 'id',        with: lambda { |value| value.to_i }
+  property :image_path, from: 'Image'
+  property :name,       from: 'Name'
+  property :role,       from: 'Role'
+  property :sort_order, from: 'SortOrder', with: lambda { |value| value.to_i }
+end

data/lib/thetvdb_mapper/banner.rb

@@ -0,0 +1,14 @@
+class ThetvdbMapper::Banner < ThetvdbMapper::Base
+  property :id,             from: 'id',           with: lambda { |value| value.to_i }
+  property :path,           from: 'BannerPath'
+  property :thumbnail_path, from: 'ThumbnailPath'
+  property :vignette_path,  from: 'VignettePath'
+  property :kind,           from: 'BannerType'
+  property :kind2,          from: 'BannerType2'
+  property :language,       from: 'Language'
+  property :season,         from: 'Season',       with: lambda { |value| value.to_i }
+  property :rating,         from: 'Rating',       with: lambda { |value| value.to_f }
+  property :rating_count,   from: 'RatingCount',  with: lambda { |value| value.to_i }
+  property :series_name,    from: 'SeriesName'
+  property :colors,         from: 'Colors'
+end

data/lib/thetvdb_mapper/base.rb

@@ -1,11 +1,5 @@
-class ThetvdbMapper::Base
-  attr_reader :id
-
-  def initialize(id)
-    @id = id
-  end
-
-  def fetcher
-    @fetcher ||= ThetvdbMapper::Fetcher.new
+class ThetvdbMapper::Base < Hashie::Trash
+  def self.to_array(string)
+    string.to_s.split('|').reject{ |element| element.empty? }
   end
 end

data/lib/thetvdb_mapper/episode.rb

@@ -1,13 +1,34 @@
 class ThetvdbMapper::Episode < ThetvdbMapper::Base
-  def data
-    @data ||= mapping_object(fetcher.episode(id).body).map
-  end
-
-  def inspect
-    "<ThetvdbMapper::Episode data=#{data.to_s} >"
-  end
-
-  def mapping_object(data)
-    ThetvdbMapper::Mapping::Episode.new(data)
-  end
+  property :id,                      from: 'id',                     with: lambda { |value| value.to_i }
+  property :combined_episode_number, from: 'Combined_episodenumber', with: lambda { |value| value.to_f }
+  property :combined_season,         from: 'Combined_season',        with: lambda { |value| value.to_f }
+  property :dvd_chapter,             from: 'DVD_chapter'
+  property :dvd_disc_id,             from: 'DVD_discid'
+  property :dvd_episode_number,      from: 'DVD_episodenumber',      with: lambda { |value| value.to_f }
+  property :dvd_season,              from: 'DVD_season',             with: lambda { |value| value.to_i }
+  property :directors,               from: 'Director',               with: lambda { |value| to_array(value) }
+  property :ep_img_flag,             from: 'EpImgFlag',              with: lambda { |value| value.to_i }
+  property :name,                    from: 'EpisodeName'
+  property :number,                  from: 'EpisodeNumber',          with: lambda { |value| value.to_i }
+  property :first_aired,             from: 'FirstAired',             with: lambda { |value| Date.parse(value) }
+  property :guest_stars,             from: 'GuestStars',             with: lambda { |value| to_array(value) }
+  property :imdb_id,                 from: 'IMDB_ID'
+  property :language,                from: 'Language'
+  property :overview,                from: 'Overview'
+  property :production_code,         from: 'ProductionCode'
+  property :rating,                  from: 'Rating',                 with: lambda { |value| value.to_f }
+  property :rating_count,            from: 'RatingCount',            with: lambda { |value| value.to_i }
+  property :season,                  from: 'SeasonNumber',           with: lambda { |value| value.to_i }
+  property :writers,                 from: 'Writer',                 with: lambda { |value| to_array(value) }
+  property :absolute_number,         from: 'absolute_number',        with: lambda { |value| value.to_i }
+  property :airs_after_season,       from: 'airsafter_season',       with: lambda { |value| value.to_i }
+  property :airs_before_episode,     from: 'airsbefore_episode',     with: lambda { |value| value.to_i }
+  property :airs_before_season,      from: 'airsbefore_season',      with: lambda { |value| value.to_i }
+  property :filename_path,           from: 'filename'
+  property :last_updated_at,         from: 'lastupdated',            with: lambda { |value| Time.at(value.to_i) }
+  property :season_id,               from: 'seasonid'
+  property :series_id,               from: 'seriesid'
+  property :thumbnail_added_at,      from: 'thumb_added',            with: lambda { |value| DateTime.parse(value) }
+  property :thumbnail_height,        from: 'thumb_height',           with: lambda { |value| value.to_i }
+  property :thumbnail_width,         from: 'thumb_width',            with: lambda { |value| value.to_i }
 end

data/lib/thetvdb_mapper/series.rb

@@ -1,13 +1,27 @@
 class ThetvdbMapper::Series < ThetvdbMapper::Base
-  def data
-    @data ||= mapping_object(fetcher.series(id).body).map
-  end
-
-  def mapping_object(data)
-    ThetvdbMapper::Mapping::Series.new(data)
-  end
-
-  def inspect
-    "<ThetvdbMapper::Series data=#{data.to_s} >"
-  end
+  property :id,               from: 'id',            with: lambda { |value| value.to_i }
+  property :actors,           from: 'Actors',        with: lambda { |value| to_array(value) }
+  property :airs_day_of_week, from: 'Airs_DayOfWeek'
+  property :airs_time,        from: 'Airs_Time'
+  property :content_rating,   from: 'ContentRating'
+  property :first_aired,      from: 'FirstAired',    with: lambda { |value| Date.parse(value) }
+  property :genres,           from: 'Genre',         with: lambda { |value| to_array(value) }
+  property :imdb_id,          from: 'IMDB_ID'
+  property :language,         from: 'Language'
+  property :network,          from: 'Network'
+  property :network_id,       from: 'NetworkID',     with: lambda { |value| value.to_i }
+  property :overview,         from: 'Overview'
+  property :rating,           from: 'Rating',        with: lambda { |value| value.to_f }
+  property :rating_count,     from: 'RatingCount',   with: lambda { |value| value.to_i }
+  property :runtime,          from: 'Runtime',       with: lambda { |value| value.to_i }
+  property :name,             from: 'SeriesName'
+  property :series_id,        from: 'SeriesId',      with: lambda { |value| value.to_i }
+  property :status,           from: 'Status'
+  property :added_at,         from: 'added',         with: lambda { |value| DateTime.parse(value) }
+  property :added_by,         from: 'addedBy'
+  property :banner_path,      from: 'banner'
+  property :fanart_path,      from: 'fanart'
+  property :last_updated_at,  from: 'lastupdated',   with: lambda { |value| Time.at(value.to_i) }
+  property :poster_path,      from: 'poster'
+  property :zap2it_id,        from: 'zap2it_id'
 end

data/lib/thetvdb_mapper/version.rb

@@ -1,3 +1,3 @@
 module ThetvdbMapper
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/functionals/actor_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Actor do
+  let(:model) { ThetvdbMapper::Actor.new(input_data) }
+  let(:input_data) do
+    {
+      'id' => '123',
+      'Image' => '/image_path',
+      'Name' => 'name',
+      'Role' => 'role',
+      'SortOrder' => '1'
+    }
+  end
+
+  let(:output_data) do
+    {
+      id: 123,
+      image_path: '/image_path',
+      name: 'name',
+      role: 'role',
+      sort_order: 1
+    }
+  end
+
+  describe '.map' do
+    it 'should return specific keys' do
+      model.keys.sort.should == [:id, :image_path, :name, :role, :sort_order].sort
+    end
+
+    it 'should return corrected Hash after mapping' do
+      model.to_hash.should == output_data
+    end
+  end
+end

data/spec/functionals/banner_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Banner do
+  let(:model) { ThetvdbMapper::Banner.new(input_data) }
+  let(:input_data) do
+    {
+      'id' => '123',
+      'BannerPath' => '/image_path',
+      'ThumbnailPath' => '/image2_path',
+      'VignettePath' => '/image3_path',
+      'BannerType' => 'kind',
+      'BannerType2' => 'kind2',
+      'Language' => 'en',
+      'Season' => '1',
+      'Rating' => '1.1',
+      'RatingCount' => '123',
+      'SeriesName' => 'Test',
+      'Colors' => 'RGB',
+    }
+  end
+
+  let(:output_data) do
+    {
+      id: 123,
+      path: '/image_path',
+      thumbnail_path: '/image2_path',
+      vignette_path: '/image3_path',
+      kind: 'kind',
+      kind2: 'kind2',
+      language: 'en',
+      season: 1,
+      rating: 1.1,
+      rating_count: 123,
+      series_name: 'Test',
+      colors: 'RGB'
+    }
+  end
+
+  describe '#map' do
+    it 'should return specific keys' do
+      model.keys.sort.should == [:path, :thumbnail_path, :vignette_path, :kind, :kind2, :language, :season,
+        :rating, :rating_count, :series_name, :colors, :id].sort
+    end
+
+    it 'should return corrected Hash after mapping' do
+      model.to_hash.should == output_data
+    end
+  end
+end

data/spec/functionals/episode_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Episode do
+  let(:model) { ThetvdbMapper::Episode.new(input_data) }
+  let(:input_data) do
+    {
+      'id' => '123',
+      'Combined_episodenumber' => 1,
+      'Combined_season' => 2,
+      'DVD_episodenumber' => 3,
+      'DVD_season' => 4,
+      'Director' => 'McG',
+      'EpImgFlag' => 1,
+      'EpisodeName' => 'Test',
+      'EpisodeNumber' => 5,
+      'FirstAired' => '2000-01-01',
+      'GuestStars' => 'Mieko Hillman|Kristine Blackport',
+      'IMDB_ID' => 'tt000000',
+      'Language' => 'en',
+      'Overview' => 'overview',
+      'ProductionCode' => '1234',
+      'Rating' => '1.1',
+      'RatingCount' => '12',
+      'SeasonNumber' => '1',
+      'Writer' => 'McG',
+      'absolute_number' => '1',
+      'airsafter_season' => '1',
+      'airsbefore_episode' => '1',
+      'airsbefore_season' => '1',
+      'filename' => '/path',
+      'lastupdated' => 1,
+      'seasonid' => '1',
+      'seriesid' => '1',
+      'thumb_added' => '2000-01-01 01:00:00',
+      'thumb_height' => '100',
+      'thumb_width' => '100'
+    }
+  end
+
+  let(:output_data) do
+    {
+      id: 123,
+      combined_episode_number: 1.0,
+      combined_season: 2.0,
+      dvd_episode_number: 3.0,
+      dvd_season: 4,
+      directors: ['McG'],
+      ep_img_flag: 1,
+      name: 'Test',
+      number: 5,
+      first_aired: Date.parse('2000-01-01'),
+      guest_stars: ['Mieko Hillman', 'Kristine Blackport'],
+      imdb_id: 'tt000000',
+      language: 'en',
+      overview: 'overview',
+      production_code: '1234',
+      rating: 1.1,
+      rating_count: 12,
+      season: 1,
+      writers: ['McG'],
+      absolute_number: 1,
+      airs_after_season: 1,
+      airs_before_episode: 1,
+      airs_before_season: 1,
+      filename_path: '/path',
+      last_updated_at: Time.at(1),
+      season_id: '1',
+      series_id: '1',
+      thumbnail_added_at: DateTime.parse('2000-01-01 01:00:00'),
+      thumbnail_height: 100,
+      thumbnail_width: 100
+    }
+  end
+
+  describe '#map' do
+    it 'should return specific keys' do
+      model.keys.sort.should == [:id, :combined_episode_number, :combined_season, :dvd_episode_number,
+        :dvd_season, :directors, :ep_img_flag, :name, :number, :first_aired, :guest_stars, :imdb_id, :language,
+        :overview, :production_code, :rating, :rating_count, :season, :writers, :absolute_number, :airs_after_season,
+        :airs_before_episode, :airs_before_season, :filename_path, :last_updated_at, :season_id, :series_id,
+        :thumbnail_added_at, :thumbnail_height, :thumbnail_width].sort
+    end
+
+    it 'should return corrected Hash after mapping' do
+      model.to_hash.should == output_data
+    end
+  end
+end

data/spec/functionals/series_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Series do
+  let(:model) { ThetvdbMapper::Series.new(input_data) }
+  let(:input_data) do
+    {
+      'id' => '123',
+      'Airs_DayOfWeek' => 'Monday',
+      'Airs_Time' => '8 AM',
+      'ContentRating' => 'PG',
+      'FirstAired' => '2000-01-01',
+      'Genre' => 'sci-fi',
+      'IMDB_ID' => 'tt000000',
+      'Language' => 'en',
+      'Network' => 'SyFy',
+      'NetworkID' => '1',
+      'Overview' => 'overview',
+      'Rating' => '1.1',
+      'RatingCount' => '123',
+      'Runtime' => '60',
+      'SeriesName' => 'Test',
+      'Status' => 'continue',
+      'added' => '2000-01-01 01:00:00',
+      'addedBy' => 'test',
+      'banner' => 'banner_path',
+      'fanart' => 'fanart_path',
+      'lastupdated' => 1,
+      'poster' => 'poster_path',
+      'zap2it_id' => 'zap123'
+    }
+  end
+
+  let(:output_data) do
+    {
+      id: 123,
+      airs_day_of_week: 'Monday',
+      airs_time: '8 AM',
+      content_rating: 'PG',
+      first_aired: Date.parse('2000-01-01'),
+      genres: ['sci-fi'],
+      imdb_id: 'tt000000',
+      language: 'en',
+      network: 'SyFy',
+      network_id: 1,
+      overview: 'overview',
+      rating: 1.1,
+      rating_count: 123,
+      runtime: 60,
+      name: 'Test',
+      status: 'continue',
+      added_at: DateTime.parse('2000-01-01 01:00:00'),
+      added_by: 'test',
+      banner_path: 'banner_path',
+      fanart_path: 'fanart_path',
+      last_updated_at: Time.at(1),
+      poster_path: 'poster_path',
+      zap2it_id: 'zap123'
+    }
+  end
+
+  describe '#map' do
+    it 'should return specific keys' do
+      model.keys.sort.should == [:id, :airs_day_of_week, :airs_time, :content_rating, :first_aired, :genres,
+        :imdb_id, :language, :network, :network_id, :overview, :rating, :rating_count, :runtime, :name, :status,
+        :added_at, :added_by, :banner_path, :fanart_path, :last_updated_at, :poster_path, :zap2it_id].sort
+    end
+
+    it 'should return corrected Hash after mapping' do
+      model.to_hash.should == output_data
+    end
+  end
+end