evostream-event 0.3.0 → 0.3.1.pre.52

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b64114447fab23fc4145af949a751c2b6aa2fcd5
-  data.tar.gz: 9f57da4855a3f0857b2e33d11ff5322301c8f517
+  metadata.gz: bac0d2f68701f1ade31fa5ce2a9f3349575efff8
+  data.tar.gz: 7234b8571fcbef0a2b4db1dc0bc86723e3453e65
 SHA512:
-  metadata.gz: fe8b17e977caae49943a17baee185d28b9c9c6d819732323ab9190527a81fa7fa432d406348734eb50d92778d40a0b51d8ae5cf981adf1d26893e56362dd1038
-  data.tar.gz: 38e868c364d05539e412eb0cc81d506b670a975e95fb79c7d4cd2f66d00b383245c75926325f38339e2b071382601e9adf30ee117a96a55358f40a426f06c1b2
+  metadata.gz: 901127bdce584987d49ef5463f8212a1b3cd6d7a25b72711dd3d36948374979b87ea26054e3c2fff444ee6d5bdf4bdc2ff3a8ad4657d0905481b6a4a1e351c84
+  data.tar.gz: 012325881d281cec235c886fe3bba4aeb1585950ebf3f98ead1b8bef8ca875674eaf073cc04c7259b076e679af7b27a015bd5a3d347be6ae849dc58c34056227

data/README.md

@@ -32,6 +32,36 @@ Or install it yourself as :
 gem install evostream-event
 ```
 
+### Environment
+
+This gem use a configuration file for configure access to EvoStream server.
+
+See initializer file.
+```ruby
+# URL to EvoStream for share video to final user
+config.uri_in       = 'http://server_stream.local:80'
+
+# URL to EvoStream for sending request to this API
+config.uri_out      = 'http://server_stream.local:7777'
+
+# Prefix to folder created for each video mangaed by EvoStream
+config.name         = 'srteamming_'
+
+# Folder for file created by EvoStream
+config.web_root     = '/var/www/html'
+
+# Name to model manipulate
+config.model        = ModelUsedInDatabase
+
+# Choose id to document manipulate in Database
+config.model_id     = :identifier_used_in_model
+
+# Use environment for this gem. Choose between :
+# - development   : Write in log and Send request to evoStream
+# - test          : Write in Log
+# - production    : Send request to EvoStream
+config.environement = :test
+```
 ### Usage
 
 Create initializer :

data/lib/evostream/event/action.rb

@@ -10,6 +10,7 @@ module Evostream
     def execute_action(command_name)
       cmd = command_name.sub(/^(\w)/, &:capitalize)
       klass = "Evostream::Commands::#{cmd}".constantize
+      Evostream.logger "Execute action with cmd : #{klass}"
       Evostream.send_command(klass.new(@payload).cmd)
     end
   end

data/lib/evostream/event/commands.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :reek:UncommunicativeMethodName
+
 module Evostream
   # Manage command
   module Commands
@@ -11,12 +13,24 @@ module Evostream
           @command.push send(command_name, command_param)
         end
       end
+
+      def cmd
+        Evostream.logger "Command before encode : #{@command}"
+      end
+
+      private
+
+      # Encode commands in base 64 with space between each command
+      def encode_64
+        Base64.strict_encode64(@command.join(' '))
+      end
     end
   end
 end
 
 require 'evostream/event/commands/create'
 require 'evostream/event/commands/destroy'
-require 'evostream/event/commands/push_stream'
+require 'evostream/event/commands/get_stream_info'
 require 'evostream/event/commands/list_config'
 require 'evostream/event/commands/list_streams'
+require 'evostream/event/commands/push_stream'

data/lib/evostream/event/commands/create.rb

@@ -16,78 +16,78 @@ module Evostream
       # The stream(s) that will be used as the input. This is a comma-delimited
       # list of active stream names (local stream names)
       def local_stream_names(param = 'null')
-        "localStreamNames=#{param} "
+        "localStreamNames=#{param}"
       end
 
       # The folder where all the manifest and fragment files will be stored.
       # This folder must be accessible by the DASH clients. It is usually in the
       # web-root of the server
       def target_folder(param = 'null')
-        "targetFolder=#{param} "
+        "targetFolder=#{param}"
       end
 
       # The corresponding bandwidths for each stream listed in localStreamNames.
       # Again, this can be a comma-delimited list
       def bandwidths(param = 0)
-        "bandwidths=#{param} "
+        "bandwidths=#{param}"
       end
 
       # The name assigned to the DASH stream or group. If the localStreamNames
       # parameter contains only one entry and groupName is not specified,
       # groupName will have the value of the input stream name
       def group_name(param)
-        "groupName=#{param} "
+        "groupName=#{param}"
       end
 
       # Either `appending` or `rolling`
       def playlist_type(param = 'appending')
-        "playlistType=#{param} "
+        "playlistType=#{param}"
       end
 
       # The number of fragments before the server starts to overwrite the older
       # fragments. Used only when playlistType is 'rolling'. Ignored otherwise
       def playlist_length(param = 10)
-        "playlistLength=#{param} "
+        "playlistLength=#{param}"
       end
 
       # The length (in seconds) of fragments to be made
       def chunk_length(param = 10)
-        "chunkLength=#{param} "
+        "chunkLength=#{param}"
       end
 
       # If true, chunking is performed ONLY on IDR. Otherwise, chunking is
       # performed whenever chunk length is achieved
       def chunk_on_idr(param = 1)
-        "chunkOnIDR=#{param} "
+        "chunkOnIDR=#{param}"
       end
 
       # If true, the EMS will attempt to reconnect to the stream source if the
       # connection is severed
       def keep_alive(param = 1)
-        "keepAlive=#{param} "
+        "keepAlive=#{param}"
       end
 
       # If true, it will allow overwrite of destination files
       def overwrite_destination(param = 1)
-        "overwriteDestination=#{param} "
+        "overwriteDestination=#{param}"
       end
 
       # How many old files are kept besides the ones present in the current
       # version of the playlist. Only applicable for rolling playlists
       def stale_retention_count(param)
-        "staleRetentionCount=#{param} "
+        "staleRetentionCount=#{param}"
       end
 
       # If true, all manifest and fragment files in the target folder will be
       # removed before DASH creation is started
       def cleanup_destination(param = 0)
-        "cleanupDestination=#{param} "
+        "cleanupDestination=#{param}"
       end
 
       # Set this parameter to 1 (default) for a live DASH, otherwise set it to 0
       # for a VOD
       def dynamic_profile(param = 1)
-        "dynamicProfile=#{param} "
+        "dynamicProfile=#{param}"
       end
     end
   end

data/lib/evostream/event/commands/create/dash.rb

@@ -12,16 +12,14 @@ module Evostream
       end
 
       def cmd
-        cmd_hash = command.join
-        Evostream.logger "createDASHStream : #{cmd_hash}"
-        "createDASHStream?params=#{Base64.urlsafe_encode64(cmd_hash)}"
+        "createDASHStream?params=#{encode_64}"
       end
 
       private
 
       # The manifest file name
       def manifest_name(param = 'manifest.mpd')
-        "manifestName=#{param} "
+        "manifestName=#{param}"
       end
     end
   end

data/lib/evostream/event/commands/create/hls.rb

@@ -14,20 +14,18 @@ module Evostream
       end
 
       def cmd
-        cmd_hash = command.join
-        Evostream.logger "createHLSStream : #{cmd_hash}"
-        "createHLSStream?params=#{Base64.urlsafe_encode64(cmd_hash)}"
+        "createHLSStream?params=#{encode_64}"
       end
 
       private
 
       def create_master_playlist(param = 1)
-        "createMasterPlaylist=#{param} "
+        "createMasterPlaylist=#{param}"
       end
 
       # The manifest file name
       def playlist_name(param = 'playlist.m3u8')
-        "playlistName=#{param} "
+        "playlistName=#{param}"
       end
 
       # This parameter represents the maximum length, in seconds, the EMS will
@@ -35,12 +33,12 @@ module Evostream
       # chunkOnIDR=true where the EMS will wait for the next key-frame. If the
       # maxChunkLength is less than chunkLength, the parameter shall be ignored
       def max_chunk_length(param = 0)
-        "maxChunkLength=#{param} "
+        "maxChunkLength=#{param}"
       end
 
       # The base name used to generate the *.ts chunks
       def chunk_base_name(param = 'segment')
-        "chunkBaseName=#{param} "
+        "chunkBaseName=#{param}"
       end
 
       # Sets the type of DRM encryption to use.  Options are: none (no
@@ -48,36 +46,36 @@ module Evostream
       # (Verimatrix DRM). For Verimatrix DRM, the 'drm' section of the
       # config.lua file must be active and properly configured
       def drm_type(param = 'none')
-        "drmType=#{param} "
+        "drmType=#{param}"
       end
 
       # Specifies the number of keys that will be automatically generated and
       # rotated over while encrypting this HLS stream
       def aes_key_count(param = 5)
-        "AESKeyCount=#{param} "
+        "AESKeyCount=#{param}"
       end
 
       # Specifies if the resulting stream will be audio only. A value of 1(true)
       # will result in a stream without video
       def audio_only(param = 0)
-        "audioOnly=#{param} "
+        "audioOnly=#{param}"
       end
 
       # If true, HLS will resume in appending segments to previously created
       # childplaylist even in cases of EMS shutdown or cut off stream source
       def hls_resume(param = 0)
-        "hlsResume=#{param} "
+        "hlsResume=#{param}"
       end
 
       # If true, corresponding hls files to a stream will be deleted if the said
       # stream is removed or shut down or disconnected
       def cleanup_on_close(param = 0)
-        "cleanupOnClose=#{param} "
+        "cleanupOnClose=#{param}"
       end
 
       # If true, will use the EXT-X-BYTERANGE feature of HLS (version 4 and up)
       def use_byte_range(param = 0)
-        "useByteRange=#{param} "
+        "useByteRange=#{param}"
       end
 
       # When using useByteRange=1, this parameter needs to be set too. This will
@@ -85,23 +83,23 @@ module Evostream
       # chunkLength in case of EXT-X-BYTERANGE, since chunkLength will be the
       # byte range chunk
       def file_length(param = 0)
-        "fileLength=#{param} "
+        "fileLength=#{param}"
       end
 
       # If true, uses UTC in playlist time stamp otherwise will use the local
       # server time
       def use_system_time(param = 0)
-        "useSystemTime=#{param} "
+        "useSystemTime=#{param}"
       end
 
       def offset_time(param = 0)
-        "offsetTime=#{param} "
+        "offsetTime=#{param}"
       end
 
       # A parameter valid only for HLS v.6 onwards. This will indicate the start
       # offset time (in seconds) for the playback of the playlist
       def start_offset(param = 0)
-        "startOffset=#{param} "
+        "startOffset=#{param}"
       end
     end
   end

data/lib/evostream/event/commands/destroy.rb

@@ -10,7 +10,7 @@ module Evostream
       end
 
       def cmd
-        "removeConfig?params=#{Base64.urlsafe_encode64(command.join)}"
+        "removeConfig?params=#{encode_64}"
       end
 
       private
@@ -21,20 +21,20 @@ module Evostream
       # can be obtained from the listConfig interface. Removing an inbound
       # stream will also automatically remove all associated outbound streams.
       def id(param = 'null')
-        "id=#{param} "
+        "id=#{param}"
       end
 
       # The name of the group that needs to be removed (applicable to HLS, HDS
       # and external processes). *Mandatory only if the id parameter is not
       # specified.
       def group_name(param = 'null')
-        "groupName=#{param} "
+        "groupName=#{param}"
       end
 
       # If 1 (true) and the stream is HLS or HDS, the folder associated with it
       # will be removed
       def remove_hls_hds_files(param = 0)
-        "removeHlsHdsFiles=#{param} "
+        "removeHlsHdsFiles=#{param}"
       end
     end
 

data/lib/evostream/event/commands/get_stream_info.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Evostream
+  module Commands
+    # Returns a detailed set of information about a stream.
+    class GetStreamInfo < Command
+      def initialize(commands = {})
+        super(commands)
+      end
+
+      def cmd
+        "getStreamInfo?params=#{encode_64}"
+      end
+
+      private
+
+      # The uniqueId of the stream. Usually a value returned by listStreamsIDs.
+      # This parameter is not mandatory but either this or the localStreamName
+      # should be present to identify the particular stream
+      def id(param = 'null')
+        "id=#{param}"
+      end
+
+      # The name of the stream. This parameter is not mandatory but either this
+      # or the id should be present to identify the particular stream
+      def local_stream_name(param = '')
+        "localStreamName=#{param}"
+      end
+    end
+  end
+end

data/lib/evostream/event/commands/list_streams.rb

@@ -9,7 +9,7 @@ module Evostream
       end
 
       def cmd
-        "listStreams?params=#{Base64.encode64(command.join)}"
+        "listStreams?params=#{encode_64}"
       end
 
       private
@@ -19,7 +19,7 @@ module Evostream
       # If this is 1 (true), internal streams (origin-edge related)
       # are filtered out from the list
       def disable_internal_streams(param = 'true')
-        "disableInternalStreams=#{param} "
+        "disableInternalStreams=#{param}"
       end
     end
   end

data/lib/evostream/event/commands/push_stream.rb

@@ -11,11 +11,7 @@ module Evostream
       end
 
       def cmd
-        base = command.join
-        Evostream.logger "Parameters : #{base}"
-        string = Base64.strict_encode64(base)
-        Evostream.logger "Base 64 decoded : #{Base64.strict_decode64(string)}"
-        "pushStream?params=#{string}"
+        "pushStream?params=#{encode_64}"
       end
 
       private
@@ -25,19 +21,19 @@ module Evostream
       # TheURI of the external stream. Can be RTMP, RTSP or unicast/multicast
       # (d) mpegts
       def uri(param = 'null')
-        "uri=#{param} "
+        "uri=#{param}"
       end
 
       # If provided, the stream will be given this name. Otherwise, a fallback
       # techniqueis used to determine the stream name (based on the URI)
       def local_stream_name(param = '')
-        "localStreamName=#{param} "
+        "localStreamName=#{param}"
       end
 
       # The name of the stream at destination. If not provided, the target
       # stream name willbe the same as the local stream name
       def target_stream_name(param = 'null')
-        "targetStreamName=#{param} "
+        "targetStreamName=#{param}"
       end
     end
   end

data/lib/evostream/event/event.rb

@@ -23,6 +23,7 @@ module Evostream
     def execute_klass(klass)
       name_flux = extract_name_flux
       Evostream.logger "Name Flux : #{name_flux}"
+      Evostream.logger "Event : #{klass}"
       case [klass]
       when [Evostream::Events::OutStreamCreated]
         klass.new(name_flux, @payload).execute

data/lib/evostream/event/event/events/in_stream_closed.rb

@@ -12,6 +12,7 @@ module Evostream
       def execute
         super do |type_flux|
           klass = Evostream::Commands::Destroy.new(remove_config(type_flux))
+          Evostream.logger 'Send command to server EvoStream'
           @result = Evostream.send_command(klass.cmd)
           # yield if block_given?
         end

data/lib/evostream/event/event/events/in_stream_created.rb

@@ -8,6 +8,7 @@ module Evostream
         super do |type_flux|
           klass = "Evostream::Commands::Create#{type_flux.upcase}".constantize
           command = send(type_flux, type_flux)
+          Evostream.logger 'Send command to server EvoStream'
           @result = Evostream.send_command(klass.new(command).cmd)
         end
       end

data/lib/evostream/event/event/events/out_stream_created.rb

@@ -10,6 +10,7 @@ module Evostream
       end
 
       def execute
+        Evostream.logger "Update document (#{model.class}) in Database"
         stream_flux = what_flux.upcase.constantize
         model.streams.push(stream_flux.new(config_id: ex_config, flux: ex_flux))
         model.save

data/lib/evostream/event/info.rb

@@ -6,7 +6,7 @@
 # Define constant to gem.
 module Evostream
   # Define version to gem
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
   # Name to gem
   GEM_NAME = 'evostream-event'

data/lib/generators/evostream/initializer_generator.rb

@@ -6,16 +6,33 @@ module Evostream
     class InitializerGenerator < Rails::Generators::Base
       desc 'Generate a initializer for evostream-event gem.'
       INITIALIZER = <<-INIT
-# frozen_string_literal: true
+  # frozen_string_literal: true
 
-Evostream::Service.configuration do |config|
-  config.uri_in     = 'http://server_stream.local:80'
-  config.uri_out    = 'http://server_stream.local:7777'
-  config.name       = 'srteamming_'
-  config.web_root   = '/var/www/html'
-  config.model      = ModelUsedInDatabase
-  config.model_id   = :identifier_used_in_model
-end
+  Evostream::Service.configuration do |config|
+    # URL to EvoStream for share video to final user
+    config.uri_in       = 'http://server_stream.local:80'
+
+    # URL to EvoStream for sending request to this API
+    config.uri_out      = 'http://server_stream.local:7777'
+
+    # Prefix to folder created for each video mangaed by EvoStream
+    config.name         = 'srteamming_'
+
+    # Folder for file created by EvoStream
+    config.web_root     = '/var/www/html'
+
+    # Name to model manipulate
+    config.model        = ModelUsedInDatabase
+
+    # Choose id to document manipulate in Database
+    config.model_id     = :identifier_used_in_model
+
+    # Use environment for this gem. Choose between :
+    # - development   : Write in log and Send request to evoStream
+    # - test          : Write in Log
+    # - production    : Send request to EvoStream
+    config.environement = :test
+  end
       INIT
 
       # Create initializer in Rails project

data/spec/evostream/commands/get_stream_info_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Evostream::Commands::GetStreamInfo do
+  let(:command) { Evostream::Commands::GetStreamInfo.new(cmd) }
+
+  context 'id' do
+    let(:arg_value) { Faker::Number.between(1, 999) }
+    let(:argument) { 'id' }
+
+    include_examples 'command'
+  end
+
+  context 'local_stream_name' do
+    let(:arg_value) { Faker::Pokemon.name }
+    let(:argument) { 'local_stream_name' }
+
+    include_examples 'command'
+  end
+end

data/spec/evostream/commands/list_stream_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Evostream::Commands::ListStreams do
+  let(:command) { Evostream::Commands::ListStreams.new(cmd) }
+
+  context 'disable_internal_streams' do
+    let(:arg_value) { Faker::Boolean.boolean }
+    let(:argument) { 'disable_internal_streams' }
+
+    include_examples 'command'
+  end
+end

data/spec/support/examples_commands.rb

@@ -6,5 +6,7 @@ RSpec.shared_examples 'command' do
   let(:cmd) { { argument => arg_value } }
   let(:result) { "#{argument.camelize(:lower)}=#{arg_value} " }
 
-  it { expect(command.instance_variable_get(:@command)[0]).to eql(result) }
+  it do
+    expect(command.instance_variable_get(:@command)[0] + ' ').to eql(result)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evostream-event
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1.pre.52
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-16 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -269,6 +269,7 @@ files:
 - lib/evostream/event/commands/create/dash.rb
 - lib/evostream/event/commands/create/hls.rb
 - lib/evostream/event/commands/destroy.rb
+- lib/evostream/event/commands/get_stream_info.rb
 - lib/evostream/event/commands/list_config.rb
 - lib/evostream/event/commands/list_streams.rb
 - lib/evostream/event/commands/push_stream.rb
@@ -287,6 +288,8 @@ files:
 - spec/evostream/commands/create_hls_spec.rb
 - spec/evostream/commands/create_spec.rb
 - spec/evostream/commands/destroy_spec.rb
+- spec/evostream/commands/get_stream_info_spec.rb
+- spec/evostream/commands/list_stream_spec.rb
 - spec/evostream/commands/push_stream_spec.rb
 - spec/evostream/event/event_spec.rb
 - spec/evostream/events/events_spec.rb
@@ -339,9 +342,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5