Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fnando/sinatra-subdomain

Separate routes for subdomains in Sinatra apps
https://github.com/fnando/sinatra-subdomain

Last synced: 13 days ago
JSON representation

Separate routes for subdomains in Sinatra apps

Host: GitHub
URL: https://github.com/fnando/sinatra-subdomain
Owner: fnando
Created: 2010-05-09T06:27:38.000Z (over 14 years ago)
Default Branch: main
Last Pushed: 2020-09-24T21:58:11.000Z (about 4 years ago)
Last Synced: 2024-04-14T09:58:23.440Z (7 months ago)
Language: Ruby
Homepage:
Size: 36.1 KB
Stars: 98
Watchers: 4
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

# Sinatra Subdomain

[![Travis-CI](https://travis-ci.org/fnando/sinatra-subdomain.svg)](https://travis-ci.org/fnando/sinatra-subdomain)
[![Code Climate](https://codeclimate.com/github/fnando/sinatra-subdomain/badges/gpa.svg)](https://codeclimate.com/github/fnando/sinatra-subdomain)
[![Gem](https://img.shields.io/gem/v/sinatra-subdomain.svg)](https://rubygems.org/gems/sinatra-subdomain)
[![Gem](https://img.shields.io/gem/dt/sinatra-subdomain.svg)](https://rubygems.org/gems/sinatra-subdomain)

## Installation

```
gem install sinatra-subdomain
```

## Usage

```ruby
require "sinatra"
require "sinatra/subdomain"

# Specify which subdomain you want
subdomain :foo do
get "/" do
"render page for FOO"
end
end

# If any subdomain is set
subdomain do
get "/" do
"render page for #{subdomain} subdomain"
end
end
```

If you're not building a classic app, make sure to register Sinatra::Subdomain
yourself:

```ruby
require "sinatra"
require "sinatra/subdomain"

# Specify which subdomain you want
class MyApp < Sinatra::Base
register Sinatra::Subdomain

subdomain :foo do
get "/" do
"render page for FOO"
end
end

# If any subdomain is set
subdomain do
get "/" do
"render page for #{subdomain} subdomain"
end
end
end
```

You can also pass an array, regular expressions to match subdomains, or a proc:

```ruby
class MyApp < Sinatra::Base
register Sinatra::Subdomain

subdomain [:foo, :bar, :zaz] do
get "/" do
"render page for #{subdomain}"
end
end

# Matches www, www1, www2, etc.
subdomain /\Awww\d*\z/ do
get "/" do
"render page for #{subdomain} subdomain"
end
end

app_matcher = lambda do |subdomain|
App.where(subdomain: actual_subdomain).exist?
end

subdomain(app_matcher) do
get "/" do
"render page for #{subdomain} app"
end
end
end
```

By default, sinatra-subdomain will consider 1 TLD as in example.com.
You can specify your TLD size for domains like example.com.br or
example.co.uk.

```ruby
require "sinatra"
require "sinatra/subdomain"

set :tld_size, 2
```

# License

(The 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.