fede 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a752e40bbfd39587eb3274f7218b258fab48beecb7980ac2dbe94e860c068949
+  data.tar.gz: 2681a19b6935dd2362b5221d2d64200b2fffcae18308621c8aa3a9cc915fb64e
+SHA512:
+  metadata.gz: e823a5bbf61bc740129397248f508c050cd8d2273c763aad3fd2e97631a4cdb6b043703c83915e963feb6d57d6c77e9d021bc7f4c38e128f3ee956dae1777505
+  data.tar.gz: 2a4cb095a593c5faa6a404ad17bf8920b1a439b1deecd64ba088b91bf25749721428673ec074f63e443612ef978117abf71382d1ae2d1fbdf405a3d8c8a7bb71

data/bin/fede

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'fede'
+
+def show_help
+  puts 'Usage: fede <config_file> <data_dir> [mode]'
+  puts '  modes:'
+  puts '    generate: generate feed from scratch'
+  puts '    append-available: append the items that have the audio files present'
+  puts '    append[-n]: appends the last -n items to the end of the feed, default is 1'
+  puts '        example: fede config_file data_dir append-3 (append last 3 items)'
+  exit
+end
+
+show_help unless ARGV[0]
+show_help unless ARGV[1]
+mode = ARGV[2] || 'generate'
+
+case ARGV[0]
+when '-h'
+  show_help
+end
+
+Fede.run config_file: ARGV[0], data_dir: ARGV[1], mode: mode

data/lib/fede/generator.rb

@@ -0,0 +1,286 @@
+require 'yaml'
+require 'date'
+
+class Fede
+  class FeedGenerator
+    def initialize(site_config, data_directory)
+      @config = parse_yaml site_config
+      @feed_file = get_setting 'feed_file'
+      @data = parse_data data_directory
+      @episode_list = []
+      @ep_name = get_setting 'ep_name'
+      @ep_pub_date = get_setting 'ep_pub_date'
+      @ep_url = get_setting 'ep_url'
+      @ep_desc = get_setting 'ep_desc'
+      @ep_img = get_setting 'ep_img'
+      @ep_details = get_setting 'ep_details'
+      @season_name = get_setting 'season_name'
+      @season_episode_list = get_setting 'season_episode_list'
+      load_episode_list
+    end
+
+    def generate
+      output_feed
+      puts "#{@feed_file} written!"
+    end
+
+    def append(item_count = 1)
+      last_n_episodes = []
+      item_count.times.sort_by(&:-@).each do |i|
+        last_n_episodes << generate_episode_item(@episode_list[-i - 1])
+      end
+      do_append last_n_episodes
+    end
+
+    def append_available_files
+      episodes = []
+      @episode_list.each do |ep|
+        next unless File.file? ep['url']
+
+        episodes << ep
+      end
+      do_append episodes
+    end
+
+    def do_append(last_n_episodes)
+      File.open(@feed_file, 'r+') do |file|
+        insert_position = Kernel.loop do
+          pos = file.pos
+          break pos if file.gets.include?('</channel>') || file.eof?
+        end
+        file.seek(insert_position, IO::SEEK_SET)
+        footer = file.read
+        file.seek(insert_position, IO::SEEK_SET)
+        episodes_string = last_n_episodes.reduce('') { |prev, ep| "#{prev}#{ep.to_s(2)}" }
+        file.write("#{episodes_string}#{footer}")
+      end
+      puts "Last #{last_n_episodes.length} episode(s) appended to #{@feed_file}!"
+    rescue Errno::ENOENT
+      puts "Cannot append if feed doesn't exist"
+    end
+
+    private
+
+    def parse_data(path)
+      data = {}
+      Dir.entries(path).each do |file|
+        next if ['.', '..'].include? file
+
+        data[file.split('.')[0]] = YAML.load_file "#{path}/#{file}"
+      end
+      data
+    end
+
+    def parse_yaml(file)
+      YAML.load_file file
+    end
+
+    def get_setting(setting_name)
+      setting = @config['podcast'][setting_name] || @config[setting_name]
+      if setting.nil?
+        raise StandardError, "Error: setting #{setting_name} is not defined in the config file, cannot continue"
+      end
+
+      setting
+    end
+
+    def output_feed
+      build_date = DateTime.now.strftime(get_setting('datetime_format_string'))
+      base_url = get_setting 'url'
+      managing_editor = get_setting 'managing_editor'
+      editor_email = get_setting 'editor_email'
+      desc = get_setting 'description'
+
+      feed = XMLFeed.new
+      channel = XMLNode.new 'channel'
+      atom_link = XMLNode.new 'atom:link'
+      atom_link.set_propperty 'href', "#{base_url}/#{@feed_file}"
+      atom_link.set_propperty 'rel', 'self'
+      atom_link.set_propperty 'type', 'application/rss+xml'
+      channel.add_child atom_link
+      channel.add_child XMLNode.new 'title', content: get_setting('title')
+      channel.add_child XMLNode.new 'pubDate', content: @episode_list[0]['pub_date']
+      channel.add_child XMLNode.new 'lastBuildDate', content: build_date
+      channel.add_child XMLNode.new 'link', content: base_url
+      channel.add_child XMLNode.new 'language', content: 'pt'
+      channel.add_child(
+        XMLNode.new(
+          'copyright',
+          cdata: true,
+          content: "#{get_setting('title')} #{DateTime.now.year}, #{get_setting('copyright')}."
+        )
+      )
+      channel.add_child XMLNode.new('docs', content: base_url)
+      channel.add_child XMLNode.new('managingEditor', content: "#{editor_email} (#{managing_editor})")
+      channel.add_child XMLNode.new('itunes:summary', cdata: true, content: desc)
+      image = XMLNode.new 'image'
+      image.add_child XMLNode.new('url', content: "#{base_url}#{get_setting('logo')}")
+      image.add_child XMLNode.new('title', content: get_setting('title'))
+      image.add_child XMLNode.new('link', cdata: true, content: base_url)
+      channel.add_child image
+      channel.add_child XMLNode.new('itunes:author', content: get_setting('author'))
+      category = XMLNode.new 'itunes:category'
+      category.set_propperty 'text', 'Society &amp; Culture'
+      channel.add_child category
+      channel.add_child XMLNode.new('itunes:keywords', content: get_setting('keywords'))
+      channel.add_child XMLNode.new('itunes:image', propperties: { href: "#{base_url}#{get_setting('logo')}" })
+      channel.add_child XMLNode.new('itunes:explicit', content: true)
+      owner = XMLNode.new 'itunes:owner'
+      owner.add_child XMLNode.new('itunes:email', content: get_setting('email'))
+      owner.add_child XMLNode.new('itunes:name', content: get_setting('title'))
+      channel.add_child owner
+      channel.add_child(XMLNode.new('description', content: desc, cdata: true))
+      channel.add_child(
+        XMLNode.new(
+          'itunes:subtitle',
+          content: get_setting('short_description'),
+          cdata: true
+        )
+      )
+      channel.add_child XMLNode.new('itunes:type', content: 'episodic')
+      channel.add_child XMLNode.new('itunes:new-feed-url', content: "#{base_url}/#{@feed_file}")
+      channel.add_children generate_all_episode_items
+
+      feed.nodes << channel
+      File.open(@feed_file, 'w') { |file| file.write(feed) }
+    end
+
+    def generate_episode_item(episode)
+      description = format_description episode[@ep_desc], details: episode[@ep_details], indent_level: 3
+      subtitle = format_subtitle episode[@ep_desc]
+
+      current_item = XMLNode.new 'item'
+      current_item.add_child XMLNode.new('guid', content: "#{get_setting('url')}#{episode[@ep_url]}")
+      current_item.add_child XMLNode.new('title', content: episode[@ep_name])
+      current_item.add_child XMLNode.new('pubDate', content: episode[@ep_pub_date])
+      current_item.add_child(XMLNode.new('link', cdata: true, content: "#{get_setting('url')}#{episode[@ep_url]}"))
+      current_item.add_child XMLNode.new(
+        'itunes:image',
+        propperties: { href: "#{get_setting('url')}#{episode_image(episode)}" }
+      )
+      current_item.add_child XMLNode.new('description', cdata: true, content: description)
+      current_item.add_child(
+        XMLNode.new(
+          'enclosure',
+          propperties: {
+            length: episode_bytes_length(episode),
+            type: 'audio/mpeg',
+            url: "#{get_setting('url')}#{episode[@ep_url]}"
+          }
+        )
+      )
+      current_item.add_child XMLNode.new 'itunes:duration', content: episode_duration(episode)
+      current_item.add_child XMLNode.new 'itunes:explicit', content: true
+      current_item.add_child XMLNode.new(
+        'itunes:keywords',
+        content: get_setting('keywords')
+      )
+      current_item.add_child XMLNode.new 'itunes:subtitle', content: subtitle, cdata: true
+      current_item.add_child XMLNode.new 'itunes:episodeType', content: 'full'
+
+      current_item
+    end
+
+    def generate_all_episode_items
+      episode_list = []
+      @episode_list.map do |episode|
+        next if episode['hide']
+
+        episode_list << generate_episode_item(episode)
+      rescue StandardError => e
+        puts "Failed to generate item for #{episode[@ep_name]}: #{e}"
+      end
+      episode_list
+    end
+
+    def format_description(description, details: '', indent_level: 0, strip_all: false)
+      indentation = "\t" * indent_level
+      description = "#{description}\n#{indentation}#{details}".gsub '</br>', "\n#{indentation}"
+      description.gsub! '<p>', ''
+      description.gsub! '</p>', "\n#{indentation}"
+      description.gsub! '<ul>', ''
+      description.gsub! '<li>', "\n#{indentation} + "
+      description.gsub! '</li>', ''
+      description.gsub! '</ul>', "\n#{indentation}"
+
+      if strip_all
+        description.gsub!(/<.?[^>]+>/, '')
+      else
+        # strip rest of html tags (a tags are allowed)
+        description.gsub!(%r{<[^a][^a]/?[^>]+>}, '')
+      end
+      description.gsub!(" \n", "\n")
+      description.strip
+    end
+
+    def format_subtitle(subtitle)
+      desc = format_description(subtitle, strip_all: true)
+      desc.length > 255 ? "#{desc.slice(0, 252)}..." : desc
+    end
+
+    def episode_bytes_length(episode)
+      return episode['bytes_length'] if episode['bytes_length']
+
+      File.new("#{Dir.getwd}#{episode[@ep_url]}").size
+    end
+
+    def episode_duration(episode)
+      return episode['duration'] if episode['duration']
+
+      raise 'FFMPEG not found. ffmpeg is needed to fech episode length' unless which('ffmpeg')
+
+      cmd = "ffmpeg -i #{Dir.getwd}#{episode[@ep_url]} 2>&1 | grep 'Duration' | cut -d ' ' -f 4 | sed s/\.[0-9]*,//"
+      `#{cmd}`.strip!
+    end
+
+    def episode_image(episode)
+      episode[@ep_img] || get_setting('logo')
+    end
+
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      nil
+    end
+
+    def load_episode_list
+      episodes
+      episodes_from_seasons
+      @episode_list.sort_by! do |episode|
+        DateTime.strptime(
+          episode[@ep_pub_date],
+          get_setting('datetime_format_string')
+        )
+      end
+    end
+
+    def episodes
+      episode_data = get_setting 'episode_data'
+      puts 'No episodes found' && return if episode_data.nil?
+
+      episode_data.each do |file|
+        puts "No data found for #{file}" && next unless @data[file]
+
+        @episode_list += @data[file]
+      end
+    end
+
+    def episodes_from_seasons
+      season_data = get_setting 'season_data'
+      puts 'No seasons found' && return if season_data.nil?
+
+      season_data.each do |file|
+        puts "No data found for #{file}" && next unless @data[file]
+
+        @data[file].each do |season|
+          @episode_list += season[@season_episode_list]
+        end
+      end
+    end
+  end
+end

