thetvdb_mapper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bae6417686751f5c3906eb98c0b4311a289052e9
+  data.tar.gz: e0e998f6b6aa9e5110dede2c4b7d54facc99db3c
+SHA512:
+  metadata.gz: 74ccff6592d49df1951b7f91d2b91415bef7e542b51c077d315318e76adb961cc8829770cb26f0fba48b76bc5e80d9c7b5e8efaf2399866e799f7352c64dddc3
+  data.tar.gz: 9fd673575408786af948eb74153d97571217907c67d74af82b11fd4b3b123e423a2b385c633969b3cf35b9268e2f4a50eb634079d99c7f1b44bc61a9da7dc48a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+spec/integrations/support/thetvdb_api.rb

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in thetvdb_mapper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Krzysztof Wawer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://travis-ci.org/wafcio/thetvdb_mapper.png?branch=master)](https://travis-ci.org/wafcio/thetvdb_mapper)
+[![Dependency Status](https://gemnasium.com/wafcio/thetvdb_mapper.png)](https://gemnasium.com/wafcio/thetvdb_mapper)
+[![Code Climate](https://codeclimate.com/github/wafcio/thetvdb_mapper.png)](https://codeclimate.com/github/wafcio/thetvdb_mapper)
+[![Coverage Status](https://coveralls.io/repos/wafcio/thetvdb_mapper/badge.png)](https://coveralls.io/r/wafcio/thetvdb_mapper)
+[![Gem Version](https://badge.fury.io/rb/thetvdb_mapper.png)](http://badge.fury.io/rb/thetvdb_mapper)
+
+# ThetvdbMapper
+
+Fetch data from thetvdb.com and mapping to common hash, where keys are symbols and underline.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'thetvdb_mapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thetvdb_mapper
+
+## 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
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/thetvdb_mapper/actors.rb

@@ -0,0 +1,13 @@
+class ThetvdbMapper::Actors < ThetvdbMapper::Base
+  def data
+    @data ||= fetcher.actors(id).body.map { |actor| map(actor) }
+  end
+
+  def map(data)
+    ThetvdbMapper::Mapping::Actor.map(data)
+  end
+
+  def inspect
+    "<ThetvdbMapper::Actors data=#{data.to_s} >"
+  end
+end

data/lib/thetvdb_mapper/banners.rb

@@ -0,0 +1,13 @@
+class ThetvdbMapper::Banners < ThetvdbMapper::Base
+  def data
+    @data ||= fetcher.banners(id).body.map { |banner| map(banner) }
+  end
+
+  def map(data)
+    ThetvdbMapper::Mapping::Banner.map(data)
+  end
+
+  def inspect
+    "<ThetvdbMapper::Banners data=#{data.to_s} >"
+  end
+end

data/lib/thetvdb_mapper/base.rb

@@ -0,0 +1,11 @@
+class ThetvdbMapper::Base
+  attr_reader :id
+
+  def initialize(id)
+    @id = id
+  end
+
+  def fetcher
+    @fetcher ||= ThetvdbMapper::Fetcher.new
+  end
+end

data/lib/thetvdb_mapper/episode.rb

@@ -0,0 +1,9 @@
+class ThetvdbMapper::Episode < ThetvdbMapper::Base
+  def data
+    @data ||= ThetvdbMapper::Mapping::Episode.map(fetcher.episode(id).body)
+  end
+
+  def inspect
+    "<ThetvdbMapper::Episode data=#{data.to_s} >"
+  end
+end

data/lib/thetvdb_mapper/fetcher.rb

@@ -0,0 +1,25 @@
+class ThetvdbMapper::Fetcher
+  def series(id)
+    @series ||= client.series.find(id, mapping: true)
+  end
+
+  def full_series(id)
+    @full_series ||= client.series.find_full(id, mapping: true)
+  end
+
+  def actors(id)
+    @actors ||= client.actor.find(id, mapping: true)
+  end
+
+  def banners(id)
+    @banners ||= client.banner.find(id, mapping: true)
+  end
+
+  def episode(id)
+    @episode ||= client.episode.find(id, mapping: true)
+  end
+
+  def client
+    ThetvdbApi::Client.new
+  end
+end

data/lib/thetvdb_mapper/full_series.rb

@@ -0,0 +1,37 @@
+class ThetvdbMapper::FullSeries < ThetvdbMapper::Base
+  def data
+    @data ||= series.merge(episodes: episodes, actors: actors, banners: banners)
+  end
+
+  def series
+    ThetvdbMapper::Mapping::Series.map(fetcher.full_series(id).body['Series'])
+  end
+
+  def episodes
+    fetcher.full_series(id).body['Episode'].map { |episode| map_episode(episode) }
+  end
+
+  def map_episode(data)
+    ThetvdbMapper::Mapping::Episode.map(data)
+  end
+
+  def actors
+    fetcher.actors(id).body.map { |actor| map_actor(actor) }
+  end
+
+  def map_actor(data)
+    ThetvdbMapper::Mapping::Actor.map(data)
+  end
+
+  def banners
+    fetcher.banners(id).body.map { |banner| map_banner(banner) }
+  end
+
+  def map_banner(data)
+    ThetvdbMapper::Mapping::Banner.map(data)
+  end
+
+  def inspect
+    "<ThetvdbMapper::FullSeries data=#{data.to_s} >"
+  end
+end

data/lib/thetvdb_mapper/mapping/actor.rb

@@ -0,0 +1,11 @@
+class ThetvdbMapper::Mapping::Actor < ThetvdbMapper::Mapping::Base
+  def self.rules
+    {
+      'id' => :id,
+      'Image' => :image_path,
+      'Name' => :name,
+      'Role' => :role,
+      'SortOrder' => :sort_order
+    }
+  end
+end

data/lib/thetvdb_mapper/mapping/banner.rb

@@ -0,0 +1,17 @@
+class ThetvdbMapper::Mapping::Banner < ThetvdbMapper::Mapping::Base
+  def self.rules
+    {
+      'BannerPath' => :path,
+      'ThumbnailPath' => :thumbnail_path,
+      'VignettePath' => :vignette_path,
+      'BannerType' => :type,
+      'BannerType2' => :type2,
+      'Language' => :language,
+      'Season' => :season,
+      'Rating' => :rating,
+      'RatingCount' => :rating_count,
+      'SeriesName' => :series_name,
+      'Colors' => :colors,
+    }
+  end
+end

data/lib/thetvdb_mapper/mapping/base.rb

@@ -0,0 +1,17 @@
+class ThetvdbMapper::Mapping::Base
+  def self.map(data)
+    rules.each do |before, after|
+      data[after] = data.delete(before)
+    end
+
+    if respond_to?(:convert)
+      data = convert(data)
+    end
+
+    data
+  end
+
+  def self.convert_to_list(data)
+    ThetvdbMapper::Mapping::StringList.map(data)
+  end
+end

data/lib/thetvdb_mapper/mapping/episode.rb

@@ -0,0 +1,45 @@
+class ThetvdbMapper::Mapping::Episode < ThetvdbMapper::Mapping::Base
+  def self.rules
+    {
+      'id' => :id,
+      'Combined_episodenumber' => :combined_episode_number,
+      'Combined_season' => :combined_season,
+      'DVD_episodenumber' => :dvd_episode_number,
+      'DVD_season' => :dvd_season,
+      'Director' => :director,
+      'EpImgFlag' => :ep_img_flag,
+      'EpisodeName' => :name,
+      'EpisodeNumber' => :number,
+      'FirstAired' => :first_aired,
+      'GuestStars' => :guest_stars,
+      'IMDB_ID' => :imdb_id,
+      'Language' => :language,
+      'Overview' => :overview,
+      'ProductionCode' => :production_code,
+      'Rating' => :rating,
+      'RatingCount' => :rating_count,
+      'SeasonNumber' => :season,
+      'Writer' => :writer,
+      'absolute_number' => :absolute_number,
+      'airsafter_season' => :airs_after_season,
+      'airsbefore_episode' => :airs_before_episode,
+      'airsbefore_season' => :airs_before_season,
+      'filename' => :filename_path,
+      'lastupdated' => :last_updated_at,
+      'season_id' => :season_id,
+      'series_id' => :series_id,
+      'thumb_added' => :thumbnail_added_at,
+      'thumb_height' => :thumbnail_height,
+      'thumb_weight' => :thumbnail_width
+    }
+  end
+
+  def self.convert(data)
+    data.merge({
+      director: convert_to_list(data[:director]),
+      guest_stars: convert_to_list(data[:guest_stars]),
+      writer: convert_to_list(data[:writer]),
+      last_updated_at: Time.at(data[:last_updated_at].to_i)
+    })
+  end
+end

data/lib/thetvdb_mapper/mapping/series.rb

@@ -0,0 +1,36 @@
+class ThetvdbMapper::Mapping::Series < ThetvdbMapper::Mapping::Base
+  def self.rules
+    {
+      'id' => :id,
+      'Airs_DayOfWeek' => :airs_day_of_week,
+      'Airs_Time' => :airs_time,
+      'ContentRating' => :content_rating,
+      'FirstAired' => :first_aired,
+      'genre' => :genres,
+      'IMDB_ID' => :imdb_id,
+      'Language' => :language,
+      'Network' => :network,
+      'NetworkID' => :network_id,
+      'Overview' => :overview,
+      'Rating' => :rating,
+      'RatingCount' => :rating_count,
+      'Runtime' => :runtime,
+      'SeriesName' => :name,
+      'Status' => :status,
+      'added' => :added_at,
+      'added_by' => :added_by,
+      'banner' => :banner_path,
+      'fanart' => :fanart_path,
+      'lastupdated' => :last_updated_at,
+      'poster' => :poster_path,
+      'zap2it_id' => :zap2it_id
+    }
+  end
+
+  def self.convert(data)
+    data.merge({
+      genres: convert_to_list(data[:genres]),
+      last_updated_at: Time.at(data[:last_updated_at].to_i)
+    })
+  end
+end

data/lib/thetvdb_mapper/mapping/string_list.rb

@@ -0,0 +1,5 @@
+class ThetvdbMapper::Mapping::StringList
+  def self.map(data)
+    data.to_s.split('|').reject{ |element| element.empty? }
+  end
+end

data/lib/thetvdb_mapper/series.rb

@@ -0,0 +1,9 @@
+class ThetvdbMapper::Series < ThetvdbMapper::Base
+  def data
+    @data ||= ThetvdbMapper::Mapping::Series.map(fetcher.series(id).body)
+  end
+
+  def inspect
+    "<ThetvdbMapper::Series data=#{data.to_s} >"
+  end
+end

data/lib/thetvdb_mapper/version.rb

@@ -0,0 +1,3 @@
+module ThetvdbMapper
+  VERSION = '0.0.1'
+end

data/lib/thetvdb_mapper.rb

@@ -0,0 +1,18 @@
+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/episode'
+require 'thetvdb_mapper/full_series'
+require 'thetvdb_mapper/series'

data/spec/functionals/mapping/actor_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Mapping::Actor do
+  let(:klass) { ThetvdbMapper::Mapping::Actor }
+
+  describe '#map' do
+    it 'should return specific keys' do
+      klass.map({}).keys.sort.should == [:id, :image_path, :name, :role, :sort_order].sort
+    end
+
+    it 'should map id' do
+      klass.map('id' => 1234)[:id].should == 1234
+    end
+
+    it 'should map Image' do
+      klass.map('Image' => 'test')[:image_path].should == 'test'
+    end
+
+    it 'should map Name' do
+      klass.map('Name' => 'test')[:name].should == 'test'
+    end
+
+    it 'should map Role' do
+      klass.map('Role' => 'test')[:role].should == 'test'
+    end
+
+    it 'should map SortOrder' do
+      klass.map('SortOrder' => 1)[:sort_order].should == 1
+    end
+  end
+end

data/spec/functionals/mapping/banner_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Mapping::Banner do
+  let(:klass) { ThetvdbMapper::Mapping::Banner }
+
+  describe '#map' do
+    it 'should return specific keys' do
+      klass.map({}).keys.sort.should == [:path, :thumbnail_path, :vignette_path, :type, :type2, :language, :season,
+                                         :rating, :rating_count, :series_name, :colors].sort
+    end
+
+    it 'should map BannerPath' do
+      klass.map('BannerPath' => 'test')[:path].should == 'test'
+    end
+
+    it 'should map ThumbnailPath' do
+      klass.map('ThumbnailPath' => 'test')[:thumbnail_path].should == 'test'
+    end
+
+    it 'should map VignettePath' do
+      klass.map('VignettePath' => 'test')[:vignette_path].should == 'test'
+    end
+
+    it 'should map BannerType' do
+      klass.map('BannerType' => 'test')[:type].should == 'test'
+    end
+
+    it 'should map BannerType2' do
+      klass.map('BannerType2' => 'test')[:type2].should == 'test'
+    end
+
+    it 'should map Language' do
+      klass.map('Language' => 'test')[:language].should == 'test'
+    end
+
+    it 'should map Season' do
+      klass.map('Season' => 'test')[:season].should == 'test'
+    end
+
+    it 'should map Rating' do
+      klass.map('Rating' => 'test')[:rating].should == 'test'
+    end
+
+    it 'should map RatingCount' do
+      klass.map('RatingCount' => 'test')[:rating_count].should == 'test'
+    end
+
+    it 'should map SeriesName' do
+      klass.map('SeriesName' => 'test')[:series_name].should == 'test'
+    end
+
+    it 'should map Colors' do
+      klass.map('Colors' => 'test')[:colors].should == 'test'
+    end
+  end
+end

data/spec/functionals/mapping/episode_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe ThetvdbMapper::Mapping::Episode do
+  let(:klass) { ThetvdbMapper::Mapping::Episode }
+
+  describe '#map' do
+    it 'should return specific keys' do
+      klass.map({}).keys.sort.should == [:id, :combined_episode_number, :combined_season, :dvd_episode_number,
+        :dvd_season, :director, :ep_img_flag, :name, :number, :first_aired, :guest_stars, :imdb_id, :language,
+        :overview, :production_code, :rating, :rating_count, :season, :writer, :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 map id' do
+      klass.map('id' => 1234)[:id].should == 1234
+    end
+
+    it 'should map Combined_episodenumber' do
+      klass.map('Combined_episodenumber' => 1234)[:combined_episode_number].should == 1234
+    end
+
+    it 'should map Combined_season' do
+      klass.map('Combined_season' => 1234)[:combined_season].should == 1234
+    end
+
+    it 'should map DVD_episodenumber' do
+      klass.map('DVD_episodenumber' => 1234)[:dvd_episode_number].should == 1234
+    end
+
+    it 'should map DVD_season' do
+      klass.map('DVD_season' => 1234)[:dvd_season].should == 1234
+    end
+
+    it 'should map Director' do
+      klass.map('Director' => '|test|')[:director].should == ['test']
+    end
+
+    it 'should map EpImgFlag' do
+      klass.map('EpImgFlag' => 1234)[:ep_img_flag].should == 1234
+    end
+
+    it 'should map EpisodeName' do
+      klass.map('EpisodeName' => 'test')[:name].should == 'test'
+    end
+
+    it 'should map EpisodeNumber' do
+      klass.map('EpisodeNumber' => 1234)[:number].should == 1234
+    end
+
+    it 'should map FirstAired' do
+      klass.map('FirstAired' => 1234)[:first_aired].should == 1234
+    end
+
+    it 'should map GuestStars' do
+      klass.map('GuestStars' => '|test|')[:guest_stars].should == ['test']
+    end
+
+    it 'should map IMDB_ID' do
+      klass.map('IMDB_ID' => 'test')[:imdb_id].should == 'test'
+    end
+
+    it 'should map Language' do
+      klass.map('Language' => 'test')[:language].should == 'test'
+    end
+
+    it 'should map Overview' do
+      klass.map('Overview' => 'test')[:overview].should == 'test'
+    end
+
+    it 'should map ProductionCode' do
+      klass.map('ProductionCode' => 'test')[:production_code].should == 'test'
+    end
+
+    it 'should map Rating' do
+      klass.map('Rating' => '1.0')[:rating].should == '1.0'
+    end
+
+    it 'should map RatingCount' do
+      klass.map('RatingCount' => '1')[:rating_count].should == '1'
+    end
+
+    it 'should map SeasonNumber' do
+      klass.map('SeasonNumber' => '1')[:season].should == '1'
+    end
+
+    it 'should map Writer' do
+      klass.map('Writer' => '|test|')[:writer].should == ['test']
+    end
+
+    it 'should map absolute_number' do
+      klass.map('absolute_number' => '1')[:absolute_number].should == '1'
+    end
+
+    it 'should map airsafter_season' do
+      klass.map('airsafter_season' => '1')[:airs_after_season].should == '1'
+    end
+
+    it 'should map airsbefore_episode' do
+      klass.map('airsbefore_episode' => '1')[:airs_before_episode].should == '1'
+    end
+
+    it 'should map airsbefore_season' do
+      klass.map('airsbefore_season' => '1')[:airs_before_season].should == '1'
+    end
+
+    it 'should map filename' do
+      klass.map('filename' => 'test')[:filename_path].should == 'test'
+    end
+
+    it 'should map lastupdated' do
+      klass.map('lastupdated' => '1234')[:last_updated_at].should == Time.at(1234)
+    end
+
+    it 'should map season_id' do
+      klass.map('season_id' => '1')[:season_id].should == '1'
+    end
+
+    it 'should map series_id' do
+      klass.map('series_id' => '1')[:series_id].should == '1'
+    end
+
+    it 'should map thumb_added' do
+      klass.map('thumb_added' => 'test')[:thumbnail_added_at].should == 'test'
+    end
+
+    it 'should map thumb_height' do
+      klass.map('thumb_height' => 'test')[:thumbnail_height].should == 'test'
+    end
+
+    it 'should map thumb_weight' do
+      klass.map('thumb_weight' => 'test')[:thumbnail_width].should == 'test'
+    end
+  end
+end