Bannerbear Ruby

Ruby wrapper for the Bannerbear API - an image and video generation service.

Installation

Add this line to your application's Gemfile:

gem 'bannerbear'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install bannerbear

Usage

Table of Contents

Authentication

Get the API key for your project in Bannerbear and create a client.

bb = Bannerbear::Client.new("your API key")

Alternatively you can place your API key in an ENV variable named BANNERBEAR_API_KEY and create the client:

bb = Bannerbear::Client.new

Account Info

Return info about the Account / Project associated with this API key.

bb.

Images

Create an Image

To create an image you reference a template uid and a list of modifications. The default is async generation meaning the API will respond with a pending status and you can use get_image to retrieve the final image.

bb.create_image("template uid", 
  :modifications => [
    {
      :name => "headline",
      :text => "Hello World!"
    },
    {
      :name => "photo",
      :image_url => "https://images.unsplash.com/photo-1555400038-63f5ba517a47?w=1000&q=80"
    }
  ]
)

You can also create images synchronously - this will take longer to respond but the image will be delivered in the response:

bb.create_image("template uid", 
  :synchronous => true, 
  :modifications => [
    {
      :name => "headline",
      :text => "Hello World!"
    },
    {
      :name => "photo",
      :image_url => "https://images.unsplash.com/photo-1555400038-63f5ba517a47?w=1000&q=80"
    }
  ]
)
Options
  • modifications: an array of modifications you would like to make (array)
  • webhook_url: a webhook url to post the final image object to (string)
  • transparent: render image with a transparent background (boolean)
  • synchronous: generate the image synchronously (boolean)
  • render_pdf: render a PDF in addition to an image (boolean)
  • metadata: include any metadata to reference at a later point (string)

Get an Image

bb.get_image("image uid")

List all Images

bb.list_images

bb.list_images(:page => 10)
Options
  • page: pagination (integer)
  • limit: return n images per page (integer)

Videos

Create a Video

To create a video you reference a video template uid, an input media and a list of modifications. Videos are created async - use get_video to retrieve the final video. 

bb.create_video("video template uid", 
  :input_media_url => "https://www.yourserver.com/videos/awesome_video.mp4", 
  :modifications => [
    {
      :name => "headline",
      :text => "Hello World!"
    }
  ]
)
Options
  • input_media_url: a url to a publicly available video file you want to import (string)
  • modifications: an array of modifications you would like to make to the video overlay (array)
  • webhook_url: a webhook url to post the final video object to (string)
  • blur: blur the imported video from 1-10 (integer)
  • trim_to_length_in_seconds: trim the video to a specific length (integer)
  • create_gif_preview: create a short preview gif (boolean)
  • metadata: include any metadata to reference at a later point (string)

If your video is using the "Multi Overlay" build pack then you can pass in a set of frames to render via:

  • frames: an array of sets of modifications (array)
  • frame_durations: specify the duration of each frame (array)

Get a Video

bb.get_video("video uid")

Update a Video

Updating a video is only relevant under specific conditions. Video Templates using the build pack transcribe and set to manual approval (via the dashboard) will result in videos that enter a pending_approval status. At this point, the video is waiting for approval before final rendering. The purpose of this is to check the transcript is correct, make any changes, and approve the video for rendering.

bb.update_video("video uid",
  :approved => true,
  :transcription => [
    "This is a new transcription",
    "It must contain the same number of lines",
    "As the previous transcription"
  ]
)
Options
  • approved: approve the video for rendering (boolean)
  • transcription: an array of strings to represent the new transcription (will overwrite the existing one) (array)

List all Videos

bb.list_videos
Options
  • page: pagination (integer)

Collections

Create multiple images in one API request.

bb.get_collection("collection uid")
bb.list_collections(:page => 3)
bb.create_collection("template set uid",
  :synchronous => true,
  :modifications => [
    {
      :name => "headline",
      :text => "Hello World!"
    }
  ]
)
Options for create_collection
  • modifications: an array of modifications you would like to make (array)
  • webhook_url: a webhook url to post the final collection object to (string)
  • transparent: render image with a transparent background (boolean)
  • synchronous: generate the images synchronously (boolean)
  • metadata: include any metadata to reference at a later point (string)

Animated Gifs

Create a slideshow style gif

bb.get_animated_gif("gif uid")
bb.list_animated_gifs(:page => 3)
bb.create_animated_gif("template uid",
  :frames => [
    [ #frame 1 starts here
      {
        :name => "layer1",
        :text => "This is my text"
      },
      {
        :name => "photo",
        :image_url => "https://www.pathtomyphoto.com/1.jpg"
      }
    ],
    [ #frame 2 starts here
      {
        :name => "layer1",
        :text => "This is my follow up text"
      },
      {
        :name => "photo",
        :image_url => "https://www.pathtomyphoto.com/2.jpg"
      }
    ]
  ]
)
Options for create_animated_gif
  • frames: an array of arrays of modifications you would like to make (array)
  • frame_durations: an array of times (in seconds) to show each frame (array)
  • input_media_url: optionally import an external video file to use as part of the gif
  • fps: frames per second e.g. 1 (integer)
  • loop: whether to loop or not (boolean)
  • webhook_url: a webhook url to post the final gif object to (string)
  • metadata: include any metadata to reference at a later point (string)

Movies

Assemble video clips or still images into a single movie with transitions.

bb.get_movie("movie uid")
bb.list_movies(:page => 3)
bb.create_movie(:width => 800, :height => 800, :transition => "pixelize", :inputs => [
  {
    :asset_url => "https://images.unsplash.com/photo-1635910160061-4b688344bd20?w=500&q=60"
  },
  {
    :asset_url => "https://i.imgur.com/fH7a5dO.png"
  }
])
Options for create_movie
  • width: the movie width in pixels (integer)
  • height: the movie height in pixels (integer)
  • transition: the transition style: fade, pixelize, slidedown, slideright, slideup, slideleft (string)
  • inputs: a list of inputs (array)
  • webhook_url: a webhook url to post the final movie object to (string)
  • metadata: include any metadata to reference at a later point (string)

Screenshots

Take screenshots of websites.

bb.get_screenshot("screenshot uid")
bb.list_screenshots(:page => 3)
bb.create_screenshot("https://www.bannerbear.com/",
  :synchronous => true,
  :width => 1000
)
Options for create_screenshot
  • width: the desired screenshot width in pixels (integer)
  • height: the desired screenshot height in pixels (integer)
  • synchronous: generate the screenshot synchronously (boolean)
  • mobile: use a mobile user agent
  • webhook_url: a webhook url to post the final screenshot object to (string)

Templates

bb.get_template("template uid")
bb.update_template("template uid", :name => "New Template Name", :tags => ["portrait", "instagram"])
bb.list_templates(:page => 2, :tag => "portrait")

Template Sets

bb.get_template_set("template set uid")
bb.list_template_sets(:page => 2)

Video Templates

bb.get_video_template("video template uid")
bb.list_video_templates(:page => 2)

Signed URLs

This gem also includes a convenient utility for generating signed urls. Authenticate as above, then:

bb.generate_signed_url("base uid", :modifications => [])

# example
bb.generate_signed_url("A89wavQyY3Bebk3djP", 
  :modifications => [
    {
      :name => "country", 
      :text => "testing!"
    },
    {
      :name => "photo", 
      :image_url => "https://images.unsplash.com/photo-1638356435991-4c79b00ebef3?w=764&q=80"
    }
  ]
)
# https://ondemand.bannerbear.com/signedurl/A89wavQyY3Bebk3djP/image.jpg?modifications=W3sibmFtZSI6ImNvdW50cnkiLCJ0ZXh0IjoidGVzdGluZyEifSx7Im5hbWUiOiJwaG90byIsImltYWdlX3VybCI6Imh0dHBzOi8vaW1hZ2VzLnVuc3BsYXNoLmNvbS9waG90by0xNjM4MzU2NDM1OTkxLTRjNzliMDBlYmVmMz93PTc2NCZxPTgwIn1d&s=40e7c9d4902b86ea83e0c400e57d7cc580534fd527e234d40a0c7ace589a16eb

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yongfook/bannerbear-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bannerbear project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.