data/lib/fede/xml_feed.rb

@@ -0,0 +1,29 @@
+class Fede
+  class XMLFeed
+    attr_accessor :nodes
+
+    def initialize(nodes = [])
+      @nodes = nodes
+    end
+
+    def header
+      "<?xml version='1.0' encoding='UTF-8'?>\n<rss version='2.0' xmlns:atom='http://www.w3.org/2005/Atom'"\
+      " xmlns:cc='http://web.resource.org/cc/' xmlns:itunes='http://www.itunes.com/dtds/podcast-1.0.dtd'"\
+      " xmlns:media='http://search.yahoo.com/mrss/' xmlns:content='http://purl.org/rss/1.0/modules/content/' xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>\n"
+    end
+
+    def footer
+      "</rss>\n"
+    end
+
+    def to_s
+      '' unless @nodes
+
+      nodes_string = @nodes.reduce('') do |prev, node|
+        "#{prev}#{node.to_s(1)}"
+      end
+
+      "#{header}#{nodes_string}#{footer}"
+    end
+  end
+end

data/lib/fede/xml_node.rb

@@ -0,0 +1,76 @@
+class Fede
+  class XMLNode
+    attr_reader :children, :propperties
+
+    def initialize(tag_name, content: nil, cdata: false, propperties: {})
+      @tag_name = tag_name
+      @content = content
+      @cdata = cdata
+      @propperties = propperties
+      @children = []
+    end
+
+    def parent?
+      !@children.empty?
+    end
+
+    def set_propperty(name, value)
+      @propperties[name] = value
+    end
+
+    def add_child(child)
+      @children << child
+    end
+
+    def add_children(children)
+      raise TypeError 'Children must be an Array of nodes' unless children.is_a? Array
+
+      @children += children
+    end
+
+    def open_tag(indent_level)
+      if @cdata
+        "<#{@tag_name}>\n#{"\t" * indent_level}<![CDATA["
+      elsif @propperties.empty?
+        "<#{@tag_name}>"
+      else
+        prop_string = @propperties.reduce('') { |prev, values| "#{prev} #{values[0]}='#{values[1]}'" }
+        "<#{@tag_name} #{prop_string.strip}#{@content ? '' : ' /'}>"
+      end
+    end
+
+    def prop_string
+      return '' if @propperties.empty?
+
+      @propperties.reduce('') { |prev, values| "#{prev} #{values[0]}='#{values[1]}'" }
+    end
+
+    def children_string(indent_level)
+      @children.reduce('') { |prev, value| "#{prev}#{value.to_s indent_level}" }
+    end
+
+    def tag_open
+      "<#{@tag_name}#{prop_string}"
+    end
+
+    def tag_middle(indent_level)
+      return '' unless parent? || @content
+
+      if @cdata
+        ">\n#{"\t" * (indent_level + 1)}<![CDATA[#{@content}]]>\n#{"\t" * indent_level}"
+      elsif parent?
+        ">\n#{children_string(indent_level + 1)}#{"\t" * indent_level}"
+      else
+        ">#{@content}"
+      end
+    end
+
+    def tag_close
+      parent? || @content ? "</#{@tag_name}>\n" : " />\n"
+    end
+
+    def to_s(indent_level = 0)
+      "#{"\t" * indent_level}#{tag_open}#{tag_middle(indent_level)}#{tag_close}"
+    end
+  end
+end

data/lib/fede.rb

@@ -0,0 +1,33 @@
+class Fede
+  def self.run(config_file:, data_dir:, mode:)
+    @generator = Fede::FeedGenerator.new config_file, data_dir
+    if mode.include? 'append'
+      append mode
+    elsif mode == 'generate'
+      generate
+    elsif mode == 'append-available'
+      append_available
+    else
+      puts "Invalid mode #{mode}. Valid modes are 'generate' or 'append'"
+    end
+  rescue StandardError => e
+    puts e
+  end
+
+  def self.append_available
+    @generator.append_available_files
+  end
+
+  def self.generate
+    @generator.generate
+  end
+
+  def self.append(mode)
+    mode_info = mode.split('-')
+    @generator.append(mode_info.length > 1 ? Integer(mode_info[1]) : 1)
+  end
+end
+
+require 'fede/generator'
+require 'fede/xml_feed'
+require 'fede/xml_node'

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: fede
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Lucca Augusto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-04-18 00:00:00.000000000 Z
+dependencies: []
+description: Very Simple XML feed generator from yaml data files
+email: lucca@luccaaugusto.xyz
+executables:
+- fede
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/fede
+- lib/fede.rb
+- lib/fede/generator.rb
+- lib/fede/xml_feed.rb
+- lib/fede/xml_node.rb
+homepage: https://github.com/luccaugusto/fede
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: XML from yaml
+test_files: []