OG-kuvat Ruby on Railsissa
Luo OG-kuvia Ruby on Railsissa FastOG:n tilauspohjaisella Dynamic API:lla — Dynamic API -tilauksella (luo API-avaimesi hallintapaneelissa). Esikatsele ilmaisessa OG Image Tester -työkalussa ja renderöi sitten dynaamisia Open Graph -kuvia Rails-sovelluksestasi HMAC-allekirjoitetuilla URL-osoitteilla.
Pika-aloitus
1. Luo allekirjoituspalvelu
# 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
Miksi mukautettu enc? Se prosenttikoodaa isoin heksadesimaalimerkein, jättäen vain -._~-merkit varaamattomiksi — joten välilyönnit muuttuvat muotoon %20, eivät koskaan +, mikä vastaa palvelimen rawurlencode-käytäntöä. Jos vaihdat tilalle CGI.escape tai URI.encode_www_form_component, molemmat tuottavat välilyönneille +: normalisoi ensin .gsub('+', '%20'):llä.
2. Määritys
# 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")
# .env
FASTOG_API_KEY=sk_your_full_api_key_here
FASTOG_HMAC_SECRET=your_64_char_hex_secret_here
Ohjain
# 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
Näkymä
<!-- 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>
Asettelu
<!-- app/views/layouts/application.html.erb -->
<head>
<%= yield :head %>
</head>
Apuri
# app/helpers/fastog_helper.rb
module QuickogHelper
def og_image_url(template:, **params)
QuickogSigner.generate_signed_og_url({ template: template }.merge(params))
end
end
<!-- In view -->
<meta property="og:image" content="<%= og_image_url(template: 'blog', title: @post.title) %>" />
Verkkokaupan esimerkki
# 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
Esimerkki blogikirjoituksesta
# 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
API-päätepiste
# config/routes.rb
get "api/og", to: "api/og#generate"
# 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
<!-- 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 %>
Yleiset sudenkuopat
Väärän viestin allekirjoittaminen
❌ Väärin: "GET/api/v1/og#{canonical}" — rivinvaihto puuttuu.
✅ Oikein: "GET/api/v1/og\n#{canonical}" — metodi + polku, rivinvaihto ja sitten kanoninen kysely.
key:n jättäminen allekirjoituksen ulkopuolelle
❌ Väärin: allekirjoitetaan vain omat sisältöparametrit ja lisätään key URL-osoitteeseen vasta jälkikäteen.
✅ Oikein: key yhdistetään parametreihin ennen kanonisen kyselyn muodostamista ja se näkyy lopullisessa URL-osoitteessa.
401 missing_signature / invalid_signature
missing_signature (401) tarkoittaa, että key tai s puuttuu URL-osoitteesta. invalid_signature (401) tarkoittaa, että kanoninen kysely ei täsmännyt — varmista rivinvaihto allekirjoitetussa viestissä, sama hmac_secret molemmilla puolilla ja että enc prosenttikoodaa välilyönnit muodossa %20 (ei koskaan +).
HMAC-salaisuuden paljastaminen
Älä koskaan paljasta FASTOG_HMAC_SECRET:ää frontend-JavaScriptissä tai asiakaspuolen koodissa.