gistribute 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 943e1cbafa8fcd6769fdf9e11c4770a7589335247b4232fa4f37c7720cfb3769
-  data.tar.gz: 1d4fe35b75840e4d8f9a2510616790fdafe9e7b216422514736f9d82943f7dc4
+  metadata.gz: 54d0c1a3f95efadf4af148ba00f9c52f66bc80b4f979d357a7430c5c412e96ab
+  data.tar.gz: 49fafdc9abd4ba1d994f796cf047c925159ee3d9bf9128386a8e3341fff04194
 SHA512:
-  metadata.gz: 84563d81f9d47098a8a6a48b64c20a606f0831a34cf2d9fc3b150c0dd6e25cc9728103e0e3e7648a5e154f81c1ddc7ac2a7670d8d753689693f9d6f4b966dc52
-  data.tar.gz: ad01c45e1e7adcd4650ac23fcf0ed6c3f72112837639874350a3a22e1bc655e1369e26341d11b5d9a388d89e2e5f525697474235a7f503e16d08f63879be70ca
+  metadata.gz: 4d01816a4228bf6041d1b6753b77655ce613166e4bdc8772a9d2e8482d1031fde7b3607c9664ccbd855b85d4e84ed82805dec1401f9d7a9c99af75fdd7991e4a
+  data.tar.gz: 83041e56c9d92034509149eb5a1968cdfea92dba1b15d3d66751b3597d2c602940e078a9eed2af3fd92f191cc9a05d9ad41687be5538180c9180c2bf53bef08e

data/.github/workflows/blocking-issues.yml

@@ -0,0 +1,14 @@
+name: Blocking Issues
+
+on:
+  issues:
+    types: [opened, edited, deleted, transferred, closed, reopened]
+  pull_request_target:
+    types: [opened, edited, closed, reopened]
+
+jobs:
+  blocking_issues:
+    runs-on: ubuntu-latest
+    name: Check for blocking issues
+    steps:
+      - uses: Levi-Lesches/blocking-issues@v2

data/.github/workflows/lint.yml

