Project

web_router

0.0
No commit activity in last 3 years
No release in over 3 years
Small router based on RACK
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13
>= 0
~> 10.0
~> 3.0

Runtime

~> 2.17
~> 2.0
 Project Readme

Build Status

WebRouter

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/web_router. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'web_router'

And then execute:

$ bundle

Or install it yourself as:

$ gem install web_router

Usage

  • Write controllers with methods. WebRouter controllers responds to json, text, html. You can use simple HTML or ERB-templates. For ERB-templates use erb() method with Symbol path of template.
class TestsController < WebRouter::Controller
  def show
    response(:json, params)
  end

  def test
    response(:text, "Required method #{request.request_method}")
  end
  
  def html_action
    response(:html, '<h1>test</h1>')
  end

  def html_action_with_erb
    @message = params['message']
    response(:html, erb(:'views/index.html.erb'))
 end
end
  • Create new application and configure it with block of routes Available HTTP methods: get, post, put, delete.

You can configure routs using controller`s methods or Rack Applications

WebRouter::Router.new.configure do
  get '/test', ->(env) { [200, {}, ['get test']] }
  post '/test', ->(env) { [200, {}, ['post test']] }
  get '/comments/:name/:other_one', 'tests#show'
  get '/testing', 'tests#test'
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/web_router. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.