jekyll-action-network 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f925a540d595bae5d52294f40fad85b4ab45bb5ef98ae6dd41b343d753ca433e
+  data.tar.gz: 6a60b65be56cfa0fdc36313c4e7c00793c5985ffda6c3570c2a1516177e9bed0
+SHA512:
+  metadata.gz: 69c5c92a8d307173cd5c2d90b2ec3513a19b82936c1f397993db6bd23a0bd78e2e5f43cb737f9d46f188d1d39e23dfb2e97a6c851a287718fc047550a686700b
+  data.tar.gz: 9ee072992fc8321b2fee437af90f7281178ed7c619afde34a082974ac4894d98bc45be6f0e67b0e196f9d60617b636a791c65916c491ee19c0265d274dd96445

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

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require "action_network_rest"
+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
+
+    def settings
+      @settings = YAML.load_file("#{File.expand_path(__dir__)}/settings.yaml")
+      @defaults = @settings["defaults"]
+      @fields = @settings["fields"]
+      @filters = @settings["filters"]
+      @settings
+    end
+
+    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"] || {})
+      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]
+        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
+      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 get_full_list(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
+
+    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
+      end
+      public
+    end
+
+    def reduce_fields(action)
+      reduced_action = {}
+      @fields.each do |field|
+        reduced_action[field] = action[field] if action[field]
+      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"]
+
+      key
+    end
+
+    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
+
+      @client = ActionNetworkRest.new(api_key: api_key)
+      unless @client.entry_point.authenticated_successfully?
+        Jekyll.logger.warn "Action Network Authentication Unsucessful"
+        return
+      end
+      true
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+filters:
+  all:
+    "action_network:hidden": false
+    browser_url: "%"
+  events:
+    visibility: public
+fields:
+  - title
+  - description
+  - petition_text
+  - browser_url
+  - image
+  - target
+  - actions
+  - "action_network:sponsor"
+  - start_date
+  - end_date
+  - location
+  - visibility
+  - capacity
+  - host_url
+  - total_events
+  - total_rsvps
+  - call_to_action
+  - "action_network:event_campaign_id"
+  - type
+embed:
+  resources:
+    forms: form
+    events: event
+    petitions: petition
+    letters: letter
+    call_campaigns: call_campaign
+    event_campaigns: event_campaign
+  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' />
+defaults:
+  petitions:
+    collection: petitions
+    layout: an-petition 
+    content: description
+    mappings:
+      title: title
+      description: description
+      petition_text: petition_text
+      browser_url: browser_url
+      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
+    content: description
+    mappings:
+      title: title
+      description: description
+      browser_url: browser_url
+      featured_image_url: image
+      start_date: start_date
+      end_date: end_date
+      location: location
+      "action_network:event_campaign_id": event_campaign_id
+      status: status
+      visibility: visibility
+      capacity: capacity
+      "action_network:sponsor": sponsor
+  event_campaigns:
+    collection: event_campaigns
+    layout: an-event_campaign
+    content: description
+    mappings:
+      title: title
+      description: description
+      browser_url: browser_url
+      featured_image_url: image
+      host_url: host_url
+      total_events: total_events
+      total_rsvps: total_rsvps
+      "action_network:sponsor": sponsor
+  advocacy_campaigns:
+    collection: advocacy_campaigns
+    layout: an-advocacy_campaign
+    content: description
+    mappings:
+      title: title
+      description: description
+      type: type
+      browser_url: browser_url
+      featured_image_url: image
+      "action_network:sponsor": sponsor
+      targets: targets
+      total_outreaches: total_outreaches
+  forms:
+    collection: forms
+    layout: an-form
+    content: description
+    mappings:
+      title: title
+      description: description
+      call_to_action: call_to_action
+      browser_url: browser_url
+      featured_image_url: image
+      "action_network:sponsor": sponsor

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module ActionNetwork
+    VERSION = "0.2.0"
+  end
+end

data/lib/jekyll-action-network.rb

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-action-network
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joe Irving
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: ''
+email:
+- joe@tippingpointuk.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-action-network.rb
+- lib/jekyll/action-network/generator.rb
+- lib/jekyll/action-network/settings.yaml
+- lib/jekyll/action-network/version.rb
+homepage: https://github.com/tippingpointuk/jekyll-action-network/
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate Jekyll collection(s) from Action Network
+test_files: []