grape 0.1.1 → 0.1.3

data/lib/grape/api.rb

@@ -45,16 +45,28 @@ module Grape
         @settings.last[key.to_sym] = value
       end
       
-      # Define a root prefix for your entire
-      # API. For instance, if you had an api
-      # that you wanted to be namespaced at
-      # `/api/` you would do this:
-      # 
-      #   prefix '/api'
+      # Define a root URL prefix for your entire
+      # API.
       def prefix(prefix = nil)
         prefix ? set(:root_prefix, prefix) : settings[:root_prefix]
       end
       
+      # Specify an API version.
+      #
+      # @example API with legacy support.
+      #   class MyAPI < Grape::API
+      #     version 'v2'
+      #     
+      #     get '/main' do
+      #       {:some => 'data'}
+      #     end
+      #         
+      #     version 'v1' do
+      #       get '/legacy' do
+      #         {:legacy => 'data'}
+      #       end
+      #     end
+      #   end
       def version(*new_versions, &block)
         new_versions.any? ? nest(block){ set(:version, new_versions) } : settings[:version]
       end
@@ -69,13 +81,14 @@ module Grape
       # Add helper methods that will be accessible from any
       # endpoint within this namespace (and child namespaces).
       #
-      #    class ExampleAPI
-      #      helpers do
-      #        def current_user
-      #          User.find_by_id(params[:token])
-      #        end
-      #      end
-      #    end
+      # @example Define some helpers.
+      #     class ExampleAPI < Grape::API
+      #       helpers do
+      #         def current_user
+      #           User.find_by_id(params[:token])
+      #         end
+      #       end
+      #     end
       def helpers(&block)
         if block_given?
           m = settings_stack.last[:helpers] || Module.new
@@ -112,9 +125,15 @@ module Grape
       # Defines a route that will be recognized
       # by the Grape API.
       #
-      # @param methods [HTTP Verb(s)] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.
-      # @param paths [String(s)] One or more strings representing the URL segment(s) for this route.
-      # @param block [Proc] The code to be executed 
+      # @param methods [HTTP Verb] One or more HTTP verbs that are accepted by this route. Set to `:any` if you want any verb to be accepted.
+      # @param paths [String] One or more strings representing the URL segment(s) for this route.
+      #
+      # @example Defining a basic route.
+      #   class MyAPI < Grape::API
+      #     route(:any, '/hello') do
+      #       {:hello => 'world'}
+      #     end
+      #   end
       def route(methods, paths, &block)
         methods = Array(methods)
         paths = ['/'] if paths == []
@@ -158,7 +177,24 @@ module Grape
       def scope(name = nil, &block)
         nest(block)
       end
-      
+
+      # Apply a custom middleware to the API. Applies
+      # to the current namespace and any children, but
+      # not parents.
+      #
+      # @param middleware_class [Class] The class of the middleware you'd like to inject.
+      def use(middleware_class, *args)
+        settings_stack.last[:middleware] ||= []
+        settings_stack.last[:middleware] << [middleware_class, *args]        
+      end
+
+      # Retrieve an array of the middleware classes
+      # and arguments that are currently applied to the
+      # application.
+      def middleware
+        settings_stack.inject([]){|a,s| a += s[:middleware] if s[:middleware]; a}
+      end
+
       protected
       
       # Execute first the provided block, then each of the
@@ -183,7 +219,8 @@ module Grape
         b.use Grape::Middleware::Prefixer, :prefix => prefix if prefix        
         b.use Grape::Middleware::Versioner, :versions => (version if version.is_a?(Array)) if version
         b.use Grape::Middleware::Formatter, :default_format => default_format || :json
-        
+        middleware.each{|m| b.use *m }
+
         endpoint = Grape::Endpoint.generate(&block)
         endpoint.send :include, helpers
         b.run endpoint
@@ -203,12 +240,13 @@ module Grape
         parts = []
         parts << prefix if prefix
         parts << ':version' if version
-        parts << namespace if namespace
-        parts << path
+        parts << namespace.to_s if namespace
+        parts << path.to_s if path && '/' != path
+        parts.last << '(.:format)'
         Rack::Mount::Utils.normalize_path(parts.join('/'))
       end
     end  
     
     reset! 
   end
-end
+end

data/lib/grape/middleware/base.rb

@@ -28,7 +28,7 @@ module Grape
       def before; end
       # @abstract
       # Called after the application is called in the middleware lifecycle.
-      # @returns [Response, nil] a Rack SPEC response or nil to call the application afterwards.
+      # @return [Response, nil] a Rack SPEC response or nil to call the application afterwards.
       def after; end
       
       def request

data/lib/grape/middleware/error.rb

@@ -18,4 +18,4 @@ module Grape
       end
     end
   end
-end
+end

data/spec/grape/api_spec.rb

@@ -92,7 +92,7 @@ describe Grape::API do
       subject.version :v1
       
       subject.namespace :awesome do
-        compile_path('hello').should == '/rad/:version/awesome/hello'
+        compile_path('hello').should == '/rad/:version/awesome/hello(.:format)'
       end
     end
     
@@ -117,9 +117,9 @@ describe Grape::API do
     it 'should be callable with nil just to push onto the stack' do
       subject.namespace do
         version 'v2'
-        compile_path('hello').should == '/:version/hello'
+        compile_path('hello').should == '/:version/hello(.:format)'
       end
-      subject.send(:compile_path, 'hello').should == '/hello'
+      subject.send(:compile_path, 'hello').should == '/hello(.:format)'
     end
     
     %w(group resource resources).each do |als|
@@ -159,6 +159,26 @@ describe Grape::API do
       get '/def'
       last_response.body.should == 'foo'
     end
+
+    it 'should allow for format' do
+      subject.get("/abc") do
+        "json"
+      end
+      
+      get '/abc.json'
+      last_response.body.should == '"json"'
+    end
+
+    it 'should allow for format in namespace with no path' do
+      subject.namespace :abc do
+        get do
+          "json"
+        end
+      end
+      
+      get '/abc.json'
+      last_response.body.should == '"json"'
+    end
     
     it 'should allow for multiple verbs' do
       subject.route([:get, :post], '/abc') do
@@ -207,6 +227,67 @@ describe Grape::API do
     end
   end
   
+  context 'custom middleware' do
+    class PhonyMiddleware
+      def initialize(app, *args)
+        @args = args
+        @app = app
+      end
+
+      def call(env)
+        env['phony.args'] ||= []
+        env['phony.args'] << @args
+        @app.call(env)
+      end
+    end
+
+    describe '.middleware' do
+      it 'should include middleware arguments from settings' do
+        subject.stub!(:settings_stack).and_return [{:middleware => [[PhonyMiddleware, 'abc', 123]]}]
+        subject.middleware.should == [[PhonyMiddleware, 'abc', 123]]
+      end
+
+      it 'should include all middleware from stacked settings' do
+        subject.stub!(:settings_stack).and_return [
+          {:middleware => [[PhonyMiddleware, 123],[PhonyMiddleware, 'abc']]},
+          {:middleware => [[PhonyMiddleware, 'foo']]}
+        ]
+  
+        subject.middleware.should == [
+          [PhonyMiddleware, 123],
+          [PhonyMiddleware, 'abc'],
+          [PhonyMiddleware, 'foo']
+        ]
+      end
+    end
+
+    describe '.use' do
+      it 'should add middleware' do
+        subject.use PhonyMiddleware, 123
+        subject.middleware.should == [[PhonyMiddleware, 123]]
+      end
+
+      it 'should not show up outside the namespace' do
+        subject.use PhonyMiddleware, 123
+        subject.namespace :awesome do
+          use PhonyMiddleware, 'abc'
+          middleware.should == [[PhonyMiddleware, 123],[PhonyMiddleware, 'abc']]
+        end
+
+        subject.middleware.should == [[PhonyMiddleware, 123]]        
+      end
+
+      it 'should actually call the middleware' do
+        subject.use PhonyMiddleware, 'hello'
+        subject.get '/' do
+          env['phony.args'].first.first
+        end
+
+        get '/'
+        last_response.body.should == 'hello'
+      end
+    end
+  end
   describe '.basic' do
     it 'should protect any resources on the same scope' do
       subject.http_basic do |u,p|
@@ -340,4 +421,4 @@ describe Grape::API do
       last_response.status.should == 200
     end
   end
-end
+end

data/spec/grape/endpoint_spec.rb

@@ -71,6 +71,18 @@ describe Grape::Endpoint do
       last_response.status.should == 401
       last_response.body.should == "Unauthorized."
     end
+
+    it 'should accept an object and render it in format' do
+      pending
+
+      subject.get '/hey' do
+        error!({'dude' => 'rad'}, 403)
+      end
+
+      get '/hey.json'
+      last_response.status.should == 403
+      last_response.body.should == '{"dude":"rad"}'
+    end
   end
   
   it 'should not persist params between calls' do
@@ -101,4 +113,4 @@ describe Grape::Endpoint do
     get '/hello?howdy=yo'
     last_response.body.should == 'yo'
   end
-end
+end

data/spec/grape/middleware/auth/basic_spec.rb

@@ -9,7 +9,7 @@ describe Grape::Middleware::Auth::Basic do
       b.use(Grape::Middleware::Auth::Basic) do |u,p| 
         u && p && u == p
       end
-      b.run lambda{|env| [200, {}, "Hello there."]}
+      b.run lambda{|env| [200, {}, ["Hello there."]]}
     end
   end
   
@@ -28,4 +28,4 @@ describe Grape::Middleware::Auth::Basic do
     get '/whatever', {}, 'HTTP_AUTHORIZATION' => encode_basic('admin','wrong')
     last_response.status.should == 401
   end
-end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: grape
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -15,123 +14,141 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-14 00:00:00 -06:00
+date: 2011-01-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
   name: rack
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rack-mount
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
         segments: 
         - 0
         - 6
         - 13
         version: 0.6.13
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rack-jsonp
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: json
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: multi_json
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
-  prerelease: false
   type: :runtime
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: multi_xml
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
+  type: :runtime
   prerelease: false
-  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: rake
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id007
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
   prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  name: jeweler
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id008
+  type: :development
+  prerelease: false
+  version_requirements: *id010
 description: A Ruby framework for rapid API development with great conventions.
 email: michael@intridea.com
 executables: []
@@ -145,7 +162,106 @@ files:
 - .document
 - .gitignore
 - .rspec
-- .rvmrc
+- .yardoc/checksums
+- .yardoc/objects/Grape.dat
+- .yardoc/objects/Grape/API.dat
+- .yardoc/objects/Grape/API/auth_c.dat
+- .yardoc/objects/Grape/API/build_endpoint_c.dat
+- .yardoc/objects/Grape/API/call_c.dat
+- .yardoc/objects/Grape/API/compile_path_c.dat
+- .yardoc/objects/Grape/API/default_format_c.dat
+- .yardoc/objects/Grape/API/delete_c.dat
+- .yardoc/objects/Grape/API/get_c.dat
+- .yardoc/objects/Grape/API/group_c.dat
+- .yardoc/objects/Grape/API/head_c.dat
+- .yardoc/objects/Grape/API/helpers_c.dat
+- .yardoc/objects/Grape/API/http_basic_c.dat
+- .yardoc/objects/Grape/API/inherited_c.dat
+- .yardoc/objects/Grape/API/logger_c.dat
+- .yardoc/objects/Grape/API/namespace_c.dat
+- .yardoc/objects/Grape/API/nest_c.dat
+- .yardoc/objects/Grape/API/post_c.dat
+- .yardoc/objects/Grape/API/prefix_c.dat
+- .yardoc/objects/Grape/API/put_c.dat
+- .yardoc/objects/Grape/API/reset_21_c.dat
+- .yardoc/objects/Grape/API/resource_c.dat
+- .yardoc/objects/Grape/API/resources_c.dat
+- .yardoc/objects/Grape/API/route_c.dat
+- .yardoc/objects/Grape/API/route_set_c.dat
+- .yardoc/objects/Grape/API/scope_c.dat
+- .yardoc/objects/Grape/API/set_c.dat
+- .yardoc/objects/Grape/API/settings_c.dat
+- .yardoc/objects/Grape/API/settings_stack_c.dat
+- .yardoc/objects/Grape/API/version_c.dat
+- .yardoc/objects/Grape/Endpoint.dat
+- .yardoc/objects/Grape/Endpoint/block_3D_c.dat
+- .yardoc/objects/Grape/Endpoint/block_c.dat
+- .yardoc/objects/Grape/Endpoint/call_c.dat
+- .yardoc/objects/Grape/Endpoint/call_i.dat
+- .yardoc/objects/Grape/Endpoint/env_i.dat
+- .yardoc/objects/Grape/Endpoint/error_21_i.dat
+- .yardoc/objects/Grape/Endpoint/generate_c.dat
+- .yardoc/objects/Grape/Endpoint/header_i.dat
+- .yardoc/objects/Grape/Endpoint/params_i.dat
+- .yardoc/objects/Grape/Endpoint/request_i.dat
+- .yardoc/objects/Grape/Endpoint/status_i.dat
+- .yardoc/objects/Grape/Endpoint/version_i.dat
+- .yardoc/objects/Grape/Middleware.dat
+- .yardoc/objects/Grape/Middleware/Auth.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic/authenticator_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic/basic_request_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic/before_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic/credentials_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/Basic/initialize_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/before_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/default_options_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/error_out_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/parse_authorization_header_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/token_class_i.dat
+- .yardoc/objects/Grape/Middleware/Auth/OAuth2/verify_token_i.dat
+- .yardoc/objects/Grape/Middleware/Base.dat
+- .yardoc/objects/Grape/Middleware/Base/after_i.dat
+- .yardoc/objects/Grape/Middleware/Base/app_i.dat
+- .yardoc/objects/Grape/Middleware/Base/before_i.dat
+- .yardoc/objects/Grape/Middleware/Base/call_21_i.dat
+- .yardoc/objects/Grape/Middleware/Base/call_i.dat
+- .yardoc/objects/Grape/Middleware/Base/default_options_i.dat
+- .yardoc/objects/Grape/Middleware/Base/env_i.dat
+- .yardoc/objects/Grape/Middleware/Base/initialize_i.dat
+- .yardoc/objects/Grape/Middleware/Base/options_i.dat
+- .yardoc/objects/Grape/Middleware/Base/request_i.dat
+- .yardoc/objects/Grape/Middleware/Base/response_i.dat
+- .yardoc/objects/Grape/Middleware/Error.dat
+- .yardoc/objects/Grape/Middleware/Error/call_21_i.dat
+- .yardoc/objects/Grape/Middleware/Error/error_response_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter.dat
+- .yardoc/objects/Grape/Middleware/Formatter/CONTENT_TYPES.dat
+- .yardoc/objects/Grape/Middleware/Formatter/after_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/before_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/content_types_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/default_options_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/encode_json_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/encode_txt_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/format_from_extension_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/format_from_header_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/headers_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/mime_array_i.dat
+- .yardoc/objects/Grape/Middleware/Formatter/mime_types_i.dat
+- .yardoc/objects/Grape/Middleware/Prefixer.dat
+- .yardoc/objects/Grape/Middleware/Prefixer/before_i.dat
+- .yardoc/objects/Grape/Middleware/Prefixer/prefix_i.dat
+- .yardoc/objects/Grape/Middleware/Versioner.dat
+- .yardoc/objects/Grape/Middleware/Versioner/before_i.dat
+- .yardoc/objects/Grape/Middleware/Versioner/default_options_i.dat
+- .yardoc/objects/Grape/MiddlewareStack.dat
+- .yardoc/objects/Grape/MiddlewareStack/initialize_i.dat
+- .yardoc/objects/Grape/MiddlewareStack/stack_i.dat
+- .yardoc/objects/Grape/MiddlewareStack/to_app_i.dat
+- .yardoc/objects/Grape/MiddlewareStack/use_i.dat
+- .yardoc/objects/root.dat
+- .yardoc/proxy_types
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -164,7 +280,6 @@ files:
 - lib/grape/middleware/formatter.rb
 - lib/grape/middleware/prefixer.rb
 - lib/grape/middleware/versioner.rb
-- lib/grape/middleware_stack.rb
 - spec/grape/api_spec.rb
 - spec/grape/endpoint_spec.rb
 - spec/grape/middleware/auth/basic_spec.rb
@@ -174,7 +289,6 @@ files:
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb
-- spec/grape/middleware_stack_spec.rb
 - spec/grape_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
@@ -191,7 +305,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 3948769819312145241
       segments: 
       - 0
       version: "0"
@@ -200,7 +314,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -221,6 +334,5 @@ test_files:
 - spec/grape/middleware/formatter_spec.rb
 - spec/grape/middleware/prefixer_spec.rb
 - spec/grape/middleware/versioner_spec.rb
-- spec/grape/middleware_stack_spec.rb
 - spec/grape_spec.rb
 - spec/spec_helper.rb