das_catalog 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brendon Murphy
+
+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,65 @@
+Das Catalog
+===========
+
+The Das Catalog gem - used for downloading screencasts from the [Destroy All Software screencasts catalog](https://www.destroyallsoftware.com/screencasts).  Uses the rss feed plus Mechanize to log you in and then download unsaved movies to a local directory.
+
+This gem is in not linked to Destroy All Software or endorsed by Gary Bernhardt.  I just like his stuff.
+
+Requirements
+------------
+
+I've written and only run the gem on Ruby 1.9.2.  YMMV, but 1.8.x will definitely blow up.
+
+The gem also expects that wget exists in your path, as it uses it for downloaded the movie file.
+
+Installation
+------------
+
+Install the gem
+
+    $ gem install das_catalog
+
+Usage
+-----
+
+Run from the command line:
+
+    $ das_catalog_sync
+
+It will prompt your for some settings (username, password, storage directory) and then be off and running.
+
+Stored Configuration
+--------------------
+
+If you don't provide configuration, `das_catalog_sync` will prompt you for configuration values when you run it.
+
+However, you can persist a full or partial config in ~/.das_catalog.yml as such:
+
+    ---
+    username: your_username
+    password: your_password
+    downloads_directory: /Users/programmer/Movies/DAS
+
+If you wish to exclude any config, leave it out and `das_catalog_sync` will prompt your for it at runtime.
+
+Basic Process
+-------------
+
+The steps by which the gem works are fairly simple:
+
+  1. Fetch the rss feed to see what is in the catalog
+  2. Use Mechanize to log in at the DAS sign in page
+  3. Find links in the feed that have not been downloaded yet
+  4. Construct a download link, and grab the location header from the redirect (the movie on S3)
+  5. Offload the download to wget for efficient processing
+
+TODO
+----
+  * Finish missing spec coverage (mostly in DasCatalog toplevel namespace)
+  * Hook up Aruba for bin testing
+  * Switch bin to [GLI](https://github.com/davetron5000/gli)?
+  * CLI interface for tracking if you've watched a specific screencast
+  * Make missing directory automatically
+  * better wget detection/warnings
+  * Lighten some dependencies (feed fetching, highline, etc)
+  * Better cli access to modify the underlying pstore

data/bin/das_catalog_sync

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'highline/import'
+
+$LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'das_catalog'
+
+config_file = File.expand_path("~/.das_catalog.yml")
+
+config = if File.exists?(config_file)
+  YAML.load_file(config_file)
+else
+  {}
+end
+
+DasCatalog.configure do |c|
+  c.username = config["username"] || ask("Enter your DAS username: ") { |q| q.echo = true }
+  c.password = config["password"] || ask("Enter your DAS password: ") { |q| q.echo = "*" }
+  c.downloads_directory = config["downloads_directory"] || ask("Enter your DAS downloads directory: ") { |q| q.echo = "*" }
+end
+
+DasCatalog.sync

data/lib/das_catalog/downloader.rb

@@ -0,0 +1,18 @@
+require 'shellwords'
+
+module DasCatalog
+  # TODO spec this
+  class Downloader
+    def self.process(screencast)
+      # Mechanize was choking on large file downloads and keeps them in memory,
+      # outsource to wget
+      agent = DasCatalog.agent
+      agent.redirect_ok = false
+      result = agent.get screencast.download_link
+      url = result.header["location"]
+      url =~ /^http.+?([^\/]+\.mov)\?/
+      output_filename = $1
+      `wget --quiet #{Shellwords.escape url} -O #{DasCatalog.downloads_directory}/#{output_filename}`
+    end
+  end
+end

data/lib/das_catalog/feed.rb

@@ -0,0 +1,11 @@
+require 'feedzirra'
+
+module DasCatalog
+  class Feed
+    FEED_URL = "https://www.destroyallsoftware.com/screencasts/feed"
+
+    def self.get
+      Feedzirra::Feed.fetch_and_parse(FEED_URL)
+    end
+  end
+end

data/lib/das_catalog/screencast.rb

@@ -0,0 +1,30 @@
+module DasCatalog
+  class Screencast
+    extend Forwardable
+    include LoggerAccess
+
+    attr_reader :screencast_data
+    def_delegators :@screencast_data, :watched?, :downloaded?, :download_link
+
+    def initialize(screencast_data)
+      @screencast_data = screencast_data
+    end
+
+    def self.for_link(link)
+      new ScreencastData.for_link(link)
+    end
+
+    def to_s
+      screencast_data.link
+    end
+
+    def download
+      return false if screencast_data.downloaded?
+      log.info "Starting download of #{self}"
+      Downloader.process(self)
+      screencast_data.downloaded
+      log.info "Finished download of #{self}"
+      screencast_data.save
+    end
+  end
+end

data/lib/das_catalog/screencast_data.rb

@@ -0,0 +1,43 @@
+module DasCatalog
+  class ScreencastData
+    attr_reader :link, :watched, :downloaded
+
+    def initialize(link)
+      @link = link
+    end
+
+    def self.for_link(link)
+      Store.find(link) or new(link)
+    end
+
+    alias :id :link
+
+    def download_link
+      "#{link}/download"
+    end
+
+    def downloaded
+      @downloaded = true
+    end
+
+    def downloaded?
+      @downloaded
+    end
+
+    def watched
+      @watched = true
+    end
+
+    def unwatched
+      @watched = false
+    end
+
+    def watched?
+      @watched
+    end
+
+    def save
+      Store.store(self)
+    end
+  end
+end

data/lib/das_catalog/std_logger.rb

@@ -0,0 +1,21 @@
+require 'logger'
+require 'delegate'
+
+module DasCatalog
+  class StdLogger < DelegateClass(::Logger)
+    def initialize
+      @logger = ::Logger.new(STDOUT)
+      super(@logger)
+    end
+  end
+
+  module LoggerAccess
+    def self.included(klass)
+      klass.extend(self)
+    end
+
+    def log
+      DasCatalog.logger
+    end
+  end
+end

data/lib/das_catalog/store.rb

@@ -0,0 +1,19 @@
+require 'pstore'
+
+module DasCatalog
+  class Store
+    def self.find(id)
+      store = PStore.new(DasCatalog.tracker_file)
+      store.transaction(true) do
+        store[id]
+      end
+    end
+
+    def self.store(screencast_data)
+      store = PStore.new(DasCatalog.tracker_file)
+      store.transaction do
+        store[screencast_data.id] = screencast_data
+      end
+    end
+  end
+end

data/lib/das_catalog/version.rb

@@ -0,0 +1,3 @@
+module DasCatalog
+  VERSION = "0.0.2"
+end

data/lib/das_catalog.rb

@@ -0,0 +1,55 @@
+require 'mechanize'
+
+module DasCatalog
+  SIGN_IN_URL = "https://www.destroyallsoftware.com/screencasts/users/sign_in"
+
+  # TODO spec this
+  class << self
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :downloads_directory
+
+    attr_writer :logger
+    def logger
+      @logger ||= StdLogger.new
+    end
+
+    attr_writer :tracker_file
+    def tracker_file
+      @tracker_file ||= File.expand_path("~/.das_tracker.pstore")
+    end
+  end
+
+  def self.configure
+    yield self
+  end
+
+  # TODO spec this
+  def self.agent
+    @agent ||= begin
+      agent = Mechanize.new
+      page = agent.get SIGN_IN_URL
+      form = page.forms.first
+      form['user[email]'] = username
+      form['user[password]'] = password
+      agent.submit form
+      agent
+    end
+  end
+
+  # TODO spec this
+  def self.sync
+    feed = Feed.get
+    feed.entries.each do |entry|
+      sc = Screencast.for_link(entry.url)
+      sc.download
+    end
+  end
+end
+
+require_relative "das_catalog/downloader"
+require_relative "das_catalog/feed"
+require_relative "das_catalog/std_logger"
+require_relative "das_catalog/screencast"
+require_relative "das_catalog/screencast_data"
+require_relative "das_catalog/store"

data/spec/das_catalog_spec.rb

@@ -0,0 +1,7 @@
+require_relative "spec_helper"
+
+describe DasCatalog do
+  it "has a DasCatalog::StdLogger by default" do
+    assert DasCatalog.logger
+  end
+end

data/spec/das_downloader_spec.rb

@@ -0,0 +1,6 @@
+require_relative "spec_helper"
+
+describe DasCatalog::Downloader do
+  # TODO
+end
+

data/spec/das_feed_spec.rb

@@ -0,0 +1,8 @@
+require_relative "spec_helper"
+
+describe DasCatalog::Feed do
+  it "grabs the feed with feedzirra" do
+    Feedzirra::Feed.expects(:fetch_and_parse).with("https://www.destroyallsoftware.com/screencasts/feed")
+    DasCatalog::Feed.get
+  end
+end

data/spec/das_screencast_data_spec.rb

@@ -0,0 +1,52 @@
+require_relative "spec_helper"
+
+describe DasCatalog::ScreencastData do
+  let(:link) { "https://www.destroyallsoftware.com/screencasts/catalog/statistics-over-git-repositories" }
+  subject { DasCatalog::ScreencastData.new(link) }
+
+  it "creates a download link by appending download to the link" do
+    subject.download_link.must_equal("#{link}/download")
+  end
+
+  it "uses the link as the id" do
+    subject.id.must_equal link
+  end
+
+  it "doesn't report as downloaded if it hasn't been" do
+    refute subject.downloaded?
+  end
+
+  it "reports as downloaded if downloaded" do
+    subject.downloaded
+    assert subject.downloaded?
+  end
+
+  it "reports as watched if watched" do
+    subject.watched
+    assert subject.watched?
+  end
+
+  it "can be unwatched" do
+    subject.unwatched
+    refute subject.watched?
+  end
+
+  it "saves by passing itself to the tracker" do
+    DasCatalog::Store.expects(:store).with(subject)
+    subject.save
+  end
+
+  describe "getting the screencast data for a given link" do
+    it "creates a new screencast data if one doeesn't already exist" do
+      skip "needs new_record?"
+      scd = DasCatalog::ScreencastData.for_link(link)
+      assert scd.new_record?
+    end
+
+    it "finds the screencast data if already persisted" do
+      DasCatalog::Store.expects(:find).with(link).returns(subject)
+      DasCatalog::ScreencastData.for_link(link).must_equal(subject)
+    end
+  end
+end
+

data/spec/das_screencast_spec.rb

@@ -0,0 +1,77 @@
+require_relative "spec_helper"
+
+describe DasCatalog::Screencast do
+  let(:link) { "https://www.destroyallsoftware.com/screencasts/catalog/statistics-over-git-repositories" }
+  let(:screencast_data) { sd = mock("ScreencastData"); sd.stubs(:link).returns(link); sd }
+  subject { DasCatalog::Screencast.new(screencast_data) }
+
+  it "is created from screencast data" do
+    screencast = DasCatalog::Screencast.new(screencast_data)
+    screencast.screencast_data.must_equal(screencast_data)
+  end
+
+  it "contains screencast data" do
+    assert subject.screencast_data
+  end
+
+  it "is converting to a string that is the link" do
+    subject.to_s.must_equal link
+  end
+
+  it "can be created for a given link" do
+    screencast_data = mock()
+    DasCatalog::ScreencastData.expects(:for_link).with(link).returns(screencast_data)
+    DasCatalog::Screencast.for_link(link).screencast_data.must_equal screencast_data
+  end
+
+  it "delegates to the screencast data for watched?" do
+    screencast_data.stubs(:watched?).returns(false, true)
+    refute subject.watched?
+    assert subject.watched?
+  end
+
+  it "delegates to the screencast data for downloaded?" do
+    screencast_data.stubs(:downloaded?).returns(false, true)
+    refute subject.downloaded?
+    assert subject.downloaded?
+  end
+
+  it "delegates to the screencast data for download link" do
+    screencast_data.stubs(:download_link).returns("http://example.com/path")
+    subject.download_link.must_equal "http://example.com/path"
+  end
+
+  describe "downloading" do
+    before do
+      DasCatalog::Downloader.stubs(:process)
+      screencast_data.stubs(:save)
+      screencast_data.stubs(:downloaded?)
+      screencast_data.stubs(:downloaded)
+    end
+
+    context "for a screencast that hasn't been downloaded" do
+      it "occurs by sending itself to the downloader for processing" do
+        DasCatalog::Downloader.expects(:process).with(subject)
+        subject.download
+      end
+
+      it "marks the screencast data downloaded" do
+        screencast_data.expects(:downloaded)
+        subject.download
+      end
+
+      it "saves the screencast data" do
+        screencast_data.expects(:save)
+        subject.download
+      end
+    end
+
+    context "for a screencast that hasn't been downloaded" do
+      it "returns false" do
+        screencast_data.expects(:downloaded?).returns(true)
+        refute subject.download
+      end
+    end
+  end
+end
+

data/spec/das_std_logger_spec.rb

@@ -0,0 +1,35 @@
+require_relative "spec_helper"
+
+describe DasCatalog::StdLogger do
+  it "creates a standard ruby logger to STDOUT" do
+    ::Logger.expects(:new).with(STDOUT)
+    DasCatalog::StdLogger.new
+  end
+
+  [:fatal, :error, :warn, :info, :debug].each do |log_method|
+    it "delegates #{log_method} to the contained logger" do
+      logger = DasCatalog::StdLogger.new
+      assert_respond_to(logger, log_method)
+      
+    end
+  end
+
+  describe "the logger mixin" do
+    let(:klass) { Class.new }
+
+    before do
+      DasCatalog.logger = mock("Logger")
+      klass.send(:include, DasCatalog::LoggerAccess)
+    end
+
+    it "adds a log class method to grab the DasCatalog.logger" do
+      assert klass.respond_to?(:log)
+      klass.log.must_equal(DasCatalog.logger)
+    end
+
+    it "also adds a log instance method" do
+      assert klass.new.respond_to?(:log)
+      klass.log.must_equal(DasCatalog.logger)
+    end
+  end
+end

data/spec/das_store_spec.rb

@@ -0,0 +1,21 @@
+require_relative "spec_helper"
+
+describe DasCatalog::Store do
+  let(:link) { "https://www.destroyallsoftware.com/screencasts/catalog/statistics-over-git-repositories" }
+  let(:id) { link }
+  let(:screencast_data) { scd = mock(); scd.stubs(:id).returns(id); scd }
+
+  it "tracks in the file specified in config" do
+    DasCatalog::Store.store(screencast_data)
+    assert File.exists?(DasCatalog.tracker_file.path)
+  end
+
+  it "can find the screencast by the id" do
+    DasCatalog::Store.store(screencast_data)
+    assert DasCatalog::Store.find(id)
+  end
+
+  it "is nil if the screencast is not found" do
+    refute DasCatalog::Store.find(id)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+gem "minitest"
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'mocha'
+require 'fakefs/safe'
+require 'fileutils'
+require 'tempfile'
+require 'logger'
+
+require_relative '../lib/das_catalog'
+
+alias :context :describe
+
+null_logger = ::Logger.new("/dev/null")
+
+MiniTest::Spec.add_setup_hook do
+  DasCatalog.configure do |c|
+    c.tracker_file = Tempfile.new("das_tracker")
+    c.logger = null_logger
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: das_catalog
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: feedzirra
+  requirement: &2153475280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153475280
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: &2153473140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153473140
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &2153472680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153472680
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2153472260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153472260
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2153471700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153471700
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &2153471140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153471140
+description: Download screencasts from Destroy All Software catalog.  Uses the rss
+  feed plus Mechanize to log you in and then download new movies to your local drive.
+email: xternal1+github@gmail.com
+executables:
+- das_catalog_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/das_catalog/downloader.rb
+- lib/das_catalog/feed.rb
+- lib/das_catalog/screencast.rb
+- lib/das_catalog/screencast_data.rb
+- lib/das_catalog/std_logger.rb
+- lib/das_catalog/store.rb
+- lib/das_catalog/version.rb
+- lib/das_catalog.rb
+- bin/das_catalog_sync
+- README.md
+- LICENSE
+- spec/das_catalog_spec.rb
+- spec/das_downloader_spec.rb
+- spec/das_feed_spec.rb
+- spec/das_screencast_data_spec.rb
+- spec/das_screencast_spec.rb
+- spec/das_std_logger_spec.rb
+- spec/das_store_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Download screencasts from Destroy All Software catalog
+test_files:
+- spec/das_catalog_spec.rb
+- spec/das_downloader_spec.rb
+- spec/das_feed_spec.rb
+- spec/das_screencast_data_spec.rb
+- spec/das_screencast_spec.rb
+- spec/das_std_logger_spec.rb
+- spec/das_store_spec.rb
+- spec/spec_helper.rb