neocities 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75778a49007c276652438d9c1cf7a240e10dc64a854727bd65c5ed16726ae325
-  data.tar.gz: 87e20c5770a3640ff2a93fc30cbd4b954ae0b6203205eb7ab909f59fd33b0611
+  metadata.gz: c97aed183932a987e86e2fd59f8001620c800007f3365552642d8a43d8a24a6d
+  data.tar.gz: 2eeba231d12c9a8d87db79b7324141b3439c6b67d95b8257cba15fece01b3d1f
 SHA512:
-  metadata.gz: 123afaa9c3cd1852be80b521ef53609f79acb4ac214938de5e777b056fc950d3be7e46165bfc57c3428eb9d97074b0153d0debe3957caaf0bfefedbfb5ca19a8
-  data.tar.gz: 35372d8ed14ed95325747e5ab8d1c0fcf33364f8b810dabd137284449d28ecc89756335661a571c6cff1b4cae2ef73bbd244b684b4f40d3c4fa658a31def668d
+  metadata.gz: 3362281d36af925b2580a1b9c7dbc2ed1fbdef24287f9315c66bc3a45096388695a19a540d3a981d43199e3f427e6a30d1765372e34776cc836829d6ac038654
+  data.tar.gz: a3a969acf5a81ca16d3ae59184a361088831ce5d666a7a70f17a7219dbaaedfb5a5ab6d5fc1365f7516ddbc24bd136b43d7311dbdfbd9e3ba5c5a00a1cc58a16

data/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
 gemspec
+gem 'minitest', '>= 5', '< 7'

data/README.md

