uri-query_params 0.4.0

data/.gitignore

@@ -0,0 +1,10 @@
+doc
+pkg
+tmp/*
+.DS_Store
+.bundle
+.yardoc
+*.db
+*.log
+*.swp
+*~

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--quiet --markup markdown --title 'URI query_params Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.4.0 / 2010-08-28
+
+* Initial release.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,37 @@
+# URI query_params
+
+* [github.com/postmodern/uri-query_params](http://github.com/postmodern/uri-query_params/)
+* [github.com/postmodern/uri-query_params/issues](http://github.com/postmodern/uri-query_params/issues/)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+Allows access to the query component of the URI as a Hash. This is similar
+to `$_GET` from PHP, except available on any {URI::HTTP} object.
+
+## Examples
+
+Inspecting the URI query_params:
+
+    url = URI('http://www.google.com/search?hl=en&client=firefox-a&rls=org.mozilla%3Aen-US%3Aofficial&hs=1HY&q=bob+ross&btnG=Search')
+    url.query_params
+    # => {"btnG"=>"Search", "hs"=>"1HY", "rls"=>"org.mozilla:en-US:official", "client"=>"firefox-a", "hl"=>"en", "q"=>"bob+ross"}
+
+
+    url.query_params['q']
+    # => "bob+ross"
+
+Setting the URI query_params:
+
+    url.query_params['q'] = 'Upright Citizens Brigade'
+    url.to_s
+    # => "http://www.google.com/search?btnG=Search&hs=1HY&rls=org.mozilla:en-US:official&client=firefox-a&hl=en&q=Upright%20Citizens%20Brigade"
+
+## Install
+
+    $ sudo gem install uri-query_params
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'uri-query_params'
+    gem.license = 'MIT'
+    gem.summary = %Q{Access the query parameters of a URI, just like $_GET in PHP.}
+    gem.description = %Q{Allows access to the query component of the URI as a Hash.}
+    gem.email = 'postmodern.mod3@gmail.com'
+    gem.homepage = 'http://github.com/postmodern/uri-query_params'
+    gem.authors = ['Postmodern']
+    gem.add_development_dependency 'rspec', '>= 1.3.0'
+    gem.add_development_dependency 'yard', '>= 0.5.3'
+    gem.has_rdoc = 'yard'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+begin
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.libs += ['lib', 'spec']
+    spec.spec_files = FileList['spec/**/*_spec.rb']
+    spec.spec_opts = ['--options', '.specopts']
+  end
+
+  task :spec => :check_dependencies
+  task :default => :spec
+rescue LoadError
+  task :spec do
+    abort "RSpec is not available. In order to run `rake spec`, you must: gem install rspec"
+  end
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/lib/uri/query_params.rb

@@ -0,0 +1,2 @@
+require 'uri/query_params/query_params'
+require 'uri/query_params/extensions'

data/lib/uri/query_params/extensions.rb

@@ -0,0 +1 @@
+require 'uri/query_params/extensions/http'

data/lib/uri/query_params/extensions/http.rb

@@ -0,0 +1,11 @@
+require 'uri/query_params/mixin'
+
+require 'uri/http'
+
+module URI
+  class HTTP < Generic
+
+    include QueryParams::Mixin
+
+  end
+end

data/lib/uri/query_params/mixin.rb

@@ -0,0 +1,107 @@
+require 'uri/query_params/query_params'
+
+require 'cgi'
+
+module URI
+  module QueryParams
+    #
+    # Adds the ability to parse individual parameters from a the query field
+    # of a URI.
+    #
+    module Mixin
+      # Allows setting the query_params.
+      attr_writer :query_params
+
+      #
+      # Sets the query string and updates query_params.
+      #
+      # @param [String] query_str
+      #   The new URI query string to use.
+      #
+      # @return [String]
+      #   The new URI query string.
+      #
+      # @example
+      #   url.query = 'a=1&b=2'
+      #   # => "a=1&b=2"
+      #
+      def query=(query_str)
+        new_query = super(query_str)
+        parse_query_params
+        return new_query
+      end
+
+      #
+      # The query params of the URI.
+      #
+      # @return [Hash{String => String}]
+      #   The query params of the URI.
+      #
+      def query_params
+        parse_query_params unless @query_params
+        return @query_params
+      end
+
+      #
+      # Iterates over every query parameter.
+      #
+      # @yield [name, value]
+      #   The block to pass each query parameter to.
+      #
+      # @yieldparam [String] name
+      #   The name of the query parameter.
+      #
+      # @yieldparam [String] value
+      #   The value of the query parameter.
+      #
+      # @example
+      #   url.each_query_param do |name,value|
+      #     puts "#{name} = #{value}"
+      #   end
+      #
+      def each_query_param(&block)
+        query_params.each(&block)
+      end
+
+      protected
+
+      #
+      # Parses the query parameters from the query data, populating
+      # query_params with the parsed parameters.
+      #
+      def parse_query_params
+        @query_params = QueryParams.parse(@query)
+      end
+
+      private
+
+      def path_query
+        if @query_params
+          str = @path
+
+          unless @query_params.empty?
+            str += '?' + @query_params.to_a.map { |name,value|
+              if value==true
+                "#{name}=active"
+              elsif value
+                if value.kind_of?(Array)
+                  "#{name}=#{CGI.escape(value.join(' '))}"
+                else
+                  "#{name}=#{CGI.escape(value.to_s)}"
+                end
+              else
+                "#{name}="
+              end
+            }.join('&')
+          end
+
+          str
+        else
+          # do not rebuild the path-query, if the query_params have not
+          # been parsed yet
+          super
+        end
+      end
+    end
+  end
+end

data/lib/uri/query_params/query_params.rb

@@ -0,0 +1,33 @@
+require 'uri'
+
+module URI
+  module QueryParams
+    #
+    # Parses a URI query string.
+    #
+    # @param [String] query_string
+    #   The URI query string.
+    #
+    # @return [Hash{String => String}]
+    #   The parsed query parameters.
+    #
+    def QueryParams.parse(query_string)
+      query_params = {}
+
+      if query_string
+        query_string.split('&').each do |param|
+          name, value = param.split('=')
+
+          if value
+            query_params[name] = URI.decode(value)
+          else
+            query_params[name] = ''
+          end
+        end
+      end
+
+      return query_params
+    end
+
+  end
+end

data/spec/extensions/http_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'uri/query_params/extensions/http'
+
+describe URI::HTTP do
+  it "should include QueryParams" do
+    URI::HTTP.should include(URI::QueryParams::Mixin)
+  end
+end

data/spec/query_params_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'uri/query_params'
+
+require 'uri'
+
+describe URI::QueryParams do
+  let(:uri) { URI('http://www.example.com/page.php?x=1&y=one%20two&z') }
+  subject { uri }
+
+  it "should provide #query_params" do
+    should respond_to(:query_params)
+  end
+
+  it "should update #query_params after #query is set" do
+    subject.query = 'u=3'
+    subject.query_params['u'].should == '3'
+  end
+
+  it "should properly escape query param values" do
+    subject.query_params = {'x' => '1&2', 'y' => 'one=two', 'z' => '?'}
+
+    subject.to_s.should == "http://www.example.com/page.php?x=1%262&y=one%3Dtwo&z=%3F"
+  end
+
+  describe "#query_params" do
+    subject { uri.query_params }
+
+    it "should be a Hash" do
+      subject.class.should == Hash
+    end
+
+    it "should contain params" do
+      should_not be_empty
+    end
+
+    it "can contain single-word params" do
+      subject['x'].should == '1'
+    end
+
+    it "can contain multi-word params" do
+      subject['y'].should == 'one two'
+    end
+
+    it "can contain empty params" do
+      subject['z'].should be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+
+gem 'rspec', '>= 1.3.0'
+require 'spec'

data/uri-query_params.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{uri-query_params}
+  s.version = "0.4.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-08-28}
+  s.description = %q{Allows access to the query component of the URI as a Hash.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/uri/query_params.rb",
+     "lib/uri/query_params/extensions.rb",
+     "lib/uri/query_params/extensions/http.rb",
+     "lib/uri/query_params/mixin.rb",
+     "lib/uri/query_params/query_params.rb",
+     "spec/extensions/http_spec.rb",
+     "spec/query_params_spec.rb",
+     "spec/spec_helper.rb",
+     "uri-query_params.gemspec"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/uri-query_params}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Access the query parameters of a URI, just like $_GET in PHP.}
+  s.test_files = [
+    "spec/extensions/http_spec.rb",
+     "spec/query_params_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<yard>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<yard>, [">= 0.5.3"])
+  end
+end
+

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: uri-query_params
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id002
+description: Allows access to the query component of the URI as a Hash.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/uri/query_params.rb
+- lib/uri/query_params/extensions.rb
+- lib/uri/query_params/extensions/http.rb
+- lib/uri/query_params/mixin.rb
+- lib/uri/query_params/query_params.rb
+- spec/extensions/http_spec.rb
+- spec/query_params_spec.rb
+- spec/spec_helper.rb
+- uri-query_params.gemspec
+has_rdoc: yard
+homepage: http://github.com/postmodern/uri-query_params
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Access the query parameters of a URI, just like $_GET in PHP.
+test_files: 
+- spec/extensions/http_spec.rb
+- spec/query_params_spec.rb
+- spec/spec_helper.rb