refinerycms-podcast 0.5

data/app/controllers/admin/podcasts_controller.rb

@@ -0,0 +1,5 @@
+class Admin::PodcastsController < Admin::BaseController
+
+  crudify :podcast, :title_attribute => :title, :order => "published DESC"
+
+end

data/app/controllers/podcasts_controller.rb

@@ -0,0 +1,12 @@
+class PodcastsController < ApplicationController
+
+  def index
+    respond_to do |format|
+      format.rss do
+        @items = Podcast.all
+        render :layout => false
+      end
+    end
+  end
+
+end

data/app/models/podcast.rb

@@ -0,0 +1,24 @@
+class Podcast < ActiveRecord::Base
+
+  acts_as_indexed :fields => [:title, :author, :subtitle, :duration, :keywords, :summary]
+
+  validates_presence_of :title
+  validates_uniqueness_of :title
+  # validations to be added yet
+
+  belongs_to :file, :class_name => 'Resource'
+  
+  default_scope :order => "published DESC"
+
+  def episode_number
+    episode = 0
+    
+    Podcast.find(:all, :order => "published ASC").each do |p|
+      episode += 1
+      break if p === self
+    end
+    
+    episode
+  end
+
+end

data/app/views/admin/podcasts/_form.html.erb

@@ -0,0 +1,59 @@
+<% form_for [:admin, @podcast] do |f| -%>
+  <%= f.error_messages %>
+  
+  <div class='field'>
+    <%= f.label :title -%>
+    <%= f.text_field :title, :class => 'larger widest' -%>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :subtitle -%>
+    <%= f.text_field :subtitle, :size => 100 -%>
+  </div>
+  
+  <div class='field'>
+    <span class='label_with_help'>
+      <%= f.label :file, 'Podcast file' -%>
+      <%= refinery_help_tag "Supported file formats include .m4a, .mp3, .mov, .mp4, .m4v, and .pdf" %>
+    </span>
+    <%= render :partial => "/shared/admin/resource_picker", :locals => {
+      :f => f,
+      :field => :file_id,
+      :resource => @podcast.file,
+      :description => "podcast"
+    } %>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :published -%>
+    <%= f.date_select :published -%>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :author -%>
+    <%= f.text_field :author -%>
+  </div>
+  
+  <div class='field'>
+    <span class='label_with_help'>
+      <%= f.label :duration -%>
+      <%= refinery_help_tag "In HH:MM:SS format. E.g. \"10:22\" for 10 minutes 22 seconds" %>
+    </span>
+    <%= f.text_field :duration, :size => 6 -%>
+  </div>
+  
+  <div class='field'>
+    <span class='label_with_help'>
+      <%= f.label :keywords -%>
+      <%= refinery_help_tag "Up to 12 keywords separated by commas. <br/><br/>E.g. rails, ruby on rails, refinerycms, refinery. <br/><br/>According to iTunes, the best use for keywords is to include common misspellings of your name or title, to ensure your podcast is still searchable despite a misspelling. To prevent keyword abuse, iTunes indexes only the first 12 keywords found in this tag." %>
+    </span>
+    <%= f.text_field :keywords, :size => 100  -%><br/>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :summary -%>
+    <%= f.text_area :summary, :rows => 5, :class => 'widest' -%>
+  </div>
+  
+  <%= render :partial => "/shared/admin/form_actions", :locals => {:f => f, :continue_editing => false} %>
+<% end -%>

data/app/views/admin/podcasts/_podcast.html.erb

@@ -0,0 +1,16 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(podcast) -%>">
+  <span class='title'>
+    #<%= podcast.episode_number %> <%=h podcast.title %>
+    <span class="preview">- <%=h truncate(podcast.subtitle, :length => 50) %></span>
+  </span>
+  <span class='actions'>
+    <%# link_to refinery_icon_tag("page_white_put.png"), podcast.file.public_filename,
+        :title =>  'Download File',
+        :target => "_blank" %>
+    <%= link_to refinery_icon_tag("application_edit.png"), edit_admin_podcast_path(podcast),
+         :title => t('.edit') %>
+    <%= link_to refinery_icon_tag("delete.png"), admin_podcast_path(podcast),
+        :class => "cancel confirm-delete",
+        :title => t('.delete') %>
+  </span>
+</li>

data/app/views/admin/podcasts/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

data/app/views/admin/podcasts/index.html.erb

