bannerbear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b0569652b31b940b16cfbceb88c284f855da55be0b847dcdf30c7e5a49de1ca
+  data.tar.gz: 3d2c9d8688ee35edcab5e74a1703c3e7c643e94e0d452ca7716a3e4dfdcac1b9
+SHA512:
+  metadata.gz: 5a30f72a5e674fc5e2a6f63b8b7558577ab8b69e99f2609ef4126d55bed014e4eabbec162663992295b69439621adf46b1ff046bfb2ef2ce4778589dc45af1d8
+  data.tar.gz: c99d21894943829c7c4f60c78edf10fd9af9ff0ab63347a37820f48746743dc669d99cdd69d484edd876f1036c8f51d6dc921a29a74aef97131769be60e05cc1

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at yongfook@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bannerbear.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    bannerbear-ruby (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.1115)
+    multi_xml (0.6.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bannerbear-ruby!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jon Yongfook
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bannerbear'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install bannerbear
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+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).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bannerbear.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/bannerbear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bannerbear"
+  spec.version       = Bannerbear::VERSION
+  spec.authors       = ["Jon Yongfook"]
+  spec.email         = ["yongfook@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for the Bannerbear API"
+  spec.homepage      = "https://www.bannerbear.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = ""
+  # spec.metadata["changelog_uri"] = ""
+
+  spec.add_dependency "httparty"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bannerbear"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/bannerbear/client.rb

@@ -0,0 +1,128 @@
+module Bannerbear
+
+  class Client
+
+    def initialize(api_key = nil)
+      @api_key = api_key || ENV["BANNERBEAR_API_KEY"]
+    end
+
+    def account
+      get_response "/account"
+    end
+
+    # Images
+
+    def get_image(uid)
+    	get_response "/images/#{uid}"
+    end
+
+    def list_images(params = {})
+    	get_response "/images?#{URI.encode_www_form(params.slice(:page, :limit))}"
+    end
+
+    def create_image(uid, payload = {})
+    	post_response "/images", payload.slice(:modifications, :webhook_url, :transparent, :render_pdf, :metadata).merge({:template => uid}), payload[:synchronous]
+    end
+
+    # Videos
+
+    def get_video(uid)
+    	get_response "/videos/#{uid}"
+    end
+
+    def list_videos(params = {})
+    	get_response "/videos?#{URI.encode_www_form(params.slice(:page))}"
+    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})
+    end
+
+    def update_video(uid, payload = {})
+      patch_response "/videos", payload.slice(:transcription, :approved).merge({:uid => uid})
+    end
+
+
+
+    # Templates
+
+    def get_template(uid)
+    	get_response "/templates/#{uid}"
+    end
+
+    def update_template(uid, payload = {})
+    	patch_response "/templates/#{uid}", payload.slice(:name, :metadata, :tags)
+    end
+
+    def list_templates(params = {})
+    	get_response "/templates?#{URI.encode_www_form(params.slice(:page, :tag, :limit, :name))}"
+    end
+
+    # Template Sets
+
+    def get_template_set(uid)
+    	get_response "/template_sets/#{uid}"
+    end
+
+    def list_template_sets(params = {})
+    	get_response "/template_sets?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+    # Video Templates
+
+    def get_video_template(uid)
+    	get_response "/video_templates/#{uid}"
+    end
+
+    def list_video_templates(params = {})
+    	get_response "/video_templates?#{URI.encode_www_form(params.slice(:page))}"
+    end
+
+
+
+
+    private
+
+    BB_API_ENDPOINT = "https://api.bannerbear.com/v2"
+    BB_API_ENDPOINT_SYNCHRONOUS = "https://sync.api.bannerbear.com/v2"
+
+    def get_response(url)
+    	response = HTTParty.get("#{BB_API_ENDPOINT}#{url}", timeout: 3, headers: { 'Authorization' => "Bearer #{@api_key}" })
+    	JSON.parse(response.body)
+    end
+
+    def patch_response(url, payload)
+    	response = HTTParty.patch("#{BB_API_ENDPOINT}#{url}", 
+    		body: payload.to_json,
+    		timeout: 5,
+    		headers: { 
+    			'Authorization' => "Bearer #{@api_key}",
+    			'Content-Type' => 'application/json'
+    		}
+    	)
+    	JSON.parse(response.body)
+    end
+
+    def post_response(url, payload, sync = false)
+    	endpoint = BB_API_ENDPOINT
+    	timeout = 5
+    	if sync == true
+    		endpoint = BB_API_ENDPOINT_SYNCHRONOUS 
+    		timeout = 15
+    	end
+    	response = HTTParty.post("#{endpoint}#{url}", 
+    		body: payload.to_json,
+    		timeout: timeout,
+    		headers: { 
+    			'Authorization' => "Bearer #{@api_key}",
+    			'Content-Type' => 'application/json'
+    		}
+    	)
+    	body = JSON.parse(response.body)
+    	return {"error" => body['message']} if response.code >= 400
+    	return body
+    end
+
+  end
+
+end

data/lib/bannerbear/version.rb

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

data/lib/bannerbear.rb

@@ -0,0 +1,9 @@
+require "httparty"
+require "bannerbear/version"
+require "bannerbear/client"
+
+module Bannerbear
+  class Error < StandardError; end
+  # Your code goes here...
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: bannerbear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Yongfook
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- yongfook@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bannerbear.gemspec
+- bin/console
+- bin/setup
+- lib/bannerbear.rb
+- lib/bannerbear/client.rb
+- lib/bannerbear/version.rb
+homepage: https://www.bannerbear.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.bannerbear.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Ruby wrapper for the Bannerbear API
+test_files: []