grape 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3f8c2e0db297ca831e464a1c0db49f2e5ba6f2e
-  data.tar.gz: 34b6bcee2a26ecb8e87b207abbb59647d2376773
+  metadata.gz: cce57801c840dd9a64018350c6dd1eb955fc7b70
+  data.tar.gz: e09089d477bba3cf9ff2bd53a5f164ecffefe494
 SHA512:
-  metadata.gz: 98bbce31a09337c9ef681b59f7a63c2bfb7cdb472d6b46275d73bd22064bcff48288283d57f5ed04ba6f662571975d3a284a91b0448a3369149729c363838fde
-  data.tar.gz: 41d9f0ac8df0ba6c7105ab8b1e50183d569f5708bdd9469661cde03a79e6f3e604551d049e49fd4fc3eb49d49456d42523718fcd961711112c4f904389ed9b70
+  metadata.gz: 1a7d4e52cdc91c6ee4f623b4a14d986b60a0f574b2885392487ff22993c6465c923165e9214382e9465265f8e1240519be0b95fec0c19c7d3f4fc603827edd1c
+  data.tar.gz: 7ec02b2a4bcc083f6034c681cf82356d97e6d3aa65ad2d6663fe2c437c5e0da7f344371f003391ff9c838b7b190c9415e5abe986f9449670a76ab545e0e7aa5d

data/.gitignore

@@ -30,6 +30,7 @@ pkg
 .yardoc/*
 dist
 Gemfile.lock
+gemfiles/*.lock
 tmp
 
 ## Rubinius

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format=progress
+--format=documentation

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+0.11.0 (2/23/2015)
+==================
+
+* [#925](https://github.com/intridea/grape/pull/925): Fixed `toplevel constant DateTime referenced by Virtus::Attribute::DateTime` - [@u2](https://github.com/u2).
+* [#916](https://github.com/intridea/grape/pull/916): Added `DateTime/Date/Numeric/Boolean` type support `allow_blank` - [@u2](https://github.com/u2).
+* [#871](https://github.com/intridea/grape/pull/871): Fixed `Grape::Middleware::Base#response` - [@galathius](https://github.com/galathius).
+* [#559](https://github.com/intridea/grape/issues/559): Added support for Rack 1.6.0, which parses requests larger than 128KB - [@myitcv](https://github.com/myitcv).
+* [#876](https://github.com/intridea/grape/pull/876): Call to `declared(params)` now returns a `Hashie::Mash` - [@rodzyn](https://github.com/rodzyn).
+* [#879](https://github.com/intridea/grape/pull/879): The `route_info` value is no longer included in `params` Hash - [@rodzyn](https://github.com/rodzyn).
+* [#881](https://github.com/intridea/grape/issues/881): Fixed `Grape::Validations::ValuesValidator` support for `Range` type - [@ajvondrak](https://github.com/ajvondrak).
+* [#901](https://github.com/intridea/grape/pull/901): Fix: callbacks defined in a version block are only called for the routes defined in that block - [@kushkella](https://github.com/kushkella).
+* [#886](https://github.com/intridea/grape/pull/886): Group of parameters made to require an explicit type of Hash or Array - [@jrichter1](https://github.com/jrichter1).
+* [#912](https://github.com/intridea/grape/pull/912): Extended the `:using` feature for param documentation to `optional` fields - [@croeck](https://github.com/croeck).
+* [#906](https://github.com/intridea/grape/pull/906): Fix: invalid body parse errors are not rescued by handlers - [@croeck](https://github.com/croeck).
+* [#913](https://github.com/intridea/grape/pull/913): Fix: Invalid accept headers are not processed by rescue handlers - [@croeck](https://github.com/croeck).
+* [#913](https://github.com/intridea/grape/pull/913): Fix: Invalid accept headers cause internal processing errors (500) when http_codes are defined - [@croeck](https://github.com/croeck).
+* [#917](https://github.com/intridea/grape/pull/917): Use HTTPS for rubygems.org - [@O-I](https://github.com/O-I).
+
 0.10.1 (12/28/2014)
 ===================
 

data/Gemfile

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

data/README.md

@@ -1,6 +1,10 @@
 ![grape logo](grape.png)
 
-[![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) [![Inline docs](http://inch-ci.org/github/intridea/grape.png)](http://inch-ci.org/github/intridea/grape) [![Dependency Status](https://www.versioneye.com/ruby/grape/badge.png)](https://www.versioneye.com/ruby/grape)
+[![Gem Version](http://img.shields.io/gem/v/grape.svg)](http://badge.fury.io/rb/grape)
+[![Build Status](http://img.shields.io/travis/intridea/grape.svg)](https://travis-ci.org/intridea/grape)
+[![Dependency Status](https://gemnasium.com/intridea/grape.svg)](https://gemnasium.com/intridea/grape)
+[![Code Climate](https://codeclimate.com/github/intridea/grape.svg)](https://codeclimate.com/github/intridea/grape)
+[![Inline docs](http://inch-ci.org/github/intridea/grape.svg)](http://inch-ci.org/github/intridea/grape)
 
 ## Table of Contents
 
@@ -86,8 +90,7 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the stable release of Grape, which is be 0.10.1.
-Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
+You're reading the documentation for the stable release of Grape, [0.11.0](https://github.com/intridea/grape/blob/v0.11.0/README.md).
 
 ## Project Resources
 
@@ -269,14 +272,14 @@ Modify `config/routes`:
 mount Twitter::API => '/'
 ```
 
-Additionally, if the version of your Rails is 4.0+ and the application uses the default model layer of ActiveRecord, you will want to use the `hashie_rails` [gem](http://rubygems.org/gems/hashie_rails). This gem disables the security feature of `strong_params` at the model layer, allowing you the use of Grape's own params validation instead.
+Additionally, if the version of your Rails is 4.0+ and the application uses the default model layer of ActiveRecord, you will want to use the `hashie_rails` [gem](https://rubygems.org/gems/hashie_rails). This gem disables the security feature of `strong_params` at the model layer, allowing you the use of Grape's own params validation instead.
 
 ```ruby
 # Gemfile
 gem "hashie_rails"
 ```
 
-See below for additional code that enables reloading of API changes in development.
+See [below](#reloading-api-changes-in-development) for additional code that enables reloading of API changes in development.
 
 ### Modules
 
@@ -479,7 +482,7 @@ post 'users/signup' do
 end
 ````
 
-If we do not specify any params, declared will return an empty hash.
+If we do not specify any params, declared will return an empty Hashie::Mash instance.
 
 **Request**
 
@@ -532,6 +535,12 @@ curl -X POST -H "Content-Type: application/json" localhost:9292/users/signup -d
 }
 ````
 
+Returned hash is a Hashie::Mash instance so you can access parameters via dot notation:
+
+```ruby
+  declared(params).user == declared(params)["user"]
+```
+
 #### Include missing
 
 By default `declared(params)` returns parameters that has `nil` value. If you want to return only the parameters that have any value, you can use the `include_missing` option. By default it is `true`. Let's have the following api:
@@ -739,7 +748,7 @@ end
 #### `allow_blank`
 
 Parameters can be defined as `allow_blank`, ensuring that they contain a value. By default, `requires`
-only validates that a parameter was sent in the request, regardless its value. With `allow_blank`,
+only validates that a parameter was sent in the request, regardless its value. With `allow_blank: false`,
 empty values or whitespace only values are invalid.
 
 `allow_blank` can be combined with both `requires` and `optional`. If the parameter is required, it has to contain
@@ -769,6 +778,25 @@ params do
 end
 ```
 
+Supplying a range to the `:values` option ensures that the parameter is (or parameters are) included in that range (using `Range#include?`).
+
+```ruby
+params do
+  requires :latitude, type: Float, values: -90.0..+90.0
+  requires :longitude, type: Float, values: -180.0..+180.0
+  optional :letters, type: Array[String], values: 'a'..'z'
+end
+```
+
+Note that *both* range endpoints have to be a `#kind_of?` your `:type` option (if you don't supplied the `:type` option, it will be guessed to be equal to the class of the range's first endpoint). So the following is invalid:
+
+```ruby
+params do
+  requires :invalid1, type: Float, values: 0..10 # 0.kind_of?(Float) => false
+  optional :invalid2, values: 0..10.0 # 10.0.kind_of?(0.class) => false
+end
+```
+
 The `:values` option can also be supplied with a `Proc`, evaluated lazily with each request.
 For example, given a status model you may want to restrict by hashtags that you have
 previously defined in the `HashTag` model.
@@ -2132,6 +2160,39 @@ GET /123        # 'Fixnum'
 GET /foo        # 400 error - 'blah is invalid'
 ```
 
+When a callback is defined within a version block, it's only called for the routes defined in that block.
+
+```ruby
+class Test < Grape::API
+  resource :foo do
+    version 'v1', :using => :path do
+      before do
+        @output ||= 'v1-'
+      end
+      get '/' do
+        @output += 'hello'
+      end
+    end
+
+    version 'v2', :using => :path do
+      before do
+        @output ||= 'v2-'
+      end
+      get '/' do
+        @output += 'hello'
+      end
+    end
+  end
+end
+```
+
+The behaviour is then:
+
+```bash
+GET /foo/v1       # 'v1-hello'
+GET /foo/v2       # 'v2-hello'
+```
+
 ## Anchoring
 
 Grape by default anchors all request paths, which means that the request URL
@@ -2184,7 +2245,7 @@ class API < Grape::API
     end
   end
 
-  get :remopte_ip do
+  get :remote_ip do
     { ip: client_ip }
   end
 end
@@ -2198,6 +2259,8 @@ You can test a Grape API with RSpec by making HTTP requests and examining the re
 
 Use `rack-test` and define your API as `app`.
 
+#### RSpec
+
 ```ruby
 require 'spec_helper'
 
@@ -2227,8 +2290,36 @@ describe Twitter::API do
 end
 ```
 
+#### MiniTest
+
+```ruby
+require "test_helper"
+
+class Twitter::APITest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Twitter::API
+  end
+
+  def test_get_api_statuses_public_timeline_returns_an_empty_array_of_statuses
+    get "/api/statuses/public_timeline"
+    assert last_response.ok?
+    assert_equal JSON.parse(last_response.body), []
+  end
+
+  def test_get_api_statuses_id_returns_a_status_by_id
+    status = Status.create!
+    get "/api/statuses/#{status.id}"
+    assert_equal last_response.body, status.to_json
+  end
+end
+```
+
 ### Writing Tests with Rails
 
+#### RSpec
+
 ```ruby
 describe Twitter::API do
   describe "GET /api/statuses/public_timeline" do
@@ -2257,6 +2348,30 @@ RSpec.configure do |config|
 end
 ```
 
+#### MiniTest
+
+```ruby
+class Twitter::APITest < ActiveSupport::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Rails.application
+  end
+
+  test "GET /api/statuses/public_timeline returns an empty array of statuses" do
+    get "/api/statuses/public_timeline"
+    assert last_response.ok?
+    assert_equal JSON.parse(last_response.body), []
+  end
+
+  test "GET /api/statuses/:id returns a status by id" do
+    status = Status.create!
+    get "/api/statuses/#{status.id}"
+    assert_equal last_response.body, status.to_json
+  end
+end
+```
+
 ### Stubbing Helpers
 
 Because helpers are mixed in based on the context when an endpoint is defined, it can
@@ -2268,7 +2383,7 @@ request.
 describe 'an endpoint that needs helpers stubbed' do
   before do
     Grape::Endpoint.before_each do |endpoint|
-      endpoint.stub(:helper_name).and_return('desired_value')
+      allow(endpoint).to receive(:helper_name).and_return('desired_value')
     end
   end
 

data/UPGRADING.md

@@ -1,6 +1,39 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 0.11.0
+
+#### Added Rack 1.6.0 Support
+
+Grape now supports, but doesn't require Rack 1.6.0. If you encounter an issue with parsing requests larger than 128KB, explictly require Rack 1.6.0 in your Gemfile.
+
+```ruby
+gem 'rack', '~> 1.6.0'
+```
+
+See [#559](https://github.com/intridea/grape/issues/559) for more information.
+
+#### Removed route_info
+
+Key route_info is excluded from params.
+
+See [#879](https://github.com/intridea/grape/pull/879) for more information.
+
+
+#### Fix callbacks within a version block
+
+Callbacks defined in a version block are only called for the routes defined in that block. This was a regression introduced in Grape 0.10.0, and is fixed in this version.
+
+See [#901](https://github.com/intridea/grape/pull/901) for more information.
+
+
+#### Make type of group of parameters required
+
+Groups of parameters now require their type to be set explicitly as Array or Hash.
+Not setting the type now results in MissingGroupTypeError, unsupported type will raise UnsupportedTypeError.
+
+See [#886](https://github.com/intridea/grape/pull/886) for more information.
+
 ### Upgrading to >= 0.10.1
 
 #### Changes to `declared(params, include_missing: false)`
@@ -217,6 +250,39 @@ end
 
 See [#801](https://github.com/intridea/grape/issues/801) for more information.
 
+#### Changes to version
+
+If version is used with a block, the callbacks defined within that version block are not scoped to that individual block. In other words, the callback would be inherited by all versions blocks that follow the first one e.g
+
+```ruby
+class API < Grape::API
+  resource :foo do
+    version 'v1', :using => :path do
+      before do
+        @output ||= 'hello1'
+      end
+      get '/' do
+        @output += '-v1'
+      end
+    end
+
+    version 'v2', :using => :path do
+      before do
+        @output ||= 'hello2'
+      end
+      get '/:id' do
+        @output += '-v2'
+      end
+    end
+  end
+end
+```
+
+when making a API call `GET /foo/v2/1`, the API would set instance variable `@output` to `hello1-v2`
+
+See [#898](https://github.com/intridea/grape/issues/898) for more information.
+
+
 ### Upgrading to >= 0.9.0
 
 #### Changes in Authentication

data/gemfiles/rails_3.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'rails', '3.2.19'
 

data/gemfiles/rails_4.gemfile

@@ -1,6 +1,6 @@
 # This file was generated by Appraisal
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'rails', '4.1.6'
 

data/lib/grape.rb

@@ -55,6 +55,10 @@ module Grape
     autoload :UnknownOptions,                 'grape/exceptions/unknown_options'
     autoload :InvalidWithOptionForRepresent,  'grape/exceptions/invalid_with_option_for_represent'
     autoload :IncompatibleOptionValues,       'grape/exceptions/incompatible_option_values'
+    autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
+    autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
+    autoload :InvalidMessageBody,             'grape/exceptions/invalid_message_body'
+    autoload :InvalidAcceptHeader,            'grape/exceptions/invalid_accept_header'
   end
 
   module ErrorFormatter

data/lib/grape/api.rb

@@ -53,11 +53,7 @@ module Grape
       protected
 
       def prepare_routes
-        routes = []
-        endpoints.each do |endpoint|
-          routes.concat(endpoint.routes)
-        end
-        routes
+        endpoints.map(&:routes).flatten
       end
 
       # Execute first the provided block, then each of the

data/lib/grape/dsl/inside_route.rb

@@ -18,6 +18,7 @@ module Grape
       def declared(params, options = {}, declared_params = nil)
         options[:include_missing] = true unless options.key?(:include_missing)
         options[:include_parent_namespaces] = true unless options.key?(:include_parent_namespaces)
+
         if declared_params.nil?
           declared_params = (!options[:include_parent_namespaces] ? route_setting(:declared_params) :
               (route_setting(:saved_declared_params) || [])).flatten(1) || []
@@ -32,7 +33,7 @@ module Grape
             declared(param || {}, options, declared_params)
           end
         else
-          declared_params.inject({}) do |hash, key|
+          declared_params.inject(Hashie::Mash.new) do |hash, key|
             key = { key => nil } unless key.is_a? Hash
 
             key.each_pair do |parent, children|

data/lib/grape/dsl/parameters.rb

@@ -21,9 +21,10 @@ module Grape
       def requires(*attrs, &block)
         orig_attrs = attrs.clone
 
-        opts = attrs.last.is_a?(Hash) ? attrs.pop : nil
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+        opts.merge!(presence: true)
 
-        if opts && opts[:using]
+        if opts[:using]
           require_required_and_optional_fields(attrs.first, opts)
         else
           validate_attributes(attrs, opts, &block)
@@ -34,15 +35,25 @@ module Grape
       end
 
       def optional(*attrs, &block)
-        orig_attrs = attrs
+        orig_attrs = attrs.clone
+
+        opts = attrs.last.is_a?(Hash) ? attrs.pop : {}
+        type = opts[:type]
+
+        # check type for optional parameter group
+        if attrs && block_given?
+          fail Grape::Exceptions::MissingGroupTypeError.new if type.nil?
+          fail Grape::Exceptions::UnsupportedGroupTypeError.new unless [Array, Hash].include?(type)
+        end
 
-        validations = {}
-        validations.merge!(attrs.pop) if attrs.last.is_a?(Hash)
-        validations[:type] ||= Array if block_given?
-        validates(attrs, validations)
+        if opts[:using]
+          require_optional_fields(attrs.first, opts)
+        else
+          validate_attributes(attrs, opts, &block)
 
-        block_given? ? new_scope(orig_attrs, true, &block) :
-            push_declared_params(attrs)
+          block_given? ? new_scope(orig_attrs, true, &block) :
+              push_declared_params(attrs)
+        end
       end
 
       def mutually_exclusive(*attrs)