vesper-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e98b2d23c5885f907bc2702d46af805272c5b1f98b4a8fa3f1cb916e7820fb1
+  data.tar.gz: 870fccc4984bc95282b61a6032eb8f83b4e4764d4f813c5c2df8af27f808a17e
+SHA512:
+  metadata.gz: 9562351a798194fed8f265438afc25ee6f1da03c093db32897d651f739a2d6acbd29df261c42e543afebdb7d07c0ff1b7ecfcf3975866ecfe7eb2a1fc9dbe1b9
+  data.tar.gz: 6dfc2308d5e03ea609a000144e9c26b69e278442b4a8c206a580bd03b18250a8552535283cde36ed5e33887a1d28771eaa78b7b3cf89c068e8efdf9376383a71

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2026-10-18
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yasumasa Ashida
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Vesper Rails
+
+Vesper Rails links Vesper and Ruby on Rails.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add vesper-rails
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install vesper-rails
+```
+
+## Usage
+
+### REST API
+
+```
+class ApplicationController < Vesper::Api::Controller
+  ...
+end
+```
+
+### other
+
+```
+class ApplicationController < Vesper::Controller
+  ...
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asip/vesper-rails.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/app/controllers/vesper/api/controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Vesper::Api::Controller
+module Vesper
+  module Api
+    class Controller < ActionController::API
+      include Vesper::Api::Renderable
+    end
+  end
+end

data/app/controllers/vesper/controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Vesper::Controller
+class Vesper::Controller < ActionController::Base
+  include Vesper::Stream::Renderable
+end

data/lib/vesper/api/error/renderable.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Vesper::Api::Error::Renderable module
+module Vesper
+  module Api
+    module Error
+      module Renderable
+        extend ActiveSupport::Concern
+
+        included do
+          # Standard Error
+          rescue_from StandardError, with: ->(exception) { request.format.json? ? on_internal_server_error(exception) : raise(exception) }
+
+          # ActiveRecord Error
+          rescue_from ActiveRecord::RecordNotFound, with: ->(exception) { request.format.json? ? on_not_found(exception) : raise(exception) }
+          rescue_from ActiveRecord::RecordNotUnique, with: ->(exception) { request.format.json? ? on_conflict(exception) : raise(exception) }
+          rescue_from ActiveRecord::RecordInvalid, with: ->(exception) { request.format.json? ? on_unprocessable_content(exception) : raise(exception) }
+
+          # UnauthorizedError
+          rescue_from Vesper::Api::UnauthorizedError, with: ->(exception) { request.format.json? ? on_unauthorized(exception) : raise(exception) }
+        end
+
+        protected
+
+        def render_errors(resource)
+          render_resource Vesper::Resources::ErrorMessagesResource.new(Vesper::Models::ErrorMessages.new(errors: error_map(resource))).serialize,
+                          status: :unprocessable_content
+        end
+
+        private
+
+        def error_map(resource)
+          resource.errors.to_hash(false).with_indifferent_access
+        end
+
+        # Common helper methods for rendering error response (エラーレスポンスをレンダリングする共通のヘルパーメソッド
+
+        # HTTP Status 400 Bad Request
+        def on_bad_request(exception = nil)
+          render_error(:bad_request, exception)
+        end
+
+        # HTTP Status 401 Unauthorized
+        def on_unauthorized(exception = nil)
+          render_error(:unauthorized, exception)
+        end
+
+        # HTTP Status 404 Not Found
+        def on_not_found(exception = nil)
+          render_error(:not_found, exception)
+        end
+
+        # HTTP Status 409 Conflict
+        def on_conflict(exception = nil)
+          render_error(:conflict, exception)
+        end
+
+        # HTTP Status 422 Unprocessable Content
+        def on_unprocessable_content(exception = nil)
+          render_error(:unprocessable_content, exception)
+        end
+
+        # HTTP Status 500 Internal Server Error
+        def on_internal_server_error(exception = nil)
+          logger.error exception.full_message
+          # logger.error exception.backtrace.join("\n") # backtrace
+
+          render_error(:internal_server_error, exception)
+        end
+
+        def make_error_map(status, exception)
+          error = {
+            title: status.to_s.titleize,
+            detail: exception&.message
+          }
+
+          if status == :not_found
+            error[:source] = exception.model
+          end
+
+          error
+        end
+
+        def render_error(status, exception)
+          error = make_error_map(status, exception)
+
+          # puts error
+
+          render_resource Vesper::Resources::ErrorMapResource.new(Vesper::Models::ErrorMap.new(error)).serialize,
+                          status:
+        end
+      end
+    end
+  end
+end

data/lib/vesper/api/renderable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Vesper::Api::Renderable module
+module Vesper
+  module Api
+    module Renderable
+      extend ActiveSupport::Concern
+      include Vesper::Api::Error::Renderable
+
+      protected
+
+      def render_resource(resource, status: :ok)
+        render json: resource, status:
+      end
+    end
+  end
+end

data/lib/vesper/api/unauthorized_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Custom error class for unauthorized api access (API未認証アクセス用のカスタムエラークラス)
+module Vesper
+  module Api
+    class UnauthorizedError < StandardError
+      def initialize(message = "Authentication information is invalid.")
+        super(message)
+      end
+    end
+  end
+end

data/lib/vesper/engine.rb

@@ -0,0 +1,8 @@
+
+
+# Vesper::Engine class
+module Vesper
+  class Engine < ::Rails::Engine
+    isolate_namespace Vesper
+  end
+end

data/lib/vesper/model/errors/a_p_i.rb

@@ -0,0 +1,14 @@
+# Vesper::Model::Errors::API module
+module Vesper
+  module Model
+    module Errors
+      module API
+        extend ActiveSupport::Concern
+
+        def error_map
+          self.errors.to_hash(false).with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/vesper/models/error_map.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Vesper::Models::ErrorMap class
+#
+module Vesper
+  module Models
+    class ErrorMap
+      include ActiveModel::API
+      include ActiveModel::Attributes
+
+      attribute :title, :string
+      attribute :detail, :string
+      attribute :source, :string
+
+      def initialize(attributes)
+        super(attributes)
+      end
+
+      def to_h
+        attributes.with_indifferent_access
+      end
+    end
+  end
+end

data/lib/vesper/models/error_messages.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# Vesper::Models::ErrorMessages class
+#
+module Vesper
+  module Models
+    class ErrorMessages
+      include ActiveModel::API
+      include ActiveModel::Attributes
+
+      attribute :errors, :hash, default: {}
+
+      def initialize(attributes)
+        super(attributes)
+      end
+
+      def to_h
+        attributes.with_indifferent_access
+      end
+    end
+  end
+end

data/lib/vesper/resources/application_resource.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Vesper::Resources::ApplicationResource
+module Vesper
+  module Resources
+    class ApplicationResource
+      include Alba::Resource
+      helper Typelizer::DSL
+    end
+  end
+end

data/lib/vesper/resources/error_map_resource.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Vesper::Resources::ErrorMapResource
+module Vesper
+  module Resources
+    class ErrorMapResource < Vesper::Resources::ApplicationResource
+      attributes :title, :detail
+
+      attributes :source, if: ->(_error, attribute) { attribute.present? }
+
+      typelize title: :string, detail: :string, source: "string?"
+    end
+  end
+end

data/lib/vesper/resources/error_messages_resource.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Vesper::Resources::ErrorMessagesResource
+module Vesper
+  module Resources
+    class ErrorMessagesResource < Vesper::Resources::ApplicationResource
+      attributes :errors
+
+      typelize errors: "Record<string, string[]>"
+    end
+  end
+end

data/lib/vesper/stream/error/renderable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Vesper::Stream::Error::Renderable module
+module Vesper
+  module Stream
+    module Error
+      module Renderable
+        extend ActiveSupport::Concern
+
+        protected
+
+        def render_error_stream
+          render_stream status: :unprocessable_content
+        end
+      end
+    end
+  end
+end

data/lib/vesper/stream/renderable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Vesper::Stream::Renderable module
+module Vesper
+  module Stream
+    module Renderable
+      extend ActiveSupport::Concern
+      include Vesper::Stream::Error::Renderable
+
+      protected
+
+      def render_stream(status: :ok)
+        render layout: false, content_type: "text/vnd.turbo-stream.html", status:
+      end
+    end
+  end
+end

data/lib/vesper/types/hash_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Vesper::Types::HashType class
+#
+module Vesper
+  module Types
+    class HashType < ActiveModel::Type::Value
+      def cast(value)
+        case value
+          when Hash then value
+          when String then Oj.load(value)
+          when NilClass then {}
+          else Hash(value)
+        end
+      end
+
+      def serialize(value)
+        JsonUtil.stringify(Hash(value))
+      end
+    end
+  end
+end
+
+ActiveModel::Type.register(:hash, Vesper::Types::HashType)

data/lib/vesper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Vesper
+  VERSION = "0.1.0"
+end

data/lib/vesper-rails.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'vesper/api/error/renderable'
+require 'vesper/api/renderable'
+require 'vesper/api/unauthorized_error'
+
+require 'vesper/model/errors/a_p_i'
+
+require 'vesper/types/hash_type'
+
+require 'vesper/models/error_map'
+require 'vesper/models/error_messages'
+
+require 'vesper/resources/application_resource'
+require 'vesper/resources/error_map_resource'
+require 'vesper/resources/error_messages_resource'
+
+require 'vesper/stream/error/renderable'
+require 'vesper/stream/renderable'
+
+require 'vesper/engine'
+
+module Vesper
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: vesper-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasumasa Ashida
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: alba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: typelizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+email:
+- ys.ashida@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/vesper/api/controller.rb
+- app/controllers/vesper/controller.rb
+- lib/vesper-rails.rb
+- lib/vesper/api/error/renderable.rb
+- lib/vesper/api/renderable.rb
+- lib/vesper/api/unauthorized_error.rb
+- lib/vesper/engine.rb
+- lib/vesper/model/errors/a_p_i.rb
+- lib/vesper/models/error_map.rb
+- lib/vesper/models/error_messages.rb
+- lib/vesper/resources/application_resource.rb
+- lib/vesper/resources/error_map_resource.rb
+- lib/vesper/resources/error_messages_resource.rb
+- lib/vesper/stream/error/renderable.rb
+- lib/vesper/stream/renderable.rb
+- lib/vesper/types/hash_type.rb
+- lib/vesper/version.rb
+homepage: https://github.com/asip/vesper-rails
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.22
+specification_version: 4
+summary: Vesper Rails
+test_files: []