fullstack-rss 0.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem 'rails'
+
+group :development do  
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,94 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.11)
+      actionpack (= 3.2.11)
+      mail (~> 2.4.4)
+    actionpack (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.11)
+      activesupport (= 3.2.11)
+      builder (~> 3.0.0)
+    activerecord (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.11)
+      activemodel (= 3.2.11)
+      activesupport (= 3.2.11)
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.7.6)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.3)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.11)
+      actionmailer (= 3.2.11)
+      actionpack (= 3.2.11)
+      activerecord (= 3.2.11)
+      activeresource (= 3.2.11)
+      activesupport (= 3.2.11)
+      bundler (~> 1.0)
+      railties (= 3.2.11)
+    railties (3.2.11)
+      actionpack (= 3.2.11)
+      activesupport (= 3.2.11)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler (~> 1.8.4)
+  rails

data/README.md

@@ -0,0 +1,105 @@
+# Fullstack-rss
+
+RSS Feed Gem for fullstack-cms
+
+## Installation
+
+``` rb
+  gem 'fullstack-rss'
+```
+
+## Usage
+
+First of all any item shoud respond at least to `:title`, `:link`, `:pubdate`, `:category` and `:description`, `:guid` and `:guid_is_permalink?`.
+
+The simplest way to achieve that is use a decorator:
+
+``` rb
+class PostRssItem < Fullstack::Rss::Item
+  
+  # ============
+  # = Required =
+  # ============
+  
+  def title
+    cdata(object.title)
+  end
+  
+  def link
+    site_post_url(object)
+  end
+  
+  def pubdate
+    object.created_at.xmlschema
+  end
+  
+  def category
+    cdata(object.category.title) # cdata helper is provided by Fullstack::Rss::ItemDecorator
+  end
+  
+  def description
+    cdata(object.intro.html_safe)
+  end
+  
+  # ============
+  # = Optional =
+  # ============
+  
+  def guid
+    link # this is the default 
+  end
+  
+  def guid_is_permalink?
+    false # this is also the default
+  end
+
+end
+```
+
+Then you can build a feed like that
+
+``` rb
+class Site::SiteController < Site::BaseController
+
+  include Fullstack::Rss::Helpers
+  
+  # ...
+  
+  action :feed, :path => "/feed", :format => "xml"
+    @items = Post.all.map { |post|  PostRssItem.new(post) }
+    render_feed @items
+  end
+
+end
+```
+
+And link it in your views with `rss_feed_link`
+
+``` rhtml
+<%= rss_feed_link site_feed_url %>
+```
+
+---
+
+Copyright (c) 2012 mcasimir
+
+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.
+
+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/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fullstack-rss"
+  gem.homepage = "http://github.com/mcasimir/kaminari-bootstrap"
+  gem.license = "MIT"
+  gem.summary = %Q{RSS Feed Gem for fullstack-cms}
+  gem.description = %Q{RSS Feed Gem for fullstack-cms}
+  gem.email = "maurizio.cas@gmail.com"
+  gem.authors = ["mcasimir"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+
+task :push do
+  message = ENV["message"] || "commit #{Time.now}"
+  `git add . && git commit -a -m '#{message}' && git push`
+end
+
+task "release:patch" do
+  Rake::Task["gemspec"].invoke
+  Rake::Task["version:bump:patch"]
+  Rake::Task["push"].invoke
+  Rake::Task["release"].invoke  
+end
+
+task "release:minor" do
+  Rake::Task["gemspec"].invoke
+  Rake::Task["version:bump:minor"]
+  Rake::Task["push"].invoke
+  Rake::Task["release"].invoke  
+end
+
+task "release:major" do
+  Rake::Task["gemspec"].invoke
+  Rake::Task["version:bump:major"]
+  Rake::Task["push"].invoke
+  Rake::Task["release"].invoke  
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/app/views/fullstack/rss/feed.xml.erb

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rss version="2.0"
+  xmlns:atom="http://www.w3.org/2005/Atom">
+
+  <channel>
+    <title><%= options[:title] %></title>
+    <atom:link href="<%= request.url %>" rel="self" type="application/rss+xml" />
+    <link><%= options[:link] %></link>
+    <description><%= options[:description] %></description>
+    <lastBuildDate><%= Time.now.xmlschema %></lastBuildDate>
+    <language><%= options[:language] || I18n.default_locale.to_s %></language>
+
+    <% items.each do |item| %>
+    <item>
+      <title><%= item.title %></title>
+      <link><%= item.link %></link>
+      <pubDate><%= item.pubdate %></pubDate>
+      <category><%= item.category %></category>
+      <guid isPermaLink="<%= item.guid_is_permalink? %>"><%= item.guid %></guid>
+      <description><%= item.description %></description>
+    </item>
+    <% end -%>
+
+  </channel>
+</rss>

data/fullstack-rss.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "fullstack-rss"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mcasimir"]
+  s.date = "2013-01-09"
+  s.description = "RSS Feed Gem for fullstack-cms"
+  s.email = "maurizio.cas@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "app/views/fullstack/rss/feed.xml.erb",
+    "fullstack-rss.gemspec",
+    "lib/fullstack-rss.rb",
+    "lib/fullstack/rss.rb",
+    "lib/fullstack/rss/engine.rb",
+    "lib/fullstack/rss/helpers.rb",
+    "lib/fullstack/rss/item.rb"
+  ]
+  s.homepage = "http://github.com/mcasimir/kaminari-bootstrap"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "RSS Feed Gem for fullstack-cms"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/fullstack/rss/engine.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module Fullstack
+  module Rss
+    class Engine < ::Rails::Engine
+    
+    end
+  end
+end