@@ -0,0 +1,34 @@
+<div id='actions'>
+  <ul>
+    <li>
+      <%= render :partial => "/shared/admin/search", :locals => {:url => admin_podcasts_url} %>
+    </li>
+    <li>
+      <%= link_to "Create New Podcast", new_admin_podcast_url, :class => "add_icon" %>
+    </li>
+  </ul>
+</div>
+<div id='records'>
+  <% if searching? %>
+    <h2><%= t('admin.search_results_for', :query => params[:search]) %></h2>
+    <% if @podcasts.any? %>
+      <%= render :partial => "podcast", :collection => @podcasts %>
+    <% else %>
+      <p><%= t('admin.search_no_results') %></p>
+    <% end %>
+  <% else %>
+    <% if @podcasts.any? %>
+      <%= will_paginate @podcasts, :previous_label => '&laquo;', :next_label => '&raquo;' %>
+       <ul id='sortable_list'>
+        <%= render :partial => "podcast", :collection => @podcasts %>
+       </ul>
+      <%= will_paginate @podcasts, :previous_label => '&laquo;', :next_label => '&raquo;' %>
+    <% else %>
+      <p>
+        <strong>
+          <%= t('.no_items_yet') %>
+        </strong>
+      </p>
+    <% end %>
+  <% end %>
+</div>

data/app/views/admin/podcasts/new.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

data/app/views/podcasts/index.rss.builder

@@ -0,0 +1,56 @@
+xml.instruct!
+
+xml.rss 'xmlns:itunes' => 'http://www.itunes.com/dtds/podcast-1.0.dtd', :version => "2.0"
+xml.channel do
+  # NOTE: Fill in everything with your own data down to the categories.
+  xml.title 'Your Podcast Title'
+  xml.link 'http://yoursite.com/'
+  
+  #  Accepted values are those in the ISO 639-1 Alpha-2 list (two-letter language codes, some with possible modifiers, such as "en-us").
+  xml.language 'en-us'
+  
+  xml.copyright "℗ & © #{Time.now.year} Jack & Jill"
+  xml.tag!('itunes:subtitle', 'A show about everything')
+  
+  # The content of this tag is shown in the Artist column in iTunes.
+  xml.tag!('itunes:author', 'John Doe')
+  
+  # The contents of this tag are shown in a separate window that appears when the 
+  # "circled i" in the Description column is clicked. It also appears on the iTunes 
+  # page for your podcast. This field can be up to 4000 characters. 
+  description = "All About Everything is a show about everything. Each week we dive into any subject known to man and talk about it as much as we can. Look for our Podcast in the iTunes Store"
+  
+  xml.tag!('itunes:summary', description)
+  xml.description description
+  
+  # This tag contains information that will be used to contact the owner of the podcast
+  # for communication specifically about their podcast. It will not be publicly displayed.
+  xml.tag!('itunes:owner') do |owner|
+    xml.tag!('itunes:name', 'John Doe')
+    xml.tag!('itunes:email', 'john.doe@example.com')
+  end
+  
+  # upload an image to your resources tab and link it in here
+  # iTunes prefers square .jpg images that are at least 600 x 600 pixels
+  xml.tag!('itunes:image', 'http://mysite.com/system/0000/1000x1000.jpg')
+  
+  # select from the list of categories here:
+  # http://www.apple.com/itunes/podcasts/specs.html#categories
+  xml.tag!('itunes:category', :text => "Technology") do |category|
+    xml.tag!('itunes:category', :text => "Software How-To")
+  end
+  
+  @items.each do |item|
+    xml.item do
+      xml.title item.title
+      xml.tag!('itunes:author', item.author)
+      xml.subtitle item.subtitle
+      xml.summary item.summary   
+      xml.enclosure :url => item.file.public_filename, :length => item.file.size, :length => item.file.content_type
+      xml.tag!('pubDate', item.published.strftime("%a, %d %b %Y %H:%M:%S %Z"))
+      xml.tag!('itunes:duration', item.duration)
+      xml.tag!('itunes:keywords', item.keywords)
+    end
+  end
+end
+

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+en:
+  admin:
+    podcasts:
+      index:
+        create_new: Create a new Podcast
+        reorder: Reorder Podcasts
+        reorder_done: Done Reordering Podcasts
+        sorry_no_results: Sorry! There are no results found.
+        no_items_yet: There are no podcasts yet. Click "Create a new Podcast" to add your first podcast.
+      podcast:
+        view_live: View this podcast live <br/><em>(opens in a new window)</em>
+        edit: Edit this podcast
+        delete: Remove this podcast forever
+  podcasts:
+    show:
+      other: Other Podcasts

data/config/locales/nl.yml

