ruby-grape / ruby-grape/grape

Expose API class to each HTTP method block via something like the described_class() method in rspec

Open
#1,500 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request
Dominant language
Ruby
Stars
10k
Forks
1.2k
Avg merge
14h 38m
Merged PRs (30d)
92

Description

Hey, is it possible to access to the API class using a method to prevent to add namespace resolution operator to the beginning of the class?

Actual behavior
module API
  module V1
    class APIClass < Grape::API
      get do
        ::APIClass.do_something
      end
   end
  end
end
Expected behavior
module API
  module V1
    class APIClass < Grape::API
      get do
        grape_class.do_something
      end
   end
  end
end

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how Grape evaluates HTTP method blocks and how the defining API class is retained. Check existing tests around method blocks and nested API namespaces; done means the block can access its API class through a supported method without requiring namespace resolution.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.