https://github.com/hyperoslo/embeddable
Embeddable makes it easier to embed videos
https://github.com/hyperoslo/embeddable
Last synced: about 1 year ago
JSON representation
Embeddable makes it easier to embed videos
- Host: GitHub
- URL: https://github.com/hyperoslo/embeddable
- Owner: hyperoslo
- License: other
- Created: 2014-03-23T15:47:11.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2015-11-20T07:57:41.000Z (over 10 years ago)
- Last Synced: 2025-04-02T02:22:34.760Z (about 1 year ago)
- Language: Ruby
- Size: 55.7 KB
- Stars: 6
- Watchers: 12
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.md
Awesome Lists containing this project
README
# Embeddable
[](https://rubygems.org/gems/embeddable)
[](https://travis-ci.org/hyperoslo/embeddable)
[](https://gemnasium.com/hyperoslo/embeddable)
[](https://codeclimate.com/github/hyperoslo/embeddable)
[](https://coveralls.io/r/hyperoslo/embeddable)
Embeddable makes it easier to embed videos.
## Installation
Add this line to your application's Gemfile:
gem 'embeddable'
And then execute:
$ bundle
Or install it yourself as:
$ gem install embeddable
## Usage
```ruby
# app/models/post.rb
class Post < ActiveRecord::Base
include Embeddable
embeddable :video, from: :video_url
end
# ...
post = Post.new video_url: 'http://www.youtube.com/watch?v=bEvNRmPzq9s'
post.video_on_youtube? # => true
post.video_id # => 'bEvNRmPzq9s'
```
### Views
You can use a simple view helper to render the respective video players. `embed_video(embeddable, width, height)`
```erb
<%= embed_video(embeddable, '100%', '100%') %>
```
#### Multiple embeddables in one model
If you have multiple columns using embeddable in one model, you will need to specify which one you want to embed unless it's the first one specified in the model. Add an extra parameter to the view helper: `embed_video(embeddable, width, height, name: :your_embeddable_name)`.
If you have this in your model:
```ruby
embeddable :video, from: :video_url
embeddable :another_video, from: :another_url
```
And you want to embed `:another_video` - you will use the helper like this:
```erb
<%= embed_video(embeddable, '100%', '100%', name: :another_video) %>
```
#### Overriding
The view helper uses partials to render the embed snippets for all of the video players. You can override them by creating a partial here: `app/views/embeddable/`. The file should be named after the player. See example below.
```erb
```
#### Brightcove
If you want to support brightcove, you'll need to add
your own brightcove player by overriding the brightcove partial.
1. Create a partial in your project here: `app/views/embeddable/partials/_brightcove.html.erb`
2. Add your brightcove player code(see example below)
3. Remember to add the following parameters(included in the example below): `id`, `width`, `height`
```html
brightcove.createExperiences();
```
If you used this example, you must remember to add your own `playerId` and `playerKey`
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Credits
Hyper made this. We're a digital communications agency with a passion for good code,
and if you're using this library we probably want to hire you.
## License
Embeddable is available under the MIT license. See the LICENSE file for more info.