mediawiki_api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2e13c62db930923fbfd515cb2029d9d43508b9a
-  data.tar.gz: dada9ee27c4c09a1a2c7a157828e16079beace62
+  metadata.gz: dd5041d5380d783963ff227ea117400d7ad7c942
+  data.tar.gz: b9019f1481fc05e4eeea1061cf09fd42f45ff20c
 SHA512:
-  metadata.gz: 145fc6da63febab8ffc18b4d32a6eda108232052fd927380357a7fdfc375eb482681c1ac339e3299f4fee62c3f05fac2e03d766cd401a891991af74a5eb35111
-  data.tar.gz: eba8ace9d4a58f8148c7e5601d6e216475fc0bce8612bd78bea5fab637a63ed46ffcd4b042cb9bad82d0ace755685d025c0b1d89ccf84567c9fc698aeccbf23e
+  metadata.gz: 222b03e90a95dbd7b8c65b9e6e05ab99d7e1edd404975c96d1dc1555db66c04fd4686e8d8c7c98d84d10f6237977123cf1287917b318fd3b15bef497f7f0fdca
+  data.tar.gz: af192c8a05c649a1d22bfcb97c9342bd6bb1ef6c0dec3fc7638c4dc2c0eec6f7c36dcf43d61c5e9aad7b8f9feae810bc0ee2d0c6328e94a224a2cadacd400cea

data/.rubocop.yml

@@ -1,24 +1,9 @@
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ParameterLists:
-  Enabled: false
+AllCops:
+  StyleGuideCopsOnly: true
 
 Metrics/LineLength:
   Max: 100
 
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -26,8 +11,13 @@ Style/Alias:
   Enabled: false
 
 Style/DotPosition:
-  Enabled: true
   EnforcedStyle: trailing
 
 Style/SignalException:
   Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/TrivialAccessors:
+  ExactNameMatch: true

data/README.md

@@ -26,12 +26,14 @@ require "mediawiki_api"
 
 client = MediawikiApi::Client.new "http://127.0.0.1:8080/w/api.php"
 client.log_in "username", "password" # default Vagrant username and password are "Admin", "vagrant"
-client.create_account "username", "password"
+client.create_account "username", "password" # will not work on wikis that require CAPTCHA, like Wikipedia
 client.create_page "title", "content"
 client.get_wikitext "title"
 client.protect_page "title", "reason", "protections" #  protections are optional, default is "edit=sysop|move=sysop"
 client.delete_page "title", "reason"
 client.upload_image "filename", "path", "comment", "ignorewarnings"
+client.watch "title"
+client.unwatch "title"
 client.meta :siteinfo, siprop: "extensions"
 client.prop :info, titles: "Some page"
 client.query titles: ["Some page", "Some other page"]
@@ -43,6 +45,15 @@ Any API action can be requested using `#action`. See the
 [MediaWiki API documentation](http://www.mediawiki.org/wiki/API) for supported
 actions and parameters.
 
+By default, the client will attempt to get a csrf token before attempting the
+action. For actions that do not require a token, you can specify
+`token_type: false` to avoid requesting the unnecessary token before the real
+request. For example:
+```client.action :parse, page: 'Main Page', token_type: false
+```
+
+
+
 ## Links
 
 MediaWiki API gem at: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/mediawiki/ruby/api), [GitHub](https://github.com/wikimedia/mediawiki-ruby-api), [RubyGems](https://rubygems.org/gems/mediawiki_api), [Code Climate](https://codeclimate.com/github/wikimedia/mediawiki-ruby-api).
@@ -54,6 +65,9 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.4.0 2015-06-16
+- use action=query&meta=tokens to fetch tokens, instead of deprecated action=tokens
+
 ### 0.3.1 2015-01-06
 - actions now automatically refresh token and re-submit action if first attempt returns 'badtoken'.
 

data/lib/mediawiki_api/client.rb

@@ -114,18 +114,18 @@ module MediawikiApi
     end
 
     def unwatch_page(title)
-      action(:watch, titles: title, unwatch: true)
+      action(:watch, token_type: 'watch', titles: title, unwatch: true)
     end
 
     def upload_image(filename, path, comment, ignorewarnings)
       file = Faraday::UploadIO.new(path, 'image/png')
       action(:upload,
-             token_type: 'edit', filename: filename, file: file, comment: comment,
+             filename: filename, file: file, comment: comment,
              ignorewarnings: ignorewarnings)
     end
 
     def watch_page(title)
-      action(:watch, titles: title)
+      action(:watch, token_type: 'watch', titles: title)
     end
 
     protected
@@ -145,14 +145,14 @@ module MediawikiApi
 
     def get_token(type)
       unless @tokens.include?(type)
-        response = action(:tokens, type: type, http_method: :get, token_type: false)
+        response = query(meta: 'tokens', type: type)
         parameter_warning = /Unrecognized value for parameter 'type'/
 
         if response.warnings? && response.warnings.grep(parameter_warning).any?
           raise TokenError, response.warnings.join(', ')
         end
 
-        @tokens[type] = response.data["#{type}token"]
+        @tokens[type] = response.data['tokens']["#{type}token"]
       end
 
       @tokens[type]
@@ -182,7 +182,7 @@ module MediawikiApi
       token_type = params.delete(:token_type)
       envelope = (params.delete(:envelope) || [name]).map(&:to_s)
 
-      params[:token] = get_token(token_type || name) unless token_type == false
+      params[:token] = get_token(token_type || :csrf) unless token_type == false
       params = compile_parameters(params)
 
       send_request(method, params.merge(action: name, format: FORMAT), envelope)

data/lib/mediawiki_api/version.rb

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

data/mediawiki_api.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
-  spec.add_development_dependency 'rubocop', '~> 0.26.1'
+  spec.add_development_dependency 'rubocop', '~> 0.29.1'
   spec.add_development_dependency 'webmock', '~> 1.17', '>= 1.17.2'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'yard'

data/spec/client_spec.rb

@@ -15,7 +15,7 @@ describe MediawikiApi::Client do
     subject { client.action(action, params) }
 
     let(:action) { 'something' }
-    let(:token_type) { action }
+    let(:token_type) { 'csrf' }
     let(:params) { {} }
 
     let(:response) do
@@ -221,7 +221,7 @@ describe MediawikiApi::Client do
       end
 
       it 'does not log in' do
-        expect { subject.log_in 'Test', 'qwe123' }.to raise_error
+        expect { subject.log_in 'Test', 'qwe123' }.to raise_error(MediawikiApi::LoginError)
         expect(subject.logged_in).to be false
       end
 
@@ -240,7 +240,7 @@ describe MediawikiApi::Client do
     let(:response) { {} }
 
     before do
-      stub_token_request(:edit)
+      stub_token_request('csrf')
       @edit_request = stub_action_request(:edit, title: title, text: text).
         to_return(body: response.to_json)
     end
@@ -254,8 +254,8 @@ describe MediawikiApi::Client do
   describe '#delete_page' do
     before do
       stub_request(:get, api_url).
-        with(query: { format: 'json', action: 'tokens', type: 'delete' }).
-        to_return(body: { tokens: { deletetoken: 't123' } }.to_json)
+        with(query: { format: 'json', action: 'query', meta: 'tokens', type: 'csrf' }).
+        to_return(body: { query: { tokens: { csrftoken: 't123' } } }.to_json)
       @delete_req = stub_request(:post, api_url).
         with(body: { format: 'json', action: 'delete',
                      title: 'Test', reason: 'deleting', token: 't123' })
@@ -276,7 +276,7 @@ describe MediawikiApi::Client do
     let(:response) { { edit: {} } }
 
     before do
-      stub_token_request(:edit)
+      stub_token_request('csrf')
       @edit_request = stub_action_request(:edit).to_return(body: response.to_json)
     end
 
@@ -363,8 +363,8 @@ describe MediawikiApi::Client do
   describe '#watch_page' do
     before do
       stub_request(:get, api_url).
-        with(query: { format: 'json', action: 'tokens', type: 'watch' }).
-        to_return(body: { tokens: { watchtoken: 't123' } }.to_json)
+        with(query: { format: 'json', action: 'query', meta: 'tokens', type: 'watch' }).
+        to_return(body: { query: { tokens: { watchtoken: 't123' } } }.to_json)
       @watch_req = stub_request(:post, api_url).
         with(body: { format: 'json', token: 't123', action: 'watch', titles: 'Test' })
     end
@@ -378,8 +378,8 @@ describe MediawikiApi::Client do
   describe '#unwatch_page' do
     before do
       stub_request(:get, api_url).
-        with(query: { format: 'json', action: 'tokens', type: 'watch' }).
-        to_return(body: { tokens: { watchtoken: 't123' } }.to_json)
+        with(query: { format: 'json', action: 'query', meta: 'tokens', type: 'watch' }).
+        to_return(body: { query: { tokens: { watchtoken: 't123' } } }.to_json)
       @watch_req = stub_request(:post, api_url).
         with(body: { format: 'json', token: 't123', action: 'watch',
                      titles: 'Test', unwatch: 'true' })

data/spec/support/request_helpers.rb

@@ -27,10 +27,10 @@ module MediawikiApi
     end
 
     def stub_token_request(type, warning = nil)
-      response = { tokens: { "#{type}token" => mock_token } }
+      response = { query: { tokens: { "#{type}token" => mock_token } } }
       response[:warnings] = { type => { '*' => [warning] } } unless warning.nil?
 
-      stub_api_request(:get, action: 'tokens', type: type).
+      stub_api_request(:get, action: 'query', meta: 'tokens', type: type).
         to_return(body: response.to_json)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Amir Aharoni
@@ -14,156 +14,156 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday-cookie_jar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.29.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.29.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.17.2
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Uses adapter-agnostic Faraday gem to talk to MediaWiki API.
@@ -179,11 +179,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .gitreview
-- .rspec
-- .rubocop.yml
-- .yardopts
+- ".gitignore"
+- ".gitreview"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
 - CREDITS
 - Gemfile
 - LICENSE.txt
@@ -208,17 +208,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: A library for interacting with MediaWiki API from Ruby.