Back to Repositories

Testing PATCH Method Handling and API Versioning in ruby-grape/grape

This test suite evaluates the PATCH method handling and API versioning functionality in Grape’s API helpers. It verifies both public and private API endpoints behavior, focusing on version-specific routing and authentication requirements.

Test Coverage Overview

The test suite provides comprehensive coverage of PATCH method handling across different API versions and authentication contexts.

Tests PATCH requests against public and private API endpoints
Verifies correct HTTP status codes (405 for PATCH, 200 for GET)
Validates version-specific response handling
Tests default routing behavior

Implementation Analysis

The testing approach utilizes RSpec’s context-based organization to separate concerns between public and private API endpoints.

The implementation leverages Grape’s class-based API definition pattern with dynamic class creation for test isolation. Authentication is implemented through a modular helper system with before hooks.

Technical Details

Uses RSpec for test framework
Implements Grape::API class inheritance
Utilizes custom HTTP headers for API versioning
Employs JSON format for response handling
Implements modular authentication helpers

Best Practices Demonstrated

The test suite exemplifies several testing best practices in API development.

Proper separation of concerns between public and private endpoints
Consistent status code validation
Modular authentication implementation
Clean test organization using RSpec contexts
Effective use of let blocks for setup

ruby-grape/grape

spec/grape/api/patch_method_helpers_spec.rb

            
# frozen_string_literal: true

describe Grape::API::Helpers do
  let(:patch_public) do
    Class.new(Grape::API) do
      format :json
      version 'public-v1', using: :header, vendor: 'grape'

      get do
        { ok: 'public' }
      end
    end
  end
  let(:auth_methods) do
    Module.new do
      def authenticate!; end
    end
  end
  let(:patch_private) do
    context = self

    Class.new(Grape::API) do
      format :json
      version 'private-v1', using: :header, vendor: 'grape'

      helpers context.auth_methods

      before do
        authenticate!
      end

      get do
        { ok: 'private' }
      end
    end
  end
  let(:main) do
    context = self

    Class.new(Grape::API) do
      mount context.patch_public
      mount context.patch_private
    end
  end

  def app
    main
  end

  context 'patch' do
    it 'public' do
      patch '/', {}, Grape::Http::Headers::HTTP_ACCEPT => 'application/vnd.grape-public-v1+json'
      expect(last_response.status).to eq 405
    end

    it 'private' do
      patch '/', {}, Grape::Http::Headers::HTTP_ACCEPT => 'application/vnd.grape-private-v1+json'
      expect(last_response.status).to eq 405
    end

    it 'default' do
      patch '/'
      expect(last_response.status).to eq 405
    end
  end

  context 'default' do
    it 'public' do
      get '/', {}, Grape::Http::Headers::HTTP_ACCEPT => 'application/vnd.grape-public-v1+json'
      expect(last_response.status).to eq 200
      expect(last_response.body).to eq({ ok: 'public' }.to_json)
    end

    it 'private' do
      get '/', {}, Grape::Http::Headers::HTTP_ACCEPT => 'application/vnd.grape-private-v1+json'
      expect(last_response.status).to eq 200
      expect(last_response.body).to eq({ ok: 'private' }.to_json)
    end

    it 'default' do
      get '/'
      expect(last_response.status).to eq 200
      expect(last_response.body).to eq({ ok: 'public' }.to_json)
    end
  end
end