rpw 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da44e397174a310bc8ba3ed4c2ecb28f2811cf30275a2cb7cd3ec85029ab99a
-  data.tar.gz: c096b4539f5570d6994eed51ec758007e08f75632e0e26f7d13e15b531633995
+  metadata.gz: 45b744148f7441c89e4b754ec0b19105e0bfbdb8e9b97e0196d0d6c0ff51266c
+  data.tar.gz: 8eac7fc7584553d6af5e2c250520ff05844e9243882baceeb133f163cee2901e
 SHA512:
-  metadata.gz: 3557e0688d5141ae96bcfed87ced6539059bbbd0517a3f2bf85910c5b13b99e153d940fbf56d9bd86bf2cf23525f32a9c848d7fa3ee2d58ae664db806854e93b
-  data.tar.gz: 0e804e064e64cd66c703238e00d80f75a35871bf724c08203594d4eec1c94db5815d5ac2bacc11b743e008eb1aeec2c39f2b240fefac87aebe2c005bb194ae19
+  metadata.gz: e20a592d2777d2fbd325cae566fe4e49ed9d07eb496c6da31d1dd70010d08baf08827095c4ffec842e7a9cfeb886d755afd632bedf6e9b671fd3d32fd062382e
+  data.tar.gz: 0b8360255ef4fd5fba85bf982236e44b0f07050a9d45c1f557e047b82d5dd91a243f2c4be96c8202953a3e993c09ecfaec4de9f803c803f038456e952d18cc08

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.3, 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

@@ -3,3 +3,4 @@ bundle
 .rpw_key
 .rpw_info
 smoketest
+scripts

data/Gemfile.lock

@@ -1,46 +1,47 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.2)
+    rpw (1.0.0)
+      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 @@
+## 1.0.0
+
+* First release!
+
+## 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

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,136 +1,5 @@
 #!/usr/bin/env ruby
 
-require "thor"
-require_relative "../lib/rpw"
-
-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
-  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 "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)
-      client.download(content)
-    end
-
-    desc "show [CONTENT]", "Show any workshop lesson"
-
-    def show(content)
-      client.show(content)
-    end
-
-    private
-
-    def client
-      @client ||= RPW::Client.new
-    end
-  end
-
-  class Progress < SubCommandBase
-    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"]}"
-      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
-
-    def client
-      @client ||= RPW::Client.new
-    end
-  end
-end
+require_relative "../lib/rpw/cli"
 
 RPW::CLI.start(ARGV)

data/lib/rpw.rb

@@ -1,289 +1,8 @@
-require "typhoeus"
-require "json"
+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(10) == 0 # lol
-      end
-      request.on_complete { |response| downloaded_file.close }
-      request
-    end
-  end
-
-  class Client
-    RPW_SERVER_DOMAIN = ENV["RPW_SERVER_DOMAIN"] || "https://rpw-licensor.speedshop.co"
-
-    def setup(key)
-      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
-
-    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
-        FileUtils.touch(self.class::DOTFILE_NAME)
-      rescue
-        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"
-
-  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)
-      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