Sha256: cd2fb556aa78d2ca6d75cdf9ea63b4cc8f02cb98122465bfc43aa2eb678f4afe

Contents?: true

Size: 1.81 KB

Versions: 13

Compression:

Stored size: 1.81 KB

Contents

module Lita
  # Handlers use this class to define HTTP routes for the built-in web
  # server.
  class HTTPRoute
    # The handler registering the route.
    # @return [Lita::Handler] The handler.
    attr_reader :handler_class

    # The HTTP method for the route (GET, POST, etc.).
    # @return [String] The HTTP method.
    attr_reader :http_method

    # The name of the instance method in the handler to call for the route.
    # @return [Symbol, String] The method name.
    attr_reader :method_name

    # The URL path component that will trigger the route.
    # @return [String] The path.
    attr_reader :path

    # @param handler_class [Lita::Handler] The handler registering the route.
    def initialize(handler_class)
      @handler_class = handler_class
    end

    class << self
      private

      # @!macro define_http_method
      #   @method $1(path, method_name)
      #   Defines a new route with the "$1" HTTP method.
      #   @param path [String] The URL path component that will trigger the
      #     route.
      #   @param method_name [Symbol, String] The name of the instance method in
      #     the handler to call for the route.
      #   @return [void]
      def define_http_method(http_method)
        define_method(http_method) do |path, method_name|
          route(http_method.to_s.upcase, path, method_name)
        end
      end
    end

    define_http_method :get
    define_http_method :post
    define_http_method :put
    define_http_method :patch
    define_http_method :delete
    define_http_method :options
    define_http_method :link
    define_http_method :unlink

    private

    # Creates a new HTTP route.
    def route(http_method, path, method_name)
      @http_method = http_method
      @path = path
      @method_name = method_name

      handler_class.http_routes << self
    end
  end
end

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
lita-2.7.2 lib/lita/http_route.rb
lita-2.7.1 lib/lita/http_route.rb
lita-2.7.0 lib/lita/http_route.rb
lita-2.6.0 lib/lita/http_route.rb
lita-2.5.0 lib/lita/http_route.rb
lita-2.4.0 lib/lita/http_route.rb
lita-2.3.0 lib/lita/http_route.rb
lita-2.2.1 lib/lita/http_route.rb
lita-2.2.0 lib/lita/http_route.rb
lita-2.1.2 lib/lita/http_route.rb
lita-2.1.1 lib/lita/http_route.rb
lita-2.1.0 lib/lita/http_route.rb
lita-2.0.0 lib/lita/http_route.rb