licode 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9953777cef8274b2556ffcb79eb88b90184d10eb
+  data.tar.gz: 742d69f5e590ff87d28dc670349613d60c2ddeda
+SHA512:
+  metadata.gz: 57ecae0683efbb1a705bc5b3988352d637eaa85d541d91906836a8975a268ad81feebb5a9c0c11e0bae3428d233b45362d1c34d8025606111b65e727d30767ea
+  data.tar.gz: 06fa9cff01f169121f0730fa504896e17aa197c23e26d4924f0afbd4736f9d268569edc221e1a51768b4ecf2db1396ce669de1505f13eb43b66e812a3d769c9b

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in licode-ruby-sdk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Joshua Rountree
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Licode Ruby SDK
+
+The Licode gem is designed to help you interface with the Licode platform via server side code.
+It is influenced by the original `nuveClient_ruby` found in the ging/licode repo but isn't a gem and isn't easy to include in your projects.
+
+This also will be more up to date and testable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'licode'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install licode
+
+## Usage
+
+### Initializing
+
+Load the gem and initialize the `Licode::Nuve` object with your Licode `ServiceId`, `ServiceKey`, and `ServiceURL`.
+Your service URL should be the server you have installed licode on either by `http://xxx.xxx.xxx.xxx:3000/` or if you reversed proxied via nginx.  (but you know that... right?)
+
+```ruby
+require "licode"
+
+licode = Licode::Nuve.new "55b3f8d58591b4566af491ed", "18316", "http://my-licode-server:3000"
+```
+
+### Creating Rooms
+Creating a room is done by the `Licode#create_room(name, options)` method.  The `name` parameter is up to you.  Pass in a hash or a unique identifier of your choosing to properly identify this room.  The `room_id` method of the returned `Licode::Room` instance is usually recommended to be persisted to a store (ie. database) for usage later when creating user tokens.
+
+```ruby
+# Creating a relayed (non-p2p) room.
+room = licode.create_room('my-new-room', :p2p => false)
+
+# Creating a p2p room which uses a TURN server to ensure proper connections between peers.
+room = licode.create_room('my-new-room', :p2p => true)
+
+# Store this room_id in the database for later generating user tokens.
+room_id = room.room_id # 55b6549e0ff0f5c9551963c7
+```
+
+### Generating User Tokens
+After creating a `Room`, your user's need a special unique `token` to connect to the room.
+You may generate a token by either `licode.create_token(room_id,username,role)` or through an instance of `Licode::Room` after creating it either by `licode.create_room(name,options)` or `licode.client.get_room(room_id)`
+
+```ruby
+# Create a Token from just a room_id (fetched from a database)
+token = licode.create_token session_id, 'my-user-id-name', 'presenter'
+
+# Create a Token from a room instance.
+room = licode.create_room('my-new-room') # or with `licode.client.get_room` but access to client might be deprecated later.
+
+token = room.create_token('my-user-id-name','presenter') # roles are configured on your server in `licode_config.json` and by default are `presenter`, `viewer`, or `viewerWithData`
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshuairl/licode-ruby-sdk. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "licode/ruby/sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/licode.rb

@@ -0,0 +1,5 @@
+require "licode/version"
+require "licode/nuve"
+module Licode
+
+end

data/lib/licode/client.rb

@@ -0,0 +1,178 @@
+require "httparty"
+require "licode/exceptions"
+require "active_support/inflector"
+require 'base64'
+require "openssl"
+module Licode
+  # @private For internal use by the SDK.
+  class Client
+    include HTTParty
+
+    open_timeout 2
+
+    def initialize(service_id,service_key,service_url)
+      self.class.base_uri service_url
+      self.class.headers({
+        "User-Agent" => "licode-ruby-sdk/#{VERSION}",
+        "Content-Type" => "application/json"
+      })
+      @service_id = service_id
+      @service_key = service_key
+      @service_url = service_url
+    end
+
+    def get_rooms ()
+      response = self.class.get('/rooms', {
+        :headers => {
+          "Authorization" => mauth_header
+        }
+      })
+
+      case response.code
+      when 200
+        response
+      when 403
+        raise LicodeAuthenticationError, "Authentication failed while retrieving rooms. Service: #{@service_id}"
+      else
+        raise LicodeArchiveError, "The rooms could not be retrieved."
+      end
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def create_room (name, options={})
+      response = self.class.post("/rooms", :body => {:name => name, :options => options}.to_json, :headers => {
+        "Authorization" => mauth_header
+      })
+      case response.code
+      when (200..300)
+        response
+      when 403
+        raise LicodeAuthenticationError, "Authentication failed while creating a room. Service: #{@service_id}"
+      else
+        raise LicodeError, "Failed to create room. Response code: #{response}"
+      end
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def get_room (room)
+      response = self.class.get('/rooms/' + room, {
+        :headers => {
+          "Authorization" => mauth_header
+        }
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def delete_room (room)
+      response = self.class.delete('/rooms/' + room, {
+        :headers => {
+          "Authorization" => mauth_header
+        }
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def create_token(room, username, role)
+      response = self.class.post('/rooms/' + room + '/tokens', {
+        :headers => { "Authorization" => mauth_header(:username => username.to_s, :role => role) }
+      })
+      response
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def create_service (name, key)
+      response = self.class.post('/services/',
+        :body => {'name' => name, 'key' => key},
+        :headers => {
+          "Authorization" => mauth_header
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def get_services ()
+      response = self.class.get('/services/',
+      :headers => {
+        "Authorization" => mauth_header,
+        "Content-Type" => "application/json"
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def get_service (service)
+      response = self.class.get('/services/' + service,
+      :headers => {
+        "Authorization" => mauth_header,
+        "Content-Type" => "application/json",
+        "Content-Type" => "application/json"
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def delete_service (service)
+      response = self.class.delete('/services/' + service,
+      :headers => {
+        "Authorization" => mauth_header,
+        "Content-Type" => "application/json"
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    def get_room_users (room)
+      response = self.class.get('/rooms/' + room + '/users/',
+      :headers => {
+        "Authorization" => mauth_header,
+        "Content-Type" => "application/json"
+      })
+    rescue StandardError => e
+      raise LicodeError, "Failed to connect to Licode. Response code: #{e.message}"
+    end
+
+    private
+    def mauth_header(opts = {})
+      header = "MAuth realm=#{@service_url},mauth_signature_method=HMAC_SHA1"
+      timestamp = (Time.now.to_f * 1000).to_i
+      cnounce = rand(99999)
+
+      toSign = timestamp.to_s + "," + cnounce.to_s
+
+      if opts[:username] && !opts[:username].empty? && opts[:role] && !opts[:role].empty?
+        header += ',mauth_username='
+        header +=  opts[:username]
+        header += ',mauth_role='
+        header +=  opts[:role]
+
+        toSign += ',' + opts[:username] + ',' + opts[:role]
+      end
+
+      signed = calculateSignature(toSign, @service_key)
+
+      header += ',mauth_serviceid='
+      header +=  @service_id
+      header += ',mauth_cnonce='
+      header += cnounce.to_s
+      header += ',mauth_timestamp='
+      header +=  timestamp.to_s
+      header += ',mauth_signature='
+      header +=  signed
+
+      header
+    end
+
+    private
+    def calculateSignature (toSign, key)
+      digest = OpenSSL::Digest.new('sha1')
+      hex = OpenSSL::HMAC.hexdigest(digest,key,toSign)
+      signed   = Base64.encode64("#{hex}")
+      return signed
+    end
+  end
+end

data/lib/licode/exceptions.rb

@@ -0,0 +1,8 @@
+module Licode
+
+  # Defines errors raised by methods of the Licode Ruby SDK.
+  class LicodeError < StandardError; end
+  # Defines errors raised when authentication fails
+  class LicodeAuthenticationError < LicodeError; end
+
+end

data/lib/licode/nuve.rb

@@ -0,0 +1,40 @@
+require "licode/room"
+require "licode/client"
+
+module Licode
+  class Nuve
+    attr_reader :service_id, :service_key, :service_url
+    ##
+    # Create a new Nuve object.
+    #
+    # @param [String] service_id Your ServiceId. See the Nuve Mongo DB.
+    # @param [String] service_key Your ServiceKey.
+    # @param [String] service_url base URL to your licode instance.
+
+    def initialize (service_id, service_key, service_url)
+      @service_id = service_id
+      @service_key = service_key
+      @service_url = service_url
+    end
+
+    # def create_service(name, key)
+    # 	response = client.create_service(name,key});
+    #   Service.new name,key
+    # end
+
+    def create_room(name,opts={})
+      response = client.create_room(name,opts)
+      Room.new response['_id'], opts
+    end
+
+    def create_token(room, username, role)
+      client.create_token(room, username, role)
+    end
+
+    protected
+
+    def client
+      @client ||= Client.new service_id, service_key, service_url
+    end
+  end
+end

data/lib/licode/room.rb

@@ -0,0 +1,29 @@
+require "licode/client"
+module Licode
+  # Represents an Licode room.
+  #
+  # Use the Nuve.create_room() method to create an Licode room. Use the
+  # room_id property of the Room object to get the room room_id.
+  class Room
+    attr_reader :room_id, :users, :opts
+
+    # @private
+    def initialize(room_id, opts={})
+      @room_id = room_id
+      @opts = opts
+    end
+
+    def create_token(username, role)
+      client.create_token(room_id, username, role)
+    end
+
+    def users
+      client.get_room_users(room_id);
+    end
+
+    # @private
+    def to_s
+      @room_id
+    end
+  end
+end

data/lib/licode/service.rb

@@ -0,0 +1,5 @@
+module Licode
+  class Service
+
+  end
+end

data/lib/licode/version.rb

@@ -0,0 +1,3 @@
+module Licode
+  VERSION = "0.1.1"
+end

data/licode.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'licode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "licode"
+  spec.version       = Licode::VERSION
+  spec.authors       = ["Joshua Rountree"]
+  spec.email         = ["joshua@swodev.com"]
+
+  spec.summary       = %q{Ruby gem for working with Licode Services from Ruby}
+  spec.description   = %q{This is a ruby gem based on the rb file from the licode repo but with tests and an up to date code base.}
+  spec.homepage      = "https://github.com/joshuairl/licode-ruby-sdk"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "addressable", "~> 2.3"
+  spec.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.1'
+  spec.add_runtime_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: licode
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Joshua Rountree
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This is a ruby gem based on the rb file from the licode repo but with
+  tests and an up to date code base.
+email:
+- joshua@swodev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/licode.rb
+- lib/licode/client.rb
+- lib/licode/exceptions.rb
+- lib/licode/nuve.rb
+- lib/licode/room.rb
+- lib/licode/service.rb
+- lib/licode/version.rb
+- licode.gemspec
+homepage: https://github.com/joshuairl/licode-ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem for working with Licode Services from Ruby
+test_files: []
+has_rdoc: