URL parsing gem that makes any operation to take only 1 line of code
Ruby
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
Gemfile
LICENSE.txt
README.md
Rakefile
furi.gemspec

README.md

Furi

FOSSA Status

Furi is a Friendly URI parsing library. Furi's philosophy is to make any operation possible in ONE LINE OF CODE.

If there is an operation that takes more than one line of code to do with Furi, this is considered a terrible bug and you should create an issue.

Installation

Add this line to your application's Gemfile:

gem 'furi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install furi

Usage

I'll say it again: any operation should take exacly one line of code! Here are basic:

Utility Methods

Parsing the URI fragments:

Furi.host("http://gusiev.com") # => "gusiev.com"
Furi.port("http://gusiev.com") # => nil
Furi.port!("http://gusiev.com") # => 80

Updating the URI parts:

Furi.update("http://gusiev.com", protocol: '') # => "//gusiev.com"
Furi.update("http://gusiev.com?source=google", query: {email: "a@b.com"}) 
    # => "http://gusiev.com?source=google&email=a@b.com"
Furi.replace("http://gusiev.com?source=google", query: {email: "a@b.com"}) 
    # => "http://gusiev.com?email=a@b.com"

Furi.defaults("http://gusiev.com", subdomain: 'www') # => "http://www.gusiev.com"
Furi.defaults("http://blog.gusiev.com", subdomain: 'www') # => "http://blog.gusiev.com"

Building an URI from initial parts:

Furi.build(protocol: '//', host: 'gusiev.com', path: '/assets/application.js') 
    # => "//gusiev.com/assets/application.js"

Working with Object

uri = Furi.parse("gusiev.com") 
    # => #<Furi::Uri "gusiev.com"> 

uri.port     # => nil
uri.port!    # => 80
uri.path     # => nil
uri.path!    # => '/'
uri.subdomain ||= 'www'
uri.protocol = "//" # protocol abstract URL

Processing Query String

uri = Furi.parse("/?person[first_name]=Bogdan&person[last_name]=Gusiev")

uri.query_string # => "person[first_name]=Bogdan&person[last_name]=Gusiev"
uri.query_tokens # => [person[first_name]=Bogdan, person[last_name]=Gusiev]
uri.query # => {person: {first_name: Bogdan, last_name: 'Gusiev'}}

uri.merge_query(person: {email: 'a@b.com'})
    # => {person: {email: 'a@b.com', first_name: Bogdan, last_name: 'Gusiev'}}

uri.merge_query(person: {email: 'a@b.com'})
    # => {person: {email: 'a@b.com', first_name: Bogdan, last_name: 'Gusiev'}}

Reference

                location                                            resource       
                    |                                                ___|___     
             _______|_______                                        /       \     
            /               \                                      /         \    
           /             authority                             request        \   
          /        __________|_________                           |            \  
         /        /                    \                    ______|______       \
        /    userinfo                hostinfo              /             \       \
       /       __|___                ___|___              /               \       \
      /       /      \              /       \            /                 \       \
     /   username  password       host      port       path               query   anchor
    /      __|___   __|__    ______|______   |  _________|__________     ____|____   |
   /      /      \ /     \  /             \ / \/                    \   /         \ / \
   http://username:zhongguo@www.example.com:80/hello/world/article.html?name=bogdan#info
    \_/                     \_/  \___/  \_/    \__________/\     /  \_/
     |                       |     |     |           |      \___/    |
  protocol             subdomain   | domainzone  directory    |   extension
                                   |     |                 filename  |       
                             domainname  /                     \_____/       
                                    \___/                         |          
                                      |                          file                       
                                    domain                   

Originated from URI.js parsing library. Giving credit...

TODO

  • Improve URI.join algorithm to match the one used in Addressible library
  • Implement filename
  • Encoding/Decoding special characters:
    • path
    • query
    • fragment

Contributing

Contribute in the way you want. Branch names and other bla-bla-bla do not matter.

License

FOSSA Status