jekyll-web_monetization 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66a55b8794510dcfdd63abdb8da667e883c099a59aa4994e81e14f824669591a
-  data.tar.gz: 1c2b20c342db264420198ff77dbe92e861ebf5c22c8d4d6a651d1a3ec37acca6
+  metadata.gz: a26bb61c7ad97c32462eff966235ee259b18fe851c0ddc68ea9dd395609dc794
+  data.tar.gz: '0213983c7ff52d7fbf830bf7d31a27c55efdd7a0015ee0370c145e05d37466f1'
 SHA512:
-  metadata.gz: 3390c1ebd6477037b79b1a96349688119fc5d2d0693ecc37f56af48b88f74131da3d1b16c7004180aa1aa355eca13e0d08e5c26742a75ff53f57525beb72eb3f
-  data.tar.gz: 291f25d54bfbd7a9309777931bf8bc9b9c51d92d8ab4eb2717c62fd15e795a0f9cf3e92a1b1c4595c0af394918d14ba2f795c0b934b194d6c0704f4add210b74
+  metadata.gz: 8bcb264668de2d62b92ff8ea951b5816f4b506dcb3caeda80395fe1fe114a27235f6691baf2701edbb3567de81b1d2d4ab2614125d57d3071637fe81cf31c31a
+  data.tar.gz: 93fc971c1ebf79afa4a3448505dddbe8258193221c8d3ca94518896b791bd7c7a828891a5b7ff470039f370c80683444b3d268875f86b26e0a315e04fb3ac838

data/.gitignore

@@ -10,4 +10,6 @@
 # rspec failure tracking
 .rspec_status
 
-.jekyll-cache
+.jekyll-cache
+
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## Ongoing [☰](https://github.com/philnash/jekyll-brotli/compare/v2.2.1...master)
+
+...
+
+## 0.2.0 (2020-06-08) [☰](https://github.com/philnash/jekyll-web_monetization/compare/v0.1.0...v0.2.0)
+
+### Added
+
+- 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
+
+## 0.1.0 (2020-06-02) [☰](https://github.com/philnash/jekyll-web_monetization/commits/v0.1.0)
+
+### Added
+
+- 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

data/README.md

@@ -66,6 +66,38 @@ payment_pointer: $securewallet.example/~bob
 ---
 ```
 
+### Probabilistic Revenue Sharing
+
+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).
+
+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.
+
+#### Array of payment pointers
+
+You can define an array of payment pointers like this:
+
+```yml
+payment_pointer:
+  - $securewallet.example/~alice
+  - $securewallet.example/~bob
+```
+
+Each payment pointer will be given an equal chance of appearing on the page each page load.
+
+#### Hash of payment pointers and weights
+
+You can also give payment pointers different weights. They will then appear on the page in a ratio based on the total weights.
+
+You define this hash of payment pointers and weights like this:
+
+```yml
+payment_pointer:
+  $securewallet.example/~alice: 20
+  $securewallet.example/~bob: 10
+```
+
+In this case, Alice's pointer will be added to the page twice as often as Bob's.
+
 ## 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.

data/lib/jekyll/web_monetization/tag.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "json"
 
 module Jekyll
   module WebMonetization
@@ -6,10 +7,48 @@ module Jekyll
       def render(context)
         site_payment_pointer = context.registers[:site].config["payment_pointer"]
         page_payment_pointer = context.registers[:page]["payment_pointer"] || site_payment_pointer
-        if page_payment_pointer
+        if page_payment_pointer.is_a?(Array) 
+          pointers_with_weights = array_to_object(page_payment_pointer)
+          return javascript(pointers_with_weights)
+        elsif page_payment_pointer.is_a?(Hash)
+          return javascript(page_payment_pointer)
+        elsif page_payment_pointer.is_a?(String)
           "<meta name='monetization' content='#{page_payment_pointer}'>"
         end
       end
+
+      private
+
+      def array_to_object(pointers)
+        pointers.reduce({}) { |acc, pointer| acc[pointer] = 1; acc }
+      end
+
+      def javascript(pointers_with_weights)
+        sum = pointers_with_weights.reduce(0) { |acc, (pointer, weight)| acc + weight }
+        pointers = JSON.generate(pointers_with_weights)
+        script = <<~JAVASCRIPT
+          <script>
+            (function() {
+              function pickPointer(pointers, sum) {
+                let choice = Math.random() * sum;
+                for (const pointer in pointers) {
+                  const weight = pointers[pointer];
+                  if ((choice -= weight) <= 0) {
+                    return pointer;
+                  }
+                }
+              }
+            
+              window.addEventListener("load", function() {
+                const tag = document.createElement("meta");
+                tag.name = "monetization";
+                tag.content = pickPointer(#{pointers}, #{sum});
+                document.head.appendChild(tag);
+              });
+            })();
+          </script>
+        JAVASCRIPT
+      end 
     end
   end
 end

data/lib/jekyll/web_monetization/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module WebMonetization
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-web_monetization
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -69,9 +69,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,90 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll-web_monetization (0.1.0)
-      jekyll (>= 3.0, < 5.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    colorator (1.1.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    em-websocket (0.5.1)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.7)
-    ffi (1.13.0)
-    forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    jekyll (4.1.0)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 1.0)
-      jekyll-sass-converter (~> 2.0)
-      jekyll-watch (~> 2.0)
-      kramdown (~> 2.1)
-      kramdown-parser-gfm (~> 1.0)
-      liquid (~> 4.0)
-      mercenary (~> 0.4.0)
-      pathutil (~> 0.9)
-      rouge (~> 3.0)
-      safe_yaml (~> 1.0)
-      terminal-table (~> 1.8)
-    jekyll-sass-converter (2.1.0)
-      sassc (> 2.0.1, < 3.0)
-    jekyll-watch (2.2.1)
-      listen (~> 3.0)
-    kramdown (2.2.1)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    liquid (4.0.3)
-    listen (3.2.1)
-      rb-fsevent (~> 0.10, >= 0.10.3)
-      rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.4.0)
-    pathutil (0.16.2)
-      forwardable-extended (~> 2.6)
-    public_suffix (4.0.5)
-    rake (12.3.3)
-    rb-fsevent (0.10.4)
-    rb-inotify (0.10.1)
-      ffi (~> 1.0)
-    rexml (3.2.4)
-    rouge (3.19.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    safe_yaml (1.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    unicode-display_width (1.7.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  jekyll-web_monetization!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.4