rpw 0.0.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 796740f7cd5cfebc0f46f72669da6d1b2941436c984d2a624a18200ae3466495
-  data.tar.gz: 3b986dbab69c20f2e840b2197175119e428d19b117378ef9192a5ce31178cbac
+  metadata.gz: 45b744148f7441c89e4b754ec0b19105e0bfbdb8e9b97e0196d0d6c0ff51266c
+  data.tar.gz: 8eac7fc7584553d6af5e2c250520ff05844e9243882baceeb133f163cee2901e
 SHA512:
-  metadata.gz: 6b5530f032ece3e44819374cb7001530359a913e5b025e04f19313c6afeb1ec2450667783c8d44e20a18b1d0c16220a19f60d29275b1f3e9852a5401a2f2b7ba
-  data.tar.gz: 1389deea5fe3705527d841abc84d9f6f33b112d5a8d02502bb8d8f8a5df90ffaedc520f8449da2891405d7702a31d65ac193087c12a5a3588afe53cf6f4dee14
+  metadata.gz: e20a592d2777d2fbd325cae566fe4e49ed9d07eb496c6da31d1dd70010d08baf08827095c4ffec842e7a9cfeb886d755afd632bedf6e9b671fd3d32fd062382e
+  data.tar.gz: 0b8360255ef4fd5fba85bf982236e44b0f07050a9d45c1f557e047b82d5dd91a243f2c4be96c8202953a3e993c09ecfaec4de9f803c803f038456e952d18cc08

data/.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-20.04, macos-10.15, windows-2019 ]
-        ruby: [ 2.6, 2.7, head ]
+        ruby: [ 2.3, 2.6, 2.7, head ]
 
     steps:
       - name: repo checkout

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rpw (0.0.6)
+    rpw (1.0.0)
       excon
       thor
       thor-hollaback

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 1.0.0
+
+* First release!
+
 ## 0.0.6
 
 * more bugfixes from beta testers

data/lib/rpw/README.md

@@ -1,22 +1,58 @@
 ## Installation Requirements
 
-This client assumes you have `tar` installed.
+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.
-$ rpw lesson show     | Show any particular workshop lesson.
+$ 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.
-$ rpw help            | Help! You can also ask in Slack.
+```
+
+Generally, you'll just be doing a lot of `$ rpw lesson next`!
 
-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`.
 
-## Data Size Notice
+## 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.
+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

@@ -55,9 +55,8 @@ module RPW
       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"
+      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
@@ -82,7 +81,6 @@ module RPW
       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
 

data/lib/rpw/cli/key.rb

@@ -8,7 +8,7 @@ module RPW
         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"
+          " please email support@speedshop.co"
       end
     end
   end

data/lib/rpw/cli/lesson.rb

@@ -3,7 +3,7 @@ module RPW
     class_before :exit_with_no_key
 
     desc "next", "Proceed to the next lesson of the workshop"
-    option :open
+    option :"no-open"
     def next
       say "Proceeding to next lesson..."
       content = client.next
@@ -16,21 +16,23 @@ module RPW
       end
 
       client.download_and_extract(content)
-      client.increment_current_lesson!(content["position"])
-      display_content(content, options[:open])
+      client.complete(content["position"])
+      display_content(content, !options[:"no-open"])
     end
 
     desc "complete", "Mark the current lesson as complete"
     def complete
       say "Marked current lesson as complete"
-      client.complete
+      client.complete(nil)
     end
 
     desc "list", "Show all available workshop lessons"
     def list
       say "All available workshop lessons:"
+      say "Use [ID] for the show/download command"
+      say "[ID]: Lesson Name"
       client.list.each do |lesson|
-        puts "#{"  " * lesson["indent"]}[#{lesson["position"]}]: #{lesson["title"]}"
+        puts "[#{lesson["position"]}]:#{"  " * lesson["indent"]} #{lesson["title"]}"
       end
     end
 
@@ -45,11 +47,11 @@ module RPW
     end
 
     desc "show [CONTENT]", "Show any workshop lesson, shows current lesson w/no arguments"
-    option :open
+    option :"no-open"
     def show(content_order = :current)
       content = client.show(content_order)
       client.download_and_extract(content)
-      display_content(content, options[:open])
+      display_content(content, !options[:"no-open"])
     end
 
     private
@@ -65,17 +67,17 @@ module RPW
         Quiz.start(["give_quiz", "quiz/" + content["s3_key"]])
       when "lab"
         location = "lab/#{content["s3_key"][0..-8]}"
+        openable = true
       when "text"
-        location = "lab/#{content["s3_key"]}"
+        location = "text/#{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."
+        say "You can check it out now, or to continue: $ rpw lesson next "
       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}"

data/lib/rpw/cli/progress.rb

@@ -3,14 +3,16 @@ module RPW
     class_before :exit_with_no_key
 
     desc "set [LESSON]", "Set current lesson to a particular lesson"
-    def set(lesson)
-      client.set_progress(lesson)
+    def set(pos)
+      lesson = client.set_progress(pos.to_i)
+      say "Set current progress to #{lesson["title"]}"
     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
+      return unless yes? "Are you sure you want to reset your progress? (Y/N)"
+      say "Resetting progress."
+      client.set_progress(nil)
     end
 
     desc "show", "Show current workshop progress"

data/lib/rpw/client.rb

@@ -21,18 +21,30 @@ module RPW
     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
+      return list.first unless client_data["completed"]
+      list.sort_by { |c| c["position"] }.find { |c| c["position"] > current_position }
     end
 
     def list
-      gateway.list_content
+      @list ||= begin
+        if client_data["content_cache_generated"] &&
+            client_data["content_cache_generated"] >= Time.now - 60 * 60
+
+          client_data["content_cache"]
+        else
+          begin
+            client_data["content_cache"] = gateway.list_content
+            client_data["content_cache_generated"] = Time.now
+            client_data["content_cache"]
+          rescue
+            client_data["content_cache"] || (raise Error.new("No internet connection"))
+          end
+        end
+      end
     end
 
     def show(content_pos)
-      content_pos = client_data["current_lesson"] if content_pos == :current
+      content_pos = current_position if content_pos == :current
       gateway.get_content_by_position(content_pos)
     end
 
@@ -64,38 +76,28 @@ module RPW
       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)
+        total: list.size,
+        current_lesson: list.find { |c| c["position"] == current_position },
+        sections: chart_section_progress(list, 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"] = []
+    def set_progress(pos)
+      client_data["completed"] = [] && return if pos.nil?
+      lesson = list.find { |l| l["position"] == pos }
+      raise Error.new("No such lesson - use the IDs in $ rpw lesson list") unless lesson
+      client_data["completed"] += [pos]
+      lesson
     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
+      return true if client_data["last_version_check"] &&
+        client_data["last_version_check"] >= Time.now - (60 * 60)
 
       begin
         latest = gateway.latest_version?
@@ -129,19 +131,23 @@ module RPW
       end
     end
 
+    def complete(position)
+      reset_progress unless client_data["completed"]
+      # we actually have to put the _next_ lesson on the completed stack
+      set_progress(self.next["position"])
+    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]
+    def current_position
+      @current_position ||= client_data["completed"]&.last || 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"]
+            if l["position"] == current_position
               "O"
             elsif completed.include?(l["position"])
               "X"

data/lib/rpw/gateway.rb

@@ -42,9 +42,13 @@ module RPW
       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)}%"
+        print "Remaining: #{(remaining_bytes.to_f / total_bytes * 100).round(2).to_s.rjust(8)}%" if remaining_bytes
+      end
+      response = Excon.get(content["url"], response_block: streamer)
+      unless response.status == 200
+        puts response.inspect
+        raise Error.new("Server problem: #{response.status}")
       end
-      Excon.get(content["url"], response_block: streamer)
       downloaded_file.close
       print "\n"
       File.rename(downloaded_file, "#{folder}/#{content["s3_key"]}")

data/lib/rpw/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rpw
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 1.0.0
 platform: ruby
 authors:
 - Nate Berkopec
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-17 00:00:00.000000000 Z
+date: 2020-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor