jekyll-subscriber_only 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaa1a515b0026b7274bbaf7b2ff047cc8aa24f0910851758badab865248eb1cc
+  data.tar.gz: 69bd7488dc9c1eac6cc3e286318f944e9d71067e07aa3b2c22ca353533142ade
+SHA512:
+  metadata.gz: 07e0d6cf897d0f483c9b2f31f492f365411c16bcbb32de0c7ea7a7440944bc7d5ddee88eced2985ef08f11467a5ca373fdd16b4305c933daf461a14bfe6b6535
+  data.tar.gz: 88e4b8c0e72d847c1b71e9781d13bb8cde480f1a70cd1f76f601f5ee4d55028929b13b9bf670596d4db08ea380701dad1942afd589cd32dda971221fccb9277a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Vitor Manuel de Sousa Pereira
+
+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,51 @@
+# Jekyll Subscriber Only
+
+Monetize your Jekyll site with paid subscriber-only content.
+
+Subscriber Only allows you to monetize your Jekyll site with paid subscriptions. Make selected content available only to paid subscribers by adding a single line to the post's front matter. Leave subscriptions, payment processing and access control to us and focus solely on making great content. Go to https://subscriber-only.com for more details.
+
+## Installation
+
+First, you need to [sign up on Subscriber Only](https://app.subscriber-only.com/site/new) -- it's easy, it takes 10 minutes!
+
+Then, add the `jekyll-subscriber_only` gem to your application's Gemfile, in the `jekyll_plugins` group. Make sure it comes after `jekyll-feed`, if you're using it:
+
+```ruby
+group :jekyll_plugins do
+  # gem "jekyll-feed", "~> 0.12"
+  gem "jekyll-subscriber_only"
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Finally, copy your tokens to your site's `_config.yml`:
+
+```yaml
+subscriber_only:
+  public_token: MY_PUBLIC_TOKEN
+  secret_token: MY_SECRET_TOKEN
+```
+
+## Usage
+
+If you want to make a particular post subscriber-only, add `subscriber_only: true` to the post's front matter:
+
+```yml
+layout: post
+title: My premium post
+subscriber_only: true
+```
+
+**That's it!**
+
+Note that your posts will only be paywalled when building with `JEKYLL_ENV=production`. I.e.
+
+    $ JEKYLL_ENV=production bundle exec jekyll build
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/subscriber-only/jekyll-subscriber_only.
+

data/lib/jekyll/subscriber_only/feed.xml

@@ -0,0 +1,123 @@
+{% comment %}
+# Copyright (c) 2023 Vitor Manuel de Sousa Pereira
+# Copyright (c) 2015-present Ben Balter and jekyll-feed contributors
+# SPDX-License-Identifier: MIT
+{% endcomment %}
+
+<?xml version="1.0" encoding="utf-8"?>
+{% if page.xsl %}
+  <?xml-stylesheet type="text/xml" href="{{ '/feed.xslt.xml' | absolute_url }}"?>
+{% endif %}
+<feed xmlns="http://www.w3.org/2005/Atom" {% if site.lang %}xml:lang="{{ site.lang }}"{% endif %}>
+  <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
+  <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
+  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang }}" {% endif %}/>
+  <updated>{{ site.time | date_to_xmlschema }}</updated>
+  <id>{{ page.url | absolute_url | xml_escape }}</id>
+
+  {% assign title = site.title | default: site.name %}
+  {% if page.collection != "posts" %}
+    {% assign collection = page.collection | capitalize %}
+    {% assign title = title | append: " | " | append: collection %}
+  {% endif %}
+  {% if page.category %}
+    {% assign category = page.category | capitalize %}
+    {% assign title = title | append: " | " | append: category %}
+  {% endif %}
+
+  {% if title %}
+    <title type="html">{{ title | smartify | xml_escape }}</title>
+  {% endif %}
+
+  {% if site.description %}
+    <subtitle>{{ site.description | xml_escape }}</subtitle>
+  {% endif %}
+
+  {% if site.author %}
+    <author>
+        <name>{{ site.author.name | default: site.author | xml_escape }}</name>
+      {% if site.author.email %}
+        <email>{{ site.author.email | xml_escape }}</email>
+      {% endif %}
+      {% if site.author.uri %}
+        <uri>{{ site.author.uri | xml_escape }}</uri>
+      {% endif %}
+    </author>
+  {% endif %}
+
+  {% if page.tags %}
+    {% assign posts = site.tags[page.tags] %}
+  {% else %}
+    {% assign posts = site[page.collection] %}
+  {% endif %}
+  {% if page.category %}
+    {% assign posts = posts | where: "categories", page.category %}
+  {% endif %}
+  {% unless site.show_drafts %}
+    {% assign posts = posts | where_exp: "post", "post.draft != true" %}
+  {% endunless %}
+  {% assign posts = posts | sort: "date" | reverse %}
+  {% assign posts_limit = site.feed.posts_limit | default: 10 %}
+  {% for post in posts limit: posts_limit %}
+    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
+      {% assign post_title = post.title | smartify | strip_html | normalize_whitespace | xml_escape %}
+
+      <title type="html">{{ post_title }}</title>
+      <link href="{{ post.url | absolute_url }}" rel="alternate" type="text/html" title="{{ post_title }}" />
+      <published>{{ post.date | date_to_xmlschema }}</published>
+      <updated>{{ post.last_modified_at | default: post.date | date_to_xmlschema }}</updated>
+      <id>{{ post.id | absolute_url | xml_escape }}</id>
+      {% assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only %}
+      {% unless excerpt_only %}
+        {% if post["subscriber_only"] == true %}
+          {% assign body = "This post is for paying subscribers only." %}
+        {% else %}
+          {% assign body = post.content %}
+        {% endif %}
+        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ body | strip }}]]></content>
+      {% endunless %}
+
+      {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
+      {% assign post_author = site.data.authors[post_author] | default: post_author %}
+      {% assign post_author_email = post_author.email | default: nil %}
+      {% assign post_author_uri = post_author.uri | default: nil %}
+      {% assign post_author_name = post_author.name | default: post_author %}
+
+      <author>
+          <name>{{ post_author_name | default: "" | xml_escape }}</name>
+        {% if post_author_email %}
+          <email>{{ post_author_email | xml_escape }}</email>
+        {% endif %}
+        {% if post_author_uri %}
+          <uri>{{ post_author_uri | xml_escape }}</uri>
+        {% endif %}
+      </author>
+
+      {% if post.category %}
+        <category term="{{ post.category | xml_escape }}" />
+      {% elsif post.categories %}
+        {% for category in post.categories %}
+          <category term="{{ category | xml_escape }}" />
+        {% endfor %}
+      {% endif %}
+
+      {% for tag in post.tags %}
+        <category term="{{ tag | xml_escape }}" />
+      {% endfor %}
+
+      {% assign post_summary = post.description | default: post.excerpt %}
+      {% if post_summary and post_summary != empty %}
+        <summary type="html"><![CDATA[{{ post_summary | strip_html | normalize_whitespace }}]]></summary>
+      {% endif %}
+
+      {% assign post_image = post.image.path | default: post.image %}
+      {% if post_image %}
+        {% unless post_image contains "://" %}
+          {% assign post_image = post_image | absolute_url %}
+        {% endunless %}
+        <media:thumbnail xmlns:media="http://search.yahoo.com/mrss/" url="{{ post_image | xml_escape }}" />
+        <media:content medium="image" url="{{ post_image | xml_escape }}" xmlns:media="http://search.yahoo.com/mrss/" />
+      {% endif %}
+    </entry>
+  {% endfor %}
+</feed>

data/lib/jekyll/subscriber_only/jekyll_feed_patch.rb

@@ -0,0 +1,20 @@
+# Copyright (c) 2023 Vitor Manuel de Sousa Pereira
+# SPDX-License-Identifier: MIT
+
+# frozen_string_literal: true
+
+module Jekyll
+  module SubscriberOnly
+    module JekyllFeedPatch
+      private
+
+      def feed_source_path
+        @feed_source_path ||= File.expand_path("feed.xml", __dir__)
+      end
+    end
+  end
+end
+
+if Object.const_defined?("JekyllFeed::Generator")
+  JekyllFeed::Generator.prepend(Jekyll::SubscriberOnly::JekyllFeedPatch)
+end

data/lib/jekyll/subscriber_only/version.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2023 Vitor Manuel de Sousa Pereira
+# SPDX-License-Identifier: MIT
+
+# frozen_string_literal: true
+
+module Jekyll
+  module SubscriberOnly
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll/subscriber_only.rb

@@ -0,0 +1,137 @@
+# Copyright (c) 2023 Vitor Manuel de Sousa Pereira
+# SPDX-License-Identifier: MIT
+
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+
+require "jekyll"
+
+require "jekyll/subscriber_only/jekyll_feed_patch"
+require "jekyll/subscriber_only/version"
+
+module Jekyll
+  module SubscriberOnly
+    extend self
+
+    Conf = Struct.new(
+      :env, :public_token, :secret_token, :base_url, :script_url, :upload_url,
+      keyword_init: true
+    )
+
+    def configure(site)
+      jekyll_conf = site.config["subscriber_only"]
+      base_url = "https://app.subscriber-only.com"
+
+      if jekyll_conf.nil?
+        die("The site must be configured before you're able to make your " \
+            "posts subscriber-only. Go to #{new_site_url} to configure the " \
+            "site.")
+      end
+
+      env = jekyll_conf["env"]
+      base_url = "http://localhost:3000" if env == "development"
+
+      @conf = Conf.new(
+        env: env,
+        public_token: jekyll_conf["public_token"],
+        secret_token: jekyll_conf["secret_token"],
+        base_url: base_url,
+        script_url: "#{base_url}/so.js",
+        upload_url: URI("#{base_url}/api/v1/posts"),
+      )
+
+      return unless @conf.public_token.nil? || @conf.secret_token.nil?
+
+      die("Public and secret tokens must be configured to enable subscriber-" \
+          "only posts. Go to #{edit_site_url} to get the tokens.")
+    end
+
+    def paywall(doc)
+      return unless subscriber_only?(doc)
+
+      info("Paywalling post \"#{doc['title']}\"")
+      upload_post(doc)
+      replace_content(doc)
+    end
+
+    private
+
+    def upload_post(doc)
+      res = Net::HTTP.post(
+        @conf.upload_url,
+        { path: doc.url, title: doc["title"], content: doc.content }.to_json,
+        {
+          Authorization: "Bearer #{@conf.secret_token}",
+          Accept: "application/json",
+          "Content-Type": "application/json",
+        },
+      )
+
+      handle_api_error(res)
+    rescue Errno::ECONNREFUSED
+      die("Failed to connect to #{@conf.base_url}. Please contact us if this " \
+          "issue persists.")
+    rescue JSON::ParserError
+      File.write("parser_error.html", res.body) if @conf.env == "development"
+      die("Failed to get a correct response.")
+    end
+
+    def handle_api_error(res)
+      return if res.is_a?(Net::HTTPSuccess)
+
+      error_details = JSON.parse(res.body)
+      die("Failed to upload \"#{doc['title']}\".\n#{error_details['message']}")
+    end
+
+    def replace_content(doc)
+      doc.output.sub!("</head>", "#{head_html}</head>")
+      doc.output.sub!(doc.content, content_html)
+    end
+
+    def head_html
+      "<script type=\"module\" src=\"#{@conf.script_url}\"></script>"
+    end
+
+    def content_html
+      "<div data-subscriber-only data-public-token=\"#{@conf.public_token}\">" \
+        "</div>"
+    end
+
+    def new_site_url
+      "#{@conf.base_url}/site/edit"
+    end
+
+    def edit_site_url
+      "#{@conf.base_url}/site/edit"
+    end
+
+    def subscriber_only?(doc)
+      Jekyll.env == "production" &&
+        !doc.draft? &&
+        doc.published? &&
+        doc.write? &&
+        doc["subscriber_only"] == true
+    end
+
+    def info(message)
+      Jekyll.logger.info("Subscriber-Only:", message)
+    end
+
+    def die(message)
+      Jekyll.logger.error("Subscriber-Only:", message)
+      # Jekyll's command handler catches all Exceptions so we must be more brusque
+      # when aborting or the user will be drowning in stack traces.
+      exit!
+    end
+  end
+end
+
+Jekyll::Hooks.register(:site, :after_init) do |site|
+  Jekyll::SubscriberOnly.configure(site)
+end
+
+Jekyll::Hooks.register(:posts, :post_render) do |doc|
+  Jekyll::SubscriberOnly.paywall(doc)
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-subscriber_only
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vitor Manuel de Sousa Pereira
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: |2
+      Subscriber Only allows you to monetize your Jekyll site with paid
+      subscriptions. Make selected content available only to paid subscribers by
+      adding a single line to the post's front matter. Leave subscriptions,
+      payment processing and access control to us and focus solely on making great
+      content. Go to https://subscriber-only.com for more details.
+email: vmsousapereira@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll/subscriber_only.rb
+- lib/jekyll/subscriber_only/feed.xml
+- lib/jekyll/subscriber_only/jekyll_feed_patch.rb
+- lib/jekyll/subscriber_only/version.rb
+homepage: https://subscriber-only.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://subscriber-only.com
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/subscriber-only/jekyll-subscriber_only
+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.1.6
+signing_key:
+specification_version: 4
+summary: Monetize your Jekyll site with paid subscriber-only content.
+test_files: []