gistribute 0.2 → 0.3

data/lib/cli.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require "cli/auth"
+require "cli/install"
+require "cli/upload"
+
+module Gistribute
+  class CLI
+    def initialize
+      @options = OptimistXL.options do
+        version "gistribute #{File.read(File.expand_path('../VERSION', __dir__)).strip}"
+
+        banner <<~BANNER
+          #{version}
+
+          Usage:
+            gistribute SUBCOMMAND [OPTION]... INPUT
+
+          Try `gistribute SUBCOMMAND -h` for more info. Available subcommands:
+            * login: log into your GitHub account
+            * logout: log out of your GitHub account
+            * install: download and install files from a gistribution
+            * upload: upload a new gistribution
+
+          Options:
+        BANNER
+
+        opt :version, "display version number"
+        opt :help, "display a help message"
+
+        # Sub-commands can't access the version from this scope for whatever reason
+        v = version
+
+        subcmd :login, "log into your GitHub account"
+        subcmd :logout, "log out of your GitHub account"
+
+        subcmd :install, "install from a gistribution" do
+          banner <<~BANNER
+            #{v}
+
+            Usage:
+              gistribute install [OPTION]... URL_OR_ID
+
+            Options:
+          BANNER
+
+          opt :yes, "install files without prompting"
+          opt :force, "overwrite existing files without prompting"
+        end
+
+        subcmd :upload, "upload a gistribution" do
+          banner <<~BANNER
+            #{v}
+
+            Usage:
+              gistribute upload [OPTION]... FILE...
+              gistribute upload [OPTION]... DIRECTORY
+
+            Options:
+          BANNER
+
+          opt :description, "description for the Gist", type: :string
+          opt :private, "use a private Gist"
+          opt :yes, "upload files without prompting"
+        end
+
+        educate_on_error
+      end
+
+      @subcommand, @global_options, @subcommand_options =
+        @options.subcommand, @options.global_options, @options.subcommand_options
+
+      authenticate unless @subcommand == "logout"
+
+      case @subcommand
+      when "install"
+        @gist_input = ARGV.first
+      when "upload"
+        @files = ARGV.dup
+      end
+    end
+
+    def run
+      case @subcommand
+      when "login"
+        # Do nothing, #authenticate is run from the constructor
+      when "logout"
+        FileUtils.rm_rf CONFIG_FILE
+        puts "Logged out.".green
+      else
+        if ARGV.empty?
+          OptimistXL.educate
+        end
+
+        eval @subcommand
+      end
+    end
+
+    def confirm?(prompt)
+      print prompt
+      input = $stdin.gets.strip.downcase
+
+      input.start_with?("y") || input.empty?
+    end
+
+    def get_input(prompt)
+      print prompt
+      $stdin.gets.strip
+    end
+
+    # Prints an error message and exits the program.
+    def panic!(message)
+      $stderr.puts "#{'Error'.red}: #{message}"
+      exit 1
+    end
+  end
+end

data/lib/gistribute.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "colorize"
+require "fileutils"
+require "json"
+require "launchy"
+require "octokit"
+require "optimist_xl"
+
+require "cli"
+
+CLIENT_ID = "3f37dc8255e5ab891c3d"
+CONFIG_FILE = "#{Dir.home}/.config/gistribute".freeze
+
+module Gistribute
+  class << self
+    # The user may enter either the full URL or just the ID, this function
+    # will parse it out of the input.
+    def parse_id(str)
+      str[%r{(^|/)([[:xdigit:]]+)}, 2]
+    end
+
+    # Encodes a file path for use in the Gist filename
+    def encode(filename)
+      filename.sub(/^#{Dir.home}/, "~").gsub("/", "|")
+    end
+
+    # Decodes the filename from the Gist into a usable path
+    def decode(filename)
+      filename.gsub(/[~|]/, "|" => "/", "~" => Dir.home)
+    end
+  end
+end

data/spec/.rubocop.yml

@@ -0,0 +1,46 @@
+inherit_from: ../.rubocop.yml
+
+RSpec/Focus:
+  Severity: warning
+
+Style/SignalException:
+  Enabled: false
+
+# Lots of spacing for alignment in the tests
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+################################################################################
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/EmptyExampleGroup:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/NoExpectationExample:
+  Enabled: false
+
+RSpec/ScatteredLet:
+  Enabled: false
+
+RSpec/SortMetadata:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false

data/spec/gistribute/cli_auth_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+DEVICE_RES = {
+  "device_code" => "testdevicecode",
+  "expires_in" => "899",
+  "interval" => "1",
+  "user_code" => "1337-6969",
+  "verification_uri" => "https://github.com/login/device"
+}.freeze
+
+PENDING_RES = {
+  "error" => "authorization_pending",
+  "error_description" => "The authorization request is still pending.",
+  "error_uri" => "https://docs.github.com/developers/apps/authorizing-oauth-apps#error-codes-for-the-device-flow"
+}.freeze
+
+EXPIRED_RES = {
+  "error" => "expired_token",
+  "error_description" => "The `device code` has expired.",
+  "error_uri" => "https://docs.github.com/developers/apps/authorizing-oauth-apps#error-codes-for-the-device-flow"
+}.freeze
+
+SUCCESS_RES = {
+  "access_token" => OAUTH_TOKEN,
+  "scope" => "gist",
+  "token_type" => "bearer"
+}.freeze
+
+def mock_oauth_response(res)
+  allow(Net::HTTP).to receive(:post_form)
+    .with(URI("https://github.com/login/oauth/access_token"), anything)
+    .and_return(:res2)
+  allow(URI).to receive(:decode_www_form)
+    .with(:res2)
+    .and_return(res)
+end
+
+# Hack to get the `:resX` symbols to fall through into #decode_www_form
+class Symbol
+  def body
+    itself
+  end
+end
+
+describe Gistribute::CLI do
+  before do
+    allow(Launchy).to receive(:open)
+    allow(File).to receive(:write)
+    suppress_stdout
+  end
+
+  let(:http_ok) { Net::HTTPOK.new("1.1", "200", "OK") }
+
+  describe "#authenticate" do
+    context "when there is no access key saved" do
+      before do
+        allow(File).to receive(:exist?).and_return(false)
+
+        allow(Net::HTTP).to receive(:post_form)
+          .with(URI("https://github.com/login/device/code"), anything)
+          .and_return(:res1)
+        allow(URI).to receive(:decode_www_form)
+          .with(:res1)
+          .and_return(DEVICE_RES.to_a)
+      end
+
+      describe "the initial output" do
+        before do
+          mock_oauth_response SUCCESS_RES
+          run "login"
+        end
+
+        it "prints the user code" do
+          expect($stdout).to have_received(:write)
+            .with(a_string_matching DEVICE_RES["user_code"])
+        end
+
+        it "prints the verification URI" do
+          expect($stdout).to have_received(:write)
+            .with(a_string_matching DEVICE_RES["verification_uri"])
+        end
+
+        it "opens the verification URI in a browser" do
+          expect(Launchy).to have_received(:open).with(DEVICE_RES["verification_uri"])
+        end
+      end
+
+      describe "when the response is a success" do
+        before do
+          mock_oauth_response SUCCESS_RES
+          allow(Octokit::Client).to receive(:new).and_call_original
+          run "login"
+        end
+
+        it "writes the token to the config file" do
+          expect(File).to have_received(:write).with(CONFIG_FILE, OAUTH_TOKEN)
+        end
+
+        it "logs in with Octokit" do
+          expect(Octokit::Client).to have_received(:new)
+            .with(a_hash_including access_token: OAUTH_TOKEN)
+        end
+      end
+
+      context "when the response is timed out" do
+        before do
+          mock_oauth_response EXPIRED_RES
+          %i[puts print].each { |p| allow($stderr).to receive p }
+          run "login", fail_on_exit: false
+        end
+
+        let(:error) { "#{'Error'.red}: Token expired! Please try again." }
+
+        it "displays an error" do
+          expect($stderr).to have_received(:puts).with(error)
+        end
+      end
+    end
+  end
+
+  describe "the `logout` subcommand" do
+    before do
+      allow(FileUtils).to receive(:rm_rf)
+      run "logout"
+    end
+
+    it "deletes the auth token" do
+      expect(FileUtils).to have_received(:rm_rf).with(CONFIG_FILE)
+    end
+  end
+end

data/spec/gistribute/cli_install_spec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+NEW_DIR_FILENAME = "nested/test.file"
+MULTI_FILENAMES = ["file1", "dir/file2"].freeze
+
+SINGLE_FILE_CONTENTS = "Line 1\nLine 2\n"
+
+# Test Gists
+PUB_SINGLE_FILE_ID = "4346763"
+SEC_SINGLE_FILE_ID = "5fa3c6bab88036e95d62cadf15128ec3"
+NO_TITLE_ID = "5865a130f9cf40acd9f0e85d15e601a7"
+NO_PIPE_SPACING_ID = "5677679b0db25054521753e5d59bed3d"
+NON_EXISTENT_DIR_ID = "8c86bf9cda921ebe7ad1bf0c46afb108"
+MULTI_FILE_ID = "8d4a2a4c8fe0b1427fed39c939857a40"
+CWD_ID = "3c7006e629fcc54262ef02a5b2204735"
+HOME_ID = "acb6caa80886101a68c5c85e4c100ddb"
+
+def test_single_file(id, path)
+  before { run "install", id }
+
+  # TEMP already gets `rm -rf`ed in the `cli_spec.rb` #after
+  unless path == TEMP
+    after { FileUtils.rm "#{path}/#{FILENAME}" }
+  end
+
+  let(:file_contents) { File.read "#{path}/#{FILENAME}" }
+
+  it "downloads the file into #{path}" do
+    expect(file_contents).to eq SINGLE_FILE_CONTENTS
+  end
+end
+
+describe Gistribute::CLI do
+  before do
+    FileUtils.rm_rf TEMP
+    FileUtils.mkdir_p TEMP
+    suppress_stdout
+  end
+
+  after { FileUtils.rm_rf TEMP }
+
+  describe "#install" do
+    context "when user inputs `y` at the installation prompt" do
+      before { simulate_user_input "y\n" }
+
+      {
+        "public single file": PUB_SINGLE_FILE_ID,
+        "secret single file": SEC_SINGLE_FILE_ID,
+        "no title": NO_TITLE_ID,
+        "no || spacing": NO_PIPE_SPACING_ID
+      }.each do |description, id|
+        context "when run with a #{description} Gist" do
+          test_single_file id, TEMP
+        end
+      end
+
+      context "when given a directory that doesn't exist" do
+        before { run "install", NON_EXISTENT_DIR_ID }
+
+        let(:file_contents) { File.read "#{TEMP}/#{NEW_DIR_FILENAME}" }
+
+        it "creates the directory" do
+          expect(file_contents).to eq SINGLE_FILE_CONTENTS
+        end
+      end
+
+      context "when run with a multi-file Gist" do
+        before { run "install", MULTI_FILE_ID }
+
+        let(:file1_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[0]}" }
+        let(:file2_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[1]}" }
+
+        it "downloads the files into the correct locations" do
+          [file1_contents, file2_contents].each_with_index do |result, i|
+            file_number = i + 1
+            expect(result).to eq "F#{file_number}L1\nF#{file_number}L2\n"
+          end
+        end
+      end
+
+      context "when given a file for the current working directory" do
+        test_single_file CWD_ID, Dir.pwd
+      end
+
+      context "when given a file for the home directory" do
+        test_single_file HOME_ID, Dir.home
+      end
+
+      context "when given a bad ID (404)" do
+        before do
+          %i[puts print].each { |p| allow($stderr).to receive p }
+          run "install", "bad", fail_on_exit: false
+        end
+
+        it "prints the error to STDERR" do
+          expect($stderr).to have_received(:print).with <<~EOS.chop.red
+            \rThere was an error downloading the requested Gist.
+            The error is as follows:
+          EOS
+
+          expect($stderr).to have_received(:puts).with(" 404 Not Found")
+          expect($stderr).to have_received(:print).with("The ID that was queried is: ".red)
+          expect($stderr).to have_received(:puts).with("bad")
+        end
+      end
+    end
+
+    context "when user inputs nothing at the installation prompt" do
+      before do
+        simulate_user_input "\n"
+        run "install", PUB_SINGLE_FILE_ID
+      end
+
+      it "saves the file" do
+        expect(File).to exist("#{TEMP}/#{FILENAME}")
+      end
+    end
+
+    %w[n m].each do |ch|
+      context "when user inputs `#{ch}` at the installation prompt" do
+        before do
+          simulate_user_input "#{ch}\n"
+          run "install", PUB_SINGLE_FILE_ID
+        end
+
+        it "doesn't save the file" do
+          expect(File).not_to exist("#{TEMP}/#{FILENAME}")
+        end
+      end
+    end
+
+    context "when a file would be overwritten" do
+      let(:orig_content) { "original" }
+
+      before do
+        FileUtils.mkdir_p "#{TEMP}/dir"
+        MULTI_FILENAMES.each do |filename|
+          File.write("#{TEMP}/#{filename}", orig_content)
+        end
+      end
+
+      let(:file1_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[0]}" }
+      let(:file2_contents) { File.read "#{TEMP}/#{MULTI_FILENAMES[1]}" }
+
+      context "when the user inputs `y` at the file overwrite prompts" do
+        before do
+          simulate_user_input "y\n", "y\n", "y\n"
+          run "install", MULTI_FILE_ID
+        end
+
+        it "downloads the files into the correct locations" do
+          expect([file1_contents, file2_contents]).not_to include orig_content
+        end
+      end
+
+      context "when the user inputs `n` at the file overwrite prompts" do
+        before do
+          simulate_user_input "y\n", "n\n", "n\n"
+          run "install", MULTI_FILE_ID
+        end
+
+        it "doesn't download the files" do
+          expect([file1_contents, file2_contents]).to all eq orig_content
+        end
+      end
+
+      context "with the `--force` flag" do
+        before do
+          simulate_user_input "y\n"
+          run "install", "--force", MULTI_FILE_ID
+        end
+
+        it "overwrites the files without prompting" do
+          [file1_contents, file2_contents].each do |result|
+            expect(result).not_to eq orig_content
+          end
+        end
+      end
+    end
+
+    context "when ran with the --yes flag" do
+      before { run "install", "--yes", PUB_SINGLE_FILE_ID }
+
+      let(:file_contents) { File.read "#{TEMP}/#{FILENAME}" }
+
+      it "downloads the file without prompting" do
+        expect(file_contents).to eq SINGLE_FILE_CONTENTS
+      end
+    end
+  end
+end

data/spec/gistribute/cli_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Gistribute::CLI do
+  before { suppress_stdout }
+
+  %w[install upload].each do |subcmd|
+    describe "the `#{subcmd}` subcommand" do
+      context "when no argument is provided" do
+        it "shows the help screen" do
+          allow(OptimistXL).to receive(:educate).and_call_original
+          run subcmd, fail_on_exit: false
+
+          expect(OptimistXL).to have_received :educate
+        end
+      end
+    end
+  end
+
+  context "when run with the `--version` flag" do
+    let :version do
+      File.read(File.expand_path("../../VERSION", __dir__)).strip
+    end
+
+    it "outputs the version number" do
+      expect { run "--version", fail_on_exit: false }
+        .to output(a_string_matching(version)).to_stdout
+    end
+  end
+end