html2img-client 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26b9fea9182f0ceb819242d093a8deaf5d661e3d25c3ff20f90286120c7b52d
-  data.tar.gz: 41691473ff4cc2ad5d17cb27ef5cf43b7500b08bc2acb4ad5ad913d9fa0600d3
+  metadata.gz: 2408ba406bee12b50306a3237e4ddd7e4bae09e170ea6e767aa870f2ce19ecd6
+  data.tar.gz: f2aeb2722ae4c14c07aff053a073658d968231e09500c884ab792afde5801042
 SHA512:
-  metadata.gz: fc292634a6b4cb762ca9f475187e6d3c9059983a486181926e3c98bf35a287296d16969cb8b9831e0bab741c9b3792c69a802d6edc51a81aa966e7298477e364
-  data.tar.gz: cc605647b58582a4182335d2412474a23b9fbdbcb3c8a2938bc74cc2ee5e1e2034d372e777c3a6ecf8ad109ac1a5b0344e7555cbfca359c38d93703dea4b3107
+  metadata.gz: 63780af867f2b8087bb1faf8c5818fe1b4fa3b3d4d9b527f4709de568e85ddd4ab7fa84d8b9080445c48c8ea3b049296a9ff420763d33a82b3143e4008e64d5f
+  data.tar.gz: d53bed7411b6b5157e2bcc78b9488d74c6ceead1fef88b0be836c8802a77714f4a0f0d72f355e49a6fa68b089e41a561da44c423807fdbcc5b43cae397f7f757

data/CHANGELOG.md

@@ -6,6 +6,19 @@ follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the
 
 ## [Unreleased]
 
+## [1.1.0] - 2026-08-16
+
+### Added
+
+- A Railtie, loaded automatically when Rails is present, so a Rails app can
+  configure the client with `config.html2img.api_key` (and `base_url`,
+  `timeout`, `transport`) from any environment file.
+- `rails generate html2img:install`, which writes a commented
+  `config/initializers/html2img.rb`.
+
+Both are optional and add no runtime dependencies: `rails/railtie` is only
+required when Rails is already loaded.
+
 ## [1.0.0] - 2026-08-16
 
 Initial release of the official Ruby client for the
@@ -30,5 +43,6 @@ Initial release of the official Ruby client for the
   responding to `#call` can replace it.
 - An `html2img` executable with `test`, `html`, `screenshot` and `template`.
 
-[Unreleased]: https://github.com/html2img/html2img-ruby/compare/v1.0.0...HEAD
+[Unreleased]: https://github.com/html2img/html2img-ruby/compare/v1.1.0...HEAD
+[1.1.0]: https://github.com/html2img/html2img-ruby/compare/v1.0.0...v1.1.0
 [1.0.0]: https://github.com/html2img/html2img-ruby/releases/tag/v1.0.0

data/README.md

@@ -235,6 +235,22 @@ post.og_image.attach(
 
 ## Rails
 
+The gem detects Rails and loads a Railtie, so there is nothing to require. Generate an initializer:
+
+```bash
+bin/rails generate html2img:install
+```
+
+That writes a commented `config/initializers/html2img.rb` reading your key from the environment. Or configure it from any environment file instead, which is handy for per-environment settings:
+
+```ruby
+# config/environments/production.rb
+config.html2img.api_key = Rails.application.credentials.html2img_api_key
+config.html2img.timeout = 45
+```
+
+Both routes end up at the same place. The Railtie runs before `config/initializers`, so an explicit `Html2img.configure` block wins if you use both.
+
 Render an Action View template into the image, so the card lives with the rest of your views:
 
 ```ruby
@@ -257,8 +273,6 @@ Then output it in your layout:
 <meta property="og:image" content="<%= @post.og_image_url %>">
 ```
 
-Configure the client once in an initializer, as shown in [configuration](#configuration).
-
 ## Background jobs
 
 Renders are a natural fit for a background job, especially full-page captures:

data/lib/generators/html2img/install/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Html2img
+  module Generators
+    # Creates config/initializers/html2img.rb.
+    #
+    #   rails generate html2img:install
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates an html2img initializer at config/initializers/html2img.rb."
+
+      def copy_initializer
+        template "html2img.rb", "config/initializers/html2img.rb"
+      end
+
+      def show_readme
+        say ""
+        say "Set HTML2IMG_API_KEY in your environment, then check it works:", :green
+        say "  bin/rails runner 'puts Html2img.html(%q{<h1>Hello</h1>}, width: 600, height: 200).url'"
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/html2img/install/templates/html2img.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Configuration for the html2img HTML to Image API.
+#
+# Docs: https://html2img.com/docs/usage/ruby
+# Keys: https://app.html2img.com/register
+
+Html2img.configure do |config|
+  # Your API key. Keep it out of version control: use an environment variable,
+  # or Rails credentials (Rails.application.credentials.html2img_api_key).
+  config.api_key = ENV.fetch("HTML2IMG_API_KEY", nil)
+
+  # Request timeout in seconds. The default sits just over the API's 30 second
+  # synchronous render budget. For captures that routinely take longer, pass a
+  # webhook_url on the request instead of raising this.
+  # config.timeout = 35
+
+  # Override only for a private deployment.
+  # config.base_url = "https://app.html2img.com"
+
+  # An object responding to #call, for retry middleware, a proxy, or a stub in
+  # tests. See https://github.com/html2img/html2img-ruby#custom-transports
+  # config.transport = nil
+end

data/lib/html2img/client.rb

@@ -269,3 +269,7 @@ module Html2img
     end
   end
 end
+
+# Rails applications get the Railtie for free: config.html2img.* in any
+# environment file, and `rails generate html2img:install`.
+require_relative "railtie" if defined?(Rails::Railtie)

data/lib/html2img/railtie.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module Html2img
+  # Wires the gem into Rails.
+  #
+  # Loaded automatically when Rails is present, so a Rails app can configure the
+  # client from `config/application.rb` or any environment file:
+  #
+  #   config.html2img.api_key = Rails.application.credentials.html2img_api_key
+  #   config.html2img.timeout = 45
+  #
+  # Anything left unset falls back to the environment, as usual. This runs
+  # before `config/initializers`, so an explicit `Html2img.configure` block in an
+  # initializer still wins — run `rails generate html2img:install` to create one.
+  class Railtie < ::Rails::Railtie
+    config.html2img = ActiveSupport::OrderedOptions.new
+
+    initializer "html2img.configure" do |app|
+      options = app.config.html2img
+
+      Html2img.configure do |client|
+        client.api_key = options.api_key unless options.api_key.nil?
+        client.base_url = options.base_url unless options.base_url.nil?
+        client.timeout = options.timeout unless options.timeout.nil?
+        client.transport = options.transport unless options.transport.nil?
+      end
+    end
+
+    generators do
+      require "generators/html2img/install/install_generator"
+    end
+  end
+end

data/lib/html2img/version.rb

@@ -2,5 +2,5 @@
 
 module Html2img
   # Single source of truth for the gem version.
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html2img-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - html2img
@@ -23,11 +23,14 @@ files:
 - LICENSE
 - README.md
 - exe/html2img
+- lib/generators/html2img/install/install_generator.rb
+- lib/generators/html2img/install/templates/html2img.rb
 - lib/html2img-client.rb
 - lib/html2img/cli.rb
 - lib/html2img/client.rb
 - lib/html2img/configuration.rb
 - lib/html2img/errors.rb
+- lib/html2img/railtie.rb
 - lib/html2img/render_response.rb
 - lib/html2img/request.rb
 - lib/html2img/transport.rb