rack-jquery-params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9172bcca4b13cbe8b15425156a6139deb65cb013
+  data.tar.gz: 1c3452cd4b88cac928c732098e65ef2c7bc5fce8
+SHA512:
+  metadata.gz: 89ff06303106907931d430498f98fce1cf150a05ed03491ebab743c95e927b57ba6e1f5e2f1cd59f3dbc3521b8bee7a3eee21f899d4dab6b4693642bf11e5a4d
+  data.tar.gz: 299c03e247fa6dfb1bda73714940d4bd18091b007500b51334e94367cc9896474744bc12f3caeb52d6c184f112425c2f786d885b5daa0f39ec99ba6c280c03d2

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store
+.idea/
+.idea/*
+Gemfile.lock

data/.yardopts

@@ -0,0 +1,5 @@
+lib/**/*.rb
+--load ./.yardopts.rb
+--markup-provider=redcarpet
+--markup=markdown
+--readme README.md

data/.yardopts.rb

@@ -0,0 +1 @@
+require 'redcarpet/compat'

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'rack-test'
+  gem 'simplecov', :require => false
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup', :require => true
+end

data/README.md

@@ -0,0 +1,79 @@
+rack-jquery-params
+===========
+
+A Rack middleware that bridges the discrepancy between jQuery.param and how Rack parses nested params within query
+strings and post bodies.
+
+If you use jQuery's get, post, put, or ajax methods then jQuery.param is run on your data. The problem is that jQuery.param
+turns this javascript object:
+
+ ```
+ {test: [{this_is_an_object_inside_an_array:'yes'}]}
+ ```
+
+into a query string that Rack cannot read correctly:
+
+```
+test[0][this_is_an_object_inside_an_array]=yes
+```
+
+Rack expects all arrays to be sent as empty brackets (i.e., "test[]"). It parses jQuery's "test[0]" as a hash, resulting
+in the following params:
+
+```ruby
+{
+    :test => {
+        :0 => {
+            :this_is_an_object_inside_an_array => 'yes'
+        }
+    }
+}
+```
+
+This gem fixes the above params and converts it to:
+
+```ruby
+{
+    :test => [
+        {
+            :this_is_an_object_inside_an_array => 'yes'
+        }
+    ]
+}
+```
+
+## Setting Up JSONR
+
+Install the gem:
+
+```ruby
+gem install rack-jquery-params
+```
+
+In your Gemfile:
+
+```ruby
+gem 'rack-jquery-params', :require => 'rack/jquery-params'
+```
+
+Activate by including it your config.ru file:
+
+```ruby
+use Rack::JQueryParams
+run Sinatra::Application
+```
+
+## Options
+
+By default the JQueryParams fix is applied to all http methods, however you can change this functionality by setting
+the applies_to option with your chosen http method:
+
+```ruby
+use Rack::JQueryParams :applies_to => :get
+```
+
+ You can also set applies_to to be an array of http methods:
+
+```ruby
+use Rack::JQueryParams :applies_to => [:get, :put, :delete]
+```

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'fileutils'
+include FileUtils
+
+task :run_test do
+  Rake::Task['test'].execute
+  puts '---------------------------------------------------------------------'
+  puts 'TESTS PASSED... READY TO BUILD...'
+  puts '---------------------------------------------------------------------'
+end
+task :build => :run_test
+task :default => :build
+
+########################################################################
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/rack/jquery-params.rb

@@ -0,0 +1,2 @@
+require_relative 'jquery-params/load'
+require_relative 'jquery-params/version'

data/lib/rack/jquery-params/load.rb

@@ -0,0 +1,63 @@
+require 'rack'
+
+module Rack
+  class JQueryParams
+    include Rack::Utils
+
+    HTTP_METHODS = %w(GET PUT POST DELETE HEAD OPTIONS PATCH)
+    ALL = 'ALL'
+
+    def initialize(app, options={})
+      @options = options
+      @app = app
+    end
+
+    # Loops through all params and convert the hashes to arrays only if all keys are comprised of integers.
+    #
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      self.class.fix(env, @options[:applies_to])
+      [status, headers, response]
+    end
+
+    def self.fix(env, valid_methods=:all)
+      valid_methods = extract_valid_methods(valid_methods)
+      return if valid_methods != :all and !valid_methods.include?(env['REQUEST_METHOD'])
+      env['rack.request.query_hash'].each {|k,p| env['rack.request.query_hash'][k] = fix_param(p) }
+      env['rack.request.form_hash'].each {|k,p| env['rack.request.form_hash'][k] = fix_param(p) }
+    end
+
+    def self.fix_param(param)
+      if param.is_a?(Hash)
+        if param.all?{|k,v| k =~ /^[0-9]+$/}
+          param.sort.inject([]){|result, v| result << fix_param(v[1]) }
+        else
+          param.each{|k,v| param[k] = fix_param(v)}
+        end
+      elsif param.is_a?(Array)
+        param.each_with_index {|v,i| param[i] = fix_param(v) }
+        return param
+      else
+        return param
+      end
+    end
+
+    def self.extract_valid_methods(object)
+      valid_methods = []
+      if object.is_a?(Array)
+        object.each do |a|
+          a = a.to_s.upcase
+          break valid_methods = [] if a == 'ALL'
+          valid_methods << a if HTTP_METHODS.include?(a)
+        end
+      else
+        method = object.to_s.upcase
+        valid_methods = [method] if HTTP_METHODS.include?(method)
+      end
+      (valid_methods.size > 0) ? valid_methods : :all
+    end
+
+  end
+
+end

data/lib/rack/jquery-params/version.rb

@@ -0,0 +1,3 @@
+class Rack::JQueryParams
+  VERSION = '0.1.0'
+end

data/rack-jquery-params.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/jquery-params'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'rack-jquery-params'
+  gem.version     = Rack::JQueryParams::VERSION
+  gem.date        = '2015-01-18'
+  gem.summary     = %q{Rack middleware that fixes the discrepancy between jQuery.param and how Rack parses nested queries.}
+  gem.authors     = ['Caleb Clark']
+  gem.email       = ['cclark@fanforce.com']
+  gem.homepage    = 'http://github.com/calebclark/rack-jquery-params'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rack'
+end

data/test/rack/params_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'rack/jquery-params'
+
+describe 'params' do
+
+  def create_env
+    {
+        'rack.request.query_hash' => {},
+        'rack.request.form_hash' => {},
+        'REQUEST_METHOD' => 'POST'
+    }
+  end
+
+  it 'should ignore hashes that have non-integers in the key' do
+    env = create_env.merge('rack.request.query_hash' => {non_array: {'0' => 'is integer', '1' => 'is integer', 'a' => 'is not integer'}})
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.query_hash'][:non_array].is_a?(Hash)
+  end
+
+  it 'should convert first-level hashes that resembles an array' do
+    env = create_env.merge('rack.request.query_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.query_hash'][:array].is_a?(Array)
+  end
+
+  it 'should convert any level of hash that resembles an array' do
+    env = create_env.merge('rack.request.query_hash' => {non_array: {'a' => 'is not integer', :array => {'0' => 'is integer', '1' => 'is integer'}}})
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.query_hash'][:non_array][:array].is_a?(Array)
+  end
+
+  it 'should fix query_hash or form_hash' do
+    env = create_env.merge('rack.request.query_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.query_hash'][:array].is_a?(Array)
+
+    env = create_env.merge('rack.request.form_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.form_hash'][:array].is_a?(Array)
+  end
+
+  it 'should apply to all methods' do
+    env = create_env.merge('rack.request.form_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    env['REQUEST_METHOD'] = 'POST'
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.form_hash'][:array].is_a?(Array)
+
+    env = create_env.merge('rack.request.query_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    env['REQUEST_METHOD'] = 'GET'
+    Rack::JQueryParams.fix(env, :all)
+    assert env['rack.request.query_hash'][:array].is_a?(Array)
+  end
+
+  it 'should allow apply to a single methods' do
+    env = create_env.merge('rack.request.query_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    env['REQUEST_METHOD'] = 'GET'
+    Rack::JQueryParams.fix(env, :get)
+    assert env['rack.request.query_hash'][:array].is_a?(Array)
+
+    env = create_env.merge('rack.request.form_hash' => {array: {'0' => 'is integer', '1' => 'is integer', '2' => 'is integer'}})
+    env['REQUEST_METHOD'] = 'POST'
+    Rack::JQueryParams.fix(env, :get)
+    assert env['rack.request.form_hash'][:array].is_a?(Hash)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'rack/test'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rack-jquery-params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: 
+email:
+- cclark@fanforce.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- .yardopts.rb
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack/jquery-params.rb
+- lib/rack/jquery-params/load.rb
+- lib/rack/jquery-params/version.rb
+- rack-jquery-params.gemspec
+- test/rack/params_test.rb
+- test/test_helper.rb
+homepage: http://github.com/calebclark/rack-jquery-params
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Rack middleware that fixes the discrepancy between jQuery.param and how Rack
+  parses nested queries.
+test_files:
+- test/rack/params_test.rb
+- test/test_helper.rb
+has_rdoc: