mediawiki_api 0.7.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 24c2b441979ef1590276ba7b44a9249bff5ba4cb
-  data.tar.gz: ffd490cd3b960e2e9ae25b5bff202ffe81c7b23f
+SHA256:
+  metadata.gz: b62379a3d8c9db42e6eef936b187f5e7ec8580d85470e06664aa77b61f84231a
+  data.tar.gz: 510e690f5ea8d2c9bd4ce6b494de54eb9b4ef055394b3cd28ff1808ee5887b74
 SHA512:
-  metadata.gz: 9b55c5b713e3a46ea705e4b57b937c1e1e7e2f0bf9828dec4036a78c837c58ecc2753f47b38589b442224460802ed7c8e1236265e0fda2549d12b37ff5b15f7d
-  data.tar.gz: 483b24f63f2c2ea9928a81d58762bed2783442e2883848f4170cefdd27d0c854125b7d9ea2128832b33239c1b21c1afe2499bd7383413443730fb037e039f4b3
+  metadata.gz: 2e9d1d43095b11d1741dacb0d277961f7880ac31ae2979a09acbe187969b69083ff8b99d929c0deff1e8f2eaf4ee1171ecd65b63438ee766cd77252584fa8f3f
+  data.tar.gz: 698a6310751aa185f48da78e4eb0c18453c1fef663186a9829a756497878e341f37cd9869bd9861260c5336d5a61f4f966830ff55c1dabb34c14db95023bb503

data/.gitignore

@@ -6,3 +6,5 @@
 .gem
 Gemfile.lock
 *.gem
+.idea/
+.vscode/

data/.rubocop.yml

@@ -1,7 +1,13 @@
+# require: rubocop-rspec # make specs compliant one day
+# until then:
+
 AllCops:
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
   StyleGuideCopsOnly: true
+  NewCops: enable
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 100
 
 Metrics/MethodLength:
@@ -10,7 +16,7 @@ Metrics/MethodLength:
 Style/Alias:
   Enabled: false
 
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: trailing
 
 Style/SignalException:
@@ -21,3 +27,7 @@ Style/StringLiterals:
 
 Style/TrivialAccessors:
   ExactNameMatch: true
+
+# See https://github.com/bbatsov/rubocop/issues/4637
+Layout/SpaceAroundOperators:
+  Enabled: false

data/.yardopts

@@ -1 +1,2 @@
 --title "MediaWiki Ruby API"
+- '*.md'

data/CREDITS

@@ -2,11 +2,11 @@ mediawiki_ruby_api_client is a collaborative project released under the
 GNU General Public License v2. We would like to recognize the
 following names for their contribution to the product.
 
-For further details on licensing, see the LICENSE file.
+For further details on licensing, see the LICENSE.md file.
 
 == Developers ==
 * Amir Aharoni
