kaltura_box 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef074ebbbc9f5d418b83bceaf45f25e5ce4668d1
-  data.tar.gz: 1eb48ebcb0461976d12e1949c35c765e60608cba
+  metadata.gz: d44f8e7050f6616d5a0c25d0f7034d7202626d62
+  data.tar.gz: e59fe2243068728b9834fae5039dede567b0eebc
 SHA512:
-  metadata.gz: f585e2fd7efcdcc2d0497d31d68706e7742591e900c0ac9e927ce2970e20bcd53cb23fc40668a4ccda4202094b573650a10843314653e92b785df7b6d164fc04
-  data.tar.gz: 73b163b702644eea8a8dc66ae3dfefc7ff442cc56d76539e76dc2ed7453687411d61e2769cba8e3e2124a04f434a28553116131c8ffd0276f062a42ab3a42e79
+  metadata.gz: a117d402b73e95d5f80f2fa8b4fb3027c05adea7398d3f776ad9103a47f12d6799e93b9aec67eafd2fd3bc15e4f1ad90760986c52596463eb04f11db325ba4ec
+  data.tar.gz: 91103a76ea91a232a8dff5ddfa1add70b789f28f0c9b4ced07b4ba077d918898b76e876094537cc78d04e431ca14f816d3149784018797f1c90b47f7c1b89555

data/README.md

@@ -20,36 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-    # For the Entry class
-    class Video < ActiveRecord::Base
-      include KalturaBox::Entry
-    end
-
-    # Category class
-    class Category < ActiveRecord::Base
-      include KalturaBox::Category
-    end
-
-    # Entry listing from Kaltura
-    Video.video_list
-
-    # Create videos based on Kaltura entries
-    Video.update_all_videos!
-
-    # Retrieve a kaltura entry
-    video = Video.new(entry_id: "0_7ivwzhbh")
-    video.get
-
-    # Tagging
-    video.set_tags = "noodles, food, yummy" # Create a new set of tags
-    video.add_tags = "rice, fruits" # Add more tags to the existing tag list
-    video.add_tag("bacon") # Add a single tag
-    video.get_tags # Retrieve tags
-
-    # Kaltura Metadata
-    video.set(name: "bla", description: "blablabla")
-    video.set_name = "bla"
-    video.set_description = "blablabla"
+```ruby
+# For the Entry class
+class Video < ActiveRecord::Base
+  include KalturaBox::Entry
+end
+
+# Category class
+class Category < ActiveRecord::Base
+  include KalturaBox::Category
+end
+
+# Entry listing from Kaltura
+Video.video_list
+
+# Search
+Video.video_list("search string here")
+
+# Create videos based on Kaltura entries
+Video.update_all_videos!
+
+# Retrieve a kaltura entry
+video = Video.new(entry_id: "0_7ivwzhbh")
+video.get
+
+# Tagging
+video.set_tags = "noodles, food, yummy" # Create a new set of tags
+video.add_tags = "rice, fruits" # Add more tags to the existing tag list
+video.add_tag("bacon") # Add a single tag
+video.get_tags # Retrieve tags
+
+# Kaltura Metadata
+video.set(name: "bla", description: "blablabla")
+video.set_name = "bla"
+video.set_description = "blablabla"
+```
 
 ## Contributing
 

data/lib/kaltura_box/entry/class_methods.rb

@@ -22,10 +22,20 @@ module KalturaBox
         end
       end
 
-      def video_list
+      def video_list(keyword = nil)
         client = KalturaBox::Client.update_session
         media = Kaltura::KalturaMediaService.new(client)
-        media_list = media.list
+
+        if keyword
+          filter = Kaltura::KalturaBaseEntryFilter.new
+          filter.free_text = keyword
+          media_list = media.list(filter)
+        else
+          media_list = media.list
+        end
+
+        return nil unless media_list.objects
+
         media_list.objects.reject { |v| v.media_type != 1  }
       end
 

data/lib/kaltura_box/version.rb

@@ -1,3 +1,3 @@
 module KalturaBox
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/kaltura_box/view_helpers.rb

@@ -0,0 +1,183 @@
+module KalturaBox
+
+  ##
+  # The ViewHelpers module provides extensions to Rails ActionView class that allow interactions with Kaltura on rails view layer.
+  #
+  # @author Patrick Robertson
+  ##
+  module ViewHelpers
+    # default UI Conf ID of the kdp player
+    DEFAULT_KPLAYER = '1339442'
+    # default embedded KDP width
+    PLAYER_WIDTH = '400'
+    # default embedded KDP height
+    PLAYER_HEIGHT = '330'
+
+    ##
+    # Convienence to include SWFObject and the required Kaltura upload embed javascripts.
+    ##
+    def include_kaltura_fu(*args)
+      content = javascript_include_tag('kaltura_upload')
+      content << javascript_include_tag('//ajax.googleapis.com/ajax/libs/swfobject/2.2/swfobject.js')
+    end
+
+    ##
+    # Returns the thumbnail of the provided Kaltura Entry.
+    # @param [String] entry_id Kaltura entry_id
+    # @param [Hash] options the options for the thumbnail parameters.
+    # @option options [Array] :size ([]) an array of [width,height]
+    # @option options [String] :second (nil) the second of the Kaltura entry that the thumbnail should be of.
+    #
+    # @return [String] Image tag of the thumbnail resource.
+    ##
+    def kaltura_thumbnail(entry_id,options={})
+      options[:size] ||= []
+      size_parameters = ""
+      seconds_parameter = ""
+
+      unless options[:size].empty?
+        size_parameters = "/width/#{options[:size].first}/height/" +
+        "#{options[:size].last}"
+      else
+        # if the thumbnail width and height are defined in the config,
+        # use it, assuming it wasn't locally overriden
+        if KalturaBox.config.thumb_width && KalturaBox.config.thumb_height
+          size_parameters = "/width/#{KalturaBox.config.thumb_width}/height/" +
+          "#{KalturaBox.config.thumb_height}"
+        end
+      end
+
+      unless options[:second].nil?
+        seconds_parameter = "/vid_sec/#{options[:second]}"
+      else
+        seconds_parameter = "/vid_sec/5"
+      end
+
+      image_tag("#{KalturaBox.config.service_url}/p/#{KalturaBox.config.partner_id}" +
+    "/thumbnail/entry_id/#{entry_id}" +
+    seconds_parameter +
+    size_parameters)
+    end
+
+    ##
+    # Returns the code needed to embed a KDPv3 player.
+    #
+    # @param [String] entry_id Kaltura entry_id
+    # @param [Hash] options the embed code options.
+    # @option options [String] :div_id ('kplayer') The div element that the flash object will be inserted into.
+    # @option options [Array] :size ([]) The [width,wight] of the player.
+    # @option options [Boolean] :use_url (false) flag to determine whether entry_id is an entry or a URL of a flash file.
+    # @option options [String] :player_conf_id (KalturaBox.config(:player_conf_id)) A UI Conf ID to override the player with.
+    #
+    # @return [String] returns a string representation of the html/javascript necessary to play a Kaltura entry.
+    ##
+    def kaltura_player_embed(entry_id,options={})
+      player_conf_parameter = "/uiconf_id/"
+      options[:div_id] ||= "kplayer"
+      options[:size] ||= []
+      options[:use_url] ||= false
+      width = PLAYER_WIDTH
+      height = PLAYER_HEIGHT
+      source_type = "entryId"
+
+      unless options[:size].empty?
+        width = options[:size].first
+        height = options[:size].last
+      end
+
+      if options[:use_url] == true
+        source_type = "url"
+      end
+
+      unless options[:player_conf_id].nil?
+        player_conf_parameter += "#{options[:player_conf_id]}"
+      else
+        unless KalturaBox.config.player_conf_id.nil?
+          player_conf_parameter += "#{KalturaBox.config.player_conf_id}"
+        else
+          player_conf_parameter += "#{DEFAULT_KPLAYER}"
+        end
+      end
+
+      "<div id=\"#{options[:div_id]}\"></div>
+      <script type=\"text/javascript\">
+        var params= {
+          allowscriptaccess: \"always\",
+          allownetworking: \"all\",
+          allowfullscreen: \"true\",
+          wmode: \"opaque\",
+          bgcolor: \"#000000\"
+        };
+        var flashVars = {};
+        flashVars.sourceType = \"#{source_type}\";
+        flashVars.entryId = \"#{entry_id}\";
+        flashVars.emptyF = \"onKdpEmpty\";
+        flashVars.readyF = \"onKdpReady\";
+
+        var attributes = {
+          id: \"#{options[:div_id]}\",
+          name: \"#{options[:div_id]}\"
+        };
+
+        swfobject.embedSWF(\"#{KalturaBox.config.service_url}/kwidget/wid/_#{KalturaBox.config.partner_id}" + player_conf_parameter + "\",\"#{options[:div_id]}\",\"#{width}\",\"#{height}\",\"10.0.0\",\"http://ttv.mit.edu/swfs/expressinstall.swf\",flashVars,params,attributes);
+      </script>".html_safe
+    end
+
+    ##
+    # Returns the html/javascript necessary for a KSU widget.
+    #
+    # @param [Hash] options
+    # @option options [String] :div_id ('uploader') div that the flash object will be inserted into.
+    ##
+    def kaltura_upload_embed(options={})
+      client = KalturaBox::Client.update_session
+      options[:div_id] ||="uploader"
+      "<div id=\"#{options[:div_id]}\"></div>
+        <script type=\"text/javascript\">
+
+        var params = {
+          allowScriptAccess: \"always\",
+          allowNetworking: \"all\",
+          wmode: \"transparent\"
+        };
+        var attributes = {
+          id: \"uploader\",
+          name: \"KUpload\"
+        };
+        var flashVars = {
+          uid: \"ANONYMOUS\",
+          partnerId: \"#{KalturaBox.config.partner_id}\",
+          subPId: \"#{KalturaBox.config.partner_id}00\",
+          entryId: \"-1\",
+          ks: \"#{client.session_key}\",
+          uiConfId: '4211621',
+          jsDelegate: \"delegate\",
+          maxFileSize: \"999999999\",
+          maxTotalSize: \"999999999\"
+        };
+
+        swfobject.embedSWF(\"#{KalturaBox.config.service_url}/kupload/ui_conf_id/4211621\", \"uploader\", \"160\", \"26\", \"9.0.0\", \"expressInstall.swf\", flashVars, params,attributes);
+
+      </script>".html_safe
+    end
+
+    ##
+    # Creates a link_to tag that seeks to a certain time on a KDPv3 player.
+    #
+    # @param [String] content The text in the link tag.
+    # @param [Integer] seek_time The time in seconds to seek the player to.
+    # @param [Hash] options
+    #
+    # @option options [String] :div_id ('kplayer') The div of the KDP player.
+    ##
+    def kaltura_seek_link(content,seek_time,options={})
+      options[:div_id] ||= "kplayer"
+
+      options[:onclick] = "$(#{options[:div_id]}).get(0).sendNotification('doSeek',#{seek_time});window.scrollTo(0,0);return false;"
+      options.delete(:div_id)
+      link_to(content,"#", options)
+    end
+  end
+
+
+end

data/spec/entry_spec.rb

@@ -15,6 +15,23 @@ describe "KalturaBox::Entry" do
 
     context "video_list" do
       it { expect(videos.class).to eq Array }
+
+      describe "searching" do
+
+        context "valid search" do
+          it "returns an array" do
+            expect(Video.video_list("education").class).to eq Array
+          end
+        end
+
+        context "invalid search" do
+          it "returns nil" do
+            expect(Video.video_list("blabla")).to be_nil
+          end
+        end
+
+      end
+
     end
 
     context "update all videos" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaltura_box
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shinn Chong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kaltura-ruby-client
@@ -124,6 +124,7 @@ files:
 - lib/kaltura_box/entry/metadata/class_and_instance_methods.rb
 - lib/kaltura_box/entry/metadata/class_methods.rb
 - lib/kaltura_box/version.rb
+- lib/kaltura_box/view_helpers.rb
 - spec/api_spec.rb
 - spec/category_spec.rb
 - spec/entry_spec.rb