helmet 0.1.3 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a879ae7efe16ee0b0697501f4075fea37abe07b1
+  data.tar.gz: 448ee6bb790963c0cd5b5b2faabc7ad1fa585b19
+SHA512:
+  metadata.gz: 15ec47ac0967d6492915529c865507451bb62e1236ec10fdf7c7c5a89af1d0e351bf0e75bfe190a4ebda7409de922a19a7b9961a3c2b536adb6dec979774c9b4
+  data.tar.gz: 495a7c1a4006bc21d140f226744983b68d09ea7c021839521c16a20b17714870a50047b275840d93eaaf99427a9172571ff96b142a6abd1828261988f1538d14

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/HISTORY.md

@@ -0,0 +1,7 @@
+# HISTORY
+
+## v0.0.2
+
+- Replace router by http_router gem.
+- Include LICENSE file 
+

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Thiago Lewin.
+
+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 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.

data/README.md

@@ -0,0 +1,46 @@
+Helmet
+======
+
+Simple web framework for Goliath web server.
+
+Helmet is **very** inspired on Sinatra framework  (https://github.com/bmizerany/sinatra) without losing the Goliath API design.
+The framework tries some functionalities that Goliath doesn't provide out of the box, like:
+
+  - Session management
+  - Simplified template support
+  - Simple notation for HTTP verbs and filters
+
+This is the very first version, all the APIand code will be reviewed.
+
+Example
+=======
+
+```ruby
+require 'helmet'
+
+class Misc < Helmet::API
+  
+  use Rack::Static,
+    :root => public_folder, # Default: ./public
+    :urls => ['/css']
+
+  get '/' do 
+    erb(:index, {:layout => :layout}, {:data => session[:data]})
+  end
+  
+  post '/session' do |env|
+    erb(:index, {:layout => :layout}, {:data => session[:data]})
+  end
+  
+end
+```
+See examples directory
+
+License
+=======
+Goliath License, (https://github.com/postrank-labs/goliath/blob/master/LICENSE)
+ 
+Credits
+=======
+
+Helmet is copyright Thiago Lewin <thiago_lewin@yahoo.com.br>

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+desc 'run tests'
+Rake::TestTask.new(:test) do |test|
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/examples/hello_world.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'helmet'
+
+class HelloWorld < Helmet::API
+  
+  get '/' do 
+    'hello world'
+  end
+
+end

data/examples/helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'helmet'
+
+class Helper < Helmet::API
+  
+  helpers do
+    def xs(num)
+      'x' * num
+    end
+  end
+  
+  get '/' do
+    num = (params['x'] || 0).to_i
+    xs(num)
+  end
+  
+end

data/examples/misc.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'helmet'
+
+class Misc < Helmet::API
+  
+  use Rack::Static,
+    :root => config(:public_folder),
+    :urls => ['/css']
+
+  get '/' do
+    erb(:index, 
+      {:layout => :layout}, 
+      {:data => session[:data]})
+  end
+  
+  post '/session' do
+    session[:data] = env['params']['session']
+    erb(:index, 
+      {:layout => :layout}, 
+      {:data => session[:data]})
+  end
+  
+end

data/examples/public/css/helmet.css

@@ -0,0 +1,15 @@
+html,
+body {
+  margin: 0px;
+  padding: 0px;
+  font-family: 'Arial', 'Sans Serif', 'Courier New', 'Times New Roman';
+}
+
+.container {
+  width: 940px;
+  margin: 0px auto;
+}
+
+h1, h2, h3, h4, h5 {
+  margin: 0px 0px 20px;
+}

data/examples/runner.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'helmet/api'
+require 'goliath/runner'
+
+class Test < Helmet::API
+
+  get '/' do
+    'test'
+  end
+
+end
+
+runner = Goliath::Runner.new(ARGV, nil)
+runner.api = Test.new
+runner.app = Goliath::Rack::Builder.build(Test, runner.api)
+runner.run
+

data/examples/views/index.erb

@@ -0,0 +1,7 @@
+<h1>Helmet for Goliath</h1>
+<h2>Current Session Data: <%= data %></h2>
+<form name="session" action="/session" method="post">
+  <label for="session">Session data:</label>
+  <input type="text" name="session">
+  <input type="submit" value="send">
+</form>

data/examples/views/layout.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+    <link rel="stylesheet" href="/css/helmet.css" type="text/css" media="screen">
+    <title>Helmet - Test</title>
+  </head>
+  <body>
+    <div class="container">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/helmet.gemspec

@@ -0,0 +1,24 @@
+require './lib/helmet/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'helmet'
+  s.version       = Helmet::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.date          = Time.now
+  s.summary       = 'Simple web framework for Goliath web server.'
+  s.description   = s.summary
+  s.authors       = ['Thiago Lewin']
+  s.email         = 'thiago_lewin@yahoo.com.br'
+  s.require_path  = 'lib'
+  s.files         = Dir['{lib/**/*,examples/**/*,test/**/*}', 'README.md', 'Rakefile', 'HISTORY.md', 'Gemfile', 'helmet.gemspec', 'LICENSE']
+  s.test_files    = Dir['test/**/*']
+  s.homepage      = 'https://github.com/tlewin/helmet'  
+  s.license       = 'MIT'
+
+  s.add_dependency 'goliath'
+  s.add_dependency 'http_router'
+  s.add_dependency 'tilt'
+
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'shoulda'
+end

data/lib/helmet.rb

@@ -1,6 +1,7 @@
 require 'goliath'
 
 require 'helmet/api'
+require 'helmet/version'
 
 module Helmet
 end

data/lib/helmet/api.rb

@@ -1,7 +1,11 @@
 require 'goliath/api'
+require 'goliath/constants'
+require 'http_router'
 
 require 'helmet/handler'
 
+require 'pry'
+
 module Helmet
   class API < Goliath::API
     
@@ -15,8 +19,8 @@ module Helmet
         @config[key.to_sym]
       end
       
-      def before(route, &block)
-        @before_filters << [route, block]
+      def before(route, opts = {}, &block)
+        @before_filters.add(route, opts, &block)
       end
       
       def routes
@@ -36,24 +40,36 @@ module Helmet
         @helpers
       end
       
-      def get(route, &block) 
-        register_route('GET', route, &block);
-        register_route('HEAD', route, &block);
-      end
-      def post(route, &block) register_route('POST', route, &block); end
-      def put(route, &block) register_route('PUT', route, &block); end
-      def delete(route, &block) register_route('DELETE', route, &block); end
-      def head(route, &block) register_route('HEAD', route, &block); end
-
-      def register_route(method, route, &block)
-        sig = API.signature(method, route)
-        @routes[sig] = block
+      def get(route, opts = {}, &block) 
+        register_route(:GET, route, opts, &block);
+        # HttpRouter already include head
+        # register_route('HEAD', route, opts, &block);
       end
       
-      def signature(method, route)
-        "#{method}#{route}"
-      end
+      def connect(route, opts = {}, &block) register_route(:CONNECT, route, opts, &block); end
+      def delete(route, opts = {}, &block) register_route(:DELETE, route, opts, &block); end
+      # def head(route, opts = {}, &block) register_route(:HEAD, route, opts, &block); end
+      # def options(route, opts = {}, &block) register_route(:OPTIONS, route, opts, &block); end
+      def post(route, opts = {}, &block) register_route(:POST, route, opts, &block); end
+      def put(route, opts = {}, &block) register_route(:PUT, route, opts, &block); end
 
+      def register_route(method, route, opts = {}, &block)       
+        case method
+        when :GET
+          @routes.get(route, opts, &block)
+        when :CONNECT
+          @routes.connect(route, opts, &block)
+        when :DELETE
+          @routes.delete(route, opts, &block)
+        when :OPTIONS
+          @routes.options(route, opts, &block)
+        when :POST
+          @routes.post(route, opts, &block)
+        when :PUT
+          @routes.put(route, opts, &block)
+        end
+      end
+    
       def inherited(klass)
         klass.init
         
@@ -70,10 +86,10 @@ module Helmet
 
       def init
         # Handle application routes
-        @routes          = {}
+        @routes          = HttpRouter.new
 
         # Handle before filters
-        @before_filters  = []
+        @before_filters  = HttpRouter.new
 
         @config          = {}
         
@@ -83,17 +99,12 @@ module Helmet
       private
             
       def setup_middlewares(klass)
-        # support for session
-        klass.use Rack::Session::Cookie
         # support for forms
         klass.use Goliath::Rack::Params 
       end
     end
 
     def response(env)
-      # request path
-      path    = env['REQUEST_PATH']
-      
       # request handler
       handler = Handler.new(env, self.class)
       
@@ -101,20 +112,16 @@ module Helmet
       handler.extend(self.class.get_helpers)
 
       catch(:halt) do
-        # evaluate filters
-        self.class.before_filters.each do |route|
-          case route.first
-          when String
-            handler.handle! &route[1] if route.first == path
-          when Regexp
-            handler.handle! &route[1] if route.first =~ path
-          end
+        # evaluate any route match
+        filters = self.class.before_filters.recognize(env).first || []
+        filters.each do |f|
+          handler.handle! &f.route.dest
         end
-        
-        sig = API.signature(env['REQUEST_METHOD'], path)
-        block = self.class.routes[sig]
-        if block
-          handler.handle!(&block)
+
+        routes_recognized = self.class.routes.recognize(env).first 
+        if routes_recognized
+          # Use the first matched route
+          handler.handle! &routes_recognized.first.route.dest
         else
           handler.handle! do
             status 404
@@ -122,6 +129,7 @@ module Helmet
           end
         end
       end
+      
       handler.response.format_response
     end
   end

data/lib/helmet/version.rb

@@ -0,0 +1,3 @@
+module Helmet
+  VERSION = '0.2.0'
+end

data/test/api_test.rb

@@ -3,8 +3,10 @@ require File.join(File.dirname(__FILE__), 'test_helper')
 require 'uri'
 
 class Simple < Helmet::API
+
+  use Rack::Session::Cookie, :secret => 'remove_security_warning'
   
-  before /\/x\w*$/ do
+  before '/xx' do
     halt 'filtered!'
   end
   
@@ -23,6 +25,10 @@ class Simple < Helmet::API
   delete '/' do
     'delete'
   end
+
+  get '/raise' do
+    raise 'Error'
+  end
   
   get '/redirect' do
     redirect '/redirected'
@@ -86,5 +92,13 @@ class APITest < Test::Unit::TestCase
       end
     end
   end
+
+  # def test_raise
+  #   with_api(Simple) do
+  #     get_request({:path => '/raise'}, @err) do |c|
+  #       assert_equal 'get', c.response
+  #     end
+  #   end
+  # end
   
 end

metadata

@@ -1,85 +1,143 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: helmet
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Thiago Lewin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: goliath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http_router
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: tilt
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple web framework for Goliath web server.
 email: thiago_lewin@yahoo.com.br
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/helmet/api.rb
 - lib/helmet/handler.rb
 - lib/helmet/response.rb
 - lib/helmet/templates.rb
+- lib/helmet/version.rb
 - lib/helmet.rb
+- examples/hello_world.rb
+- examples/helper.rb
+- examples/misc.rb
+- examples/public/css/helmet.css
+- examples/runner.rb
+- examples/views/index.erb
+- examples/views/layout.erb
 - test/api_test.rb
 - test/helper_test.rb
 - test/template_test.rb
 - test/test_helper.rb
 - test/views/test.erb
+- README.md
+- Rakefile
+- HISTORY.md
+- Gemfile
+- helmet.gemspec
+- LICENSE
 homepage: https://github.com/tlewin/helmet
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple web framework for Goliath web server.
-test_files: []
-
+test_files:
+- test/api_test.rb
+- test/helper_test.rb
+- test/template_test.rb
+- test/test_helper.rb
+- test/views/test.erb
 has_rdoc: