rack-matrix_params 0.0.1 → 0.0.5

data/.travis.yml

@@ -0,0 +1,4 @@
+language:	ruby
+rvm:
+  - 1.9.3
+  - jruby

data/README.markdown

@@ -1,18 +1,23 @@
 Rack::MatrixParams
 ==================
 
-Just simple Rack middleware to enable 'matrix' params
+[![Build Status](https://travis-ci.org/jphastings/rack-matrix_params.png)](https://travis-ci.org/jphastings/rack-matrix_params)
 
-FEATURES:
----------
+
+Just simple Rack middleware to enable 'matrix' params.
+
+*Originally developed by [Michal Fojtik](https://github.com/mifo/rack-matrix-params).*
+
+Features
+--------
 
 - Allow you to use Matrix URLs:
   - http://localhost:9393/library;category=biology/book;author=Bond;hardcover=yes
   - http://localhost:9393/library/book;author=Bond;hardcover=yes
   - http://localhost:9393/library;category=biology/book?id=123
 
-EXAMPLES:
----------
+Examples
+--------
 
 ### Example Sinatra server
 
@@ -22,7 +27,7 @@ EXAMPLES:
     use Rack::MatrixParams
 
     get '/' do
-      "Visit <a href=\"/library;category=biology/book;author=Bond;hardcover=yes\">/library;category=biology/book;author=Bond;hardcover=yes</a>"
+      "Visit <a href=\"/library;category=biology/book;author=Bond;hardcover=yes\">a matrix URL</a>."
     end
 
     get '/library/book' do
@@ -44,7 +49,14 @@ http://localhost:9393/library;category=biology/book?id=123
     params['library']['category']='biology'
     params['id']=123
 
-## LICENSE
+To Do
+-----
+
+* Write more tests!
+* Investigate which environment variables are changed, so that hopefully the Rack Log (eg. in Sinatra) doesn't have the hacked query string visible.
+
+LICENSE
+-------
 
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with

data/TODO

@@ -0,0 +1 @@
+* Look at the POST section - something'sweird there!

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/lib/rack/matrix_params.rb

@@ -40,50 +40,52 @@ module Rack
     # regular <form> parameters.
     
     def call(env)
-      # Copy PATH_INFO to REQUEST_URI if Rack::Test
-      env['REQUEST_URI'] = env['PATH_INFO'] if env['rack.test']
-
       # Split URI to components and then extract ;var=value pairs
-      uri_components = env['REQUEST_URI'].split('/')
+      uri_components = env['PATH_INFO'].split('/')
       matrix_params = {}
       uri_components.each do |component|
-       sub_components, value = component.split(/\;(\w+)\=/), nil
-      next unless sub_components.first  # Skip subcomponent if it's empty (usually /)
-      while param=sub_components.pop do
-        if value
-          matrix_params[sub_components.first] ||= {}
-          matrix_params[sub_components.first].merge!(
-            param => value
-          )
-          value=nil
-          next
-        else
-          value = param
+       sub_components, value = component.split(/\;([\w:]+)\=/), nil
+        next unless sub_components.first  # Skip subcomponent if it's empty (usually /)
+        while param = sub_components.pop do
+          if value
+            # There are matrix components to this path element
+            (matrix_params[sub_components.first] ||= {}).merge!( param => value )
+
+            value = nil
+            next
+          else
+            # There are no matrix components to this path element
+            value = param
+          end
         end
       end
-    end
+
+      # No need for anything else if there are no matrix params
+      return @app.call(env) if matrix_params.keys.empty?
 
       # If request method is POST, simply include matrix params in form_hash
       env['rack.request.form_hash'].merge!(matrix_params) if env['rack.request.form_hash']
 
       # For other methods it's a way complicated ;-)
-      if env['REQUEST_METHOD']!='POST' and not matrix_params.keys.empty?
+      if env['REQUEST_METHOD'] != 'POST'
 
-        # Rewrite current path and query string and strip all matrix params from it
-        env['REQUEST_PATH'], env['PATH_INFO'] = env['REQUEST_URI'].gsub(/;([^\/]*)/, '').gsub(/\?(.*)$/, '')
-        env['PATH_INFO'] = env['REQUEST_PATH']
-        env['QUERY_STRING'] = env['QUERY_STRING'].gsub(/;([^\/]*)/, '').freeze
+        # Rewrite current path and query string and strip all query params from it
+        env['PATH_INFO'].gsub!(/;([^\/]*)/, '').gsub(/\?(.*)$/, '')
+
+        env['QUERY_STRING'].gsub!(/;([^\/]*)/, '').freeze
         
         new_params = matrix_params.collect do |component, params|
-          params.collect { |k,v| "#{component}[#{k}]=#{CGI::escape(v.to_s)}" }
+          params.collect do |k,v|
+            "#{component}[#{k}]=#{CGI::escape(v.to_s)}"
+          end
         end.flatten
 
       	# Add matrix params as a regular GET params
       	env['QUERY_STRING'] += '&' if not env['QUERY_STRING'].empty?
       	env['QUERY_STRING'] += "#{new_params.join('&')}"
       end
+
       @app.call(env)
     end
   end
-
 end

data/rack-matrix_params.gemspec

@@ -1,11 +1,10 @@
 # -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rack/matrix_params/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "rack-matrix_params"
-  gem.version       = Rack::MatrixParams::VERSION
+  gem.version       = open('./VERSION').read
   gem.authors       = ["JP Hastings-Spital","Michal Fojtik"]
   gem.email         = ["jphastings@gmail.com"]
   gem.description   = %q{Rack middleware that populates the params variable with the contents of matrix parameters in a URL}
@@ -16,7 +15,10 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'rack'
+
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rack-test'
 end

data/spec/matrix_params_spec.rb

@@ -0,0 +1,64 @@
+require File.join(File.dirname(__FILE__),'spec_helper')
+
+describe Rack::MatrixParams do
+	include Rack::Test::Methods
+
+	let(:inner_app) do
+        lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['All good!'] ]}
+    end
+ 
+    let(:app) { described_class.new(inner_app) }
+
+	it 'should not change a normal GET query' do
+		get "/?key=value"
+
+		last_request.env['PATH_INFO'].should == "/"
+		last_request.env['REQUEST_METHOD'].should == "GET"
+		last_request.env['QUERY_STRING'].should == "key=value"
+		last_response.should be_ok
+	end
+
+	it 'should not change a normal POST query' do
+		post "/",{'key' => "value"}
+
+		last_request.env['PATH_INFO'].should == "/"
+		last_request.env['REQUEST_METHOD'].should == "POST"
+		last_request.env['rack.input'].read.should == "key=value"
+		last_response.should be_ok
+	end
+
+	it 'should add variables to the params when a matrix URL is used on a GET request' do
+		get "/path/info;key=value/more"
+
+		last_request.env['PATH_INFO'].should == "/path/info/more"
+		last_request.env['QUERY_STRING'].should == "info[key]=value"
+		last_response.should be_ok
+	end
+
+	it 'should not erase data in a query parameter if a matrix parameter has the same keyname' do
+		get '/path/info;key=value/more?info[key]=somethingelse'
+
+		last_request.env['QUERY_STRING'].should == "info[key]=somethingelse&info[key]=value"
+		last_response.should be_ok
+	end
+
+	it 'should put matrix parameters after query parameters' do
+		get '/path/info;key=value/more?queryparams'
+
+		last_request.env['QUERY_STRING'].should == "queryparams&info[key]=value"
+		last_request.env['QUERY_STRING'].should_not == "info[key]=value&queryparams"
+		last_response.should be_ok
+	end
+
+	it 'should provide access to the matrix parameters via the params variable' do
+		get '/path/info;key=value/more?queryparams'
+
+		last_request.params.should == {'queryparams'=>nil, 'info'=>{'key'=>'value'}}
+	end
+
+	it 'should work in the blinkbox books format' do
+		get '/client;img:w=200/server;v=0/test/9780111222333.sample.epub/OEBPS/chapter_001.html'
+
+		last_request.params.should == {'client'=>{'img:w' => '200'}, 'server'=>{'v'=>'0'}}
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rspec'
+require 'rack/test'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack/matrix_params'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-matrix_params
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,17 +10,17 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -44,6 +44,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +76,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rack middleware that populates the params variable with the contents
   of matrix parameters in a URL
 email:
@@ -69,12 +101,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - README.markdown
 - Rakefile
+- TODO
+- VERSION
 - lib/rack/matrix_params.rb
-- lib/rack/matrix_params/version.rb
 - rack-matrix_params.gemspec
+- spec/matrix_params_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jphastings/rack-matrix_params
 licenses: []
 post_install_message: 
@@ -87,22 +123,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2501651430979619619
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 2501651430979619619
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Allows the use of matrix URLs in a Rack environment
-test_files: []
+test_files:
+- spec/matrix_params_spec.rb
+- spec/spec_helper.rb
+has_rdoc: 

data/lib/rack/matrix_params/version.rb

@@ -1,5 +0,0 @@
-module Rack
-	class MatrixParams
-		VERSION = '0.0.1'
-	end
-end