bannerbear 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7af6c8f418095cdd98b0aca144cab75fa95911d926bef172d6c3850274e3c2
-  data.tar.gz: f9931adef63f70a4c14b9ccee4c04b72be00c55c6c3b9ff16fbf64e764af31bf
+  metadata.gz: a63e7f3269afc788dea97a56ba271553cce7ae8ad8c605246321be788bbe5601
+  data.tar.gz: 68aa7455b8b4b71ddcf47ee0a59563d0a36f437670822680b9030ff0d41993a2
 SHA512:
-  metadata.gz: 6bfc15b798a35ec932f76770f94ebb6c4bf74f3a52fd3de526301e9da9ace91476949f5f54b9b9fed1cade8d887c0cffc24c48180b6f10e62df3634ae114732d
-  data.tar.gz: 358759f57e2873ae5f8e4c2c5a63a14a9d19144bd2234fc58219018f5882673ae3e73096c8913c3c4a74d92b1687b2f17fb45cee43e318678bb2a9a77137e5e7
+  metadata.gz: 2e4cc99311a703073a184a5211bf1c7c14b18df1062b03592558368e4d017d3f5e116f1c7948c63703300bb4af6cc6da5c0b15bdaf5942e4a1465624fc89c0af
+  data.tar.gz: a3017ce751ebfac3260bd7f174b61040ac2c0130a28f13ced336f7d77e0944507a195ef28aba8701d706fc4b6bef8d5b428a7ee3e51bfa716ef92fddf33af26a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bannerbear (0.1.0)
+    bannerbear (0.1.4)
       httparty
 
 GEM
@@ -12,7 +12,7 @@ GEM
       multi_xml (>= 0.5.2)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.1115)
+    mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     rake (12.3.3)
 

data/README.md

@@ -1,4 +1,4 @@
-# Bannerbear
+# Bannerbear Ruby
 
 Ruby wrapper for the [Bannerbear API](https://developers.bannerbear.com) - an image and video generation service.
 
@@ -20,7 +20,22 @@ Or install it yourself as:
 
 ## Usage
 
-### Create the Client
+### Table of Contents
+
+- [Authentication](#authentication)
+- [Account Info](#account-info)
+- [Images](#images)
+- [Videos](#videos)
+- [Collections](#collections)
+- [Animated Gifs](#animated-gifs)
+- [Movies](#movies)
+- [Screenshots](#screenshots)
+- [Templates](#templates)
+- [Template Sets](#template-sets)
+- [Video Templates](#video-templates)
+- [Signed URLs](#signed-urls)
+
+### Authentication
 
 Get the API key for your project in Bannerbear and create a client.
 
@@ -34,7 +49,7 @@ Alternatively you can place your API key in an ENV variable named `BANNERBEAR_AP
 bb = Bannerbear::Client.new
 ```
 
-### Get Account Info
+### Account Info
 
 Return info about the Account / Project associated with this API key.
 
@@ -42,7 +57,9 @@ Return info about the Account / Project associated with this API key.
 bb.account
 ```
 
-### Create an Image
+### 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.
 
@@ -79,21 +96,22 @@ bb.create_image("template uid",
 )
 ```
 
-#### Options
+##### Options
 
 - `modifications`: an array of [modifications](https://developers.bannerbear.com/#post-v2-images) 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
+#### Get an Image
 
 ```ruby
 bb.get_image("image uid")
 ```
 
-### List all Images
+#### List all Images
 
 ```ruby
 bb.list_images
@@ -103,12 +121,14 @@ bb.list_images
 bb.list_images(:page => 10)
 ```
 
-#### Options
+##### Options
 
 - `page`: pagination (`integer`)
 - `limit`: return n images per page (`integer`)
 
-### Create a Video
+### 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. 
 
@@ -124,7 +144,7 @@ bb.create_video("video template uid",
 )
 ```
 
-#### Options
+##### 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`)
@@ -139,41 +159,204 @@ If your video is using the "Multi Overlay" build pack then you can pass in a set
 - `frames`: an array of sets of `modifications` (`array`)
 - `frame_durations`: specify the duration of each frame (`array`)
 
-### Get a Video
+#### Get a Video
 
 ```ruby
 bb.get_video("video uid")
 ```
 
-### List all Videos
+#### 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.
+
+```ruby
+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
 
 ```ruby
 bb.list_videos
 ```
 
-#### Options
+##### Options
 
 - `page`: pagination (`integer`)
 
-### Templates, Template Sets and Video Templates
+### Collections
+
+Create multiple images in one API request.
+
+```ruby
+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](https://developers.bannerbear.com/#post-v2-images) 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
+
+```ruby
+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](https://developers.bannerbear.com/#post-v2-images) 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.
+
+```ruby
+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](https://developers.bannerbear.com/#post-v2-movies) (`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`)
 
-Various operations exist for handling templates.
+
+### Screenshots
+
+Take screenshots of websites.
+
+```ruby
+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
 
 ```ruby
-# 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
+### Template Sets
+
+```ruby
 bb.get_template_set("template set uid")
 bb.list_template_sets(:page => 2)
+```
 
-# Video Templates
+### Video Templates
+
+```ruby
 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:
+
+```ruby
+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](https://github.com/yongfook/bannerbear-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/bannerbear/client.rb

@@ -109,8 +109,8 @@ module Bannerbear
 
     # Templates
 
-    def get_template(uid)
-    	get_response "/templates/#{uid}"
+    def get_template(uid, params = {})
+    	get_response "/templates/#{uid}?#{URI.encode_www_form(params.slice(:extended))}"
     end
 
     def update_template(uid, payload = {})
@@ -118,17 +118,17 @@ module Bannerbear
     end
 
     def list_templates(params = {})
-    	get_response "/templates?#{URI.encode_www_form(params.slice(:page, :tag, :limit, :name))}"
+    	get_response "/templates?#{URI.encode_www_form(params.slice(:page, :tag, :limit, :name, :extended))}"
     end
 
     # Template Sets
 
-    def get_template_set(uid)
-    	get_response "/template_sets/#{uid}"
+    def get_template_set(uid, params = {})
+    	get_response "/template_sets/#{uid}?#{URI.encode_www_form(params.slice(:extended))}"
     end
 
     def list_template_sets(params = {})
-    	get_response "/template_sets?#{URI.encode_www_form(params.slice(:page))}"
+    	get_response "/template_sets?#{URI.encode_www_form(params.slice(:page, :extended))}"
     end
 
     # Video Templates
@@ -141,7 +141,14 @@ module Bannerbear
     	get_response "/video_templates?#{URI.encode_www_form(params.slice(:page))}"
     end
 
+    # Signed URLS
 
+    def generate_signed_url(base_id, params = {})
+      base = "https://ondemand.bannerbear.com/signedurl/#{base_id}/image.jpg"
+      query = "?modifications=" + Base64.urlsafe_encode64(params[:modifications].to_json, :padding => false)
+      signature = OpenSSL::HMAC.hexdigest("SHA256", @api_key, base + query)
+      return base + query + "&s=" + signature
+    end
 
 
     private
@@ -151,7 +158,9 @@ module Bannerbear
 
     def get_response(url)
     	response = HTTParty.get("#{BB_API_ENDPOINT}#{url}", timeout: 3, headers: { 'Authorization' => "Bearer #{@api_key}" })
-    	JSON.parse(response.body)
+    	body = JSON.parse(response.body)
+      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return body
     end
 
     def patch_response(url, payload)
@@ -163,7 +172,9 @@ module Bannerbear
     			'Content-Type' => 'application/json'
     		}
     	)
-    	JSON.parse(response.body)
+    	body = JSON.parse(response.body)
+      return {"error" => body['message'], "code" => response.code} if response.code >= 400
+      return body
     end
 
     def post_response(url, payload, sync = false)
@@ -182,7 +193,7 @@ module Bannerbear
     		}
     	)
     	body = JSON.parse(response.body)
-    	return {"error" => body['message']} if response.code >= 400
+    	return {"error" => body['message'], "code" => response.code} if response.code >= 400
     	return body
     end
 

data/lib/bannerbear/version.rb

@@ -1,3 +1,3 @@
 module Bannerbear
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/bannerbear.rb

@@ -1,4 +1,6 @@
 require "httparty"
+require "openssl"
+require "base64"
 require "bannerbear/version"
 require "bannerbear/client"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bannerbear
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Jon Yongfook
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty