grape 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4362917201381823e379e97fe0be3964a122a7d56039b34419f811c6cfe3f6e
-  data.tar.gz: 5975d6e356d8487684f9470546e9c3e42027fb4610f879d844f1c9871e614f7e
+  metadata.gz: 98967e931efbc7d185d03dc983f3c1b248178e1e19de4b3179f4ed3fc7971efb
+  data.tar.gz: '009bd8cec6cfb9e2eb18864635b9785a36b1540efc4c838d5995c18b8b9e2b62'
 SHA512:
-  metadata.gz: 61a0080907f18d90106ee479cba0229aee5e3e500b42310e8c7d78a95632c4f580616dcdc10947ec008ae76cef19029a69f184749de6110a54231e688c104aea
-  data.tar.gz: 586400490332bdd096ef8f299f8ace196788268d505b76beb00a969204819940b4b5d2b1159309206c2826186e65302c19cda4f7ea2aec5ecf14109ed29362ba
+  metadata.gz: 7d43afee6bb67478c37c818bc7c14e0e39d04b7d1c6fed6232e5b7b42099acb1bea99c729770f93b2e8e08c028db764267eb26ce4c7d880e39e974a6f5014e01
+  data.tar.gz: 2ae00e36c84235da52059161f224c383ce9826878034d101c8bbaf91c94575e3c762e6d622bbd2d37b4f52c40a162c71c3c675d2e929ed4d8a161ae3364f5528

data/CHANGELOG.md

@@ -1,8 +1,26 @@
-### 1.2.0 (Next)
+### 1.2.2 (Next)
 
 #### Features
 
 * Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+
+### 1.2.1 (11/28/2018)
+
+#### Features
+
+
+#### Fixes
+
+* [#1825](https://github.com/ruby-grape/grape/pull/1825): `to_s` on a mounted class now responses with the API name - [@myxoh](https://github.com/myxoh).
+
+### 1.2.0 (11/26/2018)
+
+#### Features
+
 * [#1813](https://github.com/ruby-grape/grape/pull/1813): Add ruby 2.5 support, drop 2.2. Update rails version in travis - [@darren987469](https://github.com/darren987469).
 * [#1803](https://github.com/ruby-grape/grape/pull/1803): Adds the ability to re-mount all endpoints in any location - [@myxoh](https://github.com/myxoh).
 * [#1795](https://github.com/ruby-grape/grape/pull/1795): Fix vendor/subtype parsing of an invalid Accept header - [@bschmeck](https://github.com/bschmeck).
@@ -10,7 +28,6 @@
 
 #### Fixes
 
-* Your contribution here.
 * [#1796](https://github.com/ruby-grape/grape/pull/1796): Fix crash when available locales are enforced but fallback locale unavailable - [@Morred](https://github.com/Morred).
 * [#1776](https://github.com/ruby-grape/grape/pull/1776): Validate response returned by the exception handler - [@darren987469](https://github.com/darren987469).
 * [#1787](https://github.com/ruby-grape/grape/pull/1787): Add documented but not implemented ability to `.insert` a middleware in the stack - [@michaellennox](https://github.com/michaellennox).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grape (1.2.0)
+    grape (1.2.1)
       activesupport
       builder
       mustermann-grape (~> 1.0.0)

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/grape.svg)](http://badge.fury.io/rb/grape)
 [![Build Status](https://travis-ci.org/ruby-grape/grape.svg?branch=master)](https://travis-ci.org/ruby-grape/grape)
-[![Dependency Status](https://gemnasium.com/ruby-grape/grape.svg)](https://gemnasium.com/ruby-grape/grape)
 [![Code Climate](https://codeclimate.com/github/ruby-grape/grape.svg)](https://codeclimate.com/github/ruby-grape/grape)
 [![Coverage Status](https://coveralls.io/repos/github/ruby-grape/grape/badge.svg?branch=master)](https://coveralls.io/github/ruby-grape/grape?branch=master)
 [![Inline docs](https://inch-ci.org/github/ruby-grape/grape.svg)](https://inch-ci.org/github/ruby-grape/grape)
@@ -147,9 +146,9 @@ content negotiation, versioning and much more.
 
 ## Stable Release
 
-You're reading the documentation for the next release of Grape, which should be **1.1.1**.
+You're reading the documentation for the next release of Grape, which should be **1.2.2**.
 Please read [UPGRADING](UPGRADING.md) when upgrading from a previous version.
-The current stable release is [1.1.0](https://github.com/ruby-grape/grape/blob/v1.1.0/README.md).
+The current stable release is [1.2.1](https://github.com/ruby-grape/grape/blob/v1.2.1/README.md).
 
 ## Project Resources
 

data/UPGRADING.md

@@ -1,10 +1,27 @@
 Upgrading Grape
 ===============
 
+### Upgrading to >= 1.2.1
+
+#### Obtaining the name of a mounted class
+
+In order to make obtaining the name of a mounted class simpler, we've delegated `.to_s` to `base.name`
+
+**Deprecated in 1.2.0**
+```ruby
+  payload[:endpoint].options[:for].name
+```
+**New**
+```ruby
+  payload[:endpoint].options[:for].to_s
+```
+
 ### Upgrading to >= 1.2.0
 
 #### Changes in the Grape::API class
 
+##### Patching the class
+
 In an effort to make APIs re-mountable, The class `Grape::API` no longer refers to an API instance,
 rather, what used to be `Grape::API` is now `Grape::API::Instance` and `Grape::API` was replaced
 with a class that can contain several instances of `Grape::API`.
@@ -29,6 +46,23 @@ class Grape::API::Instance
 end
 ```
 
+##### `name` (and other caveats) of the mounted API
+
+After the patch, the mounted API is no longer a Named class inheriting from `Grape::API`, it is an anonymous class
+which inherit from `Grape::API::Instance`.
+What this means in practice, is:
+- Generally: you can access the named class from the instance calling the getter `base`.
+- In particular: If you need the `name`, you can use `base`.`name`
+
+**Deprecated**
+```ruby
+  payload[:endpoint].options[:for].name
+```
+**New**
+```ruby
+  payload[:endpoint].options[:for].base.name
+```
+
 #### Changes in rescue_from returned object
 
 Grape will now check the object returned from `rescue_from` and ensure that it is a `Rack::Response`. That makes sure response is valid and avoids exposing service information. Change any code that invoked `Rack::Response.new(...).finish` in a custom `rescue_from` block to `Rack::Response.new(...)` to comply with the validation.

data/lib/grape/api/instance.rb

@@ -17,6 +17,10 @@ module Grape
           grape_api.instances << self
         end
 
+        def to_s
+          (base && base.to_s) || super
+        end
+
         # A class-level lock to ensure the API is not compiled by multiple
         # threads simultaneously within the same process.
         LOCK = Mutex.new

data/lib/grape/version.rb

@@ -1,4 +1,4 @@
 module Grape
   # The current version of Grape.
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.2.1'.freeze
 end

data/spec/grape/named_api_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe 'A named API' do
+  subject(:api_name) { NamedAPI.endpoints.last.options[:for].to_s }
+
+  let(:api) do
+    Class.new(Grape::API) do
+      get 'test' do
+        'response'
+      end
+    end
+  end
+
+  before { stub_const('NamedAPI', api) }
+
+  it 'can access the name of the API' do
+    expect(api_name).to eq 'NamedAPI'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Michael Bleigh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -321,6 +321,7 @@ files:
 - spec/grape/middleware/versioner/param_spec.rb
 - spec/grape/middleware/versioner/path_spec.rb
 - spec/grape/middleware/versioner_spec.rb
+- spec/grape/named_api_spec.rb
 - spec/grape/parser_spec.rb
 - spec/grape/path_spec.rb
 - spec/grape/presenters/presenter_spec.rb
@@ -398,6 +399,7 @@ test_files:
 - spec/grape/api/patch_method_helpers_spec.rb
 - spec/grape/api/optional_parameters_in_route_spec.rb
 - spec/grape/api/invalid_format_spec.rb
+- spec/grape/named_api_spec.rb
 - spec/grape/exceptions/validation_spec.rb
 - spec/grape/exceptions/validation_errors_spec.rb
 - spec/grape/exceptions/missing_option_spec.rb