nolij_web 1.0.0

data/test/nolij_web/connection_test.rb

@@ -0,0 +1,404 @@
+require_relative '../test_helper'
+
+describe NolijWeb::Connection do
+  # Format cookies for webmock headers
+  def to_cookie(cookies = {})
+    cookies.sort_by{|k, v| k.to_s}.collect{|c| "#{c[0]}=#{c[1]}"}.join('; ')
+  end
+
+  # Set up basic configured connection as @conn
+  def setup_configured_connection
+    username = 'test_monkey'
+    pw = 'test_banana'
+    @base_url = 'http://banana.example.com/NolijWeb'
+    @conn = NolijWeb::Connection.new({:username => username, :password => pw, :base_url => @base_url})
+  end
+
+  #stubs connection and requests for full authenticated round trip
+  def stub_connection_round_trip(connection)
+    @cookies = {'k' => 'v', 'a' => 'b'}
+
+    @stubbed_login = stub_request(:post, "#{@base_url}/j_spring_security_check").
+with(:body => {"j_password"=> connection.instance_variable_get(:@password), "j_username"=> connection.instance_variable_get(:@username)}).to_return(:status => 200, :headers => {'Set-Cookie' => to_cookie(@cookies)})
+
+    @stubbed_logout = stub_request(:get, "#{@base_url}/j_spring_security_logout").with(:headers => {'Cookie' => to_cookie(@cookies)})
+  end
+
+  describe '# initialize' do
+    describe 'with no config' do
+      it "should raise config error" do
+        err = lambda{NolijWeb::Connection.new(nil)}.must_raise(NolijWeb::ConnectionConfigurationError)
+        err.to_s.must_match /invalid configuration/i
+      end
+    end
+
+    describe 'defaults initialization behavior' do
+      before do
+        @conn = NolijWeb::Connection.new({})
+      end
+
+      it "should have nil connection instance var" do
+        @conn.instance_variable_get(:@connection).must_be_nil
+      end
+
+      it "should have nil cookies instance var" do
+        @conn.instance_variable_get(:@cookies).must_be_nil
+      end
+
+      it "should have string username instance var" do
+        @conn.instance_variable_get(:@username).must_be_kind_of(String)
+      end
+
+      it "should have string password instance var" do
+        @conn.instance_variable_get(:@password).must_be_kind_of(String)
+      end
+
+      it "should have string base_url instance var" do
+        @conn.instance_variable_get(:@base_url).must_be_kind_of(String)
+      end
+    end
+
+    describe 'set config for new instances' do
+      describe "with hash config" do
+        before do
+          @conn = NolijWeb::Connection.new({:username => 'test_monkey', :password => 'banana oooeee', :base_url => 'http://testsomething.example.com/NolijWeb'})
+        end
+
+        it "should have string username instance var" do
+          @conn.instance_variable_get(:@username).must_equal 'test_monkey'
+        end
+
+        it "should have string password instance var" do
+          @conn.instance_variable_get(:@password).must_equal 'banana oooeee'
+        end
+
+        it "should have string base_url instance var" do
+          @conn.instance_variable_get(:@base_url).must_equal 'http://testsomething.example.com/NolijWeb'
+        end
+
+        it "should have hash config" do
+          @conn.instance_variable_get(:@config).must_be_kind_of(Hash)
+        end
+      end
+
+      describe "with yaml config" do
+        before do
+          @conn = NolijWeb::Connection.new(File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'nolij_config.yml'))
+        end
+
+        it "should have string username instance var" do
+          @conn.instance_variable_get(:@username).must_equal 'monkey'
+        end
+
+        it "should have string password instance var" do
+          @conn.instance_variable_get(:@password).must_equal 'banana'
+        end
+
+        it "should have string base_url instance var" do
+          @conn.instance_variable_get(:@base_url).must_equal 'http://testsomething2.example.com/NolijWeb'
+        end
+
+        it "should have hash config" do
+          @conn.instance_variable_get(:@config).must_be_kind_of(Hash)
+        end
+      end
+    end
+  end
+
+  describe '#configure' do
+    before do
+      @conn = NolijWeb::Connection.new({})
+      @conn.configure({:username => 'new_user', :password => 'new_password', :base_url => 'http://newsomething.example.com/NolijWeb'})
+    end
+
+    it "should define config" do
+      @conn.instance_variable_get(:@config).must_be_kind_of(Hash)
+    end
+
+    it "should define base_url" do
+      @conn.instance_variable_get(:@base_url).must_equal 'http://newsomething.example.com/NolijWeb'
+    end
+
+    it "should define username" do
+      @conn.instance_variable_get(:@username).must_equal 'new_user'
+    end
+
+    it "should define password" do
+      @conn.instance_variable_get(:@password).must_equal 'new_password'
+    end
+
+    it "should define nil connection" do
+      @conn.instance_variable_get(:@connection).must_be_nil
+    end
+
+    it "should define nil cookies" do
+      @conn.instance_variable_get(:@cookies).must_be_nil
+    end
+  end
+
+  describe '#configure_with' do
+    before do
+      @conn = NolijWeb::Connection.new({})
+    end
+
+    it "should raild ConnectionConfigurationError for invalid string parameter" do
+      err = lambda{
+                    @conn.configure_with([])
+                  }.must_raise(NolijWeb::ConnectionConfigurationError)
+      err.to_s.must_match /invalid request/i
+    end
+
+    it "should raise ConnectionConfigurationError for invalid syntax" do
+      err = lambda{
+                    @conn.configure_with(File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'bad_nolij_config.yml'))
+                  }.must_raise(NolijWeb::ConnectionConfigurationError)
+      err.to_s.must_match /invalid syntax/i
+    end
+
+    it "should raise ConnectionConfigurationError for no file" do
+      err = lambda{
+                    @conn.configure_with('gobble.yml')
+                  }.must_raise(NolijWeb::ConnectionConfigurationError)
+      err.to_s.must_match /not found/i
+    end  
+  end
+
+  describe '#establish_connection' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+    end
+
+    it "should request login url" do
+      @conn.establish_connection
+      assert_requested @stubbed_login
+    end
+
+    it "should assign instance var cookies" do
+      @conn.establish_connection
+      @conn.instance_variable_get(:@cookies).must_equal @cookies
+    end
+
+    it "should assign not nil connection" do
+      @conn.establish_connection
+      @conn.instance_variable_get(:@connection).wont_be_nil
+    end
+  end
+
+  describe '#close_connection' do
+    describe "when not logged in" do
+      before do
+        setup_configured_connection
+        @stubbed_logout = stub_request(:get, "#{@base_url}/j_spring_security_logout")
+      end
+
+      it "should not request logout url" do
+        @conn.close_connection
+        @conn.connection.must_be_nil
+        assert_not_requested @stubbed_logout
+      end
+
+      it "should set nil connection" do
+        @conn.instance_variable_set(:@connection, MiniTest::Mock.new)
+        @conn.close_connection
+        @conn.instance_variable_get(:@connection).must_be_nil
+      end
+
+      it "should set nil cookies" do
+        @conn.instance_variable_set(:@cookies, MiniTest::Mock.new)
+        @conn.close_connection
+        @conn.instance_variable_get(:@cookies).must_be_nil
+      end
+    end
+
+    describe "when logged in" do
+      before do
+        setup_configured_connection
+        stub_connection_round_trip(@conn)
+      end
+
+      it "should request logout url" do
+        assert @conn.establish_connection
+        @conn.close_connection
+        assert_requested @stubbed_logout
+      end
+
+      it "should reset nil connection" do
+        assert @conn.establish_connection
+        @conn.instance_variable_get(:@connection).wont_be_nil
+        @conn.close_connection
+        @conn.instance_variable_get(:@connection).must_be_nil
+      end
+
+      it "should set not nil cookies" do
+        assert @conn.establish_connection
+        @conn.instance_variable_get(:@cookies).wont_be_nil
+        @conn.close_connection
+        @conn.instance_variable_get(:@cookies).must_be_nil
+      end
+    end
+  end
+
+  describe "#get_custom_connection" do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should not open connection" do
+      @conn.get_custom_connection('go')
+      assert_not_requested @stubbed_login
+    end
+
+    it "should get input path at base url with cookies" do
+      @conn.get_custom_connection('go')
+      assert_requested @stubbed_get
+    end
+
+    it "should not close connection" do
+      @conn.get_custom_connection('go')
+      assert_not_requested @stubbed_logout
+    end
+  end
+
+  describe '#get' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @stubbed_get = stub_request(:get, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should open connection" do
+      @conn.get('go')
+      assert_requested @stubbed_login
+    end
+
+    it "should get input path at base url with cookies" do
+      @conn.get('go')
+      assert_requested @stubbed_get
+    end
+
+    it "should close connection" do
+      @conn.get('go', {})
+      assert_requested @stubbed_logout
+    end
+  end
+
+  describe "#delete_custom_connection" do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should not open connection" do
+      @conn.delete_custom_connection('go')
+      assert_not_requested @stubbed_login
+    end
+
+    it "should get input path at base url with cookies" do
+      @conn.delete_custom_connection('go')
+      assert_requested @stubbed_get
+    end
+
+    it "should not close connection" do
+      @conn.delete_custom_connection('go')
+      assert_not_requested @stubbed_logout
+    end
+  end
+
+  describe '#delete' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @stubbed_get = stub_request(:delete, "#{@base_url}/go").to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should open connection" do
+      @conn.delete('go')
+      assert_requested @stubbed_login
+    end
+
+    it "should get input path at base url with cookies" do
+      @conn.delete('go')
+      assert_requested @stubbed_get
+    end
+
+    it "should close connection" do
+      @conn.delete('go', {})
+      assert_requested @stubbed_logout
+    end
+  end
+
+  describe '#post_custom_connection' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @post_params = {'a' => 'b'}
+      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should not open connection" do
+      @conn.post_custom_connection('go', @post_params)
+      assert_not_requested @stubbed_login
+    end
+
+    it "should post to input path at base url with params and cookies" do
+      @conn.post_custom_connection('go', @post_params)
+      assert_requested @stubbed_post
+    end
+
+    it "should not close connection" do
+      @conn.post_custom_connection('go', @post_params)
+      assert_not_requested @stubbed_logout
+    end
+  end
+
+  describe '#post' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+      @post_params = {'a' => 'b'}
+      @stubbed_post = stub_request(:post, "#{@base_url}/go").with(:body => @post_params).to_return(:status => 200, :headers => {'Cookie' => to_cookie(@cookies)})
+    end
+
+    it "should open connection" do
+      @conn.post('go', @post_params)
+      assert_requested @stubbed_login
+    end
+
+    it "should post to input path at base url with params and cookies" do
+      @conn.post('go', @post_params)
+      assert_requested @stubbed_post
+    end
+
+    it "should close connection" do
+      @conn.post('go', @post_params)
+      assert_requested @stubbed_logout
+    end
+  end
+
+  describe '#execute' do
+    before do
+      setup_configured_connection
+      stub_connection_round_trip(@conn)
+    end
+
+    it "should establish connection" do
+      @conn.execute { "something to do" }
+      assert_requested @stubbed_login
+    end
+
+    it "should close connection when successful" do
+      @conn.execute { "something to do" }
+      assert_requested @stubbed_logout
+    end
+
+    it "should yield the block" do
+      result = @conn.execute { "something to do" }
+      result.must_equal 'something to do'
+    end
+  end
+
+end

data/test/nolij_web/handler_test.rb

@@ -0,0 +1,210 @@
+require_relative '../test_helper'
+
+describe NolijWeb::Handler do
+  before do
+    @base_url = 'http://example.reed.edu/NolijWeb'
+    @handler = NolijWeb::Handler.new({:username => 'test_user', :password => 'test_password', :base_url => @base_url})
+    # stub auth
+    stub_request(:post, "#{@base_url}/j_spring_security_check").
+  with(:body => {"j_password"=>"test_password", "j_username"=>"test_user"}).to_return(:status => 200)
+    stub_request(:get, "http://example.reed.edu/NolijWeb/j_spring_security_logout").to_return(:status => 200)
+  end
+
+  describe "initialize" do
+    it "should respond to connection" do
+      @handler.respond_to?(:connection)
+    end
+
+    it "should set a connection" do
+      @handler.instance_variable_get(:@connection).wont_be_nil
+    end
+
+    it "should set a config" do
+      @handler.instance_variable_get(:@config).wont_be_nil
+    end
+  end
+
+  describe "with valid folder request" do
+    before do
+      @folder_id = '1_2'
+      response = File.new(File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'folder_info.xml'))
+      @stubbed_request = stub_request(:get, /\/handler\/api\/docs\/#{@folder_id}/).to_return(:status => 200, :body => response)
+    end
+
+    describe "#folder_info" do
+      it "should raise missing attribute if no id is supplied" do
+        err = lambda{@handler.folder_info}.must_raise(NolijWeb::AttributeMissingError)
+        err.to_s.must_match /Folder ID is required/
+      end
+
+      it "should get stubbed url" do
+        folder_info = @handler.folder_info(:folder_id => @folder_id)
+        assert_requested @stubbed_request
+      end
+
+      it "should return nokogiri xml document" do
+        folder_info = @handler.folder_info(:folder_id => @folder_id)
+        folder_info.must_be_kind_of(Nokogiri::XML::Document)
+      end
+    end
+
+    describe "#folder_contents" do
+      it "should get stubbed url" do
+        folder_info = @handler.folder_contents(:folder_id => @folder_id)
+        assert_requested @stubbed_request
+      end
+
+      it "should return an array" do
+        folder_contents = @handler.folder_contents(:folder_id => @folder_id)
+        folder_contents.must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#submit_document" do
+    it "should raise missing attribute if no folder id is supplied" do
+      err = lambda{@handler.submit_document('test_file.txt', {:folder_id => nil})}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /Folder ID is required/
+    end
+
+    it "should raise missing attribute if folder id is supplied but no file" do
+      err = lambda{@handler.submit_document(nil, {:folder_id => '234_324'})}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /path is required/
+    end
+
+    describe 'with valid folder and file path' do
+      before do
+        @file_path = File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'text_file.txt')
+        @folder_id = '1_2'
+        response = File.new(File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'document_submitted_success.xml'))
+        @stubbed_request = stub_request(:post, /\/handler\/api\/docs\/#{@folder_id}/).to_return(:status => 200, :body => response)
+      end
+
+      it "should post to connection url" do
+        file_upload = @handler.submit_document(@file_path, :folder_id => @folder_id)
+        assert_requested @stubbed_request
+      end
+
+      it "should return a file id" do
+        #96855 is set in test_stubs/file_posted.xml
+        file_upload = @handler.submit_document(@file_path, :folder_id => @folder_id)
+        file_upload.must_equal '96855'
+      end
+    end
+  end
+
+  describe '#print_document' do
+    before do
+      @document_ids = ['12345', '54326']
+      @folder_id = '111_2'
+      @stubbed_request = stub_request(:get, /\/handler\/api\/docs\/print/).to_return(:status => 200)
+    end
+
+    it "should raise missing attribute if no document ids supplied" do
+      err = lambda{@handler.print_document}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /document ID is required/i
+    end
+
+    it "should get print document" do
+      @handler.print_document(:document_id => @document_ids)
+      assert_requested @stubbed_request
+    end
+  end
+
+  describe '#viewer_url' do
+    it "should raise missing attribute if no document id supplied" do
+      err = lambda{@handler.viewer_url}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /document ID is required/i
+    end
+
+    it "should return a full url if full url is true" do
+      @handler.viewer_url(:document_id => '1234', :full_url => true).must_match /^#{@base_url}/
+    end
+
+    it "return a path if full url is empty" do
+      @handler.viewer_url(:document_id => '1234').wont_match /^#{@base_url}/
+    end
+
+    it "return a path if full url is false" do
+      @handler.viewer_url(:document_id => '1234', :full_url => false).wont_match /^#{@base_url}/
+    end
+
+    it "should return a string" do
+      @handler.viewer_url(:document_id => '1234').must_be_kind_of(String)
+    end
+  end
+
+  describe '#login_check' do
+    it "should raise missing attribute if no redirect_to_path is supplied" do
+      err = lambda{@handler.login_check}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /redirect path is required/i
+    end
+
+    it "should raise missing attribute if redirect_to_path is empty" do
+      err = lambda{@handler.login_check(:redir => '')}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /redirect path is required/i
+    end
+
+    it "should return a full url if full url is true" do
+      @handler.login_check(:redir => '/document_path', :full_url => true).must_match /^#{@base_url}/
+    end
+
+    it "return a path if full url is empty" do
+      @handler.login_check(:redir => '/document_path').wont_match /^#{@base_url}/
+    end
+
+    it "return a path if full url is false" do
+      @handler.login_check(:redir => '/document_path', :full_url => false).wont_match /^#{@base_url}/
+    end
+
+    it "should return a string" do
+      @handler.login_check(:redir => '/document_path').must_be_kind_of(String)
+    end
+  end
+
+  describe '#work_complete' do
+    before do
+      @folder_id = '12334'
+      @folder_name = "Schmoe, Joe"
+      @wfma_code = '12344'
+    end
+
+    it "should raise missing attribute if no wfma code supplied" do
+      err = lambda{@handler.work_complete(:folder_name => @folder_name, :folder_id => @folder_id)}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /workflow master code is required/i
+    end
+
+    it "should raise missing attribute if no folder name supplied" do
+      err = lambda{@handler.work_complete(:wfma_code => '1234', :folder_id => @folder_id)}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /folder name is required/i
+    end
+
+    it "should raise missing attribute if no folder id supplied" do
+      err = lambda{@handler.work_complete(:wfma_code => '1234', :folder_name => @folder_name)}.must_raise(NolijWeb::AttributeMissingError)
+      err.to_s.must_match /folder id is required/i
+    end
+
+    it "should post to work complete" do
+      stubbed_request = stub_request(:post, /\/handler\/api\/workflow\/workcomplete\/#{@folder_id}/).with(:query => hash_including({:wfmacode => @wfma_code, :foldername => @folder_name.to_s})).to_return(:status => 200)
+      @handler.work_complete(:folder_id => @folder_id, :wfma_code => @wfma_code, :folder_name => @folder_name)
+      assert_requested stubbed_request
+    end
+  end
+
+  describe "#version" do
+    before do
+      response = File.new(File.join(File.expand_path(File.dirname(__FILE__)), 'test_stubs', 'version_info.xml'))
+      @stubbed_request = stub_request(:get, /\/handler\/api\/version/).to_return(:status => 200, :body => response)
+    end
+
+    it "should get stubbed url" do
+      @handler.version
+      assert_requested @stubbed_request
+    end
+
+    it "should return an hash" do
+      @handler.version.must_be_kind_of(Hash)
+    end
+  end
+
+end

data/test/nolij_web/test_stubs/bad_nolij_config.yml

@@ -0,0 +1,3 @@
+:username: monkey
+:password: banana
+	:base_url: http://testsomething2.example.com/NolijWeb

data/test/nolij_web/test_stubs/document_submitted_success.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0"?>
+<documentmeta
+    documentid="96855"/>

data/test/nolij_web/test_stubs/folder_info.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<folderobjects folderid="209" count="3">
+    <folderobject
+          docname="Image096550.tif"
+          displayname="Application for Withdrawal.tif"
+          datecreated="2010-01-05 13:39:58.0 EST"
+          filesize="877492"
+          documentid="96550"
+          filetype="tif"
+          pagecount="1"/>
+<folderobject
+          docname="Image096551.tif"
+          displayname="Change of Academic Program.tif"
+          datecreated="2010-01-05 13:39:58.0 EST"
+          filesize="9268980"
+          documentid="96551"
+          filetype="tif"
+          pagecount="2" />
+<folderobject
+          docname="Image096552.tif"
+          displayname="Change of Grade.tif"
+          datecreated="2010-01-05 13:39:59.0 EST"
+          filesize="2661944"
+          filetype="tif"
+          documentid="96552"
+          pagecount="1" />
+</folderobjects>

data/test/nolij_web/test_stubs/nolij_config.yml

@@ -0,0 +1,3 @@
+:username: monkey
+:password: banana
+:base_url: http://testsomething2.example.com/NolijWeb

data/test/nolij_web/test_stubs/text_file.txt

@@ -0,0 +1 @@
+some text

data/test/nolij_web/test_stubs/version_info.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0"?>
+<version majorversion="6" minorversion="4" patchversion="2" build="6001"/>

data/test/nolij_web/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../test_helper'
+
+describe NolijWeb::Version do
+  it "must match format" do
+    NolijWeb::Version::VERSION.must_match  /\d+\.\d+\.\d+/
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+gem 'minitest'
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'webmock/minitest'
+
+require File.expand_path('../../lib/nolij_web.rb', __FILE__)
+
+WebMock.disable_net_connect!