jekyll-action-network 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6beafe15785d6af1657202257f0f6db8f73ff9c6eae3b7de10d7a4b91c7ce00d
-  data.tar.gz: 5b08d9c2b83ff65ae712716f7ea13ac91328a2d0adcb98178c58b0bf1d5cb69d
+  metadata.gz: 65a9afd8b2fcbcc33e2f1f45ea6d25a07acc6bcc28e5b7ac3900443a5c4078dc
+  data.tar.gz: ba9411be015b223ded854fec35a3fb2f39c9cdaa60ce9271b0cddb4c80511ed7
 SHA512:
-  metadata.gz: 354a3b9428835b02b85511a1a588b22604f2eb42f066ac6b1e9829217c9cac0d7c286318ab99919f5c65db4d9ba35917a1e5a4f2b8c9980b9ba17df5a8893c04
-  data.tar.gz: 3e2e89571d35141b49effbab7afd858e5ca2696ed570d80747e317059be616c4751ce26a0f1973cd7e1c5ba9c5b16ed3f5e65e37aad49b071b49b020de225b4f
+  metadata.gz: e00cde2d4c9d533931f046f11b7272bfa33dfedebd94b26141d721d7990ffb6d8be48be770ccac1ff378504a8856b958987c25ddd0d7e26c2607c76fa6709399
+  data.tar.gz: 4b0c39e1b928efce610feb7ba9733853c022a33d4a20eba190d6518f465777324152c6eba58a4294da562f2931ce39298bf4a524d1a4f7c948822f526a44ba1b

data/lib/jekyll/action-network/action.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ActionNetwork
+    ##
+    # An action network action, call the +doc+ method to get a
+    # Jekyll::Document for this action
+    class Action
+      def initialize(site, name, collection, config, action)
+        @site = site
+        @collection = collection
+        @config = config
+        @action = action
+        @name = name
+        @utils = Jekyll::ActionNetwork::Utils.new
+      end
+
+      def doc
+        return @doc if @doc
+
+        @doc = Jekyll::Document.new(path, collection: @collection, site: @site)
+        @doc.content = content
+        @doc.merge_data!(front_matter)
+        @doc
+      end
+
+      def slug
+        @slug ||= @action["browser_url"].split("/")[-1] if @action["browser_url"]
+      end
+
+      def path
+        @path ||= File.join(@site.source, "_#{@config["collection"]}", "#{slug}.md")
+      end
+
+      def front_matter
+        return @front_matter if @front_matter
+
+        @front_matter = {}
+        @config["mappings"].each do |a, d|
+          front_matter[d] = @action[a]
+        end
+        @front_matter["layout"] = @config["layout"]
+        @front_matter["slug"] = slug
+        @front_matter["embed_code"] = @utils.make_embed_code(@action["browser_url"])
+        @front_matter["action_type"] = @name
+        @front_matter
+      end
+
+      def content
+        @content ||= @action[@config["content"]]
+      end
+    end
+  end
+end

data/lib/jekyll/action-network/collection.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ActionNetwork
+    ##
+    # For creating Jekyll::Collections from an Action Network config
+    #
+    class Collection
+      UTILS = Jekyll::ActionNetwork::Utils.new
+
+      def initialize(site, client, config_init, settings)
+        @site = site
+        @settings = settings
+        @client = client
+        @config_init = config_init
+      end
+
+      def config
+        @name = @config_init["name"]
+        @defaults ||= @settings["defaults"]
+        @config ||= @defaults[@name].merge!(@config_init)
+      end
+
+      def collection
+        return @collection if @collection
+
+        Jekyll.logger.debug LOG_NAME, "Creating collection #{@name}"
+        @collection ||= @site.collections[@name] if @site.collections[@name]
+        @collection ||= Jekyll::Collection.new(@site, config["collection"])
+      end
+
+      def documents
+        documents = []
+        filtered_actions.each do |action_data|
+          action = Jekyll::ActionNetwork::Action.new(@site, @name, collection, config, action_data)
+          documents << action.doc
+        end
+        documents
+      end
+
+      def populate
+        collection.docs.concat(documents)
+        @collection
+      end
+
+      def actions
+        @actions ||= UTILS.get_full_list(@client, @name)
+      end
+
+      def filters
+        filters = @settings["filters"]["all"].merge(@settings["filters"][@name] || {})
+        filters.merge(config["filters"] || {})
+      end
+
+      def filtered_actions
+        public_actions = []
+        actions.each do |action|
+          next if action_filtered(action, filters)
+
+          public_actions << reduce_fields(action)
+        end
+      end
+
+      def action_filtered(action, filters)
+        filtered = false
+        filters.each do |key, value|
+          next if action[key] == value
+
+          next if value == "%" && action[key]
+
+          Jekyll.logger.debug @log_name, "#{name} filtered because #{action[key]} == #{value}"
+          filtered = true
+          break
+        end
+        filtered
+      end
+
+      def reduce_fields(action)
+        reduced_action = {}
+        @settings["fields"].each do |field|
+          reduced_action[field] = action[field] if action[field]
+        end
+        reduced_action
+      end
+    end
+  end
+end

data/lib/jekyll/action-network/generator.rb

@@ -5,151 +5,90 @@ require "jekyll"
 require "yaml"
 require "dotenv/load"
 
-##
-# This class is a Jekyll::Generator that creates collections from
-# Action Network
 module Jekyll
   ##
-  # This sub class is a Jekyll::Generator that creates collections from
-  # Action Network
-  class ActionNetworkGenerator < Jekyll::Generator
-    def generate(site)
-      return unless site.config["action_network"]
-
-      @site = site
-      @log_name = "Action Network:"
-      @settings ||= settings
-      @config = site.config["action_network"]
-      return unless authenticate
-
-      @actions = Jekyll::Collection.new(site, "actions") if @config["actions"]
-      @config.each do |name, _config|
-        next unless @defaults[name]
-
-        make_collection(name)
-      end
-      site.collections["actions"] = @actions if @actions
-    end
+  # An integration with Action Network for a Jekyll site
+  module ActionNetwork
+    LOG_NAME = "Action Network: "
 
-    def settings
-      @settings = YAML.load_file("#{File.expand_path(__dir__)}/settings.yaml")
-      @defaults = @settings["defaults"]
-      @fields = @settings["fields"]
-      @filters = @settings["filters"]
-      @settings
-    end
+    ##
+    # Generates Jekyll collections from the Action Network API
+    class Generator < Jekyll::Generator
+      UTILS = Jekyll::ActionNetwork::Utils.new
 
-    def make_collection(name)
-      if @config[name].is_a?(Hash)
-        config = @defaults[name].merge(@config[name])
-        config["mappings"] = @defaults[name]["mappings"].merge(@config[name]["mappings"] || {})
+      def generate(site)
+        return unless site.config["action_network"]
+
+        @site = site
+        @config = site.config["action_network"]
+        @utils = Jekyll::ActionNetwork::Utils.new
+        return unless authenticate
+
+        make_collections
       end
-      config ||= @defaults[name]
-      Jekyll.logger.info @log_name, "Processing #{name}"
-      actions = get_full_list(name)
-      Jekyll.logger.warn "#{name} before filter: #{actions.length}"
-      filtered_actions = filter_actions(name, actions, config)
-      Jekyll.logger.warn "#{name} after filter: #{filtered_actions.length}"
-      collection = @site.collections[name] if @site.collections[name]
-      collection ||= Jekyll::Collection.new(@site, config["collection"])
-      filtered_actions.each do |action|
-        slug = action["browser_url"].split("/")[-1]
-        path = File.join(@site.source, "_#{config["collection"]}", "#{slug}.md")
-        doc = Jekyll::Document.new(path, collection: collection, site: @site)
-        doc.content = action[config["content"]]
-        frontmattter_data = {}
-        config["mappings"].each do |a, d|
-          frontmattter_data[d] = action[a]
+
+      def make_collections
+        @config["import"].each do |config|
+          name = config["name"] if config.is_a? Hash
+          name ||= config if config.is_a? String
+          next unless name
+
+          make_collection(name, config)
         end
-        frontmattter_data.merge!({
-                                   "layout" => config["layout"],
-                                   "slug" => slug,
-                                   "embed_code" => make_embed_code(action["browser_url"]),
-                                   "action_type" => name
-                                 })
-        doc.merge_data!(frontmattter_data)
-        collection.docs << doc
-        @actions.docs << doc if @actions
+        @site.collections["actions"] = actions if @config["actions"]
       end
-      @site.collections[config["collection"]] = collection
-    end
 
-    def make_embed_code(browser_url, style = nil)
-      relative_url = browser_url.split("://")[1].sub("actionnetwork.org/", "")
-      split_url = relative_url.split("/")
-      css = @settings["embed"]["styles"][style] if style
-      resource = @settings["embed"]["resources"][split_url[0]]
-      slug = split_url[1]
-      "#{css}<script src='https://actionnetwork.org/widgets/v5/#{resource}/#{slug}?format=js&source=widget'></script>
-      <div id='can-#{resource}-area-#{slug}' style='width: 100%'></div>"
-    end
+      def make_collection(name, config)
+        return unless defaults[name]
+
+        collection = Jekyll::ActionNetwork::Collection.new(@site, @client, config, settings)
+        @site.collections[collection.config["collection"]] = collection.populate
+        actions.docs.concat(collection.collection.docs)
+      end
 
-    def get_full_list(name)
-      page = 1
-      actions = []
-      loop do
-        action_page = @client.send(name).list(page: page)
-        break if action_page.empty?
+      def actions
+        return @actions if @actions
 
-        actions.concat(action_page)
-        page += 1
+        actions_config = @config["actions"] if @config["actions"].is_a? Hash
+        actions_settings = @settings["actions"].merge(actions_config || {})
+        @actions ||= Jekyll::Collection.new(@site, actions_settings["collection"])
       end
-      actions
-    end
 
-    def filter_actions(name, actions, _config)
-      public = []
-      puts @filters["all"]
-      puts @filters[name] || {}
-      filters = @filters["all"].merge(@filters[name] || {})
-      filters = filters.merge(@config["filters"] || {}) if @config.is_a? Hash
-      puts filters
-      actions.each do |action|
-        filtered = true
-        filters.each do |key, value|
-          unless action[key] == value
-            if value == "%" && action[key]
-              filtered = false if action[key].length.positive?
-            else
-              Jekyll.logger.warn @log_name, "#{name} filtered because #{action[key]} == #{value}"
-              filtered = true
-              break
-            end
-          end
-          filtered = false
-        end
-        public << reduce_fields(action) unless filtered
+      def settings
+        return @settings if @settings
+
+        settings = YAML.load_file("#{File.expand_path(__dir__)}/settings.yaml")
+        @fields = settings["fields"]
+        @filters = settings["filters"]
+        @settings = settings
       end
-      public
-    end
 
-    def reduce_fields(action)
-      reduced_action = {}
-      @fields.each do |field|
-        reduced_action[field] = action[field] if action[field]
+      def defaults
+        @defaults ||= settings["defaults"]
       end
-      reduced_action
-    end
 
-    def get_api_key(key)
-      return unless key
-      return ENV.fetch(key[4..key.length - 1], nil) if key[0..3] == "ENV_"
-      return ENV["ACTION_NETWORK_API_KEY"] if ENV["ACTION_NETWORK_API_KEY"]
+      private
 
-      key
-    end
+      def api_key
+        key = @config["key"] || @settings["key"]
+        return ENV.fetch(key[4..key.length - 1], nil) if key[0..3] == "ENV_"
 
-    def authenticate
-      api_key = get_api_key(@config["key"])
-      Jekyll.logger.warn "Action Network API Key not found." unless api_key
-      return unless api_key
+        key
+      end
 
-      @client = ActionNetworkRest.new(api_key: api_key)
-      unless @client.entry_point.authenticated_successfully?
-        Jekyll.logger.warn "Action Network Authentication Unsucessful"
-        return
+      def authenticate
+        unless api_key
+          Jekyll.logger.warn "Action Network API Key not found."
+          return
+        end
+
+        @client = ActionNetworkRest.new(api_key: api_key)
+        unless @client.entry_point.authenticated_successfully?
+          Jekyll.logger.warn "Action Network Authentication Unsucessful"
+          return
+        end
+        true
       end
-      true
     end
   end
 end

data/lib/jekyll/action-network/settings.yaml

@@ -35,6 +35,9 @@ embed:
   styles:
     standard: <link href='https://actionnetwork.org/css/style-embed-v3.css' rel='stylesheet' type='text/css' />
     layout_only: <link href='https://actionnetwork.org/css/style-embed-whitelabel-v3.css' rel='stylesheet' type='text/css' />
+actions:
+  collection: actions
+key: ENV_ACTION_NETWORK_API_KEY
 defaults:
   petitions:
     collection: petitions
@@ -48,17 +51,6 @@ defaults:
       featured_image_url: image
       target: target
       "action_network:sponsor": sponsor
-  # campaigns:
-  #   collection: campaigns
-  #   layout: an-campaign
-  #   content: description
-  #   mappings:
-  #     title: title
-  #     description: description
-  #     browser_url: browser_url
-  #     featured_image_url: image
-  #     actions: actions
-  #     "action_network:sponsor": sponsor
   events:
     collection: events
     layout: an-event
@@ -112,4 +104,15 @@ defaults:
   #     call_to_action: call_to_action
   #     browser_url: browser_url
   #     featured_image_url: image
+  #     "action_network:sponsor": sponsor
+  # campaigns:
+  #   collection: campaigns
+  #   layout: an-campaign
+  #   content: description
+  #   mappings:
+  #     title: title
+  #     description: description
+  #     browser_url: browser_url
+  #     featured_image_url: image
+  #     actions: actions
   #     "action_network:sponsor": sponsor

data/lib/jekyll/action-network/utils.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module Jekyll
+  module ActionNetwork
+    ##
+    # Some commonly used tools for the Action Network generator
+    class Utils
+      def settings
+        return @settings if @settings
+
+        @settings = YAML.load_file("#{File.expand_path(__dir__)}/settings.yaml")
+        @defaults = @settings["defaults"]
+        @fields = @settings["fields"]
+        @filters = @settings["filters"]
+        @settings
+      end
+
+      def make_embed_code(browser_url, style = nil)
+        relative_url = browser_url.split("://")[1].sub("actionnetwork.org/", "")
+        split_url = relative_url.split("/")
+        css = settings["embed"]["styles"][style] if style
+        resource = settings["embed"]["resources"][split_url[0]]
+        slug = split_url[1]
+        "#{css}<script src='https://actionnetwork.org/widgets/v5/#{resource}/#{slug}?format=js&source=widget'></script>
+        <div id='can-#{resource}-area-#{slug}' style='width: 100%'></div>"
+      end
+
+      def get_full_list(client, name)
+        page = 1
+        actions = []
+        loop do
+          action_page = client.send(name).list(page: page)
+          break if action_page.empty?
+
+          actions.concat(action_page)
+          page += 1
+        end
+        actions
+      end
+    end
+  end
+end

data/lib/jekyll/action-network/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module ActionNetwork
-    VERSION = "0.3.3"
+    VERSION = "0.4.0"
   end
 end

data/lib/jekyll-action-network.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
 
 require "jekyll/action-network/version"
+require "jekyll/action-network/utils"
+require "jekyll/action-network/action"
+require "jekyll/action-network/collection"
 require "jekyll/action-network/generator"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-action-network
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe Irving
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-18 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: action_network_rest
@@ -128,8 +128,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-action-network.rb
+- lib/jekyll/action-network/action.rb
+- lib/jekyll/action-network/collection.rb
 - lib/jekyll/action-network/generator.rb
 - lib/jekyll/action-network/settings.yaml
+- lib/jekyll/action-network/utils.rb
 - lib/jekyll/action-network/version.rb
 homepage: https://github.com/joe-irving/jekyll-action-network/
 licenses: