normalize_url 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8028e7b8023b9a5bd1eedb26cc0a3f827573b0b5
+  data.tar.gz: abfdc72f52b71bcdb14d654f6f5c42fd9df3e682
+SHA512:
+  metadata.gz: 8c9d689c0e501cdc118c026842eb40e6f3ff5a546e61e0cbb333f628c6f385af20fa5eba3b0088026ed21d3f7692b3e60e5fa6b0195f798294ddfad4f049da02
+  data.tar.gz: 43cfa103f3f30a8c5c8b5ea2f11ba2677950c2a19b7d9f5b10a3f883117a6830cfc2ec12352e81a5e4d955e055cc95af07d383438995ae05b747405cede52deb

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pavel Pravosud
+
+MIT License
+
+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,83 @@
+# NormalizeUrl
+
+This gem can normalize HTTP(S) URLs by applying a certain set of
+transformations. After normalization, two different URLs that point to the same
+resource should look exactly the same.
+
+For example:
+
+- `http://example.com/products`
+- `http://example.com/products/`
+- `http://example.com/foo/../products`
+- `http://example.com/products#comments-section`
+- `http://example.com//products/`
+- `http://example.com/products?`
+
+will all become `http://example.com/products` after normalization.
+
+Some of the transformations are potentially dangerous, since not all webservers
+comform to standards and some of them are just plain weird. So there is no
+gurantee that the URL will still work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "normalize_url"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install normalize_url
+
+## Usage
+
+```ruby
+NormalizeUrl.process("http://example.com/products/?foo=bar&baz") # => "http://example.com/products?baz&foo=bar"
+```
+
+Each tranformation could be skipped by demand. All you need is to pass it as a
+optional value to `normalize` method:
+
+```ruby
+NormalizeUrl.normalize("http://example.com/foo/", remove_trailing_slash: false) # => "http://example.com/foo/"
+```
+
+## Transformations
+
+- Remove trailing slash. Option `:remove_trailing_slash`
+
+    Example:
+
+    `http://example.com/products/` -> `http://example.com/products`
+
+- Remove repeating slashes. Option `:remove_repeating_slashes`
+
+    Example:
+
+    `http://example.com/foo//bar` -> `http://example.com/foo/bar`
+
+- Remove hash fragment. Option `:remove_hash`.
+
+    Example:
+
+    `http://example.com/foo#bar` -> `http://example.com/foo`
+
+- Sort query string. Option `:sort_query`.
+
+    Example:
+
+    `http://example.com/products/?foo=bar&baz` -> `http://example.com/products?baz&foo=bar`
+
+## Contributing
+
+1. Fork it (https://github.com/rwz/normalize_url/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/normalize_url.rb

@@ -0,0 +1,10 @@
+module NormalizeUrl
+  autoload :VERSION,    "normalize_url/version"
+  autoload :Normalizer, "normalize_url/normalizer"
+
+  extend self
+
+  def process(url, **options)
+    Normalizer.new(url.to_s, options).normalize
+  end
+end

data/lib/normalize_url/normalizer.rb

@@ -0,0 +1,46 @@
+require "addressable/uri"
+
+module NormalizeUrl
+  class Normalizer
+    attr_reader :uri, :options
+
+    def initialize(original_uri, options={})
+      @uri = Addressable::URI.parse(original_uri).normalize
+      @options = options
+    end
+
+    def normalize
+      process :remove_trailing_slash
+      process :remove_repeating_slashes
+      process :remove_hash
+      process :sort_query
+      uri.to_s
+    end
+
+    private
+
+    def process(step)
+      send "process_#{step}" if process?(step)
+    end
+
+    def process?(step)
+      @options.fetch(step, true)
+    end
+
+    def process_remove_trailing_slash
+      uri.path = uri.path.chomp(?/) unless uri.path == ?/
+    end
+
+    def process_sort_query
+      uri.query = uri.query.split(?&).sort.join(?&) if uri.query
+    end
+
+    def process_remove_hash
+      uri.fragment = nil
+    end
+
+    def process_remove_repeating_slashes
+      uri.path = uri.path.squeeze(?/) if uri.host
+    end
+  end
+end

data/lib/normalize_url/version.rb

@@ -0,0 +1,3 @@
+module NormalizeUrl
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: normalize_url
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Pravosud
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: 
+email:
+- pavel@pravosud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/normalize_url.rb
+- lib/normalize_url/normalizer.rb
+- lib/normalize_url/version.rb
+homepage: https://github.com/rwz/normalize_url
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Normalizing URLs like a Boss
+test_files: []