grape 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cce57801c840dd9a64018350c6dd1eb955fc7b70
-  data.tar.gz: e09089d477bba3cf9ff2bd53a5f164ecffefe494
+  metadata.gz: 219bc6e20332454502d7e7955db53424e5828880
+  data.tar.gz: 69cdeb3133100f91ebb0fd32e2ee1e52a130defc
 SHA512:
-  metadata.gz: 1a7d4e52cdc91c6ee4f623b4a14d986b60a0f574b2885392487ff22993c6465c923165e9214382e9465265f8e1240519be0b95fec0c19c7d3f4fc603827edd1c
-  data.tar.gz: 7ec02b2a4bcc083f6034c681cf82356d97e6d3aa65ad2d6663fe2c437c5e0da7f344371f003391ff9c838b7b190c9415e5abe986f9449670a76ab545e0e7aa5d
+  metadata.gz: 591cb91662a9b1a5f93889103eca65ed73c2979490d36c01f47f7cfabf926b5988693bfc4502defb394236003669fe60d2cb42b3005778f9be4c2c737975afce
+  data.tar.gz: ca855e03121beca28d6f0888e843c93e118f38acce88870732f9ec5e3073382d76bde1eb831236f64f6fe04fa7681022a4a677553a89abecc3d54a36ae05153a

data/.rubocop_todo.yml

@@ -1,63 +1,53 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-16 11:52:50 -0500 using RuboCop version 0.28.0.
+# on 2015-06-04 09:15:17 -0400 using RuboCop version 0.31.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 29
-# Cop supports --auto-correct.
-Lint/UnusedBlockArgument:
-  Enabled: false
-
-# Offense count: 26
-# Cop supports --auto-correct.
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-# Offense count: 35
+# Offense count: 37
 Metrics/AbcSize:
-  Max: 50
+  Max: 48
 
-# Offense count: 1
+# Offense count: 2
 Metrics/BlockNesting:
   Max: 4
 
 # Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 243
+  Max: 246
 
-# Offense count: 15
+# Offense count: 23
 Metrics/CyclomaticComplexity:
-  Max: 19
+  Max: 20
 
-# Offense count: 545
+# Offense count: 675
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 198
 
-# Offense count: 42
+# Offense count: 44
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 35
 
-# Offense count: 13
+# Offense count: 8
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 243
+
+# Offense count: 17
 Metrics/PerceivedComplexity:
-  Max: 21
+  Max: 22
 
 # Offense count: 26
 # Cop supports --auto-correct.
-Style/Blocks:
+# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+Style/BlockDelimiters:
   Enabled: false
 
-# Offense count: 6
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/ClassCheck:
-  Enabled: false
-
-# Offense count: 157
+# Offense count: 174
 Style/Documentation:
   Enabled: false
 
@@ -69,39 +59,18 @@ Style/DoubleNegation:
 Style/EachWithObject:
   Enabled: false
 
-# Offense count: 1
-Style/EmptyElse:
-  Enabled: false
-
-# Offense count: 14
+# Offense count: 15
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Enabled: false
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/HashSyntax:
-  Enabled: false
-
-# Offense count: 15
+# Offense count: 4
 # Cop supports --auto-correct.
-Style/IndentArray:
-  Enabled: false
-
-# Offense count: 18
 Style/Lambda:
   Enabled: false
 
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
-Style/Next:
-  Enabled: false
-
 # Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
+Style/MultilineTernaryOperator:
   Enabled: false
 
 # Offense count: 3
@@ -109,33 +78,7 @@ Style/PercentLiteralDelimiters:
 Style/PredicateName:
   Enabled: false
 
-# Offense count: 9
+# Offense count: 13
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/RaiseArgs:
   Enabled: false
-
-# Offense count: 4
-# Configuration parameters: MaxSlashes.
-Style/RegexpLiteral:
-  Enabled: false
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceBeforeBlockBraces:
-  Enabled: false
-
-# Offense count: 12
-# Cop supports --auto-correct.
-Style/SpaceBeforeSemicolon:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/UnneededPercentQ:
-  Enabled: false

data/.travis.yml

@@ -1,9 +1,9 @@
 language: ruby
 
 rvm:
+  - 2.2
   - 2.1
   - 2.0.0
-  - 1.9.3
   - rbx-2.2.10
   - jruby-19mode
   - ruby-head

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+0.12.0 (6/18/2015)
+==================
+
+#### Features
+
+* [#995](https://github.com/intridea/grape/issues/995): Added support for coercion to Set or Set[Other] - [@jordansexton](https://github.com/jordansexton) [@u2](https://github.com/u2).
+* [#980](https://github.com/intridea/grape/issues/980): Grape is now eager-loaded - [@u2](https://github.com/u2).
+* [#956](https://github.com/intridea/grape/issues/956): Support `present` with `Grape::Presenters::Presenter`  - [@u2](https://github.com/u2).
+* [#974](https://github.com/intridea/grape/pull/974): Added `error!` to `rescue_from` blocks - [@whatasunnyday](https://github.com/whatasunnyday).
+* [#950](https://github.com/intridea/grape/pull/950): Status method can now accept one of Rack::Utils status code symbols (:ok, :found, :bad_request, etc.) - [@dabrorius](https://github.com/dabrorius).
+* [#952](https://github.com/intridea/grape/pull/952): Status method now raises error when called with invalid status code - [@dabrorius](https://github.com/dabrorius).
+* [#957](https://github.com/intridea/grape/pull/957): Regexp validator now supports `allow_blank`, `nil` value behavior changed - [@calfzhou](https://giihub.com/calfzhou).
+* [#962](https://github.com/intridea/grape/pull/962): The `default` attribute with `false` value is documented now - [@ajvondrak](https://github.com/ajvondrak).
+* [#1026](https://github.com/intridea/grape/pull/1026): Added `file` method, explicitly setting a file-like response object - [@dblock](https://github.com/dblock).
+
+#### Fixes
+
+* [#994](https://github.com/intridea/grape/pull/994): Fixed optional Array params default to Hash - [@u2](https://github.com/u2).
+* [#988](https://github.com/intridea/grape/pull/988): Fixed duplicate identical endpoints - [@u2](https://github.com/u2).
+* [#936](https://github.com/intridea/grape/pull/936): Fixed default params processing for optional groups - [@dm1try](https://github.com/dm1try).
+* [#942](https://github.com/intridea/grape/pull/942): Fixed forced presence for optional params when based on a reused entity that was also required in another context - [@croeck](https://github.com/croeck).
+* [#1001](https://github.com/intridea/grape/pull/1001): Fixed calling endpoint with specified format with format in its path - [@hodak](https://github.com/hodak).
+* [#1005](https://github.com/intridea/grape/pull/1005): Fixed the Grape::Middleware::Globals - [@urkle](https://github.com/urkle).
+* [#1012](https://github.com/intridea/grape/pull/1012): Fixed `allow_blank: false` with a Boolean value of `false` - [@mfunaro](https://github.com/mfunaro).
+* [#1023](https://github.com/intridea/grape/issues/1023): Fixes unexpected beahvior with `present` and an object that responds to `merge` but isn't a Hash - [@dblock](https://github.com/dblock).
+* [#1017](https://github.com/intridea/grape/pull/1017): Fixed `undefined method stringify_keys` with nested mutual exclusive params - [@quickpay](https://github.com/quickpay).
+
 0.11.0 (2/23/2015)
 ==================
 

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'rubocop', '~> 0.28.0'
+  gem 'rubocop', '~> 0.31.0'
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-rubocop'

data/Guardfile

@@ -5,6 +5,6 @@ guard :rspec, all_on_start: true, cmd: 'bundle exec rspec' do
 end
 
 guard :rubocop do
-  watch(%r{.+\.rb$})
+  watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Michael Bleigh and Intridea, Inc.
+Copyright (c) 2010-2015 Michael Bleigh and Intridea, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -90,7 +90,8 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-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).
+You're reading the documentation for the stable release of Grape 0.12.0.
+Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 ## Project Resources
 
@@ -272,11 +273,11 @@ 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](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.
+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-forbidden_attributes gem](https://github.com/Maxim-Filimonov/hashie-forbidden_attributes). 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"
+gem "hashie-forbidden_attributes"
 ```
 
 See [below](#reloading-api-changes-in-development) for additional code that enables reloading of API changes in development.
@@ -314,7 +315,7 @@ version 'v1', using: :path
 
 Using this versioning strategy, clients should pass the desired version in the URL.
 
-    curl -H http://localhost:9292/v1/statuses/public_timeline
+    curl http://localhost:9292/v1/statuses/public_timeline
 
 ### Header
 
@@ -350,6 +351,14 @@ post do
 end
 ```
 
+You can also use one of status codes symbols that are provided by [Rack utils](http://www.rubydoc.info/github/rack/rack/Rack/Utils#HTTP_STATUS_CODES-constant)
+
+```ruby
+post do
+  status :no_content
+end
+```
+
 ### Accept-Version Header
 
 ```ruby
@@ -374,7 +383,7 @@ version 'v1', using: :param
 Using this versioning strategy, clients should pass the desired version as a request parameter,
 either in the URL query string or in the request body.
 
-    curl -H http://localhost:9292/statuses/public_timeline?apiver=v1
+    curl http://localhost:9292/statuses/public_timeline?apiver=v1
 
 The default name for the query parameter is 'apiver' but can be specified using the `:parameter` option.
 
@@ -382,7 +391,7 @@ The default name for the query parameter is 'apiver' but can be specified using
 version 'v1', using: :param, parameter: "v"
 ```
 
-    curl -H http://localhost:9292/statuses/public_timeline?v=v1
+    curl http://localhost:9292/statuses/public_timeline?v=v1
 
 
 ## Describing Methods
@@ -451,7 +460,7 @@ Multipart POSTs and PUTs are supported as well.
 The request:
 
 ```
-curl --form image_file=@image.jpg http://localhost:9292/upload
+curl --form image_file='@image.jpg;type=image/jpg' http://localhost:9292/upload
 ```
 
 The Grape endpoint:
@@ -810,7 +819,7 @@ end
 #### `regexp`
 
 Parameters can be restricted to match a specific regular expression with the `:regexp` option. If the value
-is nil or does not match the regular expression an error will be returned. Note that this is true for both `requires`
+does not match the regular expression an error will be returned. Note that this is true for both `requires`
 and `optional` parameters.
 
 ```ruby
@@ -819,6 +828,13 @@ params do
 end
 ```
 
+The validator will pass if the parameter was sent without value. To ensure that the parameter contains a value, use `allow_blank: false`.
+
+```ruby
+params do
+  requires :email, allow_blank: false, regexp: /.+@.+/
+end
+```
 
 #### `mutually_exclusive`
 
@@ -963,7 +979,7 @@ end
 class AlphaNumeric < Grape::Validations::Base
   def validate_param!(attr_name, params)
     unless params[attr_name] =~ /^[[:alnum:]]+$/
-      raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must consist of alpha-numeric characters"
+      fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must consist of alpha-numeric characters"
     end
   end
 end
@@ -981,7 +997,7 @@ You can also create custom classes that take parameters.
 class Length < Grape::Validations::Base
   def validate_param!(attr_name, params)
     unless params[attr_name].length <= @option
-      raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
+      fail Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be at the most #{@option} characters long"
     end
   end
 end
@@ -1014,7 +1030,7 @@ You can rescue a `Grape::Exceptions::ValidationErrors` and respond with a custom
 ```ruby
 format :json
 subject.rescue_from Grape::Exceptions::ValidationErrors do |e|
-  rack_response e.to_json, 400
+  error! e, 400
 end
 ```
 
@@ -1425,17 +1441,29 @@ class Twitter::API < Grape::API
 end
 ```
 
-You can rescue all exceptions with a code block. The `error_response` wrapper
+You can rescue all exceptions with a code block. The `error!` wrapper
 automatically sets the default error code and content-type.
 
 ```ruby
 class Twitter::API < Grape::API
   rescue_from :all do |e|
-    error_response({ message: "rescued from #{e.class.name}" })
+    error!("rescued from #{e.class.name}")
   end
 end
 ```
 
+Optionally, you can set the format, status code and headers.
+
+```ruby
+class Twitter::API < Grape::API
+  format :json
+  rescue_from :all do |e|
+    error!({ error: "Server error.", 500, { 'Content-Type' => 'text/error' } })
+  end
+end
+```
+
+
 You can also rescue specific exceptions with a code block and handle the Rack
 response at the lowest level.
 
@@ -1452,10 +1480,11 @@ Or rescue specific exceptions.
 ```ruby
 class Twitter::API < Grape::API
   rescue_from ArgumentError do |e|
-    Rack::Response.new([ "ArgumentError: #{e.message}" ], 500).finish
+    error!("ArgumentError: #{e.message}")
   end
+
   rescue_from NotImplementedError do |e|
-    Rack::Response.new([ "NotImplementedError: #{e.message}" ], 500).finish
+    error!("NotImplementedError: #{e.message}")
   end
 end
 ```
@@ -1475,10 +1504,10 @@ Then the following `rescue_from` clause will rescue exceptions of type `APIError
 
 ```ruby
 rescue_from APIErrors::ParentError do |e|
-    Rack::Response.new({
+    error!({
       error: "#{e.class} error",
       message: e.message
-      }.to_json, e.status).finish
+    }, e.status)
 end
 ```
 
@@ -1487,11 +1516,11 @@ The code below will rescue exceptions of type `RuntimeError` but _not_ its subcl
 
 ```ruby
 rescue_from RuntimeError, rescue_subclasses: false do |e|
-    Rack::Response.new({
+    error!({
       status: e.status,
       message: e.message,
       errors: e.errors
-      }.to_json, e.status).finish
+    }, e.status)
 end
 ```
 
@@ -1559,6 +1588,8 @@ class API < Grape::API
 end
 ```
 
+For similar to Rails request logging try the [grape_logging](https://github.com/aserafin/grape_logging) gem.
+
 ## API Formats
 
 Your API can declare which content-types to support by using `content_type`. If you do not specify any, Grape will support
@@ -1648,7 +1679,7 @@ end
 ```
 
 You can have your API only respond to a single format with `format`. If you use this, the API will **not** respond to file
-extensions. For example, consider the following API.
+extensions other than specified in `format`. For example, consider the following API.
 
 ```ruby
 class SingleFormatAPI < Grape::API
@@ -1661,7 +1692,8 @@ end
 ```
 
 * `GET /hello` will respond with JSON.
-* `GET /hello.xml`, `GET /hello.json`, `GET /hello.foobar`, or *any* other extension will respond with an HTTP 404 error code.
+* `GET /hello.json` will respond with JSON.
+* `GET /hello.xml`, `GET /hello.foobar`, or *any* other extension will respond with an HTTP 404 error code.
 * `GET /hello?format=xml` will respond with an HTTP 406 error code, because the XML format specified by the request parameter
   is not supported.
 * `GET /hello` with an `Accept: application/xml` header will still respond with JSON, since it could not negotiate a
@@ -1922,6 +1954,31 @@ Grape will automatically detect that there is a `Status::Entity` class and use t
 representative entity. This can still be overridden by using the `:with` option or an explicit
 `represents` call.
 
+You can present `hash` with `Grape::Presenters::Presenter` to keep things consistent.
+
+```ruby
+get '/users' do
+  present { id: 10, name: :dgz }, with: Grape::Presenters::Presenter
+end
+````
+The response will be
+
+```ruby
+{
+  id:   10,
+  name: 'dgz'
+}
+```
+
+It has the same result with
+
+```ruby
+get '/users' do
+  present :id, 10
+  present :name, :dgz
+end
+```
+
 ### Hypermedia and Roar
 
 You can use [Roar](https://github.com/apotonick/roar) to render HAL or Collection+JSON with the help of [grape-roar](https://github.com/dblock/grape-roar), which defines a custom JSON formatter and enables presenting entities with Grape's `present` keyword.
@@ -1951,7 +2008,7 @@ class API < Grape::API
 end
 ```
 
-You can also set the response body explicitly with `body`.
+You can set the response body explicitly with `body`.
 
 ```ruby
 class API < Grape::API
@@ -1965,6 +2022,28 @@ end
 
 Use `body false` to return `204 No Content` without any data or content-type.
 
+You can also set the response to a file-like object with `file`.
+
+```ruby
+class FileStreamer
+  def initialize(file_path)
+    @file_path = file_path
+  end
+
+  def each(&blk)
+    File.open(@file_path, 'rb') do |file|
+      file.each(10, &blk)
+    end
+  end
+end
+
+class API < Grape::API
+  get '/' do
+    file FileStreamer.new('file.bin')
+  end
+end
+```
+
 ## Authentication
 
 ### Basic and Digest Auth
@@ -2253,14 +2332,14 @@ end
 
 ## Writing Tests
 
-You can test a Grape API with RSpec by making HTTP requests and examining the response.
-
 ### Writing Tests with Rack
 
 Use `rack-test` and define your API as `app`.
 
 #### RSpec
 
+You can test a Grape API with RSpec by making HTTP requests and examining the response.
+
 ```ruby
 require 'spec_helper'
 
@@ -2290,12 +2369,34 @@ describe Twitter::API do
 end
 ```
 
+#### Airborne
+
+You can test with other RSpec-based frameworks, including [Airborne](https://github.com/brooklynDev/airborne), which uses `rack-test` to make requests.
+
+```ruby
+require 'airborne'
+
+Airborne.configure do |config|
+  config.rack_app = Twitter::API
+end
+
+describe Twitter::API do
+  describe "GET /api/statuses/:id" do
+    it "returns a status by id" do
+      status = Status.create!
+      get "/api/statuses/#{status.id}"
+      expect_json(status.as_json)
+    end
+  end
+end
+```
+
 #### MiniTest
 
 ```ruby
 require "test_helper"
 
-class Twitter::APITest < MiniTest::Unit::TestCase
+class Twitter::APITest < MiniTest::Test
   include Rack::Test::Methods
 
   def app
@@ -2305,13 +2406,13 @@ class Twitter::APITest < MiniTest::Unit::TestCase
   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), []
+    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
+    assert_equal status.to_json, last_response.body
   end
 end
 ```
@@ -2361,13 +2462,13 @@ class Twitter::APITest < ActiveSupport::TestCase
   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), []
+    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
+    assert_equal status.to_json, last_response.body
   end
 end
 ```
@@ -2457,4 +2558,4 @@ MIT License. See LICENSE for details.
 
 ## Copyright
 
-Copyright (c) 2010-2013 Michael Bleigh, and Intridea, Inc.
+Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.