├── .editorconfig ├── .github └── workflows │ └── tests.yml ├── .gitignore ├── .rspec ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── Gemfile ├── LICENSE.txt ├── README.md ├── Rakefile ├── bin ├── console └── setup ├── jekyll-web_monetization.gemspec ├── lib └── jekyll │ ├── web_monetization.rb │ └── web_monetization │ ├── tag.rb │ └── version.rb └── spec ├── fixtures ├── _posts │ └── 2020-01-01-post.md └── page.md ├── jekyll └── web_monetization │ ├── tag_spec.rb │ └── web_monetization_spec.rb └── spec_helper.rb /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | end_of_line = lf 7 | charset = utf-8 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | spaces_around_operators = true 11 | 12 | [*.md] 13 | trim_trailing_whitespace = false 14 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: tests 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | strategy: 9 | fail-fast: false 10 | matrix: 11 | ruby: [2.5, 2.6, 2.7, "3.0", 3.1, head] 12 | jekyll: ["~> 4.0", "~> 3.0"] 13 | continue-on-error: ${{ endsWith(matrix.ruby, 'head') }} 14 | env: 15 | JEKYLL_VERSION: ${{ matrix.jekyll }} 16 | steps: 17 | - uses: actions/checkout@v2 18 | - name: Set up Ruby ${{ matrix.ruby }} 19 | uses: ruby/setup-ruby@v1 20 | with: 21 | ruby-version: ${{ matrix.ruby }} 22 | - name: "Install dependencies (Jekyll: ${{matrix.jekyll}})" 23 | run: bundle install 24 | - name: Run tests 25 | run: bundle exec rspec 26 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.bundle/ 2 | /.yardoc 3 | /_yardoc/ 4 | /coverage/ 5 | /doc/ 6 | /pkg/ 7 | /spec/reports/ 8 | /tmp/ 9 | 10 | # rspec failure tracking 11 | .rspec_status 12 | 13 | .jekyll-cache 14 | 15 | Gemfile.lock 16 | 17 | .vscode/* 18 | *.code-workspace 19 | 20 | # Local History for Visual Studio Code 21 | .history/ 22 | -------------------------------------------------------------------------------- /.rspec: -------------------------------------------------------------------------------- 1 | --format documentation 2 | --color 3 | --require spec_helper 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## Ongoing [☰](https://github.com/philnash/jekyll-brotli/compare/v0.2.1...master) 4 | 5 | ... 6 | 7 | ## 0.2.1 (2022-04-05) [☰](https://github.com/philnash/jekyll-web_monetization/compare/v0.2.0...v0.2.1) 8 | 9 | ### Added 10 | 11 | - If the config is set to an array of payment pointers that has only one payment pointer, then just print the meta tag ([Thanks SethFalco](https://github.com/philnash/jekyll-web_monetization/pull/1)) 12 | 13 | 14 | ## 0.2.0 (2020-06-08) [☰](https://github.com/philnash/jekyll-web_monetization/compare/v0.1.0...v0.2.0) 15 | 16 | ### Added 17 | 18 | - If the payment pointer in the config or front matter is set to an array or hash, the liquid tag will produce JavaScript that will choose a payment pointer on page load 19 | 20 | ## 0.1.0 (2020-06-02) [☰](https://github.com/philnash/jekyll-web_monetization/commits/v0.1.0) 21 | 22 | ### Added 23 | 24 | - Liquid tag that puts a Web Monetization meta tag on the page if it has a payment pointer in the site config or page front matter 25 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at philnash@gmail.com. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at [https://contributor-covenant.org/version/1/4][version] 72 | 73 | [homepage]: https://contributor-covenant.org 74 | [version]: https://contributor-covenant.org/version/1/4/ 75 | -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | source "https://rubygems.org" 4 | 5 | # Specify your gem's dependencies in jekyll-web_monetization.gemspec 6 | gemspec 7 | 8 | # Allows to switch Jekyll version in the build matrix 9 | gem "jekyll", ENV["JEKYLL_VERSION"] ? "#{ENV["JEKYLL_VERSION"]}" : nil 10 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2020 Phil Nash 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Jekyll::WebMonetization 2 | 3 | A Jekyll plugin to add [Web Monetization API](https://webmonetization.org/) payment pointers to your site. 4 | 5 | [![Gem Version](https://badge.fury.io/rb/jekyll-web_monetization.svg)](https://badge.fury.io/rb/jekyll-web_monetization) ![Build status](https://github.com/philnash/jekyll-web_monetization/workflows/tests/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/9a29d485942538c525dc/maintainability)](https://codeclimate.com/github/philnash/jekyll-web_monetization/maintainability) [![Inline docs](http://inch-ci.org/github/philnash/jekyll-web_monetization.svg?branch=master)](http://inch-ci.org/github/philnash/jekyll-web_monetization) 6 | 7 | ## Web Monetization 8 | 9 | A JavaScript browser API which allows the creation of a payment stream from the user agent to the website. 10 | 11 | [Find out more about Web Monetization](https://webmonetization.org/). 12 | 13 | ### Payment pointer 14 | 15 | To use this plugin and receive payments from Web Monetization you will need a payment pointer. A payment pointer is an address at which you can receive streaming payments from the Web Monetization API. You can set up a payment pointer by creating a digital wallet with [one of the providers listed on the Web Monetization API site](https://webmonetization.org/docs/ilp-wallets). 16 | 17 | You can read more about [payment pointers](https://paymentpointers.org/) and [receiving money from Web Monetization](https://webmonetization.org/docs/receiving) in the relevant documentation. 18 | 19 | ## Installation 20 | 21 | Add the gem to the `:jekyll_plugins` group in your Jekyll site's Gemfile: 22 | 23 | ```ruby 24 | group :jekyll_plugins do 25 | gem 'jekyll-web_monetization' 26 | end 27 | ``` 28 | 29 | Execute: 30 | 31 | ```bash 32 | $ bundle install 33 | ``` 34 | 35 | Then in your site's `_config.yml` add the plugin to the plugins list: 36 | 37 | ```yml 38 | plugins: 39 | - jekyll/web_monetization 40 | ``` 41 | 42 | ## Usage 43 | 44 | Once you have a payment pointer, add it to your site settings in `_config.yml`: 45 | 46 | ```yml 47 | payment_pointer: $securewallet.example/~alice 48 | ``` 49 | 50 | Also, add the `web_monetization` liquid tag to the `` of your layout. 51 | 52 | ```html 53 | 54 | 55 | {% web_monetization %} 56 | 57 | ``` 58 | 59 | The site-wide payment pointer will be added to all pages on which you use the liquid tag. 60 | 61 | If you have multiple authors, you can set a payment pointer per post or page in the YAML front matter. This will over-ride the site-wide payment pointer for that page. 62 | 63 | ```yml 64 | --- 65 | payment_pointer: $securewallet.example/~bob 66 | --- 67 | ``` 68 | 69 | ### Probabilistic Revenue Sharing 70 | 71 | A site, page or post may be the work of more than one person. This plugin supports providing more than one payment pointer to enable [probabilistic revenue sharing](https://webmonetization.org/docs/probabilistic-rev-sharing). 72 | 73 | If, in your `_config.yml` or front matter for any page, you provide an array of payment pointers or a hash of payment pointers and weights, then the plugin will generate JavaScript to choose a payment pointer on each page load. 74 | 75 | #### Array of payment pointers 76 | 77 | You can define an array of payment pointers like this: 78 | 79 | ```yml 80 | payment_pointer: 81 | - $securewallet.example/~alice 82 | - $securewallet.example/~bob 83 | ``` 84 | 85 | Each payment pointer will be given an equal chance of appearing on the page each page load. 86 | 87 | #### Hash of payment pointers and weights 88 | 89 | You can also give payment pointers different weights. They will then appear on the page in a ratio based on the total weights. 90 | 91 | You define this hash of payment pointers and weights like this: 92 | 93 | ```yml 94 | payment_pointer: 95 | $securewallet.example/~alice: 20 96 | $securewallet.example/~bob: 10 97 | ``` 98 | 99 | In this case, Alice's pointer will be added to the page twice as often as Bob's. 100 | 101 | ## Development 102 | 103 | 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. 104 | 105 | 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). 106 | 107 | ## Contributing 108 | 109 | Bug reports and pull requests are welcome on GitHub at https://github.com/philnash/jekyll-web_monetization. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md). 110 | 111 | ## License 112 | 113 | The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 114 | 115 | ## Code of Conduct 116 | 117 | Everyone interacting in the Jekyll::Web::Monetization project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](./CODE_OF_CONDUCT.md). 118 | -------------------------------------------------------------------------------- /Rakefile: -------------------------------------------------------------------------------- 1 | require "bundler/gem_tasks" 2 | require "rspec/core/rake_task" 3 | 4 | RSpec::Core::RakeTask.new(:spec) 5 | 6 | task :default => :spec 7 | -------------------------------------------------------------------------------- /bin/console: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env ruby 2 | 3 | require "bundler/setup" 4 | require "jekyll/web/monetization" 5 | 6 | # You can add fixtures and/or initialization code here to make experimenting 7 | # with your gem easier. You can also use a different console, if you like. 8 | 9 | # (If you use this, don't forget to add pry to your Gemfile!) 10 | # require "pry" 11 | # Pry.start 12 | 13 | require "irb" 14 | IRB.start(__FILE__) 15 | -------------------------------------------------------------------------------- /bin/setup: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail 3 | IFS=$'\n\t' 4 | set -vx 5 | 6 | bundle install 7 | 8 | # Do any other automated setup that you need to do here 9 | -------------------------------------------------------------------------------- /jekyll-web_monetization.gemspec: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require_relative 'lib/jekyll/web_monetization/version' 4 | 5 | Gem::Specification.new do |spec| 6 | spec.name = "jekyll-web_monetization" 7 | spec.version = Jekyll::WebMonetization::VERSION 8 | spec.authors = ["Phil Nash"] 9 | spec.email = ["philnash@gmail.com"] 10 | 11 | spec.summary = %q{A Jekyll plugin to add Web Monetization API payment pointers to your site} 12 | spec.description = %q{A Jekyll plugin to add Web Monetization API payment pointers to your site} 13 | spec.homepage = "https://github.com/philnash/jekyll-web_monetization" 14 | spec.license = "MIT" 15 | spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0") 16 | 17 | spec.metadata["homepage_uri"] = spec.homepage 18 | spec.metadata["source_code_uri"] = "https://github.com/philnash/jekyll-web_monetization" 19 | spec.metadata["changelog_uri"] = "https://github.com/philnash/jekyll-web_monetization/master/CHANGELOG.md" 20 | 21 | # Specify which files should be added to the gem when it is released. 22 | # The `git ls-files -z` loads the files in the RubyGem that have been added into git. 23 | spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do 24 | `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) } 25 | end 26 | spec.require_paths = ["lib"] 27 | spec.add_dependency "jekyll", ">= 3.0", "< 5.0" 28 | spec.add_development_dependency "rake", "~> 12.0" 29 | spec.add_development_dependency "rspec", "~> 3.0" 30 | end 31 | -------------------------------------------------------------------------------- /lib/jekyll/web_monetization.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | require "jekyll" 4 | require "jekyll/web_monetization/version" 5 | require "jekyll/web_monetization/tag" 6 | 7 | 8 | module Jekyll 9 | module WebMonetization 10 | end 11 | end 12 | 13 | Liquid::Template.register_tag('web_monetization', Jekyll::WebMonetization::Tag) 14 | -------------------------------------------------------------------------------- /lib/jekyll/web_monetization/tag.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | require "json" 3 | 4 | module Jekyll 5 | module WebMonetization 6 | class Tag < Liquid::Tag 7 | def render(context) 8 | site_payment_pointer = context.registers[:site].config["payment_pointer"] 9 | page_payment_pointer = context.registers[:page]["payment_pointer"] || site_payment_pointer 10 | 11 | if page_payment_pointer.is_a?(Array) 12 | if page_payment_pointer.length == 1 13 | pointer_to_html(page_payment_pointer[0]) 14 | else 15 | pointers_with_weights = array_to_object(page_payment_pointer) 16 | return javascript(pointers_with_weights) 17 | end 18 | elsif page_payment_pointer.is_a?(Hash) 19 | return javascript(page_payment_pointer) 20 | elsif page_payment_pointer.is_a?(String) 21 | pointer_to_html(page_payment_pointer) 22 | end 23 | end 24 | 25 | private 26 | 27 | def pointer_to_html(pointer) 28 | return "" 29 | end 30 | 31 | def array_to_object(pointers) 32 | pointers.reduce({}) { |acc, pointer| acc[pointer] = 1; acc } 33 | end 34 | 35 | def javascript(pointers_with_weights) 36 | sum = pointers_with_weights.reduce(0) { |acc, (pointer, weight)| acc + weight } 37 | pointers = JSON.generate(pointers_with_weights) 38 | script = <<~JAVASCRIPT 39 | 59 | JAVASCRIPT 60 | end 61 | end 62 | end 63 | end 64 | -------------------------------------------------------------------------------- /lib/jekyll/web_monetization/version.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | module Jekyll 4 | module WebMonetization 5 | VERSION = "0.2.1" 6 | end 7 | end 8 | -------------------------------------------------------------------------------- /spec/fixtures/_posts/2020-01-01-post.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: 'default' 3 | --- 4 | -------------------------------------------------------------------------------- /spec/fixtures/page.md: -------------------------------------------------------------------------------- 1 | --- 2 | layout: default 3 | --- 4 | -------------------------------------------------------------------------------- /spec/jekyll/web_monetization/tag_spec.rb: -------------------------------------------------------------------------------- 1 | # frozen_string_literal: true 2 | 3 | RSpec.describe Jekyll::WebMonetization::Tag do 4 | let(:payment_pointer) { "$pay.money/to_me" } 5 | 6 | let(:context) { make_context(:page => page, :site => site) } 7 | let(:output) { Liquid::Template.parse("{% web_monetization %}").render!(context, {}) } 8 | 9 | describe "with no payment pointer set for the site" do 10 | let(:site) { make_site } 11 | 12 | describe "with a page" do 13 | describe "with no payment_pointer front matter" do 14 | let(:page) { make_page } 15 | 16 | it "doesn't outputs a monetization meta tag" do 17 | expect(output).not_to include("monetization") 18 | end 19 | end 20 | 21 | describe "with payment_pointer in the front matter" do 22 | let(:page) { make_page("payment_pointer" => "page_pointer") } 23 | 24 | it "outputs a meta tag with the payment pointer" do 25 | expect(output).to include("") 26 | end 27 | end 28 | 29 | describe "with an array of payment_pointers in the front matter" do 30 | let(:payment_pointers) { ["$pay.money/to_me", "$example.payment/phil"] } 31 | let(:page) { make_page("payment_pointer" => payment_pointers) } 32 | 33 | it "outputs a meta tag with the payment pointer" do 34 | expect(output).not_to include("") 35 | end 36 | it "outputs javascript to randomly choose pointer evenly" do 37 | expect(output).to include("