Temat

Obrazy OG w Ruby on Rails

Generuj obrazy OG w Ruby on Rails za pomocą opartego na subskrypcji Dynamic API od FastOG — z subskrypcją Dynamic API (utwórz swój klucz API w panelu). Podgląd w darmowym testerze obrazów OG, a następnie renderuj dynamiczne obrazy Open Graph z aplikacji Rails przy użyciu podpisanych adresów URL HMAC.

Szybki start

1. Utwórz usługę podpisującego (signer service)

ruby
# app/services/fastog_signer.rb
class QuickogSigner
  def self.generate_signed_og_url(params, options = {})
    base_url = options[:base_url] || ENV.fetch("FASTOG_BASE_URL", "https://fastog.com/api/v1/og")
    api_key = options[:api_key] || ENV.fetch("FASTOG_API_KEY")
    hmac_secret = options[:hmac_secret] || ENV.fetch("FASTOG_HMAC_SECRET")

    raise "Missing FASTOG_API_KEY or FASTOG_HMAC_SECRET" unless api_key && hmac_secret

    all = params.merge(key: api_key)
    pairs = all.flat_map do |k, v|
      Array(v).sort.map { |vv| "#{enc(k)}=#{enc(vv)}" }
    end
    canonical = pairs.sort.join("&")
    signature = OpenSSL::HMAC.hexdigest("SHA256", hmac_secret, "GET/api/v1/og\n#{canonical}")
    "#{base_url}?#{URI.encode_www_form(all.merge(s: signature))}"
  end

  def self.enc(s)
    s.to_s.gsub(/[^A-Za-z0-9\-._~]/) { |c| c.bytes.map { |b| "%%%02X" % b }.join }
  end
  private_class_method :enc
end

Dlaczego własny enc? Wykonuje percent-encoding z wielkimi literami szesnastkowymi, pozostawiając tylko znaki dozwolone w -._~ — dzięki temu spacje stają się %20, a nigdy +, co jest zgodne z rawurlencode serwera. Jeśli zamienisz go na CGI.escape lub URI.encode_www_form_component, oba generują + dla spacji: najpierw znormalizuj za pomocą .gsub('+', '%20').

2. Konfiguracja

ruby
# config/application.rb
config.fastog = ActiveSupport::OrderedOptions.new
config.fastog.api_key = ENV.fetch("FASTOG_API_KEY", nil)
config.fastog.hmac_secret = ENV.fetch("FASTOG_HMAC_SECRET", nil)
config.fastog.base_url = ENV.fetch("FASTOG_BASE_URL", "https://fastog.com/api/v1/og")
bash
# .env
FASTOG_API_KEY=sk_your_full_api_key_here
FASTOG_HMAC_SECRET=your_64_char_hex_secret_here

Kontroler

ruby
# app/controllers/blog_controller.rb
class BlogController < ApplicationController
  def show
    @post = Post.find_by!(slug: params[:slug])

    @og_image_url = QuickogSigner.generate_signed_og_url(
      template: "blog",
      title: @post.title,
      subtitle: @post.excerpt,
      author: @post.author.name
    )
  end
end

Widok

erb
<!-- app/views/blog/show.html.erb -->
<% content_for :head do %>
  <meta property="og:image" content="<%= @og_image_url %>" />
  <meta property="og:title" content="<%= @post.title %>" />
  <meta property="og:description" content="<%= @post.excerpt %>" />
<% end %>

<article>
  <h1><%= @post.title %></h1>
  <p><%= @post.excerpt %></p>
</article>

Układ

erb
<!-- app/views/layouts/application.html.erb -->
<head>
  <%= yield :head %>
</head>

Pomocnik

ruby
# app/helpers/fastog_helper.rb
module QuickogHelper
  def og_image_url(template:, **params)
    QuickogSigner.generate_signed_og_url({ template: template }.merge(params))
  end
end
erb
<!-- In view -->
<meta property="og:image" content="<%= og_image_url(template: 'blog', title: @post.title) %>" />

Przykład e-commerce

ruby
# app/controllers/products_controller.rb
class ProductsController < ApplicationController
  def show
    @product = Product.find(params[:id])

    @og_image_url = QuickogSigner.generate_signed_og_url(
      template: "ecommerce",
      title: @product.name,
      price: @product.formatted_price,
      image: @product.image_url
    )
  end
end

Przykład wpisu na blogu

ruby
# app/controllers/users_controller.rb
class UsersController < ApplicationController
  def show
    @user = User.find_by!(username: params[:username])

    @og_image_url = QuickogSigner.generate_signed_og_url(
      template: "blog",
      title: @user.name,
      subtitle: @user.bio,
      author: @user.name
    )
  end
end

Punkt końcowy API

ruby
# config/routes.rb
get "api/og", to: "api/og#generate"
ruby
# app/controllers/api/og_controller.rb
module Api
  class OgController < ApplicationController
    skip_before_action :verify_authenticity_token

    def generate
      title = params[:title]
      template = params[:template] || "default"

      unless title
        return render json: { error: "Missing title" }, status: :bad_request
      end

      og_image_url = QuickogSigner.generate_signed_og_url(
        template: template,
        title: title
      )

      render json: { ogImageUrl: og_image_url }
    end
  end
end

Turbo/Hotwire

erb
<!-- app/views/blog/_post.html.erb -->
<%= turbo_frame_tag "post_#{@post.id}" do %>
  <meta property="og:image" content="<%= og_image_url(template: 'blog', title: @post.title) %>" />
  <h2><%= link_to @post.title, blog_path(@post) %></h2>
<% end %>

Częste pułapki

Podpisywanie niewłaściwej wiadomości

❌ Źle: "GET/api/v1/og#{canonical}" — brakuje separatora nowej linii. ✅ Dobrze: "GET/api/v1/og\n#{canonical}" — metoda + ścieżka, nowa linia, a następnie kanoniczne zapytanie.

Pomijanie key w podpisie

❌ Źle: podpisywanie wyłącznie parametrów treści i dołączanie key do adresu URL później. ✅ Dobrze: key jest scalane z parametrami przed zbudowaniem kanonicznego zapytania i pojawia się w końcowym adresie URL.

401 missing_signature / invalid_signature

missing_signature (401) oznacza, że key lub s brakuje w adresie URL. invalid_signature (401) oznacza, że kanoniczne zapytanie nie pasuje — sprawdź nową linię w podpisanej wiadomości, ten sam hmac_secret po obu stronach oraz to, że enc koduje procentowo spacje jako %20 (nigdy +).

Ujawnianie sekretu HMAC

Nigdy nie ujawniaj FASTOG_HMAC_SECRET w JavaScripcie frontendowym ani w kodzie po stronie klienta.

Pełna dokumentacja API

Wypróbuj za darmo — bez rejestracji

Podglądaj i testuj dynamiczne obrazy OG w kilka sekund.

Otwórz darmowy tester obrazów OG

A BeCaSimulations site