murlsh 0.6.1 → 0.7.0

data/.gitignore

@@ -1,3 +1,6 @@
 *~
+\#*#
+\.#*
+*\.gem
 public/css/*.gen.css
 public/js/*.gen.js

data/README.textile

@@ -11,9 +11,15 @@ Simple site for a small group of people to share or archive urls.
 * plug-in interface
 * PubSubHubbub notification
 
+!http://static.mmb.s3.amazonaws.com/murlsh_screenshot.jpg!
+
+!http://static.mmb.s3.amazonaws.com/murlsh_iphone_screenshot.jpg!
+
 See "http://urls.matthewm.boedicker.org/":http://urls.matthewm.boedicker.org/ for example.
 
-Phusion Passenger Setup:
+h1. Installation
+
+h2. Phusion Passenger
 
 <pre>
 <code>
@@ -28,8 +34,25 @@ In the web directory:
 <code>
 murlsh
 edit config.yaml
-rake db:init user:add
+rake init
 </code>
 </pre>
 
+h1. PubSubHubbub
+
+Murlsh can notify "PubSubHubbub":http://code.google.com/p/pubsubhubbub/ hubs
+when a new url is added by adding them to config.yaml. The pubsubhubbub_hubs
+key is a list of hashes in the following format:
+
+<pre>
+<code>
+pubsubhubbub_hubs:
+- publish_url: http://pubsubhubbub.appspot.com/publish
+  subscribe_url: http://pubsubhubbub.appspot.com/
+</code>
+</pre>
+
+publish_url is where the notifications get sent
+subscribe_url is what gets put in the feed as link rel="hub"
+
 Questions and comments: "matthewm@boedicker.org":mailto:matthewm@boedicker.org

data/Rakefile

@@ -8,8 +8,6 @@ pp
 uri
 yaml
 
-rubygems
-
 flog
 spec/rake/spectask
 sqlite3
@@ -19,6 +17,21 @@ murlsh
 
 config = YAML.load_file('config.yaml')
 
+desc 'Initialize a new installation.'
+task :init => %w{db:init user:add compress} do
+  puts <<-eos
+
+Things you might want to do now:
+
+- visit #{config['root_url']} in a browser
+- 'rake post_sh > url_post.sh' to generate a shell script for posting urls
+
+eos
+end
+
+desc 'Combine and compress static files.'
+task :compress => %w{css:compress js:compress}
+
 desc "Test remote content type fetch for a URL and show errors."
 task :content_type, :url do |t, args|
   puts URI(args.url).extend(Murlsh::UriAsk).content_type(:failproof => false,
@@ -96,6 +109,14 @@ end
 desc "Run test suite."
 Spec::Rake::SpecTask.new('test') do |t|
   t.spec_files = FileList['spec/*_spec.rb']
+  t.spec_opts = %w{--color}
+  # list of places to check for unicode_formatter.rb and use it if found
+  %w{unicode_formatter.rb}.map { |x| File.expand_path(x) }.each do |f|
+    if File.exists?(f)
+      t.spec_opts.push(*%W{--require #{f} --format UnicodeFormatter})
+      break
+    end
+  end
   t.verbose = true
   t.warning = true
 end
@@ -161,7 +182,7 @@ task :post_sh do
 
 URL="$1"
 VIA="$2"
-AUTH="$3" # password can be passed as second parameter or hardcoded here
+AUTH="$3" # password can be passed as third parameter or hardcoded here
 
 curl \\
   --data-urlencode "url=${URL}" \\
@@ -189,7 +210,7 @@ namespace :css do
 
   desc 'Combine and compress css.'
   task :compress => ['public/css'] do
-    combined = cat(config['css_files'].collect { |x| "public/#{x}" }, "\n")
+    combined = cat(config['css_files'].map { |x| "public/#{x}" }, "\n")
 
     md5sum = Digest::MD5.hexdigest(combined)
 
@@ -204,6 +225,7 @@ namespace :css do
 
     unless config['css_compressed'] == compressed_url
       config['css_compressed'] = compressed_url
+      config.extend(Murlsh::YamlOrderedHash)
       open('config.yaml', 'w') { |f| YAML.dump(config, f) }
       puts "updated config with css_compressed = #{compressed_url}"
     end
@@ -217,7 +239,7 @@ namespace :js do
 
   desc 'Combine and compress javascript.'
   task :compress => ['public/js'] do
-    combined = cat(config['js_files'].collect { |x| "public/#{x}" } )
+    combined = cat(config['js_files'].map { |x| "public/#{x}" } )
 
     compressed = Net::HTTP.post_form(
       URI.parse('http://closure-compiler.appspot.com/compile'), {
@@ -240,11 +262,20 @@ namespace :js do
 
     unless config['js_compressed'] == compressed_url
       config['js_compressed'] = compressed_url
+      config.extend(Murlsh::YamlOrderedHash)
       open('config.yaml', 'w') { |f| YAML.dump(config, f) }
       puts "updated config with js_compressed = #{compressed_url}"
     end
   end
 
+  desc 'Run javascript through jslint.'
+  task :lint do
+    %{public/js/js.js}.each do |jsf|
+      puts jsf
+      puts `rhino http://www.jslint.com/rhino/jslint.js #{jsf}`
+    end
+  end
+
 end
 
 def ask(prompt, sep=':')
@@ -269,6 +300,7 @@ begin
       builder 2.1.2
       hpricot 0.8.1
       htmlentities 4.2.0
+      json 1.2.3
       rack 1.0.0
       sqlite3-ruby 1.2.1
      }.each_slice(2) { |g,v| gemspec.add_dependency(g, ">= #{v}") }

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/bin/murlsh

@@ -17,7 +17,7 @@ def cp_r_safe(sources, dest, options)
       FileUtils.mkdir_p(new, options)
       cp_r_safe(Dir.entries(source).
         reject { |f| %w{. ..}.include?(f) }.
-        collect { |f| File.join(source, f) }, new, options)
+        map { |f| File.join(source, f) }, new, options)
     else
       answer = if File.exists?(new)
         ask("#{new} exists. Overwrite?", 'n')
@@ -32,7 +32,7 @@ def cp_r_safe(sources, dest, options)
 end
 
 cp_r_safe(
-  %w{.htaccess config.ru config.yaml plugins/ public/ Rakefile}.collect { |x| 
+  %w{.htaccess config.ru config.yaml plugins/ public/ Rakefile}.map { |x| 
     File.join(File.dirname(__FILE__), '..', x) }, '.', :verbose => true)
 
 FileUtils.mkdir_p('tmp', :verbose => true)
@@ -41,5 +41,5 @@ puts <<eos
 Next steps:
 
 edit config.yaml
-rake db:init user:add
+rake init
 eos

data/config.ru

@@ -1,12 +1,18 @@
 $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
-require 'rubygems'
-require 'murlsh'
+%w{
+yaml
+
+murlsh
+}.each { |m| require m }
 
 # use Rack::ShowExceptions
 use Rack::ConditionalGet
+use Murlsh::EtagAddEncoding
 use Rack::Deflater
 use Rack::Static, :urls => %w{/css /js /swf}, :root => 'public'
-use Rack::Static, :urls => %w{/atom.xml}
+use Rack::Static, :urls => %w{/atom.xml /rss.xml}
+
+config = YAML.load_file('config.yaml')
 
-run Murlsh::Dispatch.new
+run Murlsh::Dispatch.new(config)

data/config.yaml

@@ -1,20 +1,24 @@
 --- 
 auth_file: murlsh_users
-description: URLs found interesting by Matthew M. Boedicker
+css_files: 
+- css/jquery.jgrowl.css
+- css/screen.css
 db_file: murlsh.db
 feed_file: atom.xml
-google_verify: 
+flickr_api_key: 
 gravatar_size: 32
-num_posts_feed: 25
-num_posts_page: 100
-page_title: mmb url share
-root_url: http://urls.matthewm.boedicker.org/
-css_files:
-- css/jquery.jgrowl.css
-- css/screen.css
-js_files:
+js_files: 
 - js/jquery-1.4.2.min.js
 - js/jquery.cookie.js
 - js/jquery.jgrowl_compressed.js
 - js/js.js
+meta_tag_description: URLs found interesting by Matthew M. Boedicker
+meta_tag_verify-v1: 
+meta_tag_viewport: width=device-width,minimum-scale=1.0,maximum-scale=1.0
+num_posts_feed: 25
+num_posts_page: 100
+page_title: mmb url share
 pubsubhubbub_hubs: []
+
+root_url: http://urls.matthewm.boedicker.org/
+show_names: true

data/lib/murlsh/atom_feed.rb

@@ -1,7 +1,8 @@
-require 'rubygems'
-require 'builder'
+%w{
+uri
 
-require 'uri'
+builder
+}.each { |m| require m }
 
 module Murlsh
 
@@ -44,7 +45,7 @@ module Murlsh
         xm.link(:href => URI.join(@root_url, @filename), :rel => 'self')
         @hubs.each { |hub| xm.link(:href => hub, :rel => 'hub') }
         xm.title(@title)
-        xm.updated(entries.collect { |mu| mu.time }.max.xmlschema)
+        xm.updated(entries.map(&:time).max.xmlschema)
         entries.each do |mu|
           xm.entry {
             xm.author { xm.name(mu.name) }

data/lib/murlsh/auth.rb

@@ -1,8 +1,9 @@
-require 'rubygems'
-require 'bcrypt'
+%w{
+csv
+digest/md5
 
-require 'csv'
-require 'digest/md5'
+bcrypt
+}.each { |m| require m }
 
 module Murlsh
 
@@ -16,9 +17,7 @@ module Murlsh
   # See Rakefile for user maintenance tasks.
   class Auth
 
-    def initialize(file)
-      @file = file
-    end
+    def initialize(file); @file = file; end
 
     # Authenticate a user by password. Return their name and email if correct.
     def auth(password)

data/lib/murlsh/dispatch.rb

@@ -1,12 +1,8 @@
 %w{
-murlsh
-
-rubygems
 active_record
 rack
-sqlite3
 
-yaml
+murlsh
 }.each { |m| require m }
 
 module Murlsh
@@ -14,34 +10,40 @@ module Murlsh
   # Dispatch requests.
   class Dispatch
 
-    # Set up config hash and database connection.
-    def initialize
-      @config = YAML.load_file('config.yaml')
-      @url_root = URI(@config.fetch('root_url')).path
+    # Set up database connection and dispatch table.
+    def initialize(config)
+      @config = config
 
       ActiveRecord::Base.establish_connection(
         :adapter => 'sqlite3', :database => @config.fetch('db_file'))
 
-      @db = ActiveRecord::Base.connection.instance_variable_get(:@connection)
+      db = ActiveRecord::Base.connection.instance_variable_get(:@connection)
 
-      @url_server = Murlsh::UrlServer.new(@config, @db)
+      url_server = Murlsh::UrlServer.new(@config, db)
+      flickr_server = Murlsh::FlickrServer.new(@config)
+
+      root_path = URI(@config.fetch('root_url')).path
+
+      @dispatch = [
+        [/^GET #{root_path}(url)?$/, url_server.method(:get)],
+        [/^POST #{root_path}(url)?$/, url_server.method(:post)],
+        [/^GET \/flickr$/, flickr_server.method(:get)],
+      ]
+    end
+
+    # Figure out which method will handle request.
+    def dispatch(req)
+      method_match = @dispatch.find do |rule|
+        rule[0].match("#{req.request_method} #{req.path}")
+      end
+
+      method_match ? method_match[1] : self.method(:not_found)
     end
 
     # Rack call.
     def call(env)
-      dispatch = {
-        ['GET', @url_root] => [@url_server, :get],
-        ['POST', @url_root] => [@url_server, :post],
-        ['GET', "#{@url_root}url"] => [@url_server, :get],
-        ['POST', "#{@url_root}url"] => [@url_server, :post],
-      }
-      dispatch.default = [self, :not_found]
-
       req = Rack::Request.new(env)
-
-      obj, meth = dispatch[[req.request_method, req.path]]
-
-      obj.send(meth, req).finish
+      dispatch(req).call(req).finish
     end
 
     # Called if the request is not found.

data/lib/murlsh/doc.rb

@@ -1,5 +1,6 @@
-require 'rubygems'
-require 'hpricot'
+%w{
+hpricot
+}.each { |m| require m }
 
 module Murlsh
 
@@ -21,14 +22,21 @@ module Murlsh
       nil
     end
 
-    # Find the title of the document.
-    def title
-      %w{//html/head/title //head/title //html/title //title}.each do |xpath|
-        return (self/xpath).first.inner_html unless (self/xpath).first.nil?
+    # Check a list of xpaths in order and return the inner html of the first
+    # one that is not nil.
+    def xpath_search(xpaths)
+      xpaths.each do |xpath|
+        selection = (self/xpath).first
+        return selection.inner_html unless selection.nil?
       end
       nil
     end
 
+    # Get the title of the document.
+    def title
+      xpath_search(%w{//html/head/title //head/title //html/title //title})
+    end
+
   end
 
 end

data/lib/murlsh/etag_add_encoding.rb

@@ -0,0 +1,27 @@
+%w{
+rack/utils
+}.each { |m| require m }
+
+module Murlsh
+
+  # Rack middleware to add the content encoding to the end of the ETag because
+  # ETag must be different for different representations.
+  class EtagAddEncoding
+
+    def initialize(app); @app = app; end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      headers = Rack::Utils::HeaderHash.new(headers)
+
+      if headers['ETag']
+        headers['ETag'].sub!(/(")?$/, "#{headers['Content-Encoding']}\\1")
+      end
+
+      [status, headers, body]
+    end
+
+  end
+
+end

data/lib/murlsh/flickr_server.rb

@@ -0,0 +1,54 @@
+%w{
+open-uri
+
+json
+rack
+}.each { |m| require m }
+
+module Murlsh
+
+  # Proxy for Flickr rest API flickr.photos.getinfo call to support conditional
+  # get.
+  #
+  # Passes along query string with api key added, returns result from Flickr
+  # with content type set to application/json and last modified header set.
+  class FlickrServer
+
+    def initialize(config); @config = config; end
+
+    # Proxy a flickr.photos.getinfo request to the Flickr rest API.
+    def get(req)
+      resp = Rack::Response.new
+
+      if @config['flickr_api_key']
+        params = req.params.merge('api_key' => @config['flickr_api_key'])
+
+        q = params.map { |k,v| "#{URI.encode(k)}=#{URI.encode(v)}" }.join('&')
+
+        json_wrapped = open("http://api.flickr.com/services/rest/?#{q}") do |f|
+          # for some reason Firefox will not cache if it's text/plain, which is
+          # what Flickr returns
+          resp['Content-Type'] = 'application/json'
+          f.read
+        end
+
+        json = /.+?\((.+)\)/.match(json_wrapped)[1]
+
+        json_parsed = JSON.parse(json)
+
+        resp['Last-Modified'] = Time.at(
+          json_parsed['photo']['dates']['lastupdate'].to_i).httpdate
+
+        resp.body = json_wrapped
+
+        resp
+      else
+        Rack::Response.new('flickr_api_key not set in config.yaml', 500,
+          { 'Content-Type' => 'text/plain' })
+      end
+
+    end
+
+  end
+
+end

data/lib/murlsh/markup.rb

@@ -89,7 +89,24 @@ module Murlsh
     # Query string builder. Takes hash of query string variables.
     def build_query(h)
       h.empty? ? '' :
-        '?' + h.collect { |k,v| URI.escape("#{k}=#{v}") }.join('&')
+        '?' + h.map { |k,v| URI.escape("#{k}=#{v}") }.join('&')
+    end
+
+    # Form input builder.
+    def form_input(options)
+      if options[:id]
+        if options[:label]
+          label_suffix = options[:label_suffix] || ':'
+          label("#{options[:label]}#{label_suffix}", :for => options[:id])
+        end
+        options[:name] ||= options[:id]
+      end
+
+      options.delete(:label)
+
+      input({
+        :type => 'text',
+        }.merge(options))
     end
 
     private

data/lib/murlsh/plugin.rb

@@ -9,6 +9,8 @@ module Murlsh
   #   run arguments (config hash)
   # * hostrec - called to post process the domain that shows after links
   #   run arguments (domain, url, title)
+  # * time - called to convert the time of a post into a string for display
+  #   run arguments (time)
   class Plugin
 
     # Called when a plugin class inherits from this class (the way plugins

data/lib/murlsh/sqlite3_adapter.rb

@@ -1,4 +1,6 @@
-require 'active_record/connection_adapters/sqlite3_adapter'
+%w{
+active_record/connection_adapters/sqlite3_adapter
+}.each { |m| require m }
 
 class ActiveRecord::ConnectionAdapters::SQLite3Adapter
 

data/lib/murlsh/time_ago.rb

@@ -0,0 +1,27 @@
+%w{
+time
+}.each { |m| require m }
+
+module Murlsh
+
+  # Mixin for time class to add fuzzy ago method.
+  module TimeAgo
+
+    # Return a string of the approximate amount of time that has passed since
+    # this time.
+    def ago
+       days_ago = (Time.now.to_i - to_i) / 86400
+
+       case days_ago
+         when 0 then 'today'
+         when 1 then 'yesterday'
+         when (2..4) then "#{days_ago} days ago"
+         when (5..7) then strftime('%a %e %b')
+         when (8..180) then strftime('%e %b').strip
+         else strftime('%e %b %Y').strip
+      end
+    end
+
+  end
+
+end

data/lib/murlsh/uri.rb

@@ -1,4 +1,6 @@
-require 'uri'
+%w{
+uri
+}.each { |m| require m }
 
 # Extra methods added to URI class.
 class URI::Generic

data/lib/murlsh/uri_ask.rb

@@ -1,12 +1,13 @@
-require 'net/http'
-require 'net/https'
-require 'open-uri'
-require 'uri'
+%w{
+net/http
+net/https
+open-uri
+uri
 
-require 'rubygems'
-require 'hpricot'
-require 'htmlentities'
-require 'iconv'
+hpricot
+htmlentities
+iconv
+}.each { |m| require m }
 
 module Murlsh
 
@@ -52,8 +53,10 @@ module Murlsh
           self.open(options[:headers]) do |f|
             doc = Hpricot(f).extend(Murlsh::Doc)
 
-            @title = HTMLEntities.new.decode(Iconv.conv('utf-8',
-              doc.charset || f.charset, doc.title))
+            if doc.title and !doc.title.empty?
+              @title = HTMLEntities.new.decode(Iconv.conv('utf-8',
+                doc.charset || f.charset, doc.title))
+            end
           end
         end
       end

data/lib/murlsh/url.rb

@@ -1,7 +1,8 @@
-require 'rubygems'
-require 'active_record'
+%w{
+uri
 
-require 'uri'
+active_record
+}.each { |m| require m }
 
 module Murlsh
 
@@ -10,7 +11,13 @@ module Murlsh
 
     # Get the title of this url.
     def title
-      read_attribute(:title) || read_attribute(:url) || 'title missing'
+      ta = read_attribute(:title)
+      ta = nil if ta and ta.empty?
+      
+      ua = read_attribute(:url)
+      ua = nil if ua and ua.empty?
+
+      ta || ua || 'title missing'
     end
 
     # Title with whitespace compressed and leading and trailing whitespace