@@ -0,0 +1,17 @@
+on: [push, pull_request]
+
+name: Lint
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+on: [push, pull_request]
+
+name: Test
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      GISTRIBUTE_TEST_OAUTH_TOKEN: ${{ secrets.GISTRIBUTE_TEST_OAUTH_TOKEN }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Check for focused tests
+        run: bundle exec rubocop --only RSpec/Focus
+      - name: Run tests
+        run: bundle exec rspec --format doc

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Don't push Gemfile.lock on a RubyGem
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,94 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Layout/TrailingWhitespace:
+  AllowInHeredoc: false
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Security/Eval:
+  Exclude:
+    - lib/cli.rb
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+Style/NestedTernaryOperator:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/RequireOrder:
+  Enabled: true
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -1,13 +1,14 @@
-# Gistribute
+# gistribute
 
-Gistribute is a simple file distribution system based on GitHub's Gist service.
+gistribute is a simple file distribution system based on [GitHub
+Gists](https://gist.github.com/).
 
-I decided to make Gistribute when I found myself sharing configuration files
+I decided to make gistribute when I found myself sharing configuration files
 and such with others by placing all of them into a Gist along with a little
-Bash script that curled all of the files, via their raw URLs, to the right
-location on the other's computer. This program removed the need to make that
-script, and the need to update the raw URLs in that script whenever you make
-a tweak to one of the files that you're sharing.
+Bash script that `curl`ed all of the files, via their raw URLs, to the right
+location on the other's computer. This program removes the need to make that
+script, and the need to update the raw URLs in that script whenever you edit
+a file in the Gist.
 
 ## Installation
 
@@ -17,30 +18,38 @@ gem install gistribute
 
 ## How It Works
 
-Gistribute looks at the filename that you enter on Gist to find all of the
+gistribute looks at the filename that you enter on Gist to find all of the
 data that it needs to download the file to the other user's computer. It
-allows you to choose what Gistribute will call the file when it is installing
+allows you to choose what gistribute will call the file when it is installing
 it, and where it will install the file.
 
-## Usage
-
-If, for example, you were sharing a .vimrc file, and you wanted Gistribute to
+If, for example, you were sharing a `~/.vimrc` file, and you wanted gistribute to
 call it "Vim configuration" when it was installing it, you would name the file
-`Vim configuration||~|.vimrc`. If the filename contains the sequence `||`,
+`Vim configuration || ~|.vimrc`. If the filename contains the sequence `||`,
 anything before that will be considered the description of that file, and
-anything after it the installation path. If there is no `||`, Gistribute will
+anything after it the installation path. If there is no `||`, gistribute will
 use the name of the file (without the path to it) as the default description.
 
-The file path separator is the pipe character because GitHub Gist doesn't
-allow slashes in filenames- this quirk is the result of Gist actually saving
-those files to a Git repository on their servers, and handling slashes in
-file names can't possibly be very nice.
+## Usage
+
+### Uploads
+
+To upload a gistribution, use the `upload` subcommand and pass in as many files
+or directories as you would like. Directories will be recursively processed and
+uploaded. The install paths will be the same ones that were used on your
+system. The home directory will be handled automatically.
+
+```sh
+gistribute upload ~/.bashrc ~/.bash_profile
+```
+
+### Downloads
 
-If the resulting Gist link was, for example, https://gist.github.com/123456,
-the user would be able to run either of these commands to download the file
-to `~/.vimrc`:
+If the resulting Gist link was, for example, `https://gist.github.com/user/123456`,
+the receiver would be able to run either of these commands to download the files
+to `~/.bashrc` and `~/.bash_profile`:
 
 ```sh
-gistribute 123456
-gistribute https://gist.github.com/123456
+gistribute install 123456
+gistribute install https://gist.github.com/user/123456
 ```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler"
 Bundler::GemHelper.install_tasks
 

data/VERSION

@@ -1 +1 @@
-0.2
+0.3

data/bin/gistribute

@@ -1,86 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "colorize"
-require "fileutils"
-require "json"
-require "open-uri"
+require "gistribute"
 
-# Print to STDOUT to clear line
-CLEAR = "\r\e[K"
-
-if %w[-v --version].include? ARGV.first
-  puts "Gistribute #{File.read(File.expand_path("../../VERSION", __FILE__)).strip}"
-  exit 0
-end
-
-print "Downloading data..."
-
-# The user can pass in either just the ID or the entire URL to the Gist.
-id = ARGV.first[/(^|\/)([[:xdigit:]]+)/, 2]
-
-begin
-  gist = JSON.parse(URI.open("https://api.github.com/gists/#{id}").read)
-rescue OpenURI::HTTPError => msg
-  print <<~EOS.red
-    #{CLEAR}There was an error downloading the requested Gist.
-    The error is as follows:
-  EOS
-  puts msg
-
-  puts "The ID that was queried is:".red
-  puts id
-
-  exit -1
-end
-
-# The JSON data contains a lot of information. The information that is
-# relevant to this program is as follows:
-#
-# {
-#   "html_url" => "Link to the Gist",
-#   "description" => "The description for the Gist",
-#
-#   "owner" => nil, # IF ANONYMOUS
-#   "owner" => {    # IF TIED TO A USER
-#     "login" => "username"
-#   },
-#
-#   "files" => {
-#     "filename of first file" => {
-#       "content" => "entire contents of the file"
-#     }
-#     # Repeat the above for every file in the Gist.
-#   }
-# }
-
-# Regular expression word wrap to keep lines less than 80 characters. Then
-# check to see if it's empty- if not, put newlines on each side so that it
-# will be padded when displayed in the output.
-desc = gist["description"].gsub(/(.{1,79})(\s+|\Z)/, "\\1\n").strip
-desc = "\n#{desc}\n" unless desc.empty?
-
-puts <<~EOS
-  #{CLEAR}Finished downloading Gist from: #{gist["html_url"]}
-  Gist uploaded by #{
-    gist["owner"] ? "user #{gist["owner"]["login"]}" : "an anonymous user"
-  }.
-  #{desc}
-  Beginning install...
-EOS
-
-gist["files"].each do |filename, data|
-  metadata = filename.split("||").map &:strip
-
-  # | as path separator in the Gist's file name, as Gist doesn't allow the
-  # usage of /.
-  path = metadata.last.gsub(/[~|]/, "|" => "/", "~" => Dir.home)
-  # Default description is the name of the file.
-  description = metadata.size == 1 ? File.basename(path) : metadata.first
-
-  puts " #{"*".green} Installing #{description}..."
-
-  # Handle directories that don't exist.
-  FileUtils.mkdir_p File.dirname(path)
-
-  File.write(path, data["content"])
-end
+Gistribute::CLI.new.run

data/gistribute.gemspec

@@ -1,10 +1,13 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |gem|
   gem.name = "gistribute"
-  gem.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  gem.version = File.read(File.expand_path("VERSION", __dir__)).strip
 
   gem.author = "Vinny Diehl"
   gem.email = "vinny.diehl@gmail.com"
-  gem.homepage = "https://github.com/gbchaosmaster/gistribute"
+  gem.homepage = "https://github.com/vinnydiehl/gistribute"
+  gem.metadata["rubygems_mfa_required"] = "true"
 
   gem.license = "MIT"
 
@@ -13,13 +16,17 @@ Gem::Specification.new do |gem|
 
   gem.bindir = "bin"
   gem.executables = %w[gistribute]
-
-  gem.test_files = Dir["spec/**/*"]
-  gem.files = Dir["bin/**/*"] + gem.test_files + %w[
-    LICENSE Rakefile README.md VERSION gistribute.gemspec
-  ]
+  gem.files = `git ls-files -z`.split "\x0"
 
   gem.add_dependency "colorize", "~> 1.0"
+  gem.add_dependency "faraday-retry", "~> 2.2"
+  gem.add_dependency "launchy", "~> 2.5"
+  gem.add_dependency "octokit", "~> 6.1"
+  gem.add_dependency "optimist_xl", "~> 3.3"
+
   gem.add_development_dependency "fuubar", "~> 2.0"
   gem.add_development_dependency "rspec", "~> 3.12"
+  gem.add_development_dependency "rubocop", "~> 1.54"
+  gem.add_development_dependency "rubocop-rspec", "~> 2.22"
+  gem.add_development_dependency "yard", "~> 0.9"
 end

data/lib/cli/auth.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Gistribute
+  class CLI
+    def authenticate
+      access_token = if File.exist?(CONFIG_FILE)
+        File.read(CONFIG_FILE).strip
+      else
+        device_res = URI.decode_www_form(
+          Net::HTTP.post_form(
+            URI("https://github.com/login/device/code"), "client_id" => CLIENT_ID, "scope" => "gist"
+          ).body
+        ).to_h
+
+        retry_interval = device_res["interval"].to_i
+
+        Launchy.open(device_res["verification_uri"])
+        puts <<~EOS
+          Opening GitHub, please enter the authentication code: #{device_res['user_code']}
+          If your browser did not open, visit #{device_res['verification_uri']}
+        EOS
+
+        uri = URI("https://github.com/login/oauth/access_token")
+
+        # Keep trying until the user enters the code or the device code expires
+        token = nil
+        loop do
+          sleep(retry_interval)
+
+          response = URI.decode_www_form(
+            Net::HTTP.post_form(
+              uri, "client_id" => CLIENT_ID, "device_code" => device_res["device_code"],
+                   "grant_type" => "urn:ietf:params:oauth:grant-type:device_code"
+            ).body
+          ).to_h
+
+          if (token = response["access_token"])
+            File.write(CONFIG_FILE, token)
+            break
+          elsif response["error"] == "authorization_pending"
+            # The user has not yet entered the code; keep waiting silently
+            next
+          elsif response["error"] == "expired_token"
+            panic! "Token expired! Please try again."
+          else
+            panic! response["error_description"]
+          end
+        end
+
+        token
+      end
+
+      @client = Octokit::Client.new(access_token:)
+
+      success_message = "Logged in as #{@client.user.login}."
+      if @subcommand == "login"
+        puts success_message.green
+      else
+        puts success_message
+        puts
+      end
+    end
+  end
+end

data/lib/cli/install.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Gistribute
+  class CLI
+    def install
+      print "Downloading data..."
+
+      id = Gistribute.parse_id(ARGV.first)
+
+      begin
+        gist = @client.gist(id)
+      rescue Octokit::Error => e
+        $stderr.print <<~EOS.chop.red
+          \rThere was an error downloading the requested Gist.
+          The error is as follows:
+        EOS
+        $stderr.puts " #{e.response_status} #{JSON.parse(e.response_body)['message']}"
+
+        $stderr.print "The ID that was queried is: ".red
+        $stderr.puts id
+
+        exit 1
+      end
+
+      # Regular expression word wrap to keep lines less than 80 characters. Then
+      # check to see if it's empty- if not, put newlines on each side so that it
+      # will be padded when displayed in the output.
+      gist_description = gist.description.gsub(/(.{1,79})(\s+|\Z)/, "\\1\n").strip
+      gist_description = "\n#{gist_description}\n" unless gist_description.empty?
+
+      # Process files
+      files = gist.files.map do |filename, data|
+        metadata = filename.to_s.split("||").map(&:strip)
+
+        # | as path separator in the Gist's file name, as Gist doesn't allow the
+        # usage of /.
+        path = Gistribute.decode(metadata.last)
+        # Default description is the name of the file.
+        description = metadata.size == 1 ? File.basename(path) : metadata.first
+
+        { description:, path:, content: data[:content] }
+      end
+
+      puts <<~EOS
+        \rFinished downloading Gist from: #{gist.html_url}
+        Gist uploaded by #{
+          gist.owner ? "user #{gist.owner[:login]}" : 'an anonymous user'
+        }.
+        #{gist_description}
+      EOS
+
+      unless @subcommand_options.yes
+        puts "Files:"
+
+        files.each do |f|
+          print "#{f[:description]}: " unless f[:description].empty?
+          puts f[:path]
+        end
+      end
+
+      if @subcommand_options.yes || confirm?("\nWould you like to install these files? [Yn] ")
+        puts unless @subcommand_options.yes
+
+        files.each do |f|
+          if File.exist?(f[:path]) && !@subcommand_options.force &&
+             !confirm?("File already exists: #{f[:path]}\nWould you like to overwrite it? [Yn] ")
+            puts " #{'*'.red} #{f[:description]} skipped."
+            next
+          end
+
+          # Handle directories that don't exist.
+          FileUtils.mkdir_p File.dirname(f[:path])
+          File.write(f[:path], f[:content])
+
+          # If using `--yes`, we print the path in the this string rather than
+          # above with the prompt
+          puts " #{'*'.green} #{f[:description]} installed#{
+            @subcommand_options.yes ? " to: #{f[:path]}" : '.'
+          }"
+        end
+      else
+        puts "Aborting.".red
+      end
+    end
+  end
+end

data/lib/cli/upload.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Gistribute
+  class CLI
+    def upload
+      files_json = process_files(@files)
+
+      if files_json.empty?
+        panic! "No files found, aborting."
+      end
+
+      if @subcommand_options.yes || confirm?("\nUpload these files? [Yn] ")
+        gist = @client.create_gist({
+          description: "[gistribution] #{@subcommand_options.description}".strip,
+          public: !@subcommand_options.private,
+          files: files_json
+        })
+
+        puts if @subcommand_options.yes
+        print "Gistribution uploaded to: ".green
+        puts gist.html_url
+      else
+        puts "Aborted.".red
+      end
+    end
+
+    def process_files(files)
+      files.each_with_object({}) do |file, hash|
+        hash.merge!(process_file file)
+      end
+    end
+
+    def process_file(file)
+      file = File.expand_path(file)
+
+      if File.directory?(file)
+        # Recursively process every file in the directory
+        process_files(
+          Dir.glob("#{file}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory? f }
+        )
+      else
+        unless (content = File.read(file))
+          panic! "Files cannot be empty."
+        end
+
+        puts "File: #{file}"
+        desc = get_input("Enter pretty file name (leave blank to use raw file name): ")
+
+        # Return a hash directly for single files
+        { "#{"#{desc} || " unless desc.empty?}#{Gistribute.encode file}" => { content: } }
+      end
+    end
+  end
+end