grape 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5943237e37e943a5a4e1d42bc6345f3af0e56509864050c7c12ba20b55d1bfb7
-  data.tar.gz: 3221d07199e081a570a99fcfe42706d9a4934e8e34054071992f3a6f84a75844
+  metadata.gz: 8934b2070d7c44a7100315712c05ee9e76eff602290b30f475f6e2e324c5392c
+  data.tar.gz: 0d618a852be97bf103c7f783702342b030440834fedd725b4e6a90e03a8b0556
 SHA512:
-  metadata.gz: 907e9a73f79bcd972ffc723215e824586875f6d10f6118ec591834a079def3aba630570c1ec3798e6e98b624b2c00e9523c4ad52821ea536873c837964cb2627
-  data.tar.gz: 81af4b1f525ccb23ea9c7c6975099ff37283ffafac37cbd7a43c8cc93e06b344555464554859569b7ad573960e4dca11b428f7d5b96346eba2c7361c6beb526f
+  metadata.gz: f11c651eb7dea86dd45065c04cdebcbb2635cf8136536850b245d4ad94eac921a4218f191cc5f523968cdc4708ee7ede49fce17de21b97b96edcd82426c06795
+  data.tar.gz: 8266b0bf359c1ed96b7aacd9bbecacfe6ef5f406b94d54a1a9c6dfdbf18d95967f8c853f13dfab642631e261f81893bcc5323e83c0d27a04226bdc03d7b19381

data/CHANGELOG.md

@@ -1,18 +1,32 @@
-### 1.2.5 (Next)
+### 1.2.5 (2019/12/01)
 
 #### Features
 
-* Your contribution here.
+* [#1931](https://github.com/ruby-grape/grape/pull/1931): Introduces LazyBlock to generate expressions that will executed at mount time - [@myxoh](https://github.com/myxoh).
+* [#1918](https://github.com/ruby-grape/grape/pull/1918): Helper methods to access controller context from middleware - [@NikolayRys](https://github.com/NikolayRys).
+* [#1915](https://github.com/ruby-grape/grape/pull/1915): Micro optimizations in allocating hashes and arrays - [@dnesteryuk](https://github.com/dnesteryuk).
+* [#1904](https://github.com/ruby-grape/grape/pull/1904): Allows Grape to load files on startup rather than on the first call - [@myxoh](https://github.com/myxoh).
+* [#1907](https://github.com/ruby-grape/grape/pull/1907): Adds outside configuration to Grape with `configure` - [@unleashy](https://github.com/unleashy).
+* [#1914](https://github.com/ruby-grape/grape/pull/1914): Run specs in random order - [@splattael](https://github.com/splattael).
 
 #### Fixes
 
-* Your contribution here.
+* [#1917](https://github.com/ruby-grape/grape/pull/1917): Update access to rack constant - [@NikolayRys](https://github.com/NikolayRys).
+* [#1916](https://github.com/ruby-grape/grape/pull/1916): Drop old appraisals - [@NikolayRys](https://github.com/NikolayRys).
+* [#1911](https://github.com/ruby-grape/grape/pull/1911): Make sure `Grape::Valiations::AtLeastOneOfValidator` properly treats nested params in errors - [@dnesteryuk](https://github.com/dnesteryuk).
+* [#1893](https://github.com/ruby-grape/grape/pull/1893): Allows `Grape::API` to behave like a Rack::app in some instances where it was misbehaving - [@myxoh](https://github.com/myxoh).
+* [#1898](https://github.com/ruby-grape/grape/pull/1898): Refactor `ValidatorFactory` to improve memory allocation - [@Bhacaz](https://github.com/Bhacaz).
+* [#1900](https://github.com/ruby-grape/grape/pull/1900): Define boolean for `Grape::Api::Instance` - [@Bhacaz](https://github.com/Bhacaz).
+* [#1903](https://github.com/ruby-grape/grape/pull/1903): Allow nested params renaming (Hash/Array) - [@bikolya](https://github.com/bikolya).
+* [#1913](https://github.com/ruby-grape/grape/pull/1913): Fix multiple params validators to return correct messages for nested params - [@bikolya](https://github.com/bikolya).
+* [#1926](https://github.com/ruby-grape/grape/pull/1926): Fixes configuration within given or mounted blocks - [@myxoh](https://github.com/myxoh).
+* [#1937](https://github.com/ruby-grape/grape/pull/1937): Fix bloat in released gem - [@dblock](https://github.com/dblock).
 
 ### 1.2.4 (2019/06/13)
 
 #### Features
 
-* [#1888](https://github.com/ruby-grape/grape/pull/1888): Makes the `configuration` hash widly available - [@myxoh](https://github.com/myxoh).
+* [#1888](https://github.com/ruby-grape/grape/pull/1888): Makes the `configuration` hash widely available - [@myxoh](https://github.com/myxoh).
 * [#1864](https://github.com/ruby-grape/grape/pull/1864): Adds `finally` on the API - [@myxoh](https://github.com/myxoh).
 * [#1869](https://github.com/ruby-grape/grape/pull/1869): Fix issue with empty headers after `error!` method call - [@anaumov](https://github.com/anaumov).
 

data/README.md

@@ -15,6 +15,7 @@
 - [Installation](#installation)
 - [Basic Usage](#basic-usage)
 - [Mounting](#mounting)
+  - [All](#all)
   - [Rack](#rack)
   - [ActiveRecord without Rails](#activerecord-without-rails)
   - [Alongside Sinatra (or other frameworks)](#alongside-sinatra-or-other-frameworks)
@@ -153,9 +154,8 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the next release of Grape, which should be **1.2.5**.
+You're reading the documentation for the stable release of Grape, **1.2.5**.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
-The current stable release is [1.2.4](https://github.com/ruby-grape/grape/blob/v1.2.4/README.md).
 
 ## Project Resources
 
@@ -213,7 +213,7 @@ module Twitter
 
       desc 'Return a status.'
       params do
-        requires :id, type: Integer, desc: 'Status id.'
+        requires :id, type: Integer, desc: 'Status ID.'
       end
       route_param :id do
         get do
@@ -261,6 +261,17 @@ end
 
 ## Mounting
 
+### All
+
+
+By default Grape will compile the routes on the first route, it is possible to pre-load routes using the `compile!` method.
+
+```ruby
+Twitter::API.compile!
+```
+
+This can be added to your `config.ru` (if using rackup), `application.rb` (if using rails), or any file that loads your server.
+
 ### Rack
 
 The above sample creates a Rack application that can be run from a rackup `config.ru` file
@@ -270,6 +281,13 @@ with `rackup`:
 run Twitter::API
 ```
 
+(With pre-loading you can use)
+
+```ruby
+Twitter::API.compile!
+run Twitter::API
+```
+
 And would respond to the following routes:
 
     GET /api/statuses/public_timeline
@@ -437,6 +455,15 @@ class Comment::API < Grape::API
 end
 ```
 
+Note that if you're passing a hash as the first parameter to `mount`, you will need to explicitly put `()` around parameters:
+```ruby
+# good
+mount({ ::Some::Api => '/some/api' }, with: { condition: true })
+
+# bad
+mount ::Some::Api => '/some/api', with: { condition: true }
+```
+
 You can access `configuration` on the class (to use as dynamic attributes), inside blocks (like namespace)
 
 If you want logic happening given on an `configuration`, you can use the helper `given`.
@@ -466,6 +493,42 @@ class ConditionalEndpoint::API < Grape::API
 end
 ```
 
+More complex results can be achieved by using `mounted` as an expression within which the `configuration` is already evaluated as a Hash.
+
+```ruby
+class ExpressionEndpointAPI < Grape::API
+  get(mounted { configuration[:route_name] || 'default_name' }) do
+    # some logic
+  end
+end
+```
+
+```ruby
+class BasicAPI < Grape::API
+  desc 'Statuses index' do
+    params: mounted { configuration[:entity] || API::Entities::Status }.documentation
+  end
+  params do
+    requires :all, using: mounted { configuration[:entity] || API::Entities::Status }.documentation
+  end
+  get '/statuses' do
+    statuses = Status.all
+    type = current_user.admin? ? :full : :default
+    present statuses, with: mounted { configuration[:entity] || API::Entities::Status }, type: type
+  end
+end
+
+class V1 < Grape::API
+  version 'v1'
+  mount BasicAPI, with: { entity: mounted { configuration[:entity] || API::Enitities::Status } }
+end
+
+class V2 < Grape::API
+  version 'v2'
+  mount BasicAPI, with: { entity: mounted { configuration[:entity] || API::Enitities::V2::Status } }
+end
+```
+
 ## Versioning
 
 There are four strategies in which clients can reach your API's endpoints: `:path`,
@@ -612,6 +675,17 @@ Grape.configure do |config|
 end
 ```
 
+You can also configure a single API:
+
+```ruby
+API.configure do |config|
+  config[key] = value
+end
+```
+
+This will be available inside the API with `configuration`, as if it were
+[mount configuration](#mount-configuration).
+
 ## Parameters
 
 Request parameters are available through the `params` hash object. This includes `GET`, `POST`
@@ -1886,6 +1960,56 @@ error! 'Unauthorized', 401, 'X-Error-Detail' => 'Invalid token.'
 
 ## Routes
 
+To define routes you can use the `route` method or the shorthands for the HTTP verbs. To define a route that accepts any route set to `:any`.
+Parts of the path that are denoted with a colon will be interpreted as route parameters.
+
+```ruby
+route :get, 'status' do
+end
+
+# is the same as
+
+get 'status' do
+end
+
+# is the same as
+
+get :status do
+end
+
+# is NOT the same as
+
+get ':status' do # this makes param[:status] available
+end
+
+# This will make both param[:status_id] and param[:id] available
+
+get 'statuses/:status_id/reviews/:id' do
+end
+```
+
+To declare a namespace that prefixes all routes within, use the `namespace` method. `group`, `resource`, `resources` and `segment` are aliases to this method. Any endpoints within will share their parent context as well as any configuration done in the namespace context.
+
+The `route_param` method is a convenient method for defining a parameter route segment. If you define a type, it will add a validation for this parameter.
+
+```ruby
+route_param :id, type: Integer do
+  get 'status' do
+  end
+end
+
+# is the same as
+
+namespace ':id' do
+  params do
+    requires :id, type: Integer
+  end
+
+  get 'status' do
+  end
+end
+```
+
 Optionally, you can define requirements for your named route parameters using regular
 expressions on namespace or endpoint. The route will match only if all requirements are met.
 
@@ -2467,6 +2591,17 @@ class Twitter::API < Grape::API
 end
 ```
 
+Inside the `rescue_from` block, the environment of the original controller method(`.self` receiver) is accessible through the `#context` method.
+
+```ruby
+class Twitter::API < Grape::API
+  rescue_from :all do |e|
+    user_id = context.params[:user_id]
+    error!("error for #{user_id}")
+  end
+end
+```
+
 #### Rescuing exceptions inside namespaces
 
 You could put `rescue_from` clauses inside a namespace and they will take precedence over ones
@@ -2489,7 +2624,7 @@ class Twitter::API < Grape::API
 end
 ```
 
-Here `'inner'` will be result of handling occured `ArgumentError`.
+Here `'inner'` will be result of handling occurred `ArgumentError`.
 
 #### Unrescuable Exceptions
 
@@ -3091,6 +3226,8 @@ end
 
 Use [Doorkeeper](https://github.com/doorkeeper-gem/doorkeeper), [warden-oauth2](https://github.com/opperator/warden-oauth2) or [rack-oauth2](https://github.com/nov/rack-oauth2) for OAuth2 support.
 
+You can access the controller params, headers, and helpers through the context with the `#context` method inside any auth middleware inherited from `Grape::Middlware::Auth::Base`.
+
 ## Describing and Inspecting an API
 
 Grape routes can be reflected at runtime. This can notably be useful for generating documentation.
@@ -3403,6 +3540,8 @@ class API < Grape::API
 end
 ```
 
+You can access the controller params, headers, and helpers through the context with the `#context` method inside any middleware inherited from `Grape::Middlware::Base`.
+
 ### Rails Middleware
 
 Note that when you're using Grape mounted on Rails you don't have to use Rails middleware because it's already included into your middleware stack.
@@ -3711,6 +3850,7 @@ Grape integrates with following third-party tools:
 * **Librato Metrics** - [grape-librato](https://github.com/seanmoon/grape-librato) gem
 * **[Skylight](https://www.skylight.io/)** - [skylight](https://github.com/skylightio/skylight-ruby) gem, [documentation](https://docs.skylight.io/grape/)
 * **[AppSignal](https://www.appsignal.com)** - [appsignal-ruby](https://github.com/appsignal/appsignal-ruby) gem, [documentation](http://docs.appsignal.com/getting-started/supported-frameworks.html#grape)
+* **[ElasticAPM](https://www.elastic.co/products/apm) - [elastic-apm](https://github.com/elastic/apm-agent-ruby) gem, [documentation](https://www.elastic.co/guide/en/apm/agent/ruby/3.x/getting-started-rack.html#getting-started-grape)
 
 ## Contributing to Grape
 

data/grape.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'rack-accept'
   s.add_runtime_dependency 'virtus', '>= 1.0.0'
 
-  s.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
+  s.files         = %w[CHANGELOG.md CONTRIBUTING.md README.md grape.png UPGRADING.md LICENSE]
+  s.files        += %w[grape.gemspec]
+  s.files        += Dir['lib/**/*']
   s.test_files    = Dir['spec/**/*']
   s.require_paths = ['lib']
 end

data/lib/grape.rb

@@ -54,106 +54,125 @@ module Grape
 
   module Exceptions
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Validation
-    autoload :ValidationArrayErrors
-    autoload :ValidationErrors
-    autoload :MissingVendorOption
-    autoload :MissingMimeType
-    autoload :MissingOption
-    autoload :InvalidFormatter
-    autoload :InvalidVersionerOption
-    autoload :UnknownValidator
-    autoload :UnknownOptions
-    autoload :UnknownParameter
-    autoload :InvalidWithOptionForRepresent
-    autoload :IncompatibleOptionValues
-    autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
-    autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
-    autoload :InvalidMessageBody
-    autoload :InvalidAcceptHeader
-    autoload :InvalidVersionHeader
-    autoload :MethodNotAllowed
-    autoload :InvalidResponse
+    eager_autoload do
+      autoload :Base
+      autoload :Validation
+      autoload :ValidationArrayErrors
+      autoload :ValidationErrors
+      autoload :MissingVendorOption
+      autoload :MissingMimeType
+      autoload :MissingOption
+      autoload :InvalidFormatter
+      autoload :InvalidVersionerOption
+      autoload :UnknownValidator
+      autoload :UnknownOptions
+      autoload :UnknownParameter
+      autoload :InvalidWithOptionForRepresent
+      autoload :IncompatibleOptionValues
+      autoload :MissingGroupTypeError,          'grape/exceptions/missing_group_type'
+      autoload :UnsupportedGroupTypeError,      'grape/exceptions/unsupported_group_type'
+      autoload :InvalidMessageBody
+      autoload :InvalidAcceptHeader
+      autoload :InvalidVersionHeader
+      autoload :MethodNotAllowed
+      autoload :InvalidResponse
+    end
   end
 
   module Extensions
     extend ::ActiveSupport::Autoload
-
-    autoload :DeepMergeableHash
-    autoload :DeepSymbolizeHash
-    autoload :DeepHashWithIndifferentAccess
-    autoload :Hash
-
+    eager_autoload do
+      autoload :DeepMergeableHash
+      autoload :DeepSymbolizeHash
+      autoload :DeepHashWithIndifferentAccess
+      autoload :Hash
+    end
     module ActiveSupport
       extend ::ActiveSupport::Autoload
-
-      autoload :HashWithIndifferentAccess
+      eager_autoload do
+        autoload :HashWithIndifferentAccess
+      end
     end
 
     module Hashie
       extend ::ActiveSupport::Autoload
-
-      autoload :Mash
+      eager_autoload do
+        autoload :Mash
+      end
     end
   end
 
   module Middleware
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Versioner
-    autoload :Formatter
-    autoload :Error
-    autoload :Globals
-    autoload :Stack
+    eager_autoload do
+      autoload :Base
+      autoload :Versioner
+      autoload :Formatter
+      autoload :Error
+      autoload :Globals
+      autoload :Stack
+      autoload :Helpers
+    end
 
     module Auth
       extend ::ActiveSupport::Autoload
-      autoload :Base
-      autoload :DSL
-      autoload :StrategyInfo
-      autoload :Strategies
+      eager_autoload do
+        autoload :Base
+        autoload :DSL
+        autoload :StrategyInfo
+        autoload :Strategies
+      end
     end
 
     module Versioner
       extend ::ActiveSupport::Autoload
-      autoload :Path
-      autoload :Header
-      autoload :Param
-      autoload :AcceptVersionHeader
+      eager_autoload do
+        autoload :Path
+        autoload :Header
+        autoload :Param
+        autoload :AcceptVersionHeader
+      end
     end
   end
 
   module Util
     extend ::ActiveSupport::Autoload
-    autoload :InheritableValues
-    autoload :StackableValues
-    autoload :ReverseStackableValues
-    autoload :InheritableSetting
-    autoload :StrictHashConfiguration
-    autoload :Registrable
+    eager_autoload do
+      autoload :InheritableValues
+      autoload :StackableValues
+      autoload :ReverseStackableValues
+      autoload :InheritableSetting
+      autoload :StrictHashConfiguration
+      autoload :Registrable
+    end
   end
 
   module ErrorFormatter
     extend ::ActiveSupport::Autoload
-    autoload :Base
-    autoload :Json
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Base
+      autoload :Json
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Formatter
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :SerializableHash
-    autoload :Txt
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :SerializableHash
+      autoload :Txt
+      autoload :Xml
+    end
   end
 
   module Parser
     extend ::ActiveSupport::Autoload
-    autoload :Json
-    autoload :Xml
+    eager_autoload do
+      autoload :Json
+      autoload :Xml
+    end
   end
 
   module DSL
@@ -177,29 +196,38 @@ module Grape
 
   class API
     extend ::ActiveSupport::Autoload
-    autoload :Helpers
+    eager_autoload do
+      autoload :Helpers
+    end
   end
 
   module Presenters
     extend ::ActiveSupport::Autoload
-    autoload :Presenter
+    eager_autoload do
+      autoload :Presenter
+    end
   end
 
   module ServeFile
     extend ::ActiveSupport::Autoload
-    autoload :FileResponse
-    autoload :FileBody
-    autoload :SendfileResponse
+    eager_autoload do
+      autoload :FileResponse
+      autoload :FileBody
+      autoload :SendfileResponse
+    end
   end
 end
 
 require 'grape/config'
 require 'grape/util/content_types'
 require 'grape/util/lazy_value'
+require 'grape/util/lazy_block'
 require 'grape/util/endpoint_configuration'
 
 require 'grape/validations/validators/base'
 require 'grape/validations/attributes_iterator'
+require 'grape/validations/single_attribute_iterator'
+require 'grape/validations/multiple_attributes_iterator'
 require 'grape/validations/validators/allow_blank'
 require 'grape/validations/validators/as'
 require 'grape/validations/validators/at_least_one_of'