2013-03-04 08:17:30 -05:00
|
|
|
|
# Sinatra
|
|
|
|
|
|
|
|
|
|
*Atenção: Este documento é apenas uma tradução da versão em inglês e
|
|
|
|
|
pode estar desatualizado.*
|
|
|
|
|
|
|
|
|
|
Sinatra é uma
|
2016-01-21 11:42:19 -05:00
|
|
|
|
[DSL](https://pt.wikipedia.org/wiki/Linguagem_de_domínio_específico) para
|
2013-03-04 08:17:30 -05:00
|
|
|
|
criar rapidamente aplicações web em Ruby com o mínimo de esforço:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# minhaapp.rb
|
|
|
|
|
require 'rubygems'
|
|
|
|
|
require 'sinatra'
|
|
|
|
|
get '/' do
|
|
|
|
|
'Olá Mundo!'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Instale a gem e execute com:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```shell
|
2013-03-04 08:17:30 -05:00
|
|
|
|
sudo gem install sinatra
|
|
|
|
|
ruby minhaapp.rb
|
|
|
|
|
```
|
|
|
|
|
|
2016-01-21 20:09:12 -05:00
|
|
|
|
Aceda em: [http://localhost:4567](http://localhost:4567)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
|
|
|
|
|
## Rotas
|
|
|
|
|
|
|
|
|
|
No Sinatra, uma rota é um metodo HTTP associado a uma URL correspondente
|
|
|
|
|
padrão. Cada rota é associada a um bloco:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/' do
|
|
|
|
|
.. mostrar algo ..
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
post '/' do
|
|
|
|
|
.. criar algo ..
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
put '/' do
|
|
|
|
|
.. atualizar algo ..
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
delete '/' do
|
|
|
|
|
.. apagar algo ..
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Rotas são encontradas na ordem em que são definidas. A primeira rota que
|
|
|
|
|
é encontrada invoca o pedido.
|
|
|
|
|
|
|
|
|
|
Padrões de rota podem incluir parâmetros nomeados, acessíveis através da
|
|
|
|
|
hash `params`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/ola/:nome' do
|
|
|
|
|
# corresponde a "GET /ola/foo" e "GET /ola/bar"
|
2014-08-04 14:16:49 -04:00
|
|
|
|
# params['nome'] é 'foo' ou 'bar'
|
|
|
|
|
"Olá #{params['nome']}!"
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Pode também aceder a parâmetros nomeados através do bloco de parâmetros:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/ola/:nome' do |n|
|
|
|
|
|
"Olá #{n}!"
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Padrões de rota podem também incluir parâmetros splat (asteriscos),
|
2014-08-04 14:16:49 -04:00
|
|
|
|
acessíveis através do array `params['splat']`.
|
2013-03-04 08:17:30 -05:00
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/diga/*/ao/*' do
|
|
|
|
|
# corresponde a /diga/ola/ao/mundo
|
2014-08-04 14:16:49 -04:00
|
|
|
|
params['splat'] # => ["ola", "mundo"]
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/download/*.*' do
|
|
|
|
|
# corresponde a /download/pasta/do/arquivo.xml
|
2014-08-04 14:16:49 -04:00
|
|
|
|
params['splat'] # => ["pasta/do/arquivo", "xml"]
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Rotas correspondem-se com expressões regulares:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2015-02-05 16:15:53 -05:00
|
|
|
|
get /\A\/ola\/([\w]+)\z/ do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
"Olá, #{params['captures'].first}!"
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Ou com um bloco de parâmetro:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get %r{/ola/([\w]+)} do |c|
|
|
|
|
|
"Olá, #{c}!"
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Rotas podem incluir uma variedade de condições correspondentes, por
|
|
|
|
|
exemplo, o agente usuário:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/foo', :agent => /Songbird (\d\.\d)[\d\/]*?/ do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
"Você está a utilizar a versão #{params['agent'][0]} do Songbird."
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/foo' do
|
|
|
|
|
# Corresponde a um navegador não Songbird
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Arquivos estáticos
|
|
|
|
|
|
|
|
|
|
Arquivos estáticos são disponibilizados a partir do directório
|
|
|
|
|
`./public`. Você pode especificar um local diferente através da opção
|
|
|
|
|
`:public_folder`
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
set :public_folder, File.dirname(__FILE__) + '/estatico'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Note que o nome do directório público não é incluido no URL. Um arquivo
|
|
|
|
|
`./public/css/style.css` é disponibilizado como
|
|
|
|
|
`http://example.com/css/style.css`.
|
|
|
|
|
|
|
|
|
|
## Views / Templates
|
|
|
|
|
|
|
|
|
|
Templates presumem-se estar localizados sob o directório `./views`. Para
|
|
|
|
|
utilizar um directório de views diferente:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
set :views, File.dirname(__FILE__) + '/modelo'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Uma coisa importante a ser lembrada é que você sempre tem as referências
|
|
|
|
|
dos templates como símbolos, mesmo se eles estiverem num sub-directório
|
|
|
|
|
(nesse caso utilize `:'subdir/template'`). Métodos de renderização irão
|
|
|
|
|
processar qualquer string passada directamente para elas.
|
|
|
|
|
|
|
|
|
|
### Haml Templates
|
|
|
|
|
|
|
|
|
|
A gem/biblioteca haml é necessária para renderizar templates HAML:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'haml' na aplicação.
|
|
|
|
|
require 'haml'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
haml :index
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/index.haml`.
|
|
|
|
|
|
|
|
|
|
[Opções
|
2016-01-21 11:55:29 -05:00
|
|
|
|
Haml](http://haml.info/docs/yardoc/file.REFERENCE.html#options)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
podem ser definidas globalmente através das configurações do sinatra,
|
|
|
|
|
veja [Opções e
|
|
|
|
|
Configurações](http://www.sinatrarb.com/configuration.html), e substitua
|
|
|
|
|
em uma requisição individual.
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
set :haml, {:format => :html5 } # o formato padrão do Haml é :xhtml
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
haml :index, :haml_options => {:format => :html4 } # substituido
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Erb Templates
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'erb' na aplicação.
|
|
|
|
|
require 'erb'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
erb :index
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/index.erb`
|
|
|
|
|
|
|
|
|
|
### Erubis
|
|
|
|
|
|
|
|
|
|
A gem/biblioteca erubis é necessária para renderizar templates erubis:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'erubis' na aplicação.
|
|
|
|
|
require 'erubis'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
erubis :index
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/index.erubis`
|
|
|
|
|
|
|
|
|
|
### Builder Templates
|
|
|
|
|
|
|
|
|
|
A gem/biblioteca builder é necessária para renderizar templates builder:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'builder' na aplicação.
|
|
|
|
|
require 'builder'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
content_type 'application/xml', :charset => 'utf-8'
|
|
|
|
|
builder :index
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/index.builder`.
|
|
|
|
|
|
|
|
|
|
### Sass Templates
|
|
|
|
|
|
|
|
|
|
A gem/biblioteca sass é necessária para renderizar templates sass:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'haml' ou 'sass' na aplicação.
|
|
|
|
|
require 'sass'
|
|
|
|
|
|
|
|
|
|
get '/stylesheet.css' do
|
|
|
|
|
content_type 'text/css', :charset => 'utf-8'
|
|
|
|
|
sass :stylesheet
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/stylesheet.sass`.
|
|
|
|
|
|
|
|
|
|
[Opções
|
2016-01-21 11:42:19 -05:00
|
|
|
|
Sass](http://sass-lang.com/documentation/file.SASS_REFERENCE.html#options)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
podem ser definidas globalmente através das configurações do sinatra,
|
|
|
|
|
veja [Opções e
|
|
|
|
|
Configurações](http://www.sinatrarb.com/configuration.html), e substitua
|
|
|
|
|
em uma requisição individual.
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
set :sass, {:style => :compact } # o estilo padrão do Sass é :nested
|
|
|
|
|
|
|
|
|
|
get '/stylesheet.css' do
|
|
|
|
|
content_type 'text/css', :charset => 'utf-8'
|
|
|
|
|
sass :stylesheet, :style => :expanded # substituido
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Less Templates
|
|
|
|
|
|
|
|
|
|
A gem/biblioteca less é necessária para renderizar templates Less:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
# É necessário requerir 'less' na aplicação.
|
|
|
|
|
require 'less'
|
|
|
|
|
|
|
|
|
|
get '/stylesheet.css' do
|
|
|
|
|
content_type 'text/css', :charset => 'utf-8'
|
|
|
|
|
less :stylesheet
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza `./views/stylesheet.less`.
|
|
|
|
|
|
|
|
|
|
### Templates Inline
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/' do
|
|
|
|
|
haml '%div.title Olá Mundo'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Renderiza a string, em uma linha, no template.
|
|
|
|
|
|
|
|
|
|
### Acedendo a Variáveis nos Templates
|
|
|
|
|
|
|
|
|
|
Templates são avaliados dentro do mesmo contexto que os manipuladores de
|
|
|
|
|
rota. Variáveis de instância definidas em rotas manipuladas são
|
|
|
|
|
directamente acedidas por templates:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/:id' do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
@foo = Foo.find(params['id'])
|
2013-03-04 08:17:30 -05:00
|
|
|
|
haml '%h1= @foo.nome'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Ou, especifique um hash explícito para variáveis locais:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/:id' do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
foo = Foo.find(params['id'])
|
2013-03-04 08:17:30 -05:00
|
|
|
|
haml '%h1= foo.nome', :locals => { :foo => foo }
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Isso é tipicamente utilizado quando renderizamos templates parciais
|
|
|
|
|
(partials) dentro de outros templates.
|
|
|
|
|
|
|
|
|
|
### Templates Inline
|
|
|
|
|
|
|
|
|
|
Templates podem ser definidos no final do arquivo fonte(.rb):
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
require 'rubygems'
|
|
|
|
|
require 'sinatra'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
haml :index
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
__END__
|
|
|
|
|
|
|
|
|
|
@@ layout
|
|
|
|
|
%html
|
|
|
|
|
= yield
|
|
|
|
|
|
|
|
|
|
@@ index
|
|
|
|
|
%div.title Olá Mundo!!!!!
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
NOTA: Templates inline definidos no arquivo fonte são automaticamente
|
|
|
|
|
carregados pelo sinatra. Digite \`enable :inline\_templates\` se tem
|
|
|
|
|
templates inline no outro arquivo fonte.
|
|
|
|
|
|
|
|
|
|
### Templates nomeados
|
|
|
|
|
|
|
|
|
|
Templates também podem ser definidos utilizando o método top-level
|
|
|
|
|
`template`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
template :layout do
|
|
|
|
|
"%html\n =yield\n"
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
template :index do
|
|
|
|
|
'%div.title Olá Mundo!'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
haml :index
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Se existir um template com nome “layout”, ele será utilizado sempre que
|
|
|
|
|
um template for renderizado. Pode desactivar layouts usando
|
|
|
|
|
`:layout => false`.
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/' do
|
|
|
|
|
haml :index, :layout => !request.xhr?
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Helpers
|
|
|
|
|
|
|
|
|
|
Use o método de alto nível `helpers` para definir métodos auxiliares
|
|
|
|
|
para utilizar em manipuladores de rotas e modelos:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
helpers do
|
|
|
|
|
def bar(nome)
|
|
|
|
|
"#{nome}bar"
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/:nome' do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
bar(params['nome'])
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Filtros
|
|
|
|
|
|
|
|
|
|
Filtros Before são avaliados antes de cada requisição dentro do contexto
|
|
|
|
|
da requisição e podem modificar a requisição e a reposta. Variáveis de
|
|
|
|
|
instância definidas nos filtros são acedidas através de rotas e
|
|
|
|
|
templates:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
before do
|
|
|
|
|
@nota = 'Olá!'
|
|
|
|
|
request.path_info = '/foo/bar/baz'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/foo/*' do
|
|
|
|
|
@nota #=> 'Olá!'
|
2014-08-04 14:16:49 -04:00
|
|
|
|
params['splat'] #=> 'bar/baz'
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Filtros After são avaliados após cada requisição dentro do contexto da
|
|
|
|
|
requisição e também podem modificar o pedido e a resposta. Variáveis de
|
|
|
|
|
instância definidas nos filtros before e rotas são acedidas através dos
|
|
|
|
|
filtros after:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
after do
|
|
|
|
|
puts response.status
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Filtros opcionalmente têm um padrão, fazendo com que sejam avaliados
|
|
|
|
|
somente se o caminho do pedido coincidir com esse padrão:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
before '/protected/*' do
|
|
|
|
|
autenticar!
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
after '/create/:slug' do |slug|
|
|
|
|
|
session[:last_slug] = slug
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Halting
|
|
|
|
|
|
|
|
|
|
Para parar imediatamente uma requisição dentro de um filtro ou rota
|
|
|
|
|
utilize:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
halt
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Pode também especificar o status ao parar…
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
halt 410
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Ou com um corpo de texto…
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
halt 'isto será o corpo de texto'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Ou também…
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
halt 401, 'vamos embora!'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Com cabeçalhos…
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
halt 402, {'Content-Type' => 'text/plain'}, 'revanche'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Passing
|
|
|
|
|
|
|
|
|
|
Dentro de uma rota, pode passar para a próxima rota correspondente
|
|
|
|
|
usando `pass`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/adivinhar/:quem' do
|
2014-08-04 14:16:49 -04:00
|
|
|
|
pass unless params['quem'] == 'Frank'
|
2013-03-04 08:17:30 -05:00
|
|
|
|
'Apanhaste-me!'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/adivinhar/*' do
|
|
|
|
|
'Falhaste!'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
O bloqueio da rota é imediatamente encerrado e o controle continua com a
|
|
|
|
|
próxima rota de parâmetro. Se o parâmetro da rota não for encontrado, um
|
|
|
|
|
404 é retornado.
|
|
|
|
|
|
|
|
|
|
## Configuração
|
|
|
|
|
|
|
|
|
|
Correndo uma vez, na inicialização, em qualquer ambiente:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
configure do
|
|
|
|
|
...
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Correndo somente quando o ambiente (`RACK_ENV` environment variável) é
|
|
|
|
|
definido para `:production`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
configure :production do
|
|
|
|
|
...
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Correndo quando o ambiente é definido para `:production` ou `:test`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
configure :production, :test do
|
|
|
|
|
...
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Lidar com Erros
|
|
|
|
|
|
|
|
|
|
Lida-se com erros no mesmo contexto das rotas e filtros before, o que
|
|
|
|
|
signifca que `haml`, `erb`, etc, estão disponíveis.
|
|
|
|
|
|
|
|
|
|
### Não Encontrado
|
|
|
|
|
|
|
|
|
|
Quando um `Sinatra::NotFound` exception é levantado, ou o código de
|
|
|
|
|
status da reposta é 404, o manipulador `not_found` é invocado:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
not_found do
|
|
|
|
|
'Isto está longe de ser encontrado'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Erro
|
|
|
|
|
|
|
|
|
|
O manipulador `error` é invocado sempre que uma exceção é lançada a
|
|
|
|
|
partir de um bloco de rota ou um filtro. O objecto da exceção pode ser
|
|
|
|
|
obtido a partir da variável Rack `sinatra.error`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
error do
|
2014-08-14 04:48:02 -04:00
|
|
|
|
'Peço desculpa, houve um erro desagradável - ' + env['sinatra.error'].message
|
2013-03-04 08:17:30 -05:00
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Erros personalizados:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
error MeuErroPersonalizado do
|
|
|
|
|
'O que aconteceu foi...' + env['sinatra.error'].message
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Então, se isso acontecer:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
get '/' do
|
|
|
|
|
raise MeuErroPersonalizado, 'alguma coisa desagradável'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
O resultado será:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
O que aconteceu foi...alguma coisa desagradável
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Alternativamente, pode definir um manipulador de erro para um código de
|
|
|
|
|
status:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
error 403 do
|
|
|
|
|
'Accesso negado'
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
get '/secreto' do
|
|
|
|
|
403
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Ou um range (alcance):
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
error 400..510 do
|
|
|
|
|
'Boom'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
O Sinatra define os manipuladores especiais `not_found` e `error` quando
|
|
|
|
|
corre no ambiente de desenvolvimento.
|
|
|
|
|
|
|
|
|
|
## Mime Types
|
|
|
|
|
|
|
|
|
|
Quando utilizamos `send_file` ou arquivos estáticos pode ter mime types
|
|
|
|
|
Sinatra não entendidos. Use `mime_type` para os registar por extensão de
|
|
|
|
|
arquivos:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
mime_type :foo, 'text/foo'
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Pode também utilizar isto com o helper `content_type`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
content_type :foo
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Middleware Rack
|
|
|
|
|
|
2014-09-19 10:24:03 -04:00
|
|
|
|
O Sinatra corre no [Rack](http://rack.github.io/), uma interface
|
2013-03-04 08:17:30 -05:00
|
|
|
|
padrão mínima para frameworks web em Ruby. Uma das capacidades mais
|
|
|
|
|
interessantes do Rack, para desenvolver aplicações, é o suporte de
|
|
|
|
|
“middleware” – componentes que residem entre o servidor e a aplicação,
|
|
|
|
|
monitorizando e/ou manipulando o pedido/resposta (request/response) HTTP
|
|
|
|
|
para providenciar varios tipos de funcionalidades comuns.
|
|
|
|
|
|
|
|
|
|
O Sinatra torna a construção de pipelines do middleware Rack fácil a um
|
|
|
|
|
nível superior utilizando o método `use`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
require 'sinatra'
|
|
|
|
|
require 'meu_middleware_personalizado'
|
|
|
|
|
|
|
|
|
|
use Rack::Lint
|
|
|
|
|
use MeuMiddlewarePersonalizado
|
|
|
|
|
|
|
|
|
|
get '/ola' do
|
|
|
|
|
'Olá mundo'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
A semântica de `use` é idêntica aquela definida para a DSL
|
2016-01-21 11:42:19 -05:00
|
|
|
|
[Rack::Builder](http://www.rubydoc.info/github/rack/rack/master/Rack/Builder)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
(mais frequentemente utilizada para arquivos rackup). Por exemplo, o
|
|
|
|
|
método `use` aceita múltiplos argumentos/variáveis, bem como blocos:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
use Rack::Auth::Basic do |utilizador, senha|
|
|
|
|
|
utilizador == 'admin' && senha == 'secreto'
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
O Rack é distribuido com uma variedade de middleware padrões para logs,
|
|
|
|
|
debugs, rotas de URL, autenticação, e manipuladores de sessão.Sinatra
|
|
|
|
|
utiliza muitos desses componentes automaticamente dependendo da
|
|
|
|
|
configuração, por isso, tipicamente nao é necessário utilizar `use`
|
|
|
|
|
explicitamente.
|
|
|
|
|
|
|
|
|
|
## Testando
|
|
|
|
|
|
|
|
|
|
Testes no Sinatra podem ser escritos utilizando qualquer biblioteca ou
|
|
|
|
|
framework de teste baseados no Rack.
|
|
|
|
|
[Rack::Test](http://gitrdoc.com/brynary/rack-test) é recomendado:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
require 'minha_aplicacao_sinatra'
|
|
|
|
|
require 'rack/test'
|
|
|
|
|
|
2015-01-10 14:30:47 -05:00
|
|
|
|
class MinhaAplicacaoTeste < Minitest::Test
|
2013-03-04 08:17:30 -05:00
|
|
|
|
include Rack::Test::Methods
|
|
|
|
|
|
|
|
|
|
def app
|
|
|
|
|
Sinatra::Application
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def meu_test_default
|
|
|
|
|
get '/'
|
|
|
|
|
assert_equal 'Ola Mundo!', last_response.body
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def teste_com_parametros
|
|
|
|
|
get '/atender', :name => 'Frank'
|
|
|
|
|
assert_equal 'Olá Frank!', last_response.bodymeet
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def test_com_ambiente_rack
|
|
|
|
|
get '/', {}, 'HTTP_USER_AGENT' => 'Songbird'
|
|
|
|
|
assert_equal "Você está utilizando o Songbird!", last_response.body
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
NOTA: Os módulos de classe embutidos `Sinatra::Test` e
|
|
|
|
|
`Sinatra::TestHarness` são depreciados na versão 0.9.2.
|
|
|
|
|
|
|
|
|
|
## Sinatra::Base - Middleware, Bibliotecas e aplicativos modulares
|
|
|
|
|
|
|
|
|
|
Definir sua aplicação a um nível superior de trabalho funciona bem para
|
|
|
|
|
micro aplicativos, mas tem consideráveis incovenientes na construção de
|
|
|
|
|
componentes reutilizáveis como um middleware Rack, metal Rails,
|
|
|
|
|
bibliotecas simples como um componente de servidor, ou mesmo extensões
|
|
|
|
|
Sinatra. A DSL de nível superior polui o espaço do objeto e assume um
|
|
|
|
|
estilo de configuração de micro aplicativos (exemplo: um simples arquivo
|
|
|
|
|
de aplicação, directórios `./public` e `./views`, logs, página de detalhes
|
|
|
|
|
de excepção, etc.). É onde o Sinatra::Base entra em jogo:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
require 'sinatra/base'
|
|
|
|
|
|
|
|
|
|
class MinhaApp < Sinatra::Base
|
|
|
|
|
set :sessions, true
|
|
|
|
|
set :foo, 'bar'
|
|
|
|
|
|
|
|
|
|
get '/' do
|
|
|
|
|
'Olá mundo!'
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
A classe MinhaApp é um componente Rack independente que pode utilizar
|
|
|
|
|
como um middleware Rack, uma aplicação Rack, ou metal Rails. Pode
|
|
|
|
|
utilizar ou executar esta classe com um arquivo rackup `config.ru`;
|
|
|
|
|
ou, controlar um componente de servidor fornecendo como biblioteca:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
MinhaApp.run! :host => 'localhost', :port => 9090
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Os métodos disponíveis para subclasses `Sinatra::Base` são exatamente como
|
|
|
|
|
aqueles disponíveis via a DSL de nível superior. Aplicações de nível
|
|
|
|
|
mais alto podem ser convertidas para componentes `Sinatra::Base` com duas
|
|
|
|
|
modificações:
|
|
|
|
|
|
|
|
|
|
- Seu arquivo deve requerer `sinatra/base` ao invés de `sinatra`;
|
|
|
|
|
outra coisa, todos os métodos DSL do Sinatra são importados para o
|
|
|
|
|
espaço principal.
|
|
|
|
|
|
|
|
|
|
- Coloque as rotas da sua aplicação, manipuladores de erro, filtros e
|
|
|
|
|
opções na subclasse de um `Sinatra::Base`.
|
|
|
|
|
|
|
|
|
|
`Sinatra::Base` é um quadro branco. Muitas opções são desactivadas por
|
|
|
|
|
padrão, incluindo o servidor embutido. Veja [Opções e
|
2016-01-21 11:42:19 -05:00
|
|
|
|
Configurações](http://www.sinatrarb.com/configuration.html) para
|
2013-03-04 08:17:30 -05:00
|
|
|
|
detalhes de opções disponíveis e seus comportamentos.
|
|
|
|
|
|
|
|
|
|
SIDEBAR: A DSL de alto nível do Sinatra é implementada utilizando um simples
|
|
|
|
|
sistema de delegação. A classe `Sinatra::Application` – uma subclasse especial
|
|
|
|
|
da `Sinatra::Base` – recebe todos os `:get`, `:put`, `:post`, `:delete`,
|
|
|
|
|
`:before`, `:error`, `:not_found`, `:configure`, e `:set` messages enviados
|
|
|
|
|
para o alto nível. Dê você mesmo uma vista de olhos ao código: aqui está o
|
|
|
|
|
[Sinatra::Delegator
|
|
|
|
|
mixin](http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/base.rb#L1128)
|
|
|
|
|
sendo [incluido dentro de um espaço
|
|
|
|
|
principal](http://github.com/sinatra/sinatra/blob/ceac46f0bc129a6e994a06100aa854f606fe5992/lib/sinatra/main.rb#L28)
|
|
|
|
|
|
|
|
|
|
## Linha de Comandos
|
|
|
|
|
|
|
|
|
|
As aplicações Sinatra podem ser executadas directamente:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```shell
|
2013-03-04 08:17:30 -05:00
|
|
|
|
ruby minhaapp.rb [-h] [-x] [-e AMBIENTE] [-p PORTA] [-o HOST] [-s SERVIDOR]
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
As opções são:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
-h # ajuda
|
|
|
|
|
-p # define a porta (padrão é 4567)
|
|
|
|
|
-o # define o host (padrão é 0.0.0.0)
|
|
|
|
|
-e # define o ambiente (padrão é development)
|
|
|
|
|
-s # especifica o servidor/manipulador rack (padrão é thin)
|
|
|
|
|
-x # activa o bloqueio (padrão é desligado)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## A última versão
|
|
|
|
|
|
|
|
|
|
Se gostaria de utilizar o código da última versão do Sinatra, crie um
|
|
|
|
|
clone local e execute sua aplicação com o directório `sinatra/lib` no
|
|
|
|
|
`LOAD_PATH`:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```shell
|
2013-03-04 08:17:30 -05:00
|
|
|
|
cd minhaapp
|
|
|
|
|
git clone git://github.com/sinatra/sinatra.git
|
|
|
|
|
ruby -I sinatra/lib minhaapp.rb
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Alternativamente, pode adicionar o directório do `sinatra/lib` no
|
|
|
|
|
`LOAD_PATH` do seu aplicativo:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```ruby
|
2013-03-04 08:17:30 -05:00
|
|
|
|
$LOAD_PATH.unshift File.dirname(__FILE__) + '/sinatra/lib'
|
|
|
|
|
require 'rubygems'
|
|
|
|
|
require 'sinatra'
|
|
|
|
|
|
|
|
|
|
get '/sobre' do
|
|
|
|
|
"Estou correndo a versão" + Sinatra::VERSION
|
|
|
|
|
end
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Para actualizar o código do Sinatra no futuro:
|
|
|
|
|
|
2015-09-20 12:50:57 -04:00
|
|
|
|
```shell
|
2013-03-04 08:17:30 -05:00
|
|
|
|
cd meuprojeto/sinatra
|
|
|
|
|
git pull
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Mais
|
|
|
|
|
|
|
|
|
|
- [Website do Projeto](http://www.sinatrarb.com/) - Documentação
|
|
|
|
|
adicional, novidades e links para outros recursos.
|
|
|
|
|
|
|
|
|
|
- [Contribuir](http://www.sinatrarb.com/contributing) - Encontrou um
|
|
|
|
|
bug? Precisa de ajuda? Tem um patch?
|
|
|
|
|
|
2016-01-21 11:42:19 -05:00
|
|
|
|
- [Acompanhar Questões](https://github.com/sinatra/sinatra/issues)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
|
2016-01-21 11:42:19 -05:00
|
|
|
|
- [Twitter](https://twitter.com/sinatra)
|
2013-03-04 08:17:30 -05:00
|
|
|
|
|
|
|
|
|
- [Lista de Email](http://groups.google.com/group/sinatrarb/topics)
|
|
|
|
|
|
|
|
|
|
- [IRC: \#sinatra](irc://chat.freenode.net/#sinatra) em
|
|
|
|
|
[freenode.net](http://freenode.net)
|