hanko-rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f88c528ee17c1ca2a5c9fe5f220647fabbaab95f4d45be435fd685ad46f64fff
-  data.tar.gz: 31ddfb033770159e3f92178cbb4333df5cdf7c8fc816f792129016bb7c4587b4
+  metadata.gz: c06034c2f3144758ec9276ba4de655e373e05cf0f43c19cfc4d4e12f9adb9fcf
+  data.tar.gz: b464d85f4d3378930e573296099af1f6602f11f8821e7eb05b72a73b71b3b24d
 SHA512:
-  metadata.gz: 2b8bf26bd7ad716c76a3ff132e52e3cfcf925f699f139a9624aab7608aa4d7d4a6fe218da95836943155c0271fc5c08183a12d4c405cb889405e619a5ccde8b6
-  data.tar.gz: a348e88853512e7d55b9988ce300e4059815c93a08c40daaf4a8b30b578ab7cb8e217d7240c564d9d4bf61d0c7d889e9d85f66debdeece0b75fd444fc4332501
+  metadata.gz: 7092b66e836e68f7f50d618e8513bd78daeee2920b260637d7e17d7b8f87fd764af29260d96e3903c60defdd309d7e2802277ca5c34d11e098bcd1e64d33f286
+  data.tar.gz: c2b83f34863b56658cb974f8aec454f951564a012f82859224024b69019958bc497c55fa0a179b2045a75df338267fdadbcf7dd751d880ad93c054195b282fc5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Fernando Ruiz
+
+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,167 @@
+# hanko-rails
+
+[![CI](https://github.com/fruizg0302/hanko-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/fruizg0302/hanko-ruby/actions)
+[![Gem Version](https://badge.fury.io/rb/hanko-rails.svg)](https://rubygems.org/gems/hanko-rails)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Rails integration for the [Hanko](https://www.hanko.io/) authentication platform. Provides Rack middleware for automatic session verification, controller helpers, an install generator, and test helpers.
+
+> **Using Ruby without Rails?** See [hanko-ruby](https://rubygems.org/gems/hanko-ruby) for the framework-agnostic SDK.
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'hanko-rails'   # pulls in hanko-ruby automatically
+```
+
+```sh
+bundle install
+```
+
+## Setup
+
+Generate the initializer:
+
+```sh
+bin/rails generate hanko:install
+```
+
+This creates `config/initializers/hanko.rb`:
+
+```ruby
+Hanko.configure do |config|
+  config.api_url = ENV.fetch('HANKO_API_URL', 'https://your-hanko-instance.hanko.io')
+  # config.api_key = ENV.fetch('HANKO_API_KEY', nil)
+end
+
+Hanko::Rails.configure do |config|
+  # config.cookie_name = 'hanko'
+  # config.exclude_paths = ['/healthz', '/up']
+  # config.jwks_cache_ttl = 3600
+end
+```
+
+## Middleware
+
+`Hanko::Rails::Middleware` is automatically inserted into the Rack stack by the engine. It:
+
+1. Extracts tokens from the `hanko` cookie or `Authorization: Bearer` header
+2. Verifies the JWT against the JWKS endpoint
+3. Sets `request.env['hanko.session']` with the decoded payload
+
+Configure which paths to skip:
+
+```ruby
+Hanko::Rails.configure do |config|
+  config.exclude_paths = ['/healthz', '/up', '/assets']
+end
+```
+
+## Authentication Concern
+
+Include `Hanko::Rails::Authentication` in your controllers:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Hanko::Rails::Authentication
+
+  before_action :authenticate_hanko_user!
+end
+```
+
+### Available helpers
+
+| Helper | Returns |
+|--------|---------|
+| `hanko_session` | Decoded JWT payload hash, or `nil` |
+| `hanko_user_id` | The `sub` claim (user UUID), or `nil` |
+| `hanko_authenticated?` | `true` if a valid session exists |
+| `current_hanko_user` | Alias for `hanko_user_id` |
+| `authenticate_hanko_user!` | Redirects (HTML) or returns 401 (JSON) if unauthenticated |
+
+All helpers except `authenticate_hanko_user!` are also available in views.
+
+## Using with your User model
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Hanko::Rails::Authentication
+
+  def current_user
+    @current_user ||= User.find_by(hanko_id: hanko_user_id) if hanko_authenticated?
+  end
+  helper_method :current_user
+end
+```
+
+## Testing
+
+The test helper is **opt-in** — require it explicitly:
+
+```ruby
+require 'hanko/rails/test_helper'
+```
+
+### Setup with RSpec
+
+```ruby
+# spec/support/hanko.rb
+require 'hanko/rails/test_helper'
+
+RSpec.configure do |config|
+  config.include Hanko::Rails::TestHelper, type: :request
+end
+```
+
+### Usage
+
+```ruby
+RSpec.describe 'Dashboard', type: :request do
+  it 'requires authentication' do
+    get '/dashboard'
+    expect(response).to have_http_status(:unauthorized)
+  end
+
+  it 'shows dashboard for authenticated user' do
+    sign_in_as_hanko_user('user-uuid')
+    get '/dashboard'
+    expect(response).to have_http_status(:ok)
+  end
+
+  it 'handles sign out' do
+    sign_in_as_hanko_user('user-uuid')
+    sign_out_hanko_user
+    get '/dashboard'
+    expect(response).to have_http_status(:unauthorized)
+  end
+end
+```
+
+## Configuration Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `cookie_name` | `'hanko'` | Name of the cookie holding the Hanko JWT |
+| `jwks_cache_ttl` | `3600` | JWKS cache lifetime in seconds |
+| `exclude_paths` | `[]` | Request path prefixes that skip verification |
+
+## Requirements
+
+- Ruby >= 3.1
+- Rails >= 7.0
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/my-feature`)
+3. Write tests for your changes
+4. Ensure all tests pass: `bundle exec rspec`
+5. Ensure linting passes: `bundle exec rubocop`
+6. Commit your changes (`git commit -m 'Add my feature'`)
+7. Push to the branch (`git push origin feature/my-feature`)
+8. Open a Pull Request
+
+## License
+
+Released under the [MIT License](LICENSE.txt).

data/lib/hanko/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Hanko
   module Rails
-    VERSION = '0.1.4'
+    VERSION = '0.1.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanko-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Fernando Ruiz
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - lib/hanko-rails.rb
 - lib/hanko/rails/authentication.rb
 - lib/hanko/rails/configuration.rb
@@ -67,6 +69,8 @@ metadata:
   homepage_uri: https://github.com/fruizg0302/hanko-ruby
   source_code_uri: https://github.com/fruizg0302/hanko-ruby/tree/main/hanko-rails
   changelog_uri: https://github.com/fruizg0302/hanko-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/fruizg0302/hanko-ruby/issues
+  documentation_uri: https://rubydoc.info/gems/hanko-rails
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: