Skip to main content

flyyer gem

Repository: https://github.com/useflyyer/flyyer-ruby

Installation

This module is agnostic to any Ruby framework.

1. Install flyyer gem

Add this line to your application's Gemfile:

Gemfile
gem 'flyyer'

And then execute:

Terminal.app
bundle install

Or install it yourself as:

Terminal.app
gem install flyyer

2. Format Flyyer CDN URLs for your meta-tags

Find your project identifier here. If you don't have a project yet, create one here.

Now you can format Flyyer CDN URLs like shown below.

require 'flyyer'

flyyer = Flyyer::Flyyer.create do |f|
# Your project identifier
f.project = 'your-project-identifier'
# The current pathname of your website, try to set it dynamically
f.path = '/path/to/product'
end

# Use this image URL in your <head/> tags
url = flyyer.href
# > https://cdn.flyyer.io/v2/your-project-identifier/_/__v=1596906866/path/to/product

Take a look into the Ruby on Rails integration guide to see a full example for your specific setup. You're invited to contribute to the Ruby documentation and add your own guide for other technologies.

note

The meta-tags code needs to be static, processed at build time or server-side rendered for link previews to work.

3. Voilà 🎉

Now you're able to manage your link previews from your dashboard, create content from templates while preserving your brand style and export it as social media formats.

Go to your dashboard 🚀

Advanced usage

Default image

Pass your main or default image for each page through the default parameter. This will help Flyyer to create a better preview efficiently.

require 'flyyer'

flyyer = Flyyer::Flyyer.create do |f|
f.project = 'your-project-identifier'
f.path = '/path/to/product'
f.default = "/static/image-1.png" # or https://your-site.com/static/image-1.png
end

# Use this image URL in your <head/> tags
url = flyyer.href
# > https://cdn.flyyer.io/v2/your-project-identifier/_/_def=%2Fstatic%2Fimage-1.png&__v=1618283086/path/to/product

Signed URLs

The package flyyer supports HMAC and JWT signatures.

Find your secret key here under Signed URLS, and enable the signing strategy you desire.

require 'flyyer'

flyyer = Flyyer::Flyyer.create do |f|
f.project = 'your-project-identifier'
f.path = '/path/to/product'
f.secret = 'your-secret-key'
f.strategy = 'JWT' # or 'HMAC'
end

# Use this image in your <head/> tags
url = flyyer.href
# > https://cdn.flyyer.io/v2/your-project-identifier/jwt-eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJhbXMiOnsiX19pZCI6ImplYW5zLTEyMyJ9LCJwYXRoIjoiXC9wYXRoXC90b1wvcHJvZHVjdCJ9.X8Vs5SGEA1-3M6bH-h24jhQnbwH95V_G0f-gPhTBTzE?__v=1618283086