neocities-red 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eec23bd190087f4364c5a68d394b5662a3709e1a567663e0f218c025d0eeb83a
-  data.tar.gz: 3f22fc98249d04d665e9d848cae49507cc475949efc1c0253a3e7f606a487650
+  metadata.gz: 979f4ecefbbdda5967fa634639786036b9c46d43c64c90207d7e4b849e19827a
+  data.tar.gz: 69fbd007930e5b45457f1445df4b9b0a877213b1dd2e523070a46acd1d2e8fc8
 SHA512:
-  metadata.gz: '0966d54d18cafd78536595231de74f89ca46664b87227b65b17263ef1101c9e9b3fb684909b8a5d3393c2a3df3f510c93c77f8cf5809dd6597fc9c5ebbfe2d9b'
-  data.tar.gz: bbef63e19889dd92d1d676c0137b0843feaf6845afaf2f3282b1122281411a51d06d8df63873e8c99f240223676595c38460204963165bf71c147f4219488bc0
+  metadata.gz: 86f21b0d75af228b1a4f5ae2feb0eb00773ada2d1614ed77f959afa38a8438c797b7dfd29032f4ca5a5eafd103c6e852a4c25ad41bf23322d32d610dbb8a386f
+  data.tar.gz: 43daf46a7d5bf9355cb81ef4e20557439c8901d00afff12d0787f738447775a7ccac766940a8ae8e68fde103d54c7e13bd885278ff6ce2738986f99f28ece234

data/README.md

@@ -2,25 +2,33 @@
 
 Hello, there is a fork of [neocities-ruby gem](https://github.com/neocities/neocities-ruby) with my own features and implementations. A much of my changes doesn't make sense to be pushed into original repository, so i pushed it here.
 
-## Main changes/Features:
+### Currently, neocities-red tests and develop with ruby 3.4.* and supports 4.*
 
-### Currently, this gems tests with ruby 3.4.*, it doesn't supports ruby 4 due of dependencies
+## List of improvements and changes:
 
-1) Added MultiThread uploading of files to neocities. This feature boosts `neocities push`;
-2) Moves from `http.rb` to `faraday` gem;
-3) Fixed `-e` flag to exclude folders recursively;
-4) Added `--ignore-dotfiles` to ignore all files-folders starts with '.';
-5) Added `--optimized` for `neocities push` flag to upload only modified files;
-6) Fixed bug with neocities info on modern rubies;
-7) Re-designed `upload` method;
+### 0) Refactor all entire project, change dependencies for more flexibility.
+
+Currently or implementing new features `neocities-red` is easier than original cli. Also i approaching the philosophy to use modern dependencies to ensure that `neocities-red` will supports newest versions of Ruby.
+
+### 1) upload
+
+- Uploading is multi-threaded (Instead of uploading by 1 file linnear it uploads 3-5 files at once.)
+- The logic is differs of original gem (please ensure that by typing the `neocities-red upload` command). 
+- Command also uploads folders recursively (It also upload the content that is inside of the target directory).
+
+### 2) push
+
+Now, that command is great for users, which uses static site generators (like Jekyll, Hugo, e.t.c.).
+
+- Uploading is multi-threaded (Instead of uploading by 1 file linnear it uploads 3-5 files at once.)
+- `neocities push --optimized` command is uploads only files which differs of already uploaded.
+- `neocities push --ignore-dotfiles .` is ignores all files with '.' at the beginning.
+- `neocities push -e <folder>` is ignores folders recursively (Ignoring the content that is inside of the target directory).
 
 ## TODO'S:
-1) Check all entire cli and client logic, fix bugs.
-2) Change dependencies for modern analogs.
-3) Refactor `cli.rb` or use `rails/thor` gem instead.
-4) Add tests
-5) Make sure that gem is compatible with Linux, Freebsd, Windows
-6) Make it compatible with ruby 4.0.0
+1) Refactor `cli.rb` or use `rails/thor` gem instead.
+2) Add tests.
+3) Make sure that gem is compatible with Linux, Freebsd and Windows
 
 # The Neocities Gem
 
@@ -28,8 +36,14 @@ A CLI and library for using the Neocities API. Makes it easy to quickly upload,
 
 ## Installation
 
-```
-  gem install neocities-red
+1) Install Ruby Programming Language to your system. 
+- If you're not a programmer - just install version directly from https://www.ruby-lang.org/en/.
+- If you're programmes, just use any of tools which supports programming language supports. I am prefer to use `asdf` of `mise`.
+
+2) Install gem just typing:
+
+```bash
+gem install neocities-red
 ```
 
 ### Running
@@ -62,3 +76,9 @@ client.delete(path)
 client.push(path)
 client.list(path)
 ```
+
+# Contributions ..?
+
+I'm glad to see everyone, so for contribution you need to check issues and take one typing something like "i'd like to take this issue". After that you should to make fork of this repository, create new branch, complete the task and share with solution via pull request. 
+
+If there are no tasks, just ping me (o-200) for the new issue, and we will think together about what can be implemented or fixed.

data/bin/neocities-red

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require File.join(File.dirname(__FILE__), '..', 'lib', 'neocities')
+require './lib/neocities'
 cli = Neocities::CLI.new ARGV
 cli.run

data/lib/neocities/cli.rb

@@ -10,12 +10,13 @@ require 'whirly'
 require 'digest'
 require 'time'
 
-# warning - the big quantity of working threads could be considered like-a DDOS. Your ip-address could get banned for a few days.
+# warning - the big quantity of working threads could be considered like-a DDOS.
+# Your ip-address could get banned for a few days.
 MAX_THREADS = 5
 
 module Neocities
   class CLI
-    SUBCOMMANDS = %w[upload delete list info push logout pizza pull].freeze
+    SUBCOMMANDS = %w[upload delete list info push logout pizza pull purge].freeze
     HELP_SUBCOMMANDS = ['-h', '--help', 'help'].freeze
     PENELOPE_MOUTHS = %w[^ o ~ - v U].freeze
     PENELOPE_EYES = %w[o ~ O].freeze
@@ -62,6 +63,7 @@ module Neocities
         display_help_and_exit
       elsif @subargs.join('').match(HELP_SUBCOMMANDS.join('|')) && @subcmd != 'info'
         send "display_#{@subcmd}_help_and_exit"
+
       end
 
       unless @api_key
@@ -115,7 +117,7 @@ module Neocities
       display_delete_help_and_exit if @subargs.empty?
 
       @subargs.each do |path|
-        FileRemover.new(@client, path).remove
+        Services::FileRemover.new(@client, path).remove
       end
     end
 
@@ -144,7 +146,7 @@ module Neocities
     end
 
     def info
-      profile_info = ProfileInfo.new(@client, @subargs, @sitename).pretty_print
+      profile_info = Services::ProfileInfo.new(@client, @subargs, @sitename).pretty_print
       puts TTY::Table.new(profile_info)
     rescue Exception => e
       display_response(e)
@@ -159,7 +161,7 @@ module Neocities
 
       path = @subargs[0]
 
-      FileList.new(@client, path, @detail).show
+      Services::FileList.new(@client, path, @detail).show
     end
 
     def push
@@ -303,7 +305,7 @@ module Neocities
               end
               next if path.nil? || path.directory?
 
-              Neocities::FileUploader.new(@client, path).upload
+              Services::FileUploader.new(@client, path, path).upload
             end
           end
         end
@@ -314,19 +316,13 @@ module Neocities
     end
 
     def upload
-      display_upload_help_and_exit if @subargs.empty?
+      display_upload_help_and_exit if @subargs[0].nil? || @subargs[1].nil?
 
-      loop do
-        case @subargs[0]
-        when /^-/
-          puts @pastel.red.bold("Unknown option: #{@subargs[0].inspect}")
-          display_upload_help_and_exit
-        else
-          break
-        end
+      if File.file?(@subargs[0])
+        Services::FileUploader.new(@client, @subargs[0], @subargs[1]).upload
+      elsif File.directory?(@subargs[0])
+        Services::FolderUploader.new(@client, @subargs[0], @subargs[1]).upload
       end
-
-      FileUploader.new(@client, @subargs[0], @subargs[1]).upload
     end
 
     def pull
@@ -336,8 +332,25 @@ module Neocities
       last_pull_time = data['LAST_PULL']['time']
       last_pull_loc = data['LAST_PULL']['loc']
 
