grape-path-helpers 1.0.0

data/spec/grape_path_helpers/named_route_matcher_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+# rubocop:disable Metrics/BlockLength
+describe GrapePathHelpers::NamedRouteMatcher do
+  include described_class
+
+  let(:routes) do
+    Grape::API.decorated_routes
+  end
+
+  let(:ping_route) do
+    routes.detect do |route|
+      route.route_path =~ /ping/ && route.route_version == 'v1'
+    end
+  end
+
+  let(:index_route) do
+    routes.detect do |route|
+      route.route_namespace =~ /cats$/
+    end
+  end
+
+  let(:show_route) do
+    routes.detect do |route|
+      route.route_namespace =~ %r{cats/:id}
+    end
+  end
+
+  describe '#route_match?' do
+    context 'when route responds to a method name' do
+      let(:route) { ping_route }
+      let(:method_name) { :api_v1_ping_path }
+      let(:segments) { {} }
+
+      context 'when segments is not a hash' do
+        it 'raises an ArgumentError' do
+          expect do
+            route_match?(route, method_name, 1234)
+          end.to raise_error(ArgumentError)
+        end
+      end
+
+      it 'returns true' do
+        is_match = route_match?(route, method_name, segments)
+        expect(is_match).to eq(true)
+      end
+
+      context 'when requested segments contains expected options' do
+        let(:segments) { { 'format' => 'xml' } }
+
+        it 'returns true' do
+          is_match = route_match?(route, method_name, segments)
+          expect(is_match).to eq(true)
+        end
+
+        context 'when no dynamic segments are requested' do
+          context 'when the route requires dynamic segments' do
+            let(:route) { show_route }
+            let(:method_name) { :ap1_v1_cats_path }
+
+            it 'returns false' do
+              is_match = route_match?(route, method_name, segments)
+              expect(is_match).to eq(false)
+            end
+          end
+
+          context 'when the route does not require dynamic segments' do
+            it 'returns true' do
+              is_match = route_match?(route, method_name, segments)
+              expect(is_match).to eq(true)
+            end
+          end
+        end
+
+        context 'when route requires the requested segments' do
+          let(:route) { show_route }
+          let(:method_name) { :api_v1_cats_path }
+          let(:segments) { { id: 1 } }
+
+          it 'returns true' do
+            is_match = route_match?(route, method_name, segments)
+            expect(is_match).to eq(true)
+          end
+        end
+
+        context 'when route does not require the requested segments' do
+          let(:segments) { { some_option: 'some value' } }
+
+          it 'returns false' do
+            is_match = route_match?(route, method_name, segments)
+            expect(is_match).to eq(false)
+          end
+        end
+      end
+
+      context 'when segments contains unexpected options' do
+        let(:segments) { { some_option: 'some value' } }
+
+        it 'returns false' do
+          is_match = route_match?(route, method_name, segments)
+          expect(is_match).to eq(false)
+        end
+      end
+    end
+
+    context 'when route does not respond to a method name' do
+      let(:method_name) { :some_other_path }
+      let(:route) { ping_route }
+      let(:segments) { {} }
+
+      it 'returns false' do
+        is_match = route_match?(route, method_name, segments)
+        expect(is_match).to eq(false)
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    context 'when method name matches a Grape::Route path helper name' do
+      it 'returns the path for that route object' do
+        path = api_v1_ping_path
+        expect(path).to eq('/api/v1/ping.json')
+      end
+
+      context 'when argument to the helper is not a hash' do
+        it 'raises an ArgumentError' do
+          expect do
+            api_v1_ping_path(1234)
+          end.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    context 'when method name does not match a Grape::Route path helper name' do
+      it 'raises a NameError' do
+        expect do
+          some_method_name
+        end.to raise_error(NameError)
+      end
+    end
+  end
+
+  context 'when Grape::Route objects share the same helper name' do
+    context 'when helpers require different segments to generate their path' do
+      it 'uses arguments to infer which route to use' do
+        show_path = api_v1_cats_path('id' => 1)
+        expect(show_path).to eq('/api/v1/cats/1.json')
+
+        index_path = api_v1_cats_path
+        expect(index_path).to eq('/api/v1/cats.json')
+      end
+
+      it 'does not get shadowed by another route with less segments' do
+        show_path = api_v1_cats_owners_path('id' => 1)
+        expect(show_path).to eq('/api/v1/cats/1/owners.json')
+
+        show_path = api_v1_cats_owners_path('id' => 1, 'owner_id' => 1)
+        expect(show_path).to eq('/api/v1/cats/1/owners/1.json')
+      end
+    end
+
+    context 'when query params are passed in' do
+      it 'uses arguments to infer which route to use' do
+        show_path = api_v1_cats_path('id' => 1, params: { 'foo' => 'bar' })
+        expect(show_path).to eq('/api/v1/cats/1.json?foo=bar')
+
+        index_path = api_v1_cats_path(params: { 'foo' => 'bar' })
+        expect(index_path).to eq('/api/v1/cats.json?foo=bar')
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('lib')
+
+require 'pry'
+require 'grape/path_helpers'
+
+support_files = Dir.glob('spec/support/*')
+support_files.each { |f| require File.expand_path(f) }

data/spec/support/api.rb

@@ -0,0 +1,77 @@
+module Spec
+  module Support
+    # Test API
+    class API < Grape::API
+      version 'v1'
+      prefix 'api'
+      format 'json'
+
+      get 'custom_name', as: :my_custom_route_name do
+        'hello'
+      end
+
+      get 'ping' do
+        'pong'
+      end
+
+      resource :cats do
+        get '/' do
+          %w[cats cats cats]
+        end
+
+        route_param :id do
+          get do
+            'cat'
+          end
+        end
+
+        get ':id/owners' do
+          %w[owner1 owner2]
+        end
+
+        get ':id/owners/:owner_id' do
+          'owner'
+        end
+      end
+
+      route :any, '*path' do
+        'catch-all route'
+      end
+    end
+
+    # API with more than one version
+    class APIWithMultipleVersions < Grape::API
+      version %w[beta alpha v1]
+
+      get 'ping' do
+        'pong'
+      end
+    end
+
+    # API with another API mounted inside it
+    class MountedAPI < Grape::API
+      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
+      version 'beta-1'
+
+      get 'ping' do
+        'pong'
+      end
+    end
+
+    # API with multiple POST routes
+    class MultiplePostsAPI < Grape::API
+      resource :hamlet do
+        post 'to_be' do
+        end
+
+        post 'or_not_to_be' do
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: grape-path-helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Drew Blessing
+- Harper Henn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Route path helpers for Grape
+email: ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-path-helpers.gemspec
+- lib/grape-path-helpers.rb
+- lib/grape-path-helpers/all_routes.rb
+- lib/grape-path-helpers/decorated_route.rb
+- lib/grape-path-helpers/named_route_matcher.rb
+- lib/grape-path-helpers/railtie.rb
+- lib/grape-path-helpers/route_displayer.rb
+- lib/grape-path-helpers/tasks.rb
+- lib/grape-path-helpers/version.rb
+- lib/grape/path_helpers.rb
+- lib/tasks/grape_path_helpers.rake
+- spec/grape_path_helpers/all_routes_spec.rb
+- spec/grape_path_helpers/decorated_route_spec.rb
+- spec/grape_path_helpers/named_route_matcher_spec.rb
+- spec/spec_helper.rb
+- spec/support/api.rb
+homepage: https://github.com/gitlab/grape-path-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: Route path helpers for Grape
+test_files: []