data/lib/fullstack/rss/helpers.rb

@@ -0,0 +1,41 @@
+module Fullstack
+  module Rss
+    module Helpers
+      extend ActiveSupport::Concern
+        
+      included do
+        helper_method :rss_feed_link
+      end
+      
+      # eg.
+      # render_feed( @items, 
+      #     title:        @feed_title,
+      #     link:         root_url,
+      #     description:  "This is a great feed.",
+      #     language:     "en"
+      # )
+      
+      def render_feed(items, options = {})
+        render :template => "fullstack/rss/feed.xml.erb", :locals => { :items => items, :options => options }
+      end
+      
+      protected
+    
+      # This is just a little helper to link feeds.
+      #
+      # usage:
+      # <%= rss_feed_link site_feed_path, :title => "Intresting stuffs from my blog" %>
+      #
+      
+      def rss_feed_link(url, options = {})
+        title = options.delete(:title)
+        raise ":title option is required" if !title
+        title = view_context.h(title)
+      
+        "<link rel=\"alternate\" type=\"application/rss+xml\" title=\"#{title}\" href=\"#{url}\" />"
+      end
+      
+      
+    end
+  end
+end

data/lib/fullstack/rss/item.rb

@@ -0,0 +1,68 @@
+# Any item shoud respond at least to :title, :link, :pubdate, :category, :guid, :description, :guid_is_permalink.
+# 
+# The simplest way to achieve that is use a decorator:
+# 
+# class PostRssItem < Fullstack::Rss::Item
+#   
+#   # ============
+#   # = Required =
+#   # ============
+#   
+#   delegate :title, :to => :object
+#   
+#   def link
+#     site_post_url(object)
+#   end
+#   
+#   def pubdate
+#     object.created_at.xmlschema
+#   end
+#   
+#   def category
+#     cdata(object.category.title) # cdata helper is provided by Fullstack::Rss::ItemDecorator
+#   end
+#   
+#   def description
+#     cdata(object.intro.html_safe)
+#   end
+#   
+#   # ============
+#   # = Optional =
+#   # ============
+#   
+#   def guid
+#     link # this is the default 
+#   end
+#   
+#   def guid_is_permalink?
+#     false # this is also the default
+#   end
+# 
+# end
+
+module Fullstack
+  module Rss
+    class Item
+      
+      attr_accessor :object
+      def initialize(object)
+        @object = object
+      end
+  
+      def guid
+        link
+      end
+        
+      def guid_is_permalink?
+        false
+      end
+      
+      protected
+      
+      def cdata(text)
+        "<![#{text}]]>".html_safe
+      end
+      
+    end
+  end
+end

data/lib/fullstack/rss.rb

@@ -0,0 +1,92 @@
+# Author::    Maurizio Casimirri (mailto:maurizio.cas@gmail.com)
+# Copyright:: Copyright (c) 2012 Maurizio Casimirri
+# 
+# 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.
+
+
+# =========
+# = Usage =
+# =========
+# 
+# # site_controller.rb
+#
+# include Fullstack::Rss::Helpers
+#
+# action :feed, :path => "/feed", :format => "xml"
+#   @items = Post.all.map { |post|  PostRssItem.new(post) }
+#   render_feed @items
+# end
+# 
+# # _head.html.erb
+#
+# <%= rss_feed_link site_feed_url %>
+# 
+# Any item shoud respond at least to :title, :link, :pubdate, :category, :guid, :description, :guid_is_permalink.
+# 
+# The simplest way to achieve that is use a decorator:
+# 
+# class PostRssItem < Fullstack::Rss::Item
+#   
+#   # ============
+#   # = Required =
+#   # ============
+#   
+#   delegate :title, :to => :object
+#   
+#   def link
+#     site_post_url(object)
+#   end
+#   
+#   def pubdate
+#     object.created_at.xmlschema
+#   end
+#   
+#   def category
+#     cdata(object.category.title) # cdata helper is provided by Fullstack::Rss::ItemDecorator
+#   end
+#   
+#   def description
+#     cdata(object.intro.html_safe)
+#   end
+#   
+#   # ============
+#   # = Optional =
+#   # ============
+#   
+#   def guid
+#     link # this is the default 
+#   end
+#   
+#   def guid_is_permalink?
+#     false # this is also the default
+#   end
+# 
+# end
+
+
+require 'fullstack/rss/engine'
+require 'fullstack/rss/helpers'
+
+module Fullstack
+  module Rss
+   
+  end
+end
+

data/lib/fullstack-rss.rb

@@ -0,0 +1,3 @@
+require 'fullstack-rss/engine'
+
+require "fullstack/rss"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: fullstack-rss
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- mcasimir
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: RSS Feed Gem for fullstack-cms
+email: maurizio.cas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- app/views/fullstack/rss/feed.xml.erb
+- fullstack-rss.gemspec
+- lib/fullstack-rss.rb
+- lib/fullstack/rss.rb
+- lib/fullstack/rss/engine.rb
+- lib/fullstack/rss/helpers.rb
+- lib/fullstack/rss/item.rb
+homepage: http://github.com/mcasimir/kaminari-bootstrap
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4068807422851151234
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RSS Feed Gem for fullstack-cms
+test_files: []