murlsh 1.6.1 → 1.7.0

data/AUTHORS

@@ -0,0 +1,2 @@
+Matthew M. Boedicker <matthewm@boedicker.org>
+Daemian Mack <daemianmack@gmail.com>

data/README.textile

@@ -1,5 +1,6 @@
 Host your bookmarks or maintain a link blog.
 
+* post from a command-line, a bookmarklet, or directly from your murlsh
 * fetches url titles and generates thumbnails from page
 * jGrowls embedded versions of Imageshack, Imgur, Vimeo and YouTube urls
 * converts Twitter status urls to their full text and adds user thumbnail
@@ -15,6 +16,7 @@ Host your bookmarks or maintain a link blog.
 * Gravatar support
 * generates import scripts from delicious api exports
 * optionally store thumbnails in S3
+* experimental support for posting by email via POP
 
 See "http://urls.matthewm.boedicker.org/":http://urls.matthewm.boedicker.org/ for example.
 
@@ -94,6 +96,32 @@ the murlsh command again from your web directory to update plugins, javascript
 and css. It will prompt before overwriting anything in case you have made
 modifications.
 
+h1. Posting
+
+h2. Bookmarklet
+
+<pre>
+rake post_bookmarklet
+</pre>
+
+This will produce a bookmarklet link customized with your murlsh's URL
+and your password. Create a link in your bookmarks toolbar with the
+output; the resulting bookmarklet will let you post to your murlsh
+from whatever page you're currently viewing.
+
+If you select text on the page before hitting the bookmarklet, your
+selection will be used as the title; otherwise, the page's title will
+be used.
+
+h2. Shell script
+
+<pre>
+rake post_sh
+</pre>
+
+will produce a customized shell script that will take command-line
+arguments for URL, etc, and post to your murlsh using curl.
+
 h1. API
 
 h2. Recent urls

data/Rakefile

@@ -176,14 +176,22 @@ namespace :user do
 
 end
 
-desc 'Generate a shell script that will post a new url.'
-task :post_sh do
+desc 'Generate code for a bookmarklet that will post a new url.'
+task :post_bookmarklet do
+  password = Murlsh.ask('Password:')
+  puts <<EOS
+javascript:var%20d=document,dgs=d.getSelection,enc=encodeURIComponent,w=window,wgs=w.getSelection,s=''+(wgs?wgs():dgs?dgs():d.selection.createRange().text),t=s===''?d.title:s;void(window.open('#{config.fetch('root_url')}bookmarklet?title='+enc(t)+'&url='+enc(location.href)+'&auth=#{password}'));
+EOS
+end
+
+desc 'Generate a shell script that will post a new url (saved password optional).'
+task :post_sh, :password do |t,args|
   puts <<EOS
 #!/bin/sh
 
 URL="$1"
 VIA="$2"
-AUTH="$3" # password can be passed as third parameter or hardcoded here
+AUTH="#{args.password || '$3'}"
 
 curl \\
   --data-urlencode "url=${URL}" \\

data/config/README

@@ -0,0 +1,2 @@
+This directory is a placeholder used only on Heroku because there was an issue
+with Heroku creating it with the wrong permissions.

data/config.ru

@@ -5,6 +5,7 @@ require 'yaml'
 
 require 'rack'
 require 'rack/cache'
+require 'rack/contrib/jsonp'
 require 'rack/rewrite'
 require 'rack/throttle'
 
@@ -41,8 +42,16 @@ use Murlsh::FarFutureExpires, :patterns => [
 ]
 
 feed_url = URI.join(config.fetch('root_url'), config.fetch('feed_file'))
-use Murlsh::MustRevalidate, :patterns => %r{^#{Regexp.escape(feed_url.path)}$}
+use Murlsh::MustRevalidate, :patterns => [
+  %r{^#{Regexp.escape(feed_url.path)}$},
+  %r{^/(url)?$},
+  %r{^/json\.json$},
+  %r{^/m3u\.m3u$},
+  %r{^/podcast\.rss$},
+  %r{^/rss\.rss$},
+  ]
 
+use Rack::JSONP
 use Rack::Static, :urls => %w{/css/ /img/ /js/}, :root => 'public'
 
 use Rack::Rewrite do

data/config.yaml

@@ -11,7 +11,7 @@ db:
 feed_file: atom.atom
 gravatar_size: 32
 js_files: 
-- js/jquery-1.5.min.js
+- js/jquery-1.5.1.min.js
 - js/jquery.jgrowl_compressed.js
 - js/twitter-text-1.3.1.js
 - js/js.js

data/lib/murlsh/atom_server.rb

@@ -7,24 +7,19 @@ require 'murlsh'
 module Murlsh
 
   # Serve Atom feed.
-  class AtomServer
-
-    def initialize(config); @config = config; end
+  class AtomServer < Server
 
     # Respond to a GET request for Atom feed.
     def get(req)
-      conditions = Murlsh::SearchConditions.new(req['q']).conditions
       page = 1
       per_page = config.fetch('num_posts_feed', 25)
 
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
-      urls = result_set.results
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page)
 
       feed_url = URI.join(config.fetch('root_url'), config.fetch('feed_file'))
-      body = Murlsh::AtomBody.new(config, req, feed_url, urls)
+      body = Murlsh::AtomBody.new(config, req, feed_url, result_set.results)
 
       resp = Rack::Response.new(body, 200,
-        'Cache-Control' => 'must-revalidate, max-age=0',
         'Content-Type' => 'application/atom+xml')
       if u = body.updated
         resp['Last-Modified'] = u.httpdate
@@ -32,7 +27,6 @@ module Murlsh
       resp
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/dispatch.rb

@@ -34,6 +34,7 @@ module Murlsh
         [%r{^(?:HEAD|GET) #{root_path}random$}, random_server.method(:get)],
         [%r{^(?:HEAD|GET) #{root_path}rss\.rss$}, rss_server.method(:get)],
         [%r{^(?:HEAD|GET) #{root_path}(url)?$}, url_server.method(:get)],
+        [%r{^GET #{root_path}bookmarklet$}, url_server.method(:post)],
         [%r{^POST #{root_path}(url)?$}, url_server.method(:post)],
       ]
 

data/lib/murlsh/doc.rb

@@ -6,7 +6,7 @@ module Murlsh
     # Check a list of xpaths in order and yield and return the node matching
     # the first one that is not nil
     def xpath_search(xpaths)
-      [*xpaths].each do |xpath|
+      Array(xpaths).each do |xpath|
         selection = (self/xpath).first
         if selection; return (yield selection); end
       end

data/lib/murlsh/install.rb

@@ -16,6 +16,7 @@ module Murlsh
       %w{
         .htaccess
         Rakefile
+        config/
         config.ru
         config.yaml
         db/

data/lib/murlsh/json_server.rb

@@ -2,34 +2,21 @@ require 'rack'
 
 module Murlsh
 
-  # Serve most recent urls in json and jsonp.
-  class JsonServer
+  # Serve most recent urls in json.
+  class JsonServer < Server
 
-    def initialize(config); @config = config; end
-
-    # Respond to a GET request. Return json of recent urls or jsonp if
-    # if callback parameter is sent.
+    # Respond to a GET request with json of recent urls.
     def get(req)
-      conditions = Murlsh::SearchConditions.new(req['q']).conditions
       page = 1
       per_page = config.fetch('num_posts_feed', 25)
 
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page)
 
-      if req['callback']
-        content_type = 'application/javascript'
-        body = Murlsh::JsonpBody.new(config, req, result_set)
-      else
-        content_type = 'application/json'
-        body = Murlsh::JsonBody.new(config, req, result_set)
-      end
+      body = Murlsh::JsonBody.new(config, req, result_set)
 
-      Rack::Response.new body, 200,
-        'Cache-Control' => 'must-revalidate, max-age=0',
-        'Content-Type' => content_type
+      Rack::Response.new body, 200, 'Content-Type' => 'application/json'
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/m3u_server.rb

@@ -7,7 +7,7 @@ require 'murlsh'
 module Murlsh
 
   # Serve m3u file of audio urls.
-  class M3uServer
+  class M3uServer < Server
 
     AudioContentTypes = %w{
       application/ogg
@@ -15,36 +15,24 @@ module Murlsh
       audio/ogg
       }
 
-    def initialize(config); @config = config; end
-
     # Respond to a GET request for m3u file.
     def get(req)
-      conditions = ['content_type IN (?)', AudioContentTypes]
-      search_conditions = Murlsh::SearchConditions.new(req['q']).conditions
-      unless search_conditions.empty?
-        conditions[0] << " AND (#{search_conditions[0]})"
-        conditions.push(*search_conditions[1..-1])
-      end
-
       page = 1
       per_page = config.fetch('num_posts_feed', 25)
 
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
-      urls = result_set.results
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page,
+        :content_type => AudioContentTypes)
 
       feed_url = URI.join(config.fetch('root_url'), 'm3u.m3u')
-      body = Murlsh::M3uBody.new(config, req, feed_url, urls)
+      body = Murlsh::M3uBody.new(config, req, feed_url, result_set.results)
 
-      resp = Rack::Response.new(body, 200,
-        'Cache-Control' => 'must-revalidate, max-age=0',
-        'Content-Type' => 'audio/x-mpegurl')
+      resp = Rack::Response.new(body, 200, 'Content-Type' => 'audio/x-mpegurl')
       if u = body.updated
         resp['Last-Modified'] = u.httpdate
       end
       resp
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/markup.rb

@@ -8,7 +8,7 @@ module Murlsh
     # Options:
     # * :prefix - prefix to append to all script urls
     def javascript(sources, options={})
-      [*sources].each do |src|
+      Array(sources).each do |src|
         script '', :type => 'text/javascript',
           :src => "#{options[:prefix]}#{src}"
       end
@@ -50,7 +50,7 @@ module Murlsh
     # * :media - optional media attribute
     # * :prefix - prepended to all CSS urls
     def css(hrefs, options={})
-      [*hrefs].each do |href|
+      Array(hrefs).each do |href|
         attrs = {
           :href => "#{options[:prefix]}#{href}",
           :rel => 'stylesheet',
@@ -69,17 +69,22 @@ module Murlsh
     def form_input(options)
       if options[:id]
         if options[:label]
-          label_suffix = options[:label_suffix] || ':'
-          label "#{options[:label]}#{label_suffix}", :for => options[:id]
+          label_class = options[:optional] ? 'optional' : 'required'
+          label options[:label], :for => options[:id], :class => label_class
         end
         options[:name] ||= options[:id]
       end
 
       options.delete :label
 
-      input({
-        :type => 'text',
-        }.merge(options))
+      options[:type] ||= 'text'
+
+      if %w{text password}.include?(options[:type]) and @req and
+        not @req[options[:name]].to_s.empty?
+        options[:value] = @req[options[:name]]
+      end
+
+      input options
     end
 
     private

data/lib/murlsh/must_revalidate.rb

@@ -9,7 +9,7 @@ module Murlsh
 
     def initialize(app, options={})
       @app = app
-      @patterns = options[:patterns] ? [*options[:patterns]] : []
+      @patterns = Array(options[:patterns])
     end
 
     def call(env)

data/lib/murlsh/podcast_server.rb

@@ -7,30 +7,20 @@ require 'murlsh'
 module Murlsh
 
   # Serve podcast RSS feed.
-  class PodcastServer
-
-    def initialize(config); @config = config; end
+  class PodcastServer < Server
 
     # Respond to a GET request for podcast RSS feed.
     def get(req)
-      conditions = ['content_type = ?', 'audio/mpeg']
-      search_conditions = Murlsh::SearchConditions.new(req['q']).conditions
-      unless search_conditions.empty?
-        conditions[0] << " AND (#{search_conditions[0]})"
-        conditions.push(*search_conditions[1..-1])
-      end
-
       page = 1
       per_page = config.fetch('num_posts_feed', 25)
 
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
-      urls = result_set.results
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page,
+        :content_type => 'audio/mpeg')
 
       feed_url = URI.join(config.fetch('root_url'), 'podcast.rss')
-      body = Murlsh::RssBody.new(config, req, feed_url, urls)
+      body = Murlsh::RssBody.new(config, req, feed_url, result_set.results)
 
       resp = Rack::Response.new(body, 200,
-        'Cache-Control' => 'must-revalidate, max-age=0',
         'Content-Type' => 'application/rss+xml')
       if u = body.updated
         resp['Last-Modified'] = u.httpdate
@@ -38,7 +28,6 @@ module Murlsh
       resp
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/pop_server.rb

@@ -1,7 +1,6 @@
 require 'net/pop'
 
 require 'active_record'
-require 'json'
 require 'postrank-uri'
 require 'rack'
 require 'rmail'
@@ -9,9 +8,7 @@ require 'rmail'
 module Murlsh
 
   # Pop mail from a pop3 server and add all urls in messages from murlsh users.
-  class PopServer
-
-    def initialize(config); @config = config; end
+  class PopServer < Server
 
     def post(req)
       response_body = []
@@ -72,7 +69,6 @@ module Murlsh
       }    
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/random_server.rb

@@ -5,18 +5,19 @@ require 'murlsh'
 module Murlsh
 
   # Redirect to a random url from the database.
-  class RandomServer
-
-    def initialize(config); @config = config; end
+  class RandomServer < Server
 
     # Redirect to a random url from the database optionally matching a query.
     #
     # Redirect to root url if no urls match.
     def get(req)
-      if choice = random_url(Murlsh::SearchConditions.new(req['q']).conditions)
-        url = choice.url
+      all_results = Murlsh::UrlResultSet.new(req['q'], 1, 1)
+
+      url = if all_results.total_entries > 0
+        Murlsh::UrlResultSet.new(req['q'],
+          rand(all_results.total_entries) + 1, 1).results[0].url
       else
-        url = config.fetch('root_url')
+        config.fetch('root_url')
       end
 
       resp = Rack::Response.new("<a href=\"#{url}\">#{url}</a>")
@@ -25,17 +26,6 @@ module Murlsh
       resp
     end
 
-    # Select a random url from the database optionally matching a query.
-    #
-    # Return nil if no urls match.
-    def random_url(conditions=[])
-      count = Murlsh::Url.count(:conditions => conditions)
-      if count > 0
-        Murlsh::Url.first(:conditions => conditions, :offset => rand(count))
-      end
-    end
-
-    attr_reader :config
   end
 
 end

data/lib/murlsh/rss_server.rb

@@ -7,24 +7,19 @@ require 'murlsh'
 module Murlsh
 
   # Serve RSS feed.
-  class RssServer
-
-    def initialize(config); @config = config; end
+  class RssServer < Server
 
     # Respond to a GET request for RSS feed.
     def get(req)
-      conditions = Murlsh::SearchConditions.new(req['q']).conditions
       page = 1
       per_page = config.fetch('num_posts_feed', 25)
 
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
-      urls = result_set.results
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page)
 
       feed_url = URI.join(config.fetch('root_url'), 'rss.rss')
-      body = Murlsh::RssBody.new(config, req, feed_url, urls)
+      body = Murlsh::RssBody.new(config, req, feed_url, result_set.results)
 
       resp = Rack::Response.new(body, 200,
-        'Cache-Control' => 'must-revalidate, max-age=0',
         'Content-Type' => 'application/rss+xml')
       if u = body.updated
         resp['Last-Modified'] = u.httpdate
@@ -32,7 +27,6 @@ module Murlsh
       resp
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/search_conditions.rb

@@ -9,7 +9,7 @@ module Murlsh
 
     # Search conditions builder for ActiveRecord conditions.
     def conditions
-      if q
+      unless q.to_s.empty?
         parser = Murlsh::SearchGrammarParser.new
         tokens = parser.parse(q).content
         search_cols = %w{name title url}

data/lib/murlsh/server.rb

@@ -0,0 +1,11 @@
+module Murlsh
+
+  # Superclass for servers.
+  class Server
+
+    def initialize(config); @config = config; end
+
+    attr_reader :config
+  end
+
+end

data/lib/murlsh/uri_ask.rb

@@ -119,8 +119,8 @@ module Murlsh
     # * :failproof - if true hide all exceptions and return empty string on failure
     # * :headers - hash of headers to send in request
     def header(header_name, options={})
-      result = [*head_headers(options)[header_name]][0]
-      result = get_headers(options)[header_name]  if not result or result.empty?
+      result = Array(head_headers(options)[header_name]).first
+      result = get_headers(options)[header_name]  if result.to_s.empty?
       result.to_s
     end
 

data/lib/murlsh/url_body.rb

@@ -165,7 +165,7 @@ module Murlsh
     def search_form
       form(:action => @config.fetch('root_url'), :method => 'get') {
         fieldset {
-          form_input :id => 'q', :size => 32, :value => @req['q']
+          form_input :id => 'q', :size => 32
           form_input :type => 'submit', :value => 'Search'
         }
       }
@@ -189,7 +189,14 @@ module Murlsh
       form(:action => 'url', :method => 'post') {
         fieldset(:id => 'add') {
           self.p { form_input :id => 'url', :label => 'Add URL', :size => 32 }
-          self.p { form_input :id => 'via', :label => 'Via', :size => 32 }
+          self.p {
+            form_input :id => 'title', :label => 'Title', :size => 32,
+              :optional => true
+          }
+          self.p {
+            form_input :id => 'via', :label => 'Via', :size => 32,
+              :optional => true
+          }
           self.p {
             form_input :type => 'password', :id => 'auth', :label => 'Password',
               :size => 16

data/lib/murlsh/url_result_set.rb

@@ -1,12 +1,36 @@
+require 'murlsh'
+
 module Murlsh
 
   class UrlResultSet
 
-    def initialize(conditions, page, per_page)
-      @conditions, @page, @per_page = conditions, page, per_page
+    def initialize(query, page, per_page, filters={})
+      @query, @page, @per_page, @filters = query, page, per_page, filters
       @order = 'time DESC'
     end
 
+    def search_conditions
+      @search_conditions ||= Murlsh::SearchConditions.new(query).conditions
+    end
+
+    def conditions
+      @conditions ||= if filters[:content_type]
+        result = if filters[:content_type].is_a?(String)
+          ['content_type = ?', filters[:content_type]]
+        else
+          ['content_type IN (?)', filters[:content_type]]
+        end
+
+        unless search_conditions.empty?
+          result[0] << " AND (#{search_conditions[0]})"
+          result.push(*search_conditions[1..-1])
+        end
+        result
+      else
+        search_conditions
+      end
+    end
+
     def total_entries
       @total_entries ||= Murlsh::Url.count(:conditions => conditions)
     end
@@ -36,9 +60,10 @@ module Murlsh
       @next_page
     end
 
-    attr_reader :conditions
+    attr_reader :query
     attr_reader :page
     attr_reader :per_page
+    attr_reader :filters
     attr_reader :order
   end
 

data/lib/murlsh/url_server.rb

@@ -4,26 +4,22 @@ require 'rack'
 module Murlsh
 
   # Build responses for HTTP requests.
-  class UrlServer
-
-    def initialize(config); @config = config; end
+  class UrlServer < Server
 
     # Respond to a GET request. Return a page of urls based on the query
     # string parameters.
     def get(req)
-      conditions = Murlsh::SearchConditions.new(req['q']).conditions
       page = [req['p'].to_i, 1].max
       per_page = req['pp'] ? req['pp'].to_i :
         config.fetch('num_posts_page', 25)
 
       content_type = 'text/html; charset=utf-8'
-      result_set = Murlsh::UrlResultSet.new(conditions, page, per_page)
+      result_set = Murlsh::UrlResultSet.new(req['q'], page, per_page)
 
       body = Murlsh::UrlBody.new(config, req, result_set, content_type)
 
       resp = Rack::Response.new
       resp.write(body.build)
-      resp['Cache-Control'] = 'must-revalidate, max-age=0'
       resp['Content-Type'] = content_type
 
       resp
@@ -86,7 +82,6 @@ module Murlsh
         config.fetch('auth_file')).auth(secret)
     end
 
-    attr_reader :config
   end
 
 end

data/lib/murlsh/version.rb

@@ -1,3 +1,3 @@
 module Murlsh
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

data/lib/murlsh.rb

@@ -1,4 +1,5 @@
 require 'murlsh/search_conditions'
+require 'murlsh/server'
 
 require 'murlsh/atom_server'
 require 'murlsh/ask'
@@ -18,7 +19,6 @@ require 'murlsh/img_store'
 require 'murlsh/install'
 require 'murlsh/json_body'
 require 'murlsh/json_server'
-require 'murlsh/jsonp_body'
 require 'murlsh/m3u_body'
 require 'murlsh/m3u_server'
 require 'murlsh/markup'

data/murlsh.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
     bcrypt-ruby
     builder
     htmlentities
-    json
     nokogiri
     plumnailer
     postrank-uri
@@ -29,6 +28,7 @@ Gem::Specification.new do |s|
     push-notify
     rack
     rack-cache
+    rack-contrib
     rack-rewrite
     rack-throttle
     rmagick