mediawiki_api 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b76c6bc6c035d11d6b3690aba25961df0472eac
-  data.tar.gz: bf35918e838839955bc6e3897ce8bfe865c26d70
+  metadata.gz: 176f86e086fb5b9c2a275cade16f2199c7a662b8
+  data.tar.gz: da273be34eff6481902b5e30621f0c08ba481af1
 SHA512:
-  metadata.gz: 33b30d02eb1ab3cf1044875a5903a516e0d55638e5c60c93b29545ef9cfd34270ee32e50a8c0c67e55fadc6451048b084c6d8c44e4107934ca917ace7f62d6df
-  data.tar.gz: 899a279b3499c720ddd38d3c6ce883613d54c4c9f32cb67e4e40098aff9bc7bf8b09d43e1cbddf7b7058c4fe4a162e8a1e1a01335deaafb8c4ca42dbbc75b4fc
+  metadata.gz: 5a76cf068332b572df322dfd3d98a76c6a018f1213aee4585f1cc94e787e15edc5678e6df2b2002d41fd37f61baf3601c569397a6c210cf1d261317e878702b8
+  data.tar.gz: cc667e15712a3acf66b26f88f366ee468606e50081dc18f72909b65ec6c23d9cd5093db8c8b3cf214512f20262b80307d026c739ca636b0829de5d48b2d81d0b

data/README.md

@@ -65,6 +65,10 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.6.0 2016-05-25
+- Update account creation code for AuthManager. This change updates the gem to test which API
+  flavor is in use, then send requests accordingly.
+
 ### 0.5.0 2015-09-04
 - Client cookies can now be read and modified via MediawikiApi::Client#cookies.
 - Logging in will recurse upon a `NeedToken` API error only once to avoid

data/Rakefile

@@ -0,0 +1,19 @@
+# pre-flight
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new(:yard)
+
+task default: [:test]
+
+desc 'Run all build/tests commands (CI entry point)'
+task test: [:build, :rubocop, :spec, :yard]
+
+desc 'Generate all documentations'
+task doc: [:yard]

data/lib/mediawiki_api/client.rb

@@ -41,7 +41,44 @@ module MediawikiApi
       end
     end
 
-    def create_account(username, password, token = nil)
+    def create_account(username, password)
+      params = { modules: 'createaccount', token_type: false }
+      d = action(:paraminfo, params).data
+      params = d['modules'] && d['modules'][0] && d['modules'][0]['parameters']
+      if !params || !params.map
+        raise CreateAccountError, 'unexpected API response format'
+      end
+      params = params.map{ |o| o['name'] }
+
+      if params.include? 'requests'
+        create_account_new(username, password)
+      else
+        create_account_old(username, password)
+      end
+    end
+
+    def create_account_new(username, password)
+      # post-AuthManager
+      data = action(:query, { meta: 'tokens', type: 'createaccount', token_type: false }).data
+      token = data['tokens'] && data['tokens']['createaccounttoken']
+      unless token
+        raise CreateAccountError, 'failed to get createaccount API token'
+      end
+
+      data = action(:createaccount, {
+        username: username,
+        password: password,
+        retype: password,
+        createreturnurl: 'http://example.com', # won't be used but must be a valid URL
+        createtoken: token,
+        token_type: false
+      }).data
+      raise CreateAccountError, data['message'] if data['status'] != 'PASS'
+      data
+    end
+
+    def create_account_old(username, password, token = nil)
+      # pre-AuthManager
       params = { name: username, password: password, token_type: false }
       params[:token] = token unless token.nil?
 
@@ -52,7 +89,7 @@ module MediawikiApi
         @logged_in = true
         @tokens.clear
       when 'NeedToken'
-        data = create_account(username, password, data['token'])
+        data = create_account_old(username, password, data['token'])
       else
         raise CreateAccountError, data['result']
       end

data/lib/mediawiki_api/version.rb

@@ -1,4 +1,4 @@
 # MediaWiki Ruby API
 module MediawikiApi
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

data/spec/client_spec.rb

@@ -335,57 +335,126 @@ describe MediawikiApi::Client do
   end
 
   describe '#create_account' do
-    it 'creates an account when API returns Success' do
-      stub_request(:post, api_url).
-        with(body: { format: 'json', action: 'createaccount', name: 'Test', password: 'qwe123' }).
-        to_return(body: { createaccount: body_base.merge(result: 'Success') }.to_json)
-
-      expect(subject.create_account('Test', 'qwe123')).to include('result' => 'Success')
-    end
-
-    context 'when API returns NeedToken' do
+    context 'when the old createaccount API is used' do
       before do
         stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'createaccount',
-                       name: 'Test', password: 'qwe123' }).
-          to_return(
-            body: { createaccount: body_base.merge(result: 'NeedToken', token: '456') }.to_json,
-            headers: { 'Set-Cookie' => 'prefixSession=789; path=/; domain=localhost; HttpOnly' }
-          )
+          with(body: { action: 'paraminfo', format: 'json', modules: 'createaccount' }).
+          to_return(body: { paraminfo: body_base.merge(modules: [{ parameters: [] }]) }.to_json)
+      end
 
-        @success_req = stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'createaccount',
-                       name: 'Test', password: 'qwe123', token: '456' }).
-          with(headers: { 'Cookie' => 'prefixSession=789' }).
+      it 'creates an account when API returns Success' do
+        stub_request(:post, api_url).
+          with(body: { format: 'json', action: 'createaccount', name: 'Test', password: 'qwe123' }).
           to_return(body: { createaccount: body_base.merge(result: 'Success') }.to_json)
-      end
 
-      it 'creates an account' do
         expect(subject.create_account('Test', 'qwe123')).to include('result' => 'Success')
       end
 
-      it 'sends second request with token and cookies' do
-        subject.create_account 'Test', 'qwe123'
-        expect(@success_req).to have_been_requested
+      context 'when API returns NeedToken' do
+        before do
+          stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'createaccount',
+                         name: 'Test', password: 'qwe123' }).
+            to_return(
+              body: { createaccount: body_base.merge(result: 'NeedToken', token: '456') }.to_json,
+              headers: { 'Set-Cookie' => 'prefixSession=789; path=/; domain=localhost; HttpOnly' }
+            )
+
+          @success_req = stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'createaccount',
+                         name: 'Test', password: 'qwe123', token: '456' }).
+            with(headers: { 'Cookie' => 'prefixSession=789' }).
+            to_return(body: { createaccount: body_base.merge(result: 'Success') }.to_json)
+        end
+
+        it 'creates an account' do
+          expect(subject.create_account('Test', 'qwe123')).to include('result' => 'Success')
+        end
+
+        it 'sends second request with token and cookies' do
+          subject.create_account 'Test', 'qwe123'
+          expect(@success_req).to have_been_requested
+        end
+      end
+
+      # docs don't specify other results, but who knows
+      # http://www.mediawiki.org/wiki/API:Account_creation
+      context 'when API returns neither Success nor NeedToken' do
+        before do
+          stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'createaccount',
+                         name: 'Test', password: 'qwe123' }).
+            to_return(body: { createaccount: body_base.merge(result: 'WhoKnows') }.to_json)
+        end
+
+        it 'raises error with proper message' do
+          expect { subject.create_account 'Test', 'qwe123' }.to raise_error(
+            MediawikiApi::CreateAccountError,
+            'WhoKnows'
+          )
+        end
       end
     end
 
-    # docs don't specify other results, but who knows
-    # http://www.mediawiki.org/wiki/API:Account_creation
-    context 'when API returns neither Success nor NeedToken' do
+    context 'when the new createaccount API is used' do
       before do
         stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'createaccount',
-                       name: 'Test', password: 'qwe123' }).
-          to_return(body: { createaccount: body_base.merge(result: 'WhoKnows') }.to_json)
+          with(body: { action: 'paraminfo', format: 'json', modules: 'createaccount' }).
+                  to_return(body: { paraminfo: body_base.merge(
+                    modules: [{ parameters: [{ name: 'requests' }] }]
+                  ) }.to_json)
       end
 
-      it 'raises error with proper message' do
+      it 'raises an error when fetching a token fails' do
+        stub_request(:post, api_url).
+          with(body: { action: 'query', format: 'json', meta: 'tokens', type: 'createaccount' }).
+          to_return(body: { tokens: body_base.merge(foo: '12345\\+')  }.to_json)
         expect { subject.create_account 'Test', 'qwe123' }.to raise_error(
           MediawikiApi::CreateAccountError,
-          'WhoKnows'
+          'failed to get createaccount API token'
         )
       end
+
+      context 'when fetching a token succeeds' do
+        before do
+          stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'query', meta: 'tokens', type: 'createaccount' }).
+            to_return(body: { tokens: body_base.merge(createaccounttoken: '12345\\+') }.to_json)
+        end
+
+        it 'creates an account when the API returns success' do
+          stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'createaccount',
+                         createreturnurl: 'http://example.com', username: 'Test',
+                         password: 'qwe123', retype: 'qwe123', createtoken: '12345\\+' }).
+            to_return(body: { createaccount: body_base.merge(status: 'PASS') }.to_json)
+          expect(subject.create_account('Test', 'qwe123')).to include('status' => 'PASS')
+        end
+
+        it 'raises an error when the API returns failure' do
+          stub_request(:post, api_url).
+            with(body: { format: 'json', action: 'createaccount',
+                         createreturnurl: 'http://example.com', username: 'Test',
+                         password: 'qwe123', retype: 'qwe123', createtoken: '12345\\+' }).
+            to_return(body: { createaccount: body_base.merge(
+              status: 'FAIL', message: 'User exists!'
+            ) }.to_json)
+          expect { subject.create_account 'Test', 'qwe123' }.to raise_error(
+            MediawikiApi::CreateAccountError,
+            'User exists!'
+          )
+        end
+      end
+    end
+
+    it 'raises an error when the paraminfo query result is weird' do
+      stub_request(:post, api_url).
+        with(body: { action: 'paraminfo', format: 'json', modules: 'createaccount' }).
+        to_return(body: { paraminfo: body_base.merge(modules: []) }.to_json)
+      expect { subject.create_account 'Test', 'qwe123' }.to raise_error(
+        MediawikiApi::CreateAccountError,
+        'unexpected API response format'
+      )
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Amir Aharoni
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2016-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,6 +188,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
 - lib/mediawiki_api.rb
 - lib/mediawiki_api/client.rb
 - lib/mediawiki_api/exceptions.rb
@@ -219,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A library for interacting with MediaWiki API from Ruby.