jekyll-mastodon_webfinger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1535439f0568c21208d168937f0729e1cec174361ebe24ce8c554d7bf15d80a
+  data.tar.gz: 78e1b7f75e0f0cbbe9fb33d7b0995616608d8e8b7bc42d0848492779261419d1
+SHA512:
+  metadata.gz: 816ee6cd3ff548fd4758e2225fed8dcc443ab3ffaca62ad02886112f8ea46f29f58abd0fadfe9092a6d7791cf753fbcbbaa806ce20bb4084b095380cd815cfd4
+  data.tar.gz: 9b4c3681b7cd3585e32b3675a9f4efad831c4266b266c6be169af3b4b619e2f1dd6f486a57a121c96676086e4bd77c1d8412f6c653a8eccaecfa0ab558a7fbd6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/SymbolArray:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [1.0.0] - 2022-11-19
+
+- Initial release
+- Generates `/.well-known/webfinger` file that points to a Mastodon profile defined in `_config.yml`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at philnash@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-mastodon_webfinger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License Copyright (c) 2022 Phil Nash
+
+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
+(including the next paragraph) 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,73 @@
+# `Jekyll::MastodonWebfinger`
+
+This is a [Jekyll](https://jekyllrb.com/) plugin that adds a [WebFinger](https://webfinger.net/) file to your site, allowing you to use your own domain to help others discover your [Mastodon](https://joinmastodon.org/) profile.
+
+* [What?](#what)
+* [How to use](#how-to-use)
+  * [Drawbacks](#drawbacks)
+* [Development](#development)
+* [Contributing](#contributing)
+* [Code of Conduct](#code-of-conduct)
+* [License](#license)
+
+## What?
+
+You may be tempated to run your own Mastodon instance so that you can use your own domain. But that's probably hard work.
+
+Instead, you can use your domain to point to your profile on a Mastodon instance that you are signed up to. This uses [WebFinger](https://webfinger.net/), which is a way to attach information to an email address or other online resource. In this case you can point email addresses on your own domain to your Mastodon profile.
+
+For example, I have a Mastodon profile at [@philnash@mastodon.social](https://mastodon.social/@philnash). If I add this plugin to my Jekyll site at https://philna.sh and set the username to `philnash` and the instance to `mastodon.social`, then you will be able to find my account by searching for "phil@philna.sh" in any Mastodon instance.
+
+For a more in depth explanation, check out [Mastodon on your own domain without hosting a server
+by Maarten Balliauw](https://blog.maartenballiauw.be/post/2022/11/05/mastodon-own-donain-without-hosting-server.html).
+
+## How to use
+
+Add the gem to your Jekyll site's `Gemfile` by executing:
+
+    $ bundle add jekyll-mastodon_webfinger
+
+Or by opening the `Gemfile`, adding:
+
+    gem "jekyll-mastodon_webfinger"
+
+and then running `bundle install`.
+
+Then in your Jekyll site's `_config.yml` file add your Mastodon account details. For example:
+
+```yml
+mastodon:
+  username: philnash
+  instance: mastodon.social
+```
+
+Also, add `jekyll/mastodon_webfinger` to the `plugins` list in `_config.yml`:
+
+```yml
+plugins:
+  - jekyll/mastodon_webfinger
+```
+
+Next time you build your Jekyll site, you will find a `/.well-known/` directory in the output with a `webfinger` file that contains the required JSON.
+
+### Drawbacks
+
+Since this generates a static file, this actually acts like a catch-all email address. `@anything@yourdomain.com` will match and point to the Mastodon profile your define.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/philnash/jekyll-mastodon_webfinger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/philnash/jekyll-mastodon_webfinger/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the Jekyll::MastodonWebfinger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/philnash/jekyll-mastodon_webfinger/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/philnash/jekyll-mastodon_webfinger/blob/main/LICENSE).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-mastodon_webfinger.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/mastodon_webfinger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-mastodon_webfinger"
+  spec.version = Jekyll::MastodonWebfinger::VERSION
+  spec.authors = ["Phil Nash"]
+  spec.email = ["philnash@gmail.com"]
+
+  spec.summary = "Use your Jekyll site and domain to forward to your Mastodon profile"
+  spec.description = "Allows you to use your own custom domain to point to your" \
+   "Mastodon profile by adding a /.well-known/webfinger file to your site output"
+  spec.homepage = "https://github.com/philnash/jekyll-mastodon_webfinger"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll", ">= 3.0", "< 5.0"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "rubocop-rake", "~> 0.6"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.15"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+end

data/lib/jekyll/mastodon_webfinger/generator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module MastodonWebfinger
+    # A Jekyll Generator that creates a `/.well-known/webfinger` file in the
+    # site output that points to your Mastodon identity
+    class Generator < Jekyll::Generator
+      def generate(site)
+        destination = site.config["destination"]
+        mastodon = site.config["mastodon"]
+        return unless mastodon && mastodon["username"] && mastodon["instance"]
+
+        username = mastodon["username"]
+        instance = mastodon["instance"]
+
+        directory = create_directory(destination)
+        write_webfinger_file(directory, username, instance)
+      end
+
+      private
+
+      def create_directory(destination)
+        directory = File.join(destination, ".well-known")
+        FileUtils.mkdir_p(directory)
+        directory
+      end
+
+      def write_webfinger_file(directory, username, instance)
+        filename = File.join(directory, "webfinger")
+        File.open(filename, "w") do |file|
+          file.write webfinger_json(username, instance)
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def webfinger_json(username, instance)
+        {
+          subject: "acct:#{username}@#{instance}",
+          aliases: [
+            "https://#{instance}/@#{username}",
+            "https://#{instance}/users/#{username}"
+          ],
+          links: [
+            {
+              rel: "http://webfinger.net/rel/profile-page",
+              type: "text/html",
+              href: "https://#{instance}/@#{username}"
+            },
+            {
+              rel: "self",
+              type: "application/activity+json",
+              href: "https://#{instance}/users/#{username}"
+            },
+            {
+              rel: "http://ostatus.org/schema/1.0/subscribe",
+              template: "https://#{instance}/authorize_interaction?uri={uri}"
+            }
+          ]
+        }.to_json
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/jekyll/mastodon_webfinger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module MastodonWebfinger
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll/mastodon_webfinger.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "json"
+require "jekyll"
+require_relative "mastodon_webfinger/version"
+require_relative "mastodon_webfinger/generator"

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-mastodon_webfinger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Phil Nash
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: Allows you to use your own custom domain to point to yourMastodon profile
+  by adding a /.well-known/webfinger file to your site output
+email:
+- philnash@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-mastodon_webfinger.gemspec
+- lib/jekyll/mastodon_webfinger.rb
+- lib/jekyll/mastodon_webfinger/generator.rb
+- lib/jekyll/mastodon_webfinger/version.rb
+homepage: https://github.com/philnash/jekyll-mastodon_webfinger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philnash/jekyll-mastodon_webfinger
+  source_code_uri: https://github.com/philnash/jekyll-mastodon_webfinger
+  changelog_uri: https://github.com/philnash/jekyll-mastodon_webfinger/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Use your Jekyll site and domain to forward to your Mastodon profile
+test_files: []