kurento_rails 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +23 -9
- data/kurento_rails.gemspec +3 -3
- data/lib/kurento_rails/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 7d2c9c2ffbc597fc4b958f598fa45fbbd6c1c505
|
|
4
|
+
data.tar.gz: c6c8b20dfbbb6499d3e44f7311e399d1bd1a96e3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 40ab39f7b43ce9bb068fbdfc3e1c693cb25d52b9e34bfaf6cf7b00997bb77d25616689bfeb8192a72c11bc14ff2278e46af05b6d40eacece51c4d8e04ec5aa58
|
|
7
|
+
data.tar.gz: cfff4a8bae652abb72f76fc8ff810919466477d8037ba63aea8fdcf28027f47b86c147a66ca31296ab47319f605d1d6d2fa5f50d4ffcf626362b32c25981c14e
|
data/README.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# KurentoRails
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
TODO: Delete this and the text above, and describe your gem
|
|
3
|
+
KurentoRails is a gem designed to make integrating kurento media server and rails applications easier. We provide a javascript library to provide easy access to kurento's video streaming functionality.
|
|
6
4
|
|
|
7
5
|
## Installation
|
|
8
6
|
|
|
@@ -20,20 +18,36 @@ Or install it yourself as:
|
|
|
20
18
|
|
|
21
19
|
$ gem install kurento_rails
|
|
22
20
|
|
|
21
|
+
|
|
22
|
+
For reasons that I'm not entirely sure about and don't have time to investigate just yet, the gem isn't correctly bundling websocket-rails in as well on some systems. If your app won't launch after you complete the steps listed below in usage, try fixing it by just adding websocket-rails to your gemfile as well, then re-running bundle.
|
|
23
|
+
|
|
23
24
|
## Usage
|
|
24
25
|
|
|
25
|
-
|
|
26
|
+
After installation, run the following command
|
|
26
27
|
|
|
27
|
-
|
|
28
|
+
```ruby
|
|
29
|
+
rails g kurento_rails:install
|
|
30
|
+
```
|
|
28
31
|
|
|
29
|
-
|
|
32
|
+
This will copy a number of files into your project. These are:
|
|
33
|
+
- config/events.rb: This file is responsible for routing websockets events to the correct controller and action
|
|
34
|
+
- app/controllers/kurento_controller.rb: This controller is used for serving html pages that interact with kurento. It should at least be a step in the right direction for you.
|
|
35
|
+
- app/controllers/kurento_websockets_controller.rb: This controller is responsible for most of the internal streaming logic. The javascript client library interacts heavily with this controller
|
|
36
|
+
- app/assets/javascripts/kurento-rails-js: This is the javascript client library. kurento-rails.js is the main code for the library. The other libraries included here are dependencies and should also be included.
|
|
37
|
+
- db/migrations/{timestamp}-create_video_streams.rb: This is the active record migration for the video stream model.
|
|
38
|
+
- app/models/kurento_rails_video_stream.rb: This is the video stream model
|
|
39
|
+
- app/views/kurento: This folder contains the views associated with the kurento controller. I assume that you're using slim, because slim is fantastic, but if you're not, you can just edit the extensions on these.
|
|
30
40
|
|
|
31
|
-
|
|
41
|
+
finally, you'll need to migrate the database
|
|
42
|
+
```ruby
|
|
43
|
+
rake db:migrate
|
|
44
|
+
```
|
|
32
45
|
|
|
33
|
-
|
|
46
|
+
After this, the installation process should be complete.
|
|
34
47
|
|
|
35
|
-
|
|
48
|
+
## Contributing
|
|
36
49
|
|
|
50
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/andrewls/kurento-rails.
|
|
37
51
|
|
|
38
52
|
## License
|
|
39
53
|
|
data/kurento_rails.gemspec
CHANGED
|
@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
|
|
|
24
24
|
spec.add_development_dependency "bundler", "~> 1.10"
|
|
25
25
|
spec.add_development_dependency "rake", "~> 10.0"
|
|
26
26
|
spec.add_development_dependency "minitest"
|
|
27
|
-
spec.
|
|
28
|
-
spec.
|
|
29
|
-
spec.
|
|
27
|
+
spec.add_runtime_dependency 'jquery-rails' # the code depends on jquery
|
|
28
|
+
spec.add_runtime_dependency 'coffee-script' # and it's written in coffeescript
|
|
29
|
+
spec.add_runtime_dependency 'websocket-rails' # and it relies on websockets to do basically anything
|
|
30
30
|
end
|