Project

furi

0.01
Low commit activity in last 3 years
A long-lived project that still receives updates
The philosophy of this gem is to make any URI modification or parsing operation to take only one line of code and never more
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies
 Project Readme

Furi

Gem Version Build Status 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 Addressable 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