get_tapas 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e18e87b07cb269780647167e73b4d6808da1ced
+  data.tar.gz: 58893d7ffe0865724bb949b2f5ceff60cd7c15e8
+SHA512:
+  metadata.gz: dc2feee0bc5331e30ebbecfc9905f973e942f609688471dc1114aed2f9092b5e07d2a97b7b941275c72544d2cdddf1cc77bac81713aec973cb3959c5b736bfe5
+  data.tar.gz: 161bdebe77eca12d4bc4f3432d96f4052507e89aaee412516f2c8675a56ea267f0a33a28be4f3adebe152ac2903663a5c393b516382cad1945cbc315ba3f27cc

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.idea/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Keith Bennett
+
+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,59 @@
+# get-tapas #
+
+Downloads Ruby Tapas screencast videos for paid subscribers.
+
+Prerequisites:
+
+* ruby (of course)
+* curl (install with your package manager such as brew, yum, or apt-get)
+
+Instructions:
+
+```
+gem install get-tapas
+# Get the video download HTML text (see below.)
+get-tapas [options]
+```
+
+This gem provides a script that _partially_ automates the process of
+downloading Ruby Tapas screencasts en masse, eliminating the need to 
+click each screencast's link individually.
+
+## Getting the Required HTML Text
+
+Here are the steps you will need to follow:
+
+* Log in to https://www.rubytapas.com.
+* Navigate to https://www.rubytapas.com/download-list, either by
+inserting the URL above into the address bar, or by
+selecting _Video Downloads_ from the _Episodes_ menu.
+* View the page's source, in many browsers by pressing _Ctrl/Cmd-U_.
+* Select all its text (_Ctrl/Cmd-A_).
+* Copy that text to the clipboard (_Ctrl/Cmd-C_).
+* You can either:
+  * pipe the text from your clipboard into the get-tapas script using `pbpaste` 
+  or whatever other clipboard paste command your system provides, 
+  and specifying to the script that it should get the HTML 
+  from standard input (`-i -`), or 
+  * save the text to a file, as in `pbpaste > download_list.html`, 
+  and specify that filename with `-i path/to/download_list.html`.
+
+
+## Command Line Options
+
+Running the script without any arguments will output the command line
+options.  They're pretty self explanatory. For your convenience, here is
+the output:
+
+```
+Usage: get-tapas [options]
+    -d, --data_dir dir               Directory for downloaded files (default: .)
+    -i, --input_spec spec            Filespec (or '-' for STDIN) containing Ruby Tapas download list page HTML
+    -0, --min_episode_num number     Minimum episode number to download
+    -9, --max_episode_num number     Maximum episode number to download
+    -n, --[no-]no_op                 Don't download anything, just show what would have been downloaded.
+    -r, --[no-]reverse               Reverse the list of input files to download most recent first
+    -z, --sleep_interval seconds     Sleep this many seconds between files
+    -h, --help                       Show this message
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "get_tapas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/get-tapas

@@ -0,0 +1,104 @@
+#!/usr/bin/env ruby
+
+=begin
+Usage: get-tapas [options]
+    -d, --data_dir dir               Directory for downloaded files (default: .)
+    -i, --input_spec spec            Filespec (or '-' for STDIN) containing Ruby Tapas download list page HTML
+    -0, --min_episode_num number     Minimum episode number to download
+    -9, --max_episode_num number     Maximum episode number to download
+    -n, --[no-]no_op                 Don't download anything, just show what would have been downloaded.
+    -r, --[no-]reverse               Reverse the list of input files to download most recent first
+    -z, --sleep_interval seconds     Sleep this many seconds between files
+    -h, --help                       Show this message
+=end
+
+
+require 'awesome_print'
+require 'fileutils'
+require 'optparse'
+require 'ostruct'
+require 'shellwords'
+require_relative '../lib/get_tapas/downloader'
+require_relative '../lib/get_tapas/options'
+require_relative '../lib/get_tapas/page_parser'
+
+def pry
+  require 'pry'
+  binding.pry
+end
+
+
+def process_options
+
+  option_parser = nil
+  output_help_and_terminate = -> { puts option_parser; puts; exit(-1) }
+
+  options = Options.new
+
+  OptionParser.new do |opts|
+
+    option_parser = opts
+
+    opts.banner = "Usage: get-tapas [options]"
+
+    opts.on('-d', '--data_dir dir', 'Directory for downloaded files (default: .)') do |value|
+      options.data_dir = value
+    end
+
+    opts.on('-i', '--input_spec spec',
+            %q{Filespec (or '-' for STDIN) containing Ruby Tapas download list page HTML})  do |value|
+      options.input_spec = value
+    end
+
+    opts.on('-0', '--min_episode_num number',
+            %q{Minimum episode number to download}) do |value|
+      options.min_episode_num = value.to_i
+    end
+
+    opts.on('-9', '--max_episode_num number',
+            %q{Maximum episode number to download}) do |value|
+      options.max_episode_num = value.to_i
+    end
+
+    opts.on('-n', '--[no-]no_op', "Don't download anything, just show what would have been downloaded.") do |value|
+      options.no_op = value
+    end
+
+    opts.on('-r', '--[no-]reverse', 'Reverse the list of input files to download most recent first') do |value|
+      options.reverse = value
+    end
+
+    opts.on('-z', '--sleep_interval seconds', 'Sleep this many seconds between files') do |value|
+      options.sleep_interval = value.to_f
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+      output_help_and_terminate.()
+    end
+
+  end.parse!
+
+  if ARGV.empty?
+    output_help_and_terminate.()
+  end
+
+  options
+end
+
+
+def get_html(options)
+  input = options.input_spec
+  if input == '-'
+    STDIN.read
+  else
+    File.read(input)
+  end
+end
+
+
+options = process_options
+puts "Running get-tapas with the following options:"
+ap options.to_h; puts
+
+html = get_html(options)
+Downloader.new(html, options).call

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/get_tapas.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'get_tapas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'get_tapas'
+  spec.version       = GetTapas::VERSION
+  spec.authors       = ['Keith Bennett']
+  spec.email         = ['keithrbennett@gmail.com']
+
+  spec.summary       = %q{Downloads Ruby Tapas screencasts.}
+  spec.description   = %q{Downloads Ruby Tapas screencasts en masse for paid subscribers.}
+  spec.homepage      = 'https://github.com/keithrbennett/get-tapas'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'awesome_print', '~> 1.7'
+  spec.add_dependency 'nokogiri',      '~> 1.7'
+end

data/lib/get_tapas/download_link.rb

@@ -0,0 +1,12 @@
+class DownloadLink < Struct.new(
+    :url,
+    :filename,
+    :description,
+    :filespec,
+    :episode_num)
+
+  def to_s
+    to_h.to_s
+ end
+end
+

data/lib/get_tapas/downloader.rb

@@ -0,0 +1,108 @@
+class Downloader
+
+  attr_accessor :html, :options
+
+  def initialize(html, options)
+    @html = html
+    @options = options
+  end
+
+  def episode_num_ok(episode_num)
+    min = options.min_episode_num
+    max = options.max_episode_num
+
+    return false if min && episode_num < min
+    return false if max && episode_num > max
+    true
+  end
+
+
+  def ensure_output_dir_exists(dir)
+    return if Dir.exists?(dir)
+    begin
+      FileUtils.mkdir_p(dir)
+      puts "Created output data directory #{dir}."
+    rescue Errno::EACCES
+      puts "Unable to create directory #{dir}. Exiting..."
+      exit(-1)
+    end
+  end
+
+
+  def filespecs_available(data_dir, links)
+    filenames = links.map { |link| link.filename}
+    filenames.map { |fn| File.join(data_dir, fn) }
+  end
+
+
+  def filespecs_present(data_dir)
+    Dir["#{data_dir}/*"]
+  end
+
+
+  def filespecs_needing_download(available, present)
+    available - present
+  end
+
+
+  def download_file_info(links)
+    present, absent = links.partition do |link|
+      File.file?(link.filespec)
+    end
+    [links, present, absent]
+  end
+
+
+  def get_link_info(html, dir)
+    links = PageParser.parse(html)
+    links.each do |link|
+      link.filespec = File.join(dir, link.filename)
+      link.episode_num = link.filename.split('-').first.to_i
+    end
+  end
+
+
+  def download_file(link, data_dir)
+    puts "Downloading #{link.filespec}..."
+    tempfilespec = File.join(data_dir, 'tempfile')
+    `curl -o #{tempfilespec} #{Shellwords.shellescape(link.url)}`
+    if $?.exitstatus == 0
+      FileUtils.mv(tempfilespec, link.filespec)
+      puts "Finished downloading #{link.filename}\n\n"
+    else
+      raise "Curl Download failed with exit status #{$0.exitstatus}."
+    end
+  end
+
+
+  def call
+    data_dir = options.data_dir
+
+    ensure_output_dir_exists(data_dir)
+    links = get_link_info(html, data_dir)
+    _available, _present, absent = download_file_info(links)
+
+    absent.reverse! if options.reverse
+
+    absent_within_desired_range = absent.select { |a| episode_num_ok(a.episode_num)}
+
+    num_downloads_to_do = absent_within_desired_range.size
+
+    if num_downloads_to_do == 0
+      puts "No files within the selection criteria needed to be downloaded."
+    elsif options.no_op
+      puts "No-op mode requested. The following #{num_downloads_to_do} file(s) would have been downloaded without it:\n\n"
+      puts absent_within_desired_range.map(&:filename).join("\n"); puts
+      exit(0)
+    else
+      absent_within_desired_range.each_with_index do |link, index|
+        download_file(link, data_dir)
+        this_was_the_last_one = (index == num_downloads_to_do - 1)
+        if options.sleep_interval && (! this_was_the_last_one)
+          puts "Sleeping #{options.sleep_interval} seconds..."
+          sleep(options.sleep_interval)
+        end
+      end
+    end
+  end
+end

data/lib/get_tapas/options.rb

@@ -0,0 +1,25 @@
+class Options < Struct.new( \
+    :data_dir,
+    :input_spec,
+    :min_episode_num,
+    :max_episode_num,
+    :no_op,
+    :reverse,
+    :sleep_interval
+)
+
+  DEFAULT_TAPAS_DIR = '~/ruby-tapas'
+
+  def initialize
+    super
+    self.data_dir ||= DEFAULT_TAPAS_DIR
+  end
+
+  # Convert '~' to $HOME if necessary.
+  def data_dir=(dir)
+    if dir.is_a?(String) && dir[0,2] == '~/'
+      dir = File.join(ENV['HOME'], dir[2..-1])
+    end
+    super(dir)
+  end
+end

data/lib/get_tapas/page_parser.rb

@@ -0,0 +1,27 @@
+require 'mechanize'
+require 'nokogiri'
+
+require_relative 'download_link'
+
+module PageParser
+
+
+  # Example Input: "https://rubytapas-media.s3.amazonaws.com/298-file-find.mp4?response-content-disposition=...
+  # Example Return: '298-file-find.mp4'
+  RUBY_TAPAS_URL_TO_FILENAME = ->(url) { url.split('?').first.split('/').last }
+
+
+  # @param html_string an HTML string from https://www.rubytapas.com/download-list/
+  # @return an array of DownloadLink instances.
+  def self.parse(html_string, fn_url_to_filename = RUBY_TAPAS_URL_TO_FILENAME)
+    html_doc = Nokogiri::HTML(html_string)
+    html_links = html_doc.xpath("//*[contains(@class, 'video-download-link')]")
+
+    html_links.map do |link|
+      url         = link.children.first.attributes['href'].value
+      description = link.children.first.text.strip
+      filename    = fn_url_to_filename.(url)
+      DownloadLink.new(url, filename, description)
+    end
+  end
+end

data/lib/get_tapas/version.rb

@@ -0,0 +1,3 @@
+module GetTapas
+  VERSION = "0.9.0"
+end

data/lib/get_tapas.rb

@@ -0,0 +1,5 @@
+require "get_tapas/version"
+
+module GetTapas
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: get_tapas
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Keith Bennett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Downloads Ruby Tapas screencasts en masse for paid subscribers.
+email:
+- keithrbennett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/get-tapas
+- bin/setup
+- get_tapas.gemspec
+- lib/get_tapas.rb
+- lib/get_tapas/download_link.rb
+- lib/get_tapas/downloader.rb
+- lib/get_tapas/options.rb
+- lib/get_tapas/page_parser.rb
+- lib/get_tapas/version.rb
+homepage: https://github.com/keithrbennett/get-tapas
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Downloads Ruby Tapas screencasts.
+test_files: []