OG Pilot API Documentation

# Gemfile
gem "og_pilot_ruby"

# Set the API key and domain in your environment variables
OG_PILOT_API_KEY=your-og-pilot-api-key
OG_PILOT_DOMAIN=yourdomain.com

# ============================================================
# USAGE IN YOUR CONTROLLERS / VIEWS
# ============================================================

# Generate an OG image URL (handles JWT signing automatically)
og_image = OgPilotRuby.create_image(title: "My Page Title")

# With template and additional parameters
og_image = OgPilotRuby.create_image(
  title: @post.title,
  template: "blog_post",
  author_name: @post.author.name,
  publish_date: @post.published_at.to_date.iso8601,
  image_url: @post.featured_image_url
)

# In ERB templates
# <meta property="og:image" content="<%= OgPilotRuby.create_image(title: @page_title) %>" />

# ============================================================
# FULL CONTROLLER EXAMPLE (with Inertia.js meta tags)
# ============================================================

class PostsController < ApplicationController
  def show
    @post = Post.find(params[:id])

    og_image = OgPilotRuby.create_image(
      title: @post.title,
      description: @post.excerpt,
      template: "blog_post",
      author_name: @post.author.name
    )

    # Works great with Inertia Rails meta tags
    inertia_meta.add [
      {tag_name: "meta", property: "og:image", content: og_image},
      {tag_name: "meta", name: "twitter:image", content: og_image}
    ]

    render inertia: "posts/show", props: {post: @post}
  end
end