samharnack / shrine-encoder

Adds remote processing support to shrine specifically for video encoding.

Shrine::Encoder

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/shrine/encoder. 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:

gem 'shrine-encoder'

And then execute:

$ bundle

Or install it yourself as:

$ gem install shrine-encoder

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shrine-encoder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

shrine-encoder's Issues

Webhook design

Hi Sam,

I noticed your two recent Shrine-related projects, shrine-encoder and shrine-webhook. I'm reaching out because I recently finished an integration for Transloadit, a service similar to Zencoder.

https://github.com/janko-m/shrine-transloadit

Since Transloadit also uses webhooks to notify you when processing is done, I was initially looking whether I could use shrine-webhook, or at least make some necessary PRs. However, at the end I went with my own approach which works really nicely, and just wanted to share it with you in case you want to do something like that in shrine-encoder.

So, in shrine-transloadit I relied on the ability to add some JSON payload when submitting my processing request, and that this same JSON will be returned to me in the webhook. This allowed me to achieve the same idea as with backgrounding jobs, that in the webhook I have all the information about which record and attachment it belongs to and instantiate all of these objects, and that I can just transform the result in Shrine's attachment format and save it to the database.

It was also really easy to allow putting that processing request in a background job, which is nice because this HTTP request doesn't actually need to be performed in the foreground.

Anyway, just wanted to let you know, so that maybe it gives you some ideas how to finish shrine-encoder.

Cheers,
Janko