rpw 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b470a6daefa536118bc45ad650345ae904890cfdc21340f4241fe95585840ca
-  data.tar.gz: 4055764a0110865d0bd1faa4616a269c16beeceee6868ad9f1b5a8188b172f30
+  metadata.gz: 796740f7cd5cfebc0f46f72669da6d1b2941436c984d2a624a18200ae3466495
+  data.tar.gz: 3b986dbab69c20f2e840b2197175119e428d19b117378ef9192a5ce31178cbac
 SHA512:
-  metadata.gz: 797f1c5528477c5befc5bed08a2dba98aabf2968be757a682a5f5dda81ae9815bbfa572f4974504eecb478a7bf106abef1562945f3865f09a8429badf68f61b4
-  data.tar.gz: a948446a6b948793d63dad89880c1e958f21532eaa278b9e232248a2b298a59c8b103e21c4f0ec537fb003d066abf79da56d8d3e97fde3aad49c9c99fbfaf7f3
+  metadata.gz: 6b5530f032ece3e44819374cb7001530359a913e5b025e04f19313c6afeb1ec2450667783c8d44e20a18b1d0c16220a19f60d29275b1f3e9852a5401a2f2b7ba
+  data.tar.gz: 1389deea5fe3705527d841abc84d9f6f33b112d5a8d02502bb8d8f8a5df90ffaedc520f8449da2891405d7702a31d65ac193087c12a5a3588afe53cf6f4dee14

data/.github/workflows/test.yml

@@ -0,0 +1,109 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: >-
+      ${{ matrix.os }} ${{ matrix.ruby }}
+    env:
+      CI: true
+      TESTOPTS: -v
+
+    runs-on: ${{ matrix.os }}
+    if: |
+      !(   contains(github.event.pull_request.title,  '[ci skip]')
+        || contains(github.event.pull_request.title,  '[skip ci]')
+        || contains(github.event.head_commit.message, '[ci skip]')
+        || contains(github.event.head_commit.message, '[skip ci]'))
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-20.04, macos-10.15, windows-2019 ]
+        ruby: [ 2.6, 2.7, head ]
+
+    steps:
+      - name: repo checkout
+        uses: actions/checkout@v2
+
+      - name: load ruby
+        uses: MSP-Greg/setup-ruby-pkgs@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: bundle install
+        run:   |
+          bundle install --jobs 4 --retry 3
+
+      - name: standardrb 
+        run: bundle exec standardrb 
+
+      - name: test
+        run: bundle exec rake test
+
+  build-live:
+    services:
+      postgres:
+        image: postgres:alpine
+        env:
+          POSTGRES_PASSWORD: password
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    name: Test against a live server
+    env:
+      CI: true
+      TESTOPTS: -v 
+      LIVE_SERVER: true
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: repo checkout
+        uses: actions/checkout@v2
+
+      - name: load ruby
+        uses: MSP-Greg/setup-ruby-pkgs@v1
+        with:
+          ruby-version: 2.7.2
+
+      - name: bundle install
+        run:   |
+          bundle install --jobs 4 --retry 3
+
+      - uses: actions/checkout@master
+        with:
+          repository: speedshop/licensor
+          path: server 
+
+      - name: nuke server ruby requirement 
+        run: grep -v "^ruby" Gemfile > temp && mv -f temp Gemfile
+        working-directory: ./server
+
+      - name: bundle install the server
+        run: |
+          bundle install --jobs 4 --retry 3
+          bundle exec rails db:setup
+        working-directory: ./server
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+
+      - name: start the server 
+        run: rails server &
+        working-directory: ./server
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+
+      - name: wait for server 
+        run: |
+          until $(curl --output /dev/null --silent --head --fail http://localhost:3000); do
+            printf '.'
+            sleep 1
+          done
+
+      - name: test
+        run: bundle exec rake test

data/.gitignore

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

data/Gemfile.lock

@@ -1,46 +1,47 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.1)
+    rpw (0.0.6)
+      excon
       thor
-      typhoeus
+      thor-hollaback
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    ffi (1.13.1)
+    excon (0.78.0)
+    hollaback (0.1.0)
     minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.1.5)
+    parallel (1.20.0)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.8.1)
+    regexp_parser (1.8.2)
     rexml (3.2.4)
-    rubocop (0.92.0)
+    rubocop (1.2.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.7.1)
+    rubocop-ast (1.1.1)
       parser (>= 2.7.1.5)
     rubocop-performance (1.8.1)
       rubocop (>= 0.87.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.10.1)
-    standard (0.7)
-      rubocop (= 0.92)
+    standard (0.9.0)
+      rubocop (= 1.2.0)
       rubocop-performance (= 1.8.1)
     thor (1.0.1)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
+    thor-hollaback (0.2.0)
+      hollaback (~> 0.1.0)
+      thor (>= 0.19.1)
     unicode-display_width (1.7.0)
 
 PLATFORMS

data/HISTORY.md

@@ -1,3 +1,24 @@
+## 0.0.6
+
+* more bugfixes from beta testers
+* CI
+
+## 0.0.5
+
+* more bugfixes from beta testers
+
+## 0.0.4
+
+* bugfixes
+
+## 0.0.3
+
+* beta
+
+## 0.0.2
+
+* first command-complete version
+
 ## 0.0.1
 
 * setup command works

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,61 +1,5 @@
 #!/usr/bin/env ruby
 
-require "thor"
-require_relative "../lib/rpw"
-
-module RPW
-  class CLI < Thor
-    class_option :verbose, type: :boolean, aliases: "-v"
-
-    desc "next", "Proceed to the next section of the workshop"
-
-    def next
-      # ...
-    end
-
-    desc "setup", "Set up your purchase key in order to download workshop sections"
-
-    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: ")
-
-      client.setup(key)
-
-      say "Successfully authenticated with the RPW server and saved your key."
-    end
-
-    desc "status", "Show your current workshop progression"
-
-    def status
-      # ...
-    end
-
-    desc "support", "Create a new support ticket, report a bug or issue"
-
-    def support
-    end
-
-    desc "show CONTENT", "Show any workshop section (use list to see all section names)"
-
-    def show(content)
-    end
-
-    desc "list", "Show all available workshop content"
-
-    def list
-    end
-
-    desc "download [CONTENT | all]", "Download one or all workshop contents"
-
-    def download(content)
-    end
-
-    private 
-
-    def client
-      @client ||= RPW::Client.new 
-    end
-  end
-end
+require_relative "../lib/rpw/cli"
 
 RPW::CLI.start(ARGV)

data/lib/rpw.rb

@@ -1,63 +1,8 @@
-require "typhoeus"
-require "base64"
+require "rpw/version"
+require "rpw/client"
+require "rpw/client_data"
+require "rpw/gateway"
 
 module RPW
-  class Gateway
-    attr_accessor :domain 
-
-    def initialize(domain)
-      @domain = domain
-    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
-      end
-
-      request.run
-    end
-
-    def get_resource(resource)
-    end
-  end
-
-  class Client
-    DOTFILE_NAME = ".rpw_key"
-    RPW_SERVER_DOMAIN = "https://rpw-licensor.speedshop.co"
-
-    class Error < StandardError; end
-
-    def setup(key)
-      # authenticate against server
-      gateway.authenticate_key(key)
-
-      # write authenticated key
-      begin
-        File.open(DOTFILE_NAME, "w") { |f| f.write(key) }
-      rescue
-        raise Error.new "Could not create dotfile in this directory \
-                         to save your key. Check your file permissions."
-      end
-
-      key
-    end
-
-    private
-
-    def gateway
-      @gateway ||= Gateway.new(RPW_SERVER_DOMAIN)
-    end
-  end
+  class Error < StandardError; end
 end

data/lib/rpw/README.md

@@ -0,0 +1,22 @@
+## Installation Requirements
+
+This client assumes you have `tar` installed.
+
+## 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.
+$ rpw lesson show     | Show any particular workshop lesson.
+$ rpw progress        | Show where you're currently at in the workshop.
+$ rpw help            | Help! You can also ask in Slack.
+
+Generally, you'll just be doing a lot of $ rpw lesson next
+
+## Data Size Notice
+
+Videos in this workshop are generally about 100MB each, which means the entire
+course is about a 3 to 4GB download.

data/lib/rpw/cli.rb

@@ -0,0 +1,96 @@
+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."
+      say "Remember to ask on Slack for help if you get stuck or encounter bugs."
+      say "Once 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`"
+        exit(0)
+      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 nate.berkopec@speedshop.co"
+      end
+    end
+  end
+end

data/lib/rpw/cli/lesson.rb

@@ -0,0 +1,99 @@
+module RPW
+  class Lesson < SubCommandBase
+    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..."
+      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.increment_current_lesson!(content["position"])
+      display_content(content, options[:open])
+    end
+
+    desc "complete", "Mark the current lesson as complete"
+    def complete
+      say "Marked current lesson as complete"
+      client.complete
+    end
+
+    desc "list", "Show all available workshop lessons"
+    def list
+      say "All available workshop lessons:"
+      client.list.each do |lesson|
+        puts "#{"  " * lesson["indent"]}[#{lesson["position"]}]: #{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 :open
+    def show(content_order = :current)
+      content = client.show(content_order)
+      client.download_and_extract(content)
+      display_content(content, options[: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]}"
+      when "text"
+        location = "lab/#{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."
+      end
+      if location
+        if openable && !open_after
+          say "This file can be opened automatically if you use the --open flag next time."
+          say "e.g. $ rpw lesson next --open"
+          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,32 @@
+module RPW
+  class Progress < SubCommandBase
+    class_before :exit_with_no_key
+
+    desc "set [LESSON]", "Set current lesson to a particular lesson"
+    def set(lesson)
+      client.set_progress(lesson)
+    end
+
+    desc "reset", "Erase all progress and start over"
+    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"]}" 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,168 @@
+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
+      contents = gateway.list_content
+      return contents.first unless client_data["completed"]
+      contents.delete_if { |c| client_data["completed"].include? c["position"] }
+      contents.sort_by { |c| c["position"] }[1] # 0 would be the current lesson
+    end
+
+    def list
+      gateway.list_content
+    end
+
+    def show(content_pos)
+      content_pos = client_data["current_lesson"] 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 increment_current_lesson!(position)
+      mark_current_lesson_as_completed
+      client_data["current_lesson"] = position
+    end
+
+    def progress
+      contents = gateway.list_content
+      completed_lessons = client_data["completed"] || []
+      {
+        completed: completed_lessons.size,
+        total: contents.size,
+        current_lesson: contents.find { |c| c["position"] == client_data["current_lesson"] },
+        sections: chart_section_progress(contents, completed_lessons)
+      }
+    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?
+      return true unless ClientData.exists?
+
+      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?
+      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
+
+    private
+
+    def mark_current_lesson_as_completed
+      reset_progress unless client_data["current_lesson"] && client_data["completed"]
+      client_data["completed"] ||= []
+      client_data["completed"] += [client_data["current_lesson"] || 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"] == client_data["current_lesson"]
+              "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

data/lib/rpw/client_data.rb

@@ -0,0 +1,73 @@
+require "fileutils"
+require "yaml"
+
+module RPW
+  class ClientData
+    DOTFILE_NAME = ".rpw_info"
+
+    def initialize
+      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.create_in_pwd!
+      FileUtils.touch(File.expand_path("./" + DOTFILE_NAME))
+    end
+
+    def self.create_in_home!
+      unless File.directory?(File.expand_path("~/.rpw/"))
+        FileUtils.mkdir(File.expand_path("~/.rpw/"))
+      end
+
+      FileUtils.touch(File.expand_path("~/.rpw/" + DOTFILE_NAME))
+    end
+
+    def self.delete_filestore
+      return unless File.exist?(filestore_location)
+      FileUtils.remove(filestore_location)
+    end
+
+    def self.exists?
+      File.exist? filestore_location
+    end
+
+    def self.filestore_location
+      if File.exist?(File.expand_path("./" + DOTFILE_NAME))
+        File.expand_path("./" + DOTFILE_NAME)
+      else
+        File.expand_path("~/.rpw/" + DOTFILE_NAME)
+      end
+    end
+
+    private
+
+    def filestore_location
+      self.class.filestore_location
+    end
+
+    def data
+      @data ||= begin
+        begin
+          YAML.safe_load(File.read(filestore_location), permitted_classes: [Time]) || {}
+        rescue Errno::ENOENT
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/rpw/gateway.rb

@@ -0,0 +1,63 @@
+require "excon"
+require "json"
+
+module RPW
+  class Gateway
+    attr_accessor :domain
+
+    def initialize(domain, key)
+      @domain = domain
+      @key = key
+    end
+
+    class Error < StandardError; end
+
+    def authenticate_key(key)
+      Excon.get(domain + "/license", user: key).status == 200
+    end
+
+    def get_content_by_position(position)
+      response = Excon.get(domain + "/contents/positional?position=#{position}", user: @key)
+      if response.status == 200
+        JSON.parse(response.body)
+      else
+        puts response.inspect
+        raise Error, "There was a problem fetching this content."
+      end
+    end
+
+    def list_content
+      response = Excon.get(domain + "/contents", user: @key)
+      if response.status == 200
+        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"]}.partial", "w")
+      streamer = lambda do |chunk, remaining_bytes, total_bytes|
+        downloaded_file.write(chunk)
+        print 13.chr
+        print "Remaining: #{(remaining_bytes.to_f / total_bytes * 100).round(2).to_s.rjust(8)}%"
+      end
+      Excon.get(content["url"], response_block: streamer)
+      downloaded_file.close
+      print "\n"
+      File.rename(downloaded_file, "#{folder}/#{content["s3_key"]}")
+    end
+
+    def latest_version?
+      resp = Excon.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)
+      Excon.put(domain + "/license?email=#{email}&key=#{@key}").status == 200
+    end
+  end
+end

data/lib/rpw/version.rb

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

data/rpw.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Nate Berkopec
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  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: excon
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -46,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".ruby_version"
 - CODE_OF_CONDUCT.md
@@ -57,6 +72,17 @@ files:
 - Rakefile
 - exe/rpw
 - lib/rpw.rb
+- lib/rpw/README.md
+- lib/rpw/cli.rb
+- lib/rpw/cli/bannerlord.rb
+- lib/rpw/cli/key.rb
+- lib/rpw/cli/lesson.rb
+- lib/rpw/cli/progress.rb
+- lib/rpw/cli/quiz.rb
+- lib/rpw/cli/sub_command_base.rb
+- lib/rpw/client.rb
+- lib/rpw/client_data.rb
+- lib/rpw/gateway.rb
 - lib/rpw/version.rb
 - rpw.gemspec
 homepage: https://speedshop.co