Feature/railtie

CHANGELOG.md

@@ -1,5 +1,7 @@
-## [Unreleased]
+## Changelog.md
 
-## [0.1.0] - 2026-01-20
 
-- Initial release
+## 0.1.1
+- Rails integration documentation
+- Optional Railtie for Rails environments
+## [0.1.0] - 2026-01-20

README.md

@@ -18,4 +18,45 @@ brew install gd
 ### Gemfile
 ```bash
 gem 'imprint'
-```
+```
+
+
+
+## Rails integration
+
+Imprint is framework-agnostic, but integrates cleanly with Rails.
+
+### Routes
+
+Define your own route:
+
+```ruby
+# config/routes.rb
+get '/imprint/:token', to: 'imprint#show'
+```
+### Controller
+
+```ruby
+class ImprintController < ApplicationController
+  def show
+    path = Imprint.render_from_token(params[:token])
+
+    return head :not_found unless path
+
+    send_file path, type: 'image/png', disposition: 'inline'
+  end
+end
+```
+
+### Usage
+
+```ruby
+token = Imprint.sign(
+  source: '/path/to/image.png',
+  watermark: 'CONFIDENTIAL',
+  expires_in: 5.minutes
+)
+```
+```html
+<img src="/imprint/<%= token.split('/').last %>" />
+```

imprint.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Signed, expiring image watermark rendering for Ruby"
   spec.description = <<~DESC
-  Imprint is a Ruby library for generating signed, time-limited image renders
-  with dynamic text watermarks. It allows you to securely distribute images
-  using expiring tokens, preventing unauthorized reuse or hotlinking.
+    Imprint is a Ruby library for generating signed, time-limited image renders
+    with dynamic text watermarks. It allows you to securely distribute images
+    using expiring tokens, preventing unauthorized reuse or hotlinking.
 
-  Imprint works as a pure Ruby library and can optionally integrate with Rails
-  via an isolated engine. Image rendering is powered by the GD graphics library.
-DESC
+    Imprint works as a pure Ruby library and can optionally integrate with Rails
+    via an isolated engine. Image rendering is powered by the GD graphics library.
+  DESC
   spec.homepage = "https://github.com/ggerman/imprint"
   spec.license = "MIT"
   spec.required_ruby_version = '>= 3.3.0'

lib/imprint.rb

@@ -4,6 +4,7 @@
 require 'imprint/signer'
 require 'imprint/renderer'
 require 'imprint/engine' if defined?(Rails)
+require 'imprint/railtie' if defined?(Rails)
 
 module Imprint
   def self.sign(source:, watermark:, expires_in:)

lib/imprint/rails/helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Imprint
+  module Rails
+    module Helper
+      def imprint_image_tag(token, **)
+        image_tag(
+          imprint_render_path(token: token),
+          **
+        )
+      end
+    end
+  end
+end

lib/imprint/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Imprint
+  class Railtie < Rails::Railtie
+    initializer 'imprint.helpers' do
+      ActiveSupport.on_load(:action_view) do
+        include Imprint::Rails::Helper
+      end
+    end
+
+    initializer 'imprint.configure' do
+      # Punto de extensión futuro
+    end
+  end
+end