Exposes the name of the API via to_s (Addresses #1825) (#1826)

Author: myxoh

CHANGELOG.md

@@ -7,8 +7,9 @@
 #### Fixes
 
 * Your contribution here.
+* [#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 (29/11/2018)
+### 1.2.0 (11/29/2018)
 
 #### Features
 

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.

lib/grape/api/instance.rb

@@ -17,6 +17,10 @@ def base=(grape_api)
           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

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