bannerbear 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b0569652b31b940b16cfbceb88c284f855da55be0b847dcdf30c7e5a49de1ca
-  data.tar.gz: 3d2c9d8688ee35edcab5e74a1703c3e7c643e94e0d452ca7716a3e4dfdcac1b9
+  metadata.gz: 6e7af6c8f418095cdd98b0aca144cab75fa95911d926bef172d6c3850274e3c2
+  data.tar.gz: f9931adef63f70a4c14b9ccee4c04b72be00c55c6c3b9ff16fbf64e764af31bf
 SHA512:
-  metadata.gz: 5a30f72a5e674fc5e2a6f63b8b7558577ab8b69e99f2609ef4126d55bed014e4eabbec162663992295b69439621adf46b1ff046bfb2ef2ce4778589dc45af1d8
-  data.tar.gz: c99d21894943829c7c4f60c78edf10fd9af9ff0ab63347a37820f48746743dc669d99cdd69d484edd876f1036c8f51d6dc921a29a74aef97131769be60e05cc1
+  metadata.gz: 6bfc15b798a35ec932f76770f94ebb6c4bf74f3a52fd3de526301e9da9ace91476949f5f54b9b9fed1cade8d887c0cffc24c48180b6f10e62df3634ae114732d
+  data.tar.gz: 358759f57e2873ae5f8e4c2c5a63a14a9d19144bd2234fc58219018f5882673ae3e73096c8913c3c4a74d92b1687b2f17fb45cee43e318678bb2a9a77137e5e7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bannerbear-ruby (0.1.0)
+    bannerbear (0.1.0)
       httparty
 
 GEM
@@ -20,7 +20,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bannerbear-ruby!
+  bannerbear!
   rake (~> 12.0)
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,6 @@
 # Bannerbear
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bannerbear`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Ruby wrapper for the [Bannerbear API](https://developers.bannerbear.com) - an image and video generation service.
 
 ## Installation
 
@@ -22,18 +20,163 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Create the Client
 
-## Development
+Get the API key for your project in Bannerbear and create a client.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+bb = Bannerbear::Client.new("your API key")
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Alternatively you can place your API key in an ENV variable named `BANNERBEAR_API_KEY` and create the client:
 
-## Contributing
+```ruby
+bb = Bannerbear::Client.new
+```
+
+### Get Account Info
+
+Return info about the Account / Project associated with this API key.
+
+```ruby
+bb.account
+```
+
+### 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.
+
+```ruby
+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:
+
+```ruby
+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](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`)
+- `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
+
+```ruby
+bb.get_image("image uid")
+```
+
+### List all Images
+
+```ruby
+bb.list_images
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bannerbear. 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/[USERNAME]/bannerbear/blob/master/CODE_OF_CONDUCT.md).
+```ruby
+bb.list_images(:page => 10)
+```
+
+#### Options
+
+- `page`: pagination (`integer`)
+- `limit`: return n images per page (`integer`)
+
+### 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. 
+
+```ruby
+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
+
+```ruby
+bb.get_video("video uid")
+```
+
+### List all Videos
+
+```ruby
+bb.list_videos
+```
+
+#### Options
+
+- `page`: pagination (`integer`)
+
+### Templates, Template Sets and Video Templates
+
+Various operations exist for handling 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
+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)
+```
+
+## 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).
 
 ## License
 
@@ -41,4 +184,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## 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](https://github.com/[USERNAME]/bannerbear/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Bannerbear project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yongfook/bannerbear-ruby/blob/master/CODE_OF_CONDUCT.md).

data/bannerbear.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["yongfook@gmail.com"]
 
   spec.summary       = "Ruby wrapper for the Bannerbear API"
-  spec.homepage      = "https://www.bannerbear.com"
+  spec.homepage      = "https://github.com/yongfook/bannerbear-ruby"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 

data/lib/bannerbear/client.rb

@@ -10,6 +10,14 @@ module Bannerbear
       get_response "/account"
     end
 
+    def fonts
+      get_response "/fonts"
+    end
+
+    def effects
+      get_response "/effects"
+    end
+
     # Images
 
     def get_image(uid)
@@ -35,13 +43,68 @@ module Bannerbear
     end
 
     def create_video(uid, payload = {})
-    	post_response "/videos", payload.slice(:input_media_url, :modifications, :blur, :trim_to_length_in_seconds, :webhook_url, :transparent, :metadata, :frames, :frame_durations, :create_gif_preview).merge({:video_template => uid})
+    	post_response "/videos", payload.slice(:input_media_url, :modifications, :blur, :trim_to_length_in_seconds, :webhook_url, :metadata, :frames, :frame_durations, :create_gif_preview).merge({:video_template => uid})
     end
 
     def update_video(uid, payload = {})
       patch_response "/videos", payload.slice(:transcription, :approved).merge({:uid => uid})
     end
 
+    # Collections
+
+    def get_collection(uid)
+      get_response "/collections/#{uid}"
+    end
+
+    def list_collections(params = {})
+      get_response "/collections?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+    def create_collection(uid, payload = {})
+      post_response "/collections", payload.slice(:modifications, :webhook_url, :transparent, :metadata).merge({:template_set => uid}), payload[:synchronous]
+    end
+
+    # Screenshots
+
+    def get_screenshot(uid)
+      get_response "/screenshots/#{uid}"
+    end
+
+    def list_screenshots(params = {})
+      get_response "/screenshots?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+    def create_screenshot(url, payload = {})
+      post_response "/screenshots", payload.slice(:width, :height, :mobile, :webhook_url).merge({:url => url}), payload[:synchronous]
+    end
+
+    # Animated Gifs
+
+    def get_animated_gif(uid)
+      get_response "/animated_gifs/#{uid}"
+    end
+
+    def list_animated_gifs(params = {})
+      get_response "/animated_gifs?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+    def create_animated_gif(uid, payload = {})
+      post_response "/animated_gifs", payload.slice(:frames, :input_media_url, :webhook_url, :metadata, :loop, :frame_durations, :fps).merge({:template => uid})
+    end
+
+    # Movies
+
+    def get_movie(uid)
+      get_response "/movies/#{uid}"
+    end
+
+    def list_movies(params = {})
+      get_response "/movies?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+    def create_movie(payload = {})
+      post_response "/movies", payload.slice(:width, :height, :inputs, :transition, :soundtrack_url, :webhook_url, :metadata)
+    end
 
 
     # Templates

data/lib/bannerbear/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bannerbear
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jon Yongfook
@@ -44,11 +44,11 @@ files:
 - lib/bannerbear.rb
 - lib/bannerbear/client.rb
 - lib/bannerbear/version.rb
-homepage: https://www.bannerbear.com
+homepage: https://github.com/yongfook/bannerbear-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://www.bannerbear.com
+  homepage_uri: https://github.com/yongfook/bannerbear-ruby
 post_install_message:
 rdoc_options: []
 require_paths: