Merge pull request #50 from mconf/refactor-lti-response-logs

LTI-75 Replace 'debug' flag with a Logger

Author: wpramio

features/config.yml.example

@@ -1,4 +1,4 @@
-debug: false
+logger: nil
 
 # maximum wait for a response to any API request (secs)
 timeout_req: 60

features/step_definitions/common_steps.rb

@@ -4,7 +4,7 @@
   @api = BigBlueButton::BigBlueButtonApi.new(@config_server['url'],
                                              @config_server['secret'],
                                              @config_server['version'].to_s,
-                                             @config['debug'])
+                                             @config['logger'])
   @api.timeout = @config['timeout_req']
 end
 

lib/bigbluebutton_api.rb

@@ -9,6 +9,7 @@
 require 'bigbluebutton_modules'
 require 'bigbluebutton_config_xml'
 require 'bigbluebutton_config_layout'
+require 'logger'
 
 module BigBlueButton
 
@@ -50,8 +51,8 @@ class BigBlueButtonApi
     # API version e.g. 0.81
     attr_accessor :version
 
-    # Flag to turn on/off debug mode
-    attr_accessor :debug
+    # logger to log reponses and infos
+    attr_accessor :logger
 
     # Maximum wait time for HTTP requests (secs)
     attr_accessor :timeout
@@ -67,21 +68,25 @@ class BigBlueButtonApi
     # url::       URL to a BigBlueButton server (e.g. http://demo.bigbluebutton.org/bigbluebutton/api)
     # secret::    Shared secret for this server
     # version::   API version e.g. 0.81
-    def initialize(url, secret, version=nil, debug=false)
+    def initialize(url, secret, version=nil, logger=nil)
       @supported_versions = ['0.8', '0.81', '0.9', '1.0']
       @url = url
       @secret = secret
-      @debug = debug
       @timeout = 10         # default timeout for api requests
       @request_headers = {} # http headers sent in all requests
-
+      @logger = logger
+      if logger.nil?
+        @logger = Logger.new(STDOUT)
+        @logger.level = Logger::INFO
+      end
+      
       version = nil if version && version.strip.empty?
       @version = nearest_version(version || get_api_version)
       unless @supported_versions.include?(@version)
-        puts "BigBlueButtonAPI: detected unsupported version, using the closest one that is supported (#{@version})"
+        @logger.warn("BigBlueButtonAPI: detected unsupported version, using the closest one that is supported (#{@version})")
       end
 
-      puts "BigBlueButtonAPI: Using version #{@version}" if @debug
+      @logger.debug("BigBlueButtonAPI: Using version #{@version}")
     end
 
     # Creates a new meeting. Returns the hash with the response or throws BigBlueButtonException
@@ -636,7 +641,7 @@ def check_url
     # API's are equal if all the following attributes are equal.
     def ==(other)
       r = true
-      [:url, :supported_versions, :secret, :version, :debug].each do |param|
+      [:url, :supported_versions, :secret, :version, :logger].each do |param|
         r = r && self.send(param) == other.send(param)
       end
       r
@@ -743,7 +748,7 @@ def send_api_request(method, params={}, data=nil, raw=false)
     # Otherwise uses GET
     def send_request(url, data=nil)
       begin
-        puts "BigBlueButtonAPI: URL request = #{url}" if @debug
+        @logger.debug("BigBlueButtonAPI: URL request = #{url}")
         url_parsed = URI.parse(url)
         http = Net::HTTP.new(url_parsed.host, url_parsed.port)
         http.open_timeout = @timeout
@@ -753,11 +758,12 @@ def send_request(url, data=nil)
         if data.nil?
           response = http.get(url_parsed.request_uri, @request_headers)
         else
-          puts "BigBlueButtonAPI: Sending as a POST request with data.size = #{data.size}" if @debug
+          @logger.debug("BigBlueButtonAPI: Sending as a POST request with data.size = #{data.size}")
           opts = { 'Content-Type' => 'application/xml' }.merge @request_headers
           response = http.post(url_parsed.request_uri, data, opts)
         end
-        puts "BigBlueButtonAPI: URL response = #{response.body}" if @debug
+        @logger.info("BigBlueButtonAPI: request=#{url} response_status=#{response.class.name} response_code=#{response.code}  message_key=#{response.message}")
+        @logger.debug("BigBlueButtonAPI: URL response = #{response.body}")
 
       rescue Timeout::Error => error
         raise BigBlueButtonException.new("Timeout error. Your server is probably down: \"#{@url}\". Error: #{error}")

spec/bigbluebutton_api_0.81_spec.rb

@@ -7,8 +7,7 @@
   let(:url) { "http://server.com" }
   let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.81" }
-  let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version) }
 
   describe "#get_default_config_xml" do
     let(:response) { "<response><returncode>1</returncode></response>" }

spec/bigbluebutton_api_0.9_spec.rb

@@ -7,8 +7,7 @@
   let(:url) { "http://server.com" }
   let(:secret) { "1234567890abcdefghijkl" }
   let(:version) { "0.9" }
-  let(:debug) { false }
-  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+  let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version) }
 
   describe "#create_meeting" do
     context "accepts the new parameters" do

spec/bigbluebutton_api_spec.rb

@@ -9,16 +9,17 @@
     # default variables and API object for all tests
     let(:url) { "http://server.com" }
     let(:secret) { "1234567890abcdefghijkl" }
-    let(:debug) { false }
-    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+    let(:logger) { Logger.new(STDOUT) }
+    let(:api) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
+    before { logger.level = Logger::INFO }
 
     describe "#initialize" do
       context "standard initialization" do
-        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+        subject { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
         it { subject.url.should == url }
         it { subject.secret.should == secret }
         it { subject.version.should == version }
-        it { subject.debug.should == debug }
+        it { subject.logger.should == logger }
         it { subject.timeout.should == 10 }
         it { subject.supported_versions.should include("0.8") }
         it { subject.supported_versions.should include("0.81") }
@@ -350,14 +351,14 @@
     end
 
     describe "#==" do
-      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, debug) }
+      let(:api2) { BigBlueButton::BigBlueButtonApi.new(url, secret, version, logger) }
 
       context "compares attributes" do
         it { api.should == api2 }
       end
 
-      context "differs #debug" do
-        before { api2.debug = !api.debug }
+      context "differs #logger" do
+        before { api2.logger = !api.logger }
         it { api.should_not == api2 }
       end
 
@@ -559,17 +560,19 @@
     describe "#send_request" do
       let(:url) { "http://test-server:8080/res?param1=value1&checksum=12345" }
       let(:url_parsed) { URI.parse(url) }
+      let(:res) { Net::HTTPResponse.new(1.0, '200', 'OK') }
 
       before do
         @http_mock = mock(Net::HTTP)
         @http_mock.should_receive(:"open_timeout=").with(api.timeout)
         @http_mock.should_receive(:"read_timeout=").with(api.timeout)
         Net::HTTP.should_receive(:new).with("test-server", 8080).and_return(@http_mock)
+        res.stub(:body) { "ok" }
       end
 
       context "standard case" do
-        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", {}).and_return("ok") }
-        it { api.send(:send_request, url).should == "ok" }
+        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", {}).and_return(res) }
+        it { api.send(:send_request, url).should == res }
       end
 
       context "handles a TimeoutError" do
@@ -586,20 +589,20 @@
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'application/x-www-form-urlencoded' }
-          @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
+          opts = { 'Content-Type' => 'application/xml' }
+          @http_mock.should_receive(:post).with(path, data, opts).and_return(res)
         }
         it {
-          api.send(:send_request, url, data).should == "ok"
+          api.send(:send_request, url, data).should == res
         }
       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") }
+        before { @http_mock.should_receive(:get).with("/res?param1=value1&checksum=12345", headers_hash).and_return(res) }
         it {
           api.request_headers = headers_hash
-          api.send(:send_request, url).should == "ok"
+          api.send(:send_request, url).should == res
         }
       end
 
@@ -608,12 +611,12 @@
         let(:data) { "any data" }
         before {
           path = "/res?param1=value1&checksum=12345"
-          opts = { 'Content-Type' => 'application/x-www-form-urlencoded', :anything => "anything" }
-          @http_mock.should_receive(:post).with(path, data, opts).and_return("ok")
+          opts = { 'Content-Type' => 'application/xml', :anything => "anything" }
+          @http_mock.should_receive(:post).with(path, data, opts).and_return(res)
         }
         it {
           api.request_headers = headers_hash
-          api.send(:send_request, url, data).should == "ok"
+          api.send(:send_request, url, data).should == res
         }
       end
     end