bigbluebutton-api-ruby 0.0.11 → 0.1.0.rc1

data/spec/bigbluebutton_modules_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe BigBlueButton::BigBlueButtonModules do
+  let(:modules) { BigBlueButton::BigBlueButtonModules.new }
+
+  describe "#presentation_urls" do
+    subject { modules }
+    it { should respond_to(:presentation_urls) }
+    it { should respond_to("presentation_urls=") }
+  end
+
+  describe "#presentation_files" do
+    subject { modules }
+    it { should respond_to(:presentation_files) }
+    it { should respond_to("presentation_files=") }
+  end
+
+  describe "#presentation_base64s" do
+    subject { modules }
+    it { should respond_to(:presentation_base64s) }
+    it { should respond_to("presentation_base64s=") }
+  end
+
+  describe "#add_presentation" do
+    context "when type = :url" do
+      before {
+        modules.add_presentation(:url, "http://anything")
+        modules.add_presentation(:url, "http://anything2")
+      }
+      it { modules.presentation_urls.size.should == 2 }
+      it { modules.presentation_urls.first.should == "http://anything" }
+      it { modules.presentation_urls.last.should == "http://anything2" }
+    end
+
+    context "when type = :file" do
+      before {
+        modules.add_presentation(:file, "myfile.ppt")
+        modules.add_presentation(:file, "myfile2.ppt")
+      }
+      it { modules.presentation_files.size.should == 2 }
+      it { modules.presentation_files.first.should == "myfile.ppt" }
+      it { modules.presentation_files.last.should == "myfile2.ppt" }
+    end
+
+    context "when type = :base64" do
+      before {
+        modules.add_presentation(:base64, "1234567890", "file1.pdf")
+        modules.add_presentation(:base64, "0987654321", "file2.pdf")
+      }
+      it { modules.presentation_base64s.size.should == 2 }
+      it { modules.presentation_base64s.first.should == ["file1.pdf", "1234567890"] }
+      it { modules.presentation_base64s.last.should == ["file2.pdf", "0987654321"] }
+    end
+  end
+
+  describe "#to_xml" do
+    context "when nothing was added" do
+      it { modules.to_xml.should == "" }
+    end
+
+    context "with presentations" do
+      let(:file) {
+        f = Tempfile.new(['file1', '.pdf'])
+        f.write("First\nSecond")
+        f.close
+        f
+      }
+      let(:file_encoded) {
+        File.open(file.path, "r") do |f|
+          Base64.encode64(f.read)
+        end
+      }
+      let(:xml) {
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" +
+        "<modules>" +
+          "<module name=\"presentation\">" +
+            "<document url=\"http://anything\" />" +
+            "<document url=\"http://anything2\" />" +
+            "<document name=\"file1.pdf\">1234567890</document>" +
+            "<document name=\"#{File.basename(file.path)}\">#{file_encoded}</document>" +
+          "</module>" +
+        "</modules>"
+      }
+      before {
+        modules.add_presentation(:url, "http://anything")
+        modules.add_presentation(:url, "http://anything2")
+        modules.add_presentation(:base64, "1234567890", "file1.pdf")
+        modules.add_presentation(:file, file.path)
+      }
+      it { modules.to_xml.should == xml }
+    end
+  end
+
+end

data/spec/data/hash_to_xml_complex.xml

@@ -0,0 +1,45 @@
+<response>
+  <returncode>SUCCESS</returncode>
+  <recordings>
+    <recording>
+      <recordID>7f5745a08b24fa27551e7a065849dda3ce65dd32-1321618219268</recordID>
+      <meetingID>bd1811beecd20f24314819a52ec202bf446ab94b</meetingID>
+      <name><![CDATA[Evening Class1]]></name>
+      <published>true</published>
+      <startTime>Fri Nov 18 12:10:23 UTC 2011</startTime>
+      <endTime>Fri Nov 18 12:12:25 UTC 2011</endTime>
+      <metadata>
+        <course><![CDATA[Fundamentals Of JAVA]]></course>
+        <description><![CDATA[List of recordings]]></description>
+        <activity><![CDATA[Evening Class1]]></activity>
+      </metadata>
+      <playback>
+        <format>
+          <type>slides</type>
+          <url>http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=7f5745</url>
+          <length>3</length>
+        </format>
+      </playback>
+    </recording>
+    <recording>
+      <recordID>6c1d35b82e2552bb254d239540e4f994c4a77367-1316717270941</recordID>
+      <meetingID>585a44eb32b526b100e12b7b755d971fbbd19ab0</meetingID>
+      <name><![CDATA[Test de fonctionnalit&#xe9;]]></name>
+      <published>false</published>
+      <startTime>2011-09-22 18:47:55 UTC</startTime>
+      <endTime>2011-09-22 19:08:35 UTC</endTime>
+      <metadata>
+        <course><![CDATA[Ressources technologiques]]></course>
+        <activity><![CDATA[Test de fonctionnalit&#xe9;]]></activity>
+        <recording><![CDATA[true]]></recording>
+      </metadata>
+      <playback>
+        <format>
+          <type>slides</type>
+          <url>http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=6c1d35</url>
+          <length>0</length>
+        </format>
+      </playback>
+    </recording>
+  </recordings>
+</response>

data/spec/hash_to_xml_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe Hash do
+
+  describe ".from_xml" do
+    it "simple example" do
+      xml = "<response><returncode>1</returncode></response>"
+      hash = { :returncode => "1" }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "maintains all values as strings" do
+      xml = "<parent>" \
+            "  <node1>1</node1>" \
+            "  <node2>string</node2>" \
+            "  <node3>true</node3>" \
+            "</parent>"
+      hash = { :node1 => "1", :node2 => "string", :node3 => "true" }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "works for xmls with multiple levels" do
+      xml = "<parent>" \
+            "  <node1>" \
+            "    <node2>" \
+            "      <node3>true</node3>" \
+            "    </node2>" \
+            "  </node1>" \
+            "</parent>"
+      hash = { :node1 => { :node2 => { :node3 => "true" } } }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "transforms CDATA fields to string" do
+      xml = "<parent>" \
+            "  <name><![CDATA[Evening Class]]></name>" \
+            "  <course><![CDATA[Advanced Ruby]]></course>" \
+            "</parent>"
+      hash = { :name => "Evening Class", :course => "Advanced Ruby" }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "transforms duplicated keys in arrays" do
+      xml = "<parent>" \
+            "  <meetings>" \
+            "    <meeting>1</meeting>" \
+            "    <meeting>2</meeting>" \
+            "    <meeting><details>3</details></meeting>" \
+            "    <other>4</other>" \
+            "  </meetings>" \
+            "</parent>"
+      hash = { :meetings => { :meeting => [ "1", "2", { :details => "3" } ],
+                              :other => "4" } }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "works with attributes" do
+      xml = "<parent>" \
+            "  <meeting attr1=\"v1\">1</meeting>" \
+            "</parent>"
+      hash = { :meeting => { :attr1 => "v1", :content => "1" } }
+      Hash.from_xml(xml).should == hash
+    end
+
+    it "complex real example" do
+      xml = File.open("spec/data/hash_to_xml_complex.xml")
+
+      hash = { :returncode => "SUCCESS",
+               :recordings =>
+                 { :recording => [
+                   { :recordID => "7f5745a08b24fa27551e7a065849dda3ce65dd32-1321618219268",
+                     :meetingID => "bd1811beecd20f24314819a52ec202bf446ab94b",
+                     :name => "Evening Class1",
+                     :published => "true",
+                     :startTime => "Fri Nov 18 12:10:23 UTC 2011",
+                     :endTime => "Fri Nov 18 12:12:25 UTC 2011",
+                     :metadata =>
+                       { :course => "Fundamentals Of JAVA",
+                         :description => "List of recordings",
+                         :activity => "Evening Class1" },
+                     :playback =>
+                       { :format =>
+                         { :type => "slides",
+                           :url => "http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=7f5745",
+                           :length => "3" }
+                       }
+                   },
+                   { :recordID => "6c1d35b82e2552bb254d239540e4f994c4a77367-1316717270941",
+                     :meetingID => "585a44eb32b526b100e12b7b755d971fbbd19ab0",
+                     :name => "Test de fonctionnalit&#xe9;",
+                     :published => "false",
+                     :startTime => "2011-09-22 18:47:55 UTC",
+                     :endTime => "2011-09-22 19:08:35 UTC",
+                     :metadata =>
+                       { :course => "Ressources technologiques",
+                         :activity => "Test de fonctionnalit&#xe9;",
+                         :recording => "true" },
+                     :playback =>
+                       { :format =>
+                         { :type => "slides",
+                           :url =>  "http://test-install.blindsidenetworks.com/playback/slides/playback.html?meetingId=6c1d35",
+                           :length => "0" }
+                       }
+                   } ]
+                 }
+      }
+      Hash.from_xml(xml).should == hash
+    end
+  end
+
+  describe ".symbolize_keys" do
+    it "converts string-keys to symbols" do
+      before = { "one" => 1, "two" => 2, "three" => 3 }
+      after = { :one => 1, :two => 2, :three => 3 }
+      Hash.symbolize_keys(before).should == after
+    end
+
+    it "maintains case" do
+      before = { "One" => 1, "tWo" => 2, "thrEE" => 3 }
+      after = { :One => 1, :tWo => 2, :thrEE => 3 }
+      Hash.symbolize_keys(before).should == after
+    end
+
+    it "works with multilevel hashes" do
+      before = { "l1" => { "l2" => { "l3" => 1 } }, "l1b" => 2 }
+      after = { :l1 => { :l2 => { :l3 => 1 } }, :l1b => 2 }
+      Hash.symbolize_keys(before).should == after
+    end
+
+    it "works with arrays" do
+      before = { "a1" => [ "b1" => 1,  "b2" => 2 ], "b2" => 2 }
+      after = { :a1 => [ :b1 => 1,  :b2 => 2 ], :b2 => 2 }
+      Hash.symbolize_keys(before).should == after
+    end
+
+    it "doesn't convert values" do
+      before = { "a" => "a", "b" => "b" }
+      after = { :a => "a", :b => "b" }
+      Hash.symbolize_keys(before).should == after
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
+require 'forgery'
+
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 # Load Factories
 #require 'factory_girl'
-#require 'forgery'
-#Dir["#{ File.dirname(__FILE__)}/factories/*.rb"].each { |f| require f }
+# Dir["#{ File.dirname(__FILE__)}/factories/*.rb"].each { |f| require f }
+
 
 RSpec.configure do |config|
   config.mock_with :rspec

data/spec/support/forgery/forgeries/random_name.rb

@@ -0,0 +1,7 @@
+require 'securerandom'
+
+class Forgery::Basic < Forgery
+  def self.random_name(base)
+    base + "-" + SecureRandom.hex(4)
+  end
+end

data/spec/support/forgery/forgeries/url.rb

@@ -0,0 +1,5 @@
+class Forgery::Internet < Forgery
+  def self.url
+    "http://" + domain_name + top_level_domain + cctld + "/"
+  end
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.11
-  prerelease: 
+  version: 0.1.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Leonardo Crauss Daronco
@@ -10,19 +10,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-02 00:00:00.000000000Z
+date: 2011-11-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: &20159120 !ruby/object:Gem::Requirement
+  name: xml-simple
+  requirement: &84100630 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *20159120
+  version_requirements: *84100630
 description: Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)
 email:
 - leonardodaronco@gmail.com
@@ -32,28 +32,60 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 - LICENSE
+- LICENSE_003
 - CHANGELOG.rdoc
 files:
 - .gitignore
 - .rspec
 - .rvmrc
+- .travis.yml
 - CHANGELOG.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- LICENSE_003
 - README.rdoc
 - Rakefile
 - bigbluebutton-api-ruby.gemspec
+- examples/get_version_example.rb
+- examples/join_example.rb
+- examples/overall_0.7_example.rb
+- examples/prepare.rb
+- extras/bigbluebutton_bot.rb
+- extras/download_bot_from.txt
+- extras/test-presentation.pdf
+- features/check_status.feature
+- features/config.yml.example
+- features/create_meetings.feature
+- features/end_meetings.feature
+- features/join_meetings.feature
+- features/pre_upload_slides.feature
+- features/recordings.feature
+- features/step_definitions/check_status_steps.rb
+- features/step_definitions/common_steps.rb
+- features/step_definitions/create_meetings_steps.rb
+- features/step_definitions/end_meetings_steps.rb
+- features/step_definitions/join_meetings_steps.rb
+- features/step_definitions/pre_upload_slides_steps.rb
+- features/step_definitions/recordings_steps.rb
+- features/support/api_tests/configs.rb
+- features/support/env.rb
+- features/support/hooks.rb
 - lib/bigbluebutton_api.rb
 - lib/bigbluebutton_exception.rb
 - lib/bigbluebutton_formatter.rb
+- lib/bigbluebutton_modules.rb
 - lib/hash_to_xml.rb
+- spec/bigbluebutton_api_0.8_spec.rb
 - spec/bigbluebutton_api_spec.rb
 - spec/bigbluebutton_exception_spec.rb
 - spec/bigbluebutton_formatter_spec.rb
+- spec/bigbluebutton_modules_spec.rb
+- spec/data/hash_to_xml_complex.xml
+- spec/hash_to_xml_spec.rb
 - spec/spec_helper.rb
-- test/config.yml.example
-- test/test.rb
+- spec/support/forgery/forgeries/random_name.rb
+- spec/support/forgery/forgeries/url.rb
 homepage: https://github.com/mconf/bigbluebutton-api-ruby/
 licenses: []
 post_install_message: 
@@ -66,12 +98,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 999658801
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10

data/test/config.yml.example

@@ -1,9 +0,0 @@
-bbb_salt: 'insert-a-valid-salt-here'
-bbb_url: 'http://devbuild.bigbluebutton.org/bigbluebutton/api'
-bbb_version: '0.7'
-meeting_id: 'bigbluebutton-api-ruby-test'
-meeting_name: 'Test Meeting For Ruby Gem'
-moderator_name: 'House'
-moderator_password: '4321'
-attendee_name: 'Cameron'
-attendee_password: '1234'

data/test/test.rb

@@ -1,154 +0,0 @@
-$:.unshift File.expand_path(File.dirname(__FILE__))
-$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib')
-
-require 'bigbluebutton-api'
-require 'thread'
-require 'yaml'
-
-def prepare
-
-  config_file = File.join(File.dirname(__FILE__), 'config.yml')
-  unless File.exist? config_file
-    puts config_file + " does not exists. Copy the example and configure your server."
-    puts "cp test/config.yml.example test/config.yml"
-    puts
-    Kernel.exit!
-  end
-  @config = YAML.load_file(config_file)
-
-  puts "config:"
-  @config.each do |k,v|
-    puts k + ": " + v
-  end
-
-  @api = BigBlueButton::BigBlueButtonApi.new(@config['bbb_url'], @config['bbb_salt'], @config['bbb_version'].to_s, true)
-
-end
-
-def general_test
-
-  puts
-  puts "---------------------------------------------------"
-  if @api.test_connection
-    puts "Connection successful! continuing..."
-  else
-    puts "Connection failed! The server might be unreachable. Exiting..."
-    Kernel.exit!
-  end
-
-  puts
-  puts "---------------------------------------------------"
-  version = @api.get_api_version
-  puts "The API version of your server is #{version}"
-
-  puts
-  puts "---------------------------------------------------"
-  response = @api.get_meetings
-  puts "Existent meetings in your server:"
-  response[:meetings].each do |m|
-    puts "  " + m[:meetingID] + ": " + m.inspect
-  end
-
-  puts
-  puts "---------------------------------------------------"
-  @api.create_meeting(@config['meeting_name'], @config['meeting_id'], @config['moderator_password'], @config['attendee_password'],
-                     'Welcome to my meeting', '1-800-000-0000x00000#', 'https://github.com/mconf/bigbluebutton-api-ruby', 10)
-  puts "The meeting has been created. Please open a web browser and enter the meeting using either of the URLs below."
-
-  puts
-  puts "---------------------------------------------------"
-  url = @api.join_meeting_url(@config['meeting_id'], @config['moderator_name'], @config['moderator_password'])
-  puts "1) Moderator URL = #{url}"
-  puts ""
-  url = @api.join_meeting_url(@config['meeting_id'], @config['attendee_name'], @config['attendee_password'])
-  puts "2) Attendee URL = #{url}"
-
-  puts
-  puts "---------------------------------------------------"
-  puts "Waiting 30 seconds for you to enter via browser"
-  sleep(30)
-
-  unless @api.is_meeting_running?(@config['meeting_id'])
-    puts "You have NOT entered the meeting"
-    Kernel.exit!
-  end
-  puts "You have successfully entered the meeting"
-
-  puts
-  puts "---------------------------------------------------"
-  response = @api.get_meeting_info(@config['meeting_id'], @config['moderator_password'])
-  puts "Meeting info:"
-  puts response.inspect
-
-  puts
-  puts "---------------------------------------------------"
-  puts "Attendees:"
-  response[:attendees].each do |m|
-    puts "  " + m[:fullName] + " (" +  m[:userID] + "): " + m.inspect
-  end
-
-
-  puts
-  puts "---------------------------------------------------"
-  @api.end_meeting(@config['meeting_id'], @config['moderator_password'])
-  puts "The meeting has been ended"
-
-rescue Exception => ex
-  puts "Failed with error #{ex.message}"
-  puts ex.backtrace
-
-end
-
-def join_test
-  unless @api.is_meeting_running?(@config['meeting_id'])
-    @api.create_meeting(@config['meeting_name'], @config['meeting_id'], @config['moderator_password'], @config['attendee_password'],
-                       'Welcome to my meeting', '1-800-000-0000x00000#', 'https://github.com/mconf/bigbluebutton-api-ruby', 10)
-    puts "The meeting has been created. Please open a web browser and enter the meeting as moderator."
-
-    puts
-    puts "---------------------------------------------------"
-    url = @api.join_meeting_url(@config['meeting_id'], @config['moderator_name'], @config['moderator_password'])
-    puts "1) Moderator URL = #{url}"
-
-    puts
-    puts "---------------------------------------------------"
-    puts "Waiting 30 seconds for you to enter via browser"
-    sleep(30)
-  end
-
-  unless @api.is_meeting_running?(@config['meeting_id'])
-    puts "You have NOT entered the meeting"
-    Kernel.exit!
-  end
-  puts "You have successfully entered the meeting"
-
-  puts
-  puts "---------------------------------------------------"
-  response = @api.get_meeting_info(@config['meeting_id'], @config['moderator_password'])
-  puts "Meeting info:"
-  puts response.inspect
-
-  puts
-  puts
-  puts
-  puts "---------------------------------------------------"
-  response = @api.join_meeting(@config['meeting_id'], @config['attendee_name'], @config['attendee_password'])
-  puts "Join meeting response:"
-  puts response.inspect
-
-end
-
-def get_version_test
-  @api = BigBlueButton::BigBlueButtonApi.new(@config['bbb_url'], @config['bbb_salt'], nil, true)
-
-  puts
-  puts "---------------------------------------------------"
-  puts "The version of your BBB server is: #{@api.version}"
-end
-
-begin
-  prepare
-  general_test
-  #join_test
-  #get_version_test
-end