kurento_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2297760202b825050f276abc24b8fff554f9f75
-  data.tar.gz: 80c42b33a9d2301f1677eef881013bdd593ee861
+  metadata.gz: 7d2c9c2ffbc597fc4b958f598fa45fbbd6c1c505
+  data.tar.gz: c6c8b20dfbbb6499d3e44f7311e399d1bd1a96e3
 SHA512:
-  metadata.gz: 6a594dd7d3805dfdaa7ad0b4007c9c4eec12078cc356f94de07e91ddfaef5e9355228d38697c36e328c2608cf35646cbf797d6c88f50aa7ea5f1eadc2a8af718
-  data.tar.gz: b159f874f98671b5690187624359842f6b31f201d26b39c47f70345bcaceeab775961007fda4e525e682470f60d5c4b0c41f28bb72d6249e8666d6568f4d0e65
+  metadata.gz: 40ab39f7b43ce9bb068fbdfc3e1c693cb25d52b9e34bfaf6cf7b00997bb77d25616689bfeb8192a72c11bc14ff2278e46af05b6d40eacece51c4d8e04ec5aa58
+  data.tar.gz: cfff4a8bae652abb72f76fc8ff810919466477d8037ba63aea8fdcf28027f47b86c147a66ca31296ab47319f605d1d6d2fa5f50d4ffcf626362b32c25981c14e

data/README.md

@@ -1,8 +1,6 @@
 # KurentoRails
 
-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/kurento_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+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. 
 
 ## Installation
 
@@ -20,20 +18,36 @@ Or install it yourself as:
 
     $ gem install kurento_rails
 
+
+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. 
+
 ## Usage
 
-TODO: Write usage instructions here
+After installation, run the following command
 
-## Development
+```ruby
+rails g kurento_rails:install
+```
 
-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.
+This will copy a number of files into your project. These are:
+- config/events.rb: This file is responsible for routing websockets events to the correct controller and action
+- 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.
+- 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
+- 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.
+- db/migrations/{timestamp}-create_video_streams.rb: This is the active record migration for the video stream model.
+- app/models/kurento_rails_video_stream.rb: This is the video stream model
+- 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.
 
-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).
+finally, you'll need to migrate the database
+```ruby
+rake db:migrate
+```
 
-## Contributing
+After this, the installation process should be complete.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/andrewls/kurento-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewls/kurento-rails.
 
 ## License
 

data/kurento_rails.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest"
-  spec.add_dependency 'jquery-rails' # the code depends on jquery
-  spec.add_dependency 'coffee-script' # and it's written in coffeescript
-  spec.add_dependency 'websocket-rails' # and it relies on websockets to do basically anything
+  spec.add_runtime_dependency 'jquery-rails' # the code depends on jquery
+  spec.add_runtime_dependency 'coffee-script' # and it's written in coffeescript
+  spec.add_runtime_dependency 'websocket-rails' # and it relies on websockets to do basically anything
 end

data/lib/kurento_rails/version.rb

@@ -1,3 +1,3 @@
 module KurentoRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kurento_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Stephenson