helmet 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a879ae7efe16ee0b0697501f4075fea37abe07b1
-  data.tar.gz: 448ee6bb790963c0cd5b5b2faabc7ad1fa585b19
+  metadata.gz: 3c0fa561a63d2be52841a64cc90103db7cdbdd7e
+  data.tar.gz: 31c33f5bbe5b145b04e3955c0cf128e7f880ea19
 SHA512:
-  metadata.gz: 15ec47ac0967d6492915529c865507451bb62e1236ec10fdf7c7c5a89af1d0e351bf0e75bfe190a4ebda7409de922a19a7b9961a3c2b536adb6dec979774c9b4
-  data.tar.gz: 495a7c1a4006bc21d140f226744983b68d09ea7c021839521c16a20b17714870a50047b275840d93eaaf99427a9172571ff96b142a6abd1828261988f1538d14
+  metadata.gz: 887635bc3aefd6badbfe428df978f7984382bdb1cea93337f8cac9d218970b5ae9e4bda353e3506e09ec271f3578dc3899d301077c9b18ccfea61c542b065875
+  data.tar.gz: de5a117cbe50bd4f21563500ea2311d9256d03f84e350b481faee2ec727d87f9cbde6e5687f83f3324309ca58113a02ebe808d5e8d6bd480448bca11c84d0276

data/HISTORY.md

@@ -1,6 +1,13 @@
 # HISTORY
 
-## v0.0.2
+## v0.2.1
+- content-type support
+- Fix template bugs
+- Include HttpRouter params into env params
+- Rename config method to settings
+- Include config into handler
+
+## v0.2.0
 
 - Replace router by http_router gem.
 - Include LICENSE file 

data/LICENSE

@@ -16,3 +16,52 @@ 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.
+
+Portions of this code are from the Goliath project (https://github.com/postrank-labs/goliath) and under the following license:
+Copyright (c) 2011-2012 PostRank Inc.
+
+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.
+
+Portions of this code are from the Sinatra project (https://github.com/bmizerany/sinatra) and under the following license:
+Copyright (c) 2007, 2008, 2009, 2010, 2011 Blake Mizerany
+
+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.
+

data/Rakefile

@@ -1,10 +1,27 @@
 require 'rake'
 require 'rake/testtask'
 
-task :default => [:test]
+require './lib/helmet/version'
 
 desc 'run tests'
 Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
+
+namespace :gem do
+  desc 'build gem file'
+  task :build do
+    system 'gem build helmet.gemspec'
+  end
+
+  desc 'install gem file'
+  task :install do
+    system "gem install --local helmet-#{Helmet::VERSION}.gem"
+  end
+end
+
+desc 'build and install gem file'
+task :gem => ['gem:build', 'gem:install']
+
+task :default => [:test]

data/lib/helmet.rb

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

data/lib/helmet/api.rb

@@ -4,20 +4,12 @@ require 'http_router'
 
 require 'helmet/handler'
 
-require 'pry'
-
 module Helmet
   class API < Goliath::API
     
     class << self
-      
-      def set(key, value)
-        @config[key.to_sym] = value
-      end
 
-      def config(key)
-        @config[key.to_sym]
-      end
+      attr_accessor :settings
       
       def before(route, opts = {}, &block)
         @before_filters.add(route, opts, &block)
@@ -78,8 +70,9 @@ module Helmet
 
         # compute public/ views folder
         base = File.expand_path(File.dirname(caller.first[/^[^:]*/]))
-        klass.set :public_folder, File.join(base, 'public')
-        klass.set :views_folder, File.join(base, 'views')
+        
+        klass.settings[:public_folder]  = File.join(base, 'public')
+        klass.settings[:views_folder]   = File.join(base, 'views')
 
         super # update Goliath::Application.app_class
       end
@@ -91,7 +84,7 @@ module Helmet
         # Handle before filters
         @before_filters  = HttpRouter.new
 
-        @config          = {}
+        @settings        = {}
         
         @helpers         = Module.new
       end
@@ -113,15 +106,26 @@ module Helmet
 
       catch(:halt) do
         # evaluate any route match
-        filters = self.class.before_filters.recognize(env).first || []
+        filters = self.class.before_filters.recognize(env).first 
+
         filters.each do |f|
+          # include route params into env
+          route_params = f.params
+          env.params.merge! route_params
+          
           handler.handle! &f.route.dest
-        end
+          
+          # remove after usage
+          env.params.delete_if {|k,v| route_params[k] == v}
+        end if filters
 
         routes_recognized = self.class.routes.recognize(env).first 
         if routes_recognized
           # Use the first matched route
-          handler.handle! &routes_recognized.first.route.dest
+          http_router_response = routes_recognized.first
+          # Bind params to the env
+          env.params.merge! http_router_response.params
+          handler.handle! &http_router_response.route.dest
         else
           handler.handle! do
             status 404

data/lib/helmet/handler.rb

@@ -1,6 +1,8 @@
 require 'helmet/templates'
 require 'helmet/response'
 
+require 'rack/mime'
+
 module Helmet
 
   # Handle each request and provide usefull methods for request handling
@@ -67,9 +69,27 @@ module Helmet
     def params
       env.params || {}
     end
+
+    # @return [Hash] config object
+    def config
+      env.config
+    end
     
-    def content_type(type)
-      # TODO implement content type header
+    # Set content-type header based on extension
+    #
+    # @param [String, Symbol] ext mime extension
+    # @return [String] mime type (@see mime_type)
+    def content_type ext
+      header['Content-Type'] = mime_type(ext)
+    end
+
+    # Return mime type based on extension
+    # Uses Rack::Mime library.
+    #
+    # @param [String, Symbol] ext mime type extension
+    # @return [String] mime type
+    def mime_type ext
+      Rack::Mime.mime_type ".#{ext}"
     end
   end
 end

data/lib/helmet/templates.rb

@@ -6,11 +6,12 @@ module Helmet
     @@template_cache = Tilt::Cache.new
         
     def erb(template, options = {}, locals = {})
-     render(:erb, template, options, locals) 
+      render(:erb, template, options, locals) 
     end
 
     def render(engine, data, options = {}, locals = {}, &block)
-      layout = options.delete(:layout)
+      layout = options[:layout]
+      layout = :layout if layout.nil?
       # force template update
       @@template_cache.clear unless Goliath.env == :production
       compiled_template = @@template_cache.fetch(data, options) do
@@ -18,7 +19,12 @@ module Helmet
       end
       output = compiled_template.render(self, locals, &block)
       if layout
-        return render(engine, layout, options, locals) {output}
+        begin
+          options.merge!(layout: false)
+          return render(engine, layout, options, locals) {output}
+        rescue 
+          # Do nothing
+        end
       end
       output
     end
@@ -27,7 +33,8 @@ module Helmet
     
     def find_template(engine, template)
       filename = "#{template.to_s}.#{engine.to_s}"
-      File.join(@klass.config(:views_folder), filename)
+      File.join(@klass.settings[:views_folder], filename)
     end
   end
+
 end

data/lib/helmet/version.rb

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

data/test/api_test.rb

@@ -1,18 +1,23 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
 require 'uri'
+require 'rack/mime'
 
 class Simple < Helmet::API
 
   use Rack::Session::Cookie, :secret => 'remove_security_warning'
   
-  before '/xx' do
+  before '/filtered' do
     halt 'filtered!'
   end
   
   get '/' do
     'get'
   end
+
+  get '/filtered' do
+    'should not be here!'
+  end
   
   post '/' do
     'post'
@@ -33,6 +38,11 @@ class Simple < Helmet::API
   get '/redirect' do
     redirect '/redirected'
   end
+
+  get '/ct' do
+    ct = params['ct'].to_sym
+    content_type ct
+  end
 end
 
 class APITest < Test::Unit::TestCase
@@ -77,7 +87,7 @@ class APITest < Test::Unit::TestCase
 
   def test_filter
     with_api(Simple) do
-      get_request({:path => '/xx'}, @err) do |c|
+      get_request({:path => '/filtered'}, @err) do |c|
         assert_equal 'filtered!', c.response
       end
     end
@@ -93,6 +103,30 @@ class APITest < Test::Unit::TestCase
     end
   end
 
+  def test_content_type_json
+    with_api(Simple) do
+      get_request({:path => '/ct', :query => {ct: 'json'}}, @err) do |c|
+        assert_equal c.response_header['Content-Type'], Rack::Mime.mime_type('.json')
+      end
+    end
+  end    
+
+  def test_content_type_js
+    with_api(Simple) do
+      get_request({:path => '/ct', :query => {ct: 'js'}}, @err) do |c|
+        assert_equal c.response_header['Content-Type'], Rack::Mime.mime_type('.js')
+      end
+    end
+  end    
+
+  def test_content_type_html
+    with_api(Simple) do
+      get_request({:path => '/ct', :query => {ct: 'html'}}, @err) do |c|
+        assert_equal c.response_header['Content-Type'], Rack::Mime.mime_type('.html')
+      end
+    end
+  end    
+
   # def test_raise
   #   with_api(Simple) do
   #     get_request({:path => '/raise'}, @err) do |c|

data/test/http_router_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RouterAPI < Helmet::API
+
+  before '/user/:id' do
+    halt "Halt user #{params[:id]}" if params[:id] == '11'
+  end
+
+  before '/clean/:user/1' do
+    "Clean/ #{params[:user] || 'nil'}/ #{params[:id] || 'nil'}"
+  end
+
+  before '/clean/test/:id' do
+    [body, "Clean/ #{params[:user] || 'nil'}/ #{params[:id] || 'nil'}"] * ','
+  end
+
+  get '/user/:id' do
+    "Hello user #{params[:id]}"
+  end
+
+  get '/clean/:user/:id' do
+    body
+  end
+
+end
+
+class HttpRouterTest < Test::Unit::TestCase
+  include Goliath::TestHelper
+
+  def setup
+    @err = Proc.new { assert false, "API request failed" }
+  end
+
+  def test_url_params
+    with_api(RouterAPI) do
+      get_request({path: '/user/3'}, @err) do |c|
+        assert_equal 'Hello user 3', c.response
+      end
+    end
+  end
+
+  def test_before_filters_params 
+    with_api(RouterAPI) do
+      get_request({path: '/user/11'}, @err) do |c|
+        assert_equal 'Halt user 11', c.response
+      end
+    end
+  end
+
+  def test_clean_params_for_each_route 
+    with_api(RouterAPI) do
+      get_request({path: '/clean/test/1'}, @err) do |c|
+        assert_equal 'Clean/ test/ nil,Clean/ nil/ 1', c.response
+      end
+    end      
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Thiago Lewin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: goliath
@@ -101,6 +101,7 @@ files:
 - examples/views/layout.erb
 - test/api_test.rb
 - test/helper_test.rb
+- test/http_router_test.rb
 - test/template_test.rb
 - test/test_helper.rb
 - test/views/test.erb
@@ -137,6 +138,7 @@ summary: Simple web framework for Goliath web server.
 test_files:
 - test/api_test.rb
 - test/helper_test.rb
+- test/http_router_test.rb
 - test/template_test.rb
 - test/test_helper.rb
 - test/views/test.erb