https://github.com/ruby/uri

URI is a module providing classes to handle Uniform Resource Identifiers
https://github.com/ruby/uri

ruby

Last synced: about 1 month ago
JSON representation

URI is a module providing classes to handle Uniform Resource Identifiers

• Host: GitHub
• URL: https://github.com/ruby/uri
• Owner: ruby
• License: other
• Created: 2019-08-06T03:31:32.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2025-04-30T01:33:15.000Z (about 2 months ago)
• Last Synced: 2025-04-30T02:34:02.765Z (about 2 months ago)
• Topics: ruby
• Language: Ruby
• Homepage: https://ruby.github.io/uri/
• Size: 785 KB
• Stars: 95
• Watchers: 33
• Forks: 51
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# URI

[![CI](https://github.com/ruby/uri/actions/workflows/test.yml/badge.svg)](https://github.com/ruby/uri/actions/workflows/test.yml)

[![Yard Docs](https://img.shields.io/badge/docs-exist-blue.svg)](https://ruby.github.io/uri/)

URI is a module providing classes to handle Uniform Resource Identifiers [RFC3986](http://tools.ietf.org/html/rfc3986).

## Features

* Uniform way of handling URIs.

* Flexibility to introduce custom URI schemes.

* Flexibility to have an alternate URI::Parser (or just different patterns and regexp's).

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'uri'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install uri

## Usage

```ruby

require 'uri'

uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")

#=> #

uri.scheme    #=> "http"

uri.host      #=> "foo.com"

uri.path      #=> "/posts"

uri.query     #=> "id=30&limit=5"

uri.fragment  #=> "time=1305298413"

uri.to_s      #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/uri.