praxis 2.0.pre.18 → 2.0.pre.19

data/lib/praxis/responses/http.rb

@@ -1,7 +1,7 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   module Responses
-
     # Descriptions from http://en.wikipedia.org/wiki/List_of_HTTP_status_codes
 
     # Standard response for successful HTTP requests.
@@ -20,7 +20,6 @@ module Praxis
       self.status = 201
     end
 
-
     # The request has been accepted for processing, but the
     # processing has not been completed. The request might or might
     # not eventually be acted upon, as it might be disallowed when
@@ -29,7 +28,6 @@ module Praxis
       self.status = 202
     end
 
-
     # The server successfully processed the request, but is not
     # returning any content. Usually used as a response to
     # a successful delete request.
@@ -37,73 +35,61 @@ module Praxis
       self.status = 204
     end
 
-
     # Indicates multiple options for the resource that the client may follow. It, for instance, could be used to present different format options for video, list files with different extensions, or word sense disambiguation.
     class MultipleChoices < Praxis::Response
       self.status = 300
     end
 
-
     # This and all future requests should be directed to the given URI.
     class MovedPermanently < Praxis::Response
       self.status = 301
     end
 
-
     # This is an example of industry practice contradicting the standard. The HTTP/1.0 specification (RFC 1945) required the client to perform a temporary redirect (the original describing phrase was "Moved Temporarily"),[5] but popular browsers implemented 302 with the functionality of a 303 See Other. Therefore, HTTP/1.1 added self.status = codes 303 and 307 to distinguish between the two behaviours.[6] However, some Web applications and frameworks use the 302 self.status = code as if it were the 303.[7]
     class Found < Praxis::Response
       self.status = 302
     end
 
-
     # The response to the request can be found under another URI using a GET method. When received in response to a POST (or PUT/DELETE), it should be assumed that the server has received the data and the redirect should be issued with a separate GET message.
     class SeeOther < Praxis::Response
       self.status = 303
     end
 
-
     # Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-Match. This means that there is no need to retransmit the resource, since the client still has a previously-downloaded copy.
     class NotModified < Praxis::Response
       self.status = 304
     end
 
-
     # In this case, the request should be repeated with another URI; however, future requests should still use the original URI. In contrast to how 302 was historically implemented, the request method is not allowed to be changed when reissuing the original request. For instance, a POST request should be repeated using another POST request.[10]
     class TemporaryRedirect < Praxis::Response
       self.status = 307
     end
 
-
     # The request cannot be fulfilled due to bad syntax.
     class BadRequest < Praxis::Response
       self.status = 400
     end
 
-
     # Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. The response must include a WWW-Authenticate header field containing a challenge applicable to the requested resource. See Basic access authentication and Digest access authentication.
     class Unauthorized < Praxis::Response
       self.status = 401
     end
 
-
     # The request was a valid request, but the server is refusing to respond to it. Unlike a 401 Unauthorized response, authenticating will make no difference.
     class Forbidden < Praxis::Response
       self.status = 403
     end
 
-
     # The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible.
     class NotFound < Praxis::Response
       self.status = 404
     end
 
-
     # A request was made of a resource using a request method not supported by that resource; for example, using GET on a form which requires data to be presented via POST, or using PUT on a read-only resource.
     class MethodNotAllowed < Praxis::Response
       self.status = 405
     end
 
-
     # The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.
     class NotAcceptable < Praxis::Response
       self.status = 406
@@ -119,55 +105,48 @@ module Praxis
       self.status = 409
     end
 
-
     # The server does not meet one of the preconditions that the requester put on the request.
     class PreconditionFailed < Praxis::Response
       self.status = 412
     end
 
-
     # The request was well-formed but was unable to be followed due to semantic errors.[3]
     class UnprocessableEntity < Praxis::Response
       self.status = 422
     end
 
     ApiDefinition.define do |api|
-
-
       [
-        [ :accepted, 202, "The request has been accepted for processing, but the processing has not been completed." ],
-        [ :no_content, 204,"The server successfully processed the request, but is not returning any content."],
-        [ :multiple_choices, 300,"Indicates multiple options for the resource that the client may follow."],
-        [ :moved_permanently, 301,"This and all future requests should be directed to the given URI."],
-        [ :found, 302,"The requested resource resides temporarily under a different URI."],
-        [ :see_other, 303,"The response to the request can be found under another URI using a GET method"],
-        [ :not_modified, 304,"Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-Match."],
-        [ :temporary_redirect, 307,"In this case, the request should be repeated with another URI; however, future requests should still use the original URI."],
-        [ :bad_request, 400,"The request cannot be fulfilled due to bad syntax."],
-        [ :unauthorized, 401,"Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided."],
-        [ :forbidden, 403,"The request was a valid request, but the server is refusing to respond to it."],
-        [ :not_found, 404,"The requested resource could not be found but may be available again in the future."],
-        [ :method_not_allowed, 405,"A request was made of a resource using a request method not supported by that resource."],
-        [ :not_acceptable, 406,"The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request."],
-        [ :request_timeout, 408,"The server timed out waiting for the request."],
-        [ :conflict, 409, "Indicates that the request could not be processed because of conflict in the request, such as an edit conflict in the case of multiple updates."],
-        [ :precondition_failed, 412,"The server does not meet one of the preconditions that the requester put on the request."],
-        [ :unprocessable_entity, 422,"The request was well-formed but was unable to be followed due to semantic errors."],
+        [:accepted, 202, 'The request has been accepted for processing, but the processing has not been completed.'],
+        [:no_content, 204, 'The server successfully processed the request, but is not returning any content.'],
+        [:multiple_choices, 300, 'Indicates multiple options for the resource that the client may follow.'],
+        [:moved_permanently, 301, 'This and all future requests should be directed to the given URI.'],
+        [:found, 302, 'The requested resource resides temporarily under a different URI.'],
+        [:see_other, 303, 'The response to the request can be found under another URI using a GET method'],
+        [:not_modified, 304, 'Indicates that the resource has not been modified since the version specified by the request headers If-Modified-Since or If-Match.'],
+        [:temporary_redirect, 307, 'In this case, the request should be repeated with another URI; however, future requests should still use the original URI.'],
+        [:bad_request, 400, 'The request cannot be fulfilled due to bad syntax.'],
+        [:unauthorized, 401, 'Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.'],
+        [:forbidden, 403, 'The request was a valid request, but the server is refusing to respond to it.'],
+        [:not_found, 404, 'The requested resource could not be found but may be available again in the future.'],
+        [:method_not_allowed, 405, 'A request was made of a resource using a request method not supported by that resource.'],
+        [:not_acceptable, 406, 'The requested resource is only capable of generating content not acceptable according to the Accept headers sent in the request.'],
+        [:request_timeout, 408, 'The server timed out waiting for the request.'],
+        [:conflict, 409, 'Indicates that the request could not be processed because of conflict in the request, such as an edit conflict in the case of multiple updates.'],
+        [:precondition_failed, 412, 'The server does not meet one of the preconditions that the requester put on the request.'],
+        [:unprocessable_entity, 422, 'The request was well-formed but was unable to be followed due to semantic errors.']
       ].each do |name, code, base_description|
         api.response_template name do |media_type: nil, location: nil, headers: nil, description: nil|
           status code
-          description( description || base_description ) # description can "potentially" be overriden in an individual action.
+          description(description || base_description) # description can "potentially" be overriden in an individual action.
 
           media_type media_type if media_type
           location location if location
-          headers&.each do |(name, value)|
-            header(name: name, value: value)
+          headers&.each do |(header_name, value)|
+            header(name: header_name, value: value)
           end
         end
       end
-
     end
-
-
   end
 end

data/lib/praxis/responses/internal_server_error.rb

@@ -1,7 +1,7 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   module Responses
-
     # A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.
     class InternalServerError < Praxis::Response
       self.status = 500
@@ -9,37 +9,34 @@ module Praxis
 
       def initialize(error: nil, **opts)
         super(**opts)
-        @headers['Content-Type'] = 'application/json' #TODO: might want an error mediatype
+        @headers['Content-Type'] = 'application/json' # TODO: might want an error mediatype
         @error = error
       end
 
       def format!(exception = @error)
-        if @error
-
-          if Application.instance.config.praxis.show_exceptions == true
-            msg = {
-              name: exception.class.name,
-              message: exception.message,
-              backtrace: exception.backtrace
-            }
-            msg[:cause] = format!(exception.cause) if exception.cause
-          else
-            msg = {name: 'InternalServerError', message: "Something bad happened."}
-          end
-
-          @body = msg
+        return unless @error
+
+        if Application.instance.config.praxis.show_exceptions == true
+          msg = {
+            name: exception.class.name,
+            message: exception.message,
+            backtrace: exception.backtrace
+          }
+          msg[:cause] = format!(exception.cause) if exception.cause
+        else
+          msg = { name: 'InternalServerError', message: 'Something bad happened.' }
         end
+
+        @body = msg
       end
     end
-
   end
 
   ApiDefinition.define do |api|
     api.response_template :internal_server_error do
-      description "A generic error message, given when an unexpected condition was encountered and no more specific message is suitable."
+      description 'A generic error message, given when an unexpected condition was encountered and no more specific message is suitable.'
       status 500
-      media_type "application/json"
+      media_type 'application/json'
     end
   end
-
 end

data/lib/praxis/responses/multipart_ok.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Praxis
   module Responses
     class MultipartOk < Ok
-
-      def initialize(status:self.class.status, headers:{}, body:'')
+      def initialize(status: self.class.status, headers: {}, body: '')
         @name    = response_name
         @status  = status
         @headers = headers
@@ -12,13 +13,10 @@ module Praxis
       def handle
         case @body
         when Praxis::Types::MultipartArray
-          if @headers['Content-Type'].nil?
-            @headers['Content-Type'] = @body.content_type
-          end
+          @headers['Content-Type'] = @body.content_type if @headers['Content-Type'].nil?
         end
       end
 
-
       def encode!
         case @body
         when Praxis::Types::MultipartArray
@@ -36,9 +34,7 @@ module Praxis
 
         [@status, @headers, @body]
       end
-
     end
-
   end
 
   ApiDefinition.define do |api|
@@ -47,5 +43,4 @@ module Praxis
       media_type media_type
     end
   end
-
 end

data/lib/praxis/responses/validation_error.rb

@@ -1,43 +1,36 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   module Responses
-
     class ValidationError < BadRequest
       def initialize(summary:, errors: nil, exception: nil, documentation: nil, **opts)
         super(**opts)
-        @headers['Content-Type'] = 'application/json' #TODO: might want an error mediatype
+        @headers['Content-Type'] = 'application/json' # TODO: might want an error mediatype
         @errors = errors
-        unless @errors # The exception message will the the only error if no errors are passed in
-           @errors = [exception.message] if exception && exception.message
-         end
+        @errors = [exception.message] if !@errors && exception&.message # The exception message will the the only error if no errors are passed in
         @exception = exception
         @summary = summary
         @documentation = documentation
       end
 
       def format!
-        @body = {name: 'ValidationError', summary: @summary }
+        @body = { name: 'ValidationError', summary: @summary }
         @body[:errors] = @errors if @errors
 
-        if @exception && @exception.cause
-          @body[:cause] = {name: @exception.cause.class.name, message: @exception.cause.message}
-        end
+        @body[:cause] = { name: @exception.cause.class.name, message: @exception.cause.message } if @exception&.cause
 
         @body[:documentation] = @documentation if @documentation
 
         @body
       end
     end
-
   end
 
-
   ApiDefinition.define do |api|
     api.response_template :validation_error do
-      description "An error message indicating that one or more elements of the request did not match the API specification for the action"
+      description 'An error message indicating that one or more elements of the request did not match the API specification for the action'
       status 400
-      media_type "application/json"
+      media_type 'application/json'
     end
   end
-
 end

data/lib/praxis/route.rb

@@ -1,9 +1,10 @@
-module Praxis
+# frozen_string_literal: true
 
+module Praxis
   class Route
     attr_accessor :verb, :path, :version, :prefixed_path, :options
 
-    def initialize(verb, path, version='n/a', prefixed_path:nil, **options)
+    def initialize(verb, path, version = 'n/a', prefixed_path: nil, **options)
       @verb = verb
       @path = path
       @version = version
@@ -11,8 +12,8 @@ module Praxis
       @prefixed_path = prefixed_path
     end
 
-    def example(example_hash:{}, params:)
-      path_param_keys = self.path.named_captures.keys.collect(&:to_sym)
+    def example(params:, example_hash: {})
+      path_param_keys = path.named_captures.keys.collect(&:to_sym)
 
       param_attributes = params ? params.attributes : {}
       query_param_keys = param_attributes.keys - path_param_keys
@@ -20,11 +21,10 @@ module Praxis
         array << p if params.attributes[p].options[:required]
       end
 
-      path_params = example_hash.select{|k,v| path_param_keys.include? k }
+      path_params = example_hash.select { |k, _v| path_param_keys.include? k }
       # Let's generate the example only using required params, to avoid mixing incompatible parameters
-      query_params = example_hash.select{|k,v| required_query_param_keys.include? k }
-      example = { verb: self.verb, url: self.path.expand(path_params.transform_values(&:to_s)), query_params: query_params }
-
+      query_params = example_hash.select { |k, _v| required_query_param_keys.include? k }
+      { verb: verb, url: path.expand(path_params.transform_values(&:to_s)), query_params: query_params }
     end
 
     def describe
@@ -36,7 +36,5 @@ module Praxis
       result[:options] = options if options.any?
       result
     end
-
   end
-
 end

data/lib/praxis/router/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Originally from:
 # https://github.com/rkh/mustermann/blob/500a603fffe0594ab842d72addcc449eedd6d5be/mustermann/lib/mustermann/router/rack.rb
 # Copied here after its removal from Mustermann proper
@@ -25,20 +27,24 @@ module Mustermann
     #    # in a config.ru
     #    run router
     class Rack < Simple
-      def initialize(env_prefix: "mustermann", params_key: "#{env_prefix}.params", pattern_key: "#{env_prefix}.pattern", **options, &block)
-        @params_key, @pattern_key = params_key, pattern_key
-        options[:default] = [404, {"Content-Type" => "text/plain", "X-Cascade" => "pass"}, ["Not Found"]] unless options.include? :default
+      def initialize(env_prefix: 'mustermann', params_key: "#{env_prefix}.params", pattern_key: "#{env_prefix}.pattern", **options, &block)
+        @params_key = params_key
+        @pattern_key = pattern_key
+        options[:default] = [404, { 'Content-Type' => 'text/plain', 'X-Cascade' => 'pass' }, ['Not Found']] unless options.include? :default
         super(**options, &block)
       end
 
       def invoke(callback, env, params, pattern)
-        params_was, pattern_was             = env[@params_key], env[@pattern_key]
-        env[@params_key], env[@pattern_key] = params, pattern
+        params_was = env[@params_key]
+        pattern_was = env[@pattern_key]
+        env[@params_key] = params
+        env[@pattern_key] = pattern
         response = callback.call(env)
-        response[1].each { |k,v| throw :pass if k.downcase == 'x-cascade' and v == 'pass' }
+        response[1].each { |k, v| throw :pass if (k.downcase == 'x-cascade') && (v == 'pass') }
         response
       ensure
-        env[@params_key], env[@pattern_key] = params_was, pattern_was
+        env[@params_key] = params_was
+        env[@pattern_key] = pattern_was
       end
 
       def string_for(env)

data/lib/praxis/router/simple.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Originally from:
 # https://github.com/rkh/mustermann/blob/500a603fffe0594ab842d72addcc449eedd6d5be/mustermann/lib/mustermann/router/simple.rb
 # Copied here after its removal from Mustermann proper
@@ -60,7 +62,9 @@ module Mustermann
         @map     = []
         @default = default
 
-        block.arity == 0 ? instance_eval(&block) : yield(self) if block
+        return unless block
+
+        block.arity.zero? ? instance_eval(&block) : yield(self)
       end
 
       # @example
@@ -74,7 +78,7 @@ module Mustermann
       # @return [#call, nil] callback for given string, if a pattern matches
       def [](string)
         string = string_for(string) unless string.is_a? String
-        @map.detect { |p,v| p === string }[1]
+        @map.detect { |p, _v| p === string }[1] # rubocop:disable Style/CaseEquality
       end
 
       # @example
@@ -125,14 +129,15 @@ module Mustermann
       def call(input)
         @map.each do |pattern, callback|
           catch(:pass) do
-            next unless params = pattern.params(string_for(input))
+            next unless (params = pattern.params(string_for(input)))
+
             return invoke(callback, input, params, pattern)
           end
         end
         @default
       end
 
-      def invoke(callback, input, params, pattern)
+      def invoke(callback, input, params, _pattern)
         callback.call(input, params)
       end
 
@@ -143,4 +148,4 @@ module Mustermann
       private :invoke, :string_for
     end
   end
-end
+end

data/lib/praxis/router.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 require 'praxis/router/rack'
 
 module Praxis
-
   class Router
-    attr_reader :request_class
-    attr_reader :application
-
+    attr_reader :request_class, :application
 
     class VersionMatcher
       def initialize(target, version: 'n/a')
         @target = target
         @version = version
       end
+
       def call(request)
         if request.version == @version
           @target.call(request)
@@ -24,13 +24,13 @@ module Praxis
     end
 
     class RequestRouter < Mustermann::Router::Simple
-      def initialize(default: nil, **options, &block)
+      def initialize(**options, &block)
         options[:default] = :not_found
 
         super(**options, &block)
       end
 
-      def invoke(callback, request, params, pattern)
+      def invoke(callback, request, params, _pattern)
         request.route_params = params
         callback.call(request)
       end
@@ -40,7 +40,6 @@ module Praxis
       end
     end
 
-
     def initialize(application, request_class: Praxis::Request)
       @routes = Hash.new do |hash, verb|
         hash[verb] = RequestRouter.new
@@ -55,34 +54,32 @@ module Praxis
       # DEPRECATED: remove with EndpointDefinition.version using: :path
       path_versioning ||= (target.action.endpoint_definition.version_options[:using] == :path)
 
-      unless path_versioning
-        target = VersionMatcher.new(target, version: route.version)
-      end
+      target = VersionMatcher.new(target, version: route.version) unless path_versioning
 
       @routes[route.verb].on(route.path, call: target)
     end
 
     def call(env_or_request)
       request = case env_or_request
-      when Hash
-        request_class.new(env_or_request)
-      when request_class
-        env_or_request
-      else
-        raise ArgumentError, "received #{env_or_request.class}"
-      end
+                when Hash
+                  request_class.new(env_or_request)
+                when request_class
+                  env_or_request
+                else
+                  raise ArgumentError, "received #{env_or_request.class}"
+                end
 
       verb = request.verb
-      r = ( @routes.key?(verb) ? @routes[verb] : nil )  # Exact verb match
+      r = (@routes.key?(verb) ? @routes[verb] : nil) # Exact verb match
       result = r.call(request) if r
       # If we didn't have an exact verb route, or if we did but the rest or route conditions didn't match
-      if( r == nil || result == :not_found )
+      if r.nil? || result == :not_found
         # Fallback to a wildcard router, if there is one registered
         result = if @routes.key?('ANY')
-          @routes['ANY'].call(request)
-        else
-          :not_found
-        end
+                   @routes['ANY'].call(request)
+                 else
+                   :not_found
+                 end
       end
 
       if result == :not_found
@@ -90,25 +87,21 @@ module Praxis
         # plus we wouldn't have tracked it as unmatched
         version = request.version
         attempted_versions = request.unmatched_versions
-        body = "NotFound"
+        body = 'NotFound'
         unless attempted_versions.empty? || (attempted_versions.size == 1 && attempted_versions.first == 'n/a')
           body += if version == 'n/a'
-            ". Your request did not specify an API version.".freeze
-          else
-            ". Your request specified API version = \"#{version}\"."
-          end
+                    '. Your request did not specify an API version.'
+                  else
+                    ". Your request specified API version = \"#{version}\"."
+                  end
           pretty_versions = attempted_versions.collect(&:inspect).join(', ')
           body += " Available versions = #{pretty_versions}."
         end
-        headers = {"Content-Type" => "text/plain"}
-        if Praxis::Application.instance.config.praxis.x_cascade
-          headers['X-Cascade'] = 'pass'
-        end
+        headers = { 'Content-Type' => 'text/plain' }
+        headers['X-Cascade'] = 'pass' if Praxis::Application.instance.config.praxis.x_cascade
         result = [404, headers, [body]]
       end
       result
     end
-
   end
-
 end