@@ -0,0 +1,16 @@
+nl:
+  admin:
+    podcasts:
+      index:
+        create_new: Maak een nieuwe Podcast
+        reorder: Wijzig de volgorde van de Podcasts
+        reorder_done: Klaar met het wijzingen van de volgorde van de Podcasts
+        sorry_no_results: Helaas! Er zijn geen resultaten gevonden.
+        no_items_yet: Er zijn nog geen podcasts. Druk op 'Maak een nieuwe Podcast' om de eerste aan te maken.
+      podcast:
+        view_live: Bekijk deze podcast op de website <br/><em>(opent een nieuw venster)</em>
+        edit: Bewerk deze podcast
+        delete: Verwijder deze podcast voor eeuwig
+  podcasts:
+    show:
+      other: Andere Podcasts

data/config/routes.rb

@@ -0,0 +1,10 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :podcasts
+
+  map.namespace(:admin, :path_prefix => 'refinery') do |admin|
+    admin.resources :podcasts, :collection => {:update_positions => :post, :settings => :get}
+  end
+  
+  map.podcast '/podcast.rss', :controller => "podcasts", :action => "index", :format => "rss"
+
+end

data/generators/podcast/podcast_generator.rb

@@ -0,0 +1,23 @@
+class PodcastGenerator < Rails::Generator::NamedBase
+
+  def initialize(*runtime_args)
+    # set first argument to the table's name so that the user doesn't have to pass it in.
+    runtime_args[0] = ["podcasts"]
+    super(*runtime_args)
+  end
+
+  def banner
+    "Usage: script/generate podcast"
+  end
+
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', 'db/migrate',
+        :migration_file_name => "create_structure_for_podcast",
+        :assigns => {
+          :migration_name => "CreateStructureForPodcast"
+        }
+    end
+  end
+
+end if defined?(Rails::Generator::NamedBase)

data/generators/podcast/templates/migration.rb

@@ -0,0 +1,32 @@
+class <%= migration_name %> < ActiveRecord::Migration
+
+  def self.up
+    create_table :podcasts do |t|
+      t.string :title
+      t.string :author
+      t.string :subtitle
+      t.integer :file_id
+      t.date :published
+      t.string :duration
+      t.string :keywords
+      t.text :summary
+      t.integer :position
+
+      t.timestamps
+    end
+
+    add_index :podcasts, :id
+
+    User.find(:all).each do |user|
+      user.plugins.create(:name => "Podcast",
+                          :position => (user.plugins.maximum(:position) || -1) +1)
+    end
+  end
+
+  def self.down
+    UserPlugin.destroy_all({:title => "Podcast"})
+
+    drop_table :podcasts
+  end
+
+end

data/lib/gemspec.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+require File.expand_path('../refinery/podcast.rb', __FILE__)
+version = Refinery::Podcast.version
+raise "Could not get version so gemspec can not be built" if version.nil?
+files = Dir.glob("**/*").flatten.reject do |file|
+  file =~ /\.gem(spec)?$/
+end
+
+gemspec = <<EOF
+Gem::Specification.new do |s|
+  s.name              = %q{refinerycms-podcast}
+  s.version           = %q{#{version}}
+  s.description       = %q{Plugin for Refinery CMS to manage and publish podcasts to iTunes}
+  s.date              = %q{#{Time.now.strftime('%Y-%m-%d')}}
+  s.summary           = %q{Ruby on Rails podcast plugin for RefineryCMS.}
+  s.email             = %q{info@refinerycms.com}
+  s.homepage          = %q{http://refinerycms.com}
+  s.authors           = %w(David\\ Jones)
+  s.require_paths     = %w(lib)
+
+  s.files             = [
+    '#{files.join("',\n    '")}'
+  ]
+  #{"s.test_files        = [
+    '#{Dir.glob("test/**/*.rb").join("',\n    '")}'
+  ]" if File.directory?("test")}
+end
+EOF
+
+File.open(File.expand_path("../../refinerycms-podcast.gemspec", __FILE__), 'w').puts(gemspec)

data/lib/refinery/podcast.rb

@@ -0,0 +1,15 @@
+module Refinery
+  module Podcast
+
+    def self.version
+      ::Refinery::Podcast::Version.to_s
+    end
+
+    class Version
+      def self.to_s
+        %q{0.5}
+      end
+    end
+
+  end
+end

data/lib/tasks/podcast.rake

@@ -0,0 +1,35 @@
+namespace :refinery do
+  namespace :podcast do
+	  desc "Install extra files from the podcast plugin"
+
+  	task :install do
+  		[%w(db migrate), %w(app views podcasts)].each do |dir|
+        Rails.root.join(dir.join(File::SEPARATOR)).mkpath
+      end
+
+      podcast_root = Pathname.new(File.expand_path("../../../", __FILE__))
+      copies = [
+        {:from => %w(app views podcasts), :to => %w(app views podcasts), :filename => "index.rss.builder"},
+      ]
+      puts "\nCopying files...\n\n"
+    	copies.each do |copy|
+        copy_from = podcast_root.join(copy[:from].join(File::SEPARATOR), copy[:filename])
+    	  copy_to = Rails.root.join(copy[:to].join(File::SEPARATOR), copy[:filename])
+        unless copy_to.exist? and ENV["force"].presence.to_s != "true"
+    	    FileUtils::cp copy_from.to_s, copy_to.to_s
+    	    puts "Copied to #{copy_to}"
+        else
+          puts "'#{File.join copy[:to], copy[:filename]}' already existed in your application so your existing file was not overwritten - use force=true to overwrite."
+          puts "Without this file being up to date, the podcast may not function properly."
+        end
+      end
+
+    	puts "\nCopied all files."
+    	puts "\nGenerating migration..."
+    	puts `ruby #{Rails.root.join('script', 'generate').cleanpath.to_s.gsub(/\/$/, '')} podcast`
+    	puts "\nNow, run these tasks:"
+    	puts "  rake db:migrate"
+    	puts "\nWe hope you enjoy using our podcast plugin!\n\n"
+  	end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+ 
+Copyright (c) 2005-2010 [Resolve Digital Ltd.](http://www.resolvedigital.co.nz)
+ 
+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/rails/init.rb

@@ -0,0 +1,14 @@
+Refinery::Plugin.register do |plugin|
+  plugin.title = "Podcasts"
+  plugin.name = "podcasts"
+  plugin.description = "Manage Podcasts"
+  plugin.version = 1.0
+  plugin.url = {:controller => "/admin/podcasts", :action => "index"}
+  plugin.activity = {
+    :class => Podcast,
+    :url_prefix => "edit",
+    :title => 'title'
+  }
+  # this tells refinery where this plugin is located on the filesystem and helps with urls.
+  plugin.directory = directory
+end

data/readme.md

@@ -0,0 +1,48 @@
+# Podcast plugin for [RefineryCMS](http://www.refinerycms.com) ([Github](http://github.com/djones/refinerycms-podcast))
+
+By: [David Jones](http://www.d-jones.com) from [Resolve Digital](http://www.resolvedigital.com)
+
+## Requirements
+
+Refinery CMS >= 0.9.7.7
+
+## Installation Using Gem
+
+Open your ``Gemfile`` and add this line to the bottom:
+
+    gem 'refinerycms-podcast', '= 0.5'
+
+Now run ``bundle install`` and once bundler has installed the gem run:
+
+    rake refinery:podcast:install
+
+..and follow the instructions!
+
+## Installation using Plugin
+
+From within your Refinery directory at command line, install this as a plugin using:
+
+    script/plugin install git://github.com/djones/refinerycms-podcast.git
+
+Then run:
+
+    rake refinery:podcast:install
+
+## Setup
+
+Edit ``/app/views/podcasts/index.rss.builder`` and fill out the documented parts with your podcast
+channel information.
+
+## Usage
+
+Now on the backend of Refinery you should see a new "Podcast" tab. You can add your podcasts one by one there as you wish to publish them.
+
+## iTunes Setup
+
+Your iTunes Podcast URL should now be available at:
+
+    http://yoursite.com/podcast.rss
+  
+Now you need to tell iTunes about your podcast URL. Read: [How to publish a podcast on the iTunes Store](http://support.apple.com/kb/TA23478)
+
+For more detailed technical information about making iTunes podcasts read: [Making a Podcast](http://www.apple.com/itunes/podcasts/specs.html)

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-podcast
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
+platform: ruby
+authors: 
+- David Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: Plugin for Refinery CMS to manage and publish podcasts to iTunes
+email: info@refinerycms.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/admin/podcasts_controller.rb
+- app/controllers/podcasts_controller.rb
+- app/models/podcast.rb
+- app/views/admin/podcasts/_form.html.erb
+- app/views/admin/podcasts/_podcast.html.erb
+- app/views/admin/podcasts/edit.html.erb
+- app/views/admin/podcasts/index.html.erb
+- app/views/admin/podcasts/new.html.erb
+- app/views/podcasts/index.rss.builder
+- config/locales/en.yml
+- config/locales/nl.yml
+- config/routes.rb
+- generators/podcast/podcast_generator.rb
+- generators/podcast/templates/migration.rb
+- lib/gemspec.rb
+- lib/refinery/podcast.rb
+- lib/tasks/podcast.rake
+- license.md
+- rails/init.rb
+- readme.md
+has_rdoc: true
+homepage: http://refinerycms.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby on Rails podcast plugin for RefineryCMS.
+test_files: []
+