eyeson 2.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df038ff7b658f27c2f39ef01417c1001f7f87b46
+  data.tar.gz: 33a6f554c01e04eac6672ef6b491b0770ca070a9
+SHA512:
+  metadata.gz: 6a4458e514f1bcb32c97e98fe174e2ee714c7dd5c8905250c9ec6127f5b48c71f57723db9b1c1b200b7825dcbf6393b0fb0b42ce7abcd4d248224a63dcc62101
+  data.tar.gz: 458f634872b4482aa2f7172a01a325a852a0b4126b368a96e36159eff9f084a7ff5c0e7ab536ba6b648e0387fdcdd27c798202c231f950b998da21eb58dfcb41

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 eyeson GmbH
+
+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,121 @@
+# Eyeson
+eyeson ruby sdk for service app implementation
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eyeson'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+## Configuration
+```ruby
+Eyeson.configure do |config|
+  config.api_key      = 'YOUR_API_KEY'
+  config.api_endpoint = 'https://api.eyeson.team'
+end
+```
+
+## Receive webhooks for specific events
+
+```ruby
+Eyeson::Webhook.create!(
+  url,       # Webhooks will be sent to this URL
+  types: []  # supported types: 'room', 'team', 'user', 'presentation', 'broadcast', 'file'
+)
+```
+
+## Meeting reference
+
+### Join a meeting room
+
+Puts a user to a (specific) meeting room.
+
+If no arbitrary ids are given, random ids will be generated.
+
+```ruby
+room = Eyeson::Room.join(id:   'ARBITRARY_ID',     # optional, e.g. to join a specific room
+                         name: 'DISPLAY_NAME',     # optional
+                         user: {
+                        	 id:     'ARBITRARY_ID', # optional, e.g. your internal user_id
+                        	 name:   'DISPLAY_NAME', # required!
+                        	 avatar: 'IMAGE_URL'     # optional
+                         })
+```
+
+The meeting room will be available immediately:
+
+```ruby
+# Temporary access key - only valid for current session:
+# access_key = room.access_key 
+
+redirect_to room.url
+```
+
+### Upload a presentation file from remote URL
+
+Uploads and converts any external stored PDF file for presentation.
+
+```ruby
+Eyeson::FileUpload.new(access_key).upload_from('FILE_URL')
+```
+
+### Start a live broadcast (YouTube only at the moment)
+
+```ruby
+Eyeson::Broadcast.new(access_key).create(
+  platform:   'youtube',
+  stream_url: 'YOUTUBE_STREAM_URL' # see YouTube documentation on how to get a stream url.
+)
+```
+
+#### Stop specific broadcast
+
+```ruby
+Eyeson::Broadcast.new(access_key).destroy(
+  platform: 'youtube'
+)
+```
+
+#### Stop all broadcasts
+
+```ruby
+Eyeson::Broadcast.new(access_key).destroy_all
+```
+
+### Send a message into meeting chat
+
+```ruby
+Eyeson::Message.new(access_key).create(
+  type:    'chat',
+  content: 'YOUR_MESSAGE'
+)
+```
+
+### Insert an image into video
+
+```ruby
+Eyeson::Layer.new(access_key).create(
+  file:   FILE, # either file or url must be provided!
+  url:    URL,  # either file or url must be provided!
+  index:  1,    # (optional) use 1 (default) to set as foreground image and -1 to set as background image
+  layout: nil   # (optional) currently supported: 'auto' (meeting participants will be arranged automatically), 'fixed' (meeting participants will be rendered at the bottom of the video, so your background content can be fully displayed.)
+)
+```
+
+### Get download URL of a specific recording
+
+It is assumed that the recording_id is known (e.g. from a webhook request).
+
+```ruby
+recording = Eyeson::Recording.find(recording_id)
+redirect_to recording.url
+```
+
+## 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,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Eyeson'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/eyeson.rb

@@ -0,0 +1,27 @@
+# Eyeson API
+module Eyeson
+  require 'rest_client'
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+require_relative 'eyeson/config'
+require_relative 'eyeson/requests'
+require_relative 'eyeson/account'
+require_relative 'eyeson/webhook'
+require_relative 'eyeson/room'
+require_relative 'eyeson/file_upload'
+require_relative 'eyeson/layer'
+require_relative 'eyeson/broadcast'
+require_relative 'eyeson/message'
+require_relative 'eyeson/recording'

data/lib/eyeson/account.rb

@@ -0,0 +1,25 @@
+module Eyeson
+  # Handles eyeson account confirmation
+  class Account
+    class ValidationFailed < StandardError
+    end
+
+    attr_reader :confirmation_url
+
+    def initialize(confirmation_url: nil)
+      @confirmation_url = confirmation_url
+    end
+
+    def self.find_or_initialize_by(user: {}, remote_ip: nil)
+      confirmed = Eyeson.post('/internal/accounts',
+                              user: user,
+                              remote_ip: remote_ip)
+      confirmation_url = confirmed['create_url'] if confirmed.present?
+      Account.new(confirmation_url: confirmation_url)
+    end
+
+    def new_record?
+      @confirmation_url.present?
+    end
+  end
+end

data/lib/eyeson/broadcast.rb

@@ -0,0 +1,27 @@
+module Eyeson
+  # Manages room broadcast
+  class Broadcast
+    class ValidationFailed < StandardError
+    end
+
+    def initialize(access_key)
+      @access_key = access_key
+    end
+
+    def create(platform: nil, stream_url: nil)
+      response = Eyeson.post("/rooms/#{@access_key}/broadcasts",
+                             platform:   platform,
+                             stream_url: stream_url)
+
+      raise ValidationFailed, response['error'] if response['error'].present?
+    end
+
+    def destroy(platform: nil)
+      Eyeson.delete("/rooms/#{@access_key}/broadcasts/#{platform}")
+    end
+
+    def destroy_all
+      Eyeson.delete("/rooms/#{@access_key}/broadcasts")
+    end
+  end
+end

data/lib/eyeson/config.rb

@@ -0,0 +1,11 @@
+module Eyeson
+  # API configuration class
+  class Configuration
+    attr_accessor :api_key, :api_endpoint
+
+    def initialize
+      @api_key      = ''
+      @api_endpoint = 'https://api.eyeson.team'
+    end
+  end
+end

data/lib/eyeson/file_upload.rb

@@ -0,0 +1,35 @@
+require 'open-uri'
+
+module Eyeson
+  # Manages file uploads
+  class FileUpload
+    class ValidationFailed < StandardError
+    end
+
+    attr_accessor :file
+
+    def initialize(access_key)
+      @access_key = access_key
+      @file       = nil
+    end
+
+    def upload_from(url)
+      Tempfile.class_eval do
+        attr_accessor :original_filename
+      end
+
+      url = URI(url)
+      @file = OpenURI.open_uri url
+      @file.original_filename = File.basename url.path
+
+      upload!
+    end
+
+    private
+
+    def upload!
+      response = Eyeson.post("/rooms/#{@access_key}/files", file: @file)
+      raise ValidationFailed, response['error'] if response['error'].present?
+    end
+  end
+end

data/lib/eyeson/layer.rb

@@ -0,0 +1,26 @@
+module Eyeson
+  # Manages room layers
+  class Layer
+    class ValidationFailed < StandardError
+    end
+
+    def initialize(access_key)
+      @access_key = access_key
+    end
+
+    def create(file: nil, url: nil, insert: nil, index: 1, layout: nil)
+      response = Eyeson.post("/rooms/#{@access_key}/layers",
+                             file: file,
+                             url: url,
+                             insert: insert,
+                             'z-index' => index,
+                             layout: layout)
+
+      raise ValidationFailed, response['error'] if response['error'].present?
+    end
+
+    def destroy(index: 1, layout: nil)
+      Eyeson.delete("/rooms/#{@access_key}/layers/#{index}", layout: layout)
+    end
+  end
+end

data/lib/eyeson/message.rb

@@ -0,0 +1,19 @@
+module Eyeson
+  # Forward messages to room
+  class Message
+    class ValidationFailed < StandardError
+    end
+
+    def initialize(access_key)
+      @access_key = access_key
+    end
+
+    def create(type: nil, content: nil)
+      response = Eyeson.post("/rooms/#{@access_key}/messages",
+                             type: type,
+                             content: content)
+
+      raise ValidationFailed, response['error'] if response['error'].present?
+    end
+  end
+end

data/lib/eyeson/recording.rb

@@ -0,0 +1,20 @@
+module Eyeson
+  # Get room recordings
+  class Recording
+    class NotFound < StandardError
+    end
+
+    attr_reader :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def self.find(recording_id)
+      response  = Eyeson.get("/recordings/#{recording_id}")
+      links     = response['links']
+      raise NotFound if links.nil?
+      Recording.new(links['download'])
+    end
+  end
+end

data/lib/eyeson/requests.rb

@@ -0,0 +1,43 @@
+# Provides REST methods
+module Eyeson
+  def get(path, params = {})
+    request(:get, path, params)
+  end
+  module_function :get
+
+  def post(path, params = {})
+    request(:post, path, params)
+  end
+  module_function :post
+
+  def delete(path, params = {})
+    request(:delete, path, params)
+  end
+  module_function :delete
+
+  def request(method, path, params)
+    req = RestClient::Request.new(
+      method: method,
+      url: configuration.api_endpoint + path,
+      payload: params.compact,
+      headers: {
+        authorization: configuration.api_key,
+        accept: 'application/json',
+        user_agent: 'eyeson-ruby'
+      }
+    )
+    response_for(req)
+  end
+  module_function :request
+
+  def response_for(req)
+    res = begin
+      req.execute
+    rescue RestClient::ExceptionWithResponse => e
+      e.response
+    end
+    return {} if res.body.empty?
+    JSON.parse(res.body)
+  end
+  module_function :response_for
+end

data/lib/eyeson/room.rb

@@ -0,0 +1,26 @@
+module Eyeson
+  # Manages conf rooms
+  class Room
+    class ValidationFailed < StandardError
+    end
+
+    attr_reader :url, :access_key, :links
+
+    def initialize(response = {})
+      @url        = response['links']['gui']
+      @access_key = response['access_key']
+      @links      = response['links']
+    end
+
+    def self.join(id: nil, name: nil, user: {}, options: nil)
+      response = Eyeson.post('/rooms',
+                             id:      id,
+                             name:    name,
+                             user:    user,
+                             options: options)
+
+      raise ValidationFailed, response['error'] if response['error'].present?
+      Room.new(response)
+    end
+  end
+end

data/lib/eyeson/version.rb

@@ -0,0 +1,3 @@
+module Eyeson
+  VERSION = '2.4.1'.freeze
+end

data/lib/eyeson/webhook.rb

@@ -0,0 +1,14 @@
+module Eyeson
+  # Creates Webhooks
+  class Webhook
+    class ValidationFailed < StandardError
+    end
+
+    def self.create!(url: nil, types: [])
+      response = Eyeson.post('/webhooks',
+                             url: url,
+                             types: types.join(','))
+      raise ValidationFailed, response['error'] if response['error'].present?
+    end
+  end
+end

data/lib/tasks/eyeson_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :eyeson do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: eyeson
+version: !ruby/object:Gem::Version
+  version: 2.4.1
+platform: ruby
+authors:
+- Michael Maier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: Use the eyeson api to boost your app with video conferencing
+email:
+- developers@eyeson.team
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/eyeson.rb
+- lib/eyeson/account.rb
+- lib/eyeson/broadcast.rb
+- lib/eyeson/config.rb
+- lib/eyeson/file_upload.rb
+- lib/eyeson/layer.rb
+- lib/eyeson/message.rb
+- lib/eyeson/recording.rb
+- lib/eyeson/requests.rb
+- lib/eyeson/room.rb
+- lib/eyeson/version.rb
+- lib/eyeson/webhook.rb
+- lib/tasks/eyeson_tasks.rake
+homepage: https://www.eyeson.team/developers
+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.6.14.1
+signing_key: 
+specification_version: 4
+summary: eyeson API
+test_files: []