wouter 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 328983ffb5c818d8e95bfd645fa6a4390bc97efee9d3b195d28cd86421b69315
-  data.tar.gz: '01191a528dab4215b98d03545b863c4cd8c3f0b5be7c0f9f91e97a0bbe300e72'
+  metadata.gz: b29bb82a3cec6a4618458dc39b5efd372e27648b87c33893a4e91b23ab7b016e
+  data.tar.gz: 880aa04c4957d8e616c4ec31887656571283504fc52d8131eaea2285254b5035
 SHA512:
-  metadata.gz: 5e1b52bc209def3b17235c036102d145c1e43ed31deb318288437956307489636573c037342dd064d541c8f59d6343b9d42f363c4e3638e4d36d83e9d2c2c9ea
-  data.tar.gz: a41ead4e722ebccfd50af05e13571cd880f3f580eec097d89cc992f09376bc6352ab96c1560d85589cb9cd20d1c08d4352c12d98f48146199d65ad14d8a11ae4
+  metadata.gz: '0943f0078e3088c8a2b73fffaeae8f9a367a15aab7f9aad3a67482704b7599b5fa61316bd425ce510ecb37565543661500e2390fb1c27c41717337535b6515a4'
+  data.tar.gz: 7e25c151a9458ec94c6dcfe0089ff4d6cf574d8568745c9e8e0368a82d746efd64124e4db8a08156f1a69d76a51d25f7c7d48c0936907d6d5658ed17674ffe0d

data/README.md

@@ -4,24 +4,56 @@ Wouter is a modular web framework built on top of Rack.
 
 Wouter design goals: explicit, modular, readable.
 
-## Basic Usage
+## Quick Example
 
 Wouter allows you to define routes that connect to endpoints.
 
-Here is an example `rackup` compatible file:
+Here is an example `rackup` compatible `config.ru`:
 
 ```ruby
-require 'wouty'
+require 'wouter'
 
-class HelloWorld < Wouty::Endpoint
+class HelloWorld < Wouter::Endpoint
   def respond
     'Hello, world!'
   end
 end
 
-class Routes < Wouty
+class Routes < Wouter
   get '/', HelloWorld
 end
 
 run Routes.build
 ```
+
+Intances of `Wouter::Endpoint` are Rack applications. Instances of `Wouter` are Rack applications. `Wouter` builds routes to dispatch requests to `Wouter::Endpoint` instances.
+
+An example application can be viewed [here](./test/test_app.rb).
+
+## Instances of `Wouter`
+
+When you create an instance of the `Wouter` class, you must call `.build` to create the Rack application.
+
+### Wouter DSL
+
+HTTP routes:
+
+* `get`
+* `put`
+* `post`
+* `delete`
+
+Rack middleware:
+
+* `middleware` - add Rack middleware
+
+## Instaces of `Wouter::Endpoint`
+
+Instances of `Wouter::Endpoint` have access to a few helper methods.
+
+* `req` - an instance of `Rack::Request` for the current HTTP request
+* `res` - an instance of `Rack::Response` for the current HTTP response
+* `params` - convience method for access to `req.params` and any URL route parameters
+* `headers` - convience method for getting and setting HTTP headers
+* `status` - get or set HTTP status code
+* `not_found` - generates a HTTP 404 Not Found `Rack::Response`

data/lib/wouter/route.rb

@@ -42,7 +42,7 @@ class Wouter::Route
       path.scan(/(:\w+)/).flatten.each do |param|
         string_regex = string_regex.gsub(param, '(?<' + param[1..-1] +'>' + REGEX + ')')
       end
-      Regexp.new(string_regex)
+      Regexp.new('^' + string_regex + '$')
     end
   end
 
@@ -54,7 +54,7 @@ class Wouter::Route
       path.scan(/(:\w+)/).flatten.each do |param|
         string_regex = string_regex.gsub(param, REGEX)
       end
-      Regexp.new(string_regex)
+      Regexp.new('^' + string_regex + '$')
     end
   end
 end

data/wouter.gemspec

@@ -3,12 +3,12 @@
 Gem::Specification.new do |s|
   s.name        = 'wouter'
   s.platform    = Gem::Platform::RUBY
-  s.version     = '0.0.6'
-  s.summary     = 'Rack web router.'
-  s.description = 'Wouter is a modular web router built on Rack.'
+  s.version     = '0.0.7'
+  s.summary     = 'Rack web framework.'
+  s.description = 'Wouter is a modular web framework built on top of Rack.'
   s.authors     = ['Robert Peterson']
   s.email       = 'robertpeterson@gmail.com'
-  s.files       = Dir['lib/**/*', 'examples/*'] + ['README.md', 'Gemfile', 'Rakefile', 'wouter.gemspec']
+  s.files       = Dir['lib/**/*'] + ['README.md', 'Gemfile', 'Rakefile', 'wouter.gemspec']
   s.test_files  = s.files.select { |p| p =~ /^test\/.*_test.rb/ }
   s.license     = 'MIT'
   s.homepage    = 'https://github.com/rawburt/wouter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wouter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Robert Peterson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-17 00:00:00.000000000 Z
+date: 2018-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 12.3.1
-description: Wouter is a modular web router built on Rack.
+description: Wouter is a modular web framework built on top of Rack.
 email: robertpeterson@gmail.com
 executables: []
 extensions: []
@@ -159,7 +159,6 @@ files:
 - Gemfile
 - README.md
 - Rakefile
-- examples/hello.rb
 - lib/wouter.rb
 - lib/wouter/endpoint.rb
 - lib/wouter/route.rb
@@ -189,5 +188,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Rack web router.
+summary: Rack web framework.
 test_files: []

data/examples/hello.rb

@@ -1,15 +0,0 @@
-# Usage: rackup hello.rb
-
-require 'wouter'
-
-class HelloWorld < Wouty::Endpoint
-  def respond
-    'Hello, world!'
-  end
-end
-
-class Routes < Wouty
-  get '/', HelloWorld
-end
-
-run Routes.build