rpw 0.0.3 → 1.0.1

data/lib/rpw.rb

@@ -1,378 +1,8 @@
-require "typhoeus"
-require "json"
-require_relative "rpw/version"
+require "rpw/version"
+require "rpw/client"
+require "rpw/client_data"
+require "rpw/gateway"
 
 module RPW
   class Error < StandardError; end
-
-  class Gateway
-    attr_accessor :domain
-
-    def initialize(domain, key)
-      @domain = domain
-      @key = key
-    end
-
-    class Error < StandardError; end
-
-    def authenticate_key(key)
-      Typhoeus.get(domain + "/license", userpwd: key + ":").success?
-    end
-
-    def get_content_by_position(position)
-      response = Typhoeus.get(domain + "/contents/positional?position=#{position}", userpwd: @key + ":")
-      if response.success?
-        JSON.parse(response.body)
-      else
-        puts response.inspect
-        raise Error, "There was a problem fetching this content."
-      end
-    end
-
-    def list_content
-      response = Typhoeus.get(domain + "/contents", userpwd: @key + ":")
-      if response.success?
-        JSON.parse(response.body)
-      else
-        puts response.inspect
-        raise Error, "There was a problem fetching this content."
-      end
-    end
-
-    def download_content(content, folder:)
-      puts "Downloading #{content["title"]}..."
-      downloaded_file = File.open("#{folder}/#{content["s3_key"]}", "w")
-      request = Typhoeus::Request.new(content["url"])
-      request.on_body do |chunk|
-        downloaded_file.write(chunk)
-        printf(".") if rand(500) == 0 # lol
-      end
-      request.on_complete { |response| downloaded_file.close }
-      request
-    end
-
-    def latest_version?
-      resp = Typhoeus.get("https://rubygems.org/api/v1/gems/rpw.json")
-      data = JSON.parse resp.body
-      Gem::Version.new(RPW::VERSION) >= Gem::Version.new(data["version"])
-    end
-
-    def register_email(email)
-      Typhoeus.put(domain + "/license", params: {email: email, key: @key})
-    end
-  end
-
-  class Client
-    RPW_SERVER_DOMAIN = ENV["RPW_SERVER_DOMAIN"] || "https://rpw-licensor.speedshop.co"
-
-    def setup(key)
-      gateway.authenticate_key(key)
-      client_data["key"] = key
-    end
-
-    def register_email(email)
-      gateway.register_email(email)
-    end
-
-    def directory_setup
-      ["video", "quiz", "lab", "text", "cgrp"].each do |path|
-        FileUtils.mkdir_p(path) unless File.directory?(path)
-      end
-
-      client_data["completed"] = [] # just to write the file
-
-      unless File.exist?(".gitignore") && File.read(".gitignore").match(/rpw_key/)
-        File.open(".gitignore", "a") do |f|
-          f.puts "\n"
-          f.puts ".rpw_key\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
-    end
-
-    def next(open_after = false)
-      complete
-      content = next_content
-      if content.nil?
-        finished_workshop
-        return
-      end
-
-      unless File.exist?(content["style"] + "/" + content["s3_key"])
-        gateway.download_content(content, folder: content["style"]).run
-        extract_content(content) if content["s3_key"].end_with?(".tar.gz")
-      end
-      client_data["current_lesson"] = content["position"]
-      display_content(content, open_after)
-    end
-
-    def complete
-      reset_progress unless client_data["current_lesson"] && client_data["completed"]
-      client_data["completed"] ||= []
-      client_data["completed"] += [client_data["current_lesson"] || 0]
-    end
-
-    def list
-      gateway.list_content
-    end
-
-    def show(content_pos, open_after = false)
-      content_pos = client_data["current_lesson"] if content_pos == :current
-      content = gateway.get_content_by_position(content_pos)
-      unless File.exist?(content["style"] + "/" + content["s3_key"])
-        gateway.download_content(content, folder: content["style"]).run
-        extract_content(content) if content["s3_key"].end_with?(".tar.gz")
-      end
-      client_data["current_lesson"] = content["position"]
-      display_content(content, open_after)
-    end
-
-    def download(content_pos)
-      if content_pos.downcase == "all"
-        to_download = gateway.list_content
-        hydra = Typhoeus::Hydra.new(max_concurrency: 5)
-        to_download.each do |content|
-          unless File.exist?(content["style"] + "/" + content["s3_key"])
-            hydra.queue gateway.download_content(content, folder: content["style"])
-          end
-        end
-        hydra.run
-        to_download.each { |content| extract_content(content) if content["s3_key"].end_with?(".tar.gz") }
-      else
-        content = gateway.get_content_by_position(content_pos)
-        unless File.exist?(content["style"] + "/" + content["s3_key"])
-          gateway.download_content(content, folder: content["style"]).run
-          extract_content(content) if content["s3_key"].end_with?(".tar.gz")
-        end
-      end
-    end
-
-    def progress
-      contents = gateway.list_content
-      {
-        completed: client_data["completed"].size,
-        total: contents.size,
-        current_lesson: contents.find { |c| c["position"] == client_data["current_lesson"] },
-        sections: chart_section_progress(contentsi)
-      }
-    end
-
-    def set_progress(lesson)
-      client_data["current_lesson"] = lesson.to_i
-    end
-
-    def reset_progress
-      client_data["current_lesson"] = 0
-      client_data["completed"] = []
-    end
-
-    def latest_version?
-      if client_data["last_version_check"]
-        return true if client_data["last_version_check"] >= Time.now - (60 * 60 * 24)
-        return false if client_data["last_version_check"] == false
-      end
-
-      begin
-        latest = gateway.latest_version?
-      rescue
-        return true
-      end
-
-      client_data["last_version_check"] = if latest
-        Time.now
-      else
-        false
-      end
-    end
-
-    def setup?
-      client_data["key"]
-    end
-
-    private
-
-    def finished_workshop
-      RPW::CLI.new.print_banner
-      puts "Congratulations!"
-      puts "You have completed the Rails Performance Workshop."
-    end
-
-    def chart_section_progress(contents)
-      contents.group_by { |c| c["position"] / 100 }
-        .each_with_object([]) do |(_, c), memo|
-          completed_str = c.map { |l|
-            if l["position"] == client_data["current_lesson"]
-              "O"
-            elsif client_data["completed"].include?(l["position"])
-              "X"
-            else
-              "."
-            end
-          }.join
-          memo << {
-            title: c[0]["title"],
-            progress: completed_str
-          }
-        end
-    end
-
-    def next_content
-      contents = gateway.list_content
-      return contents.first unless client_data["completed"]
-      contents.delete_if { |c| client_data["completed"].include? c["position"] }
-      contents.min_by { |c| c["position"] }
-    end
-
-    def client_data
-      @client_data ||= ClientData.new
-    end
-
-    def gateway
-      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN, client_data["key"])
-    end
-
-    def extract_content(content)
-      folder = content["style"]
-      `tar -C #{folder} -xvzf #{folder}/#{content["s3_key"]}`
-    end
-
-    def display_content(content, open_after)
-      puts "\nCurrent Lesson: #{content["title"]}"
-      case content["style"]
-      when "video"
-        location = "video/#{content["s3_key"]}"
-      when "quiz"
-        Quiz.start(["give_quiz", "quiz/" + content["s3_key"]])
-      when "lab"
-        location = "lab/#{content["s3_key"]}"
-      when "text"
-        location = "lab/#{content["s3_key"]}"
-      when "cgrp"
-        puts "The Complete Guide to Rails Performance has been downloaded and extracted to the ./cgrp directory."
-        puts "All source code for the CGRP is in the src directory, PDF and other compiled formats are in the release directory."
-      end
-      if location
-        puts "Downloaded to:"
-        puts location.to_s
-        if open_after
-          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
-
-  require "fileutils"
-  require "yaml"
-
-  class ClientData
-    DOTFILE_NAME = ".rpw_info"
-
-    def initialize
-      make_sure_dotfile_exists
-      data # access file to load
-    end
-
-    def [](key)
-      data[key]
-    end
-
-    def []=(key, value)
-      data
-      data[key] = value
-
-      begin
-        File.open(filestore_location, "w") { |f| f.write(YAML.dump(data)) }
-      rescue
-        raise Error, "The RPW data at #{filestore_location} is not writable. \
-                      Check your file permissions."
-      end
-    end
-
-    def self.delete_filestore
-      return unless File.exist?(filestore_location)
-      FileUtils.remove(filestore_location)
-    end
-
-    def self.filestore_location
-      if File.exist?(File.expand_path("./" + self::DOTFILE_NAME))
-        File.expand_path("./" + + self::DOTFILE_NAME)
-      else
-        File.expand_path("~/.rpw/" + self::DOTFILE_NAME)
-      end
-    end
-
-    private
-
-    def filestore_location
-      self.class.filestore_location
-    end
-
-    def create_client_data_directory(path)
-      dirname = File.dirname(path)
-      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
-    end
-
-    def data
-      @data ||= begin
-        yaml = YAML.safe_load(File.read(filestore_location), permitted_classes: [Time])
-        yaml || {}
-      end
-    end
-
-    def make_sure_dotfile_exists
-      return true if File.exist?(filestore_location)
-      create_client_data_directory(filestore_location)
-      begin
-        FileUtils.touch(filestore_location)
-      rescue
-        raise Error, "Could not create the RPW data file at ~/.rpw/ \
-                      Check your file permissions."
-      end
-    end
-  end
-
-  require "digest"
-  require "thor"
-
-  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/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