podcast_feed_generator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b263b6ecc78fa2eccf6bf647de3149f8f253fa12ac9055131ad08c83e41a646
+  data.tar.gz: f4e213071fd65c16ac144704162523a44bf850081c85d4cc21f1f224e82edc2b
+SHA512:
+  metadata.gz: b83117c6734c19663a84b4f0302571573bb68b54968bd16ae64c48ca0c3ca94463fe6049ba996a7c204c941919ba6898f2d72189d591ebed17d571d582dfa791
+  data.tar.gz: 82178f7ae70067c127ffb599e11eb1935eb16c53a5e702cea4f6e99247349ad5fbf9caaf5a79902f8c1c984e1f364f8700fec191a2ac9fe04f91fff341cd8c55

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: fCqbPBJxZmznxqrW2sGW3KInmsIOoxjwx

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in podcast_feed_generator.gemspec
+gemspec
+gem 'nokogiri'
+gem 'minitest-reporters'
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    podcast_feed_generator (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.4)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.4)
+    json (2.5.1)
+    minitest (5.14.2)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nokogiri (1.11.0-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rake (10.5.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.26.0)
+      sync
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls
+  minitest (~> 5.0)
+  minitest-reporters
+  nokogiri
+  podcast_feed_generator!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.2.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Michoel Samuels
+
+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,111 @@
+# PodcastFeedGenerator
+
+[![Build Status](https://travis-ci.org/AnalyzePlatypus/PodcastFeedGenerator.svg?branch=master)](https://travis-ci.org/AnalyzePlatypus/PodcastFeedGenerator)
+[![Coverage Status](https://coveralls.io/repos/github/AnalyzePlatypus/PodcastFeedGenerator/badge.svg?branch=master)](https://coveralls.io/github/AnalyzePlatypus/PodcastFeedGenerator?branch=master)
+[![mit license](https://img.shields.io/badge/license-MIT-blue.svg)](https://img.shields.io/badge/license-MIT-blue.svg)
+
+Easily generate industry-standard podcast RSS feeds.
+
+```ruby
+require "podcast_feed_generator"
+
+json = JSON.parse(File.open("feed.json").read) # A JSON file containing all of your podcast's info
+
+rss_feed = PodcastFeedGenerator::Generator.new.generate json
+```
+
+## Installation
+
+```shell
+$ gem install podcast_feed_generator
+```
+
+Or add this line to your application's Gemfile:
+
+```ruby
+gem 'podcast_feed_generator'
+```
+
+## Build
+
+```shell
+$ cd PodcastFeedGenerator/
+$ gem build podcast_feed_generator.gemspec
+$ gem install podcast_feed_generator
+```
+
+## Usage
+
+`PodcastFeedGenerator` has exactly one public method: `generate`, which expects a Ruby hash with the following shape:
+
+```javascript
+{
+  "podcast": {
+    "title": "Podcast Title",
+    "description": "Podcast Description",
+    "link": "link/to/show",
+    "author": "Podcast author",
+    "ownerName": "Podcast owner",
+    "ownerEmail": "podcast@email.io",
+    "podcastArtworkUrl": "link/to/feedImage",
+     "categories": [ // Add up to three of the official iTunes categories: https://castos.com/itunes-podcast-category-list/
+      "Category 1",
+      "Category 2",
+      "Category 3"
+    ],
+
+    // Optional
+    "lastBuildDate": "2019-06-23",           // Defaults to current date
+    "generator": "PodcastFeedGenerator gem", // Defaults to "PodcastFeedGenerator"
+    "subtitle": "Podcast subtitle",          // Defaults to value of `description`
+    "summary": "Podcast summary",            // Defaults to value of `description`
+    "explicit": "no",                        // Can be one of `yes` | `no` | `explicit`.  Defaults to "no"
+    "language": "en-US",                     // Defaults to `en-US`
+    "podcastType": "Episodic",               // `Episodic` or `Serial`. `Episodic` causes iTunes to list newest first; `Serial`, oldest first
+    "copyright": "(c) Podcast Copyright Notice" // Empty by default
+  },
+  "episodes": [
+    {
+      "title": "Episode Title",
+      "pubDate": "2019-05-01",
+      "link": "link/to/episode", 
+      "description": "Episode description",
+      "mediaFileUrl": "https://my-site.io/podcast/1",
+      "duration": "00:33:12",
+      "mediaFileSizeBytes": "34540230",
+
+      // Optional
+      "author": "Episode Author",                 // Defaults to the `author` field above
+      "creator": "Episode Creator",               // Defaults to the `author` field above
+      "subtitle": "Episode subtitle",             // Defaults to the episode `description`
+      "summary": "Episode summary",               // Defaults to the episode `description`
+      "explicit": "no",                           // Can be one of `yes` | `no` | `explicit`.  Defaults to "no"
+      "episodeArtUrl": "path/to/episodeImage",    // Defaults to the podcast artwork url
+      "itunesTitle": "Episode iTunes title",      // Special title to show in iTunes. Defaults to episode `title`
+      "episodeNumber": "42",                      // Automatically generated if not specified.
+      "seasonNumber": "2",                        // Defaults to ""
+      "episodeType": "Full",                      // `full` | `trailer` | `bonus`. Defaults to `Full`. See the documentation for <itunes:episodeType> on https://help.apple.com/itc/podcasts_connect/#/itcb54353390
+      "mediaMimeType": "audio/mpeg",              // Any media mime type. Defaults to "audio/mpeg"
+      "mediaIsDefault": "true",                   // Defaults to true
+      "medium": "audio"                           // `audio` | `video`. Defaults to `audio`
+      "htmlDescription": "<div></div>",           // Defaults to the episode `description`
+      "guid": "my.site/episodes/hjhkhl7829hs986", // Defaults to a 32-character random string. Can alternatvely be a URL.
+      "guidIsPermalink": "false",                 // `false` by default. Set to `true` if your `guid` is a permalink url
+    }
+  ]
+}
+```
+
+## See Also
+
+* [Apple Podcasts Feed Guidelines](https://help.apple.com/itc/podcasts_connect/#/itc2b3780e76)
+* [Apple Podcasts RSS Explained](https://help.apple.com/itc/podcasts_connect/#/itcb54353390)
+* [Apple Podcasts Categories](https://help.apple.com/itc/podcasts_connect/#/itc9267a2f12)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/podcast_feed_generator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "podcast_feed_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/podcast_feed_generator.rb

@@ -0,0 +1,197 @@
+require "podcast_feed_generator/version"
+
+require 'json'
+require 'uri'
+require 'time'
+require 'nokogiri'
+
+# Constants
+
+DEFAULT_GENERATOR_STRING = "Ruby PodcastFeedGenerator (https://github.com/AnalyzePlatypus/PodcastFeedGenerator)"
+
+# Warning Strings
+
+NO_ARTWORK_WARNING = "❗️ Warning: No podcast artwork has been set. The iTunes podcast directory will not accept podcasts the lack channel art.\n"
+NO_DURATION_WARNING = "❗️ Warning: Episode #%{episode_number}: '%{episode_title}' is missing a duration. Some podcast players may reject your feed.\n"
+NO_CATEGORIES_WARNING = "❗️ Warning: Your feed has no categories defined.\nThe iTunes podcast directory requires 3 categories to be present in your feed.\n"
+NO_MEDIA_URL_WARNING = "❗️ Warning: Episode #%{episode_number}: '%{episode_title}' has no audio url defined.\nGot: %{url}\nThe episode will be unplayable and some podcast players may reject your feed.\n"
+INVALID_URL_WARNING = "❗️ Warning: url `mediaFileUrl` appears to be invalid: %{url}.\nFound in Episode #%{episode_number}: '%{episode_title}'\nThe episode will be unplayable and some podcast players may reject your feed.\n"
+MISSING_FILE_SIZE_WARNING = "❗️ Warning: Episode #%{episode_number}: '%{episode_title}' is missing media file size (Got: %{fileSize}). (Missing key: `mediaFileSizeBytes`)\n. Some podcast players may reject your feed."
+DUPLICATE_GUID_WARNING = "❗️ Warning: Multiple episodes are using the same GUID: `%{guid}`.\nGUIDS should be unique.\nSome podcast players may reject your feed."
+
+# Helpers
+
+def url_valid? url
+  URI.parse(url).kind_of?(URI::HTTP)
+end
+
+def detect_duplicate_guids episodes  
+  episode_guids = episodes.map{|e| e["guid"]}
+  length_before_uniq = episode_guids.length
+  length_after_uniq = episode_guids.uniq.length
+
+  id = episode_guids.group_by{|e| e}.keep_if{|_, e| e.length > 1}
+
+  if length_after_uniq < length_before_uniq
+    STDERR.puts DUPLICATE_GUID_WARNING % {
+      guid: id
+    } 
+  end
+end
+
+def verifyHasArtwork channel_details
+  STDERR.puts NO_ARTWORK_WARNING if channel_details["podcastArtworkUrl"].nil? || channel_details["podcastArtworkUrl"].empty?
+end
+
+def verifyHasCategories channel_details
+  if channel_details["categories"].nil? || channel_details["categories"].empty?
+    STDERR.puts NO_CATEGORIES_WARNING    
+  end
+end
+
+def verifyHasDuration episode
+  if  episode["duration"].nil?
+    STDERR.puts NO_DURATION_WARNING % {
+      episode_number: episode["episodeNumber"],
+      episode_title: episode["title"]
+    } 
+  end
+end
+
+def verifyMediaFileUrl episode
+  if  episode["mediaFileUrl"].nil? || episode["mediaFileUrl"].empty?
+    STDERR.puts NO_MEDIA_URL_WARNING % {
+      url: episode["mediaFileUrl"],
+      episode_number: episode["episodeNumber"],
+      episode_title: episode["title"]
+    } 
+  else 
+    unless url_valid? episode["mediaFileUrl"]
+      STDERR.puts INVALID_URL_WARNING % {
+        url: episode["mediaFileUrl"],
+        episode_number: episode["episodeNumber"],
+        episode_title: episode["title"]
+      } 
+    end
+  end
+end
+
+def verifyMediaFileBytes episode
+  if  episode["mediaFileSizeBytes"].nil? || episode["mediaFileSizeBytes"].empty?
+    STDERR.puts MISSING_FILE_SIZE_WARNING % {
+      fileSize: episode["mediaFileSizeBytes"],
+      episode_number: episode["episodeNumber"] || feed_info["episodes"].length - index,
+      episode_title: episode["title"]
+    } 
+  end
+end
+
+module PodcastFeedGenerator
+ 
+  class Generator
+    def generate feed_info
+      builder = Nokogiri::XML::Builder.new do |xml|
+
+        detect_duplicate_guids feed_info["episodes"]
+        verifyHasArtwork    feed_info["podcast"]
+        verifyHasCategories feed_info["podcast"]
+
+        xml.rss('xmlns:content' => "http://purl.org/rss/1.0/modules/content/",  "xmlns:wfw" => "http://wellformedweb.org/CommentAPI/", "xmlns:itunes" => "http://www.itunes.com/dtds/podcast-1.0.dtd", "xmlns:dc" => "http://purl.org/dc/elements/1.1/", "xmlns:media" => "http://search.yahoo.com/mrss/",  "version" => "2.0") {
+          channel_details = feed_info["podcast"]
+          xml.channel {
+            
+              xml.title         channel_details["title"]
+              xml.description   channel_details["description"]
+              xml.link          channel_details["link"]
+              xml.lastBuildDate channel_details["lastBuildDate"] || Time.now.rfc2822
+              xml.generator     channel_details["generator"]     || DEFAULT_GENERATOR_STRING
+              xml.language      channel_details["language"]     || "en-US"
+              xml.copyright     channel_details["copyright"]
+
+              xml['itunes'].author   channel_details["author"]      || channel_details["author"]
+              xml['itunes'].subtitle channel_details["subtitle"]    || channel_details["description"]
+              xml['itunes'].summary  channel_details["summary"]     || channel_details["description"]
+              xml['itunes'].explicit channel_details["explicit"]    || "no"
+              xml['itunes'].type     channel_details["podcastType"] || "episodic"
+
+              xml['itunes'].owner {
+                xml['itunes'].name  channel_details["ownerName"]
+                xml['itunes'].email channel_details["ownerEmail"]
+              }
+              
+              xml['itunes'].image("href"    =>     channel_details["podcastArtworkUrl"] )
+              
+              unless channel_details["categories"].nil?
+                channel_details["categories"].each do |category_name|
+                  xml['itunes'].category("text" => category_name)
+                end
+              end 
+              
+
+              episodes = feed_info["episodes"].each_with_index do |episode, index|
+                episode["episodeNumber"] = episode["episodeNumber"] || (feed_info["episodes"].length - index)
+              end
+
+              feed_info["episodes"].each_with_index do |episode, index|
+                
+                verifyHasDuration episode
+                verifyMediaFileUrl episode
+                verifyMediaFileBytes episode
+
+                xml.item {
+                  xml.title episode["title"]
+                  xml['dc'].creator episode["creator"] || channel_details["author"]
+                  xml.author episode["creator"] || channel_details["author"]
+                  xml.pubDate episode["pubDate"]
+                  xml.link episode["link"]
+                  xml.guid("isPermalink": episode["guidIsPermalink"]){
+                    xml.text episode["guid"] || (0...32).map { (65 + rand(26)).chr }.join
+                  } 
+
+                  xml.description episode["description"]
+                  xml["content"].encoded {
+                    xml.text "<![CDATA[#{episode["htmlDescription"]} ]]>"
+                  }
+                  xml['itunes'].author episode["author"]
+                  xml['itunes'].subtitle episode["subtitle"] || episode["description"]
+                  xml['itunes'].summary episode["summary"] || episode["description"]
+                  
+
+                  xml['itunes'].explicit episode["explicit"] || 'no'
+                  xml['itunes'].duration episode["duration"]
+                  xml['itunes'].image("href"=> episode["episodeArtUrl"] || channel_details["podcastArtworkUrl"])
+    
+                  
+                  xml['itunes'].episode episode["episodeNumber"]
+                  xml['itunes'].season episode["seasonNumber"]
+
+                  xml['itunes'].title episode["itunesTitle"] || episode["title"]
+                  xml['itunes'].episodeType episode["episodeType"] || "full"
+      
+                  xml.enclosure(
+                    "url" => episode["mediaFileUrl"], 
+                    "type" => episode["mediaMimeType"] || "audio/mpeg",
+                    "length" => episode["mediaFileSizeBytes"] 
+                  )
+    
+                  xml['media'].content(
+                    "url"=> episode["mediaFileUrl"], 
+                    "type" => episode["mediaMimeType"] || "audio/mpeg",
+                    "length" => episode["mediaFileSizeBytes"],
+                    "isDefault" => episode["mediaIsDefault"] || "true", 
+                    "medium" => episode["medium"] || "audio"
+                  ) {
+                    xml['media'].title("type" => "plain") {
+                      xml.text episode["title"]
+                    }
+                  }
+                }
+              end
+            }
+          }
+      end
+      
+      builder.to_xml
+    end
+  end
+end

data/lib/podcast_feed_generator/version.rb

@@ -0,0 +1,3 @@
+module PodcastFeedGenerator
+  VERSION = "0.2.0"
+end

data/podcast_feed_generator.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "podcast_feed_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "podcast_feed_generator"
+  spec.version       = PodcastFeedGenerator::VERSION
+  spec.authors       = ["Michoel Samuels"]
+  spec.email         = ["k2co3@icloud.com"]
+
+  spec.summary       = %q{🎙 Easily generate RSS podcast feeds from a simple JSON object.}
+  spec.description   = %q{🎙 Easily generate RSS podcast feeds from a simple JSON object (100% test coverage, compatible with every major podcast player)}
+  spec.homepage      = "https://github.com/AnalyzePlatypus/PodcastFeedGenerator"
+  spec.license       = "MIT"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: podcast_feed_generator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michoel Samuels
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-05 00:00:00.000000000 Z
+dependencies:
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: "\U0001F399 Easily generate RSS podcast feeds from a simple JSON object
+  (100% test coverage, compatible with every major podcast player)"
+email:
+- k2co3@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/podcast_feed_generator.rb
+- lib/podcast_feed_generator/version.rb
+- podcast_feed_generator.gemspec
+homepage: https://github.com/AnalyzePlatypus/PodcastFeedGenerator
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: "\U0001F399 Easily generate RSS podcast feeds from a simple JSON object."
+test_files: []