@@ -22,6 +22,14 @@ Install ruby with [RubyInstaller](https://rubyinstaller.org/). Then you can inst
 
 After that, you are all set! Run `neocities` in a command line to see the options and get started.
 
+### Authentication
+
+The CLI uses an API key and never asks for your Neocities password. Create or copy a key from your site's [settings](https://neocities.org/settings), then paste it into the prompt the first time you run a command. The key is stored in your local Neocities config for later commands.
+
+For CI or other automation, set `NEOCITIES_API_KEY` instead. Keys supplied through the environment are not saved locally.
+
+Run `neocities logout -y` to remove a saved key from the computer. Regenerate the key in your site settings if you need to revoke it everywhere.
+
 ## Neocities::Client
 
 This gem also ships with Neocities::Client, which you can use to write code that interfaces with the Neocities API.

data/lib/neocities/cli.rb

@@ -14,6 +14,7 @@ module Neocities
     HELP_SUBCOMMANDS = ['-h', '--help', 'help']
     PENELOPE_MOUTHS = %w{^ o ~ - v U}
     PENELOPE_EYES = %w{o ~ O}
+    ALWAYS_EXCLUDED_PUSH_DIRECTORIES = %w{.git}.freeze
 
     def initialize(argv)
       @argv = argv.dup
@@ -40,6 +41,8 @@ module Neocities
     end
 
     def run
+      display_sign_in_status if @argv.empty?
+
       if @argv[0] == 'version'
         puts Neocities::VERSION
         exit
@@ -53,13 +56,15 @@ module Neocities
         send "display_#{@subcmd}_help_and_exit"
       end
 
+      return logout if @subcmd == 'logout'
+
       if !@api_key
         begin
           file = File.read @app_config_path
           data = JSON.load file
 
           if data
-            @api_key = data["API_KEY"].strip # Remove any trailing whitespace causing HTTP requests to fail
+            @api_key = data["API_KEY"]&.strip # Remove any trailing whitespace causing HTTP requests to fail
             @sitename = data["SITENAME"] # Store the sitename to be able to reference it later
             @last_pull = data["LAST_PULL"] # Store the last time a pull was performed so that we only fetch from updated files
           end
@@ -68,38 +73,45 @@ module Neocities
         end
       end
 
-      if @api_key.nil?
-        puts "Please login to get your API key:"
+      prompted_for_api_key = false
+      if @api_key.nil? || @api_key.empty?
+        puts 'Please enter your Neocities API key.'
+        puts 'Create or copy one from https://neocities.org/settings'
+        @api_key = @prompt.mask('API key:').to_s.strip
+        prompted_for_api_key = true
+      end
+
+      @client = build_client @api_key
 
-        if !@sitename && !@password
-          @sitename = @prompt.ask('sitename:', default: ENV['NEOCITIES_SITENAME'])
-          @password = @prompt.mask('password:', default: ENV['NEOCITIES_PASSWORD'])
+      if prompted_for_api_key || @sitename.nil?
+        resp = @client.info
+        if resp[:result] == 'error'
+          display_response resp
+          exit
         end
 
-        @client = Neocities::Client.new sitename: @sitename, password: @password
+        @sitename = resp[:info][:sitename]
+      end
 
-        resp = @client.key
-        if resp[:api_key]
-          conf = {
-            "API_KEY": resp[:api_key],
-            "SITENAME": @sitename,
-          }
+      if prompted_for_api_key
+        conf = {
+          "API_KEY": @api_key,
+          "SITENAME": @sitename,
+        }
 
-          FileUtils.mkdir_p Pathname(@app_config_path).dirname
-          File.write @app_config_path, conf.to_json
+        FileUtils.mkdir_p Pathname(@app_config_path).dirname
+        File.write @app_config_path, conf.to_json
 
-          puts "The api key for #{@pastel.bold @sitename} has been stored in #{@pastel.bold @app_config_path}."
-        else
-          display_response resp
-          exit
-        end
-      else
-        @client = Neocities::Client.new api_key: @api_key
+        puts "The API key for #{@pastel.bold @sitename} has been stored in #{@pastel.bold @app_config_path}."
       end
 
       send @subcmd
     end
 
+    def build_client(api_key)
+      Neocities::Client.new api_key: api_key
+    end
+
     def delete
       display_delete_help_and_exit if @subargs.empty?
       @subargs.each do |file|
@@ -120,8 +132,8 @@ module Neocities
         end
       end
       if confirmed
-        FileUtils.rm @app_config_path
-        puts @pastel.bold("Your api key has been removed.")
+        FileUtils.rm_f @app_config_path
+        puts @pastel.bold("Your API key has been removed.")
       else
         display_logout_help_and_exit
       end
@@ -245,6 +257,7 @@ module Neocities
 
       Dir.chdir(root_path) do
         paths = Dir.glob(File.join('**', '*'), File::FNM_DOTMATCH)
+        paths.reject! { |path| always_excluded_push_path?(path) }
 
         if @no_gitignore == false
           begin
@@ -559,6 +572,29 @@ HERE
 HERE
     end
 
+    def display_sign_in_status
+      config = {}
+      begin
+        config = JSON.parse File.read(@app_config_path)
+      rescue SystemCallError, JSON::ParserError
+        # Status should still be available without a readable config.
+      end
+      config = {} unless config.is_a?(Hash)
+      saved_key = config['API_KEY'].to_s.strip
+      environment_key = ENV['NEOCITIES_API_KEY']
+
+      status = if environment_key && environment_key != saved_key
+        environment_key.empty? ? 'Signed out' : 'Using NEOCITIES_API_KEY (username not loaded)'
+      elsif saved_key.empty?
+        'Signed out'
+      elsif config['SITENAME'].to_s.empty?
+        'API key saved (username not loaded)'
+      else
+        "Signed in as: #{config['SITENAME']}"
+      end
+      puts @pastel.cyan.bold(status)
+    end
+
     def display_help_and_exit
       display_banner
       puts <<HERE
@@ -573,10 +609,19 @@ HERE
     pull        Get the most recent version of files from your site
     pizza       Order a free pizza
 
+  The first command asks for an API key from your site settings.
+  Set NEOCITIES_API_KEY to use a key without saving it locally.
+
 HERE
       exit
     end
 
+    def always_excluded_push_path?(path)
+      Pathname.new(path).each_filename.any? do |filename|
+        ALWAYS_EXCLUDED_PUSH_DIRECTORIES.include?(filename)
+      end
+    end
+
     def self.app_config_path(name)
       platform = if RUBY_PLATFORM =~ /win32/
         :win32
@@ -616,4 +661,4 @@ HERE
       end
     end
   end
-end
+end

data/lib/neocities/client.rb

@@ -151,7 +151,9 @@ module Neocities
       post 'delete', 'filenames[]' => paths
     end
 
-    def info(sitename)
+    def info(sitename=nil)
+      return get 'info' if sitename.nil?
+
       get 'info', sitename: sitename
     end
 
@@ -168,4 +170,4 @@ module Neocities
       JSON.parse resp.body, symbolize_names: true
     end
   end
-end
+end

data/lib/neocities/version.rb

@@ -1,3 +1,3 @@
 module Neocities
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/neocities.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-prompt',          '~> 0.23', '= 0.23.1'
   spec.add_dependency 'pastel',              '~> 0.8',  '= 0.8.0'
   spec.add_dependency 'http',                '~> 5.3',  '>= 5.3.1'
+  spec.add_dependency 'http-cookie',         '~> 1.0',  '< 1.1.1'
   spec.add_dependency 'rake',                '~> 13',   '>= 13.3.0'
   spec.add_dependency 'whirly',              '~> 0.3',  '>= 0.3.0'
   spec.add_dependency 'openssl',             '~> 3.3',  '>= 3.3.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neocities
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kyle Drake
@@ -89,6 +89,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.1
+- !ruby/object:Gem::Dependency
+  name: http-cookie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Neocities.org CLI and API client
 test_files: []