neocities 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eed39701962669f623a0c0c5a765a47f2e3c675a5b6c58ff5783bd745aac1355
-  data.tar.gz: a92dced052ec57bf28cd0375b236b2fddd8f21160b13f99cb9c6f53b3b5326f6
+  metadata.gz: c97aed183932a987e86e2fd59f8001620c800007f3365552642d8a43d8a24a6d
+  data.tar.gz: 2eeba231d12c9a8d87db79b7324141b3439c6b67d95b8257cba15fece01b3d1f
 SHA512:
-  metadata.gz: 68cdc534f9d0a35f4c0c1fe41abb7110e69a282673b908cf5757c11e803a3f431d6ecf7dd58d551a66637b27b503c3b8a6dd96d8e76dadbe6cf9b774e216c4b4
-  data.tar.gz: 44aa22f8c174a79b0e5b2caaa8da8cab2be56777610386c55da61456b5434bf3a6f9e016a84e35a1c7c559733d93537f142614e649c9cf6f6fad07e57f03a83c
+  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

@@ -41,6 +41,8 @@ module Neocities
     end
 
     def run
+      display_sign_in_status if @argv.empty?
+
       if @argv[0] == 'version'
         puts Neocities::VERSION
         exit
@@ -54,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
@@ -69,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|
@@ -121,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
@@ -561,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
@@ -575,6 +609,9 @@ 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

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.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neocities
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kyle Drake