grape-path-helpers 1.1.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5de62b3e52c6df10f69653f7aad9f4c81a64298c4ad74eb0085b06985a98474
-  data.tar.gz: bc29c3966d9f85de40b845d9e071fce2bc869d73776ce95078816c6f553a0494
+  metadata.gz: 40792c146fc9c26dd609bc8dd99adce92b010820e3c2ca9644144f3493dd06ec
+  data.tar.gz: aed680f63272f1e61467787e0d374bb8a8145b61979c18b5c61e332763472cd5
 SHA512:
-  metadata.gz: 04bb77b1e0ee4b792ca6edc6ce1dfd1a18f9af85bc828f2e5f384f621f5ad42a7ad16e2712e9dfb50c8f8e2e8229e5947279122888169eeaeaf12d78860d64fc
-  data.tar.gz: 0bfc95924b6ed43d02c39c6f77123c047122d2cfebc762745362273c837950e568fb22894008cd729de90a17373ea48d2dd933a8e9b85d5b7acdfab156aa836d
+  metadata.gz: ff06e53d14f8d46a398cc14754fbc61e7e1a1e28179aa83a27bbca47698c117daaf064f62d3e03e1a385112fea2c0dd076b102e64e4c2f1ffa3c4d4fae7d3279
+  data.tar.gz: 82fde6483c7ad996189c59ab9c79969495e642fb0274d9e209228b6633e6c6c731066a4bf24effa6e00e990f3fc82b94eca8084b469f64aad15e8f9a5f486728

data/.gitlab-ci.yml

@@ -1,8 +1,9 @@
-image: "ruby:2.4-alpine"
+image: "ruby:3.0-alpine"
 
 cache:
   paths:
     - vendor/ruby
+  key: ruby-3.0
 
 before_script:
   - apk add --update git

data/.rubocop.yml

@@ -8,3 +8,7 @@ Metrics/MethodLength:
 
 Style/FileName:
  Enabled: false
+
+# Removed in newer versions of Rubocop
+Lint/SplatKeywordArguments:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 1.6.0
+
+* [Extract kwargs to fix 2.7 warnings](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/29)
+
+## 1.5.0
+
+* [Relax rake dependency](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/27)
+
+## 1.4.0
+
+* [Support using a base class other than Grape::API::Instance](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/23)
+
+## 1.3.0
+
+* [Upgrade to Grape 1.3.1](https://gitlab.com/gitlab-org/grape-path-helpers/-/merge_requests/21)
+
+## 1.2.0
+
+* [Add wildcard segments support](https://gitlab.com/gitlab-org/grape-path-helpers/merge_requests/16)
+
 ## 1.1.0
 
 * [Relax dependency on ActiveSupport](https://gitlab.com/gitlab-org/grape-path-helpers/merge_requests/12)

data/Gemfile.lock

@@ -1,48 +1,60 @@
 PATH
   remote: .
   specs:
-    grape-path-helpers (1.0.6)
-      activesupport (>= 4, < 5.1)
-      grape (~> 1.0)
-      rake (~> 12)
+    grape-path-helpers (1.6.0)
+      activesupport
+      grape (~> 1.3)
+      rake (> 12)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.7)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.3)
+    builder (3.2.4)
     coderay (1.1.2)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.0.5)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.3)
-    equalizer (0.0.11)
-    grape (1.0.3)
+    dry-configurable (0.12.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.5.0)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.1.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    grape (1.5.1)
       activesupport
       builder
+      dry-types (>= 1.1)
       mustermann-grape (~> 1.0.0)
       rack (>= 1.3.0)
       rack-accept
-      virtus (>= 1.0.0)
-    i18n (1.0.1)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    ice_nine (0.11.2)
     method_source (0.9.0)
-    minitest (5.11.3)
-    mustermann (1.0.2)
-    mustermann-grape (1.0.0)
-      mustermann (~> 1.0.0)
+    minitest (5.14.3)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
     parallel (1.12.1)
     parser (2.5.1.0)
       ast (~> 2.4.0)
@@ -50,11 +62,11 @@ GEM
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rack (2.0.5)
+    rack (2.2.3)
     rack-accept (0.4.5)
       rack (>= 0.4)
     rainbow (3.0.0)
-    rake (12.3.1)
+    rake (13.0.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -76,15 +88,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
+    ruby2_keywords (0.0.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.3.3)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -96,4 +104,4 @@ DEPENDENCIES
   rubocop (~> 0.56)
 
 BUNDLED WITH
-   1.16.2
+   2.2.3

data/LICENSE.txt

@@ -1,6 +1,7 @@
 MIT License (MIT)
 
-Copyright (c) 2015 Harper Henn
+Copyright (c) 2015,2016 Harper Henn
+Copyright (c) 2018-2020 GitLab B.V.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,10 +1,10 @@
 # grape-path-helpers
 
-[![Build status](https://gitlab.com/gitlab-org/grape-path-helpers/badges/master/build.svg)](https://gitlab.com/gitlab-org/grape-path-helpers/commits/master)
+[![Build status](https://gitlab.com/gitlab-org/grape-path-helpers/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/grape-path-helpers/commits/master)
 
 Provides named route helpers for Grape APIs, similar to [Rails' route helpers](http://edgeguides.rubyonrails.org/routing.html#path-and-url-helpers).
 
-**This is a fork and rename of [group-route-helpers](https://github.com/reprah/grape-route-helpers). It [includes some fixes](CHANGELOG.md) needed for GitLab.**
+**This is a fork and rename of [grape-route-helpers](https://github.com/reprah/grape-route-helpers). It [includes some fixes](CHANGELOG.md) needed for GitLab.**
 
 ### Installation
 
@@ -76,7 +76,7 @@ You can use helper methods in your REPL session by including a module:
 Use the methods inside your Grape API actions. Given this example API:
 
 ```ruby
-class ExampleAPI < Grape::API
+class ExampleAPI < Grape::API::Instance
   version 'v1'
   prefix 'api'
   format 'json'
@@ -127,7 +127,7 @@ api_v1_anything_path # => '/api/v1/*anything'
 If you want to assign a custom helper name to a route, pass the `:as` option when creating your route in your API:
 
 ```ruby
-class Base < Grape::API
+class Base < Grape::API::Instance
   get 'ping', as: 'is_the_server_running'
     'pong'
   end
@@ -169,6 +169,14 @@ end
 
 6.) Create a new pull request
 
+### Releasing
+
+1. Update the [CHANGELOG](CHANGELOG.md).
+2. Update the version in [lib/grape-path-helpers/version.rb](lib/grape-path-helpers/version.rb).
+3. [Tag](https://gitlab.com/gitlab-org/grape-path-helpers/-/tags) the commit with the version number prefixed by 'v'.
+4. Run `gem build grape-path-helpers` locally.
+5. Run `gem push $new_file.gem` locally, where `$new_file` is the file generated by the step above.
+
 ### License
 
 See LICENSE

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler'
+require 'bundler/gem_tasks'
 
 Bundler.setup :default, :test, :development
 

data/grape-path-helpers.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |gem|
   gem.homepage    = 'https://gitlab.com/gitlab-org/grape-path-helpers'
 
   gem.add_runtime_dependency 'activesupport'
-  gem.add_runtime_dependency 'grape', '~> 1.0'
-  gem.add_runtime_dependency 'rake', '~> 12'
+  gem.add_runtime_dependency 'grape', '~> 1.3'
+  gem.add_runtime_dependency 'rake', '> 12'
 
   gem.add_development_dependency 'pry', '~> 0.11'
   gem.add_development_dependency 'rspec', '~> 3.7'

data/lib/grape-path-helpers.rb

@@ -12,5 +12,5 @@ module GrapePathHelpers
   require 'grape-path-helpers/railtie' if defined?(Rails)
 end
 
-Grape::API.extend GrapePathHelpers::AllRoutes
+Grape::API::Instance.extend GrapePathHelpers::AllRoutes
 Grape::Endpoint.send(:include, GrapePathHelpers::NamedRouteMatcher)

data/lib/grape-path-helpers/all_routes.rb

@@ -11,7 +11,7 @@ module GrapePathHelpers
     end
 
     def all_routes
-      routes = subclasses.flat_map { |s| s.send(:prepare_routes) }
+      routes = descendants.flat_map { |s| s.send(:prepare_routes) }
       routes.uniq { |r| r.options.merge(path: r.path) }
     end
   end

data/lib/grape-path-helpers/decorated_route.rb

@@ -4,6 +4,9 @@ module GrapePathHelpers
     attr_reader :route, :helper_names, :helper_arguments,
                 :extension, :route_options
 
+    PATH_SEGMENTS_REGEXP = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\??\*}
+    PATH_SEGMENTS_WITH_WILDCARDS_REGEXP = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\?}
+
     def self.sanitize_method_name(string)
       string.gsub(/\W|^[0-9]/, '_')
     end
@@ -40,12 +43,12 @@ module GrapePathHelpers
 
     def define_path_helper(method_name, route_attributes)
       method_body = <<-RUBY
-        def #{method_name}(attributes = {})
+        def #{method_name}(attributes = {}, include_wildcard_segments = false)
           attrs = #{route_attributes}.merge(attributes)
 
           query_params = attrs.delete(:params)
           content_type = attrs.delete(:format)
-          path = '/' + path_segments_with_values(attrs).join('/')
+          path = '/' + path_segments_with_values(attrs, include_wildcard_segments).join('/')
 
           path + content_type + query_string(query_params)
         end
@@ -99,13 +102,19 @@ module GrapePathHelpers
       end
     end
 
-    def path_segments_with_values(opts)
-      segments = path_segments.map { |s| segment_to_value(s, opts) }
+    def path_segments_with_values(opts, include_wildcard_segments = false)
+      segments = path_segments(include_wildcard_segments).map do |s|
+        segment_to_value(s, opts)
+      end
       segments.reject(&:blank?)
     end
 
-    def path_segments
-      pattern = %r{\(/?\.:?\w+\)|/(?!\))|(?<=\))|\??\*}
+    def path_segments(include_wildcard_segments = false)
+      pattern = if include_wildcard_segments
+                  PATH_SEGMENTS_WITH_WILDCARDS_REGEXP
+                else
+                  PATH_SEGMENTS_REGEXP
+                end
       route_path.split(pattern).reject(&:blank?)
     end
 
@@ -117,7 +126,7 @@ module GrapePathHelpers
     end
 
     def dynamic_segment?(segment)
-      segment.start_with?(':')
+      segment.start_with?(':', '*')
     end
 
     def optional_segment?(segment)

data/lib/grape-path-helpers/named_route_matcher.rb

@@ -3,26 +3,34 @@ module GrapePathHelpers
   # to unknown methods will look for a route with a matching
   # helper function name
   module NamedRouteMatcher
-    def method_missing(method_id, *arguments)
+    def method_missing(method_id, *args, **kwargs)
       return super unless method_id.to_s =~ /_path$/
 
+      success, result = call_path_method(method_id, *args, **kwargs)
+
+      if success
+        result
+      else
+        super
+      end
+    end
+
+    def call_path_method(method_id, *arguments)
       segments = arguments.first || {}
 
-      route = Grape::API.decorated_routes.detect do |r|
+      route = Grape::API::Instance.decorated_routes.detect do |r|
         route_match?(r, method_id, segments)
       end
 
-      if route
-        route.send(method_id, *arguments)
-      else
-        super
-      end
+      return false unless route
+
+      [true, route.send(method_id, *arguments)]
     end
 
     def respond_to_missing?(method_name, _include_private = false)
       return super unless method_name =~ /_path$/
 
-      Grape::API.decorated_routes.detect do |route|
+      Grape::API::Instance.decorated_routes.detect do |route|
         return true if route.respond_to?(method_name)
       end
 

data/lib/grape-path-helpers/route_displayer.rb

@@ -3,7 +3,7 @@ module GrapePathHelpers
   # and required arguments for every Grape::Route.
   class RouteDisplayer
     def route_attributes
-      Grape::API.decorated_routes.map do |route|
+      Grape::API::Instance.decorated_routes.map do |route|
         {
           route_path: route.route_path,
           route_method: route.route_method,

data/lib/grape-path-helpers/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module GrapePathHelpers
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/spec/grape_path_helpers/all_routes_spec.rb

@@ -1,7 +1,8 @@
 require 'spec_helper'
 
+# rubocop:disable Metrics/BlockLength
 describe GrapePathHelpers::AllRoutes do
-  Grape::API.extend described_class
+  Grape::API::Instance.extend described_class
 
   describe '#all_routes' do
     context 'when API is mounted within another API' do
@@ -11,7 +12,7 @@ describe GrapePathHelpers::AllRoutes do
         mounting_api
 
         # A route is unique if no other route shares the same set of options
-        all_route_options = Grape::API.all_routes.map do |r|
+        all_route_options = Grape::API::Instance.all_routes.map do |r|
           r.instance_variable_get(:@options).merge(path: r.path)
         end
 
@@ -28,10 +29,18 @@ describe GrapePathHelpers::AllRoutes do
       it 'returns all POST routes' do
         expected_routes = Spec::Support::MultiplePostsAPI.routes.map(&:path)
 
-        all_routes = Grape::API.all_routes
+        all_routes = Grape::API::Instance.all_routes
         expect(all_routes.map(&:path)).to include(*expected_routes)
       end
     end
+
+    context 'when an API is created via an intermediate class' do
+      it 'includes those routes on both Grape::API::Instance and the base class' do
+        expect(Spec::Support::BaseAPI.all_routes.map(&:origin)).to include('/derived_ping')
+        expect(Grape::API::Instance.all_routes.map(&:origin)).to include('/derived_ping')
+      end
+    end
     # rubocop:enable Metrics/LineLength
   end
 end
+# rubocop:enable Metrics/BlockLength

data/spec/grape_path_helpers/decorated_route_spec.rb

@@ -19,7 +19,7 @@ describe GrapePathHelpers::DecoratedRoute do
   end
 
   let(:catch_all_route) do
-    routes.detect { |route| route.route_path =~ /\*/ }
+    routes.detect { |route| route.route_path =~ /\*path/ }
   end
 
   let(:custom_route) do
@@ -34,6 +34,10 @@ describe GrapePathHelpers::DecoratedRoute do
     routes.detect { |route| route.route_path =~ /optional/ }
   end
 
+  let(:wildcard_route) do
+    routes.detect { |route| route.route_path =~ /\*owner_ids/ }
+  end
+
   describe '#sanitize_method_name' do
     it 'removes characters that are illegal in Ruby method names' do
       illegal_names = ['beta-1', 'name_with_+', 'name_with_(']
@@ -51,6 +55,53 @@ describe GrapePathHelpers::DecoratedRoute do
     end
   end
 
+  describe '#define_path_helper' do
+    context 'with only static segments' do
+      let(:route) { ping_route }
+
+      subject { route.api_v1_ping_path }
+
+      it { is_expected.to eq '/api/v1/ping.json' }
+    end
+
+    context 'with optional segments' do
+      let(:route) { optional_route }
+
+      subject { route.api_v1_cats______optional_path }
+
+      it { is_expected.to eq '/api/v1/cats/(-/)/optional.json' }
+    end
+
+    context 'with dynamic segments' do
+      let(:route) { show_route }
+
+      subject { route.api_v1_cats_path(id: 1) }
+
+      it { is_expected.to eq '/api/v1/cats/1.json' }
+    end
+
+    context 'with wildcard segments' do
+      let(:route) { wildcard_route }
+
+      context 'including them' do
+        subject do
+          route.api_v1_cats_owners_owner_ids_cats_path(
+            { owner_ids: 'foobar' },
+            true
+          )
+        end
+
+        it { is_expected.to eq '/api/v1/cats/owners/foobar/cats.json' }
+      end
+
+      context 'excluding them' do
+        subject { route.api_v1_cats_owners_owner_ids_cats_path }
+
+        it { is_expected.to eq '/api/v1/cats/owners/owner_ids/cats.json' }
+      end
+    end
+  end
+
   describe '#helper_names' do
     context 'when a route is given a custom helper name' do
       it 'uses the custom name instead of the dynamically generated one' do
@@ -119,7 +170,7 @@ describe GrapePathHelpers::DecoratedRoute do
 
   describe '#path_segments_with_values' do
     context 'when path has dynamic segments' do
-      it 'replaces segments with corresponding values found in @options' do
+      it 'replaces segments with corresponding values found in options' do
         opts = { id: 1 }
         result = show_route.path_segments_with_values(opts)
         expect(result).to include(1)
@@ -133,6 +184,74 @@ describe GrapePathHelpers::DecoratedRoute do
         end
       end
     end
+
+    context 'when path has wildcard segments' do
+      context 'with regex excluding them' do
+        it "doesn't replaces wildcard segments" do
+          opts = { version: 4, id: 34, owner_ids: 'foobar' }
+
+          result = wildcard_route.path_segments_with_values(opts)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).to include('owner_ids')
+          expect(result).not_to include('foobar')
+        end
+
+        it "doesn't blank wildcard segments" do
+          opts = { version: 4, id: 34, owner_ids: '' }
+
+          result = wildcard_route.path_segments_with_values(opts)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).to include('owner_ids')
+        end
+      end
+
+      context 'with regex including them' do
+        context 'replaces segments' do
+          it 'with static text' do
+            opts = { version: 4, id: 34, owner_ids: 'foobar' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foobar')
+            expect(result).not_to include('owner_ids')
+          end
+
+          it 'with additional segments' do
+            opts = { version: 4, id: 34, owner_ids: 'foo/bar/baz' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foo/bar/baz')
+            expect(result).not_to include('owner_ids')
+          end
+        end
+
+        it 'blanks wildcard segments' do
+          opts = { version: 4, id: 34, owner_ids: '' }
+
+          result = wildcard_route.path_segments_with_values(opts, true)
+          expect(result).to include(4)
+          expect(result).to include(34)
+          expect(result).not_to include('owner_ids')
+        end
+
+        context 'when options contains string keys' do
+          it 'replaces segments' do
+            opts = { 'version' => 4, 'id' => 34, 'owner_ids' => 'foobar' }
+
+            result = wildcard_route.path_segments_with_values(opts, true)
+            expect(result).to include(4)
+            expect(result).to include(34)
+            expect(result).to include('foobar')
+            expect(result).not_to include('owner_ids')
+          end
+        end
+      end
+    end
   end
 
   describe '#path_helper_name' do
@@ -165,6 +284,13 @@ describe GrapePathHelpers::DecoratedRoute do
         expect(result).to eq('api_v1_path_path')
       end
     end
+
+    context 'when the path has a wildcard segment' do
+      it 'returns a name without the glob star' do
+        result = wildcard_route.path_helper_name
+        expect(result).to eq('api_v1_cats_owners_owner_ids_cats_path')
+      end
+    end
   end
 
   describe '#segment_to_value' do

data/spec/grape_path_helpers/named_route_matcher_spec.rb

@@ -5,7 +5,7 @@ describe GrapePathHelpers::NamedRouteMatcher do
   include described_class
 
   let(:routes) do
-    Grape::API.decorated_routes
+    Grape::API::Instance.decorated_routes
   end
 
   let(:ping_route) do
@@ -30,8 +30,8 @@ describe GrapePathHelpers::NamedRouteMatcher do
     fake_class = Class.new do
       prepend GrapePathHelpers::NamedRouteMatcher
 
-      def method_missing(_method_id, *_args)
-        'whatever' || super
+      def method_missing(method_id, *args, **kwargs)
+        [method_id, args, kwargs] || super
       end
 
       def respond_to_missing?(_method_name, _include_private = false)
@@ -44,13 +44,14 @@ describe GrapePathHelpers::NamedRouteMatcher do
 
   describe '#method_missing' do
     it 'returns super method_missing if the method does not end with path' do
-      expect(Grape::API).not_to receive(:decorated_routes)
+      expect(Grape::API::Instance).not_to receive(:decorated_routes)
 
-      helper_class.test_method
+      expect(helper_class.test_method(:arg1, kwarg1: :kwarg1))
+        .to eq([:test_method, [:arg1], { kwarg1: :kwarg1 }])
     end
 
     it 'search for the route if the method ends with path' do
-      expect(Grape::API).to receive(:decorated_routes).and_call_original
+      expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
 
       helper_class.test_method_path
     end
@@ -146,14 +147,14 @@ describe GrapePathHelpers::NamedRouteMatcher do
   end
 
   describe '#respond_to_missing?' do
-    it 'returns super if the method doesb not end with path' do
-      expect(Grape::API).not_to receive(:decorated_routes)
+    it 'returns super if the method does not end with path' do
+      expect(Grape::API::Instance).not_to receive(:decorated_routes) # rubocop:disable Metrics/LineLength
 
       expect(helper_class.send(:respond_to_missing?, :test)).to eq(false)
     end
 
     it 'search for the route if the method ends with path' do
-      expect(Grape::API).to receive(:decorated_routes).and_call_original
+      expect(Grape::API::Instance).to receive(:decorated_routes).and_call_original # rubocop:disable Metrics/LineLength
 
       expect(helper_class.send(:respond_to_missing?, :test_path)).to eq(false)
     end

data/spec/support/api.rb

@@ -1,7 +1,7 @@
 module Spec
   module Support
     # Test API
-    class API < Grape::API
+    class API < Grape::API::Instance
       version 'v1'
       prefix 'api'
       format 'json'
@@ -36,6 +36,10 @@ module Spec
         get ':id/owners/:owner_id' do
           'owner'
         end
+
+        get ':id/owners/*owner_ids/cats' do
+          %w[cats cats cats]
+        end
       end
 
       route :any, '*path' do
@@ -44,7 +48,7 @@ module Spec
     end
 
     # API with more than one version
-    class APIWithMultipleVersions < Grape::API
+    class APIWithMultipleVersions < Grape::API::Instance
       version %w[beta alpha v1]
 
       get 'ping' do
@@ -53,13 +57,13 @@ module Spec
     end
 
     # API with another API mounted inside it
-    class MountedAPI < Grape::API
+    class MountedAPI < Grape::API::Instance
       mount Spec::Support::API
       mount Spec::Support::APIWithMultipleVersions
     end
 
     # API with a version that would be illegal as a method name
-    class APIWithIllegalVersion < Grape::API
+    class APIWithIllegalVersion < Grape::API::Instance
       version 'beta-1'
 
       get 'ping' do
@@ -68,7 +72,7 @@ module Spec
     end
 
     # API with multiple POST routes
-    class MultiplePostsAPI < Grape::API
+    class MultiplePostsAPI < Grape::API::Instance
       resource :hamlet do
         post 'to_be' do
         end
@@ -77,5 +81,14 @@ module Spec
         end
       end
     end
+
+    class BaseAPI < Grape::API::Instance
+    end
+
+    class DerivedAPI < BaseAPI
+      get 'derived_ping' do
+        'pong'
+      end
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-path-helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Drew Blessing
 - Harper Henn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,26 +31,26 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '12'
 - !ruby/object:Gem::Dependency
@@ -131,7 +131,7 @@ homepage: https://gitlab.com/gitlab-org/grape-path-helpers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Route path helpers for Grape
 test_files: []