hanami-action 3.0.0.rc1

data/lib/hanami/http/status.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require "rack/utils"
+
+module Hanami
+  # @since 0.1.0
+  # @api private
+  module Http
+    # An HTTP status
+    #
+    # @since 0.1.0
+    # @api private
+    class Status
+      # A set of standard codes and messages for HTTP statuses
+      #
+      # @since 0.1.0
+      # @api private
+      ALL = ::Rack::Utils::HTTP_STATUS_CODES
+
+      # Symbolic names for status codes
+      #
+      # @since 2.0.2
+      # @api private
+      SYMBOLS = ::Rack::Utils::SYMBOL_TO_STATUS_CODE.merge(
+        unprocessable_content: 422,
+        unprocessable_entity: 422
+      )
+
+      # Return a status for the given code
+      #
+      # @param code [Integer, Symbol] a valid HTTP code
+      #
+      # @return [Array] a pair of code and message for an HTTP status
+      #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @since 0.1.0
+      # @api private
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.for_code(401)
+      #     # => [401, "Unauthorized"]
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.for_code(:unauthorized)
+      #     # => [401, "Unauthorized"]
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.for_code(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.for_code(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      def self.for_code(code)
+        case code
+        when Integer
+          ALL.assoc(code)
+        when Symbol
+          ALL.assoc(SYMBOLS[code])
+        end or raise ::Hanami::Action::UnknownHttpStatusError.new(code)
+      end
+
+      # Return a status code for the given code
+      #
+      # @param code [Integer,Symbol] a valid HTTP code
+      #
+      # @return [Integer] a message for the given status code
+      #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
+      # @since 2.0.2
+      # @api private
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(401)
+      #     # => 401
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(:unauthorized)
+      #     # => 401
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.lookup(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      def self.lookup(code)
+        for_code(code)[0]
+      end
+
+      # Return a message for the given status code
+      #
+      # @param code [Integer,Symbol] a valid HTTP code
+      #
+      # @return [String] a message for the given status code
+      #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
+      # @since 0.3.2
+      # @api private
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(401)
+      #     # => "Unauthorized"
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(:unauthorized)
+      #     # => "Unauthorized"
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.message_for(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      def self.message_for(code)
+        for_code(code)[1]
+      end
+    end
+  end
+end

data/lib/hanami-action.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/action"

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: hanami-action
+version: !ruby/object:Gem::Version
+  version: 3.0.0.rc1
+platform: ruby
+authors:
+- Hanakai team
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.16
+- !ruby/object:Gem::Dependency
+  name: hanami-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  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: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Complete, fast and testable actions for Rack and Hanami
+email:
+- info@hanakai.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- hanami-action.gemspec
+- lib/hanami-action.rb
+- lib/hanami/action.rb
+- lib/hanami/action/body_parser.rb
+- lib/hanami/action/body_parser/json.rb
+- lib/hanami/action/body_parser/multipart_form.rb
+- lib/hanami/action/cache.rb
+- lib/hanami/action/cache/cache_control.rb
+- lib/hanami/action/cache/conditional_get.rb
+- lib/hanami/action/cache/directives.rb
+- lib/hanami/action/cache/expires.rb
+- lib/hanami/action/config.rb
+- lib/hanami/action/config/formats.rb
+- lib/hanami/action/constants.rb
+- lib/hanami/action/cookie_jar.rb
+- lib/hanami/action/cookies.rb
+- lib/hanami/action/csrf_protection.rb
+- lib/hanami/action/errors.rb
+- lib/hanami/action/flash.rb
+- lib/hanami/action/halt.rb
+- lib/hanami/action/mime.rb
+- lib/hanami/action/mime/request_mime_weight.rb
+- lib/hanami/action/params.rb
+- lib/hanami/action/rack/file.rb
+- lib/hanami/action/rack_utils.rb
+- lib/hanami/action/request.rb
+- lib/hanami/action/request/session.rb
+- lib/hanami/action/response.rb
+- lib/hanami/action/session.rb
+- lib/hanami/action/validatable.rb
+- lib/hanami/action/version.rb
+- lib/hanami/action/view_name_inferrer.rb
+- lib/hanami/http/status.rb
+homepage: https://hanamirb.org
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/hanami/hanami-action/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/hanami/hanami-action
+  bug_tracker_uri: https://github.com/hanami/hanami-action/issues
+  funding_uri: https://github.com/sponsors/hanami
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.14
+specification_version: 4
+summary: Complete, fast and testable actions for Rack and Hanami
+test_files: []