my_episodes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baf01e0820221ce85012d67c4cddcb60fa91fd62
+  data.tar.gz: a898c7f434ce68400188daf639ddd278b4df60f6
+SHA512:
+  metadata.gz: f3734bcd664a66aa9c5fd9f2c24b56735e0b2f6ed4135f7907ba3a4fa8214e19d29f3181083414f43c85aa0af4516eb40d081fe554226e1d784a79c264fae33d
+  data.tar.gz: 5446854bfa20da02ef4ae8576503567292c3c5f7404a11ac8fb5818cd8c52120001c6967f5e587317bfc2321fc8fe028fd040b1da945f780ad15ec5453586277

data/README.md

@@ -0,0 +1,32 @@
+# my episodes
+
+[![Build Status](https://travis-ci.org/mthssdrbrg/my_episodes.png?branch=master)](https://travis-ci.org/mthssdrbrg/my_episodes)
+[![Coverage Status](https://coveralls.io/repos/mthssdrbrg/my_episodes/badge.png?branch=master)](https://coveralls.io/r/mthssdrbrg/my_episodes?branch=master)
+
+[My Episodes](http://www.myepisodes.com) helps one keep track of one's TV shows,
+but unfortunately there's no API or no built-in functionality for exporting
+one's history, hence this gem.
+
+There's a simple bin script, `myeps`, that can be used to dump your history to
+standard out (and then you can pipe it to a file or whatever).
+
+## Installation
+
+```
+gem install my_episodes
+```
+
+## Usage
+
+```
+Usage: myeps [options]
+    -D, --dump                       Dump history from myepisodes.com to CSV
+    -u, --username=USERNAME          Username for myepisodes.com
+    -p, --password=PASSWORD          Password for myepisodes.com
+    -s, --separator=SEP              Separator for CSV output
+    -h, --help                       You're looking at it
+```
+
+## Copyright
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT) :: 2014 Mathias Söderberg.

data/bin/myeps

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'my_episodes'
+
+
+MyEpisodes::Cli.run(ARGV, $stdout)

data/lib/my_episodes.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'mechanize'
+
+
+module MyEpisodes
+  MyEpisodesError = Class.new(StandardError)
+  AuthenticationError = Class.new(MyEpisodesError)
+end
+
+require 'my_episodes/cli'
+require 'my_episodes/client'
+require 'my_episodes/dump'
+require 'my_episodes/episode'
+require 'my_episodes/season'
+require 'my_episodes/show'
+require 'my_episodes/shows'
+require 'my_episodes/table_parser'

data/lib/my_episodes/cli.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require 'optparse'
+
+
+module MyEpisodes
+  class Cli
+    def initialize
+      @options = {action: :help}
+      @parser = create_parser
+    end
+
+    def parse(argv)
+      @parser.parse(argv)
+    end
+
+    def self.run(argv, io)
+      cli = self.new
+      cli.parse(argv)
+      cli.run(io)
+    end
+
+    def run(io)
+      case @options[:action]
+      when :dump
+        Dump.new(client, io, @options).execute
+      when :help
+        io.puts(@parser)
+      end
+    end
+
+    private
+
+    def client
+      @client ||= Client.create(*@options.values_at(:username, :password))
+    end
+
+    def create_parser
+      OptionParser.new do |opts|
+        opts.on('-D', '--dump', 'Dump history from myepisodes.com to CSV') do
+          @options[:action] = :dump
+        end
+
+        opts.on('-u', '--username=USERNAME', 'Username for myepisodes.com') do |username|
+          @options[:username] = username
+        end
+
+        opts.on('-p', '--password=PASSWORD', 'Password for myepisodes.com') do |passwd|
+          @options[:password] = passwd
+        end
+
+        opts.on('-s', '--separator=SEP', 'Separator for CSV output') do |separator|
+          @options[:separator] = separator
+        end
+
+        opts.on('-h', '--help', 'You\'re looking at it') do
+          @options[:action] = :help
+        end
+      end
+    end
+  end
+end

data/lib/my_episodes/client.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Client
+    def self.create(username, password, agent=Mechanize.new)
+      client = self.new(agent)
+      client.login(username, password)
+      client
+    end
+
+    def initialize(agent=Mechanize.new)
+      @agent = agent
+      @page = nil
+    end
+
+    def login(username, password)
+      unless @page
+        page = @agent.get(login_url)
+        form = page.form_with(action: 'login.php', method: 'POST')
+        form.username = username
+        form.password = password
+        form.u = life_wasted
+        @page = form.submit(form.buttons.first)
+        ensure_logged_in
+      end
+    end
+
+    def shows
+      @shows ||= Shows.new(parser).create(shows_links).to_a
+    end
+
+    def logout
+      if @page
+        @page.link_with(text: /Logout/).click
+        @page = nil
+      end
+    end
+
+    private
+
+    def parser
+      @parser ||= TableParser.new
+    end
+
+    def shows_links
+      @shows_links ||= @page.links_with(href: /views\.php\?type=epsbyshow/)
+    end
+
+    def login_url
+      @login_url ||= 'http://www.myepisodes.com/login.php'
+    end
+
+    def life_wasted
+      @life_wasted ||= 'life_wasted.php'
+    end
+
+    def still_on_login_page?
+      @page.title && @page.title.match(/: Login Page/i)
+    end
+
+    def login_warning?
+      warning_text = @page.search('#divContainer div.warning').text.strip
+      warning_text && warning_text.match(/wrong username.+password/i)
+    end
+
+    def ensure_logged_in
+      if still_on_login_page? && login_warning?
+        @page = nil
+        raise AuthenticationError, 'wrong username / password'
+      end
+    end
+  end
+end

data/lib/my_episodes/dump.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Dump
+    def initialize(client, output, options={})
+      @client = client
+      @output = output
+      @separator = options.fetch(:separator, ';')
+    end
+
+    def execute
+      @output.puts(headers.join(@separator))
+      @client.shows.each do |show|
+        show.seasons.each do |season|
+          season.episodes.each do |episode|
+            @output.puts(to_line(show, season, episode).join(@separator))
+          end
+        end
+      end
+    end
+
+    private
+
+    def to_line(s, se, e)
+      [s.name, se.name, e.number, e.name, e.acquired?, e.watched?]
+    end
+
+    def headers
+      @headers ||= %w[show season number episode_name acquired watched].freeze
+    end
+  end
+end

data/lib/my_episodes/episode.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Episode
+    attr_reader :air_date, :show_name, :number, :name
+
+    def initialize(season)
+      @season = season
+    end
+
+    def create(attrs)
+      attrs = sanitize(attrs)
+      @air_date = text(attrs[AIR_DATE_FIELD])
+      @show_name = text(attrs[SHOW_NAME_FIELD])
+      @number = text(attrs[NUMBER_FIELD])
+      @name = text(attrs[NAME_FIELD])
+      @acquired = checked?(attrs[ACQUIRED_FIELD])
+      @watched = checked?(attrs[WATCHED_FIELD])
+      self
+    end
+
+    def season
+      @season.freeze
+    end
+
+    def acquired?
+      !!@acquired
+    end
+
+    def watched?
+      !!@watched
+    end
+
+    private
+
+    def sanitize(attrs)
+      attrs.reject.with_index { |a, i| i.even? }
+    end
+
+    def text(a)
+      a.text.strip
+    end
+
+    def checked?(a)
+      a.children.any? && a.children.last.attr(CHECKED) == CHECKED
+    end
+
+    CHECKED = 'checked'.freeze
+    AIR_DATE_FIELD = 0
+    SHOW_NAME_FIELD = 1
+    NUMBER_FIELD = 2
+    NAME_FIELD = 3
+    ACQUIRED_FIELD = 4
+    WATCHED_FIELD = 5
+  end
+end

data/lib/my_episodes/season.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Season
+    attr_reader :name
+
+    def initialize(show=nil)
+      @show = show
+      @episodes = []
+    end
+
+    def create(row)
+      @name = row.text.strip
+      self
+    end
+
+    def <<(episode)
+      @episodes << episode
+    end
+
+    def episodes
+      @episodes.freeze
+    end
+
+    def show
+      @show.freeze
+    end
+  end
+end

data/lib/my_episodes/show.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Show
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @seasons = []
+    end
+
+    def create(rows)
+      season = nil
+      rows.each do |row|
+        if useless?(row)
+          next
+        elsif new_season?(row)
+          @seasons << Season.new(self).create(row)
+          season = @seasons.last
+        else
+          season << Episode.new(season).create(row.children)
+        end
+      end
+      self
+    end
+
+    def seasons
+      @seasons.freeze
+    end
+
+    private
+
+    def useless?(row)
+      row.text.strip.empty?
+    end
+
+    def new_season?(row)
+      row.attr(CLASS) == HEADER
+    end
+
+    CLASS = 'class'.freeze
+    HEADER = 'header'.freeze
+  end
+end

data/lib/my_episodes/shows.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module MyEpisodes
+  class Shows
+    include Enumerable
+
+    def initialize(parser)
+      @shows = []
+      @parser = parser
+    end
+
+    def create(links)
+      links.each do |link|
+        name = link.text
+        page = link.click
+        rows = @parser.parse(page)
+        @shows << Show.new(name).create(rows)
+      end
+
+      self
+    end
+
+    def each(&block)
+      @shows.each(&block)
+    end
+  end
+end

data/lib/my_episodes/table_parser.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module MyEpisodes
+	class TableParser
+		def initialize(options={})
+			@options = options
+			@search_string = 'table.mylist tr'.freeze
+		end
+
+		def parse(page)
+			table = page.search(@search_string)
+			table.shift unless @options[:keep_header]
+			table
+		end
+	end
+end

data/lib/my_episodes/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module MyEpisodes
+  VERSION = '0.1.0'.freeze
+end

data/spec/integration/cli_integration_spec.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module MyEpisodes
+  describe Cli, vcr: {cassette_name: 'my_episodes'} do
+    let :io do
+      StringIO.new
+    end
+
+    describe '-D / --dump' do
+      let :argv do
+        %w[--dump -u demo -p demo]
+      end
+
+      let :output do
+        io.string.split("\n")
+      end
+
+      before do
+        described_class.run(argv, io)
+      end
+
+      it 'dumps history to $stdout' do
+        expect(output.grep(/Akame ga KILL!/)).to_not be_empty
+        expect(output.grep(/Blake's 7/)).to_not be_empty
+        expect(output.grep(/Doctor Who/)).to_not be_empty
+        expect(output.grep(/Under the Dome/)).to_not be_empty
+        expect(output.grep(/Wilfred \(US\)/)).to_not be_empty
+        expect(output.size).to eq(587)
+      end
+
+      it 'includes headers' do
+        expect(output.first).to eq('show;season;number;episode_name;acquired;watched')
+      end
+
+      context 'with -s / --separator' do
+        let :argv do
+          %w[--dump -u demo -p demo -s ':']
+        end
+
+        it 'uses given character as separator' do
+          expect(output.grep(/.+:.+:.+/)).to_not be_empty
+        end
+      end
+    end
+
+    describe '-h / --help' do
+      let :argv do
+        %w[--help]
+      end
+
+      before do
+        described_class.run(argv, io)
+      end
+
+      it 'prints usage' do
+        expect(io.string).to match(/^Usage: /)
+      end
+    end
+
+    describe 'without any action' do
+      let :argv do
+        []
+      end
+
+      before do
+        described_class.run(argv, io)
+      end
+
+      it 'prints usage' do
+        expect(io.string).to match(/^Usage: /)
+      end
+    end
+  end
+end

data/spec/integration/client_integration_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module MyEpisodes
+  describe Client do
+    let :client do
+      described_class.create('demo', 'demo')
+    end
+
+    after do
+      client.logout
+    end
+
+    describe '#login' do
+      let :client do
+        described_class.new
+      end
+
+      context 'when given valid username and password', vcr: {cassette_name: 'login-fail'} do
+        it 'does not raise an error' do
+          expect { client.login('demo', 'demo') }.to_not raise_error
+        end
+      end
+
+      context 'when given invalid username and password', vcr: {cassette_name: 'login-success'} do
+        it 'raises an error' do
+          expect { client.login('demo', 'this is wrong') }.to raise_error(AuthenticationError)
+        end
+      end
+    end
+
+    describe '#shows', vcr: {cassette_name: 'my_episodes'} do
+      it 'parses the expected number of shows' do
+        expect(client.shows.size).to eq(5)
+      end
+
+      it 'parses seasons as expected' do
+        show = client.shows.find { |s| s.name == 'Doctor Who' }
+        expect(show.seasons.size).to eq(22)
+        show.seasons.each do |season|
+          expect(season.name).to_not be_nil
+          expect(season.name).to_not be_empty
+        end
+      end
+
+      it 'parses episodes as expected' do
+        show = client.shows.find { |s| s.name == 'Under the Dome' }
+        seasons = show.seasons
+        expect(seasons.size).to eq(2)
+        expect(seasons.first.episodes.size).to eq(1)
+        expect(seasons.last.episodes.size).to eq(11)
+      end
+    end
+  end
+end

data/spec/my_episodes/episode_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module MyEpisodes
+  describe Episode do
+    let :episode do
+      described_class.new(season)
+    end
+
+    let :season do
+      Season.new('Season 1')
+    end
+
+    let :attributes do
+      Nokogiri::HTML(File.read('spec/support/resources/episode.html'))
+        .children.last.children.first.children.first.children
+    end
+
+    it 'belongs to a Season' do
+      expect(episode.season).to be_a(Season)
+    end
+
+    describe '#create' do
+      before do
+        episode.create(attributes)
+      end
+
+      it 'parses air date' do
+        expect(episode.air_date).to eq('17-Aug-2014')
+      end
+
+      it 'parses show name' do
+        expect(episode.show_name).to eq('Akame ga KILL!')
+      end
+
+      it 'parses number' do
+        expect(episode.number).to eq('S01E07')
+      end
+
+      it 'parses name' do
+        expect(episode.name).to eq('Season 1, Episode 7')
+      end
+
+      it 'parses `acquired` state' do
+        expect(episode).to be_acquired
+      end
+
+      it 'parses `watched` state' do
+        expect(episode).to_not be_watched
+      end
+    end
+  end
+end

data/spec/my_episodes/season_spec.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module MyEpisodes
+  describe Season do
+    let :season do
+      described_class.new(show)
+    end
+
+    let :show do
+      Show.new('Show')
+    end
+
+    describe '#create' do
+      it 'sets name' do
+        row = double(:row, text: 'Season #1')
+        season.create(row)
+        expect(season.name).to eq('Season #1')
+      end
+
+      it 'strips whitespace characters' do
+        row = double(:row, text: "     Season #1\t\t\n")
+        season.create(row)
+        expect(season.name).to eq('Season #1')
+      end
+
+      it 'returns self' do
+        expect(season.create(double(:row, text: 'Season #1'))).to eq(season)
+      end
+    end
+
+    describe '#show' do
+      it 'returns given show, but frozen' do
+        expect(season.show).to eq(show)
+        expect(season.show).to be_frozen
+      end
+    end
+
+    describe '#<<' do
+      it 'adds an Episode to list of episodes' do
+        episode = Episode.new(season)
+        season << episode
+        expect(season.episodes.size).to eq(1)
+        expect(season.episodes).to eq([episode])
+      end
+    end
+
+    describe '#episodes' do
+      it 'returns a frozen list of episodes' do
+        expect(season.episodes).to be_frozen
+      end
+    end
+  end
+end

data/spec/my_episodes/show_spec.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+
+module MyEpisodes
+  describe Show do
+    let :show do
+      described_class.new('Show')
+    end
+
+    let :rows do
+      Nokogiri::HTML(File.read('spec/support/resources/show.html'))
+        .children.last.children.first.children
+    end
+
+    describe '#name' do
+      it 'returns the name of the show' do
+        expect(show.name).to eq('Show')
+      end
+    end
+
+    describe '#create' do
+      before do
+        show.create(rows)
+      end
+
+      it 'parses consecutive seasons' do
+        expect(show.seasons.size).to eq(2)
+      end
+
+      it 'parses episodes correctly' do
+        seasons = show.seasons
+        expect(seasons.first.episodes.size).to eq(3)
+        expect(seasons.last.episodes.size).to eq(1)
+      end
+    end
+
+    describe '#seasons' do
+      it 'returns a frozen list of seasons' do
+        expect(show.seasons).to be_frozen
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'vcr'
+require 'simplecov'
+require 'coveralls'
+require 'stringio'
+
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/support/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+if ENV.include?('TRAVIS')
+  Coveralls.wear!
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+
+SimpleCov.start do
+  add_group 'Source', 'lib'
+  add_group 'Unit tests', 'spec/my_episodes'
+  add_group 'Integration tests', 'spec/integration'
+end
+
+require 'my_episodes'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: my_episodes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mathias Söderberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Export history from myepisodes.com
+email: mths@sdrbrg.se
+executables:
+- myeps
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/myeps
+- lib/my_episodes.rb
+- lib/my_episodes/cli.rb
+- lib/my_episodes/client.rb
+- lib/my_episodes/dump.rb
+- lib/my_episodes/episode.rb
+- lib/my_episodes/season.rb
+- lib/my_episodes/show.rb
+- lib/my_episodes/shows.rb
+- lib/my_episodes/table_parser.rb
+- lib/my_episodes/version.rb
+- spec/integration/cli_integration_spec.rb
+- spec/integration/client_integration_spec.rb
+- spec/my_episodes/episode_spec.rb
+- spec/my_episodes/season_spec.rb
+- spec/my_episodes/show_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mthssdrbrg/my_episodes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simple myepisodes.com client
+test_files:
+- spec/integration/cli_integration_spec.rb
+- spec/integration/client_integration_spec.rb
+- spec/my_episodes/episode_spec.rb
+- spec/my_episodes/season_spec.rb
+- spec/my_episodes/show_spec.rb
+- spec/spec_helper.rb