-      SiteExporter.new(@client, @sitename, data, @app_config_path)
-                  .export(quiet, last_pull_time, last_pull_loc)
+      Services::SiteExporter.new(@client, @sitename, data, @app_config_path)
+                            .export(quiet, last_pull_time, last_pull_loc)
+    end
+
+    # only for development purposes
+    def purge
+      pruned_dirs = []
+      resp = @client.list
+      resp[:files].each do |file|
+        print @pastel.bold("Deleting #{file[:path]} ... ")
+        resp = @client.delete_wrapper_with_dry_run file[:path], @dry_run
+
+        if resp[:result] == 'success'
+          print "#{@pastel.green.bold('SUCCESS')}\n"
+        else
+          print "\n"
+          display_response resp
+        end
+      end
     end
 
     def pizza
@@ -345,7 +358,7 @@ module Neocities
     end
 
     def display_pizza_help_and_exit
-      puts Pizza.new.make_order
+      puts Services::Pizza.new.make_order
     end
 
     def display_list_help_and_exit
@@ -392,7 +405,10 @@ HERE
 
   #{@pastel.dim 'Examples:'}
 
-  #{@pastel.green '$ neocities upload /img.jpg /images/img2.jpg'} Upload img.jpg to /images folder and with img2.jpg name
+  #{@pastel.green '$ neocities upload ./img.jpg ./images/img2.jpg'} Upload img.jpg to /images folder and with img2.jpg name
+
+  #{@pastel.green '$ neocities upload images/ images/'} Upload images folder with their content to /images folder
+
 HERE
       exit
     end
@@ -425,7 +441,7 @@ HERE
 
   #{@pastel.green '$ neocities push --dry-run .'}                       Just show what would be uploaded
 
-  #{@pastel.green '$ neocities push --optimized .'}                      Do not upload unchanged files.#{' '}
+  #{@pastel.green '$ neocities push --optimized .'}                     Do not upload unchanged files.#{' '}
 
   #{@pastel.green '$ neocities push --prune .'}                         Delete site files not in dir (be careful!)
 

data/lib/neocities/{file_list.rb → services/file_list.rb}

@@ -3,7 +3,7 @@
 require 'pastel'
 require 'tty/table'
 
-module Neocities
+module Neocities::Services
   class FileList
     def initialize(client, path, detail)
       @client = client

data/lib/neocities/{file_remover.rb → services/file_remover.rb}

@@ -2,7 +2,7 @@
 
 require 'pastel'
 
-module Neocities
+module Neocities::Services
   class FileRemover
     attr_accessor :client, :filepath
 

data/lib/neocities/services/file_uploader.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'pastel'
+
+module Neocities
+  module Services
+    class FileIsNotExists < StandardError; end
+
+    class FileUploader
+      def initialize(client, filepath, remote_path = nil)
+        @client = client
+        @filepath = filepath
+        @remote_path = remote_path
+        @pastel = Pastel.new(eachline: "\n")
+      end
+
+      def upload
+        path = Pathname(@filepath)
+
+        raise FileIsNotExists, "#{path} does not exist locally." unless path.exist?
+
+        if path.directory?
+          puts @pastel.bold("#{path} is a directory, skipping")
+          return
+        end
+
+        puts @pastel.bold("Uploading #{path} to #{@remote_path} ...")
+
+        response = @client.upload(path, @remote_path)
+        puts response if response[:result] == 'error'
+
+        if response[:result] == 'error' && response[:error_type] == 'file_exists'
+          puts @pastel.yellow.bold('EXISTS')
+        elsif response[:result] == 'success'
+          puts @pastel.green.bold('SUCCESS')
+        end
+
+        response
+      end
+    end
+  end
+end

data/lib/neocities/services/folder_uploader.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'pastel'
+
+module Neocities
+  module Services
+    class FileIsNotExists < StandardError; end
+
+    # warning - the big quantity of working threads could be considered like-a DDOS.
+    # Your ip-address could get banned for a few days.
+    MAX_THREADS = 5
+
+    class FolderUploader
+      def initialize(client, filepath, remote_path)
+        @client = client
+        @filepath = filepath
+        @remote_path = remote_path
+        @pastel = Pastel.new(eachline: "\n")
+      end
+
+      def upload
+        path = Pathname(@filepath)
+
+        raise FileIsNotExists, "#{path} does not exist locally." unless path.exist?
+
+        if path.file?
+          puts @pastel.bold("#{path} is not a directory, skipping")
+          return
+        end
+
+        Dir.chdir(path) do
+          files = Dir.glob('**/*', File::FNM_DOTMATCH).select { |f| File.file?(f) }
+
+          queue = Queue.new
+          files.each { |file| queue << file }
+
+          workers = Array.new(MAX_THREADS) do
+            Thread.new do
+              loop do
+                begin
+                  file = queue.pop(true)
+                rescue ThreadError
+                  break # queue is empty
+                end
+
+                remote_path = File.join(@remote_path, file)
+                FileUploader.new(@client, file, remote_path).upload
+              end
+            end
+          end
+
+          workers.each(&:join)
+        end
+      end
+    end
+  end
+end

