nanoc-neocities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '028bae6c19a810cfda8e7a04b3bb8f41ac780795bc76e5ab6efcef4cf08f8f35'
+  data.tar.gz: d5f7a3c7eeff00f191cd806e5a4a4565d42ab42e9e377e86dd35dfd7e7a11f16
+SHA512:
+  metadata.gz: 3a809bcc35f5f24ddbd700757eec27f42200fd552d25d9e9350eb9eb02b3f046092a090d46dd0c6fdca1b0ecda444ba965b2c645558865e09069df7538a6617f
+  data.tar.gz: 94949d8a0a5c999531c1bdf3b4f845b0e61b6421a0aa9205589ead3d9c28fccc75c1553f2a6c229ccbeaf4ad71319e27bc64154ea7be25216de76c4f99385ab9

data/LICENSE

@@ -0,0 +1,10 @@
+BSD 3-Clause License
+
+Copyright © 2019 Daniel Aleksandersen.
+Copyright © 2017 Denis Defreyne.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# nanoc-neocities
+
+This Gem provides a deployer that allows [Nanoc](https://nanoc.ws/),
+the open-source static website generator, to deploy to
+[Neocities](https://neocities.org/)™; the free and open-source web
+hosting service for creative web-native individuals.
+
+## Installation
+
+Either `gem install nanoc-neocities` and `require 'nanoc-neocities'`
+from your Nanoc site’s `lib/`.
+
+Or add `nanoc-neocities` to the `nanoc` group of your Gemfile:
+
+```ruby
+group :nanoc do
+  gem 'nanoc-neocities'
+end
+```
+
+Available on [RubyGem](https://rubygems.org/gems/nanoc-neocities/).
+
+## Usage
+
+Add a deployment target to your `nanoc.yaml` file and provide the
+sitename (without the `.neocities.org` TLD) and your site API key:
+
+```deploy:
+  my-example-neocities:
+    kind: neocities
+    sitename: example-site
+    api_key: example-api-key
+filter :external, exec: 'wc'
+```
+
+You can then run `nanoc deploy my-example-neocities` from inside your
+Nanoc site directory to deploy it to your configured Neocities™ site.
+
+You can find the API key for your Neocities™ site on the Site
+settings page on the main Neocities™ website.
+
+---
+
+The project is licensed under the MIT License (see LICENSE).
+“Neocities” is a trademark of Neocities Ltd.

data/lib/nanoc-neocities.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# This file os based on Nanoc::Deploying::Deployer::Git
+# by Copyright © 2017 Denis Defreyne (MIT License).
+
+require 'neocities'
+
+module Nanoc::Deploying::Deployers
+  # A deployer that deploys a site to [Neocities](https://neocities.org/).
+  #
+  # @example A deployment configuration for Neocities:
+  #
+  #   deploy:
+  #     default:
+  #       kind:       neocities
+  #       api_key:    1234abcd
+  #       sitename:   mysite
+  #
+  class NeocitiesDeployer < ::Nanoc::Deploying::Deployer
+    identifier :neocities
+
+    module Errors
+      class Generic < ::Nanoc::Error
+      end
+
+      class OutputEmptyOrGone < Generic
+        def initialize(path)
+          super("The directory to deploy, #{path}, does not exist.")
+        end
+      end
+
+      class AuthenticationFailed < Generic
+        def initialize()
+          super('Your Neocities API key or sitename failed to authenticate your request.')
+        end
+      end
+
+      class APIerror < Generic
+        def initialize(object)
+          super("Neocities API error “#{object}”.")
+        end
+      end
+
+      class UploadFailed < Generic
+        def initialize(path)
+          super("Failed to upload file #{path} to Neocities.")
+        end
+      end
+
+      class DeleteOrphanFailed < Generic
+        def initialize(path)
+          super("Failed to delete orphaned file #{path} from Neocities.")
+        end
+      end
+    end
+
+    def run
+      unless File.exist?(source_path)
+        raise Errors::OutputEmptyOrGone.new(source_path)
+      end
+
+      api_key  = config.fetch(:api_key,  '')
+      sitename = config.fetch(:sitename, '')
+
+      client = Neocities::Client.new({api_key: api_key, sitename: sitename})
+
+      remote_files = client.list
+      
+      unless remote_files[:result] == 'success'
+        if remote_files[:error_type] == 'invalid_auth'
+puts remote_files
+          raise Errors::AuthenticationFailed
+        else
+          raise Errors::APIerror.new(remote_files)
+        end
+      end
+
+      puts "Deploying to Neocities site “#{sitename}”…"
+
+      Dir.chdir(source_path) do
+        Dir.glob("**/*") {|path|
+          unless File.directory?(path)
+            upload = client.upload(path, path)
+            if upload[:result] == 'success'
+              puts "Uploaded file “#{path}”."
+            elsif upload[:error_type] == 'file_exists'
+              puts "Existing file “#{path}” was identical. Skipping upload."
+            else 
+              raise Errors::UploadFailed.new(path)
+            end
+          end
+        }
+
+        puts "Neocities site “#{sitename}” deployed."
+
+        remote_files = client.list
+        puts "Deleting orphaned files from Neocities site “#{sitename}”…"
+
+        orphans = client.list[:files].map{|file| file[:path]} - Dir.glob("**/*")
+
+        for path in orphans
+          puts "Deleting “#{path}”."
+          unless client.delete(orphan)[:result] == 'success'
+            raise Errors::DeleteOrphanFailed.new(path)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-neocities
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Aleksandersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.2
+- !ruby/object:Gem::Dependency
+  name: neocities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.13
+description: Deploy your static website built with Nanoc to your Neocities site.
+email: code+rubygems@daniel.priv.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/nanoc-neocities.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://bitbucket.org/da2x/nanoc-neocities/issues
+  changelog_uri: https://bitbucket.org/da2x/nanoc-neocities/commits/branch/master
+  homepage_uri: https://rubygems.org/gems/nanoc-neocities/
+  source_code_uri: https://bitbucket.org/da2x/nanoc-neocities/src
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Deploy from Nanoc to Neocities.
+test_files: []