mediawiki-gateway 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9348630e11f96f1c356898c7c788f0a92331da51
-  data.tar.gz: 04cb698dc943616403ea27dbbfc9ab02a89b1cc8
+  metadata.gz: 3bf439067ecdc78862001617673b8f7eca06812b
+  data.tar.gz: 2bc0d1305900bbc69f8bd66ab3809d3fefa64849
 SHA512:
-  metadata.gz: 3103c1160612dd0edd49e5fde0e5a1af1ed08e49910185d45f37b0b82fcae2829d93cc8ac0e956441e0d65dc27fe96cb64a3850fe284c44cbee28ad04cc3a813
-  data.tar.gz: 77190501400ca7b3213cfcbe0de6a2683ac7324c0550007cf321538a7c1adeae55630e338d0ff965a9969fdea0db4a4ee282005733ad1748bc9f89bcf0159a18
+  metadata.gz: 1a357d4c39d1d86a2a493e1c0f954c8e5a3095eaa8d4afb6eeb583cbd8512744f0d011eae82914a4455f1fde499cd75dd18bd895bc1dd4d872b58b2e87a9205d
+  data.tar.gz: eaa97ac659108a0cf6fead74380619706c274309b8a7073aa64b22d7fa38a6492385895a0ee7a2312393aded3951c63ecc82c28b70c26b78f5694c9209a265de

data/ChangeLog

@@ -2,6 +2,21 @@
 
 = Revision history for mediawiki-gateway
 
+== 1.1.0 [2016-01-05]
+
+* Allow empty params for semantic_query.
+* Add a method to purge a page.  Pull request #93 by MusikAnimal.
+* Follow redirects if HTTP 301, 302 or 307 is returned.  Pull request #86
+  by Brandon Liu.
+* Change exception superclass to StandardError.  Pull request #85 by
+  Brandon Liu.
+* Fixed categorymembers to use new continue rules. Pull request #82
+  by Asaf Bartov.
+* Fix search to return nil if namespace not found.  Pull request #88 by
+  Alexander Adrianov.
+* Fixed MediaWiki::Gateway::Users#contributions to not continue when enough
+  contributions have been received. Pull request #79 by Michaël Witrant.
+
 == 1.0.0 [2014-10-31]
 
 * <b>Required Ruby version is now 1.9.3 or higher.</b>

data/README.md

@@ -2,6 +2,10 @@
 
 A Ruby framework for [MediaWiki API](http://www.mediawiki.org/wiki/API:Main_page) manipulation.
 
+**Note**: This library is not actively maintained and uses deprecated API methods.
+If you are starting a new project, please use the official Wikimedia Ruby client at
+https://github.com/wikimedia/mediawiki-ruby-api instead.
+
 ## Features
 
 * Simple, elegant syntax for common operations
@@ -9,7 +13,8 @@ A Ruby framework for [MediaWiki API](http://www.mediawiki.org/wiki/API:Main_page
 * List, search operations work around API limits to fetch all results
 * Support for maxlag detection and automated retries on 503
 * Integrated logging
-* Tested up to MediaWiki 1.23
+* Tested up to MediaWiki 1.24
+  * For 1.25+, you must skip deprecation warnings with `:ignorewarnings => true` in `MediaWiki::Gateway.new`.  See [issue #69](https://github.com/jpatokal/mediawiki-gateway/issues/69).
 * Should work with Ruby 1.9.3 and higher
 
 ## Links

data/lib/media_wiki/exception.rb

@@ -1,7 +1,7 @@
 module MediaWiki
 
   # General exception occurred within MediaWiki::Gateway, and parent class for MediaWiki::APIError, MediaWiki::Unauthorized.
-  class Exception < ::Exception
+  class Exception < ::StandardError
   end
 
   # Wrapper for errors returned by MediaWiki API.  Possible codes are defined in http://www.mediawiki.org/wiki/API:Errors_and_warnings.

data/lib/media_wiki/gateway.rb

@@ -127,7 +127,7 @@ module MediaWiki
     def make_api_request(form_data, continue_xpath = nil, retry_count = 1)
       form_data.update('format' => 'xml', 'maxlag' => @options[:maxlag])
 
-      http_send(@wiki_url, form_data, @headers.merge(cookies: @cookies)) { |response, &block|
+      http_send(@wiki_url, form_data, @headers.merge(cookies: @cookies)) do |response|
         if response.code == 503 && retry_count < @options[:retry_count]
           log.warn("503 Service Unavailable: #{response.body}.  Retry in #{@options[:retry_delay]} seconds.")
           sleep(@options[:retry_delay])
@@ -168,10 +168,11 @@ module MediaWiki
 
         return [doc, (continue_xpath && doc.elements['query-continue']) ?
           REXML::XPath.first(doc, continue_xpath) : nil]
-      }
+      end
     end
 
-    # Execute the HTTP request using either GET or POST as appropriate
+    # Execute the HTTP request using either GET or POST as appropriate.
+    # @yieldparam response
     def http_send url, form_data, headers, &block
       opts = @http_options.merge(url: url, headers: headers)
       opts[:method] = form_data['action'] == 'query' ? :get : :post
@@ -179,7 +180,20 @@ module MediaWiki
 
       log.debug("#{opts[:method].upcase}: #{form_data.inspect}, #{@cookies.inspect}")
 
-      RestClient::Request.execute(opts, &block)
+      RestClient::Request.execute(opts) do |response, request, result|
+        # When a block is passed to RestClient::Request.execute, we must
+        # manually handle response codes ourselves. If no block is passed,
+        # then redirects are automatically handled, but HTTP errors also
+        # result in exceptions being raised. For now, we manually check for
+        # HTTP 503 errors (see: #make_api_request), but we must also manually
+        # handle HTTP redirects.
+        if [301, 302, 307].include?(response.code) && request.method == :get
+          response = response.follow_redirection(request, result)
+        end
+
+        block.call(response)
+      end
+
     end
 
     # Get API XML response

data/lib/media_wiki/gateway/pages.rb

@@ -274,6 +274,7 @@ module MediaWiki
       def category_members(category, options = {})
         iterate_query('categorymembers', '//cm', 'title', 'cmcontinue', options.merge(
           'cmtitle' => category,
+          'continue' => '', # new format, per https://www.mediawiki.org/wiki/API:Query#Continuing_queries
           'cmlimit' => @options[:limit]
         ))
       end
@@ -341,6 +342,19 @@ module MediaWiki
         end
       end
 
+      # Purge MediaWiki page. Does not follow redirects.
+      #
+      # [page_titles] Page titles to purge
+      # [options] Hash of additional options
+      #
+      # Returns purge object
+      def purge(page_titles, options = {})
+        page = send_request(options.merge(
+          'action' => 'purge',
+          'titles' => page_titles
+        ))
+      end
+
       # Convenience wrapper for _langlinks_ returning the title in language _lang_ (ISO code) for a given article of pageid, if it exists, via the interlanguage link
       #
       # Example:

data/lib/media_wiki/gateway/query.rb

@@ -25,7 +25,7 @@ module MediaWiki
         if namespaces
           form_data['srnamespace'] = Array(namespaces).map! { |ns|
             namespaces_by_prefix[ns]
-          }.join('|')
+          }.compact.join('|')
         end
 
         begin
@@ -55,13 +55,13 @@ module MediaWiki
         if smw_version.to_f >= 1.7
           send_request(options.merge(
             'action' => 'ask',
-            'query'  => "#{query}|#{params.join('|')}"
+            'query'  => [query, *params].join('|')
           ))
         else
           send_request(options.merge(
             'action' => 'parse',
             'prop'   => 'text',
-            'text'   => "{{#ask:#{query}|#{params.push('format=list').join('|')}}}"
+            'text'   => "{{#ask:#{[query, 'format=list', *params].join('|')}}}"
           )).elements['parse/text'].text
         end
       end

data/lib/media_wiki/gateway/users.rb

@@ -37,8 +37,8 @@ module MediaWiki
 
       # Get user contributions
       #
-      # user: The user name
-      # count: Maximum number of contributions to retreive, or nil for all
+      # [user] The user name
+      # [count] Maximum number of contributions to retrieve, or nil for all
       # [options] Optional hash of options, eg. { 'ucnamespace' => 4 }.  See http://www.mediawiki.org/wiki/API:Usercontribs
       #
       # Returns array of hashes containing the "item" attributes defined here: http://www.mediawiki.org/wiki/API:Usercontribs
@@ -51,6 +51,7 @@ module MediaWiki
         )) { |element|
           result << hash = {}
           element.attributes.each { |key, value| hash[key] = value }
+          break if count && result.size >= count
         }
 
         count ? result.take(count) : result

data/lib/media_wiki/version.rb

@@ -3,7 +3,7 @@ module MediaWiki
   module Version
 
     MAJOR = 1
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     class << self

data/spec/media_wiki/live_gateway_spec.rb

@@ -753,7 +753,7 @@ end
 unless (pool_size = Integer(ENV['LIVE_POOL_SIZE'] || 2)) > 1
   warn 'Docker pool size must be greater than 1.'
 else
-  ENV.fetch('LIVE_VERSION', '1.23.4').split(/[\s:,]/).each { |version|
+  ENV.fetch('LIVE_VERSION', '1.23.7').split(/[\s:,]/).each { |version|
     describe_live(MediaWiki::Gateway, version: version, pool_size: pool_size) {
       include_examples 'live gateway'
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jani Patokallio
@@ -9,124 +9,124 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   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: nokogiri
   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: sham_rack
   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: sinatra
   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: hen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.8.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: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Ruby framework for MediaWiki API manipulation.
@@ -141,11 +141,6 @@ extra_rdoc_files:
 - ChangeLog
 - README.md
 files:
-- COPYING
-- ChangeLog
-- README.md
-- Rakefile
-- bin/mediawiki-gateway
 - lib/media_wiki.rb
 - lib/media_wiki/exception.rb
 - lib/media_wiki/fake_wiki.rb
@@ -158,6 +153,11 @@ files:
 - lib/media_wiki/utils.rb
 - lib/media_wiki/version.rb
 - lib/mediawiki-gateway.rb
+- bin/mediawiki-gateway
+- COPYING
+- ChangeLog
+- README.md
+- Rakefile
 - spec/data/import.xml
 - spec/media_wiki/gateway/files_spec.rb
 - spec/media_wiki/gateway/pages_spec.rb
@@ -174,47 +174,45 @@ licenses:
 metadata: {}
 post_install_message: |2+
 
-  mediawiki-gateway-1.0.0 [2014-10-31]:
+  mediawiki-gateway-1.1.0 [2016-01-05]:
 
-  * <b>Required Ruby version is now 1.9.3 or higher.</b>
-  * For better Unicode support, install the +unicode+ or +activesupport+ gem.
-  * API methods are grouped into submodules of MediaWiki::Gateway.
-  * MediaWiki::Utils has been added as a proper module.
-  * MediaWiki::FakeWiki has been added as a first-class citizen.
-  * MediaWiki::Config has been removed.
-  * MediaWiki::Gateway#send_request allows generic API requests.
-  * MediaWiki::Gateway::Query#custom_query has been made public.
-  * MediaWiki::Gateway::new learned +user_agent+ option.
-  * MediaWiki::Gateway#headers attribute has been exposed.
-  * MediaWiki::Gateway#wiki_url attribute has been exposed.
-  * Added +mediawiki-gateway+ command-line client.
-  * Changed or removed some of the dependencies.
-  * Housekeeping and internal refactoring.
+  * Allow empty params for semantic_query.
+  * Add a method to purge a page.  Pull request #93 by MusikAnimal.
+  * Follow redirects if HTTP 301, 302 or 307 is returned.  Pull request #86
+    by Brandon Liu.
+  * Change exception superclass to StandardError.  Pull request #85 by
+    Brandon Liu.
+  * Fixed categorymembers to use new continue rules. Pull request #82
+    by Asaf Bartov.
+  * Fix search to return nil if namespace not found.  Pull request #88 by
+    Alexander Adrianov.
+  * Fixed MediaWiki::Gateway::Users#contributions to not continue when enough
+    contributions have been received. Pull request #79 by Michaël Witrant.
 
 rdoc_options:
-- "--title"
-- mediawiki-gateway Application documentation (v1.0.0)
-- "--charset"
+- --title
+- mediawiki-gateway Application documentation (v1.1.0)
+- --charset
 - UTF-8
-- "--line-numbers"
-- "--all"
-- "--main"
+- --line-numbers
+- --all
+- --main
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Connect to the MediaWiki API.