imprint-image 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1844ab246c97a048a3ffd9a5f97ef4194b96c44ced2986f2c7ec7de1c96f872c
-  data.tar.gz: dae5536d6035f67546136f12ffe1fc52d602bdffc8dd5eeba120fec2313c4cd7
+  metadata.gz: 74fc0a692977e7e71b4b60c67b5a4df6f031cf3a1ab300d7b101f64eace13870
+  data.tar.gz: 610281c24277f365da0c123fae869a1bcb58ccd1c26e3231e77bb6e684e4104a
 SHA512:
-  metadata.gz: ba77ada64c1f0fb91755aa766dbbdb330eee4ec7c630fedcd467a858569f751ac546c5a823c9857e4ae67e737a911bf686a2fe2a26b4a25e427450766ed3e3d4
-  data.tar.gz: 8cf8d948c812075b068479e25737a0d43999831f2dea87a018d6d62fe8c1049d96bb27076f88173ed91d4bd4ae1939669d768402ee9e8ce8e5c215c14014d909
+  metadata.gz: 7b03cabfb248058c3d74cc786eb13bc7db0e9047e02d410ae5e61a1aef532fb294fd4a7c2c3056d39279014fe93160d3fdc84bc13e04b746710d68fa38c42c7e
+  data.tar.gz: 258bd180f84820402c8427f478c06032a0d9ea16282c1408a2a9f7611b1e27e7a17bd8fc0188dae4a16f95dcf4844cfb3e39c442c96d635cb7d6328949332051

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## Changelog.md
+
+## 0.1.1 - 2026-01-21
+
+- Optional Rails integration via Railtie
+- Rails view helper for rendering signed images
+- Documentation for Rails usage
+
+## [0.1.0] - 2026-01-20

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Giménez Silva Germán Alberto
+
+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,158 @@
+# Imprint Image
+
+**Signed, expiring image watermark rendering for Ruby**
+
+`imprint-image` 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, hotlinking, or permanent access.
+
+The library is **framework-agnostic** and works as pure Ruby, with **optional Rails integration**.
+
+Image rendering is powered by the **GD graphics library**.
+
+---
+
+## Features
+
+- 🔐 Signed tokens with expiration
+- 🖼 Dynamic text watermarks rendered on the fly
+- ⏱ Time-limited image access
+- 🚫 Prevents hotlinking and unauthorized reuse
+- 🧩 Pure Ruby core
+- 🚆 Optional Rails integration (no forced dependency)
+
+---
+
+## Installation
+
+### RubyGems
+
+```bash
+gem install imprint-image
+```
+
+or in your `Gemfile`:
+
+```ruby
+gem 'imprint-image'
+```
+
+---
+
+## Requirements
+
+- Ruby ≥ 3.3
+- GD graphics library (`libgd`)
+- The `ruby-libgd` gem (installed automatically)
+
+On Debian / Ubuntu:
+
+```bash
+sudo apt install libgd-dev
+```
+
+---
+
+## Basic Usage (Pure Ruby)
+
+### Generate a signed token
+
+```ruby
+token = Imprint.sign(
+  source: '/path/to/image.png',
+  watermark: 'CONFIDENTIAL',
+  expires_in: 60
+)
+```
+
+---
+
+### Render an image from a token
+
+```ruby
+output_path = Imprint.render_from_token(token)
+
+if output_path
+  puts "Rendered image at: #{output_path}"
+else
+  puts "Token expired or invalid"
+end
+```
+
+---
+
+## Rails Integration (Optional)
+
+Imprint does **not** force routes or controllers.
+
+### Example Route
+
+```ruby
+get '/imprint/:token', to: 'imprint#show'
+```
+
+---
+
+### Example 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
+```
+
+---
+
+### Example View
+
+```erb
+<img src="/imprint/<%= token.split('/').last %>" />
+```
+
+---
+
+## Rails View Helper
+
+```erb
+<%= imprint_image_tag(token, class: "watermarked") %>
+```
+
+---
+
+## Security Model
+
+- Tokens are signed and tamper-proof
+- Tokens include an expiration timestamp
+- Expired tokens cannot be rendered
+
+---
+
+## Temporary Files
+
+Rendered images are written to `Dir.tmpdir`.
+You are responsible for cleaning them if needed.
+
+---
+
+## Development
+
+```bash
+bundle install
+bundle exec rake
+```
+
+---
+
+## License
+
+MIT License.
+
+---
+
+## Author
+
+Germán Giménez Silva  
+https://github.com/ggerman

data/lib/imprint/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Imprint::Engine.routes.draw do
+  get 'render/:token', to: 'renders#show'
+end

data/lib/imprint/controllers/imprint/renders_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Imprint
+  class RendersController < ActionController::Base
+    def show
+      path = Imprint.render_from_token(params[:token])
+
+      return head :not_found unless path && File.exist?(path)
+
+      send_file(
+        path,
+        type: 'image/png',
+        disposition: 'inline',
+        cache_control: 'no-store'
+      )
+    end
+  end
+end

data/lib/imprint/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Imprint
+  class Engine < ::Rails::Engine
+    isolate_namespace Imprint
+  end
+end

data/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

data/lib/imprint/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'imprint-image'
+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

data/lib/imprint/renderer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'gd'
+require 'securerandom'
+require 'tmpdir'
+
+module Imprint
+  class Renderer
+    DEFAULT_FONT_SIZE = 24
+
+    def self.render(source:, watermark:)
+      raise ArgumentError, 'source image not found' unless File.exist?(source)
+
+      image = GD::Image.open(source)
+
+      apply_watermark(image, watermark)
+
+      output = File.join(
+        Dir.tmpdir,
+        "imprint-#{SecureRandom.hex(8)}.png"
+      )
+
+      image.save(output)
+      output
+    end
+
+    def self.apply_watermark(image, text)
+      color = GD::Color.rgba(0, 116, 139, 225)
+
+      raise "Font missing" unless File.exist?(default_font)
+
+      image.text(
+        text,
+        x: 20,
+        y: image.height - 20,
+        size: DEFAULT_FONT_SIZE,
+        color: color,
+        font: default_font
+      )
+    end
+
+    def self.default_font
+      @default_font ||= begin
+        font = '/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf'
+        raise 'Font not found' unless File.exist?(font)
+
+        font
+      end
+    end
+  end
+end

data/lib/imprint/signer.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "openssl"
+require "json"
+require "base64"
+
+module Imprint
+  class Signer
+    ALGORITHM = "HS256"
+
+    def self.sign(payload, secret:)
+      data = Base64.urlsafe_encode64(payload.to_json)
+      signature = OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new("sha256"),
+        secret,
+        data
+      )
+
+      "#{data}.#{signature}"
+    end
+
+    def self.verify(token, secret:)
+      data, signature = token.split(".", 2)
+      return nil unless data && signature
+
+      expected = OpenSSL::HMAC.hexdigest(
+        OpenSSL::Digest.new("sha256"),
+        secret,
+        data
+      )
+
+      return nil unless secure_compare(expected, signature)
+
+      JSON.parse(Base64.urlsafe_decode64(data))
+    rescue JSON::ParserError, ArgumentError
+      nil
+    end
+
+    def self.secure_compare(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      OpenSSL.fixed_length_secure_compare(a, b)
+    end
+  end
+end

data/lib/imprint/version.rb

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

data/lib/imprint-image.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'imprint/version'
+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:)
+    payload = {
+      source: source,
+      watermark: watermark,
+      exp: Time.now.to_i + expires_in.to_i
+    }
+
+    token = Signer.sign(payload, secret: secret_key)
+    "/imprint/render/#{token}"
+  end
+
+  def self.verify(token)
+    payload = Signer.verify(token, secret: secret_key)
+    return nil unless payload.is_a?(Hash)
+
+    return nil if payload['exp'].to_i < Time.now.to_i
+
+    payload
+  end
+
+  def self.render_from_token(token)
+    payload = verify(token)
+    return nil unless payload
+
+    Renderer.render(
+      source: payload['source'],
+      watermark: payload['watermark']
+    )
+  end
+
+  def self.secret_key
+    # sin engine todavía; Rails solo si existe
+    if defined?(Rails)
+      Rails.application.secret_key_base
+    else
+      ENV['IMPRINT_SECRET'] || 'imprint-dev-secret'
+    end
+  end
+end

data/lib/imprint.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'imprint'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imprint-image
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Giménez Silva Germán Alberto
@@ -35,7 +35,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/imprint-image.rb
+- lib/imprint.rb
+- lib/imprint/config/routes.rb
+- lib/imprint/controllers/imprint/renders_controller.rb
+- lib/imprint/engine.rb
+- lib/imprint/rails/helper.rb
+- lib/imprint/railtie.rb
+- lib/imprint/renderer.rb
+- lib/imprint/signer.rb
+- lib/imprint/version.rb
 homepage: https://github.com/ggerman/imprint
 licenses:
 - MIT