murlsh 1.2.1 → 1.3.0

data/.htaccess

@@ -9,11 +9,13 @@ AddOutputFilterByType DEFLATE text/css
 AddOutputFilterByType DEFLATE text/html
 
 <FilesMatch "\.gen\.(css|js)$">
-  Header add Expires "Wed, 22 Jun 2019 20:07:00 GMT"
+  ExpiresActive On
+  ExpiresDefault "now plus 1 years"
   FileETag None
 </FilesMatch>
 
 <FilesMatch "[\da-z]{32}\.(gif|jpe?g|png)$">
-  Header add Expires "Wed, 22 Jun 2019 20:07:00 GMT"
+  ExpiresActive On
+  ExpiresDefault "now plus 1 years"
   FileETag None
 </FilesMatch>

data/README.textile

@@ -4,14 +4,15 @@ Site for sharing and archiving links.
 * jGrowls embedded versions of Imageshack, Vimeo and YouTube urls
 * converts Twitter status urls to their full text and adds user thumbnail
 * generates Atom and RSS feeds
+* generates json and jsonp feeds for client-side inclusion in other sites
 * regex search
-* embeds Flash mp3 player for mp3 urls
+* uses HTML5 audio for mp3 and ogg urls
 * looks good on iPhone
 * PubSubHubbub notification
 * plugin interface
 * rack interface
 * Gravatar support
-* imports Netscape bookmark format files
+* generates import scripts from delicious api exports
 
 See "http://urls.matthewm.boedicker.org/":http://urls.matthewm.boedicker.org/ for example.
 
@@ -32,6 +33,14 @@ rake init
 </code>
 </pre>
 
+h2. Development
+
+* Create a fork and check it out
+* edit config.yaml
+* rake init
+* rackup
+* open http://localhost:9292/
+
 h1. Updating
 
 If you are using the gem and it gets updated to a new version you should run
@@ -39,6 +48,16 @@ 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. API
+
+h2. Recent urls
+
+* http://your_root/atom.atom
+* http://your_root/rss.rss
+* http://your_root/podcast.rss (urls with audio/mpeg content type)
+* http://your_root/json.json
+* http://your_root/json.json?callback=x (jsonp)
+
 h1. Plugins
 
 Classes in the plugins directory can be used to change behavior at certain

data/Rakefile

@@ -3,6 +3,7 @@ $:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require 'cgi'
 require 'digest/md5'
 require 'net/http'
+require 'open-uri'
 require 'pp'
 require 'set'
 require 'uri'
@@ -131,17 +132,12 @@ end
 
 desc 'Run test suite.'
 begin
-  require 'spec/rake/spectask'
+  require 'rspec/core/rake_task'
 
-  Spec::Rake::SpecTask.new('test') do |t|
-    t.spec_files = FileList['spec/*_spec.rb']
-    t.spec_opts = %w{--color}
+  RSpec::Core::RakeTask.new('test') do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.rspec_opts = %w{--color}
     t.verbose = true
-    t.warning = true
-  end
-rescue LoadError
-  task :test do
-    gem_not_found 'rspec'
   end
 end
 
@@ -320,9 +316,17 @@ namespace :js do
 
   desc 'Run javascript through jslint.'
   task :jslint do
+    local_jslint = 'jslint_rhino.js'
+    open(local_jslint, 'w') do |f|
+      f.write(cat(%w{
+        https://github.com/AndyStricker/JSLint/raw/rhinocmdline/fulljslint.js
+        https://github.com/AndyStricker/JSLint/raw/rhinocmdline/rhino.js
+      }))
+    end
+
     MURLSH_JS.each do |jsf|
       puts jsf
-      puts `rhino http://www.jslint.com/rhino/jslint.js #{jsf}`
+      puts `rhino #{local_jslint} #{jsf}`
     end
   end
 
@@ -455,7 +459,7 @@ begin
     %w{
       flog >= 2.5.0
       rack-test ~> 0.5
-      rspec ~> 1.3
+      rspec ~> 2.0
       }.each_slice(3) do |g,o,v|
       gemspec.add_development_dependency(g, "#{o} #{v}")
     end

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/bin/murlsh

@@ -50,10 +50,11 @@ cp_r_safe(
 
 FileUtils.mkdir_p('tmp', :verbose => true)
 
+cd_command = File.expand_path(dest_dir) == Dir.pwd ? '' : "cd #{dest_dir}\n"
+
 puts <<eos
 Next steps:
 
-cd #{dest_dir}
-edit config.yaml
+#{cd_command}edit config.yaml
 rake init
 eos

data/config.ru

@@ -31,7 +31,7 @@ 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 Rack::Static, :urls => %w{/css /img /js /swf}, :root => 'public'
+use Rack::Static, :urls => %w{/css/ /img/ /js/}, :root => 'public'
 use Rack::Static, :urls => %w{/atom.atom /podcast.rss /rss.rss}
 
 use Rack::Rewrite do

data/config.yaml

@@ -2,8 +2,6 @@
 auth_file: murlsh_users
 cache_entitystore: file:tmp/cache/rack/body
 cache_metastore: file:tmp/cache/rack/meta
-config_js: []
-
 css_files: 
 - css/jquery.jgrowl.css
 - css/screen.css
@@ -28,3 +26,9 @@ root_url: http://urls.matthewm.boedicker.org/
 show_names: true
 thumbnail_max_side: 90
 user_agent: murlsh (http://github.com/mmb/murlsh)
+predefined_searches:
+  audio: \.(mp3|ogg)$
+  code: (code\.google|github)\.com/
+  images: \.(png|gif|jpe?g)$
+  tweets: twitter\.com/
+  video: (youtube|vimeo)\.com/

data/lib/murlsh/build_md5.rb

@@ -0,0 +1,12 @@
+require 'digest/md5'
+
+module Murlsh
+
+  module BuildMd5
+
+    # Return the md5 sum of the result of the build method.
+    def md5; Digest::MD5.hexdigest(build); end
+
+  end
+
+end

data/lib/murlsh/dispatch.rb

@@ -15,15 +15,15 @@ module Murlsh
       @config = config
 
       url_server = Murlsh::UrlServer.new(config)
-      config_server = Murlsh::ConfigServer.new(config)
+      json_server = Murlsh::JsonServer.new(config)
       root_path = URI(config.fetch('root_url')).path
 
       @routes = [
         [%r{^HEAD #{root_path}(url)?$}, url_server.method(:head)],
         [%r{^GET #{root_path}(url)?$}, url_server.method(:get)],
         [%r{^POST #{root_path}(url)?$}, url_server.method(:post)],
-        [%r{^HEAD #{root_path}config$}, config_server.method(:head)],
-        [%r{^GET #{root_path}config$}, config_server.method(:get)],
+        [%r{^HEAD #{root_path}json\.json$}, json_server.method(:head)],
+        [%r{^GET #{root_path}json\.json$}, json_server.method(:get)],
       ]
 
       db_init

data/lib/murlsh/far_future_expires.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 require 'rack'
 require 'rack/utils'
 
@@ -10,7 +12,9 @@ module Murlsh
     def initialize(app, options={})
       @app = app
       @patterns = options[:patterns] ? [*options[:patterns]] : []
-      @future = options[:future] || 'Wed, 22 Jun 2019 20:07:00 GMT'
+      # rfc2616 HTTP/1.1 servers SHOULD NOT send Expires dates more than one
+      # year in the future.
+      @future = options[:future] || (Time.now + 31536000).httpdate
     end
 
     def call(env)

data/lib/murlsh/json_body.rb

@@ -0,0 +1,41 @@
+require 'uri'
+
+module Murlsh
+
+  # Recent urls json response builder.
+  class JsonBody
+    include Murlsh::BuildMd5
+
+    def initialize(config, req, result_set)
+      @config, @req, @result_set = config, req, result_set
+    end
+
+    # Yield body for Rack.
+    def each; yield build; end
+
+    # Recent urls json response builder.
+    def build
+      if defined?(@body)
+        @body
+      else
+        urls = @result_set.results.map do |mu|
+          h = mu.attributes
+
+          h['title'] = mu.title_stripped
+
+          # add site root url to relative thumbnail urls
+          if h['thumbnail_url'] and
+            not URI(h['thumbnail_url']).scheme.to_s.downcase[/https?/]
+            h['thumbnail_url'] = URI.join(@config['root_url'],
+              h['thumbnail_url']).to_s
+          end
+
+          h
+        end
+        @body = urls.to_json
+      end
+    end
+
+  end
+
+end

data/lib/murlsh/json_server.rb

@@ -0,0 +1,39 @@
+require 'rack'
+
+module Murlsh
+
+  # Serve most recent urls in json and jsonp.
+  class JsonServer
+
+    include Murlsh::HeadFromGet
+
+    def initialize(config); @config = config; end
+
+    # Respond to a GET request. Return json of recent urls or jsonp if
+    # if callback parameter is sent.
+    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)
+
+      resp = Rack::Response.new
+
+      if req['callback']
+        resp['Content-Type'] = 'application/javascript'
+        resp.body = Murlsh::JsonpBody.new(@config, req, result_set)
+      else
+        resp['Content-Type'] = 'application/json'
+        resp.body = Murlsh::JsonBody.new(@config, req, result_set)
+      end
+
+      resp['Cache-Control'] = 'must-revalidate, max-age=0'
+      resp['ETag'] = "\"#{resp.body.md5}\""
+
+      resp
+    end
+
+  end
+
+end

data/lib/murlsh/jsonp_body.rb

@@ -0,0 +1,17 @@
+module Murlsh
+
+  # Recent urls jsonp response builder.
+  class JsonpBody < Murlsh::JsonBody
+
+    # Recent urls jsonp response builder.
+    def build
+      if defined?(@body)
+        @body
+      else
+        @body = "#{@req['callback']}(#{super})"
+      end
+    end
+
+  end
+
+end

data/lib/murlsh/search_conditions.rb

@@ -0,0 +1,22 @@
+module Murlsh
+
+  # Search conditions builder for ActiveRecord conditions.
+  class SearchConditions
+
+    def initialize(q); @q = q; end
+
+    # Search conditions builder for ActiveRecord conditions.
+    def conditions
+      if q
+        search_cols = %w{name title url}
+        [search_cols.map { |x| "MURLSHMATCH(#{x}, ?)" }.join(' OR ')].push(
+          *[q] * search_cols.size)
+      else
+        []
+      end
+    end
+
+    attr_accessor :q
+  end
+
+end

data/lib/murlsh/url.rb

@@ -36,6 +36,8 @@ module Murlsh
       @ask
     end
 
+    attr_accessor :user_supplied_title
+    alias :user_supplied_title? :user_supplied_title
   end
 
 end

data/lib/murlsh/url_body.rb

@@ -1,119 +1,98 @@
 require 'builder'
+require 'uri'
 
 module Murlsh
 
   # Url list page builder.
   class UrlBody < Builder::XmlMarkup
+    include Murlsh::BuildMd5
     include Murlsh::Markup
 
-    def initialize(config, req, content_type='text/html')
-      @config, @req, @q, @content_type =
-        config, req, req.params['q'], content_type
-      @page = [req.params['p'].to_i, 1].max
-
-      @first_href, @prev_href, @next_href = page_href(1), nil, nil
- 
-      @total_entries, @total_pages = 0, 0
-
-      @per_page = @req.params['pp'] ? @req.params['pp'].to_i :
-        config.fetch('num_posts_page', 25)
-
+    def initialize(config, req, result_set, content_type='text/html')
+      @config, @req, @result_set, @content_type = config, req, result_set,
+        content_type
       super(:indent => @config['html_indent'] || 0)
     end
 
     # Get the href of a page in the same result set as this page.
+    #
+    # Return nil if page is invalid.
     def page_href(page)
-      query = @req.params.dup
-      query['p'] = page
-      Murlsh.build_query(query)
-    end
-
-    # Fetch urls based on query string parameters.
-    def urls
-      search = search_conditions
-
-      @total_entries = Murlsh::Url.count(:conditions => search)
-      @total_pages = (@total_entries / @per_page.to_f).ceil
-
-      if @page > 1 and @page <= @total_pages
-        @prev_href = page_href(@page - 1)
-      end
-
-      if @page < @total_pages
-        @next_href = page_href(@page + 1)
-      end
-
-      offset = (@page - 1) * @per_page
-
-      Murlsh::Url.all(:conditions => search_conditions, :order => 'time DESC',
-        :limit => @per_page, :offset => offset)
-    end
-
-    # Search conditions builder for ActiveRecord conditions.
-    def search_conditions
-      if @q
-        search_cols = %w{name title url}
-        [search_cols.map { |x| "MURLSHMATCH(#{x}, ?)" }.join(' OR ')].push(
-          *[@q] * search_cols.size)
-      else
-        []
+      if page.to_i >= 1
+        query = @req.params.dup
+        query['p'] = page
+        Murlsh.build_query(query)
       end
     end
 
-    # Url list page body builder.
-    def each
-      mus = urls
+    # Get the url of the previous page or nil if this is the first.
+    def prev_href; page_href(@result_set.prev_page); end
 
-      declare! :DOCTYPE, :html
+    # Get the url of the next page or nil if this is the last.
+    def next_href; page_href(@result_set.next_page); end
 
-      yield html(:lang => 'en') {
-        headd
-        body {
-          ul(:id => 'urls') {
-            li { feed_icon ; search_form }
+    # Yield body for Rack.
+    def each; yield build; end
 
-            last = nil
+    # Url list page body builder.
+    def build
+      if defined?(@body)
+        @body
+      else
+        declare! :DOCTYPE, :html
+
+        @body = html(:lang => 'en') {
+          headd
+          body {
+            search_form
+            self.p {
+              predefined_searches
+              feed_link
+            }
+            ul(:id => 'urls') {
+              last = nil
+
+              @result_set.results.each do |mu|
+                li {
+                  unless mu.same_author?(last)
+                    avatar_url = Murlsh::Plugin.hooks('avatar').inject(
+                      nil) do |url_so_far,plugin|
+                      plugin.run(url_so_far, mu, @config)
+                    end
+                    div(:class => 'icon') {
+                      murlsh_img :src => avatar_url, :text => mu.name
+                    }  if avatar_url
+                    div(mu.name, :class => 'name')  if
+                      @config.fetch('show_names', false) and mu.name
+                  end
 
-            mus.each do |mu|
-              li {
-                unless mu.same_author?(last)
-                  avatar_url = Murlsh::Plugin.hooks('avatar').inject(
-                    nil) do |url_so_far,plugin|
-                    plugin.run(url_so_far, mu, @config)
+                  if mu.thumbnail_url
+                    murlsh_img :src => mu.thumbnail_url,
+                      :text => mu.title_stripped, :class => 'thumb'
                   end
-                  div(:class => 'icon') {
-                    murlsh_img :src => avatar_url, :text => mu.name
-                  }  if avatar_url
-                  div(mu.name, :class => 'name')  if
-                    @config.fetch('show_names', false) and mu.name
-                end
 
-                if mu.thumbnail_url
-                  murlsh_img :src => mu.thumbnail_url,
-                    :text => mu.title_stripped, :class => 'thumb'
-                end
+                  a mu.title_stripped, :href => mu.url, :class => 'm'
 
-                a mu.title_stripped, :href => mu.url, :class => 'm'
+                  Murlsh::Plugin.hooks('url_display_add') do |p|
+                    p.run self, mu, @config
+                  end
 
-                Murlsh::Plugin.hooks('url_display_add') do |p|
-                  p.run self, mu, @config
-                end
+                  last = mu
+                }
+              end
+            }
 
-                last = mu
-              }
-            end
+            clear
 
-            li { paging_nav }
+            paging_nav
+            add_form
+            powered_by
 
-            li { add_form }
+            js
+            div '', :id => 'bottom'
           }
-
-          clear
-          powered_by
-          js
-          div '', :id => 'bottom'
         }
-      }
+      end
     end
 
     # Head builder.
@@ -125,29 +104,39 @@ module Murlsh
           map { |k,v| [k.sub('meta_tag_', ''), v] })
         css(@config['css_compressed'] || @config['css_files'])
         atom @config.fetch('feed_file')
-        link :rel => 'first', :href => @first_href
+        link :rel => 'first', :href => page_href(1)
         link :rel => 'prev', :href => @prev_href  if @prev_href
         link :rel => 'next', :href => @next_href  if @next_href
       }
     end
 
+    # Predefined search list builder.
+    def predefined_searches
+      if @config['predefined_searches']
+        text! 'search: '
+        @config['predefined_searches'].each do |k,v|
+          a "/#{k}", :href => "?q=#{URI.escape(v)}" ; text! ' '
+        end
+        text! '| '
+      end
+    end
+
     # Title builder.
     def titlee
-      title(@config.fetch('page_title', '') + (@q ? " /#{@q}" : ''))
+      title(@config.fetch('page_title', '') +
+        (@req['q'] ? " /#{@req['q']}" : ''))
     end
 
-    # Feed icon builder.
-    def feed_icon
-      div(:class => 'icon') {
-        a('feed', :href => @config.fetch('feed_file'), :class => 'feed')
-      }
+    # Feed link builder.
+    def feed_link
+      a('feed', :href => @config.fetch('feed_file'), :class => 'feed')
     end
 
     # Search form builder.
     def search_form
       form(:action => '', :method => 'get') {
         fieldset {
-          form_input :id => 'q', :size => 32, :value => @q
+          form_input :id => 'q', :size => 32, :value => @req['q']
           form_input :type => 'submit', :value => 'Regex Search'
         }
       }
@@ -155,13 +144,15 @@ module Murlsh
 
     # Paging navigation.
     def paging_nav
-      text! "Page #{@page}/#{@total_pages}"
-      if @prev_href
-        text! ' | '; a 'previous', :href => @prev_href
-      end
-      if @next_href
-        text! ' | '; a 'next', :href => @next_href
-      end
+      self.p {
+        text! "Page #{@result_set.page}/#{@result_set.total_pages}"
+        if p_href = prev_href
+          text! ' | '; a 'previous', :href => p_href
+        end
+        if n_href = next_href
+          text! ' | '; a 'next', :href => n_href
+        end
+      }
     end
 
     # Url add form builder.

data/lib/murlsh/url_result_set.rb

@@ -0,0 +1,35 @@
+module Murlsh
+
+  class UrlResultSet
+
+    def initialize(conditions, page, per_page)
+      @conditions, @page, @per_page = conditions, page, per_page
+      @order = 'time DESC'
+    end
+
+    def total_entries
+      @total_entries ||= Murlsh::Url.count(:conditions => conditions)
+    end
+
+    def total_pages
+      @total_pages ||= [(total_entries / per_page.to_f).ceil, 1].max
+    end
+
+    def offset; @offset ||= (page - 1) * per_page; end
+
+    def results
+      Murlsh::Url.all(:conditions => conditions, :order => order,
+        :limit => per_page, :offset => offset)
+    end
+
+    def prev_page; @prev_page ||= page - 1  if (2..total_pages) === page; end
+
+    def next_page; @next_page ||= page + 1  if page < total_pages; end
+
+    attr_reader :conditions
+    attr_reader :page
+    attr_reader :per_page
+    attr_reader :order
+  end
+
+end