rewritten 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37841f437483adb3768e967970d71867cb642c7f
-  data.tar.gz: 9e3f522b3cf8f71f1ca71a5d4b1283fdfda63e58
+  metadata.gz: a44ade38a5b5052b5d98a4424fc444e7b4208939
+  data.tar.gz: 6ddaf0da53b50cca46e91c6d4a77a90003abfeb4
 SHA512:
-  metadata.gz: ccd2858e30f1b317f3d2b879ee8e246090203713a0047f0fa67183075fa7feb927d61ba5ba72ef98b59a0652bd020d4901c7aa110ccc1a8a72eeb49f1736f730
-  data.tar.gz: f0223d07fd9ebdafb2f6e9835d99f4bba4fa45e7d99a7088d891f3500496de033198f2fc57cf2851b53c35b568361e3d0de0fe35bb0b530b1bfdad1c23ae71d4
+  metadata.gz: e2c287f97d495e2a7f566baba6ab2a9c266f05f984daa5eca6d76cd74a0961c5fc0e62d08517ddf616612468dc2c74f1253b50f2ceefde2f3eb61e3ff59f9986
+  data.tar.gz: 0ca027f2379473fbf9602fcaf04c33d62e00b3f56c3628d903e99b372e1b83102c78da4ee5aee4bac9644b69a005ee29ce469df5d4b8ec14061c2fc9139aa2b5

data/README.md

@@ -0,0 +1,126 @@
+Rewritten [![Build Status](https://travis-ci.org/learnjin/rewritten.png?branch=master)](https://travis-ci.org/learnjin/rewritten/) [![Code Climate](https://codeclimate.com/github/learnjin/rewritten.png)](https://codeclimate.com/github/learnjin/rewritten) [![Coverage Status](https://coveralls.io/repos/learnjin/rewritten/badge.png)](https://coveralls.io/r/learnjin/rewritten)
+=========
+
+Rewritten is a lookup-based rewriting engine that rewrites requested URLs on
+the fly. The URL manipulations depend on translations found in a redis
+database. URLs without translations are passed through while URLs with
+translations result in a either redirection or ultimatively in a modification
+of path and request parameters. The gem is compromised of several 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 requests (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 requests (Rack::Rewritten::Record)
+6. A Rack app for identifying subdomains (Rack::Rewritten::Subdomain)
+
+Part 1. and 2. are based heavily on parts from the Resque codebase.
+
+## Installation
+
+    gem install rewritten
+
+On Rails add Rewritten to your Gemfile:
+
+    gem 'rewritten'
+
+Rewritten works completely transparent and decoupled as Rack middleware. Add it to your rack stack.
+
+    # config.ru
+    require 'rewritten'
+    
+    Rewritten.redis = Redis.new(host: 'host', port: 'port', password: 'password' )
+
+    map "/" do
+      use Rack::Rewritten::Url
+      use Rack::Rewritten::Html
+      run MyApp::Application
+    end
+
+
+This will translate pretty/SEO requests to the language that MyApp speaks and translate the HTML-Output of
+MyApp to the desired pretty/SEO language.
+
+On Rails the HTML translation can also be achieved by including the following to your <tt>application_controller.rb</tt>:
+
+    require 'rewritten/rails'
+
+    class ApplicationController < Action:Controller::Base
+    
+      include Rewritten::Rails::UrlHelper
+    
+      # ....
+      #
+
+    end
+
+This way all routes helpers will be translated.
+
+
+## Managing Vocabulary
+
+To manage the vocabulary from within your Rack app you need to establish a connection to the same
+redis db (on Rails put this into an initializer).
+
+    include 'rewritten'
+    Rewritten.redis = Redis.new(host: 'host', port: 'port', password: 'password' )
+
+The ruby library allows you to successively add and remove vocabulary:
+
+    Rewritten.add_translation('/apple-computer/newton', '/products/4e4d3c6a1d41c811e8000009')
+    Rewritten.add_translation('/apple/ipad', '/products/4e4d3c6a1d41c811e8000009')
+
+    Rewritten.remove_translation('/failed-computer/newton', '/products/4e4d3c6a1d41c811e8000009')
+
+
+To query for the current "trade language" use:
+
+    Rewritten.get_current_translation('/products/4e4d3c6a1d41c811e8000009')         # => "/apple/ipad"
+
+
+## The web front end
+
+Rewritten comes with a Sinatra-based front end for dislaying and
+managing your URL translations (layout taken from Resque). Include it in your Rack stack with:
+
+    require 'rewritten/server'
+
+    map "/rewritten" do
+      use Rack::Auth::Basic do |username, password|
+        username == 'user' and password == 'password'
+      end
+      run Rewritten::Server
+    end
+
+### Standalone
+
+Running the gem in standalone mode is easy as well:
+
+    $ rewritten-web 
+
+It's based on Vegas, a thin layer around rackup, and as such configurable as well:
+
+    $ rewritten-web -p 8282
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

data/lib/rewritten/rails/url_helpers.rb

@@ -0,0 +1,12 @@
+module Rewritten
+  module Rails
+    module UrlHelper
+
+      def url_for(options = nil)
+        Rewritten.get_current_translation(super)
+      end
+
+    end
+  end
+end
+

data/lib/rewritten/rails.rb

@@ -0,0 +1 @@
+require 'rewritten/rails/url_helpers'

data/lib/rewritten/version.rb

@@ -1,4 +1,4 @@
 module Rewritten
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end
 

data/rewritten.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest"
   s.add_development_dependency "pry"
+  s.add_development_dependency "coveralls"
 
   s.description = <<description
     Rewritten is a lookup-based rewriting engine that rewrites requested

data/test/test_helper.rb

@@ -1,6 +1,9 @@
 require 'rewritten'
 require 'minitest/autorun'
 require 'pry'
+require 'coveralls'
+
+Coveralls.wear!
 
 class Minitest::Spec 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rewritten
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Kai Rubarth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-namespace
@@ -108,6 +108,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       Rewritten is a lookup-based rewriting engine that rewrites requested
       URLs on the fly. The URL manipulations depend on translations found in
@@ -137,7 +151,7 @@ files:
 - .gitignore
 - Gemfile
 - HISTORY.rdoc
-- README.rdoc
+- README.md
 - Rakefile
 - bin/rewritten-dump.rb
 - bin/rewritten-import.rb
@@ -151,6 +165,8 @@ files:
 - lib/rewritten.rb
 - lib/rewritten/config.ru
 - lib/rewritten/helpers.rb
+- lib/rewritten/rails.rb
+- lib/rewritten/rails/url_helpers.rb
 - lib/rewritten/server.rb
 - lib/rewritten/server/public/favicon.ico
 - lib/rewritten/server/public/idle.png

data/README.rdoc

@@ -1,113 +0,0 @@
-= Rewritten 
-
-Rewritten is a lookup-based rewriting engine that rewrites requested
-URLs on the fly. The URL manipulations depend on translations found in
-a redis database.
-
-If a matching translation is found, the result of a request is either a
-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 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 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
-
-There seem to be unresolved issues when Rack::Rewritten::Html is used
-in conjunction with the New Relic gem (being a rack app as well).
-Unfortunately the only workaround so far is either disabling New Relic
-or Rack::Rewritten::Html (pointers in the right debugging direction or
-pull requests are welcome).
-
-
-== Overview
-
-The Rewritten library allows you to create new URL translations and     
-then query for the current "trade language" of an URL.                  
-
-    Rewritten.add_translation('/apple-computer/newton', '/products/4e4d3c6a1d41c811e8000009')
-    Rewritten.add_translation('/apple/ipad', '/products/4e4d3c6a1d41c811e8000009')
-    Rewritten.get_current_translation('/products/4e4d3c6a1d41c811e8000009')         # => "/apple/ipad"
-
-Translations are removed in a similar fashion.
-
-    Rewritten.remove_translation('/apple-computer/newton', '/products/4e4d3c6a1d41c811e8000009')
-
-
-== Usage in your Rack stack
-
-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
-
-This way the URL rewriting and generation is stays decoupled from your
-app. For a Rails app, for instance, you wouldn't need to mess with your
-<tt>routes.rb</tt> or path helpers when dealing with custom URLs.
-
-
-== The Front End
-
-Rewritten comes with a Sinatra-based front end for dislaying and
-managing your URL translations (in the familiar Resque layout).
-
-[IMAGE]
-
-
-=== Standalone
-
-Running Rewritten as a gem in standalone mode is easy:
-
-    $ rewritten-web 
-
-It's based on Vegas, a thin layer around rackup, and as such configurable as well:
-
-    $ rewritten-web -p 8282
-
-
-=== Rack::URLMap
-
-To load Rewritten on a subpath alongside other apps you can make use of URLMap:
-
-run Rack::URLMap.new \
-    "/"       => Your::App.new,
-    "/resque" => Rewritten::Server.new
-    
-Check lib/test.ru for a functional example.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-