ruby-tapas-downloader 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cca06220dad1b22ec9ac237334ff1f860674e68
+  data.tar.gz: a9392d4d857a3fcd85257c9cdcb5bae7532e9f0a
+SHA512:
+  metadata.gz: 00ebe03a4463feb0b9168118b0cbdc2ef66cafb3ccc14f6316a3fe17463fa40368b9d585019644e4aaf0fa1d5409149e722e61920315babff495164d2772caf8
+  data.tar.gz: 5d10b7bcb522279593ccf512b002b614d3aea17eb78a64d62cd2d6fe49c6f22da9ecbbac3e763baa4fcf5369edfd266d84378e0819564f7daf7c0809286ae28e

data/License.txt

@@ -0,0 +1,13 @@
+     DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2013 Leandro Facchinetti <leafac@gmail.com>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md

@@ -0,0 +1,46 @@
+Ruby Tapas Downloader
+=====================
+
+[Ruby Tapas][ruby-tapas] is a great series of screencasts by
+[Avdi Grimm][avdi-grimm]. You should totally check it out if you don't already
+know it!
+
+There's only one problem with Ruby Tapas, in my opinion: there's no way to
+watch it via straming. One can only download episodes, which soon becomes
+tedious.
+
+Enters Ruby Tapas Downloader! It downloads all episodes and attachments,
+organizes them for later use and keeps an easy to use index of episodes.
+
+Installation
+------------
+
+```bash
+$ gem install ruby-tapas-downloader
+```
+
+Usage
+-----
+
+```bash
+$ ruby-tapas-downloader <email> <password> <download-path>
+```
+
+Warning
+-------
+
+Except for a few episodes, Ruby Tapas is a paid screencast. Therefore, assert
+that you don't redistribute the downloaded material. Ruby Tapas Downloader is
+only an utility tool and doesn't substitute the subscription.
+
+You should do no evil!
+
+Thanks
+------
+
+Thanks Avdi Grimm for putting all this great material out the door!
+
+I learn a lot from you.
+
+[ruby-tapas]: http://www.rubytapas.com/
+[avdi-grimm]: http://devblog.avdi.org/

data/bin/ruby-tapas-downloader

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+if ARGV.count != 3
+  abort <<-USAGE
+Usage:
+$ ruby-tapas-downloader <email> <password> <download-path>
+  USAGE
+end
+
+require_relative '../lib/ruby_tapas_downloader/cli'
+
+RubyTapasDownloader::CLI.new(*ARGV).download

data/config/urls.yml

@@ -0,0 +1,3 @@
+---
+:login: https://rubytapas.dpdcart.com/subscriber/content
+:feed: https://rubytapas.dpdcart.com/feed

data/lib/ruby-tapas-downloader.rb

@@ -0,0 +1,30 @@
+require 'yaml'
+require 'fileutils'
+require 'rss'
+require 'rexml/document'
+require 'set'
+require 'cgi'
+require 'logger'
+
+module RubyTapasDownloader
+  class << self
+    # The Logger for RubyTapasDownloader.
+    attr_writer :logger
+
+    # @return [Logger] the Logger for RubyTapasDownloader
+    def logger
+      @logger ||= Logger.new STDOUT
+    end
+  end
+end
+
+require 'bundler/setup'
+require 'mechanize'
+
+require_relative 'ruby_tapas_downloader/downloadables'
+
+require_relative 'ruby_tapas_downloader/extractors'
+
+require_relative 'ruby_tapas_downloader/config'
+require_relative 'ruby_tapas_downloader/login'
+require_relative 'ruby_tapas_downloader/feed_fetcher'

data/lib/ruby_tapas_downloader/cli.rb

@@ -0,0 +1,45 @@
+require_relative '../ruby-tapas-downloader'
+
+# The Command Line Interface for Ruby Tapas Downloader.
+class RubyTapasDownloader::CLI
+  # @param email [String] the e-mail for the user.
+  # @param password [String] the password for the user.
+  # @param download_path [String] the path in which the download is performed.
+  def initialize email, password, download_path
+    @email         = email
+    @password      = password
+    @download_path = download_path
+  end
+
+  # Perform complete download procedure.
+  def download
+    create_agent
+    login
+    fetch_feed
+    create_catalog
+    download_catalog
+  end
+
+  private
+
+  def create_agent
+    @agent = Mechanize.new
+  end
+
+  def login
+    RubyTapasDownloader::Login.new(@agent, @email, @password).login
+  end
+
+  def fetch_feed
+    @feed = RubyTapasDownloader::FeedFetcher.new(@agent, @email, @password)
+                                                                         .fetch
+  end
+
+  def create_catalog
+    @catalog = RubyTapasDownloader::Extractors::Catalog.new.extract @feed
+  end
+
+  def download_catalog
+    @catalog.download @download_path, @agent
+  end
+end

data/lib/ruby_tapas_downloader/config.rb

@@ -0,0 +1,8 @@
+# Retrieve configurations.
+class RubyTapasDownloader::Config
+  # Retrieve urls stored in `urls.yml`.
+  # @return [Hash] the urls stored in `urls.yml`.
+  def self.urls
+    @urls ||= YAML.load File.read 'config/urls.yml'
+  end
+end

data/lib/ruby_tapas_downloader/downloadable.rb

@@ -0,0 +1,7 @@
+# The contract for Downloadables.
+class RubyTapasDownloader::Downloadable
+  # Should be implemented by children.
+  def download
+    fail NotImplementedError
+  end
+end

data/lib/ruby_tapas_downloader/downloadables.rb

@@ -0,0 +1,9 @@
+# Namespace module for Downloadable assets.
+module RubyTapasDownloader::Downloadables
+end
+
+require_relative 'downloadable'
+
+require_relative 'downloadables/file'
+require_relative 'downloadables/episode'
+require_relative 'downloadables/catalog'

data/lib/ruby_tapas_downloader/downloadables/catalog.rb

@@ -0,0 +1,34 @@
+# Catalog is the set of all Ruby Tapas Episodes.
+class RubyTapasDownloader::Downloadables::Catalog <
+                                              RubyTapasDownloader::Downloadable
+
+  # @return [Set<RubyTapasDownloader::Downloadables::Episode>] the Episodes.
+  attr_reader :episodes
+
+  def initialize episodes
+    @episodes = episodes
+  end
+
+  # Download the Catalog.
+  #
+  # @param basepath [String] the path to place download.
+  # @param agent [Mechanize] the Mechanize agent.
+  def download basepath, agent
+    RubyTapasDownloader.logger.info 'Starting download of catalog in ' \
+                                    "`#{ basepath }'..."
+    FileUtils.mkdir_p basepath
+    episodes.each { |episode| episode.download basepath, agent }
+  end
+
+  def == other
+    episodes == other.episodes
+  end
+
+  def eql? other
+    episodes.eql? other.episodes
+  end
+
+  def hash
+    episodes.hash
+  end
+end

data/lib/ruby_tapas_downloader/downloadables/episode.rb

@@ -0,0 +1,51 @@
+# An Ruby Tapas Episode.
+class RubyTapasDownloader::Downloadables::Episode <
+                                              RubyTapasDownloader::Downloadable
+
+  # @return [String] the title of the Episode.
+  attr_reader :title
+
+  # @return [String] the link to the Episode.
+  attr_reader :link
+
+  # @return [Set<RubyTapasDownloader::Downloadables::File>] the Set of Files
+  #   for that episode.
+  attr_reader :files
+
+  def initialize title, link, files
+    @title = title
+    @link  = link
+    @files = files
+  end
+
+  # Clean title to be used in path names.
+  #
+  # @return [String] the sanitized title.
+  def sanitized_title
+    @sanitized_title ||= title.downcase.gsub(/[^\w<>#?!$]+/, '-')
+  end
+
+
+  # Download the Episode.
+  #
+  # @param (see: RubyTapasDownloader::Downloadables::Catalog#download)
+  def download basepath, agent
+    episode_path = File.join basepath, sanitized_title
+    RubyTapasDownloader.logger.info 'Starting download of episode ' \
+                                    "`#{ title }' in `#{ episode_path }'..."
+    FileUtils.mkdir_p episode_path
+    files.each { |file| file.download episode_path, agent }
+  end
+
+  def == other
+    title == other.title && link == other.link && files == other.files
+  end
+
+  def eql? other
+    title.eql?(other.title) && link.eql?(other.link) && files.eql?(other.files)
+  end
+
+  def hash
+    title.hash + link.hash + files.hash
+  end
+end

data/lib/ruby_tapas_downloader/downloadables/file.rb

@@ -0,0 +1,39 @@
+# The File resource of an Episode.
+class RubyTapasDownloader::Downloadables::File <
+                                              RubyTapasDownloader::Downloadable
+
+  # @return [String] the name of the File.
+  attr_reader :name
+
+  # @return [String] the link to download the File.
+  attr_reader :link
+
+  def initialize name, link
+    @name = name
+    @link = link
+  end
+
+  # Download the File.
+  #
+  # @param (see: RubyTapasDownloader::Downloadables::Catalog#download)
+  def download basepath, agent
+    FileUtils.mkdir_p basepath
+
+    file_path = File.join(basepath, name)
+    RubyTapasDownloader.logger.info "Starting download of file `#{ name }' " \
+                                    "in `#{ file_path }'..."
+    agent.download link, file_path unless File.exists? file_path
+  end
+
+  def == other
+    name == other.name && link == other.link
+  end
+
+  def eql? other
+    name.eql?(other.name) && link.eql?(other.link)
+  end
+
+  def hash
+    name.hash + link.hash
+  end
+end

data/lib/ruby_tapas_downloader/extractor.rb

@@ -0,0 +1,7 @@
+# The contract for Extractors.
+class RubyTapasDownloader::Extractor
+  # Should be implemented by children.
+  def extract
+    fail NotImplementedError
+  end
+end

data/lib/ruby_tapas_downloader/extractors.rb

@@ -0,0 +1,9 @@
+# Namespace module for Extractors.
+module RubyTapasDownloader::Extractors
+end
+
+require_relative 'extractor'
+
+require_relative 'extractors/files'
+require_relative 'extractors/episode'
+require_relative 'extractors/catalog'

data/lib/ruby_tapas_downloader/extractors/catalog.rb

@@ -0,0 +1,22 @@
+# Extract an Catalog from an Feed.
+class RubyTapasDownloader::Extractors::Catalog < RubyTapasDownloader::Extractor
+  # @param episode_extractor [RubyTapasDownloader::Extractors::Episode] the
+  #   Episode Extractor.
+  def initialize episode_extractor =
+                                   RubyTapasDownloader::Extractors::Episode.new
+    @episode_extractor = episode_extractor
+  end
+
+  # @param feed [RSS::Rss] the feed extracted with `RSS::Parser.parse`.
+  # @return [RubyTapasDownloader::Downloadables::Catalog] the Catalog extracted
+  #   from feed.
+  def extract feed
+    episodes = Set.new
+
+    feed.items.each { |item|
+      episodes << @episode_extractor.extract(item)
+    }
+
+    RubyTapasDownloader::Downloadables::Catalog.new episodes
+  end
+end

data/lib/ruby_tapas_downloader/extractors/episode.rb

@@ -0,0 +1,20 @@
+# Extract an Episode from an Feed Item.
+class RubyTapasDownloader::Extractors::Episode < RubyTapasDownloader::Extractor
+  # @param files_extractor [RubyTapasDownloader::Extractors::Files] the
+  #   Files Extractor.
+  def initialize files_extractor = RubyTapasDownloader::Extractors::Files.new
+    @files_extractor = files_extractor
+  end
+
+  # @param item [RSS::Rss::Channel::Item] the feed item extracted with
+  #   `feed.items[i]`.
+  # @return [RubyTapasDownloader::Downloadables::Episode] the Episode extracted
+  #   from feed item.
+  def extract item
+    title = CGI.unescapeHTML item.title
+    link  = item.link
+    files = @files_extractor.extract item.description
+
+    RubyTapasDownloader::Downloadables::Episode.new title, link, files
+  end
+end

data/lib/ruby_tapas_downloader/extractors/files.rb

@@ -0,0 +1,17 @@
+# Extract a Set of Files from an Feed Item Description.
+class RubyTapasDownloader::Extractors::Files < RubyTapasDownloader::Extractor
+  # @param item_description [String] the feed item description extracted with
+  #   `feed.items[i].description`.
+  # @return [Set<RubyTapasDownloader::Downloadables::File>] the Set of Files
+  #   extracted from feed item description.
+  def extract item_description
+    files = Set.new
+    document = REXML::Document.new item_description
+    document.elements.each("/div[@class='blog-entry']/ul/li/a") { |element|
+      name = element.text
+      link = element.attribute('href').to_s
+      files << RubyTapasDownloader::Downloadables::File.new(name, link)
+    }
+    files
+  end
+end

data/lib/ruby_tapas_downloader/feed_fetcher.rb

@@ -0,0 +1,29 @@
+# Fetches feed from Ruby Tapas.
+class RubyTapasDownloader::FeedFetcher
+  # @return [Mechanize] the Mechanize agent.
+  attr_reader :agent
+
+  # @return [String] the e-mail for the user.
+  attr_reader :email
+
+  # @return [String] the password for the user.
+  attr_reader :password
+
+  def initialize agent, email, password
+    @agent    = agent
+    @email    = email
+    @password = password
+  end
+
+  # Fetch feed from Ruby Tapas.
+  #
+  # @return [RSS::Rss] the feed for Ruby Tapas.
+  def fetch
+    RubyTapasDownloader.logger.info 'Fetching episodes feed...'
+
+    feed_url = RubyTapasDownloader::Config.urls[:feed]
+
+    agent.add_auth feed_url, email, password
+    RSS::Parser.parse agent.get(feed_url).body
+  end
+end

data/lib/ruby_tapas_downloader/login.rb

@@ -0,0 +1,46 @@
+# Perform Login in Ruby Tapas.
+#
+# Login must be performed before any attempt to download files.
+class RubyTapasDownloader::Login
+  # @return [Mechanize] the Mechanize agent.
+  attr_reader :agent
+
+  # @return [String] the e-mail for the user.
+  attr_reader :email
+
+  # @return [String] the password for the user.
+  attr_reader :password
+
+  def initialize agent, email, password
+    @agent    = agent
+    @email    = email
+    @password = password
+  end
+
+  # Perform login.
+  def login
+    RubyTapasDownloader.logger.info 'Logging in...'
+    request_login_page
+    fill_login_form
+    submit_login_form
+  end
+
+  private
+
+  def request_login_page
+    @page = agent.get RubyTapasDownloader::Config.urls.fetch(:login)
+  end
+
+  def fill_login_form
+    login_form.username = email
+    login_form.password = password
+  end
+
+  def submit_login_form
+    login_form.submit
+  end
+
+  def login_form
+    @page.forms.first
+  end
+end

data/lib/ruby_tapas_downloader/version.rb

@@ -0,0 +1,3 @@
+module RubyTapasDownloader
+  VERSION = '1.0.1'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: ruby-tapas-downloader
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Leandro Facchinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: It downloads all episodes and attachments, organizes them for later use
+  and keeps an easy to use index of episodes.
+email: ruby-tapas-downloader@leafac.com
+executables:
+- ruby-tapas-downloader
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- License.txt
+- README.md
+- bin/ruby-tapas-downloader
+- config/urls.yml
+- lib/ruby-tapas-downloader.rb
+- lib/ruby_tapas_downloader/cli.rb
+- lib/ruby_tapas_downloader/config.rb
+- lib/ruby_tapas_downloader/downloadable.rb
+- lib/ruby_tapas_downloader/downloadables.rb
+- lib/ruby_tapas_downloader/downloadables/catalog.rb
+- lib/ruby_tapas_downloader/downloadables/episode.rb
+- lib/ruby_tapas_downloader/downloadables/file.rb
+- lib/ruby_tapas_downloader/extractor.rb
+- lib/ruby_tapas_downloader/extractors.rb
+- lib/ruby_tapas_downloader/extractors/catalog.rb
+- lib/ruby_tapas_downloader/extractors/episode.rb
+- lib/ruby_tapas_downloader/extractors/files.rb
+- lib/ruby_tapas_downloader/feed_fetcher.rb
+- lib/ruby_tapas_downloader/login.rb
+- lib/ruby_tapas_downloader/version.rb
+homepage: https://github.com/leafac/ruby-tapas-downloader
+licenses:
+- wtfpl
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Downloader for Avdi Grimm Ruby Tapas
+test_files: []