mediawiki_api 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4033e20e939a4e529667d68f9980dbecbf546e39
-  data.tar.gz: 26a103f6d54867b344c0e8542d42cbb58ae5ecb1
+  metadata.gz: 7b76c6bc6c035d11d6b3690aba25961df0472eac
+  data.tar.gz: bf35918e838839955bc6e3897ce8bfe865c26d70
 SHA512:
-  metadata.gz: 3b9163974f7c7dcbfcf57de36c9339c978a856c5d199d2cd4706ac3a06d34e4ef8b4c110975fd601a27f5d1c0e19936c24d116f4fb8bd3f7195e68f34954d1fa
-  data.tar.gz: 7cc523a723658d551cff463f92aa20d78810fd21f2e66bab690aa229815619bd75bcaf1254ea6b0a39c90b13a8c813a74d3af83342d0a9e7609ccdec7948017e
+  metadata.gz: 33b30d02eb1ab3cf1044875a5903a516e0d55638e5c60c93b29545ef9cfd34270ee32e50a8c0c67e55fadc6451048b084c6d8c44e4107934ca917ace7f62d6df
+  data.tar.gz: 899a279b3499c720ddd38d3c6ce883613d54c4c9f32cb67e4e40098aff9bc7bf8b09d43e1cbddf7b7058c4fe4a162e8a1e1a01335deaafb8c4ca42dbbc75b4fc

data/README.md

@@ -65,6 +65,11 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 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
+  infinite recursion in cases where authentication is repeatedly unsuccessful.
+
 ### 0.4.1 2015-06-17
 - Allow for response-less ApiError exceptions to make mocking in tests easier
 

data/lib/mediawiki_api/client.rb

@@ -10,18 +10,22 @@ module MediawikiApi
   class Client
     FORMAT = 'json'
 
+    attr_reader :cookies
     attr_accessor :logged_in
 
     alias_method :logged_in?, :logged_in
 
     def initialize(url, log = false)
+      @cookies = HTTP::CookieJar.new
+
       @conn = Faraday.new(url: url) do |faraday|
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.response :logger if log
-        faraday.use :cookie_jar
+        faraday.use :cookie_jar, jar: @cookies
         faraday.adapter Faraday.default_adapter
       end
+
       @logged_in = false
       @tokens = {}
     end
@@ -89,6 +93,7 @@ module MediawikiApi
         @logged_in = true
         @tokens.clear
       when 'NeedToken'
+        raise LoginError, "failed to log in with the returned token '#{token}'" unless token.nil?
         data = log_in(username, password, data['token'])
       else
         raise LoginError, data['result']

data/lib/mediawiki_api/version.rb

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

data/spec/client_spec.rb

@@ -172,8 +172,28 @@ describe MediawikiApi::Client do
     end
   end
 
-  describe '#log_in' do
+  describe '#cookies' do
+    subject { client.cookies }
+
+    it { is_expected.to be_a(HTTP::CookieJar) }
+
+    context 'when a new cookie is added' do
+      before do
+        client.cookies.add(HTTP::Cookie.new('cookie_name', '1', domain: 'localhost', path: '/'))
+      end
+
+      it 'includes the cookie in subsequent requests' do
+        stub_token_request('csrf')
+        request = stub_action_request('foo').with(headers: { 'Cookie' => 'cookie_name=1' })
 
+        client.action(:foo)
+
+        expect(request).to have_been_requested
+      end
+    end
+  end
+
+  describe '#log_in' do
     it 'logs in when API returns Success' do
       stub_request(:post, api_url).
         with(body: { format: 'json', action: 'login', lgname: 'Test', lgpassword: 'qwe123' }).
@@ -184,39 +204,48 @@ describe MediawikiApi::Client do
     end
 
     context 'when API returns NeedToken' do
-      before do
-        stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'login', lgname: 'Test', lgpassword: 'qwe123' }).
-          to_return(
-            body: { login: body_base.merge(result: 'NeedToken', token: '456') }.to_json,
-            headers: { 'Set-Cookie' => 'prefixSession=789; path=/; domain=localhost; HttpOnly' }
-          )
+      context 'and a token was not given' do
+        before do
+          stub_login_request('Test', 'qwe123').
+            to_return(
+              body: { login: body_base.merge(result: 'NeedToken', token: '456') }.to_json,
+              headers: { 'Set-Cookie' => 'prefixSession=789; path=/; domain=localhost; HttpOnly' }
+            )
+
+          @success_req = stub_login_request('Test', 'qwe123', '456').
+            with(headers: { 'Cookie' => 'prefixSession=789' }).
+            to_return(body: { login: body_base.merge(result: 'Success') }.to_json)
+        end
 
-        @success_req = stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'login',
-                       lgname: 'Test', lgpassword: 'qwe123', lgtoken: '456' }).
-          with(headers: { 'Cookie' => 'prefixSession=789' }).
-          to_return(body: { login: body_base.merge(result: 'Success') }.to_json)
-      end
+        it 'logs in' do
+          response = subject.log_in('Test', 'qwe123')
 
-      it 'logs in' do
-        response = subject.log_in('Test', 'qwe123')
+          expect(response).to include('result' => 'Success')
+          expect(subject.logged_in).to be true
+        end
 
-        expect(response).to include('result' => 'Success')
-        expect(subject.logged_in).to be true
+        it 'sends second request with token and cookies' do
+          subject.log_in('Test', 'qwe123')
+
+          expect(@success_req).to have_been_requested
+        end
       end
 
-      it 'sends second request with token and cookies' do
-        subject.log_in('Test', 'qwe123')
+      context 'but a token was already provided' do
+        subject { client.log_in('Test', 'qwe123', '123') }
 
-        expect(@success_req).to have_been_requested
+        it 'should raise a LoginError' do
+          stub_login_request('Test', 'qwe123', '123').
+            to_return(body: { login: body_base.merge(result: 'NeedToken', token: '456') }.to_json)
+
+          expect { subject }.to raise_error(MediawikiApi::LoginError)
+        end
       end
     end
 
     context 'when API returns neither Success nor NeedToken' do
       before do
-        stub_request(:post, api_url).
-          with(body: { format: 'json', action: 'login', lgname: 'Test', lgpassword: 'qwe123' }).
+        stub_login_request('Test', 'qwe123').
           to_return(body: { login: body_base.merge(result: 'EmptyPass') }.to_json)
       end
 

data/spec/support/request_helpers.rb

@@ -26,6 +26,13 @@ module MediawikiApi
       stub_api_request(method, params.merge(action: action, token: mock_token))
     end
 
+    def stub_login_request(username, password, token = nil)
+      params = { action: 'login', lgname: username, lgpassword: password }
+      params[:lgtoken] = token unless token.nil?
+
+      stub_api_request(:post, params)
+    end
+
     def stub_token_request(type, warning = nil)
       response = { query: { tokens: { "#{type}token" => mock_token } } }
       response[:warnings] = { type => { '*' => [warning] } } unless warning.nil?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Amir Aharoni
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday