Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 1.8 KB

README.md

File metadata and controls

63 lines (40 loc) · 1.8 KB
Raw

Wisecrack

Video streaming with Ruby and Mongo GridFS

Installation

Add this line to your application's Gemfile:

gem 'wisecrack'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wisecrack

Usage

Boot up your Wisecrack instance:

$ rackup

Bootstrap the DSL with your Ruby framework:

Wisecrack.config(:development) do |config|
  config.base_host_url = 'http://localhost:9292'
end

Wisecrack.config(:production) do |config|
  config.base_host_url = 'http://video.yourdomain.com'
end

POST a new video the Wisecrack instance:

Wisecrack::Video.create(video_path_mp4)

Stream that resource from Wisecrack to your app:

<video controls="controls" preload="auto" width="800">
  <source src="<%= Wisecrack::Video.stream_url(mongo_grid_fs_id: xxx) %>" type="video/mp4"></source>
</video>

Development

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