rpw 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b470a6daefa536118bc45ad650345ae904890cfdc21340f4241fe95585840ca
-  data.tar.gz: 4055764a0110865d0bd1faa4616a269c16beeceee6868ad9f1b5a8188b172f30
+  metadata.gz: 7da44e397174a310bc8ba3ed4c2ecb28f2811cf30275a2cb7cd3ec85029ab99a
+  data.tar.gz: c096b4539f5570d6994eed51ec758007e08f75632e0e26f7d13e15b531633995
 SHA512:
-  metadata.gz: 797f1c5528477c5befc5bed08a2dba98aabf2968be757a682a5f5dda81ae9815bbfa572f4974504eecb478a7bf106abef1562945f3865f09a8429badf68f61b4
-  data.tar.gz: a948446a6b948793d63dad89880c1e958f21532eaa278b9e232248a2b298a59c8b103e21c4f0ec537fb003d066abf79da56d8d3e97fde3aad49c9c99fbfaf7f3
+  metadata.gz: 3557e0688d5141ae96bcfed87ced6539059bbbd0517a3f2bf85910c5b13b99e153d940fbf56d9bd86bf2cf23525f32a9c848d7fa3ee2d58ae664db806854e93b
+  data.tar.gz: 0e804e064e64cd66c703238e00d80f75a35871bf724c08203594d4eec1c94db5815d5ac2bacc11b743e008eb1aeec2c39f2b240fefac87aebe2c005bb194ae19

data/.gitignore

@@ -1,2 +1,5 @@
 bundle
-*.gem
+*.gem
+.rpw_key
+.rpw_info
+smoketest

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.1)
+    rpw (0.0.2)
       thor
       typhoeus
 

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 0.0.2
+
+* first command-complete version
+
 ## 0.0.1
 
 * setup command works

data/exe/rpw

@@ -4,56 +4,131 @@ require "thor"
 require_relative "../lib/rpw"
 
 module RPW
-  class CLI < Thor
-    class_option :verbose, type: :boolean, aliases: "-v"
+  class SubCommandBase < Thor
+    def self.banner(command, namespace = nil, subcommand = false)
+      "#{basename} #{subcommand_prefix} #{command.usage}"
+    end
 
-    desc "next", "Proceed to the next section of the workshop"
+    def self.subcommand_prefix
+      name.gsub(%r{.*::}, "").gsub(%r{^[A-Z]}) { |match| match[0].downcase }.gsub(%r{[A-Z]}) { |match| "-#{match[0].downcase}" }
+    end
+  end
+
+  class Lesson < SubCommandBase
+    desc "next", "Proceed to the next lesson of the workshop"
 
     def next
-      # ...
+      say "Proceeding to next lesson..."
+      client.next
     end
 
-    desc "setup", "Set up your purchase key in order to download workshop sections"
+    desc "complete", "Mark the current lesson as complete"
 
-    def setup
-      say "We'll create a .rpw_key file in the current directory to save your key for future use."
-      key = ask("Purchase Key: ")
+    def complete
+      say "Marked current lesson as complete"
+      client.complete
+    end
 
-      client.setup(key)
+    desc "list", "Show all available workshop lessons"
 
-      say "Successfully authenticated with the RPW server and saved your key."
+    def list
+      say "All available workshop lessons:"
+      client.list.each do |lesson|
+        puts "#{"  " * lesson["indent"]}[#{lesson["position"]}]: #{lesson["title"]}"
+      end
     end
 
-    desc "status", "Show your current workshop progression"
+    desc "download [CONTENT | all]", "Download one or all workshop contents"
 
-    def status
-      # ...
+    def download(content)
+      client.download(content)
     end
 
-    desc "support", "Create a new support ticket, report a bug or issue"
+    desc "show [CONTENT]", "Show any workshop lesson"
 
-    def support
+    def show(content)
+      client.show(content)
     end
 
-    desc "show CONTENT", "Show any workshop section (use list to see all section names)"
+    private
 
-    def show(content)
+    def client
+      @client ||= RPW::Client.new
     end
+  end
 
-    desc "list", "Show all available workshop content"
+  class Progress < SubCommandBase
+    desc "set [LESSON]", "Set current lesson to a particular lesson"
 
-    def list
+    def set(lesson)
+      client.set_progress(lesson)
     end
 
-    desc "download [CONTENT | all]", "Download one or all workshop contents"
+    desc "reset", "Erase all progress and start over"
 
-    def download(content)
+    def reset
+      yes? "Are you sure you want to reset your progress? (Y/N)"
+      client.reset_progress
+    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"]}"
+      say "Progress by Section (X == completed, O == current):"
+      data[:sections].each do |section|
+        say "#{section[:title]}: #{section[:progress]}"
+      end
+    end
+
+    private
+
+    def client
+      @client ||= RPW::Client.new
+    end
+
+    default_task :show
+  end
+
+  class CLI < Thor
+    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 "setup", "Set up purchase key and directories"
+
+    def setup
+      return unless yes? "We're going to (idempotently!) create a few files and directories in the current working directory. Is that OK? (Y/N)"
+
+      say "We'll create a .rpw_key file in the current directory to save your purchase key and course data."
+      key = ask("Your Purchase Key: ")
+
+      client.setup(key)
+
+      say "Successfully authenticated with the RPW server and saved your key."
+      say "We'll also create a few directories for your course data and progress."
+
+      client.directory_setup
+
+      say "Setup complete!"
+    end
+
+    desc "support", "Create a new support ticket, report a bug or issue"
+
+    def support
     end
 
-    private 
+    private
 
     def client
-      @client ||= RPW::Client.new 
+      @client ||= RPW::Client.new
     end
   end
 end

data/lib/rpw.rb

@@ -1,63 +1,289 @@
 require "typhoeus"
-require "base64"
+require "json"
 
 module RPW
+  class Error < StandardError; end
+
   class Gateway
-    attr_accessor :domain 
+    attr_accessor :domain
 
-    def initialize(domain)
+    def initialize(domain, key)
       @domain = domain
+      @key = key
     end
 
     class Error < StandardError; end
 
     def authenticate_key(key)
-      request = Typhoeus::Request.new(
-        domain + "/license",
-        method: :get,
-        headers: { Authorization: "Basic #{Base64.encode64(key + ':')}" }
-      )
-      
-      request.on_complete do |response|
-        if response.success?
-          true
-        else
-          raise Error, "Server responded: #{response.code} #{response.response_body}"
-        end
+      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
 
-      request.run
+    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 get_resource(resource)
+    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(10) == 0 # lol
+      end
+      request.on_complete { |response| downloaded_file.close }
+      request
     end
   end
 
   class Client
-    DOTFILE_NAME = ".rpw_key"
-    RPW_SERVER_DOMAIN = "https://rpw-licensor.speedshop.co"
-
-    class Error < StandardError; end
+    RPW_SERVER_DOMAIN = ENV["RPW_SERVER_DOMAIN"] || "https://rpw-licensor.speedshop.co"
 
     def setup(key)
-      # authenticate against server
       gateway.authenticate_key(key)
+      keyfile["key"] = key
+    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
+      content = next_content
+      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)
+    end
+
+    def complete
+      client_data["completed"] ||= []
+      client_data["completed"] += [client_data["current_lesson"]]
+    end
+
+    def list
+      gateway.list_content
+    end
+
+    def show(content_pos)
+      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)
+    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(contents)
+      }
+    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
+
+    private
 
-      # write authenticated key
+    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 keyfile
+      @keyfile ||= Keyfile.new
+    end
+
+    def gateway
+      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN, keyfile["key"])
+    end
+
+    def extract_content(content)
+      folder = content["style"]
+      `tar -C #{folder} -xvzf #{folder}/#{content["s3_key"]}`
+    end
+
+    def display_content(content)
+      case content["style"]
+      when "video"
+        puts "Opening video: #{content["title"]}"
+        exec("open video/#{content["s3_key"]}")
+      when "quiz"
+        Quiz.start(["give_quiz", "quiz/" + content["s3_key"]])
+      when "lab"
+        # extract and rm archive
+        puts "Lab downloaded to lab/#{content["s3_key"]}, navigate there and look at the README to continue"
+      when "text"
+        puts "Opening in your editor: #{content["title"]}"
+        exec("$EDITOR text/#{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
+    end
+  end
+
+  require "fileutils"
+  require "yaml"
+
+  class ClientData
+    DOTFILE_NAME = ".rpw_info"
+
+    def [](key)
+      make_sure_dotfile_exists
+      data[key]
+    end
+
+    def []=(key, value)
+      data[key] = value
+      begin
+        File.open(self.class::DOTFILE_NAME, "w") { |f| f.write(YAML.dump(data)) }
+      rescue
+        raise Error, "The RPW data file in this directory is not writable. \
+                      Check your file permissions."
+      end
+    end
+
+    private
+
+    def data
+      @data ||= begin
+        yaml = begin
+          YAML.safe_load(File.read(self.class::DOTFILE_NAME))
+        rescue
+          nil
+        end
+        yaml || {}
+      end
+    end
+
+    def make_sure_dotfile_exists
+      return true if File.exist?(self.class::DOTFILE_NAME)
       begin
-        File.open(DOTFILE_NAME, "w") { |f| f.write(key) }
+        FileUtils.touch(self.class::DOTFILE_NAME)
       rescue
-        raise Error.new "Could not create dotfile in this directory \
-                         to save your key. Check your file permissions."
+        raise Error, "Could not create the RPW data file in this directory \
+                      Check your file permissions."
       end
+    end
+  end
+
+  class Keyfile < ClientData
+    DOTFILE_NAME = ".rpw_key"
+  end
+
+  require "digest"
 
-      key
+  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 gateway
-      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN)
+    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)
+      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
     end
   end
 end

data/lib/rpw/version.rb

@@ -1,3 +1,3 @@
-module RPW 
-  VERSION = "0.0.1"
-end
+module RPW
+  VERSION = "0.0.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nate Berkopec
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor