neocities-red 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf561591a6a553947115437ac9ed12e84f72fc4d14ea9532fe3d3465584db764
-  data.tar.gz: 9b6b0f645578532ee3d647a8b5f87d38aca66ebd0580f8347c2e39ff4cabee18
+  metadata.gz: ef7b7c412b2db9911f08da1e341094af9e73cdc5f15ccd1b64187acc98c6df9a
+  data.tar.gz: 33e7e3e703787840f0e69985859f9d3e80a6560f40c81cd115df88388021eec1
 SHA512:
-  metadata.gz: d2c2245f54b0afeb60684c05f5d9d7cb67c0f4d1f0a479472a4a75db1fc95587521d7e7ea3e98f9372296e9ec007dcaba2e970eb3234006f082e054dbcc16ab9
-  data.tar.gz: 3d01aee0ffd3d92dd8128dfa6e5cfdfd113df1564b983951c01f350f8d62f4115cc788fe95629d55c5f3aa16f9cb9b4a8f642b47129d9695b82f36610128217a
+  metadata.gz: f683232f030fdd8c2b2b0e6a99dc20edd2bb035a929f38c87c708e4f34513154343b159b35aa38a0fe0579101b6b4cddba2e72a24c90d0e0d5ee9782ad05c3a7
+  data.tar.gz: b960d354732fa8836ea390a9953a0db14321d55ad74d293302eb9bd0f6d7323677b9a81c294a81c2490a81349f0ae47b7c0d18560ce25198ca8381a3f5dd5f0f

data/.github/workflows/ci.yml

@@ -138,7 +138,7 @@ jobs:
           usesh: true
           prepare: |
             pkg install -y ca_root_nss git rubygem-bundler
-            pkg install -y ruby34
+            pkg install -y ruby
           run: |
             RUBY_BIN="$(command -v ruby34 || command -v ruby)"
             "$RUBY_BIN" -v

data/.gitignore

@@ -37,6 +37,11 @@ coverage/
 doc/
 .yardoc
 
+# Jekyll site (docs/) local build output
+docs/_site/
+docs/.jekyll-cache/
+docs/.sass-cache/
+
 # Temporary files
 tmp/
 *.log

data/.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
     - "vendor/**/*"
     - "tmp/**/*"
     - "spec/fixtures/**/*"
+    - "docs/**/*"
 
 Layout/LineLength:
   Max: 150

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 
 group :test, :development do
   gem "rspec"
-  gem "rubocop", "~> 1.88.2"
+  gem "rubocop", "~> 1.91.0"
   gem "rubocop-rspec", "~> 3.10.2"
   gem "webmock"
   gem "yard"

data/Gemfile.lock

@@ -25,7 +25,7 @@ GEM
       bigdecimal
       rexml
     diff-lcs (1.6.2)
-    faraday (2.14.3)
+    faraday (2.14.4)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -39,14 +39,14 @@ GEM
       faraday (~> 2.0)
     fiddle (1.1.8)
     hashdiff (1.2.1)
-    json (2.21.2)
+    json (3.0.2)
     language_server-protocol (3.17.0.6)
     lint_roller (1.1.0)
     logger (1.7.0)
     multipart-post (2.4.1)
     net-http (0.9.1)
       uri (>= 0.11.1)
-    parallel (2.1.0)
+    parallel (2.2.0)
     parser (3.3.12.0)
       ast (~> 2.4.1)
       racc
@@ -72,8 +72,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.7)
-    rubocop (1.88.2)
-      json (~> 2.3)
+    rubocop (1.91.0)
+      json (>= 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
       parallel (>= 1.10)
@@ -114,7 +114,7 @@ GEM
     unicode-display_width (2.6.0)
     unicode_utils (1.4.0)
     uri (1.1.1)
-    webmock (3.26.2)
+    webmock (3.26.4)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -131,7 +131,7 @@ PLATFORMS
 DEPENDENCIES
   neocities-red!
   rspec
-  rubocop (~> 1.88.2)
+  rubocop (~> 1.91.0)
   rubocop-rspec (~> 3.10.2)
   webmock
   yard
@@ -143,21 +143,21 @@ CHECKSUMS
   bundler (4.0.17) sha256=214e21431b5665dd2f99df8a5511c6b151d7a72e8015c8b38f8b775b61cbb6c1
   crack (1.0.1) sha256=ff4a10390cd31d66440b7524eb1841874db86201d5b70032028553130b6d4c7e
   diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
-  faraday (2.14.3) sha256=1882247e6766615c8220b4392bf1d27f6ebb63d8e28267587cef1fb0bf37f278
+  faraday (2.14.4) sha256=9bb4408c44621b0dbaaaa39e5dbfc4dbe58cc6751b6eb94d16ae9e1f2f2fab6e
   faraday-follow_redirects (0.5.0) sha256=5cde93c894b30943a5d2b93c2fe9284216a6b756f7af406a1e55f211d97d10ad
   faraday-multipart (1.2.0) sha256=7d89a949693714176f612323ca13746a2ded204031a6ba528adee788694ef757
   faraday-net_http (3.4.4) sha256=0e78af151747ed1b00f33e25973b4bc220d7f16c00c39676817c8b12331eb588
   faraday-retry (2.4.0) sha256=7b79c48fb7e56526faf247b12d94a680071ff40c9fda7cf1ec1549439ad11ebe
   fiddle (1.1.8) sha256=7fa8ee3627271497f3add5503acdbc3f40b32f610fc1cf49634f083ef3f32eee
   hashdiff (1.2.1) sha256=9c079dbc513dfc8833ab59c0c2d8f230fa28499cc5efb4b8dd276cf931457cd1
-  json (2.21.2) sha256=1f1d3b7cf2b3ba1a69beca0bb6db13d5438b80bff3cd54cdaaa620b9b07c1c6a
+  json (3.0.2) sha256=8e6d7e7b11384c21230430cef90b71f14849a34a1f4452796670f7c981bd19df
   language_server-protocol (3.17.0.6) sha256=5ef2c0c138f8267e1bc631d3328347d354f96724b0af22f2c79516120443b7f0
   lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
   logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
   multipart-post (2.4.1) sha256=9872d03a8e552020ca096adadbf5e3cb1cd1cdd6acd3c161136b8a5737cdb4a8
   neocities-red (1.2.0)
   net-http (0.9.1) sha256=25ba0b67c63e89df626ed8fac771d0ad24ad151a858af2cc8e6a716ca4336996
-  parallel (2.1.0) sha256=b35258865c2e31134c5ecb708beaaf6772adf9d5efae28e93e99260877b09356
+  parallel (2.2.0) sha256=e1059c5fd7b649558a0aec38a769f06a42942bdb40503d005a59c352fe011cd8
   parser (3.3.12.0) sha256=21a6d7f755d5a24dfbdc6e6b772e4e879a52e7631a88bc5a3a134606052c9828
   pastel (0.8.0) sha256=481da9fb7d2f6e6b1a08faf11fa10363172dc40fd47848f096ae21209f805a75
   prism (1.9.0) sha256=7b530c6a9f92c24300014919c9dcbc055bf4cdf51ec30aed099b06cd6674ef85
@@ -172,7 +172,7 @@ CHECKSUMS
   rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
   rspec-mocks (3.13.8) sha256=086ad3d3d17533f4237643de0b5c42f04b66348c28bf6b9c2d3f4a3b01af1d47
   rspec-support (3.13.7) sha256=0640e5570872aafefd79867901deeeeb40b0c9875a36b983d85f54fb7381c47c
-  rubocop (1.88.2) sha256=8def251c90cd955feb4daa3edc0ab56893250c4ce90ef81e6c80c03f9a939bbf
+  rubocop (1.91.0) sha256=9c82b7bf391c5d7e3798c5b9996e22a1fe3bd7468e351dfdeb96140c058296d0
   rubocop-ast (1.50.0) sha256=b9ca88300da0803ee222ad20cdb30494c0a784eed06fdc35d254b06d662788db
   rubocop-rspec (3.10.2) sha256=0b3e2ecc592cd10ecbf0095bb58d1e357905276e069643523cc19eb7495f65e2
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
@@ -188,7 +188,7 @@ CHECKSUMS
   unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a
   unicode_utils (1.4.0) sha256=b922d0cf2313b6b7136ada6645ce7154ffc86418ca07d53b058efe9eb72f2a40
   uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
-  webmock (3.26.2) sha256=774556f2ea6371846cca68c01769b2eac0d134492d21f6d0ab5dd643965a4c90
+  webmock (3.26.4) sha256=8d8da206d217ebe6968cfb09c77f4533c23074e1432bad865f3994eacbaad50d
   whirly (0.4.0) sha256=3ffdf9097e711097442f6d83c91b8fc431d73224863f75b48f06fb850b3e596e
   wisper (2.0.1) sha256=ce17bc5c3a166f241a2e6613848b025c8146fce2defba505920c1d1f3f88fae6
   yard (0.9.45) sha256=52e211493f7cb8a3ebf7e104a25a1e73937a3103092545d34cb88fafebb3dc51

data/README.md

@@ -24,14 +24,14 @@ Built for performance, reliability, and real-world workflows (especially static
 - **Recursive uploads** out of the box
 - **SSG-friendly** (Jekyll, Hugo, Eleventy, etc.)
 - **Namespaced services** grouped by domain (`file/`, `site/`, `common/`)
+- **Incremental `pull`** — skips files unchanged since your last pull
+- **`.gitignore`-aware `push`** — respects your ignore rules by default
 
 ---
 
-## Installation
-
-### Requirements
+## Requirements
 
-- **Ruby 3.4+** (tested, supports 4.x)
+- **Ruby 3.4+** (CI-tested against 3.4, 3.5, and 4.0 on Linux, macOS, Windows, and FreeBSD)
 
 Not a programmer?
 
@@ -40,7 +40,7 @@ Not a programmer?
 
 ---
 
-### Install
+## Installation
 
 ```bash
 gem install neocities-red
@@ -55,6 +55,47 @@ neocities-red help
 neocities-red help push
 ```
 
+On first authenticated command you'll be prompted for your sitename/username and
+password — the resulting API key is stored locally for future runs.
+
+```bash
+neocities-red push .
+```
+
+---
+
+## Authentication
+
+The CLI resolves credentials in this order:
+
+1. **`--api-key` flag** — `neocities-red --api-key <key> push .`
+2. **`NEOCITIES_API_KEY` environment variable**
+3. **Stored config** — the API key saved by a previous interactive login
+4. **Interactive login** — prompts for sitename/username and password
+
+For non-interactive logins you can also set:
+
+| Variable | Purpose |
+| --- | --- |
+| `NEOCITIES_API_KEY` | API key used as a Bearer token |
+| `NEOCITIES_SITENAME` | Default sitename/username for the login prompt |
+| `NEOCITIES_PASSWORD` | Default password for the login prompt |
+
+The config file is stored per platform:
+
+| Platform | Location |
+| --- | --- |
+| Linux | `$XDG_CONFIG_HOME/neocities/config.json` (defaults to `~/.config/neocities/config.json`) |
+| macOS | `~/Library/Application Support/neocities/config.json` |
+| Windows | `%LOCALAPPDATA%\neocities\config.json` |
+| FreeBSD / other | `~/.neocities/config.json` |
+
+Remove the stored key with:
+
+```bash
+neocities-red logout -y
+```
+
 ---
 
 ## CLI Commands
@@ -62,36 +103,142 @@ neocities-red help push
 ```text
 push      Recursively upload a local directory to your site
 upload    Upload individual files/folders to your site
-delete    Delete remote files
-diff      Compare local directory with remote
-list      List remote files
-info      Show site info
-pull      Download latest remote files
-logout    Remove stored API key from config
-version   Print gem version
-pizza     Easter egg
+delete    Delete files from your site
+diff      Compare your local directory with your site
+list      List files from your site
+info      Show information and stats for your site
+pull      Get the most recent version of files from your site
+purge     Remove all files from your site (development only)
+logout    Remove the stored API key from the config
+version   Print the gem version
+pizza     Order a free pizza
+help      Show help for a command
 ```
 
-### `push` options
+### `push`
+
+Recursively upload a local directory to your Neocities site. Respects
+`.gitignore` rules by default.
 
 | Flag | Description |
 | --- | --- |
 | `--no-gitignore` | Ignore `.gitignore` filtering and upload matching files |
 | `--ignore-dotfiles` | Skip dotfiles/dot-directories |
-| `-e`, `--exclude` | Exclude file/directory paths |
+| `-e`, `--exclude` | Exclude file/directory paths (repeatable) |
 | `--dry-run` | Show intended actions without mutating remote |
-| `--optimized` | Skip files that already match remote hash |
+| `--optimized` | Skip files whose SHA1 hash already matches the server |
 | `--prune` | Delete remote files that do not exist locally |
 
-Examples:
-
 ```bash
 neocities-red push .
 neocities-red push . --optimized --ignore-dotfiles
 neocities-red push . -e node_modules -e .git
+neocities-red push . --dry-run
+neocities-red push . --prune
+```
+
+### `diff`
+
+Compare a local directory with the remote site and show added, modified, and
+removed files.
+
+| Flag | Description |
+| --- | --- |
+| `--ignore-dotfiles` | Skip dotfiles/dot-directories |
+| `-e`, `--exclude` | Exclude file/directory paths (repeatable) |
+
+```bash
+neocities-red diff .
+neocities-red diff ./my-website --ignore-dotfiles
 neocities-red diff . -e secret.txt
 ```
 
+### `upload`
+
+Upload an individual file or folder to your site.
+
+```bash
+neocities-red upload index.html
+neocities-red upload assets/ images/assets
+```
+
+### `list`
+
+List files from your Neocities site.
+
+| Flag | Description |
+| --- | --- |
+| `-d`, `--detail` | Show a detailed table with size, SHA1 hash, and last-updated timestamp |
+| `-a`, `--all` | List the entire site (ignore the path argument) |
+
+```bash
+neocities-red list
+neocities-red list images -d
+neocities-red list -a
+```
+
+### `info`
+
+Show information and statistics for a site (defaults to your own site).
+
+```bash
+neocities-red info
+neocities-red info fauux
+```
+
+### `pull`
+
+Download the most recent version of files from your site. Skips files that
+haven't changed since your last pull.
+
+| Flag | Description |
+| --- | --- |
+| `-q`, `--quiet` | Show a spinner instead of per-file output |
+
+```bash
+neocities-red pull
+neocities-red pull --quiet
+```
+
+### `delete`
+
+Delete one or more files from your site.
+
+```bash
+neocities-red delete old.html
+neocities-red delete old.html archived/old.css
+```
+
+### `purge`
+
+Delete **everything** from your site. Intended for development sites only —
+use with care.
+
+| Flag | Description |
+| --- | --- |
+| `-y`, `--yes` | Confirm the destructive action (required) |
+| `--dry-run` | Show what would be deleted without deleting |
+
+```bash
+neocities-red purge -y
+neocities-red purge -y --dry-run
+```
+
+### `logout`
+
+Remove the stored API key from the config. Requires confirmation.
+
+```bash
+neocities-red logout -y
+```
+
+### `version` & `pizza`
+
+```bash
+neocities-red version   # print the gem version
+neocities-red pizza     # order a free pizza (easter egg)
+```
+
 ---
 
 ## Library Usage
@@ -109,7 +256,10 @@ client.list(remote_path)
 client.info(sitename)
 ```
 
----
+The client supports both API-key (`api_key:`) and basic-auth
+(`sitename:`/`password:`) authentication, retries transient failures (429/5xx)
+automatically, and exposes low-level helpers like `upload_hash`,
+`delete_wrapper_with_dry_run`, `key`, and `download`.
 
 ### Advanced: Services
 
@@ -132,7 +282,18 @@ Current service namespaces:
 
 - `NeocitiesRed::Services::File` (`Uploader`, `FolderUploader`, `List`, `Remover`)
 - `NeocitiesRed::Services::Site` (`Pusher`, `Differencer`, `Exporter`, `Informer`)
-- `NeocitiesRed::Services::Common` (`Pizza`)
+- `NeocitiesRed::Services::Common` (`Exclusions`, `WorkerPool`, `Pizza`)
+
+---
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec     # run the test suite
+bundle exec rubocop   # run the linter
+bundle exec ruby bin/neocities-red   # run the CLI from source
+```
 
 ---
 

data/lib/neocities_red/version.rb

@@ -2,5 +2,5 @@
 
 module NeocitiesRed
   # The current version of the NeocitiesRed gem.
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/neocities-red.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     files = begin
       if system("git", "rev-parse", "--is-inside-work-tree", out: File::NULL, err: File::NULL)
-        `git ls-files -z`.split("\x0").reject { |f| f == ".yardopts" }
+        `git ls-files -z`.split("\x0").reject { |f| f == ".yardopts" || f.start_with?("docs/") }
       else
         []
       end

data/spec/neocities_red/cli_spec.rb

@@ -87,6 +87,7 @@ RSpec.describe NeocitiesRed::CLI do
       cli.send(:persist_config, API_KEY: "secret", SITENAME: "test-site")
 
       expect(File.read(config_path)).to eq('{"API_KEY":"secret","SITENAME":"test-site"}')
+      skip "chmod is a no-op on Windows" if Gem.win_platform?
       expect(File.stat(config_path).mode & 0o777).to eq(0o600)
     end
   end

data/spec/neocities_red/services/site/differencer_spec.rb

@@ -23,9 +23,8 @@ RSpec.describe NeocitiesRed::Services::Site::Differencer do
   let(:ignore_dotfiles) { false }
   let(:exclude) { [] }
 
-  # rubocop:disable RSpec/VerifiedDoubles
+  # rubocop:disable-next RSpec/VerifiedDoubles
   let(:pastel) { double("Pastel") }
-  # rubocop:enable RSpec/VerifiedDoubles
 
   let(:file_list_service) do
     instance_double(

metadata

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