mediawiki-gateway 0.6.2 → 1.0.0.rc1

data/spec/media_wiki/gateway/query_spec.rb

@@ -0,0 +1,84 @@
+describe_fake MediaWiki::Gateway::Query do
+
+  describe "#search" do
+
+    before do
+      $fake_media_wiki.reset
+      @gateway.create("Search Test", "Foo KEY Blah")
+      @gateway.create("Search Test 2", "Zomp KEY Zorg")
+      @gateway.create("Book:Search Test", "Bar KEY Baz")
+      @gateway.create("Sandbox:Search Test", "Evil KEY Evil")
+    end
+
+    describe "with an empty key" do
+
+      it "should raise an error" do
+        lambda do
+          @gateway.search("")
+        end.should raise_error(MediaWiki::APIError)
+      end
+
+    end
+
+    describe "with a valid key and no namespaces" do
+
+      before do
+        @search = @gateway.search("KEY")
+      end
+
+      it "should list all matching pages in the main namespace" do
+        @search.should =~ [ "Search Test", "Search Test 2" ]
+      end
+
+    end
+
+    describe "with a valid key and a namespace string" do
+
+      before do
+        @search = @gateway.search("KEY", "Book")
+      end
+
+      it "should list all matching pages in the specified namespaces" do
+        @search.should == [ "Book:Search Test" ]
+      end
+
+    end
+
+    describe "with a valid key and a namespace array" do
+
+      before do
+        @search = @gateway.search("KEY", ["Book", "Sandbox"])
+      end
+
+      it "should list all matching pages in the specified namespaces" do
+        @search.should =~ [ "Sandbox:Search Test", "Book:Search Test" ]
+      end
+
+    end
+
+    describe "with maximum number of results" do
+
+      before do
+        @search = @gateway.search("KEY", nil, 2, 1)
+      end
+
+      it "should return at most the maximum number of results asked" do
+        @search.size.should == 1
+      end
+    end
+
+  end
+
+  describe "#semantic_query" do
+
+    before do
+      @response = @gateway.semantic_query('[[place::123]]', ['mainlabel=Page'])
+    end
+
+    it "should return an HTML string" do
+      @response.should == 'Sample <B>HTML</B> content.'
+    end
+
+  end
+
+end

data/spec/media_wiki/gateway/site_spec.rb

@@ -0,0 +1,122 @@
+describe_fake MediaWiki::Gateway::Site do
+
+  describe "#import" do
+
+    let(:import_file) { data('import.xml') }
+
+    describe "when not logged in" do
+
+      it "should raise an error" do
+        lambda do
+          @gateway.import(import_file)
+        end.should raise_error(MediaWiki::Unauthorized)
+      end
+
+    end
+
+    describe "when logged in as admin" do
+
+      def import_response
+        <<-XML
+          <api>
+            <import>
+              <page title='Main Page' ns='0' revisions='0'/>
+              <page title='Template:Header' ns='10' revisions='1'/>
+            </import>
+          </api>
+        XML
+      end
+
+      before do
+        @gateway.login("atlasmw", "wombat")
+        @page = @gateway.import(import_file)
+      end
+
+      it "should import content" do
+        expect(@page.to_s).to be_equivalent_to(import_response)
+      end
+
+    end
+
+  end
+
+  describe "#export" do
+
+    def export_response
+      <<-XML
+        <mediawiki>
+          <page>
+            <title>Main Page</title>
+            <id>1</id>
+            <revision>
+              <id>1</id>
+              <text>Content</text>
+            </revision>
+          </page>
+        </mediawiki>
+      XML
+    end
+
+    before do
+      @page = @gateway.export("Main Page")
+    end
+
+    it "should return export data for the page" do
+      expect(@page.to_s).to be_equivalent_to(export_response)
+    end
+
+  end
+
+  describe "#siteinfo" do
+
+    before do
+      $fake_media_wiki.reset
+      @siteinfo = @gateway.siteinfo
+    end
+
+    it "should get the siteinfo" do
+      @siteinfo.should == { 'generator' => "MediaWiki #{MediaWiki::VERSION}" }
+    end
+
+  end
+
+  describe "#version" do
+
+    before do
+      $fake_media_wiki.reset
+      @version = @gateway.version
+    end
+
+    it "should get the version" do
+      @version.should == MediaWiki::VERSION
+    end
+
+  end
+
+  describe "#namespaces_by_prefix" do
+
+    before do
+      $fake_media_wiki.reset
+      @namespaces = @gateway.namespaces_by_prefix
+    end
+
+    it "should list all namespaces" do
+      @namespaces.should == { "" => 0, "Book" => 100, "Sandbox" => 200 }
+    end
+
+  end
+
+  describe "#extensions" do
+
+    before do
+      $fake_media_wiki.reset
+      @extensions = @gateway.extensions
+    end
+
+    it "should list all extensions" do
+      @extensions.should == { "FooExtension" => "r1", "BarExtension" => "r2", 'Semantic MediaWiki' => '1.5' }
+    end
+
+  end
+
+end

data/spec/media_wiki/gateway/users_spec.rb

@@ -0,0 +1,171 @@
+describe_fake MediaWiki::Gateway::Users do
+
+  describe '#login' do
+
+    describe "with a valid username & password" do
+
+      before do
+        @gateway.login('atlasmw', 'wombat')
+      end
+
+      it "should login successfully with the default domain" do
+        $fake_media_wiki.logged_in('atlasmw').should == true
+      end
+
+    end
+
+    describe "with a valid username, password and domain" do
+
+      before do
+        @gateway.login('ldapuser', 'ldappass', 'ldapdomain')
+      end
+
+      it "should login successfully" do
+        $fake_media_wiki.logged_in('ldapuser').should == true
+      end
+
+    end
+
+    describe "with an non-existent username" do
+
+      it "should raise an error" do
+        lambda do
+          @gateway.login('bogususer', 'sekrit')
+        end.should raise_error(MediaWiki::Unauthorized)
+      end
+
+    end
+
+    describe "with an incorrect password" do
+
+      it "should raise an error" do
+        lambda do
+          @gateway.login('atlasmw', 'sekrit')
+        end.should raise_error(MediaWiki::Unauthorized)
+      end
+
+    end
+
+    describe "with an incorrect domain" do
+
+      it "should raise an error" do
+        lambda do
+          @gateway.login('atlasmw', 'wombat', 'bogusdomain')
+        end.should raise_error(MediaWiki::Unauthorized)
+      end
+
+    end
+
+  end
+
+  describe "#create_account" do
+
+    describe "when logged in as admin" do
+      before do
+        @gateway.login("atlasmw", "wombat")
+      end
+
+      it 'should get expected result' do
+        expected = <<-XML
+          <api>
+            <createaccount result='success' token='admin_token+\\' userid='4' username='FooBar'/>
+          </api>
+        XML
+
+        expect(@gateway.create_account({ 'name' => 'FooBar', 'password' => 'BarBaz' }).to_s).to be_equivalent_to(expected)
+      end
+
+    end
+
+  end
+
+  describe '#options' do
+
+    describe 'when logged in' do
+      before do
+        @gateway.login("atlasmw", "wombat")
+      end
+
+      describe 'requesting an options token' do
+        before  do
+          @token = @gateway.send(:get_options_token)
+        end
+
+        it "should return a token" do
+          @token.should_not == nil
+          @token.should_not == "+\\"
+        end
+
+      end
+
+      it 'should return the expected response' do
+        expected = '<api options="success" />'
+        expect(@gateway.options({ :realname => 'Bar Baz' }).to_s).to be_equivalent_to(expected)
+      end
+
+    end
+
+  end
+
+  describe "#user_rights" do
+
+    describe "when logged in as admin" do
+
+      before do
+        @gateway.login("atlasmw", "wombat")
+      end
+
+      describe "requesting a userrights token for an existing user" do
+
+        before do
+          @token = @gateway.send(:get_userrights_token, 'nonadmin')
+        end
+
+        it "should return a token" do
+          @token.should_not == nil
+          @token.should_not == "+\\"
+        end
+      end
+
+      describe "requesting a userrights token for an nonexistant user" do
+
+        it "should raise an error" do
+          lambda do
+            @gateway.send(:get_userrights_token, 'nosuchuser')
+          end.should raise_error(MediaWiki::APIError)
+        end
+      end
+
+      describe "changing a user's groups with a valid token" do
+
+        def userrights_response
+          <<-XML
+            <api>
+              <userrights user="nonadmin">
+                <removed>
+                  <group>oldgroup</group>
+                </removed>
+                <added>
+                  <group>newgroup</group>
+                </added>
+              </userrights>
+            </api>
+          XML
+        end
+
+        before do
+          @token = @gateway.send(:get_userrights_token, 'nonadmin')
+          @result = @gateway.send(:userrights, 'nonadmin', @token, 'newgroup', 'oldgroup', 'because I can')
+        end
+
+        it "should return a result matching the input" do
+          expect(@result.to_s).to be_equivalent_to(userrights_response)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/media_wiki/gateway_spec.rb

@@ -0,0 +1,129 @@
+describe_fake MediaWiki::Gateway do
+
+  describe 'setting the User-Agent header' do
+
+    ua = described_class::USER_AGENT
+
+    def expect_user_agent(expected, actual = default = true)
+      options = default ? {} : { user_agent: actual }
+      gateway = described_class.new('test.wiki', options)
+      expect(gateway.headers['User-Agent']).to eq(expected)
+    end
+
+    it 'should default to generic value' do
+      expect_user_agent ua
+    end
+
+    it 'should ignore nil value' do
+      expect_user_agent ua, nil
+    end
+
+    it 'should prepend given value' do
+      expect_user_agent "Foo/4.2 #{ua}", 'Foo/4.2'
+    end
+
+    describe 'with global default' do
+
+      before do
+        described_class.default_user_agent = 'Bar/2.3'
+      end
+
+      after do
+        described_class.default_user_agent = nil
+      end
+
+      it 'should default to global value' do
+        expect_user_agent "Bar/2.3 #{ua}"
+      end
+
+      it 'should accept nil value' do
+        expect_user_agent ua, nil
+      end
+
+      it 'should override with given value' do
+        expect_user_agent "Foo/4.2 #{ua}", 'Foo/4.2'
+      end
+
+    end
+
+  end
+
+  describe "#get_token" do
+
+    describe "when not logged in" do
+
+      describe "requesting an edit token" do
+
+        before do
+          @token = @gateway.send(:get_token, 'edit', 'Main Page')
+        end
+
+        it "should return a blank token" do
+          @token.should_not == nil
+          @token.should == "+\\"
+        end
+
+      end
+
+      describe "requesting an import token" do
+
+        it "should raise an error" do
+          lambda do
+            @gateway.send(:get_token, 'import', 'Main Page')
+          end.should raise_error(MediaWiki::Unauthorized)
+        end
+
+      end
+
+    end
+
+    describe "when logged in as admin user" do
+
+      before do
+        @gateway.login('atlasmw', 'wombat')
+      end
+
+      describe "requesting an edit token for a single page" do
+
+        before do
+          @token = @gateway.send(:get_token, 'edit', 'Main Page')
+        end
+
+        it "should return a token" do
+          @token.should_not == nil
+          @token.should_not == "+\\"
+        end
+
+      end
+
+      describe "requesting an edit token for multiple pages" do
+
+        before do
+          @token = @gateway.send(:get_token, 'edit', "Main Page|Another Page")
+        end
+
+        it "should return a token" do
+          @token.should_not == nil
+          @token.should_not == "+\\"
+        end
+
+      end
+
+      describe "requesting an import token" do
+
+        before do
+          @token = @gateway.send(:get_token, 'import', 'Main Page')
+        end
+
+        it "should return a token" do
+          @token.should_not == nil
+          @token.should_not == "+\\"
+        end
+
+      end
+
+    end
+
+  end
+
+end