jekyll-octopod 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 397d681111c05a14e5b0efb6229f937c03c845b5
-  data.tar.gz: f522a27e931755627a0435b494c3df6eb62067d2
+  metadata.gz: 43b02c09d5031f84ac5bf63449f516169a90a1b7
+  data.tar.gz: 3040b8706f3214479476516e90f60fbd46b1832b
 SHA512:
-  metadata.gz: 885248f53c8a38a055810ae2bee83c11345236cc4c22f1a94550dc391e23221f789ddab7d48b21051794fb090e2663ff55c105883e8842d48831e13b1e6dad90
-  data.tar.gz: 7972fece845fd30b6813038af6a6c15adf04fa04ea3303c25b02ab218174446bca00a80862b8d02cfff955b51307f1d8bf4a8054bf00748bb67c805979da272f
+  metadata.gz: aa90cd3b533527b3b373097af3a7b7aa53a662288f4a761ae4c08ddf5698d606cd761b41704218b203f8c983cbcbd7ced45bb74d0a4ff76559f65117edb4b816
+  data.tar.gz: 56d1217779413bfbb40ea2e8d78d32edcaf9e48ed5c3fb25088a8bb417e2f3dfe48ef6bc83ee2c05bd401db00bf66cb8fe35b925893ee0d9b62f9eec205e8a95

data/README.rdoc

@@ -4,11 +4,26 @@ Podcasting publishing extension for Jekyll
 
 == Installation
 
-  $ gem install jekyll-octopod
+  $ gem install jekyll
+  $ jekyll new name-of-my-podcast
+  $ cd name-of-my-podcast
+
+Create file Gemfile with the contents:
+
+  source 'http://rubygems.org'
+  gem 'jekyll-octopod'
+
+Install the dependencies and run the setup script via:
+
+  $ bundle install
+  $ octopod setup
+
 
 == Usage
 
-missing
+FIXME! Confiruration File.
+FIXME! You might want to change the images and logos in ...
+FIXME! You might want to delete the demo episode files
 
 == Contributions
 
@@ -18,18 +33,24 @@ are welcomed!
 
 Stefan Haslinger <mailto:stefan.haslinger@informatom.com>
 
+Based on octopod by Arne Eilermann <mailto: arne@kleinerdrei.org>
+
 
 == Credits
 
 This Gem is sitting on the shoulder of giants, lots of the code was not written by me and/or depends on other code.
+
 Especially to be mentioned: Arne Eilermann eilermann@lavabit.com from Octopod https://github.com/pattex/octopod
 
 == License
 
-The MIT License
-
-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.
+Missing: Link to MIT -License
 
-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.
+* Glyphicons
+* Font Awesome
+* Podlove Webplayer
+* Bootflat
+* Bootstrap
+* iCheck v1.0.1 by Damir Sultanov, http://git.io/arlzeA, MIT License
+* JQuery
+* Demo Audio

data/Rakefile

@@ -1,4 +1,5 @@
 require 'rake/testtask'
+require "bundler/gem_tasks"
 
 task :default => [:test]
 
@@ -7,4 +8,4 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/all.rb'
   t.verbose = true
 end
-Rake::Task['test'].comment = "Run all tests"
+Rake::Task['test'].comment = "Run all tests"

data/bin/octopod

@@ -0,0 +1,250 @@
+#!/usr/bin/env ruby
+require "byebug"
+PWD = Dir.pwd
+GEM_DIR = Gem::Specification.find_by_name("jekyll-octopod").gem_dir
+
+require 'rubygems'
+require 'optparse'
+require 'yaml'
+
+octopod_help = <<HELP
+Octopod - podcast publishing for geeks
+
+Basic Command Line Usage:
+  Standard Jekyll commands:
+    octopod                                                   # . -> ./_site
+    octopod <path to write generated site>                    # . -> <path>
+    octopod <path to source> <path to write generated site>   # <path> -> <path>
+    octopod import <importer name> <options>                  # imports posts using named import script
+    octopod setup                                             # Setup blog to become podcast-aware, copy assets and default config
+
+  Additional Octopod commands:
+    octopod episode                                           # adds a template for a new episode
+    octopod deploy                                            # deploys your site
+
+  See 'octopod <command> --help' for more information on a specific command.
+
+Configuration is read from '<source>/_config.yml' but can be overridden
+using the following options:
+
+HELP
+
+episode_help = <<EPISODE_HELP
+octopod episode - generates a template to post your next episode
+
+octopod episode [options] [audio file[, audio file]]
+
+Configuration is read from '<source>/_config.yml' but can be overridden
+using the following options:
+
+EPISODE_HELP
+
+deploy_help = <<DEPLOY_HELP
+octopod deploy - deploys website via rsync
+
+octopod deploy [path to write generated site] [options]
+
+Configuration is read from '<source>/_config.yml' but can be overridden
+using the following options:
+
+DEPLOY_HELP
+
+DEFAULT_EXT = '.md'
+
+class OptionParser
+  alias_method :_octopod_banner=, :banner=
+  def banner=(_)
+    return ''
+  end
+end
+
+def ok_failed(condition)
+  if (condition)
+    puts "OK"
+  else
+    puts "FAILED"
+  end
+end
+
+def write_file?(filename)
+  if File.exists?(filename)
+    unless ["Y","N"].include?(@answer)
+      @answer = ask("File '#{filename}' already exists. Overwrite? Capitalized answer for ALL files.", ['y', 'Y', 'n', 'N'])
+    end
+    ["Y", "y"].include?(@answer)
+  else
+    true
+  end
+end
+
+def copy_file_or_create_dir(file)
+  filename = file.split(GEM_DIR + "/assets")[1]
+  if File.directory?(file)
+    FileUtils.mkdir(PWD + filename, {verbose: true}) unless File.exists?(PWD + filename)
+  else
+    if write_file?(PWD + filename)
+      FileUtils.cp(file, PWD + filename, {verbose: true})
+    end
+  end
+end
+
+def ask(message, valid_options = nil)
+  if valid_options
+    answer = get_stdin("#{message} #{valid_options.to_s.gsub(/"/, '').gsub(/, /,'/')} ") while !valid_options.include?(answer)
+  else
+    answer = get_stdin(message)
+  end
+  answer
+end
+
+def get_stdin(message)
+  print message
+  STDIN.gets.chomp
+end
+
+if ARGV.size > 0 && (ARGV[0] == 'episode' || ARGV[0] == 'deploy' || ARGV[0] == 'setup')
+  options = YAML.load_file(File.join(PWD, '_config.yml'))
+  options['posts_dir'] = File.join(PWD, '_posts')
+
+  case ARGV[0]
+
+  when 'episode'
+    post_header = {
+      'title'         => nil,
+      'layout'        => 'post',
+      'author'        => options['author'],
+      'explicit'      => options['explicit'] || 'no',
+      'audio'         => {
+        'm4a'  => 'name.m4a',
+        'mp3'  => 'name.mp3',
+        'opus' => 'name.opus'},
+    }
+
+    opts = OptionParser.new do |opts|
+      opts._octopod_banner = episode_help
+
+      opts.on("-a", "--author [AUTHOR]", "Name of post author") do |episode_author|
+        post_header['author'] = options['author'] = episode_author
+      end
+
+      opts.on("-c", "--chapters [chapter1,chapter2,...]", Array, "The episodes chapters.") do |episode_chapters|
+        warn episode_chapters.inspect
+        post_header['chapters'] = options['chapters'] = episode_chapters
+      end
+
+      opts.on("-d", "--duration [DURATION]", "Duration of the episode") do |episode_duration|
+        post_header['duration'] = options['duration'] = episode_duration.to_i
+      end
+
+      opts.on("-e", "--explicit [yes/no]", "Explicit rating for this episode (default: 'no')") do |episode_explicit|
+        post_header['explicit'] = options['explicit'] = episode_explicit
+      end
+
+      opts.on("--episode-cover [PATH]", "Path to the image that represents the episode.") do |episode_cover|
+        post_header['episode_cover'] = options['episode_cover'] = episode_cover
+      end
+
+      opts.on("-l", "--layout [LAYOUT]", "Layout to use (default: 'post')") do |episode_layout|
+        post_header['layout'] = options['layout'] = episode_layout
+      end
+
+      opts.on("-p", "--posts-dir [PATH]", "Path to the post directory (default: '_posts')") do |episode_posts_dir|
+        options['posts_dir'] = episode_posts_dir
+      end
+
+      opts.on("-s", "--subtitle [TEXT]", "Subtitle of the episode") do |episode_subtitle|
+        post_header['subtitle'] = options['subtitle'] = episode_subtitle
+      end
+
+      opts.on("--summary [TEXT]", "Summary of the episode") do |episode_summary|
+        post_header['summary'] = options['summary'] = episode_summary
+      end
+
+      opts.on("--tags [tag1,tag2,...]", Array, "Tags for the episode") do |episode_tags|
+        post_header['tags'] = options['tags'] = episode_tags
+      end
+
+      opts.on("-t", "--title [TEXT]", "Title of the episode") do |episode_title|
+        post_header['title'] = options['title'] = episode_title
+      end
+    end
+    opts.parse!
+
+    unless FileTest.directory?(options['posts_dir'])
+      abort("rake aborted: '#{options['posts_dir']}' directory not found.")
+    end
+
+    post_header['title'] = post_header['title'] || 'untitled'
+    slug = post_header['title'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '_')
+    date = Time.now.strftime('%Y-%m-%d')
+
+    filename = File.join(options['posts_dir'], "#{date}-#{slug}#{DEFAULT_EXT}")
+
+    abort() unless write_file?(filename)
+
+    open(filename, 'w') do |post|
+      post.puts post_header.to_yaml
+      post.puts '---'
+      post.puts "Insert eloquent and worth reading text here.\n\n"
+      post.puts "{{ page | web_player:site }}\n\n"
+      post.puts "## Shownotes\n* Note"
+    end
+
+    puts "Created new episode: #{filename}" if File.exists?(filename)
+
+  when 'deploy'
+    opts = OptionParser.new do |opts|
+      opts._octopod_banner = deploy_help
+
+      opts.on("--document-root [PATH]", "Path to the documwrite_fileent root on the remote machine") do |deploy_document_root|
+        options['document_root'] = deploy_document_root
+      end
+
+      opts.on("--rsync-delete", "Delete extraneous files from destination dir") do |deploy_rsync_delete|
+        options['rsync_delete'] = deploy_rsync_delete
+      end
+
+      opts.on("--ssh-host [USER@]<HOST>", "[User and] host of the destination machine") do |deploy_ssh_host|
+        options['ssh_host'] = deploy_ssh_host =~ /\A\w*@.*/ ? deploy_ssh_host : "#{ENV['USER']}@#{deploy_ssh_host}"
+      end
+
+      opts.on("--ssh-port [PORT]", "SSH port on the remote machine") do |deploy_ssh_port|
+        options['ssh_port'] = deploy_ssh_port.to_i
+      end
+    end
+    opts.parse!
+
+    options['public_dir'] = ARGV[1] ? ARGV[1] : File.join(PWD, '_site')
+    exclude = ""
+    if File.exists?('./rsync-exclude')
+      exclude = "--exclude-from '#{File.expand_path('./rsync-exclude')}'"
+    end
+    puts "## Deploying website via Rsync"
+
+    rsync_command = "rsync --progress -avze 'ssh -p #{options['ssh_port']}' #{exclude} \
+      #{"--delete" unless options['rsync_delete'] == false} \
+      #{options['public_dir']}/ #{options['ssh_host']}:#{options['document_root']}"
+
+    ok_failed system(rsync_command)
+
+  when 'setup'
+    unless File.exists?(PWD + '/_config.dist_backup.yml')
+      puts "", "===== Creating a backup of the configuation file ... ====="
+      FileUtils.cp(PWD + '/_config.yml', PWD + '/_config.dist_backup.yml', {verbose: true})
+      puts "===== ... done ===== ", ""
+    end
+
+    puts "", "===== Copying assets ... ====="
+    Dir.glob(GEM_DIR + "/assets/**/*").each do |file|
+      copy_file_or_create_dir(file)
+    end
+
+    Dir.glob(GEM_DIR + "/assets/**/.*").each do |file|
+      copy_file_or_create_dir(file)
+    end
+    puts "===== ... done ===== ", ""
+  end
+else
+  puts octopod_help if ARGV.size > 0 && ARGV[0] == '--help'
+  load Gem.bin_path('jekyll', 'jekyll')
+end

data/lib/jekyll/octopod/version.rb

@@ -2,7 +2,7 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,15 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-octopod
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
+- Arne Eilermann
 - Stefan Haslinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-05-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -28,12 +43,14 @@ description: Enables you to publish your podcast using the Jekyll static site ge
   creating feeds and a reasonably looking website
 email:
 - stefan.haslinger@informatom.com
-executables: []
+executables:
+- octopod
 extensions: []
 extra_rdoc_files: []
 files:
 - README.rdoc
 - Rakefile
+- bin/octopod
 - lib/jekyll/octopod/version.rb
 - lib/octopod.rb
 homepage: https://github.com/haslinger/jekyll-