openvidu-ruby-client 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59a8122f21134fc2603ab6a8ee13db1688c30e8c
-  data.tar.gz: 822010be06300ead388a01be303fdd8a54a7fdb1
+  metadata.gz: 92a0236b9a03c43f0e291d64f90afe17c0b7df22
+  data.tar.gz: 349f451e07e134e94e1fa51b496ef4058595e67f
 SHA512:
-  metadata.gz: 5526e8ef1d05d2942df8bea05184452041502440b230652d36955fdc88519d19590df1abe5bd1b1aca557b5c0c22151902a4e0feaa2e7d0df08c94eb539cfe33
-  data.tar.gz: 1057d5c72a526ada260bbd5327641e6ee8198924ba04e301c9ec15a17f00f334ba4d17ac79cacef9a9c4a11dfbcfaf81aebaf17c3c9cb8afacf8583b8887e421
+  metadata.gz: 547c143edba3b07a2bc0bad6fa41b7dd0ddd8663f9f25b37f9ec7992652377547da6284164ea06ad55de2eb74d68188d9e4ff53525ebbab025b3676326b83cbc
+  data.tar.gz: 5bcbfcb21c66f75c8b11df8c9a44992bbb8087a64d1e37ac52998baf4052d29754564346833202a16a8bf51db0d517c2a7667452a04ee76e83b6654922125602

data/.gitignore

@@ -11,3 +11,5 @@
 /vendor/
 .DS_Store
 \.idea
+\.rakeTasks
+Gemfile.lock

data/README.md

@@ -1,8 +1,6 @@
 # OpenVidu Ruby Client
 
-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/open_vidu`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+![Build Status](https://travis-ci.org/BryanSaxon/openvidu-ruby-client.svg?branch=master)
 
 ## Installation
 
@@ -22,12 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To get started locally, first pull the OpenVidu Docker image and start a container:
 
 ```bash
-OPENVIDU_URL = 'https://localhost:4443'
-OPENVIDU_USERNAME = 'OPENVIDUAPP'
-OPENVIDU_PASSWORD = 'MY_SECRET'
+docker pull openvidu/openvidu-server-kms
+docker run -p 4443:4443 -d --rm -e openvidu.secret=MY_SECRET -e openvidu.recording.path=/recordings -e openvidu.recording=true -v /var/run/docker.sock:/var/run/docker.sock openvidu/openvidu-server-kms
+```
+
+Set the following environment variables in your Ruby application:
+
+To start a OpenVidu session:
+
+```ruby
+server = 'https://127.0.0.1:4443?token=MY_SECRET'
+
+OpenVidu::Session.new(server,
+  customSessionId: 'your-custom-session-id',
+  defaultOutputMode: 'INDIVIDUAL',
+  recordingMode: 'ALWAYS').create
+
+# Create a token to publish video
+token = OpenVidu::Token.new(server, session: 'your-custom-session-id,
+  role: "PUBLISHER",
+  data: {
+    "full_name": "John Smith"  # Custom data can be supplied here
+  }
+)
+
 ```
 
 ## Development

data/lib/open_vidu.rb

@@ -1,6 +1,7 @@
 require "open_vidu/version"
+require "open_vidu/base"
 
 module OpenVidu
   class Error < StandardError; end
-  # Your code goes here...
+
 end

data/lib/open_vidu/base.rb

@@ -1,4 +1,5 @@
 require 'open_vidu/command'
+require 'open_vidu/server'
 
 module OpenVidu
   # Base
@@ -7,11 +8,14 @@ module OpenVidu
     GENERATED_PARAMS = %w[].freeze
     ALL_PARAMS = (ASSIGNABLE_PARAMS + GENERATED_PARAMS).freeze
 
+    attr_reader :server
+
     def self.content_key
       'content'
     end
 
-    def initialize(params = {})
+    def initialize(uri, params = {})
+      @server = Server.new(uri).freeze
       self.class::ALL_PARAMS.each do |param|
         instance_variable_set("@#{param}", params[param.to_sym])
         self.class.send(:attr_accessor, param.to_sym)

data/lib/open_vidu/command.rb

@@ -5,19 +5,23 @@ require 'open_vidu/exceptions'
 module OpenVidu
   # Command
   class Command
-    attr_reader :object, :method, :endpoint, :params
+    attr_reader :object, :method, :endpoint, :params, :requestor, :responder, :server
 
-    def initialize(object, method, endpoint, params = {})
+    def initialize(object, method, endpoint, params = {}, options: {})
       @object = object
       @method = method
       @endpoint = endpoint
       @params = params
+
+      @server = options.fetch(:server)
+      @requestor = options[:requestor] || OpenVidu::Requestor.new(server, method, endpoint, params)
+      @responder = options[:responder] || OpenVidu::Responder.new
     end
 
     def execute
-      response = OpenVidu::Requestor.new(method, endpoint, params).execute
+      response = requestor.execute
       raise OpenVidu::ResponseError.new(response) unless valid?(response)
-      OpenVidu::Responder.new(object, response.parsed_response).execute
+      responder.execute(server, object, response.parsed_response)
     end
 
     private

data/lib/open_vidu/config.rb

@@ -12,8 +12,8 @@ module OpenVidu
     ].freeze
     ALL_PARAMS = (ASSIGNABLE_PARAMS + GENERATED_PARAMS).freeze
 
-    def self.config
-      OpenVidu::Command.new(:config, :get, 'config').execute
+    def config
+      OpenVidu::Command.new(:config, :get, 'config', { options: {server: server } }).execute
     end
   end
 end

data/lib/open_vidu/recording.rb

@@ -14,19 +14,19 @@ module OpenVidu
       'items'
     end
 
-    def self.all
+    def all
       OpenVidu::Command.new(
-        :recording, :get, 'api/recordings'
+        :recording,
+        :get,
+        'api/recordings',
+        { options: { server: server } }
       ).execute
     end
 
-    def self.create(params)
-      new(params).create
-    end
-
-    def self.find(id)
+    def find(id)
       OpenVidu::Command.new(
-        :recording, :get, "api/recordings/#{id}"
+        :recording, :get, "api/recordings/#{id}",
+        { options: { server: server } }
       ).execute
     end
 
@@ -34,7 +34,8 @@ module OpenVidu
       OpenVidu::Command.new(
         :recording,
         :post,
-        "api/recordings/stop/#{id}"
+        "api/recordings/stop/#{id}",
+        { options: { server: server } }
       ).execute
     end
 
@@ -42,13 +43,18 @@ module OpenVidu
       OpenVidu::Command.new(
         :recording,
         :delete,
-        "api/recordings/#{id}"
+        "api/recordings/#{id}",
+        { options: { server: server } }
       ).execute
     end
 
     def create
       OpenVidu::Command.new(
-        :recording, :post, 'api/recordings/start', create_params
+        :recording,
+        :post,
+        'api/recordings/start',
+        create_params,
+        { options: { server: server } }
       ).execute
     end
 

data/lib/open_vidu/requestor.rb

@@ -4,13 +4,10 @@ require 'json'
 module OpenVidu
   # Requestor
   class Requestor
-    attr_reader :method, :endpoint, :params
+    attr_reader :server, :method, :endpoint, :params
 
-    BASE_URL = ENV['OPENVIDU_URL']
-    TOKEN = "#{ENV['OPENVIDU_USERNAME']}:#{ENV['OPENVIDU_PASSWORD']}".freeze
-    VERIFY_PEER = ENV['OPENVIDU_VERIFY_PEER']
-
-    def initialize(method, endpoint, params = {})
+    def initialize(server, method, endpoint, params = {})
+      @server = server
       @method = method
       @endpoint = endpoint
       @params = params
@@ -23,16 +20,16 @@ module OpenVidu
     private
 
     def url
-      "#{BASE_URL}/#{endpoint}"
+      "#{server.scheme}://#{server.host}:#{server.port || 4443}/#{endpoint}"
     end
 
     def options
       {
         headers: {
-          'Authorization' => "Basic #{Base64.strict_encode64(TOKEN)}",
+          'Authorization' => "Basic #{Base64.strict_encode64(server.token)}",
           'Content-Type' => 'application/json'
         },
-        verify: VERIFY_PEER != 'false',
+        verify: server.verify_peer?,
         body: params.to_json
       }
     end

data/lib/open_vidu/responder.rb

@@ -3,19 +3,16 @@ module OpenVidu
   class Responder
     attr_reader :object, :response
 
-    def initialize(object, response)
+    def execute(server, object, response)
       @object = object
       @response = response
-    end
-
-    def execute
       klass = Object.const_get(klass_name)
 
       return true if record_destroyed?
-      return klass.new(mapped_params(response)) if complete_record?
-      return klass.find(response['id']) if record_lookup?
+      return klass.new(server, mapped_params(response)) if complete_record?
+      return klass.new(server).find(response['id']) if record_lookup?
 
-      response[content_key].map { |hash| klass.new(mapped_params(hash)) }
+      response[content_key].map { |hash| klass.new(server, mapped_params(hash)) }
     end
 
     private

data/lib/open_vidu/server.rb

@@ -0,0 +1,39 @@
+require 'addressable'
+require 'forwardable'
+
+module OpenVidu
+  # Endpoint configuration
+  class Server
+    extend Forwardable
+
+    InvalidURI = Class.new(StandardError)
+
+    def_delegators :@uri, :host, :port, :scheme, :query_values, :to_s
+
+    # `uri` should take the form of scheme://some-openvidu-host-or-ip:port?token=<your-secret-here>
+    # e.g. https://1.2.3.4?token=abcdefghijklmnop
+    def initialize(uri)
+      @uri = Addressable::URI.parse(uri.to_s)
+      raise InvalidURI if @uri.empty?
+    end
+
+    def token
+      "OPENVIDUAPP:#{query_values.fetch('token')}"
+    end
+
+    def host_and_port
+      "#{host}:#{port}"
+    end
+
+    def verify_peer?
+      return false if query_values['verify_peer'].to_s.downcase == 'false'
+
+      true
+    end
+
+    def ==(other)
+      other.to_s == self.to_s
+    end
+  end
+end
+

data/lib/open_vidu/session.rb

@@ -8,26 +8,22 @@ module OpenVidu
     GENERATED_PARAMS = %w[sessionId createdAt connections recording].freeze
     ALL_PARAMS = (ASSIGNABLE_PARAMS + GENERATED_PARAMS).freeze
 
-    def self.all
+    def all
       OpenVidu::Command.new(
-        :session, :get, 'api/sessions'
+        :session, :get, 'api/sessions', { options: { server: server } }
       ).execute
     end
 
-    def self.create(params)
-      new(params).create
-    end
-
-    def self.find(id)
+    def find(id)
       OpenVidu::Command.new(
-        :session, :get, "api/sessions/#{id}"
+        :session, :get, "api/sessions/#{id}", { options: { server: server } }
       ).execute
     end
 
-    def self.exists?(id)
+    def exists?(id)
       begin
         OpenVidu::Command.new(
-            :session, :get, "api/sessions/#{id}"
+          :session, :get, "api/sessions/#{id}", { options: { server: server } }
         ).execute
         true
       rescue OpenVidu::ResponseError => e
@@ -38,13 +34,13 @@ module OpenVidu
 
     def create
       OpenVidu::Command.new(
-        :session, :post, 'api/sessions', create_params
+        :session, :post, 'api/sessions', create_params, { options: { server: server } }
       ).execute
     end
 
     def delete
       OpenVidu::Command.new(
-        :session, :delete, "api/sessions/#{sessionId}"
+        :session, :delete, "api/sessions/#{customSessionId}", { options: { server: server } }
       ).execute
     end
   end

data/lib/open_vidu/token.rb

@@ -5,13 +5,9 @@ module OpenVidu
     GENERATED_PARAMS = %w[id token].freeze
     ALL_PARAMS = (ASSIGNABLE_PARAMS + GENERATED_PARAMS).freeze
 
-    def self.create(params)
-      new(params).create
-    end
-
     def create
       OpenVidu::Command.new(
-        :token, :post, 'api/tokens', create_params
+        :token, :post, 'api/tokens', create_params, options: { server: server }
       ).execute
     end
   end

data/lib/open_vidu/version.rb

@@ -1,3 +1,3 @@
 module OpenVidu
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/openvidu-ruby-client.gemspec

@@ -37,7 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.4'
   spec.add_development_dependency 'openssl', '>= 2.1.2' # Fix for Travis CI
+  spec.add_development_dependency 'webmock', '~> 3.7'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
 
-  spec.add_development_dependency 'dotenv', '~> 2.7', '>= 2.7.5'
+  spec.add_runtime_dependency 'addressable', '>= 2.5.0'
   spec.add_runtime_dependency 'httparty', '>= 0.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openvidu-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryan Saxon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -93,25 +93,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.2
 - !ruby/object:Gem::Dependency
-  name: dotenv
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
-    - - ">="
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.5
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +173,7 @@ files:
 - lib/open_vidu/recording.rb
 - lib/open_vidu/requestor.rb
 - lib/open_vidu/responder.rb
+- lib/open_vidu/server.rb
 - lib/open_vidu/session.rb
 - lib/open_vidu/token.rb
 - lib/open_vidu/version.rb