html2img-client 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26b9fea9182f0ceb819242d093a8deaf5d661e3d25c3ff20f90286120c7b52d
-  data.tar.gz: 41691473ff4cc2ad5d17cb27ef5cf43b7500b08bc2acb4ad5ad913d9fa0600d3
+  metadata.gz: ed2d883315742595595236208062902e3e9a7a184c9e544826a76cda817c369b
+  data.tar.gz: 953f2eceeebd093ae4864edd4cdd32022af4ba6f07d04951bca41d5e15b99e59
 SHA512:
-  metadata.gz: fc292634a6b4cb762ca9f475187e6d3c9059983a486181926e3c98bf35a287296d16969cb8b9831e0bab741c9b3792c69a802d6edc51a81aa966e7298477e364
-  data.tar.gz: cc605647b58582a4182335d2412474a23b9fbdbcb3c8a2938bc74cc2ee5e1e2034d372e777c3a6ecf8ad109ac1a5b0344e7555cbfca359c38d93703dea4b3107
+  metadata.gz: d600987f67788924bfa8f02225d469ee14e653455909c7dcc14db949586488c9063d672c29ed4e23b0ce53751b089d3d80c6a0774823a0491776cbd837cf48fc
+  data.tar.gz: b3b2bc28bf89c420dfc1e2af91160988b372005d1997e4ec440000f88c239da0a9fc38af66b16fb63c4df09825de4f8f927df0c6a58f6c303005ecd475a347f5

data/CHANGELOG.md

@@ -6,6 +6,30 @@ follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and the
 
 ## [Unreleased]
 
+## [1.1.1] - 2026-08-17
+
+### Changed
+
+- `documentation_uri` now points at <https://html2img.com/integrations/ruby/>.
+  The Ruby guide moved and the old `/docs/usage/ruby` URL 404s, so the
+  documentation link on the gem page pointed nowhere. Because gemspec metadata
+  is fixed at build time, correcting it needs a release.
+- The same move applied to the guide links in the README and in the generated
+  `config/initializers/html2img.rb`.
+
+## [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 +54,7 @@ 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.1...HEAD
+[1.1.1]: https://github.com/html2img/html2img-ruby/compare/v1.1.0...v1.1.1
+[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

@@ -9,7 +9,7 @@
 
 The official Ruby client for the [HTML to Image API](https://html2img.com) at html2img.com. Turn HTML and CSS into images, capture screenshots of live URLs, render named templates, and export A4 PDFs, all returning a typed response object.
 
-Every render runs in real Chrome, so flexbox, grid, custom properties, web fonts and inline JavaScript behave exactly as they do in the browser. The gem has **zero runtime dependencies** — it is built on Net::HTTP from the standard library — and works anywhere Ruby does: Rails and Sinatra apps, Sidekiq and Active Job workers, rake tasks and one-off scripts. The full API reference lives in the [documentation](https://html2img.com/docs), with a Ruby guide at [html2img.com/docs/usage/ruby](https://html2img.com/docs/usage/ruby).
+Every render runs in real Chrome, so flexbox, grid, custom properties, web fonts and inline JavaScript behave exactly as they do in the browser. The gem has **zero runtime dependencies** — it is built on Net::HTTP from the standard library — and works anywhere Ruby does: Rails and Sinatra apps, Sidekiq and Active Job workers, rake tasks and one-off scripts. The full API reference lives in the [documentation](https://html2img.com/docs), with a Ruby guide at [html2img.com/integrations/ruby](https://html2img.com/integrations/ruby/).
 
 Three things this gem does, each with its own worked guide:
 
@@ -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:
@@ -442,14 +456,13 @@ It prints the resulting image URL and your remaining credits, or a clear error i
 The same API has worked guides and official packages for
 [Python](https://github.com/html2img/html2img-python),
 [Django](https://github.com/html2img/html2img-django),
-[PHP](https://html2img.com/docs/usage/php),
-[Laravel](https://html2img.com/docs/usage/laravel),
-[Ruby on Rails](https://html2img.com/docs/usage/rails),
-[JavaScript and Node.js](https://html2img.com/docs/usage/javascript),
-[React](https://html2img.com/docs/usage/react),
-[Vue](https://html2img.com/docs/usage/vue),
-[WordPress](https://html2img.com/docs/usage/wordpress) and
-[Statamic](https://html2img.com/docs/usage/statamic).
+[PHP](https://html2img.com/integrations/php/),
+[Laravel](https://html2img.com/integrations/laravel/),
+[JavaScript and Node.js](https://html2img.com/integrations/javascript/),
+[React](https://html2img.com/integrations/javascript/#react-and-nextjs),
+[Vue](https://html2img.com/integrations/javascript/#vue-and-nuxt),
+[WordPress](https://html2img.com/integrations/wordpress/) and
+[Statamic](https://html2img.com/integrations/statamic/).
 
 ## Development
 
@@ -465,7 +478,7 @@ Publishing to RubyGems is covered in [PUBLISHING.md](PUBLISHING.md).
 
 ## Links
 
-[HTML to Image API](https://html2img.com) · [Screenshot API](https://html2img.com/screenshot-api/) · [HTML to PDF API](https://html2img.com/html-to-pdf/) · [Documentation](https://html2img.com/docs) · [Ruby guide](https://html2img.com/docs/usage/ruby) · [Templates](https://html2img.com/templates) · [Tools](https://html2img.com/tools) · [Features](https://html2img.com/features) · [Comparisons](https://html2img.com/compare) · [Articles](https://html2img.com/articles) · [Pricing](https://html2img.com/pricing)
+[HTML to Image API](https://html2img.com) · [Screenshot API](https://html2img.com/screenshot-api/) · [HTML to PDF API](https://html2img.com/html-to-pdf/) · [Documentation](https://html2img.com/docs) · [Ruby guide](https://html2img.com/integrations/ruby/) · [Templates](https://html2img.com/templates) · [Tools](https://html2img.com/tools) · [Features](https://html2img.com/features) · [Comparisons](https://html2img.com/compare) · [Articles](https://html2img.com/articles) · [Pricing](https://html2img.com/pricing)
 
 ## Licence
 

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/integrations/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.1"
 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.1
 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
@@ -40,7 +43,7 @@ metadata:
   source_code_uri: https://github.com/html2img/html2img-ruby
   changelog_uri: https://github.com/html2img/html2img-ruby/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/html2img/html2img-ruby/issues
-  documentation_uri: https://html2img.com/docs/usage/ruby
+  documentation_uri: https://html2img.com/integrations/ruby/
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: