pummel 0.3.0

data/.document

@@ -0,0 +1,3 @@
+README.md
+LICENSE
+pummel.rb

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Colin Shea
+
+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,70 @@
+# pummel
+
+Auto-tumble your RSS feed! (Default: my (Evaryont) pinboard.in links)
+
+## Dependencies
+
+* Rack
+* Sinatra
+* Ruby-OEmbed (vendored under vendor/ruby-oembed)
+* RSS (built-in in Ruby 1.8+)
+
+## Installation
+
+    $ git clone git://github.com/evaryont/pummel.git
+    $ cd pummel
+    $ edit pummel.rb
+    # Edit the file to point to your choice of RSS feed
+    $ rackup
+    # Open your browser to http://localhost:9292/
+
+## Demo (& Heroku)
+
+This web application was designed for Heroku, and is immediately compatible.
+You can see a demo (and my bookmarks!) at [Heroku][].
+
+## Inspiration
+
+I was just browsing around on the web, aimlessly when I stumbled on the [OEmbed][]
+project, and subsequently found [OohEmbed][]. The author created a small-ish
+javascript application called [Dumble][], which is exactly what Pummel is, but
+uses a user's del.icio.us bookmarks rather than Pinboard. As I don't really use
+del.icio.us but instead of pinboard.in, I decided to create my own version.
+
+Here it is.
+
+## Technical Overview
+
+This is relatively geeky overview of how Pummel works, so if you want to skip it,
+go right ahead.
+
+At application initiation, an Iconv object is created, and the RSS feed is fetched
+and parsed.
+
+Every time the index page is requested, loop through each item in the feed, and
+pull it's link. Check if the link is embeddable. If it is, determine the type and
+use the correct HTML. (Note: This perhaps should be done by Ruby-OEmbed itself.)
+If it can not be embedded, create a simple link. If there is an error when embedding,
+show the error in a <pre> block, and create a simple link.
+
+Every time the refresh page is requested (http://.../refresh) pull the feed again
+and parse it. Then redirect the user to the index page.
+
+## Note on Patches/Pull Requests
+
+1. Fork the project.
+1. Make your feature addition or bug fix.
+1. Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+1. Commit, do not mess with Rakefile, version, or history.
+   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+1. Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (C) 2010 Colin Shea. See LICENSE for details.
+
+[OEmbed]: http://www.oembed.com/
+[OohEmbed]: http://oohembed.com/
+[Dumble]: http://oohembed.com/dumble/
+[Heroku]: http://pummel-demo.heroku.com

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pummel"
+    gem.summary = %Q{Auto-tumble your RSS feed!}
+    gem.description = %Q{Given an RSS feed, make a tumblr-like site out of it. Uses Sinatra & Rack, inspired by Dumble.}
+    gem.email = "colin@evaryont.me"
+    gem.homepage = "http://github.com/evaryont/pummel"
+    gem.authors = ["Colin Shea"]
+    gem.add_dependency("sinatra")
+    gem.add_development_dependency "riot", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/config.ru

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'sinatra'
+require 'pummel'
+
+root_dir = ::File.dirname(__FILE__)
+
+set :environment, :production
+set :root,  root_dir
+set :app_file, ::File.join(root_dir, 'pummel.rb')
+disable :run
+
+#::FileUtils.mkdir_p 'log' unless ::File.exists?('log')
+#log = ::File.new("log/sinatra.log", "a")
+#$stdout.reopen(log)
+#$stderr.reopen(log)
+
+run Sinatra::Application

data/public/style.css

@@ -0,0 +1,34 @@
+/* Body image stolen from Heroku's main page (v3) */
+/* A beautiful gradient is beautiful regardless, thank you very much Heroku! */
+body {
+    background: url("/body.png") repeat-x scroll 0 0 #212121;
+    padding: 0px;
+    margin: 0px;
+    text-align: center;
+    color: #333;
+}
+
+a {
+    color: #555;
+}
+
+hr {
+    background-color: #444;
+    width: 250px;
+    height: 1px;
+    border: 0px;
+}
+
+h2 {
+    margin-bottom: 0px;
+}
+h2 a {
+    color: #fff;
+}
+h2 + span {
+    color: #bbb;
+}
+
+#oembed_feed code {
+    display: block;
+}

data/pummel.gemspec

@@ -0,0 +1,75 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pummel}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Colin Shea"]
+  s.date = %q{2010-02-16}
+  s.description = %q{Given an RSS feed, make a tumblr-like site out of it. Uses Sinatra & Rack, inspired by Dumble.}
+  s.email = %q{colin@evaryont.me}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "config.ru",
+     "public/body.png",
+     "public/favicon.ico",
+     "public/style.css",
+     "pummel.gemspec",
+     "pummel.rb",
+     "templates/index.erb",
+     "vendor/ruby-oembed/idea.rb",
+     "vendor/ruby-oembed/lib/oembed.rb",
+     "vendor/ruby-oembed/lib/oembed/errors.rb",
+     "vendor/ruby-oembed/lib/oembed/formatters.rb",
+     "vendor/ruby-oembed/lib/oembed/provider.rb",
+     "vendor/ruby-oembed/lib/oembed/provider_discovery.rb",
+     "vendor/ruby-oembed/lib/oembed/providers.rb",
+     "vendor/ruby-oembed/lib/oembed/response.rb",
+     "vendor/ruby-oembed/lib/oembed/response/link.rb",
+     "vendor/ruby-oembed/lib/oembed/response/photo.rb",
+     "vendor/ruby-oembed/lib/oembed/response/rich.rb",
+     "vendor/ruby-oembed/lib/oembed/response/video.rb",
+     "vendor/ruby-oembed/spec/provider_spec.rb",
+     "vendor/ruby-oembed/spec/providers_spec.rb",
+     "vendor/ruby-oembed/spec/response_spec.rb",
+     "vendor/ruby-oembed/spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/evaryont/pummel}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Auto-tumble your RSS feed!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sinatra>, [">= 0"])
+      s.add_development_dependency(%q<riot>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<sinatra>, [">= 0"])
+      s.add_dependency(%q<riot>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sinatra>, [">= 0"])
+    s.add_dependency(%q<riot>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/pummel.rb

@@ -0,0 +1,50 @@
+require 'iconv'
+require 'rss/1.0'
+require 'rss/2.0'
+require 'open-uri'
+require 'sinatra'
+$: << File.join(File.dirname(__FILE__), 'vendor', 'ruby-oembed', 'lib')
+require 'oembed'
+
+@@rss_url = "http://feeds.pinboard.in/rss/u:evaryont/"
+@@ic = Iconv.new('UTF-8//IGNORE', 'UTF-8')
+def refresh_rss
+    valid_string = @@ic.iconv(open(@@rss_url).read << ' ')[0..-2]
+    @@rss = RSS::Parser.parse valid_string, false
+end
+refresh_rss()
+
+set :public, File.dirname(__FILE__) + '/public'
+set :views, File.dirname(__FILE__) + '/templates'
+
+# Access to the @@rss variable, used in the template
+def rss
+    @@rss
+end
+
+# Return a string, the proper HTML for the OEmbed response
+#
+# Used in the template.
+def generate_html(oembed_response)
+    case oembed_response.field('type')
+    when 'photo'
+        return "<img src='#{oembed_response.field("url")}' width='#{oembed_response.field("width")}' height='#{oembed_response.field("height")}' />"
+    when 'video'
+        return oembed_response.field('html')
+    when 'link'
+        return "<a href='#{oembed_response.url}'>#{oembed_response.field('html') || oembed_response.url}</a>"
+    when 'rich'
+        return oembed_response.field('html')
+    else
+        "<a href='#{oembed_response.url}'>#{oembed_response.field('html') || oembed_response.url}</a>"
+    end
+end
+
+get '/' do
+    erb :index
+end
+
+get '/refresh' do
+    refresh_rss()
+    redirect '/'
+end

data/templates/index.erb

@@ -0,0 +1,22 @@
+<html><head>
+    <title>Pummel - Auto tumble your pinboard.in links!</title>
+    <link href="/style.css" media="screen" rel="stylesheet" type="text/css" />
+</head><body>
+<p>
+    <h2><a href="<%= rss.channel.link %>"><%= rss.channel.title %></a></h2>
+    <span><%= rss.channel.description %></span> (<a href="/refresh">refresh</a>)
+</p>
+<div id="oembed_feed">
+<% rss.items.each do |item| %>
+    <p><%
+   begin
+      oemb = OEmbed::Providers.get(item.link) %>
+      <%= generate_html(oemb) %>
+<% rescue OEmbed::NotFound %>
+    <a href="<%= item.link %>"><%= item.title %></a>
+<% rescue OEmbed::Error => error %>
+    <a href="<%= item.link %>"><%= item.title %></a><code>Error: <%= error.to_s %></code>
+<% end %>
+<hr /></p>
+<% end %>
+</div></body></html>

data/vendor/ruby-oembed/idea.rb

@@ -0,0 +1,37 @@
+# Adding providers:
+# The second argument defines the default format
+flickr = OEmbed::Provider.new("http://www.flickr.com/services/oembed/", :xml)
+flickr << "http://*.flickr.com/*"
+# Optional settings:
+flickr.name = "Flickr"
+flickr.url = "http://flickr.com/"
+
+# Another one:
+# The default format is json
+qik = OEmbed::Provider.new("http://qik.com/api/oembed.{format}")
+qik << "http://qik.com/*"
+
+# Get a raw XML-file from Flickr
+flickr.raw("http://flickr.com/photos/my_user/1231231312")
+# Get a raw JSON-file from Flickr
+flickr.raw("http://flickr.com/photos/my_user/1231231312", :format => :json)
+
+# Register both providers
+OEmbed::Providers.register(flickr, qik)
+
+# Get a raw XML-file from whichever provider matches
+OEmbed::Providers.raw("http://qik.com/video/1", :format => :xml)
+
+# Returns a OEmbed::Response using XmlSimple library to parse the response
+res = flickr.get("http://flickr.com/photos/my_user/1231231312")
+# Returns a OEmbed::Response using the JSON library to parse the response
+res = flickr.get("http://flickr.com/photos/my_user/1231231312", :format => :json)
+
+res.is_a?(OEmbed::Response) # => true
+res.type # => "photo"
+res.version # => "1.0"
+res.html # => "<img src='http://farm1.static.flickr.com/2312/3123123_123123.jpg' />"
+res.author_name # => "my_user"
+res.author_url # => "http://flickr.com/photos/my_user"
+res.provider.url # => "http://flickr.com/"
+res.provider.name # => "Flickr"

data/vendor/ruby-oembed/lib/oembed.rb

@@ -0,0 +1,14 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'net/http'
+
+require 'oembed/errors'
+require 'oembed/formatters'
+require 'oembed/provider'
+require 'oembed/provider_discovery'
+require 'oembed/providers'
+require 'oembed/response'
+require 'oembed/response/photo'
+require 'oembed/response/video'
+require 'oembed/response/link'
+require 'oembed/response/rich'

data/vendor/ruby-oembed/lib/oembed/errors.rb

@@ -0,0 +1,28 @@
+module OEmbed
+  class Error < StandardError
+  end
+
+  class NotFound < OEmbed::Error
+    def to_s
+      "No embeddable content at '#{super}'"
+    end
+  end
+
+  class UnknownFormat < OEmbed::Error
+    def to_s
+      "The provider doesn't support the '#{super}' format"
+    end
+  end
+
+  class FormatNotSupported < OEmbed::Error
+    def to_s
+      "This server doesn't have the correct libraries installed to support the '#{super}' format"
+    end
+  end
+
+  class UnknownResponse < OEmbed::Error
+    def to_s
+      "Got unknown response (#{super}) from server"
+    end
+  end
+end