neocities 0.0.18 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 322b624aea971dd7a650eac8a9b6011e0f3d13ff8e4a5bb2f1a423b87bb446ac
-  data.tar.gz: c28f4d3296f36bb8a556fa210cc79a19a765e511fbf3b45111f93738b26014d4
+  metadata.gz: 5031613f2ead49cb8b0d897ba928dca50121afbc65b0f624afd89038c6f97c3e
+  data.tar.gz: 3f6a7813f75c2d0d667700258a5f2a9a60b74176b69cee5c1d26d95892970a91
 SHA512:
-  metadata.gz: ec195af25579bd74b8763ec1bc2d997ede505157fb2e6da9e27bfc4854a03526c57d8d05c593e9a10bfa8c0597649f75be03962d338933cbf763c9c75be9e110
-  data.tar.gz: 45ea7e5ff1bc0addafe30ca5bb9a8e3b23dabd168b01b0169ab254895d8041bb098687cfb982c5161d2d5a9d4ed2634937064c87b1f3b0bcb76b8ea1d944d031
+  metadata.gz: b1ae46e13488bbdd244da5e1f3eb005002f6a2e9a687c9682fc2055ccaf054c76de1f9386ed578b7462745acf1c53d7fac81957b41b474b2f0422ab5823d3f09
+  data.tar.gz: a72a64b9bc2ea15a3c7c6ad01f8f405802c5476e96b8975081d3e7dbef531543838eb029fcba108c7cc7a96e89725fac8855500c0c8ffd8922235f05a86fb9b9

data/Gemfile

@@ -1,2 +1,3 @@
 source 'https://rubygems.org'
+
 gemspec

data/lib/neocities/cli.rb

@@ -3,11 +3,14 @@ require 'pastel'
 require 'tty/table'
 require 'tty/prompt'
 require 'fileutils'
+require 'json' # for reading configs
+require 'whirly' # for loader spinner
+
 require File.join(File.dirname(__FILE__), 'client')
 
 module Neocities
   class CLI
-    SUBCOMMANDS = %w{upload delete list info push logout pizza}
+    SUBCOMMANDS = %w{upload delete list info push logout pizza pull}
     HELP_SUBCOMMANDS = ['-h', '--help', 'help']
     PENELOPE_MOUTHS = %w{^ o ~ - v U}
     PENELOPE_EYES = %w{o ~ O}
@@ -19,7 +22,7 @@ module Neocities
       @subargs = @argv[1..@argv.length]
       @prompt = TTY::Prompt.new
       @api_key = ENV['NEOCITIES_API_KEY'] || nil
-      @app_config_path = File.join self.class.app_config_path('neocities'), 'config'
+      @app_config_path = File.join self.class.app_config_path('neocities'), 'config.json' # added json extension
     end
 
     def display_response(resp)
@@ -42,18 +45,28 @@ module Neocities
         exit
       end
 
-      display_help_and_exit if @subcmd.nil? || @argv.include?(HELP_SUBCOMMANDS) || !SUBCOMMANDS.include?(@subcmd)
-      send "display_#{@subcmd}_help_and_exit" if @subargs.empty?
+      if HELP_SUBCOMMANDS.include?(@subcmd) && SUBCOMMANDS.include?(@subargs[0])
+        send "display_#{@subargs[0]}_help_and_exit"
+      elsif @subcmd.nil? || !SUBCOMMANDS.include?(@subcmd)
+        display_help_and_exit
+      elsif @subargs.join("").match(HELP_SUBCOMMANDS.join('|')) && @subcmd != "info"
+        send "display_#{@subcmd}_help_and_exit"
+      end
 
       if !@api_key
         begin
-          @api_key = File.read @app_config_path
-          # Remove any trailing whitespace causing HTTP requests to fail
-          @api_key = @api_key.strip
+          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
+            @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
         rescue Errno::ENOENT
           @api_key = nil
         end
-      end 
+      end
 
       if @api_key.nil?
         puts "Please login to get your API key:"
@@ -67,8 +80,14 @@ module Neocities
 
         resp = @client.key
         if resp[:api_key]
+          conf = {
+            "API_KEY": resp[:api_key],
+            "SITENAME": @sitename,
+          }
+
           FileUtils.mkdir_p Pathname(@app_config_path).dirname
-          File.write @app_config_path, resp[:api_key]
+          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
@@ -82,6 +101,7 @@ module Neocities
     end
 
     def delete
+      display_delete_help_and_exit if @subargs.empty?
       @subargs.each do |file|
         puts @pastel.bold("Deleting #{file} ...")
         resp = @client.delete file
@@ -92,16 +112,18 @@ module Neocities
 
     def logout
       confirmed = false
-      loop {
+      loop do
         case @subargs[0]
         when '-y' then @subargs.shift; confirmed = true
-        when /^-/ then puts(@pastel.red.bold("Unknown option: #{@subargs[0].inspect}")); display_logout_help_and_exit
+        when /^-/ then puts(@pastel.red.bold("Unknown option: #{@subargs[0].inspect}")); break
         else break
         end
-      }
+      end
       if confirmed
         FileUtils.rm @app_config_path
         puts @pastel.bold("Your api key has been removed.")
+      else
+        display_logout_help_and_exit
       end
     end
 
@@ -115,7 +137,7 @@ module Neocities
 
       out = []
 
-      resp[:info].each do |k,v|
+      resp[:info].each do |k, v|
         v = Time.parse(v).localtime if v && (k == :created_at || k == :last_updated)
         out.push [@pastel.bold(k), v]
       end
@@ -125,6 +147,7 @@ module Neocities
     end
 
     def list
+      display_list_help_and_exit if @subargs.empty?
       if @subargs.delete('-d') == '-d'
         @detail = true
       end
@@ -161,11 +184,12 @@ module Neocities
     end
 
     def push
+      display_push_help_and_exit if @subargs.empty?
       @no_gitignore = false
       @excluded_files = []
       @dry_run = false
       @prune = false
-      loop {
+      loop do
         case @subargs[0]
         when '--no-gitignore' then @subargs.shift; @no_gitignore = true
         when '-e' then @subargs.shift; @excluded_files.push(@subargs.shift)
@@ -174,10 +198,11 @@ module Neocities
         when /^-/ then puts(@pastel.red.bold("Unknown option: #{@subargs[0].inspect}")); display_push_help_and_exit
         else break
         end
-      }
+      end
 
-      if @dry_run
-        puts @pastel.green.bold("Doing a dry run, not actually pushing anything")
+      if @subargs[0].nil?
+        display_response result: 'error', message: "no local path provided"
+        display_push_help_and_exit
       end
 
       root_path = Pathname @subargs[0]
@@ -192,6 +217,10 @@ module Neocities
         display_push_help_and_exit
       end
 
+      if @dry_run
+        puts @pastel.green.bold("Doing a dry run, not actually pushing anything")
+      end
+
       if @prune
         pruned_dirs = []
         resp = @client.list
@@ -237,13 +266,11 @@ module Neocities
           end
         end
 
-        paths.select! {|p| !@excluded_files.include?(p)}
+        paths.select! { |p| !@excluded_files.include?(p) }
 
-        paths.select! {|p|
-          !@excluded_files.include?(Pathname.new(p).dirname.to_s)
-        }
+        paths.select! { |p| !@excluded_files.include?(Pathname.new(p).dirname.to_s) }
 
-        paths.collect! {|path| Pathname path}
+        paths.collect! { |path| Pathname path }
 
         paths.each do |path|
           next if path.directory?
@@ -266,13 +293,13 @@ module Neocities
       display_upload_help_and_exit if @subargs.empty?
       @dir = ''
 
-      loop {
+      loop do
         case @subargs[0]
         when '-d' then @subargs.shift; @dir = @subargs.shift
         when /^-/ then puts(@pastel.red.bold("Unknown option: #{@subargs[0].inspect}")); display_upload_help_and_exit
         else break
         end
-      }
+      end
 
       @subargs.each do |path|
         path = Pathname path
@@ -295,6 +322,39 @@ module Neocities
       end
     end
 
+    def pull
+      begin
+        quiet = !(['--log', '-l'].include? @subargs[0])
+
+        file = File.read @app_config_path
+        data = JSON.load file
+
+        last_pull_time = data["LAST_PULL"] ? data["LAST_PULL"]["time"] : nil
+        last_pull_loc = data["LAST_PULL"] ? data["LAST_PULL"]["loc"] : nil
+
+        Whirly.start spinner: ["😺", "😸", "😹", "😻", "😼", "😽", "🙀", "😿", "😾"], status: "Retrieving files for #{@pastel.bold @sitename}" if quiet
+        resp = @client.pull @sitename, last_pull_time, last_pull_loc, quiet
+
+        # write last pull data to file (not necessarily the best way to do this, but better than cloning every time)
+        data["LAST_PULL"] = {
+          "time": Time.now,
+          "loc": Dir.pwd
+        }
+
+        File.write @app_config_path, data.to_json
+      rescue StandardError => ex
+        Whirly.stop if quiet
+        puts @pastel.red.bold "\nA fatal error occurred :-("
+        puts @pastel.red ex
+      ensure
+        exit
+      end
+    end
+
+    def pizza
+      display_pizza_help_and_exit
+    end
+
     def display_pizza_help_and_exit
       puts "Sorry, we're fresh out of dough today. Try again tomorrow."
       exit
@@ -348,6 +408,16 @@ HERE
 
   #{@pastel.green '$ neocities upload -d images img.jpg'}   Upload img.jpg to the 'images' directory on your site
 
+HERE
+      exit
+    end
+
+    def display_pull_help_and_exit
+      display_banner
+
+      puts <<HERE
+  #{@pastel.magenta.bold 'pull'} - Get the most recent version of files from your site
+
 HERE
       exit
     end
@@ -367,7 +437,7 @@ HERE
   #{@pastel.green '$ neocities push --no-gitignore .'}                  Don't use .gitignore to exclude files
 
   #{@pastel.green '$ neocities push --dry-run .'}                       Just show what would be uploaded
-      
+
   #{@pastel.green '$ neocities push --prune .'}                         Delete site files not in dir (be careful!)
 
 HERE
@@ -423,6 +493,7 @@ HERE
     info        Information and stats for your site
     logout      Remove the site api key from the config
     version     Unceremoniously display version and self destruct
+    pull        Get the most recent version of files from your site
     pizza       Order a free pizza
 
 HERE
@@ -468,4 +539,4 @@ HERE
       end
     end
   end
-end
+end

data/lib/neocities/client.rb

@@ -8,6 +8,10 @@ require 'pathname'
 require 'uri'
 require 'digest'
 require 'httpclient'
+require 'pastel'
+require 'date'
+
+require 'whirly'
 
 module Neocities
   class Client
@@ -17,6 +21,7 @@ module Neocities
       @uri = URI.parse API_URI
       @http = HTTPClient.new force_basic_auth: true
       @opts = opts
+      @pastel = Pastel.new eachline: "\n"
 
       unless opts[:api_key] || (opts[:sitename] && opts[:password])
         raise ArgumentError, 'client requires a login (sitename/password) or an api_key'
@@ -27,13 +32,92 @@ module Neocities
       else
         @http.set_auth API_URI, opts[:sitename], opts[:password]
       end
-
     end
 
     def list(path=nil)
       get 'list', :path => path
     end
 
+    def pull(sitename, last_pull_time=nil, last_pull_loc=nil, quiet=true)
+      site_info = get 'info', sitename: sitename
+
+      if site_info[:result] == 'error'
+        raise ArgumentError, site_info[:message]
+      end
+
+      # handle custom domains for supporter accounts
+      if site_info[:info][:domain] && site_info[:info][:domain] != ""
+        domain = "https://#{site_info[:info][:domain]}/"
+      else
+        domain = "https://#{sitename}.neocities.org/"
+      end
+
+      # start stats
+      success_loaded = 0
+      start_time = Time.now
+      curr_dir = Dir.pwd
+
+      # get list of files
+      resp = get 'list'
+
+      if resp[:result] == 'error'
+        raise ArgumentError, resp[:message]
+      end
+      
+      # fetch each file
+      uri_parser = URI::Parser.new
+      resp[:files].each do |file|
+        if !file[:is_directory]
+          print @pastel.bold("Loading #{file[:path]} ... ") if !quiet
+          
+          if 
+            last_pull_time && \
+            last_pull_loc && \
+            Time.parse(file[:updated_at]) <= Time.parse(last_pull_time) && \
+            last_pull_loc == curr_dir && \
+            File.exist?(file[:path]) # case when user deletes file
+            # case when file hasn't been updated since last 
+            print "#{@pastel.yellow.bold "NO NEW UPDATES"}\n" if !quiet
+            next
+          end
+          
+          pathtotry = uri_parser.escape(domain + file[:path])
+          fileconts = @http.get pathtotry
+          
+          # follow redirects
+          while fileconts.status == 301
+            new_path = fileconts.header['location'][0]
+            print "\n#{@pastel.red "Fetch from #{pathtotry} failed."}\nTrying #{new_path} instead..." if !quiet
+
+            pathtotry = new_path
+            fileconts = @http.get pathtotry
+          end
+
+          if fileconts.ok?
+            print "#{@pastel.green.bold 'SUCCESS'}\n" if !quiet
+            success_loaded += 1
+
+            File.open("#{file[:path]}", "w") do |f|
+              f.write(fileconts.body)
+            end
+          else
+            print "#{@pastel.red.bold 'FAIL'}\n" if !quiet
+          end
+        else
+          FileUtils.mkdir_p "#{file[:path]}"
+        end
+      end
+
+      # calculate time command took
+      total_time = Time.now - start_time
+
+      # stop the spinner, if there is one
+      Whirly.stop if quiet
+
+      # display stats
+      puts @pastel.green "\nSuccessfully fetched #{success_loaded} files in #{total_time} seconds"
+    end
+
     def key
       get 'key'
     end
@@ -86,6 +170,7 @@ module Neocities
       uri = @uri+path
       uri.query = URI.encode_www_form params
       resp = @http.get uri
+      
       JSON.parse resp.body, symbolize_names: true
     end
 
@@ -95,4 +180,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.0.18'
+  VERSION = '0.0.20'
 end

data/neocities.gemspec

@@ -21,5 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'tty-prompt',          '~> 0.12', '= 0.12.0'
   spec.add_dependency 'pastel',              '~> 0.7',  '= 0.7.2'
   spec.add_dependency 'httpclient-fixcerts', '~> 2.8',  '>= 2.8.5'
-  spec.add_dependency 'rake',                '~> 12.3',  '>= 12.3.1'
+  spec.add_dependency 'rake',                '~> 12.3', '>= 12.3.1'
+  spec.add_dependency 'whirly',              '~> 0.3',  '>= 0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neocities
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.20
 platform: ruby
 authors:
 - Kyle Drake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-07 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-table
@@ -110,6 +110,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: whirly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: 
 email:
 - contact@neocities.org
@@ -148,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.13
 signing_key: 
 specification_version: 4
 summary: Neocities.org CLI and API client