jekyll-patreon 1.0.0 → 1.1.0

data/README.md

@@ -0,0 +1,115 @@
+# jekyll-patreon [![Build Status](https://travis-ci.org/uta-org/jekyll-patreon.svg?branch=master)](https://travis-ci.org/uta-org/jekyll-patreon) [![Gem Version](https://badge.fury.io/rb/jekyll-patreon.svg)](http://badge.fury.io/rb/jekyll-patreon)
+
+Requires Ruby 2.5+ and Jekyll 3.8+
+
+> A Jekyll plugins that adds Patreon support in your blog to easily embed a widget with goals
+
+## Features 
+
+* Supports several designs: default, fancy, minimal, streamlined, reversed, swapped
+* Supports several colors: red, green, orange, red nostripes, green nostripes, orange nostripes, blue nostripes
+* Supports i18n (compatible with [jekyll-language-plugin](https://github.com/vwochnik/jekyll-language-plugin))
+* Supports Markdown on your Patreon goals
+
+> To see the possible styles && designs navigate to the assets folder where the screenshots are located
+
+## Installation
+
+Add this line to your site's Gemfile:
+
+```ruby
+gem 'jekyll-patreon'
+```
+
+Add this configuration to your _config.yml file:
+
+```yaml
+####################
+# Patreon Settings #
+####################
+
+patreon:
+    enabled: true
+    design: 'default' # Supports the following desings: default, fancy, minimal, streamlined, reversed, swapped
+    title: 'Example title'
+    metercolor: 'green' # Supports the following colors: red, green, orange, red nostripes, green nostripes, orange nostripes, blue nostripes
+    toptext: 'Example top text' # Text that appears in before the progress bar (optional)
+    bottomtext: 'Example bottom text' # Text that appears in after the progress bar (optional)
+    showgoaltext: true # Display the goal text?
+    showbutton: true # Display the "Become a patron" button?
+    username: 'Your username here'
+    default_lang: "en" # The default language to use (to avoid writing twice the same text from Patreon)
+```
+
+## Usage
+
+Simply just put the following tag where you need this:
+
+`{% patreon %}`
+
+### i18n
+
+To support languages just use [jekyll-language-plugin](https://github.com/vwochnik/jekyll-language-plugin) configuration. Or if you don't use it, do the following steps.
+
+First, in your main index.html (or wherever you need the i18n support) declare the following lines:
+
+```yaml
+---
+layout: <layout>
+language: en
+---
+```
+
+Or if you want to support several languages in the same page:
+
+```yaml
+---
+layout: <layout>
+languages:
+- en
+- es
+---
+```
+
+Then, in "_data/lang/" create one file for each lang.
+
+> Example: `en.yml` and `es.yml`. 
+
+Then, put the translations of you goals like this:
+
+```yaml
+#################
+# Patreon Goals #
+#################
+
+patreon_goal_0: "..."
+patreon_goal_1: "..."
+patreon_goal_2: "..."
+# etc etc...
+```
+
+There you will need to create as much translations as the number of goals that your Patreon page have. (**Note:** starting index is 0 (zero))
+
+## Issues
+
+Having issues? Just report in [the issue section](https://github.com/uta-org/jekyll-patreon/issues). **Thanks for the feedback!**
+
+## Contribute
+
+Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file a bug report.
+
+## Donate
+
+Become a patron, by simply clicking on this button (**very appreciated!**):
+
+[![](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/z3nth10n)
+
+... Or if you prefer an one-time donation:
+
+[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://paypal.me/z3nth10n)
+
+## Copyright
+
+Copyright (c) 2019 z3nth10n (United Teamwork Association).
+
+License: MIT

data/lib/jekyll-patreon.rb

@@ -9,6 +9,8 @@ require "jekyll-patreon/version"
 # Files needed for the widget generator
 require "jekyll-patreon/generator/defaults"
 require "jekyll-patreon/generator/patreonGenerator"
+# Files needed for parsing
+require "jekyll-patreon/parsers/patreonParser"
 # Files needed for displaying the widget
 require "jekyll-patreon/tags/patreonTag"
 

data/lib/jekyll-patreon/_inc/js/patreon.js

@@ -67,7 +67,8 @@ var patreon = {
         {
             pledgeSum = Math.floor(this.GetPledgeSum(campaignData));
 
-            $("#patreon_paypername").html("per " + campaignData.pay_per_name);
+            var payper = campaignData.pay_per_name;        
+            $("#patreon_paypername").html("#{per} " + (payper == "month" ? "#{month}" : "#{patrons}"));
         }
 
         if (goalData)
@@ -75,20 +76,18 @@ var patreon = {
             goalTotal = Math.floor(this.GetGoalTotal(goalData));
 
             if (patreonShowGoalText)
-            {
                 $("#patreon_goaltext").html(goalData.description);
-            }
         }
 
         if (pledgeSum < goalTotal)
         {
-            $("#patreon_goalmoneytext").html("$" + pledgeSum + " of $" + goalTotal);
+            $("#patreon_goalmoneytext").html("$" + pledgeSum + " #{of} $" + goalTotal);
             $("#patreon_goalreached").html("");
         }
         else
         {
             $("#patreon_goalmoneytext").html("$" + goalTotal);
-            $("#patreon_goalreached").html("- reached!");
+            $("#patreon_goalreached").html("- #{reached}");
         }
     },
     CreateDummyGoal: function(campaignData) {

data/lib/jekyll-patreon/_inc/translated_button.html

@@ -0,0 +1,140 @@
+<link href="https://c5.patreon.com/external/fonts/gt-america.css" rel="stylesheet" type="text/css">
+<link href="https://c6.patreon.com/widget.css" rel="stylesheet" type="text/css">
+<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Lato:400,100,100italic,300,300italic,400italic,500,700,700italic,900,900italic">
+
+<style>
+._2KV-widgets-shared--patreonWidgetWrapper {
+    -webkit-font-smoothing: antialiased;
+    -moz-osx-font-smoothing: grayscale;
+    text-rendering: optimizeLegibility;
+}
+    
+.hNJHmD:active {
+    background-color: rgb(229, 72, 49);
+}
+
+.hNJHmD:hover {
+    background-color: rgb(231, 81, 59);
+}
+    
+.hNJHmD {
+    backface-visibility: hidden;
+    background-color: rgb(232, 91, 70);
+    box-sizing: border-box;
+    cursor: pointer;
+    display: inline-block;
+    font-weight: 500;
+    position: relative;
+    pointer-events: unset;
+    text-align: center;
+    text-transform: none;
+    user-select: none;
+    white-space: unset;
+    width: 100%;
+    color: rgb(255, 255, 255) !important;
+    font-size: 0.875rem !important;
+    border-radius: 9999px;
+    border-width: initial;
+    border-style: none;
+    border-color: initial;
+    border-image: initial;
+    padding: 0.5rem 0.75rem;
+    text-decoration: none;
+    transition: all 300ms cubic-bezier(0.19, 1, 0.22, 1) 0s;
+}
+
+.bDCJxk {
+    -webkit-box-align: center;
+    align-items: center;
+    box-sizing: border-box;
+    display: flex;
+    -webkit-box-pack: center;
+    justify-content: center;
+    padding-top: 0rem;
+    padding-right: 0rem;
+    padding-bottom: 0rem;
+    padding-left: 0rem;
+    margin-top: 0rem;
+    margin-right: 0rem;
+    margin-bottom: 0rem;
+    margin-left: 0rem;
+    visibility: visible;
+    transition: all 300ms cubic-bezier(0.19, 1, 0.22, 1) 0s;
+}
+    
+.hnTNrw {
+    align-self: center;
+    -webkit-box-align: center;
+    align-items: center;
+    display: inline-flex;
+    filter: none;
+    cursor: unset;
+    vertical-align: unset;
+    height: unset;
+    width: unset;
+}
+    
+.gBDeVU {
+    width: 0.75rem;
+    height: 1px;
+}
+    
+.ZmzLr, .ZmzLr svg {
+    height: 12px;
+    width: 12px;
+}
+
+.ZmzLr {
+    display: flex;
+}
+    
+.ZmzLr svg {
+    align-self: center;
+    fill: transparent;
+    stroke-width: 1.2px;
+}
+    
+.ZmzLr svg * {
+    vector-effect: non-scaling-stroke;
+    transition: all 300ms cubic-bezier(0.19, 1, 0.22, 1) 0s;
+}
+    
+.ZmzLr svg [data-color="1"], .ZmzLr svg [data-fill="1"] {
+    fill: rgb(255, 255, 255);
+}
+    
+.ZmzLr svg [data-color="2"], .ZmzLr svg [data-fill="2"] {
+    fill: rgb(5, 45, 73);
+}
+    
+.button-text {
+    font-family: 'America', 'GT America', 'Lato', 'Helvetica Neue', 'Helvetica', 'Arial', sans-serif;
+    font-size: 16px;
+    color: white;
+}
+</style>
+
+<div>
+    <div class="_2KV-widgets-shared--patreonWidgetWrapper">
+        <div class="">
+            <div class="s16n3jhk-0 cTHxSM">
+                <a color="primary" class="sc-hMqMXs hNJHmD" tabindex="0" type="button" href="" role="button" target="_blank">
+                    <div display="flex" class="sc-cSHVUG bDCJxk">
+                        <div class="sc-ckVGcZ hnTNrw"><span class="sc-dxgOiQ ZmzLr"><svg viewBox="0 0 569 546" xmlns="http://www.w3.org/2000/svg"><g><circle data-fill="1" id="Oval" cx="362.589996" cy="204.589996" r="204.589996"></circle><rect data-fill="2" id="Rectangle" x="0" y="0" width="100" height="545.799988"></rect></g></svg></span></div>
+                        <div class="sc-hSdWYo gBDeVU"></div>
+                        <div class="button-text">#{caption}</div>
+                    </div>
+                </a>
+                <script>
+                    // https://www.patreon.com/bePatron?u=18277220&amp;redirect_uri=http%3A%2F%2F127.0.0.1%3A4000%2Fes%2F&amp;utm_medium=widget
+                    // $(document).ready(function() { $(".sc-hMqMXs.hNJHmD").attr("href", "https://www.patreon.com/bePatron?u=#{pid}&amp;redirect_uri=" + escape(window.location.href) + "&amp;utm_medium=widget"); });
+                    
+                    document.addEventListener("DOMContentLoaded", function(event) {
+                        var url = "https://www.patreon.com/bePatron?u=#{pid}&amp;redirect_uri=" + escape(window.location.href) + "&amp;utm_medium=widget";
+                        document.getElementsByClassName("sc-hMqMXs")[0].setAttribute("href", url);
+                    });
+                </script>
+            </div>
+        </div>
+    </div>
+</div>

data/lib/jekyll-patreon/generator/defaults.rb

@@ -10,7 +10,9 @@ module Jekyll
       'toptext'      => "", # Text that appears in before the progress bar
       'bottomtext'   => "", # Text that appears in after the progress bar
       'showgoaltext' => true,
-      'showbutton'   => false
+      'showbutton'   => false,
+      'username'     => 'z3nth10n',
+      'default_lang' => "en"
     }
 
   end # module Patreon

data/lib/jekyll-patreon/generator/patreonGenerator.rb

@@ -1,8 +1,5 @@
 module Jekyll
-  module Patreon::Generator
-  
-    @@config = nil  
-      
+  module Patreon::Generator      
     #
     # The main entry point into the generator, called by Jekyll
     # this function extracts all the necessary information from the jekyll end and passes it into the pagination 
@@ -10,6 +7,17 @@ module Jekyll
     # (such as how to create new pages)
     # 
     class PatreonGenerator < Generator
+      # The constants
+        
+      PatreonWebsiteURL = "https://www.patreon.com/"
+      PatreonUserAPIURL = "https://api.patreon.com/user/"
+        
+      # The vars 
+        
+      @@config ||= nil
+      @@PatreonID ||= nil
+      @@json ||= nil
+        
       # This generator is safe from arbitrary code execution.
       safe true
 
@@ -22,15 +30,85 @@ module Jekyll
       # Returns nothing.
       def generate(site)
       #begin
+        
+        Jekyll.logger.info "Patreon:","Initializating"
+        
+        start = Time.now
           
         # Retrieve and merge the Patreon configuration from the site yml file
         default_config = Jekyll::Utils.deep_merge_hashes(DEFAULT, site.config['patreon'] || {})
         @@config = default_config
+          
+        username = @@config["username"]
+          
+        if username.nil?
+           username = "z3nth10n" 
+        end
+        
+        if @@PatreonID.nil?
+            @@PatreonID = internalGetPatreonID(username)
+        else
+            infoSpended(start)
+            return
+        end
+            
+        # Jekyll.logger.info "Patreon lang:",@config['lang']
+
+        @@json = Net::HTTP.get_response(URI.parse("#{PatreonUserAPIURL}#{@@PatreonID}")).body.force_encoding('UTF-8')
+        infoSpended(start)
+      end
+        
+      def infoSpended(start)
+          spended = Time.now - start
+          Jekyll.logger.info "Patreon:", "Initialized in #{spended} seconds"
+      end
+        
+      def internalGetPatreonID(username)
+          patreon_url = URI.encode("#{PatreonWebsiteURL}#{username}")
+
+          # Jekyll.logger.info "Patreon profile url:",patreon_url
+          patreon_source = Net::HTTP.get_response(URI.parse(patreon_url)).body.force_encoding('UTF-8').delete!("\r\n\\")
+
+          patreon_id_index = patreon_source.index("\"creator_id\": ")
+
+          unless patreon_id_index.nil?
+
+              patreon_id_index += 14
+              endidpos = patreon_source.from(patreon_id_index).index("\n")
+
+              if endidpos.nil?
+                endidpos = patreon_source.from(patreon_id_index).index("}")
+              end
+
+              if endidpos.nil?
+                  raiseError()
+              end
+
+              patreon_id = patreon_source.from(patreon_id_index)[0, endidpos].strip
+
+              # Jekyll.logger.info "Patreon ID:",patreon_id
+
+              if patreon_id.nil?
+                  raiseError()
+              end
+
+              return Integer(patreon_id)
+          end
+
+          return -1
       end
         
       def self.getConfig
          @@config 
       end
+        
+      def self.getPatreonID
+         @@PatreonID
+      end
+        
+      def self.getJSON
+         @@json
+      end
     end
   end
 end

data/lib/jekyll-patreon/langs/en.yml

@@ -0,0 +1,8 @@
+# Static translations for this plugins
+
+per: "per"
+month: "month"
+patrons: "patrons"
+of: "of"
+reached: "reached!"
+caption: "Become a patron"

data/lib/jekyll-patreon/langs/es.yml

@@ -0,0 +1,8 @@
+# Static translations for this plugins
+
+per: "por"
+month: "mes"
+patrons: "patreons"
+of: "de"
+reached: "¡conseguido!"
+caption: "¡Suscríbete a mi patreon!"