-* Asaf Bartov
+* [Asaf Bartov](https://github.com/abartov) (current maintainer)
 * Chris McMahon
 * Dan Duvall
 * Jeff Hall

data/Gemfile

@@ -1,6 +1,3 @@
-# ruby=ruby-2.1.2
-# ruby-gemset=mediawiki_api
-
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mediawiki_api.gemspec

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,6 @@
-== License and copyright information ==
+# License and copyright information
 
-=== License ===
+## License
 
 MediaWiki is licensed under the terms of the GNU General Public License,
 version 2 or later. Derivative works and later versions of the code must be
@@ -12,12 +12,12 @@ For the full text of version 2 of the license, see
 https://www.gnu.org/licenses/gpl-2.0.html or '''GNU General Public License'''
 below.
 
-=== Copyright owners ===
+## Copyright owners
 
 MediaWiki contributors, including those listed in the CREDITS file, hold the
 copyright to this work.
 
-=== Additional license information ===
+## Additional license information
 
 Some components of MediaWiki imported from other projects may be under other
 Free and Open Source, or Free Culture, licenses. Specific details of their
@@ -36,7 +36,7 @@ CC licenses:
 These icons are trademarked, and used subject to the CC trademark license,
 available at http://creativecommons.org/policies#trademark
 
-== GNU GENERAL PUBLIC LICENSE ==
+# GNU GENERAL PUBLIC LICENSE
 
 Version 2, June 1991
 
@@ -45,7 +45,7 @@ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.
 
-=== Preamble ===
+## Preamble
 
 The licenses for most software are designed to take away your
 freedom to share and change it.  By contrast, the GNU General Public
@@ -95,7 +95,7 @@ patent must be licensed for everyone's free use or not licensed at all.
 The precise terms and conditions for copying, distribution and
 modification follow.
 
-== TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION ==
+# TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 
 '''0.''' This License applies to any program or other work which contains
 a notice placed by the copyright holder saying it may be distributed
@@ -293,7 +293,7 @@ make exceptions for this.  Our decision will be guided by the two goals
 of preserving the free status of all derivatives of our free software and
 of promoting the sharing and reuse of software generally.
 
-=== NO WARRANTY ===
+## NO WARRANTY
 
 '''11.''' BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
@@ -317,7 +317,7 @@ POSSIBILITY OF SUCH DAMAGES.
 
    '''END OF TERMS AND CONDITIONS'''
 
-== How to Apply These Terms to Your New Programs ==
+# How to Apply These Terms to Your New Programs
 
 If you develop a new program, and you want it to be of the greatest
 possible use to the public, the best way to achieve this is to make it

data/README.md

@@ -26,6 +26,7 @@ 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.set_oauth_access_token("user_oauth_token") # INSTEAD of logging in, will make all actions as the user authenticated via OAuth
 client.create_account "username", "password" # will not work on wikis that require CAPTCHA, like Wikipedia
 client.create_page "title", "content"
 client.get_wikitext "title"
@@ -65,6 +66,14 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.9.0 2024-05-06
+- Upgraded underlying Faraday gem to 2.x (> 2.7.0)
+- Updated required Ruby to 2.6.x
+
+### 0.8.0 2023-10-26
+- Add `oauth_access_token`, allowing authenticated actions on behalf of users via [Wikimedia's OAuth service](https://www.mediawiki.org/wiki/OAuth/For_Developers). Obtaining the access token is up to this gem's user. In Ruby, one can use the `[oauth2](https://gitlab.com/oauth-xx/oauth2/)` gem. A working example can be seen in the source code of [the Luthor tool](https://gitlab.wikimedia.org/toolforge-repos/luthor/-/blob/master/app/controllers/usage_controller.rb).
+- New maintainer: @abartov
+
 ### 0.7.1 2017-01-31
 - Add `text` param to `MediawikiApi::Client#upload_image`
 
@@ -137,3 +146,7 @@ See https://www.mediawiki.org/wiki/Gerrit
 ### 0.0.1 2014-02-07
 
 - Added MediawikiApi#create_article and #create_user.
+
+## {file:LICENSE.md}
+
+© Copyright 2013-2023, Wikimedia Foundation & Contributors. Released under the terms of the GNU General Public License, version 2 or later.

data/Rakefile

@@ -13,7 +13,7 @@ YARD::Rake::YardocTask.new(:yard)
 task default: [:test]
 
 desc 'Run all build/tests commands (CI entry point)'
-task test: [:build, :rubocop, :spec, :yard]
+task test: %i[build rubocop spec yard]
 
 desc 'Generate all documentations'
 task doc: [:yard]

data/lib/mediawiki_api/client.rb

@@ -1,6 +1,7 @@
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/multipart'
 require 'faraday-cookie_jar'
+require 'faraday/follow_redirects'
 require 'json'
 
 require 'mediawiki_api/exceptions'
@@ -16,7 +17,7 @@ module MediawikiApi
 
     alias_method :logged_in?, :logged_in
 
-    def initialize(url, log = false)
+    def initialize(url, log: false)
       @cookies = HTTP::CookieJar.new
 
       @conn = Faraday.new(url: url) do |faraday|
@@ -24,7 +25,7 @@ module MediawikiApi
         faraday.request :url_encoded
         faraday.response :logger if log
         faraday.use :cookie_jar, jar: @cookies
-        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.response :follow_redirects
         faraday.adapter Faraday.default_adapter
       end
 
@@ -35,21 +36,23 @@ module MediawikiApi
     def action(name, params = {})
       raw_action(name, params)
     rescue ApiError => e
-      if e.code == 'badtoken'
-        @tokens.clear # ensure fresh token on re-try
-        raw_action(name, params) # no rescue this time; only re-try once.
-      else
-        raise # otherwise, propagate the exception
-      end
+      # propagate the exception
+      raise unless e.code == 'badtoken'
+      @tokens.clear # ensure fresh token on re-try
+      raw_action(name, params) # no rescue this time; only re-try once.
+    end
+
+    # set the OAuth access token to be used for all subsequent actions
+    # (obtaining the token is up to you)
+    def oauth_access_token(access_token)
+      @conn.headers['Authorization'] = "Bearer #{access_token}"
     end
 
     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
+      raise CreateAccountError, 'unexpected API response format' if !params || !params.map
       params = params.map{ |o| o['name'] }
 
       if params.include? 'requests'
@@ -63,9 +66,7 @@ module MediawikiApi
       # 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
+      raise CreateAccountError, 'failed to get createaccount API token' unless token
 
       data = action(:createaccount, {
         username: username,

data/lib/mediawiki_api/response.rb

@@ -89,7 +89,7 @@ module MediawikiApi
       if !obj.is_a?(Hash) || env.nil? || env.empty? || !obj.include?(env.first)
         obj
       else
-        open_envelope(obj[env.first], env[1..-1])
+        open_envelope(obj[env.first], env[1..])
       end
     end
 

data/lib/mediawiki_api/version.rb

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

data/mediawiki_api.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mediawiki_api/version'
@@ -18,21 +17,30 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A library for interacting with MediaWiki API from Ruby.'
   spec.description   = 'Uses adapter-agnostic Faraday gem to talk to MediaWiki API.'
   spec.homepage      = 'https://github.com/wikimedia/mediawiki-ruby-api'
-  spec.license       = 'GPL-2'
+  spec.license       = 'GPL-2.0'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.test_files    = spec.files.grep(/^(test|spec|features)/)
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.0'
-  spec.add_runtime_dependency 'faraday-cookie_jar', '~> 0.0', '>= 0.0.6'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10', '>= 0.10.0'
+  spec.required_ruby_version = '>= 2.6.0'
 
-  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.29.1'
-  spec.add_development_dependency 'webmock', '~> 1.17', '>= 1.17.2'
+  spec.add_runtime_dependency 'faraday', '>= 2.7.0'
+  spec.add_runtime_dependency 'faraday-multipart'
+  spec.add_runtime_dependency 'faraday-retry'
+  spec.add_runtime_dependency 'faraday-cookie_jar'
+  spec.add_runtime_dependency 'faraday-follow_redirects'
+
+  # Most developer dependencies can float to latest, but stick to RSpec 3
+  # since that would likely introduce breaking changes (bundler, rubocop
+  # and rake have excellent back-compat)
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'redcarpet'
   spec.add_development_dependency 'yard'
 end

data/spec/client_spec.rb

@@ -91,7 +91,7 @@ describe MediawikiApi::Client do
       end
 
       context 'array parameters' do
-        let(:params) { { foo: %w(one two) } }
+        let(:params) { { foo: %w[one two] } }
 
         before do
           @request = stub_action_request(action, foo: 'one|two').to_return(response)
@@ -141,6 +141,21 @@ describe MediawikiApi::Client do
       end
     end
 
+    context 'when an OAuth access token was supplied' do
+      before do
+        client.oauth_access_token('my_token')
+      end
+
+      it 'includes the OAuth access token in an Authorization: Bearer header' do
+        stub_token_request('csrf')
+        request = stub_action_request('foo').with(headers: { 'Authorization' => 'Bearer my_token' })
+
+        client.action(:foo)
+
+        expect(request).to have_been_requested
+      end
+    end
+
     context 'when the token response includes only other types of warnings (see bug 70066)' do
       let(:token_warning) do
         'action=tokens has been deprecated. Please use action=query&meta=tokens instead.'

data/spec/response_spec.rb

@@ -28,14 +28,14 @@ describe MediawikiApi::Response do
       end
 
       context 'and a multi-level envelope' do
-        let(:envelope) { %w(query result) }
+        let(:envelope) { %w[query result] }
         let(:nested_object) { response_object['query']['result'] }
 
         it { is_expected.to eq(nested_object) }
       end
 
       context "and a multi-level envelope that doesn't completely match" do
-        let(:envelope) { %w(query something) }
+        let(:envelope) { %w[query something] }
         let(:partially_nested_object) { response_object['query'] }
 
         it { is_expected.to eq(partially_nested_object) }
@@ -46,7 +46,7 @@ describe MediawikiApi::Response do
       let(:body) { '[ "something" ]' }
 
       context 'with any expected envelope' do
-        let(:envelope) { %w(what ever) }
+        let(:envelope) { %w[what ever] }
 
         it { is_expected.to eq(response_object) }
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Amir Aharoni
@@ -11,97 +11,107 @@ authors:
 - Jeff Hall
 - Juliusz Gonera
 - Zeljko Filipin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2024-05-07 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'
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '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
+        version: '0'
   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
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !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
@@ -110,54 +120,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: '0'
 - !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
+        version: '0'
   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
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +232,7 @@ files:
 - ".yardopts"
 - CREDITS
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/mediawiki_api.rb
@@ -222,9 +248,9 @@ files:
 - spec/support/request_helpers.rb
 homepage: https://github.com/wikimedia/mediawiki-ruby-api
 licenses:
-- GPL-2
+- GPL-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -232,16 +258,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.7
-signing_key: 
+rubygems_version: 3.5.7
+signing_key:
 specification_version: 4
 summary: A library for interacting with MediaWiki API from Ruby.
 test_files:
@@ -250,4 +275,3 @@ test_files:
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/request_helpers.rb
-has_rdoc: