gistribute 0.2 → 0.3

data/spec/gistribute/cli_upload_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+ENCODED_TEMP = "|tmp|gistribute_spec"
+
+SINGLE_FILE_PATH = "#{TEMP}/#{FILENAME}".freeze
+ENCODED_SINGLE_FILE_PATH = "#{ENCODED_TEMP}|#{FILENAME}".freeze
+HOME_FILE_PATH = "#{Dir.home}/#{FILENAME}".freeze
+ENCODED_HOME_FILE_PATH = "~|#{FILENAME}".freeze
+
+SINGLE_FILE_CONTENT = "Line 1\nLine 2\n"
+SINGLE_FILE_DESC = "Test File"
+
+MOCK_GIST_URL = "https://gist.github.com/vinnydiehl/thisisnotarealgistid"
+
+describe Gistribute::CLI do
+  let(:octokit_client) { instance_double(Octokit::Client) }
+
+  before do
+    FileUtils.rm_rf TEMP
+    FileUtils.mkdir_p TEMP
+
+    allow(Octokit::Client).to receive(:new).and_return(octokit_client)
+    allow(octokit_client).to receive(:user).and_return(double(login: "test"))
+    allow(octokit_client).to receive(:create_gist).and_return(double(html_url: MOCK_GIST_URL))
+
+    suppress_stdout
+  end
+
+  after { FileUtils.rm_rf TEMP }
+
+  describe "#upload" do
+    before { allow($stdout).to receive(:puts) }
+
+    context "with a single file" do
+      before do
+        File.write(SINGLE_FILE_PATH, SINGLE_FILE_CONTENT)
+        simulate_user_input "Test File\n", "y\n"
+        run "upload", SINGLE_FILE_PATH
+      end
+
+      let :expected_api_call do
+        {
+          description: "[gistribution]",
+          public: true,
+          files: {
+            "#{SINGLE_FILE_DESC} || #{ENCODED_SINGLE_FILE_PATH}" => {
+              content: SINGLE_FILE_CONTENT
+            }
+          }
+        }
+      end
+
+      it "uploads the file correctly" do
+        expect(octokit_client).to have_received(:create_gist)
+          .with(expected_api_call)
+      end
+
+      it "prints the URL of the Gist" do
+        expect($stdout).to have_received(:puts).with MOCK_GIST_URL
+      end
+    end
+
+    context "with a single file in the home directory" do
+      before do
+        File.write(HOME_FILE_PATH, SINGLE_FILE_CONTENT)
+        simulate_user_input "Test File\n", "y\n"
+        run "upload", "~/#{FILENAME}"
+      end
+
+      after { FileUtils.rm HOME_FILE_PATH }
+
+      let :expected_api_call do
+        {
+          description: "[gistribution]",
+          public: true,
+          files: { "#{SINGLE_FILE_DESC} || #{ENCODED_HOME_FILE_PATH}" => { content: SINGLE_FILE_CONTENT } }
+        }
+      end
+
+      it "uploads the file correctly" do
+        expect(octokit_client).to have_received(:create_gist)
+          .with(expected_api_call)
+      end
+    end
+
+    {
+      "multiple files": ["#{TEMP}/dir/file1", "#{TEMP}/file2"],
+      "a directory containing multiple files": [TEMP]
+    }.each do |desc, args|
+      context "with #{desc} passed in" do
+        let(:file1_content) { "F1L1\nF1L2\n" }
+        let(:file2_content) { "F2L1\nF2L2\n" }
+
+        before do
+          FileUtils.mkdir_p "#{TEMP}/dir"
+          File.write("#{TEMP}/dir/file1", file1_content)
+          File.write("#{TEMP}/file2", file2_content)
+
+          simulate_user_input "File 1\n", "File 2\n", "y\n"
+          run "upload", *args
+        end
+
+        let :expected_api_call do
+          {
+            description: "[gistribution]",
+            public: true,
+            files: {
+              "File 1 || #{ENCODED_TEMP}|dir|file1" => { content: file1_content },
+              "File 2 || #{ENCODED_TEMP}|file2" => { content: file2_content }
+            }
+          }
+        end
+
+        it "uploads the files correctly" do
+          expect(octokit_client).to have_received(:create_gist)
+            .with(expected_api_call)
+        end
+      end
+    end
+
+    context "with the `--description` flag" do
+      before do
+        File.write(SINGLE_FILE_PATH, SINGLE_FILE_CONTENT)
+        simulate_user_input "Test File\n", "y\n"
+        run "upload", "--description", "foo bar", SINGLE_FILE_PATH
+      end
+
+      it "uses the given description" do
+        expect(octokit_client).to have_received(:create_gist)
+          .with(a_hash_including(description: "[gistribution] foo bar"))
+      end
+    end
+
+    context "with the `--private` flag" do
+      before do
+        File.write(SINGLE_FILE_PATH, SINGLE_FILE_CONTENT)
+        simulate_user_input "Test File\n", "y\n"
+        run "upload", "--private", SINGLE_FILE_PATH
+      end
+
+      it "uploads a private Gist" do
+        expect(octokit_client).to have_received(:create_gist)
+          .with(a_hash_including(public: false))
+      end
+    end
+
+    context "with the `--yes` flag" do
+      before do
+        File.write(SINGLE_FILE_PATH, SINGLE_FILE_CONTENT)
+        simulate_user_input "Test File\n"
+        run "upload", "--yes", SINGLE_FILE_PATH
+      end
+
+      it "uploads without prompting the user" do
+        expect(octokit_client).to have_received(:create_gist)
+      end
+    end
+  end
+end

data/spec/gistribute_spec.rb

@@ -1,33 +1,21 @@
-require "fileutils"
+# frozen_string_literal: true
 
-TEMP = "/tmp/gistribute_spec"
+require "spec_helper"
 
-describe "gistribute" do
-  # Make sure we start and end with a clean `/tmp`
-  before { FileUtils.rm_rf TEMP }
-  after { FileUtils.rm_rf TEMP }
-
-  BAD_LINK = "bad_link"
-  let(:output_404) { `gistribute #{BAD_LINK}` }
-
-  let(:output) { `gistribute https://gist.github.com/4346763` }
-  let(:output_only_id) { `gistribute 4346763` }
-
-  let :version do
-    File.read(File.expand_path("../../VERSION", __FILE__)).strip
-  end
-
-  %w[--version -v].each do |flag|
-    context "with the #{flag} flag" do
-      it "outputs the version" do
-        expect(`gistribute #{flag}`).to eq "Gistribute #{version}\n"
+describe Gistribute do
+  describe "::parse_id" do
+    [PUB_SINGLE_FILE_ID, SEC_SINGLE_FILE_ID].each do |id|
+      [
+        "https://gist.github.com/username/#{id}",
+        "https://gist.github.com/#{id}",
+        id
+      ].each do |link|
+        context "when given the String: #{link}" do
+          it "parses down to the Gist ID" do
+            expect(described_class.parse_id(link)).to eq(id)
+          end
+        end
       end
     end
   end
-
-  context "with a single file Gist" do
-    it "allows both the full URL and the Gist ID" do
-      expect(output).to eq output_only_id
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "gistribute"
+
+# Get OAuth token from environment if there is none
+unless File.exist?(CONFIG_FILE)
+  File.write(CONFIG_FILE, ENV.fetch("GISTRIBUTE_TEST_OAUTH_TOKEN"))
+end
+
+# Yes, this could be leaked in CI, but it's just a gist scoped token for a dummy account
+OAUTH_TOKEN = File.read(CONFIG_FILE).freeze
+
+# Include all files in spec/support
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |f| require f }
+
+RSpec.configure do |config|
+  # Add `focus: true` hash parameter to a describe/context/it block
+  # to only run the specs in that block
+  config.filter_run_when_matching :focus
+
+  # Fuubar
+  unless ARGV.any? { |arg| arg.include? "-f" }
+    config.add_formatter "Fuubar"
+    config.fuubar_progress_bar_options = { format: "  %c/%C |%b>%i|%e " }
+  end
+
+  # More verbose output if only running one spec
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, fix the order by providing the seed,
+  # which is printed after each run, e.g. --seed 1234
+  config.order = :random
+  Kernel.srand config.seed
+end

data/spec/support/cli.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+def suppress_stdout
+  allow($stdout).to receive(:write)
+end
+
+def set_argv(*args)
+  ARGV.replace(args)
+end
+
+def run(*args, fail_on_exit: true)
+  set_argv(*args)
+
+  begin
+    Gistribute::CLI.new.run
+  rescue SystemExit
+    fail "unexpected exit" if fail_on_exit
+  end
+end
+
+def simulate_user_input(*inputs)
+  # The reference to `inputs` ends up getting stored in the mock, since
+  # it's passed in with the block. Each time `gets` is called we pull
+  # one off the beginning. If there aren't enough inputs, the error
+  # gets raised.
+  allow($stdin).to receive(:gets) { inputs.shift || fail("blocked for input") }
+end

data/spec/support/constants.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+TEMP = "/tmp/gistribute_spec"
+FILENAME = "test.file"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gistribute
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Vinny Diehl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-18 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,6 +24,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: optimist_xl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +108,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.54'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Distribute files simply using GitHub Gist.
 email: vinny.diehl@gmail.com
 executables:
@@ -59,17 +157,37 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/blocking-issues.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - bin/gistribute
 - gistribute.gemspec
+- lib/cli.rb
+- lib/cli/auth.rb
+- lib/cli/install.rb
+- lib/cli/upload.rb
+- lib/gistribute.rb
+- spec/.rubocop.yml
+- spec/gistribute/cli_auth_spec.rb
+- spec/gistribute/cli_install_spec.rb
+- spec/gistribute/cli_spec.rb
+- spec/gistribute/cli_upload_spec.rb
 - spec/gistribute_spec.rb
-homepage: https://github.com/gbchaosmaster/gistribute
+- spec/spec_helper.rb
+- spec/support/cli.rb
+- spec/support/constants.rb
+homepage: https://github.com/vinnydiehl/gistribute
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -89,5 +207,4 @@ rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: GitHub Gist based file distribution.
-test_files:
-- spec/gistribute_spec.rb
+test_files: []