bigbluebutton-api-ruby 1.1.0 → 1.1.1

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+=== 1.1.1
+
+* BigBlueButtonApi can now receive http headers to be sent in all get/post requests
+
 === 1.1.0
 
 * Updated ruby to 1.9.3-194.

data/Gemfile.lock

@@ -1,13 +1,13 @@
 GIT
   remote: git://github.com/mconf/bbbot-ruby.git
-  revision: 83f3ccf88aa355260a791eb450a8d73f94049053
+  revision: 6b47fe212ea49a3120e9ee787cedd6097c9c81bd
   specs:
     bbbot-ruby (0.0.1)
 
 PATH
   remote: .
   specs:
-    bigbluebutton-api-ruby (1.1.0)
+    bigbluebutton-api-ruby (1.1.1)
       xml-simple (>= 1.1.1)
 
 GEM

data/bigbluebutton-api-ruby.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = 'bigbluebutton-api-ruby'
-  s.version = '1.1.0'
+  s.version = '1.1.1'
   s.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'LICENSE_003', 'CHANGELOG.rdoc']
   s.summary = 'Provides an interface to the BigBlueButton web meeting API (https://github.com/mconf/bigbluebutton-api-ruby)'
   s.description = s.summary

data/lib/bigbluebutton_api.rb

@@ -35,18 +35,39 @@ module BigBlueButton
   #
   class BigBlueButtonApi
 
-    attr_accessor :url, :supported_versions, :salt, :version, :debug, :timeout
+    # URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
+    attr_accessor :url
+
+    # Secret salt for this server
+    attr_accessor :salt
+
+    # API version e.g. 0.7 (valid for 0.7, 0.71 and 0.71a)
+    attr_accessor :version
+
+    # Flag to turn on/off debug mode
+    attr_accessor :debug
+
+    # Maximum wait time for HTTP requests (secs)
+    attr_accessor :timeout
+
+    # HTTP headers to be sent in all GET/POST requests
+    attr_accessor :request_headers
+
+    # Array with the version of BigBlueButton supported
+    # TODO: do we really need an accessor? shouldn't be internal?
+    attr_accessor :supported_versions
 
     # Initializes an instance
     # url::       URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
     # salt::      Secret salt for this server
-    # version::   API version: 0.7 (valid for 0.7, 0.71 and 0.71a)
+    # version::   API version e.g. 0.7 (valid for 0.7, 0.71 and 0.71a)
     def initialize(url, salt, version='0.7', debug=false)
       @supported_versions = ['0.7', '0.8']
       @url = url
       @salt = salt
       @debug = debug
-      @timeout = 10 # default timeout for api requests
+      @timeout = 10         # default timeout for api requests
+      @request_headers = {} # http headers sent in all requests
 
       @version = version || get_api_version
       unless @supported_versions.include?(@version)
@@ -532,19 +553,19 @@ module BigBlueButton
         http.open_timeout = @timeout
         http.read_timeout = @timeout
         if data.nil?
-          response = http.get(url_parsed.request_uri)
+          response = http.get(url_parsed.request_uri, @request_headers)
         else
           puts "BigBlueButtonAPI: Sending as a POST request with data.size = #{data.size}" if @debug
-          opts = { 'Content-Type' => 'text/xml' }
+          opts = { 'Content-Type' => 'text/xml' }.merge @request_headers
           response = http.post(url_parsed.request_uri, data, opts)
         end
         puts "BigBlueButtonAPI: URL response = #{response.body}" if @debug
 
       rescue TimeoutError => error
-        raise BigBlueButtonException.new("Timeout error. Your server is probably down: \"#{@url}\"")
+        raise BigBlueButtonException.new("Timeout error. Your server is probably down: \"#{@url}\". Error: #{error}")
 
       rescue Exception => error
-        raise BigBlueButtonException.new("Connection error. Your URL is probably incorrect: \"#{@url}\"")
+        raise BigBlueButtonException.new("Connection error. Your URL is probably incorrect: \"#{@url}\". Error: #{error}")
       end
 
       response

data/spec/bigbluebutton_api_spec.rb

@@ -13,13 +13,14 @@ describe BigBlueButton::BigBlueButtonApi do
   describe "#initialize" do
     context "standard initialization" do
       subject { BigBlueButton::BigBlueButtonApi.new(url, salt, version, debug) }
-      it { subject.url.should be(url) }
-      it { subject.salt.should be(salt) }
-      it { subject.version.should be(version) }
-      it { subject.debug.should be(debug) }
-      it { subject.timeout.should be(10) }
+      it { subject.url.should == url }
+      it { subject.salt.should == salt }
+      it { subject.version.should == version }
+      it { subject.debug.should == debug }
+      it { subject.timeout.should == 10 }
       it { subject.supported_versions.should include("0.7") }
       it { subject.supported_versions.should include("0.8") }
+      it { subject.request_headers.should == {} }
     end
 
     context "when the version is not informed, get it from the BBB server" do
@@ -449,7 +450,7 @@ describe BigBlueButton::BigBlueButtonApi do
     end
 
     context "standard case" do
-      before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345").and_return("ok") }
+      before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", {}).and_return("ok") }
       it { api.send(:send_request, url).should == "ok" }
     end
 
@@ -463,7 +464,7 @@ describe BigBlueButton::BigBlueButtonApi do
       it { expect { api.send(:send_request, url) }.to raise_error(BigBlueButton::BigBlueButtonException) }
     end
 
-    context "with data" do
+    context "post with data" do
       let(:data) { "any data" }
       before {
         path = "/res?param1=value1&checksum=12345"
@@ -475,6 +476,29 @@ describe BigBlueButton::BigBlueButtonApi do
       }
     end
 
+    context "get with headers" do
+      let(:headers_hash) { { :anything => "anything" } }
+      before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", headers_hash).and_return("ok") }
+      it {
+        api.request_headers = headers_hash
+        api.send(:send_request, url).should == "ok"
+      }
+    end
+
+    context "get with headers" do
+      let(:headers_hash) { { :anything => "anything" } }
+      let(:data) { "any data" }
+      before {
+        path = "/res?param1=value1&checksum=12345"
+        opts = { 'Content-Type' => 'text/xml', :anything => "anything" }
+        @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
+      }
+      it {
+        api.request_headers = headers_hash
+        api.send(:send_request, url, data).should == "ok"
+      }
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bigbluebutton-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-05 00:00:00.000000000 Z
+date: 2012-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -937799181
+      hash: -1556921647631366101
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -937799181
+      hash: -1556921647631366101
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24