rewritten 0.1.0 → 0.2.0

data/HISTORY.rdoc

@@ -1,3 +1,8 @@
+== 0.2.0
+
+* support for subdomains
+* streamlined CRUD interface in web gui 
+* cleanup page
 
 == 0.1.0
 
@@ -9,4 +14,3 @@
 * fixed bug with unescaped keys in web gui
 
 
-

data/README.rdoc

@@ -9,13 +9,14 @@ redirection or a modification of path and request parameters. For URLs
 without translation entries the request is left unmodified.
 
 Rewritten takes larges parts from the Resque codebase (which rocks). The
-gem is compromised of four parts:
+gem is compromised of six parts:
 
 1. A Ruby library for creating, modifying and querying translations
 2. A Sinatra app for displaying and managing translations
-3. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
-4. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
-5. A Rack app for recording successful request (Rack::Rewritten::Record)
+3. A Rack app for identifying subdomains (Rack::Rewritten::Subdomain)
+4. A Rack app for rewriting and redirecting request (Rack::Rewritten::Url)
+5. A Rack app for substituting URLs in HTML pages with their current translation (Rack::Rewritten::Html)
+6. A Rack app for recording requests (Rack::Rewritten::Record)
 
 
 == New Relic Notice
@@ -43,9 +44,10 @@ Translations are removed in a similar fashion.
 
 == Usage in your Rack stack
 
-To take full advantage of the engine you would use both, the URL and
-HTML, rack apps as follows:
+To take full advantage of the engine you would be using  at least
+the following stack:
 
+    use Rack::Rewritten::Subdomain, "example.com", "lvh.me" # only needed for subdomain support
     use Rack::Rewritten::Url
     use Rack::Rewritten::Html
     run Your::App

data/lib/rack/dummy.rb

@@ -5,13 +5,16 @@ module Rack
   class Dummy
 
     def call(env)
-     puts "-> Rack::Dummy"
-     lines = []
-     req = Rack::Request.new(env)
-     lines <<  req.path
-     lines <<  req.params.inspect
-     lines << '<a href="/some/resource">'
-     [200, {"Content-Type"  => "text/plain"}, lines.join("\n")]
+      puts "-> Rack::Dummy"
+      lines = []
+      req = Rack::Request.new(env)
+      lines <<  req.path
+      lines <<  req.params.inspect
+      lines <<  req.host
+      lines <<  req.env.inspect
+      lines <<  "SUBDOMAIN: #{env['SUBDOMAIN']}"
+      lines << '<a href="/some/resource">'
+      [200, {"Content-Type"  => "text/plain"}, lines.join("\n")]
     end
 
   end

data/lib/rack/subdomain.rb

@@ -0,0 +1,35 @@
+require 'rack'
+
+module Rack
+
+  module Rewritten
+
+    class Subdomain
+
+      def initialize(app, *fqdns)
+        @app = app
+        @fqdns = fqdns
+      end
+
+      def call(env)
+        puts "-> Rack::Rewritten::Subdomain"
+        req = Rack::Request.new(env)
+
+        @fqdns.each do |n|
+          if req.host =~ /(.+)\.#{n}$/
+            env["SUBDOMAIN"] = $1
+            env["FQDN"] = n 
+            break
+          end
+        end
+
+        @app.call(env) 
+      end
+
+    end
+
+  end
+
+end
+
+

data/lib/rack/url.rb

@@ -14,8 +14,13 @@ module Rack
         puts "-> Rack::Rewritten::Url"
         req = Rack::Request.new(env)
 
-        if to = ::Rewritten.redis.get("from:#{req.path_info}")
+        subdomain = env["SUBDOMAIN"] ? "#{env["SUBDOMAIN"]}:" : ""
+
+        puts "SUBDOMAIN: #{subdomain}"
+
+        if to = ::Rewritten.redis.get("from:#{subdomain}#{req.path_info}")
           current_path = ::Rewritten.list_range("to:#{to}", -1, 1)  
+          current_path = current_path.split(":").last
           if current_path == req.path_info
             # if this is the current path, rewrite path and parameters
             tpath, tparams = split_to_path_params(to)
@@ -25,8 +30,15 @@ module Rack
           else
             # if this is not the current path, redirect to current path
             r = Rack::Response.new
-            r.redirect(current_path, 301)
-            r.finish
+            # NOTE: assuming redirection is always to non-subdomain-path
+            new_path = env["rack.url_scheme"]
+            new_path << "://"
+            new_path << env["HTTP_HOST"].sub(/^#{subdomain.chomp(':')}\./, '')
+            new_path << current_path
+            r.redirect(new_path, 301)
+            a = r.finish
+            puts a.inspect
+            a
           end
         else
           @app.call(req.env) 

data/lib/rewritten/server/views/cleanup.erb

@@ -0,0 +1,28 @@
+
+<h1>Cleanup</h1>
+
+<% if @from_without_tos.size > 0 %>
+
+<p>The following translations seem to be broken:</p>
+
+<table class=''>
+  <tr>
+    <th>from URL (Browser Location)</th>
+    <th>to URL (Your App)</th>
+  </tr>
+
+  <% for from in @from_without_tos  %>
+    <tr>
+      <td><%= from %></td> 
+      <td></td>
+      <td><a href='<%= u("/delete?from=#{escape(from)}") %>'>delete</a></td>
+    </tr>
+  <% end %>
+
+</table>
+
+<% else %>
+  <p>No obviously broken translations found.</p>
+<% end %>
+
+

data/lib/rewritten/server/views/delete.erb

@@ -1,5 +1,5 @@
 <div style="">
-  <% if @from && @to %>  
+  <% if @from %>  
 
     <h2 style="width: 90%; overflow: scroll"><%= @from %> -> <%= @to %> </h2>
 

data/lib/rewritten/server/views/delete_all.erb

@@ -0,0 +1,40 @@
+
+<div style="">
+  <% if @to %>  
+
+    <h1 class='wi'><%= @to %> (App URL)</h1>
+
+    <table class='queues'>
+      <tr>
+        <th>Translations (Browser Location Bar) </th>
+      </tr>
+      <% for translation in Rewritten.get_all_translations(@to) %>
+        <tr>
+          <td class=''><a href="<%= translation %>" target="new"><%= translation %></td>
+          </tr>
+        <% end %>
+      </table>
+
+      <div style="float :left">
+
+        <p>
+        From a SEO perspective it's wise to keep the links and just 
+        <a href='<%= u("/edit?to=#{escape(@to)}") %>'>add another translation</a> resulting in a 301 redirect.
+        </p>
+        <p>
+        Are you sure you want to delete all translations? THIS CANNOT BE UNDONE.
+        </p>
+
+        <form action='<%= u("/delete_all")%>' method="post" style="margin-top: 10px ">  
+          <input type="hidden" name="_method" value="delete">  
+          <input type="hidden" name="from" value="<%= @from %>">
+          <input type="hidden" name="to" value="<%= @to %>">
+          <input type="submit" value="Yes, I know; please do remove everything!">
+          <a href='<%= u("/to?to=#{escape(@to)}") %>'>Cancel</a>  
+        </form>  
+      </div>
+    <% else %>  
+      <p>No translations found.</p>  
+    <% end %>
+  </div>  
+

data/lib/rewritten/server/views/edit.erb

@@ -0,0 +1,27 @@
+
+<h1>Edit Translations</h1>
+
+<p style="background: yellow; line-height:120%; padding: 10px; border: 1px solid black;"> Instead of removing (or renaming)
+existing translations you often really want to add another entry to the
+translation list. Because doing so will ensure that requests to old URLs
+are redirected to their new location (a SEO friendly 301 redirect).
+Especially older entries that may have already been used for links or in
+indexes you will want to keep. </p>
+
+
+<div style="float: left; margin-top: 10px">
+  <form method="POST" action="<%= u "/edit" %>" >
+
+    <%= partial :fields %> 
+
+    <p>
+    <input type="submit" value="Change!" />
+    <a href='<%= u("/to?to=#{escape(@to)}") %>'>Cancel</a>  
+    </p>
+
+  </form>
+</div>
+
+
+
+

data/lib/rewritten/server/views/fields.erb

@@ -0,0 +1,18 @@
+
+<input type="hidden" name="old" size="80" value="<%= @old_to  %>"/> <br />
+
+<label>
+  <h2>Translations (What's seen in the browser's location bar)</h2>
+  <p>Last line being the final location in the browser</p>
+  <p>Subdomains are to be prefixed with a colon, e.g. my.subdomain:/some/path</p>
+</label><br/>
+
+<textarea name="translations" cols="80" rows="10"><%= @translations.join("\n") %></textarea> <br />
+
+<p>
+<label><h2>Resource (What your app sees)</h2></label><br/>
+<textarea name="to" cols="80" rows="2"><%= @to %></textarea>
+</p>
+
+
+

data/lib/rewritten/server/views/new.erb

@@ -1,17 +1,17 @@
 
-
-<h1>New Translation</h1>
-
+<h1>+ Add Translations</h1>
 
 <div style="float: left; margin-top: 10px">
-<form method="POST" action="<%= u "/translations" %>" >
-  <label>From (what the user sees) </label><br/>  <input type="text" name="from" size="80"/> <br />
-  <label>To (what your app sees) </label><br/>   <textarea name="to" cols="80" rows="5" value="<%= params[:to] %>"></textarea> <br />
-  <input type="submit" value="Create" />
-  <a href='<%= u("/translations") %>'>Cancel</a>  
-</form>
-</div>
+  <form method="POST" action="<%= u "/translations" %>" >
 
+    <%= partial :fields %>
 
+    <p>
+    <input type="submit" value="Add" />
+    <a href='<%= u("/") %>'>Cancel</a>  
+    </p>
+
+  </form>
+</div>
 
 

data/lib/rewritten/server/views/to.erb

@@ -1,7 +1,15 @@
 
 <h1 class='wi'><%= params[:to] %> (App URL)</h1>
 
-<a href="<%= u(%|/new?to=#{Rack::Utils.escape(params[:to])}|) %>"> + add another translation </a>
+
+<p>
+<a href="<%= u(%|/edit?to=#{escape(params[:to])}|) %>">% rename</a>
+</p>
+
+<p>
+<a href="<%= u(%|/delete_all?to=#{escape(params[:to])}|) %>">!! delete all</a>
+</p>
+
 
 <table class='queues'>
   <tr>
@@ -12,7 +20,11 @@
   <% for translation in Rewritten.list_range("to:#{params[:to]}", 0, 100) %>
     <tr>
       <td class=''><a href="<%= translation %>" target="new"><%= translation %></td>
-      <td class=''><a href="<%= u("/delete?from=#{translation}&to=#{escape(params[:to])}") %>">Delete</a></td>
+        <td class=''>
+          <a href="<%= u(%|/edit?to=#{escape(params[:to])}|) %>"> add </a>| 
+          <a href="<%= u(%|/edit?to=#{escape(params[:to])}|) %>"> edit </a>|
+          <a href="<%= u(%|/edit?to=#{escape(params[:to])}|) %>"> remove </a>
+        </td>
     </tr>
   <% end %>
 

data/lib/rewritten/server/views/translations.erb

@@ -1,42 +1,42 @@
 
 <%# @subtabs = resque.queues unless partial? || params[:id].nil? %>
 
-  <h1 class='wi'>Translations</h1>
-
-  <p class='intro'>The list below contains all the registered translations from an 
-  url to target url.  To view all translations for a target click on the
-  target URL.</p>
-
-  <a href="<%= u('/new') %>"> + New Translation </a>
-
-
-  <form method="get">
-    <label>Filter:</label> <input type="text" name="f" value="<%= params[:f] %>"/>
-    <a href="<%= u('/translations') %>"> clear </a>
-  </form>
-
-  <p class='sub'>
-  Showing <%= @start + 1%> to <%= [@size, @start + Rewritten.per_page].min %> of <b><%= @size %></b> translations
-  <% if params[:f] && params[:f] != '' %>
-    matching: <%= params[:f] %>.
-  <% else %>.<% end %>
-  </p>
-
-  <table class=''>
+<h1 class='wi'>Translations</h1>
+
+<p class='intro'>The list below contains all the registered translations from an 
+url to target url.  To view all translations for a target click on the
+target URL.</p>
+
+<p><a href="<%= u('/new') %>"> + New Translation </a></p>
+<p><a href="<%= u('/cleanup') %>"> % Cleanup </a></p>
+
+<form method="get">
+  <label>Filter:</label> <input type="text" name="f" value="<%= params[:f] %>"/>
+  <a href="<%= u('/translations') %>"> clear </a>
+</form>
+
+<p class='sub'>
+Showing <%= @start + 1%> to <%= [@size, @start + Rewritten.per_page].min %> of <b><%= @size %></b> translations
+<% if params[:f] && params[:f] != '' %>
+  matching: <%= params[:f] %>.
+<% else %>.<% end %>
+</p>
+
+<table class=''>
+  <tr>
+    <th>from URL (Browser Location)</th>
+    <th>to URL (Your App)</th>
+  </tr>
+
+  <% for from,to in @translations %>
     <tr>
-      <th>from URL (Browser Location)</th>
-      <th>to URL (Your App)</th>
+      <td class=''><a href="<%= from %>" target="new"><%= from %></td>
+      <td class=''><a href="<%= u("/to?to=#{escape(to)}") %>"><%= to %></td>
     </tr>
-
-    <% for from,to in @translations %>
-      <tr>
-        <td class=''><a href="<%= from %>" target="new"><%= from %></td>
-        <td class=''><a href="<%= u("/to?to=#{escape(to)}") %>"><%= to %></td>
-        </tr>
-      <% end %>
+  <% end %>
 
     </table>
 
 
-  <%= partial :next_more, :start => @start, :size => @size %>
+    <%= partial :next_more, :start => @start, :size => @size %>
 

data/lib/rewritten/server.rb

@@ -78,6 +78,11 @@ module Rewritten
         end
       end
 
+      def extract_translations
+        text = params[:translations] or ""
+        text.split("\n").map(&:strip).reject(&:empty?)
+      end
+
       def show_args(args)
         Array(args).map { |a| a.inspect }.join("\n")
       end
@@ -173,12 +178,41 @@ module Rewritten
     end
 
     get "/new" do 
+      @translations = []
       show "new"
     end
 
+    get "/edit" do
+      @old_to = @to = params[:to]
+      @translations = Rewritten.get_all_translations(@to)
+      show "edit"
+    end
+
+    post "/edit" do
+
+      @old_to = params[:old].strip
+      @to = params[:to].strip
+      @translations = extract_translations
+
+      if @to != '' and @translations.size > 0
+
+        # delete old translations
+        Rewritten.remove_all_translations(@old_to)
+        # create new translations
+        Rewritten.add_translations(@to, @translations)
+
+        redirect u("/to?to=#{escape(@to)}")
+      else
+        show "edit"
+      end
+
+    end
+
     post "/translations" do
-      if params[:from]!='' && params[:to]!=''
-        Rewritten.add_translation(params[:from], params[:to])
+      @to = params[:to].strip
+      @translations = extract_translations 
+      if @to != '' && @translations.size > 0
+        Rewritten.add_translations(@to, @translations)
         redirect u('translations')
       else
         show "new"
@@ -190,6 +224,18 @@ module Rewritten
       show "to" 
     end
 
+    get "/cleanup" do
+      # find keys that have no target
+      @from_without_tos= []
+      Rewritten.redis.lrange("froms", 0, -1).each do |from|
+        if Rewritten.redis.get("from:#{from}").empty?
+          @from_without_tos << from
+        end
+      end
+      
+      show "cleanup"
+    end
+
     get "/delete" do
       @from = params[:from]
       @to = params[:to]
@@ -197,18 +243,20 @@ module Rewritten
     end
 
     post '/delete' do
-
       from = params[:from]
       to   = params[:to]
-
       Rewritten.remove_translation(from, to)
+      redirect u("/")
+    end
 
-      if Rewritten.num_translations(to) > 0
-        redirect u("/to?to=#{escape(to)}")
-      else
-        redirect u("/")
-      end
+    get "/delete_all" do
+      @to = params[:to]
+      show "delete_all"
+    end
 
+    post "/delete_all" do
+      Rewritten.remove_all_translations(params[:to])
+      redirect u("/")
     end
 
     get "/hits" do
@@ -225,10 +273,9 @@ module Rewritten
     end
 
     def self.tabs
-      #@tabs ||= ["Overview", "Working", "Failed", "Queues", "Workers", "Stats"]
       @tabs ||= ["Translations", "Hits"] 
     end
- 
+
   end
 end
 

data/lib/rewritten/version.rb

@@ -1,3 +1,3 @@
 module Rewritten
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rewritten.rb

@@ -5,6 +5,7 @@ require 'rack/dummy'
 require 'rack/url'
 require 'rack/record'
 require 'rack/html'
+require 'rack/subdomain'
 
 module Rewritten
   include Helpers
@@ -131,6 +132,10 @@ module Rewritten
     redis.rpush("to:#{to}", from) 
   end
 
+  def add_translations(to, froms)
+    froms.each {|from|  add_translation(from, to)}
+  end
+
   def num_translations(to)
     Rewritten.size("to:#{to}")
   end
@@ -142,8 +147,18 @@ module Rewritten
     Rewritten.redis.lrem("tos", 0, to) if num_translations(to) == 0
  end
 
+  def remove_all_translations(to)
+    get_all_translations(to).each do |from|
+      Rewritten.remove_translation(from, to)
+    end
+  end
+
+  def get_all_translations(to)
+    Rewritten.redis.lrange("to:#{to}", 0, -1)
+  end
+
   def get_current_translation(path)
-    translation = Rewritten.list_range("to:#{path}", -1, 1)  
+    translation = Rewritten.list_range("to:#{path}", -1)  
     return translation if translation
     return path
   end

data/lib/test.ru

@@ -4,7 +4,8 @@ require 'rewritten'
 require 'rewritten/server'
 
 map "/" do
-  use Rack::Rewritten::Record
+  #use Rack::Rewritten::Record
+  use Rack::Rewritten::Subdomain, "doxter.de", "lvh.me"
   use Rack::Rewritten::Url
   use Rack::Rewritten::Html
   run Rack::Dummy.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rewritten
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kai Rubarth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-12 00:00:00 Z
+date: 2011-09-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis-namespace
@@ -100,6 +100,7 @@ files:
 - lib/rack/dummy.rb
 - lib/rack/html.rb
 - lib/rack/record.rb
+- lib/rack/subdomain.rb
 - lib/rack/url.rb
 - lib/rewritten.rb
 - lib/rewritten/config.ru
@@ -115,9 +116,13 @@ files:
 - lib/rewritten/server/public/style.css
 - lib/rewritten/server/public/working.png
 - lib/rewritten/server/test_helper.rb
+- lib/rewritten/server/views/cleanup.erb
 - lib/rewritten/server/views/clear_hits.erb
 - lib/rewritten/server/views/delete.erb
+- lib/rewritten/server/views/delete_all.erb
+- lib/rewritten/server/views/edit.erb
 - lib/rewritten/server/views/error.erb
+- lib/rewritten/server/views/fields.erb
 - lib/rewritten/server/views/hits.erb
 - lib/rewritten/server/views/layout.erb
 - lib/rewritten/server/views/new.erb