rpw 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da44e397174a310bc8ba3ed4c2ecb28f2811cf30275a2cb7cd3ec85029ab99a
-  data.tar.gz: c096b4539f5570d6994eed51ec758007e08f75632e0e26f7d13e15b531633995
+  metadata.gz: '05387043187fc7a9e95503872a907814efe4bf14cd20d42420a0754b6792b8be'
+  data.tar.gz: df48bbf5d6cdb4c9c23d26bdaa647692271abe5a51aa262c930288195b1ebd88
 SHA512:
-  metadata.gz: 3557e0688d5141ae96bcfed87ced6539059bbbd0517a3f2bf85910c5b13b99e153d940fbf56d9bd86bf2cf23525f32a9c848d7fa3ee2d58ae664db806854e93b
-  data.tar.gz: 0e804e064e64cd66c703238e00d80f75a35871bf724c08203594d4eec1c94db5815d5ac2bacc11b743e008eb1aeec2c39f2b240fefac87aebe2c005bb194ae19
+  metadata.gz: 004e0811e1b491e835baa74fb238df98af7580ffc730614332a9cd432d99d8567e83bcf8c332e56f68f9b99a3b3af1dedb5c8b02e5dc5a530c949727ffe1d7e6
+  data.tar.gz: 25f7bd4c5de94368fe9c306252b6dc4c2c5b2743284450550812cfece422dc1b2feff9a4a76f1836a03d592e87899060285d9f4e8f1865323c0316b8f472961b

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.2)
+    rpw (0.0.3)
       thor
+      thor-hollaback
       typhoeus
 
 GEM
@@ -12,6 +13,7 @@ GEM
     ethon (0.12.0)
       ffi (>= 1.3.0)
     ffi (1.13.1)
+    hollaback (0.1.0)
     minitest (5.14.2)
     parallel (1.19.2)
     parser (2.7.1.5)
@@ -39,6 +41,9 @@ GEM
       rubocop (= 0.92)
       rubocop-performance (= 1.8.1)
     thor (1.0.1)
+    thor-hollaback (0.2.0)
+      hollaback (~> 0.1.0)
+      thor (>= 0.19.1)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.7.0)

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 0.0.3
+
+* beta
+
 ## 0.0.2
 
 * first command-complete version

data/README.md

@@ -1,2 +1,4 @@
+# The Rails Performance Workshop Client
+
 This is `rpw`, the CLI client for the Rails Performance Workshop.
 Copyright (C) 2020 The Speedshop Ltd. Co.

data/exe/rpw

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require "thor"
+require "thor/hollaback"
 require_relative "../lib/rpw"
 
 module RPW
@@ -12,14 +13,30 @@ module RPW
     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
+    end
+  end
+
+  class Key < SubCommandBase
+    desc "register [EMAIL_ADDRESS]", "Change email registered with Speedshop. One-time only."
+    def register(email)
+      client.register_email(email)
+      say "License registered. You should receive a Slack invite soon."
+    end
   end
 
   class Lesson < SubCommandBase
-    desc "next", "Proceed to the next lesson of the workshop"
+    class_before :exit_with_no_key
 
+    desc "next", "Proceed to the next lesson of the workshop"
+    option :open
     def next
       say "Proceeding to next lesson..."
-      client.next
+      client.next(options[:open])
     end
 
     desc "complete", "Mark the current lesson as complete"
@@ -44,20 +61,22 @@ module RPW
       client.download(content)
     end
 
-    desc "show [CONTENT]", "Show any workshop lesson"
-
-    def show(content)
-      client.show(content)
+    desc "show [CONTENT]", "Show any workshop lesson, shows current lesson w/no arguments"
+    option :open
+    def show(content = :current)
+      client.show(content, options[:open])
     end
 
     private
 
-    def client
-      @client ||= RPW::Client.new
+    def exit_with_no_key
+      exit(1) unless client.setup?
     end
   end
 
   class Progress < SubCommandBase
+    class_before :exit_with_no_key
+
     desc "set [LESSON]", "Set current lesson to a particular lesson"
 
     def set(lesson)
@@ -85,14 +104,19 @@ module RPW
 
     private
 
-    def client
-      @client ||= RPW::Client.new
+    def exit_with_no_key
+      exit(1) unless client.setup?
     end
 
     default_task :show
   end
 
   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"
@@ -102,27 +126,66 @@ module RPW
       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)"
+    desc "start", "Tutorial and onboarding"
+
+    def start
+      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 ""
+      return unless yes? "Are you in a directory that we can safely add new folders and files to? (Y/N)"
+      puts ""
+      say "We'll 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)")
 
-      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)
 
+      puts ""
+
       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."
+
+      puts ""
+
+      say "rpw works by downloading files into the current working directory."
+      say "We're going to (idempotently!) create a few directories in the current working directory."
+      puts ""
+      return unless yes? "Is that OK? (Y/N)"
 
       client.directory_setup
 
       say "Setup complete!"
+      puts ""
+      say "Here are some important commands for you to know:"
+      say "$ rpw lesson next     | Proceed to the next part of the workshop."
+      say "$ rpw lesson complete | Mark current lesson as complete."
+      say "$ rpw lesson list     | List all workshop lessons. Note each lesson is preceded with an ID."
+      say "$ rpw lesson download | Download any or all lessons."
+      say "$ rpw lesson show     | Show any particular workshop lesson."
+      say "$ rpw progress        | Show where you're currently at in the workshop."
+      say "$ rpw help            | Help! You can also ask in Slack."
+      puts ""
+      say "Generally, you'll just be doing a lot of $ rpw lesson next"
+      say "Remember to ask on Slack for help if you get stuck or encounter bugs."
+      say "Let's get going! $ rpw lesson next"
     end
 
-    desc "support", "Create a new support ticket, report a bug or issue"
-
-    def support
+    no_commands do
+      def print_banner
+        puts r
+        if `tput cols 80`.to_i < 80
+          puts small_banner
+        else
+          puts banner
+        end
+        puts reset
+      end
     end
 
     private
@@ -130,6 +193,63 @@ module RPW
     def client
       @client ||= RPW::Client.new
     end
+
+    def check_version
+      unless client.latest_version?
+        say "#{r}WARNING: You are running an old version of rpw."
+        say "WARNING: Please run `$ gem install rpw`#{reset}"
+      end
+    end
+
+    def check_setup
+      unless client.setup? || current_command_chain == [:start]
+        say "#{r}WARNING: You do not have a purchase key set. Run `$ rpw start`#{reset}"
+      end
+    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
 

data/lib/rpw.rb

@@ -1,5 +1,6 @@
 require "typhoeus"
 require "json"
+require_relative "rpw/version"
 
 module RPW
   class Error < StandardError; end
@@ -44,11 +45,21 @@ module RPW
       request = Typhoeus::Request.new(content["url"])
       request.on_body do |chunk|
         downloaded_file.write(chunk)
-        printf(".") if rand(10) == 0 # lol
+        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
@@ -56,7 +67,11 @@ module RPW
 
     def setup(key)
       gateway.authenticate_key(key)
-      keyfile["key"] = key
+      client_data["key"] = key
+    end
+
+    def register_email(email)
+      gateway.register_email(email)
     end
 
     def directory_setup
@@ -80,33 +95,41 @@ module RPW
       end
     end
 
-    def next
+    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)
+      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"]]
+      client_data["completed"] += [client_data["current_lesson"] || 0]
     end
 
     def list
       gateway.list_content
     end
 
-    def show(content_pos)
+    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)
+      display_content(content, open_after)
     end
 
     def download(content_pos)
@@ -135,7 +158,7 @@ module RPW
         completed: client_data["completed"].size,
         total: contents.size,
         current_lesson: contents.find { |c| c["position"] == client_data["current_lesson"] },
-        sections: chart_section_progress(contents)
+        sections: chart_section_progress(contentsi)
       }
     end
 
@@ -148,8 +171,37 @@ module RPW
       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|
@@ -180,12 +232,8 @@ module RPW
       @client_data ||= ClientData.new
     end
 
-    def keyfile
-      @keyfile ||= Keyfile.new
-    end
-
     def gateway
-      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN, keyfile["key"])
+      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN, client_data["key"])
     end
 
     def extract_content(content)
@@ -193,23 +241,41 @@ module RPW
       `tar -C #{folder} -xvzf #{folder}/#{content["s3_key"]}`
     end
 
-    def display_content(content)
+    def display_content(content, open_after)
+      puts "\nCurrent Lesson: #{content["title"]}"
       case content["style"]
       when "video"
-        puts "Opening video: #{content["title"]}"
-        exec("open video/#{content["s3_key"]}")
+        location = "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"
+        location = "lab/#{content["s3_key"]}"
       when "text"
-        puts "Opening in your editor: #{content["title"]}"
-        exec("$EDITOR text/#{content["s3_key"]}")
+        location = "lab/#{content["s3_key"]}"
       when "cgrp"
-        puts "The Complete Guide to Rails Performance has been downloaded and extracted to the cgrp directory."
+        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
 
@@ -219,50 +285,72 @@ module RPW
   class ClientData
     DOTFILE_NAME = ".rpw_info"
 
-    def [](key)
+    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(self.class::DOTFILE_NAME, "w") { |f| f.write(YAML.dump(data)) }
+        File.open(filestore_location, "w") { |f| f.write(YAML.dump(data)) }
       rescue
-        raise Error, "The RPW data file in this directory is not writable. \
+        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 = begin
-          YAML.safe_load(File.read(self.class::DOTFILE_NAME))
-        rescue
-          nil
-        end
+        yaml = YAML.safe_load(File.read(filestore_location), permitted_classes: [Time])
         yaml || {}
       end
     end
 
     def make_sure_dotfile_exists
-      return true if File.exist?(self.class::DOTFILE_NAME)
+      return true if File.exist?(filestore_location)
+      create_client_data_directory(filestore_location)
       begin
-        FileUtils.touch(self.class::DOTFILE_NAME)
+        FileUtils.touch(filestore_location)
       rescue
-        raise Error, "Could not create the RPW data file in this directory \
+        raise Error, "Could not create the RPW data file at ~/.rpw/ \
                       Check your file permissions."
       end
     end
   end
 
-  class Keyfile < ClientData
-    DOTFILE_NAME = ".rpw_key"
-  end
-
   require "digest"
+  require "thor"
 
   class Quiz < Thor
     desc "give_quiz FILENAME", ""
@@ -277,13 +365,14 @@ module RPW
       puts data["prompt"]
       data["answer_choices"].each { |ac| puts ac }
       provided_answer = ask("Your answer?")
-      answer_digest = Digest::MD5.hexdigest(data["prompt"] + provided_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/version.rb

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

data/rpw.gemspec

@@ -25,5 +25,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor"
+  spec.add_dependency "thor-hollaback"
   spec.add_dependency "typhoeus"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Nate Berkopec
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor-hollaback
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement