grape 0.3.2 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+0.4.0 (3/17/2013)
+=================
+
+* [#356](https://github.com/intridea/grape/pull/356): Fix: presenting collections other than `Array` (eg. `ActiveRecord::Relation`) - [@zimbatm](https://github.com/zimbatm).
+* [#352](https://github.com/intridea/grape/pull/352): Fix: using `Rack::JSONP` with `Grape::Entity` responses - [@deckchair](https://github.com/deckchair).
+* [#347](https://github.com/intridea/grape/issues/347): Grape will accept any valid JSON as PUT or POST, including strings, symbols and arrays - [@qqshfox](https://github.com/qqshfox), [@dblock](https://github.com/dblock).
+* [#347](https://github.com/intridea/grape/issues/347): JSON format APIs always return valid JSON, eg. strings are now returned as `"string"` and no longer `string` - [@dblock](https://github.com/dblock).
+* Raw body input from POST and PUT requests (`env['rack.input'].read`) is now available in `api.request.input` - [@dblock](https://github.com/dblock).
+* Parsed body input from POST and PUT requests is now available in `api.request.body` - [@dblock](https://github.com/dblock).
+* [#343](https://github.com/intridea/grape/pull/343): Fix: return `Content-Type: text/plain` with error 405 - [@gustavosaume](https://github.com/gustavosaume), [@wyattisimo](https://github.com/wyattisimo).
+* [#357](https://github.com/intridea/grape/pull/357): Grape now requires Rack 1.3.0 or newer - [@jhecking](https://github.com/jhecking).
+* [#320](https://github.com/intridea/grape/issues/320): API `namespace` now supports `requirements` - [@niedhui](https://github.com/niedhui).
+* [#353](https://github.com/intridea/grape/issues/353): Revert to standard Ruby logger formatter, `require active_support/all` if you want old behavior - [@rhunter](https://github.com/rhunter), [@dblock](https://github.com/dblock).
+* Fix: `undefined method `call' for nil:NilClass` for an API method implementation without a block, now returns an empty string - [@dblock](https://github.com/dblock).
+
 0.3.2 (2/28/2013)
 =================
 

data/Gemfile

@@ -14,4 +14,5 @@ group :development, :test do
   gem 'rack-test', "~> 0.6.2", :require => "rack/test"
   gem 'github-markup'
   gem 'cookiejar'
+  gem 'rack-contrib'
 end

data/README.md

@@ -8,11 +8,11 @@ providing a simple DSL to easily develop RESTful APIs. It has built-in support
 for common conventions, including multiple formats, subdomain/prefix restriction,
 content negotiation, versioning and much more.
 
-[![Build Status](https://travis-ci.org/intridea/grape.png?branch=master)](http://travis-ci.org/intridea/grape)
+[![Build Status](https://travis-ci.org/intridea/grape.png?branch=master)](http://travis-ci.org/intridea/grape) [![Code Climate](https://codeclimate.com/github/intridea/grape.png)](https://codeclimate.com/github/intridea/grape)
 
 ## Stable Release
 
-You're reading the documentation for Grape, release 0.3.2.
+You're reading the documentation for the stable release 0.4.0.
 
 ## Project Tracking
 
@@ -363,12 +363,12 @@ end
 
 ### Validation Errors
 
-When validation and coercion errors occur an exception of type `Grape::Exceptions::ValidationError` is raised.
+When validation and coercion errors occur an exception of type `Grape::Exceptions::Validation` is raised.
 If the exception goes uncaught it will respond with a status of 400 and an error message.
-You can rescue a `Grape::Exceptions::ValidationError` and respond with a custom response.
+You can rescue a `Grape::Exceptions::Validation` and respond with a custom response.
 
 ```ruby
-rescue_from Grape::Exceptions::ValidationError do |e|
+rescue_from Grape::Exceptions::Validation do |e|
     Rack::Response.new({
         'status' => e.status,
         'message' => e.message,
@@ -402,12 +402,20 @@ header "X-Robots-Tag", "noindex"
 ## Routes
 
 Optionally, you can define requirements for your named route parameters using regular
-expressions. The route will match only if all requirements are met.
+expressions on namespace or endpoint. The route will match only if all requirements are met.
 
 ```ruby
 get ':id', :requirements => { :id => /[0-9]*/ } do
   Status.find(params[:id])
 end
+
+namespace :outer, :requirements => { :id => /[0-9]*/ } do
+  get :id do
+  end
+
+  get ":id/edit" do
+  end
+end
 ```
 
 ## Helpers
@@ -721,9 +729,8 @@ By default, Grape supports _XML_, _JSON_, and _TXT_ content-types. The default f
 
 Serialization takes place automatically. For example, you do not have to call `to_json` in each JSON API implementation.
 
-Your API can declare which types to support by using `content_type`. Response format
-is determined by the request's extension, an explicit `format` parameter in the query
-string, or `Accept` header.
+Your API can declare which types to support by using `content_type`. Response format is determined by the
+request's extension, an explicit `format` parameter in the query string, or `Accept` header.
 
 The following API will only respond to the JSON content-type and will not parse any other input than `application/json`,
 `application/x-www-form-urlencoded`, `multipart/form-data`, `multipart/related` and `multipart/mixed`. All other requests
@@ -795,6 +802,45 @@ The order for choosing the format is the following.
 * Use the default format, if specified by the `default_format` option.
 * Default to `:txt`.
 
+### JSONP
+
+Grape suports JSONP via [Rack::JSONP](https://github.com/rack/rack-contrib), part of the
+[rack-contrib](https://github.com/rack/rack-contrib) gem. Add `rack-contrib` to your `Gemfile`.
+
+```ruby
+require 'rack/contrib'
+
+class API < Grape::API
+  use Rack::JSONP
+  format :json
+  get '/' do
+    'Hello World'
+  end
+end
+```
+
+### CORS
+
+Grape supports CORS via [Rack::CORS](https://github.com/cyu/rack-cors), part of the
+[rack-cors](https://github.com/cyu/rack-cors) gem. Add `rack-cors` to your `Gemfile`.
+
+```ruby
+require 'rack/cors'
+
+class API < Grape::API
+  use Rack::Cors do
+    allow do
+      origins '*'
+      resource '*', :headers => :any, :methods => :get
+    end
+  end
+  format :json
+  get '/' do
+    'Hello World'
+  end
+end
+```
+
 ## Content-type
 
 Content-type is set by the formatter. You can override the content-type of the response at runtime
@@ -816,7 +862,8 @@ section above. It also supports custom data formats. You must declare additional
 `content_type` and optionally supply a parser via `parser` unless a parser is already available within
 Grape to enable a custom format. Such a parser can be a function or a class.
 
-Without a parser, data is available "as-is" and can be read with `env['rack.input'].read`.
+With a parser, parsed data is available "as-is" in `env['api.request.body']`.
+Without a parser, data is available "as-is" and in `env['api.request.input']`.
 
 The following example is a trivial parser that will assign any input with the "text/custom" content-type
 to `:value`. The parameter will be available via `params[:value]` inside the API call.
@@ -1153,4 +1200,4 @@ MIT License. See LICENSE for details.
 
 ## Copyright
 
-Copyright (c) 2010-2012 Michael Bleigh, and Intridea, Inc.
+Copyright (c) 2010-2013 Michael Bleigh, and Intridea, Inc.

data/grape.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "grape"
 
-  s.add_runtime_dependency 'rack'
+  s.add_runtime_dependency 'rack', '>= 1.3.0'
   s.add_runtime_dependency 'rack-mount'
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'activesupport'

data/lib/grape.rb

@@ -6,7 +6,8 @@ require 'rack/accept'
 require 'rack/auth/basic'
 require 'rack/auth/digest/md5'
 require 'hashie'
-require 'active_support/all'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/ordered_hash'
 require 'grape/util/deep_merge'
 require 'grape/util/content_types'
 require 'multi_json'
@@ -20,6 +21,7 @@ module Grape
   autoload :API,                 'grape/api'
   autoload :Endpoint,            'grape/endpoint'
   autoload :Route,               'grape/route'
+  autoload :Namespace,           'grape/namespace'
   autoload :Cookies,             'grape/cookies'
   autoload :Validations,         'grape/validations'
 

data/lib/grape/api.rb

@@ -356,17 +356,17 @@ module Grape
       def options(paths = ['/'], options = {}, &block); route('OPTIONS', paths, options, &block) end
       def patch(paths = ['/'], options = {}, &block); route('PATCH', paths, options, &block) end
 
-      def namespace(space = nil, &block)
+      def namespace(space = nil, options = {},  &block)
         if space || block_given?
           previous_namespace_description = @namespace_description
           @namespace_description = (@namespace_description || {}).deep_merge(@last_description || {})
           @last_description = nil
           nest(block) do
-            set(:namespace, space.to_s) if space
+            set(:namespace, Namespace.new(space, options)) if space
           end
           @namespace_description = previous_namespace_description
         else
-          Rack::Mount::Utils.normalize_path(settings.stack.map{|s| s[:namespace]}.join('/'))
+          Namespace.joined_space_path(settings)
         end
       end
 
@@ -507,7 +507,7 @@ module Grape
         not_allowed_methods = %w(GET PUT POST DELETE PATCH HEAD) - methods
         not_allowed_methods << "OPTIONS" if self.class.settings[:do_not_route_options]
         not_allowed_methods.each do |bad_method|
-          @route_set.add_route( proc { [405, { 'Allow' => allow_header }, []]}, {
+          @route_set.add_route( proc { [405, { 'Allow' => allow_header, 'Content-Type' => 'text/plain' }, []]}, {
             :path_info      => path_info,
             :request_method => bad_method
           })

data/lib/grape/endpoint.rb

@@ -35,9 +35,9 @@ module Grape
     def initialize(settings, options = {}, &block)
       @settings = settings
       if block_given?
-        method_name = [ 
+        method_name = [
           options[:method],
-          settings.gather(:namespace).join("/"),
+          Namespace.joined_space(settings),
           settings.gather(:mount_path).join("/"),
           Array(options[:path]).join("/")
         ].join(" ")
@@ -88,7 +88,11 @@ module Grape
           anchor = options[:route_options][:anchor]
           anchor = anchor.nil? ? true : anchor
 
-          requirements = options[:route_options][:requirements] || {}
+          endpoint_requirements = options[:route_options][:requirements] || {}
+          all_requirements = (settings.gather(:namespace).map(&:requirements) << endpoint_requirements)
+          requirements = all_requirements.reduce({}) do |base_requirements, single_requirements|
+            base_requirements.merge!(single_requirements)
+          end
 
           path = compile_path(prepared_path, anchor && !options[:app], requirements)
           regex = Rack::Mount::RegexpWithNamedGroups.new(path)
@@ -137,7 +141,7 @@ module Grape
     end
 
     def namespace
-      Rack::Mount::Utils.normalize_path(settings.stack.map{|s| s[:namespace]}.join('/'))
+      @namespace ||= Namespace.joined_space_path(settings)
     end
 
     def compile_path(prepared_path, anchor = true, requirements = {})
@@ -316,7 +320,7 @@ module Grape
       entity_class = options.delete(:with)
 
       # auto-detect the entity from the first object in the collection
-      object_instance = object.is_a?(Array) ? object.first : object
+      object_instance = object.respond_to?(:first) ? object.first : object
 
       object_instance.class.ancestors.each do |potential|
         entity_class ||= (settings[:representations] || {})[potential]
@@ -379,7 +383,7 @@ module Grape
 
       run_filters after_validations
 
-      response_text = @block.call(self)
+      response_text = @block ? @block.call(self) : nil
       run_filters afters
       cookies.write(header)
 
@@ -399,6 +403,16 @@ module Grape
         :rescue_options => settings[:rescue_options],
         :rescue_handlers => merged_setting(:rescue_handlers)
 
+      aggregate_setting(:middleware).each do |m|
+        m = m.dup
+        block = m.pop if m.last.is_a?(Proc)
+        if block
+          b.use *m, &block
+        else
+          b.use *m
+        end
+      end
+
       b.use Rack::Auth::Basic, settings[:auth][:realm], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_basic
       b.use Rack::Auth::Digest::MD5, settings[:auth][:realm], settings[:auth][:opaque], &settings[:auth][:proc] if settings[:auth] && settings[:auth][:type] == :http_digest
 
@@ -417,16 +431,6 @@ module Grape
         :formatters => settings[:formatters],
         :parsers => settings[:parsers]
 
-      aggregate_setting(:middleware).each do |m|
-        m = m.dup
-        block = m.pop if m.last.is_a?(Proc)
-        if block
-          b.use *m, &block
-        else
-          b.use *m
-        end
-      end
-
       b
     end
 

data/lib/grape/formatter/json.rb

@@ -4,7 +4,6 @@ module Grape
       class << self
 
         def call(object, env)
-          return object if object.is_a?(String)
           return object.to_json if object.respond_to?(:to_json)
           MultiJson.dump(object)
         end

data/lib/grape/locale/en.yml

@@ -7,7 +7,7 @@ en:
         regexp: 'invalid parameter: %{attribute}'
         missing_vendor_option:
           problem: 'missing :vendor option.'
-          summary: 'when version using header, you must specify :verdor option. '
+          summary: 'when version using header, you must specify :vendor option. '
           resolution: "eg: version 'v1', :using => :header, :vendor => 'twitter'"
         missing_mime_type:
           problem: 'missing mime type for %{new_format}'

data/lib/grape/middleware/formatter.rb

@@ -37,29 +37,39 @@ module Grape
 
       private
 
+        # store read input in env['api.request.input']
         def read_body_input
           if (request.post? || request.put? || request.patch?) && (! request.form_data?) && (! request.parseable_data?) && (request.content_length.to_i > 0)
-            if env['rack.input'] && (body = env['rack.input'].read).length > 0
-              begin
-                fmt = mime_types[request.media_type] if request.media_type
-                if content_type_for(fmt)
-                  parser = Grape::Parser::Base.parser_for fmt, options
-                  unless parser.nil?
-                    begin
-                      body = parser.call body, env
-                      env['rack.request.form_hash'] = env['rack.request.form_hash'] ? env['rack.request.form_hash'].merge(body) : body
-                      env['rack.request.form_input'] = env['rack.input']
-                    rescue Exception => e
-                      throw :error, :status => 400, :message => e.message
-                    end
+            if env['rack.input'] && (body = (env['api.request.input'] = env['rack.input'].read)).length > 0
+              read_rack_input body
+            end
+          end
+        end
+
+        # store parsed input in env['api.request.body']
+        def read_rack_input(body)
+          begin
+            fmt = mime_types[request.media_type] if request.media_type
+            if content_type_for(fmt)
+              parser = Grape::Parser::Base.parser_for fmt, options
+              if parser
+                begin
+                  body = (env['api.request.body'] = parser.call(body, env))
+                  if body.is_a?(Hash)
+                    env['rack.request.form_hash'] = env['rack.request.form_hash'] ? 
+                      env['rack.request.form_hash'].merge(body) : 
+                      body
                   end
-                else
-                  throw :error, :status => 406, :message => "The requested content-type '#{request.media_type}' is not supported."
+                  env['rack.request.form_input'] = env['rack.input']
+                rescue Exception => e
+                  throw :error, :status => 400, :message => e.message
                 end
-              ensure
-                env['rack.input'].rewind
               end
+            else
+              throw :error, :status => 406, :message => "The requested content-type '#{request.media_type}' is not supported."
             end
+          ensure
+            env['rack.input'].rewind
           end
         end
 

data/lib/grape/namespace.rb

@@ -0,0 +1,24 @@
+module Grape
+  class Namespace
+    attr_reader :space, :options
+
+    # options:
+    #   requirements: a hash
+    def initialize(space, options = {})
+      @space, @options = space.to_s, options
+    end
+
+    def requirements
+      options[:requirements] || {}
+    end
+
+    def self.joined_space(settings)
+      settings.gather(:namespace).map(&:space).join("/")
+    end
+
+    def self.joined_space_path(settings)
+      Rack::Mount::Utils.normalize_path(joined_space(settings))
+    end
+
+  end
+end

data/lib/grape/version.rb

@@ -1,3 +1,3 @@
 module Grape
-  VERSION = '0.3.2'
+  VERSION = '0.4.0'
 end

data/spec/grape/api_spec.rb

@@ -57,6 +57,7 @@ describe Grape::API do
       end
     end
   end
+
   describe '.version using param' do
     it_should_behave_like 'versioning' do
       let(:macro_options) do
@@ -93,9 +94,7 @@ describe Grape::API do
       # end
     end
 
-    it 'routes if any media type is allowed' do
-
-    end
+    # pending 'routes if any media type is allowed'
   end
 
   describe '.represent' do
@@ -108,7 +107,6 @@ describe Grape::API do
       subject.represent Object, :with => klass
       subject.settings[:representations][Object].should == klass
     end
-
   end
 
   describe '.namespace' do
@@ -189,7 +187,6 @@ describe Grape::API do
         get do
           "Votes"
         end
-
         post do
           "Created a Vote"
         end
@@ -201,15 +198,22 @@ describe Grape::API do
       last_response.body.should eql 'Created a Vote'
     end
 
+    it 'handles empty calls' do
+      subject.get "/"
+      get "/"
+      last_response.body.should eql ""
+    end
+
     describe 'root routes should work with' do
       before do
+        subject.format :txt
         def subject.enable_root_route!
-          self.get("/") {"root"}
+          self.get("/") { "root" }
         end
       end
 
       after do
-        last_response.body.should eql 'root'
+        last_response.body.should eql "root"
       end
 
       describe 'path versioned APIs' do
@@ -314,6 +318,31 @@ describe Grape::API do
       last_response.body.should eql 'hiya'
     end
 
+    [ :put, :post ].each do |verb|
+      context verb do
+        [ 'string', :symbol, 1, -1.1, {}, [], true, false, nil ].each do |object|
+          it "allows a(n) #{object.class} json object in params" do
+            subject.format :json
+            subject.send(verb) do
+              env['api.request.body']
+            end
+            send verb, '/', MultiJson.dump(object), { 'CONTENT_TYPE' => 'application/json' }
+            last_response.status.should == (verb == :post ? 201 : 200)
+            last_response.body.should eql MultiJson.dump(object)
+          end
+          it "stores input in api.request.input" do
+            subject.format :json
+            subject.send(verb) do
+              env['api.request.input']
+            end
+            send verb, '/', MultiJson.dump(object), { 'CONTENT_TYPE' => 'application/json' }
+            last_response.status.should == (verb == :post ? 201 : 200)
+            last_response.body.should eql MultiJson.dump(object).to_json
+          end
+        end
+      end
+    end
+
     it 'allows for multipart paths' do
 
       subject.route([:get, :post], '/:id/first') do
@@ -395,6 +424,17 @@ describe Grape::API do
       last_response.headers['Allow'].should eql 'OPTIONS, GET, POST, HEAD'
     end
 
+    specify '405 responses includes an Content-Type header' do
+      subject.get 'example' do
+        "example"
+      end
+      subject.post 'example' do
+        "example"
+      end
+      put '/example'
+      last_response.headers['Content-Type'].should eql 'text/plain'
+    end
+
     it 'adds an OPTIONS route that returns a 204 and an Allow header' do
       subject.get 'example' do
         "example"
@@ -631,6 +671,20 @@ describe Grape::API do
           last_response.body.should == 'true'
         end
       end
+
+      it 'mounts behind error middleware' do
+        m = Class.new(Grape::Middleware::Base) do
+          def before
+            throw :error, :message => "Caught in the Net", :status => 400
+          end
+        end
+        subject.use m
+        subject.get "/" do
+        end
+        get "/"
+        last_response.status.should == 400
+        last_response.body.should == "Caught in the Net"
+      end
     end
   end
   describe '.basic' do
@@ -685,6 +739,13 @@ describe Grape::API do
       mylogger.should_receive(:info).exactly(1).times
       subject.logger.info "this will be logged"
     end
+
+    it "defaults to a standard logger log format" do
+      t = Time.at(100)
+      Time.stub(:now).and_return(t)
+      STDOUT.should_receive(:write).with("I, [#{Logger::Formatter.new.send(:format_datetime, t)}\##{Process.pid}]  INFO -- : this will be logged\n")
+      subject.logger.info "this will be logged"
+    end
   end
 
   describe '.helpers' do