data/lib/neocities/{pizza.rb → services/pizza.rb}

@@ -2,7 +2,7 @@
 
 require 'pastel'
 
-module Neocities
+module Neocities::Services
   class Pizza
     EXCUSES = [
       "Sorry, we're fresh out of pineapple today.",

data/lib/neocities/{profile_info.rb → services/profile_info.rb}

@@ -3,7 +3,7 @@
 require 'time'
 require 'pastel'
 
-module Neocities
+module Neocities::Services
   class ClientError < StandardError; end
 
   class ProfileInfo

data/lib/neocities/{site_exporter.rb → services/site_exporter.rb}

@@ -3,7 +3,7 @@
 require 'whirly'
 require 'pastel'
 
-module Neocities
+module Neocities::Services
   class SiteExporter
     attr_accessor :client, :sitename, :data, :app_config_path
 

data/lib/neocities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Neocities
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'
 end

data/lib/neocities.rb

@@ -3,9 +3,12 @@
 require File.join(File.dirname(__FILE__), 'neocities', 'version')
 require File.join(File.dirname(__FILE__), 'neocities', 'client')
 require File.join(File.dirname(__FILE__), 'neocities', 'cli')
-require File.join(File.dirname(__FILE__), 'neocities', 'profile_info')
-require File.join(File.dirname(__FILE__), 'neocities', 'file_uploader')
-require File.join(File.dirname(__FILE__), 'neocities', 'file_remover')
-require File.join(File.dirname(__FILE__), 'neocities', 'file_list')
-require File.join(File.dirname(__FILE__), 'neocities', 'site_exporter')
-require File.join(File.dirname(__FILE__), 'neocities', 'pizza')
+
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'file_uploader')
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'folder_uploader')
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'file_remover')
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'file_list')
+
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'profile_info')
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'site_exporter')
+require File.join(File.dirname(__FILE__), 'neocities', 'services', 'pizza')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neocities-red
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Kyle Drake
@@ -174,12 +174,13 @@ files:
 - lib/neocities.rb
 - lib/neocities/cli.rb
 - lib/neocities/client.rb
-- lib/neocities/file_list.rb
-- lib/neocities/file_remover.rb
-- lib/neocities/file_uploader.rb
-- lib/neocities/pizza.rb
-- lib/neocities/profile_info.rb
-- lib/neocities/site_exporter.rb
+- lib/neocities/services/file_list.rb
+- lib/neocities/services/file_remover.rb
+- lib/neocities/services/file_uploader.rb
+- lib/neocities/services/folder_uploader.rb
+- lib/neocities/services/pizza.rb
+- lib/neocities/services/profile_info.rb
+- lib/neocities/services/site_exporter.rb
 - lib/neocities/version.rb
 - neocities-red.gemspec
 homepage: https://github.com/o-200/neocities-red
@@ -200,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Yet Another Neocities.org CLI and API client with improvements
 test_files: []

data/lib/neocities/file_uploader.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'pathname'
-require 'pastel'
-
-module Neocities
-  class FileIsNotExists < StandardError; end
-
-  class FileUploader
-    def initialize(client, filepath, remote_path = nil)
-      @client = client
-      @filepath = filepath
-      @remote_path = remote_path
-      @pastel = Pastel.new(eachline: "\n")
-    end
-
-    def upload
-      path = Pathname(@filepath)
-
-      raise FileIsNotExists, "#{path} does not exist locally." unless path.exist?
-
-      if path.directory?
-        puts @pastel.bold("#{path} is a directory, skipping")
-        return
-      end
-
-      remote_path = @remote_path || path
-
-      puts @pastel.bold("Uploading #{path} to #{remote_path} ...")
-
-      response = @client.upload(path, remote_path)
-      puts response if response[:result] == 'error'
-
-      if response[:result] == 'error' && response[:error_type] == 'file_exists'
-        puts @pastel.yellow.bold('EXISTS')
-      elsif response[:result] == 'success'
-        puts @pastel.green.bold('SUCCESS')
-      end
-
-      response
-    end
-  end
-end