mediawiki-gateway 0.3.5 → 0.3.6

data/doc/created.rid

@@ -1 +1 @@
-Mon, 07 Feb 2011 12:14:29 +1100
+Mon, 28 Mar 2011 12:16:13 +1100

data/doc/files/lib/media_wiki/gateway_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Mon Feb 07 12:13:27 +1100 2011</td>
+      <td>Mon Feb 07 14:36:34 +1100 2011</td>
     </tr>
     </table>
   </div>

data/doc/files/lib/media_wiki/utils_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Tue Jan 25 13:42:08 +1100 2011</td>
+      <td>Mon Mar 28 12:14:25 +1100 2011</td>
     </tr>
     </table>
   </div>

data/doc/fr_method_index.html

@@ -20,39 +20,41 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/MediaWiki/Config.html#M000034">abort (MediaWiki::Config)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000016">backlinks (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000011">create (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000013">delete (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000021">download (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000023">export (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000025">extensions (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000009">get (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000036">abort (MediaWiki::Config)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000018">backlinks (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000012">create (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000015">delete (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000023">download (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000013">edit (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000025">export (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000027">extensions (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000010">get (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000001">get_base_name (MediaWiki)</a><br />
     <a href="classes/MediaWiki.html#M000002">get_path_to_subpage (MediaWiki)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000030">get_response (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000032">get_response (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000003">get_subpage (MediaWiki)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000027">get_token (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000028">get_undelete_token (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000020">image_info (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000022">import (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000015">list (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000008">login (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000029">make_api_request (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000012">move (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000024">namespaces_by_prefix (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Config.html#M000033">new (MediaWiki::Config)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000007">new (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000019">redirect? (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000010">render (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000017">search (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000026">semantic_query (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000014">undelete (MediaWiki::Gateway)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000018">upload (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000029">get_token (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000030">get_undelete_token (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000022">image_info (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000024">import (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000017">list (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000009">login (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000031">make_api_request (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000014">move (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000026">namespaces_by_prefix (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000008">new (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Config.html#M000035">new (MediaWiki::Config)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000021">redirect? (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000011">render (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000019">search (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000028">semantic_query (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000016">undelete (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki.html#M000007">upcase_first_char (MediaWiki)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000020">upload (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000004">uri_to_wiki (MediaWiki)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000031">valid_page? (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000033">valid_page? (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000006">version (MediaWiki)</a><br />
-    <a href="classes/MediaWiki/Gateway.html#M000032">warning (MediaWiki::Gateway)</a><br />
+    <a href="classes/MediaWiki/Gateway.html#M000034">warning (MediaWiki::Gateway)</a><br />
     <a href="classes/MediaWiki.html#M000005">wiki_to_uri (MediaWiki)</a><br />
   </div>
 </div>

data/lib/media_wiki.rb

@@ -3,5 +3,5 @@ require File.dirname(__FILE__) + '/media_wiki/utils'
 require File.dirname(__FILE__) + '/media_wiki/gateway'
 
 module MediaWiki
-  VERSION = "0.3.5"
+  VERSION = "0.3.6"
 end

data/lib/media_wiki/gateway.rb

@@ -37,7 +37,7 @@ module MediaWiki
       @cookies = {}
     end
     
-    attr_reader :base_url
+    attr_reader :base_url, :cookies
     
     # Login to MediaWiki
     #
@@ -459,6 +459,16 @@ module MediaWiki
       xml, dummy = make_api_request(form_data)
       return xml.elements["parse/text"].text
     end
+    
+    # Set groups for a user
+    #
+    # [user] Username of user to modify
+    # [groups_to_add] Groups to add user to, as an array or a string if a single group (optional)
+    # [groups_to_remove] Groups to remove user from, as an array or a string if a single group (optional)
+    def set_groups(user, groups_to_add = [], groups_to_remove = [], comment = '')
+      token = get_userrights_token(user)
+      userrights(user, token, groups_to_add, groups_to_remove, comment)
+    end
 
     private
 
@@ -483,6 +493,42 @@ module MediaWiki
       end
     end
 
+    # User rights management (aka group assignment)
+    def get_userrights_token(user)
+      form_data = {'action' => 'query', 'list' => 'users', 'ustoken' => 'userrights', 'ususers' => user}
+      res, dummy = make_api_request(form_data)
+      token = res.elements["query/users/user"].attributes["userrightstoken"]
+
+      @log.debug("RESPONSE: #{res.to_s}")
+      if token.nil?
+        if res.elements["query/users/user"].attributes["missing"]
+          raise "User '#{user}' was not found (get_userrights_token)"
+        else
+          raise "User '#{@username}' is not permitted to perform this operation: get_userrights_token"
+        end
+      end
+      
+      token
+    end
+    
+    def userrights(user, token, groups_to_add, groups_to_remove, reason)
+      # groups_to_add and groups_to_remove can be a string or an array. Turn them into MediaWiki's pipe-delimited list format.
+      if groups_to_add.is_a? Array
+        groups_to_add = groups_to_add.join('|')
+      end
+      if groups_to_remove.is_a? Array
+        groups_to_remove = groups_to_remove.join('|')
+      end
+
+      form_data = {'action' => 'userrights', 'user' => user, 'token' => token,
+        'add' => groups_to_add,
+        'remove' => groups_to_remove,
+        'reason' => reason
+      }
+      res, dummy = make_api_request(form_data)
+      res
+    end
+
     # Make generic request to API
     #
     # [form_data] hash or string of attributes to post

data/mediawiki-gateway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mediawiki-gateway}
-  s.version = "0.3.5"
+  s.version = "0.3.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jani Patokallio"]
-  s.date = %q{2011-03-28}
+  s.date = %q{2011-03-30}
   s.description = %q{}
   s.email = %q{jpatokal@iki.fi}
   s.extra_rdoc_files = [

data/spec/fake_media_wiki/api_pages.rb

@@ -108,6 +108,7 @@ module FakeMediaWiki
     end
     alias_method :deletetoken, :importtoken
     alias_method :undeletetoken, :importtoken
+    alias_method :userrightstoken, :importtoken
     
     def edittoken
       if @user

data/spec/fake_media_wiki/app.rb

@@ -252,6 +252,27 @@ module FakeMediaWiki
       end
     end
 
+    def get_userrights_token(username)
+      @token.set_type 'userrights'
+      token_str = @token.request(user)
+      
+      user_to_manage = @users[username]
+      
+      if user_to_manage
+        api_response do |_|
+          _.query do
+            _.users do
+              _.user(nil, { :name => user_to_manage[:username], :userrightstoken => token_str })
+            end
+          end
+        end
+      else
+        api_response do |_|
+          _.error(nil, { :code => 'nosuchuser', :info => "The user '#{params[:ususer].to_s}' does not exist"} )
+        end
+      end
+    end    
+
     def login
       user = @users[params[:lgname]]
       if user and user[:domain] == params[:lgdomain]
@@ -271,6 +292,23 @@ module FakeMediaWiki
       end
     end
 
+    def userrights
+      api_response do |_|
+        _.userrights({:user => params[:user]}) do
+          _.removed do
+            params[:remove].split('|').each do |removed_group|
+              _.group(removed_group)
+            end
+          end
+          _.added do
+            params[:add].split('|').each do |added_group|
+              _.group(added_group)
+            end
+          end
+        end
+      end
+    end
+
   end
 
   class WikiPage

data/spec/fake_media_wiki/query_handling.rb

@@ -3,6 +3,13 @@ module FakeMediaWiki
   
   module QueryHandling
 
+    def action
+      [:userrights].each do |action_type|
+        return send(action_type)
+      end
+      halt(404, "Page not found")
+    end
+
     def query
       [:prop, :export, :list, :meta].each do |query_type|
         return send(query_type) if params[query_type]
@@ -37,6 +44,14 @@ module FakeMediaWiki
     
     def list
       list_type = params[:list].to_sym
+
+      # api.php?action=query&list=users&ususers=Bob&ustoken=userrights
+      if list_type == :users && params[:ustoken] && params[:ususers]
+        # This "list" is actually a request for a user rights token
+        return get_userrights_token(params[:ususers])
+      end
+      
+      # This is a real list
       return send(list_type) if respond_to?(list_type)
       halt(404, "Page not found")
     end
@@ -108,6 +123,7 @@ module FakeMediaWiki
         end
       end
     end
+    
   end
 
 end

data/spec/gateway_spec.rb

@@ -144,7 +144,7 @@ describe MediaWiki::Gateway do
         end
         
       end
-  
+
     end
   
   end
@@ -733,5 +733,64 @@ describe MediaWiki::Gateway do
     form_data['createonly'] = "" unless options[:overwrite]
     @gateway.send(:make_api_request, form_data)
   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(StandardError)
+        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
+          Hash.from_xml(@result.to_s).should == Hash.from_xml(userrights_response)
+        end
+        
+      end
+      
+    end
+  end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Jani Patokallio
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-28 00:00:00 +11:00
+date: 2011-03-30 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency