rpw 0.0.2 → 1.0.0

data/lib/rpw/README.md

@@ -0,0 +1,58 @@
+## Installation Requirements
+
+This client assumes you're using Ruby 2.3 or later.
+
+This client assumes you have `tar` installed and available on your PATH.
+
+The way that the client opens files (using `open` or `xdg-open` depending on platform) assumes you have your default program for the following filetypes set correctly:
+
+* .md for Markdown (XCode by default on Mac: you probably want to change that!)
+* .mp4 for videos
+
+## Slack Invite 
+
+If you purchased the Workshop yourself, you will receive a Slack channel invitation
+shortly. If you are attending the Workshop as part of a group and your license key
+was provided to you, you need to register your key to get an invite:
+
+```
+$ rpw key register [YOUR_EMAIL_ADDRESS]
+```
+
+Please note you can only register your key once.
+
+The Slack channel is your best resource for questions about Rails Performance
+or other material in the workshop. Nate is almost always monitoring that channel.
+
+If you encounter a **bug or other software problem**, please email support@speedshop.co.
+
+## Important Commands
+
+Here are some important commands for you to know:
+
+```
+$ rpw lesson next     | Proceed to the next part of the workshop.
+$ rpw lesson complete | Mark current lesson as complete.
+$ rpw lesson list     | List all workshop lessons. Note each lesson is preceded with an ID.
+$ rpw lesson download | Download any or all lessons. Use the IDs from "list".
+$ rpw lesson show     | Show any particular workshop lesson. Use the IDs from "list".
+$ rpw progress        | Show where you're currently at in the workshop.
+```
+
+Generally, you'll just be doing a lot of `$ rpw lesson next`!
+
+By default, `$ rpw lesson next` will try to open the content it downloads. If you 
+either don't like this, or for some reason it doesn't work, use `$ rpw lesson next --no-open`.
+
+## Working Offline 
+
+By default, the course will download each piece of content as you progress through 
+the course. However, you can use `rpw lesson download all` to download all content
+at once, and complete the workshop entirely offline.
+
+Videos in this workshop are generally about 100MB each, which means the entire
+course is about a 3 to 4GB download.
+
+## Bugs and Support
+
+If you encounter any problems, please email support@speedshop.co for the fastest possible response.

data/lib/rpw/cli.rb

@@ -0,0 +1,94 @@
+require "thor"
+require "thor/hollaback"
+require "rpw"
+require "rpw/cli/bannerlord"
+require "rpw/cli/sub_command_base"
+require "rpw/cli/key"
+require "rpw/cli/lesson"
+require "rpw/cli/progress"
+
+module RPW
+  class CLI < Thor
+    class_before :check_version
+    class_before :check_setup
+
+    desc "key register [EMAIL_ADDRESS]", "Change email registered w/Speedshop"
+    subcommand "key", Key
+    desc "lesson [SUBCOMMAND]", "View and download lessons"
+    subcommand "lesson", Lesson
+    desc "progress [SUBCOMMAND]", "View and set progress"
+    subcommand "progress", Progress
+
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "start", "Tutorial and onboarding"
+    def start
+      warn_if_already_started
+
+      print_banner
+      say "Welcome to the Rails Performance Workshop."
+      say ""
+      say "This is rpw, the command line client for this workshop."
+      say ""
+      say "This client will download files from the internet into the current"
+      say "working directory, so it's best to run this client from a new directory"
+      say "that you'll use as your 'scratch space' for working on the Workshop."
+      say ""
+      say "We will create a handful of new files and folders in the current directory."
+      return unless yes? "Is this OK? (y/N) (N will quit)"
+      puts ""
+      say "We'll also create a .rpw_info file at #{File.expand_path("~/.rpw")} to save your purchase key."
+      home_dir_ok = yes?("Is this OK? (y/N) (N will create it in the current directory)")
+      client.directory_setup(home_dir_ok)
+
+      key = ask("Your Purchase Key: ")
+
+      unless client.setup(key)
+        say "That is not a valid key. Please try again."
+        exit(0)
+      end
+
+      puts ""
+      say "Successfully authenticated with the RPW server and saved your key."
+      puts ""
+      say "Setup complete!"
+      puts ""
+      say "To learn how to use this command-line client, consult ./README.md, which we just created."
+      say "Once you've read that and you're ready to get going: $ rpw lesson next"
+    end
+
+    no_commands do
+      def print_banner
+        RPW::Bannerlord.print_banner
+      end
+    end
+
+    private
+
+    def client
+      @client ||= RPW::Client.new
+    end
+
+    def warn_if_already_started
+      return unless client.setup?
+      exit(0) unless yes? "You have already started the workshop. Continuing "\
+        "this command will wipe all of your current progress. Continue? (y/N)"
+    end
+
+    def check_version
+      unless client.latest_version?
+        say "WARNING: You are running an old version of rpw."
+        say "WARNING: Please run `$ gem install rpw`"
+      end
+    end
+
+    def check_setup
+      unless client.setup? || current_command_chain == [:start]
+        say "WARNING: You do not have a purchase key set. Run `$ rpw start`"
+        exit(0)
+      end
+    end
+  end
+end

data/lib/rpw/cli/bannerlord.rb

@@ -0,0 +1,59 @@
+module RPW
+  class Bannerlord
+    class << self
+      def print_banner
+        puts r
+        if `tput cols 80`.to_i < 80
+          puts small_banner
+        else
+          puts banner
+        end
+        puts reset
+      end
+
+      def r
+        "\e[31m"
+      end
+
+      def reset
+        "\e[0m"
+      end
+
+      def small_banner
+        %(
+       _____ _          _____     _ _
+      |_   _| |_ ___   | __  |___|_| |___
+        | | |   | -_|  |    -| .'| | |_ -|
+        |_| |_|_|___|  |__|__|__,|_|_|___|
+       _____         ___
+      |  _  |___ ___|  _|___ ___ _____ ___ ___ ___ ___
+      |   __| -_|  _|  _| . |  _|     | .'|   |  _| -_|
+      |__|  |___|_| |_| |___|_| |_|_|_|__,|_|_|___|___|
+       _ _ _         _       _
+      | | | |___ ___| |_ ___| |_ ___ ___
+      | | | | . |  _| '_|_ -|   | . | . |
+      |_____|___|_| |_,_|___|_|_|___|  _|
+                                    |_|
+          #{reset})
+      end
+
+      def banner
+        %(
+                                 _____ _          _____     _ _
+      +hmNMMMMMm/`  -ymMMNh/    |_   _| |_ ___   | __  |___|_| |___
+      sMMMMMMMMMy   +MMMMMMMMy    | | |   | -_|  |    -| .'| | |_ -|
+      yMMMMMMMMMMy` yMMMMMMMMN    |_| |_|_|___|  |__|__|__,|_|_|___|
+       `dMMMMMMMMMMm:-dMMMMMMm:   _____         ___
+        `sNMMMMMMMMMMs.:+sso:`   |  _  |___ ___|  _|___ ___ _____ ___ ___ ___ ___
+          :dMMMMMMMMMMm/         |   __| -_|  _|  _| . |  _|     | .'|   |  _| -_|
+      :oss+:.sNMMMMMMMMMMy`      |__|  |___|_| |_| |___|_| |_|_|_|__,|_|_|___|___|
+     /mMMMMMMd-:mMMMMMMMMMMd.     _ _ _         _       _
+     NMMMMMMMMy `hMMMMMMMMMMh    | | | |___ ___| |_ ___| |_ ___ ___
+     yMMMMMMMM+  `dMMMMMMMMMy    | | | | . |  _| '_|_ -|   | . | . |
+     /hNMMmy-  `/mMMMMMNmy/      |_____|___|_| |_,_|___|_|_|___|  _|
+                                                               |_|
+          #{reset})
+      end
+    end
+  end
+end

data/lib/rpw/cli/key.rb

@@ -0,0 +1,15 @@
+module RPW
+  class Key < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "register [EMAIL_ADDRESS]", "Change email registered with Speedshop. One-time only."
+    def register(email)
+      if client.register_email(email)
+        say "Key registered with #{email}. You should receive a Slack invite soon."
+      else
+        say "Key has already been registered. If you believe this is in error,"\
+          " please email support@speedshop.co"
+      end
+    end
+  end
+end

data/lib/rpw/cli/lesson.rb

@@ -0,0 +1,101 @@
+module RPW
+  class Lesson < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "next", "Proceed to the next lesson of the workshop"
+    option :"no-open"
+    def next
+      say "Proceeding to next lesson..."
+      content = client.next
+
+      if content.nil?
+        RPW::CLI.new.print_banner
+        say "Congratulations!"
+        say "You have completed the Rails Performance Workshop."
+        exit(0)
+      end
+
+      client.download_and_extract(content)
+      client.complete(content["position"])
+      display_content(content, !options[:"no-open"])
+    end
+
+    desc "complete", "Mark the current lesson as complete"
+    def complete
+      say "Marked current lesson as complete"
+      client.complete(nil)
+    end
+
+    desc "list", "Show all available workshop lessons"
+    def list
+      say "All available workshop lessons:"
+      say "Use [ID] for the show/download command"
+      say "[ID]: Lesson Name"
+      client.list.each do |lesson|
+        puts "[#{lesson["position"]}]:#{"  " * lesson["indent"]} #{lesson["title"]}"
+      end
+    end
+
+    desc "download [CONTENT | all]", "Download one or all workshop contents"
+    def download(content_pos)
+      to_download = if content_pos.downcase == "all"
+        client.list
+      else
+        [client.show(content_pos)]
+      end
+      to_download.each { |content| client.download_and_extract(content) }
+    end
+
+    desc "show [CONTENT]", "Show any workshop lesson, shows current lesson w/no arguments"
+    option :"no-open"
+    def show(content_order = :current)
+      content = client.show(content_order)
+      client.download_and_extract(content)
+      display_content(content, !options[:"no-open"])
+    end
+
+    private
+
+    def display_content(content, open_after)
+      say "Current Lesson: #{content["title"]}"
+      openable = false
+      case content["style"]
+      when "video"
+        location = "video/#{content["s3_key"]}"
+        openable = true
+      when "quiz"
+        Quiz.start(["give_quiz", "quiz/" + content["s3_key"]])
+      when "lab"
+        location = "lab/#{content["s3_key"][0..-8]}"
+        openable = true
+      when "text"
+        location = "text/#{content["s3_key"]}"
+        openable = true
+      when "cgrp"
+        say "The Complete Guide to Rails Performance has been downloaded and extracted to the ./cgrp directory."
+        say "All source code for the CGRP is in the src directory, PDF and other compiled formats are in the release directory."
+        say "You can check it out now, or to continue: $ rpw lesson next "
+      end
+      if location
+        if openable && !open_after
+          say "Download complete. Open with: $ #{open_command} #{location}"
+        elsif open_after && openable
+          exec "#{open_command} #{location}"
+        end
+      end
+    end
+
+    require "rbconfig"
+    def open_command
+      host_os = RbConfig::CONFIG["host_os"]
+      case host_os
+      when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+        "start"
+      when /darwin|mac os/
+        "open"
+      else
+        "xdg-open"
+      end
+    end
+  end
+end

data/lib/rpw/cli/progress.rb

@@ -0,0 +1,34 @@
+module RPW
+  class Progress < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "set [LESSON]", "Set current lesson to a particular lesson"
+    def set(pos)
+      lesson = client.set_progress(pos.to_i)
+      say "Set current progress to #{lesson["title"]}"
+    end
+
+    desc "reset", "Erase all progress and start over"
+    def reset
+      return unless yes? "Are you sure you want to reset your progress? (Y/N)"
+      say "Resetting progress."
+      client.set_progress(nil)
+    end
+
+    desc "show", "Show current workshop progress"
+    def show
+      data = client.progress
+      say "The Rails Performance Workshop"
+      say "You have completed #{data[:completed]} out of #{data[:total]} total sections."
+      say "Current lesson: #{data[:current_lesson]["title"]}" if data[:current_lesson]
+      say "Progress by Section (X == completed, O == current):"
+      data[:sections].each do |section|
+        say "#{section[:title]}: #{section[:progress]}"
+      end
+    end
+
+    private
+
+    default_task :show
+  end
+end

data/lib/rpw/cli/quiz.rb

@@ -0,0 +1,28 @@
+require "digest"
+require "thor"
+
+module RPW
+  class Quiz < Thor
+    desc "give_quiz FILENAME", ""
+    def give_quiz(filename)
+      @quiz_data = YAML.safe_load(File.read(filename))
+      @quiz_data["questions"].each { |q| question(q) }
+    end
+
+    private
+
+    def question(data)
+      puts data["prompt"]
+      data["answer_choices"].each { |ac| puts ac }
+      provided_answer = ask("Your answer?")
+      answer_digest = Digest::MD5.hexdigest(data["prompt"] + provided_answer.upcase)
+      if answer_digest == data["answer_digest"]
+        say "Correct!"
+      else
+        say "Incorrect."
+        say "I encourage you to try reviewing the material to see what the correct answer is."
+      end
+      say ""
+    end
+  end
+end

data/lib/rpw/cli/sub_command_base.rb

@@ -0,0 +1,30 @@
+module RPW
+  class SubCommandBase < Thor
+    def self.banner(command, namespace = nil, subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
+
+    def self.subcommand_prefix
+      name.gsub(%r{.*::}, "").gsub(%r{^[A-Z]}) { |match| match[0].downcase }
+        .gsub(%r{[A-Z]}) { |match| "-#{match[0].downcase}" }
+    end
+
+    no_commands do
+      def client
+        @client ||= RPW::Client.new
+      end
+
+      def exit_with_no_key
+        unless client.setup?
+          say "You have not yet set up the client. Run $ rpw start"
+          exit(1)
+        end
+        unless client.directories_ready?
+          say "You are not in your workshop scratch directory, or you have not yet"
+          say "set up the client. Change directory or run $ rpw start"
+          exit(1)
+        end
+      end
+    end
+  end
+end

data/lib/rpw/client.rb

@@ -0,0 +1,174 @@
+require "fileutils"
+require "rpw/cli/quiz"
+
+module RPW
+  class Client
+    RPW_SERVER_DOMAIN = ENV["RPW_SERVER_DOMAIN"] || "https://rpw-licensor.speedshop.co"
+    attr_reader :gateway
+
+    def initialize(gateway = nil)
+      @gateway = gateway || Gateway.new(RPW_SERVER_DOMAIN, client_data["key"])
+    end
+
+    def setup(key)
+      success = gateway.authenticate_key(key)
+      client_data["key"] = key if success
+      success
+    end
+
+    def register_email(email)
+      gateway.register_email(email)
+    end
+
+    def next
+      return list.first unless client_data["completed"]
+      list.sort_by { |c| c["position"] }.find { |c| c["position"] > current_position }
+    end
+
+    def list
+      @list ||= begin
+        if client_data["content_cache_generated"] &&
+            client_data["content_cache_generated"] >= Time.now - 60 * 60
+
+          client_data["content_cache"]
+        else
+          begin
+            client_data["content_cache"] = gateway.list_content
+            client_data["content_cache_generated"] = Time.now
+            client_data["content_cache"]
+          rescue
+            client_data["content_cache"] || (raise Error.new("No internet connection"))
+          end
+        end
+      end
+    end
+
+    def show(content_pos)
+      content_pos = current_position if content_pos == :current
+      gateway.get_content_by_position(content_pos)
+    end
+
+    def directory_setup(home_dir_ok = true)
+      ["video", "quiz", "lab", "text", "cgrp"].each do |path|
+        FileUtils.mkdir_p(path) unless File.directory?(path)
+      end
+
+      if home_dir_ok
+        ClientData.create_in_home!
+      else
+        ClientData.create_in_pwd!
+      end
+
+      unless File.exist?(".gitignore") && File.read(".gitignore").match(/rpw_info/)
+        File.open(".gitignore", "a") do |f|
+          f.puts "\n"
+          f.puts ".rpw_info\n"
+          f.puts "video\n"
+          f.puts "quiz\n"
+          f.puts "lab\n"
+          f.puts "text\n"
+          f.puts "cgrp\n"
+        end
+      end
+
+      File.open("README.md", "w+") do |f|
+        f.puts File.read(File.join(File.dirname(__FILE__), "README.md"))
+      end
+    end
+
+    def progress
+      completed_lessons = client_data["completed"] || []
+      {
+        completed: completed_lessons.size,
+        total: list.size,
+        current_lesson: list.find { |c| c["position"] == current_position },
+        sections: chart_section_progress(list, completed_lessons)
+      }
+    end
+
+    def set_progress(pos)
+      client_data["completed"] = [] && return if pos.nil?
+      lesson = list.find { |l| l["position"] == pos }
+      raise Error.new("No such lesson - use the IDs in $ rpw lesson list") unless lesson
+      client_data["completed"] += [pos]
+      lesson
+    end
+
+    def latest_version?
+      return true unless ClientData.exists?
+      return true if client_data["last_version_check"] &&
+        client_data["last_version_check"] >= Time.now - (60 * 60)
+
+      begin
+        latest = gateway.latest_version?
+      rescue
+        return true
+      end
+
+      client_data["last_version_check"] = if latest
+        Time.now
+      else
+        false
+      end
+    end
+
+    def setup?
+      return false unless ClientData.exists?
+      client_data["key"]
+    end
+
+    def directories_ready?
+      ["video", "quiz", "lab", "text", "cgrp"].all? do |path|
+        File.directory?(path)
+      end
+    end
+
+    def download_and_extract(content)
+      location = content["style"] + "/" + content["s3_key"]
+      unless File.exist?(location)
+        gateway.download_content(content, folder: content["style"])
+        extract_content(content) if content["s3_key"].end_with?(".tar.gz")
+      end
+    end
+
+    def complete(position)
+      reset_progress unless client_data["completed"]
+      # we actually have to put the _next_ lesson on the completed stack
+      set_progress(self.next["position"])
+    end
+
+    private
+
+    def current_position
+      @current_position ||= client_data["completed"]&.last || 0
+    end
+
+    def chart_section_progress(contents, completed)
+      contents.group_by { |c| c["position"] / 100 }
+        .each_with_object([]) do |(_, c), memo|
+          completed_str = c.map { |l|
+            if l["position"] == current_position
+              "O"
+            elsif completed.include?(l["position"])
+              "X"
+            else
+              "."
+            end
+          }.join
+          memo << {
+            title: c[0]["title"],
+            progress: completed_str
+          }
+        end
+    end
+
+    def client_data
+      @client_data ||= ClientData.new
+    end
+
+    def extract_content(content)
+      folder = content["style"]
+      `tar -C #{folder} -xvzf #{folder}/#{content["s3_key"]}`
+    end
+  end
+end