mediawiki-butt 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d607878d899519bb2780c1e1b22e704d42e84ee0
-  data.tar.gz: c9e1672f535750b5c9cee2f1922f8c9fadf6a912
+  metadata.gz: 6ac2473bbed75da107401d8c5dceeca3e2ed6b3c
+  data.tar.gz: 36463ff0c4f70d87ce6d6f62994d7ff03cf4b47a
 SHA512:
-  metadata.gz: 5aff5ca892a0cad1a9db8a532d90117dbb7183487a0c1f326a223c295900147eae00d3f1f173d3157faed57054de8a67e4a1622fcbfa3f185c8b0806e97d5dd8
-  data.tar.gz: a1cc08cc6e86caeda0cf63b7f7179e224511ad5012b972bb4cf3b7b217974678081b1a5b1018fd664a2270718081512eb55b061dac579359b461735a0ee7ef41
+  metadata.gz: 208c930ffa7dc8913b4c2b51bc6a82a46f1f55319d2ba92bf33eb139579dfbb8dff5b17327636df5235e651f63381ae4c808f84263868ca931a0cf1c9232035e
+  data.tar.gz: ef133085ca55bd92f603d43430c4c100d17011c0d64427950463c4e18856da642c2f2270df33e722c1efda9b971484d5a6e416767ed2b487e719ee444001acfc

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 ## Version 1
+### Version 1.2.0
+* Add support for the Purge API (#48)
+
 ### Version 1.1.1
 * Fix query methods throwing NoMethodErrors.
 

data/lib/mediawiki/butt.rb

@@ -4,6 +4,7 @@ require_relative 'constants'
 require_relative 'edit'
 require_relative 'administration'
 require_relative 'watch'
+require_relative 'purge'
 require 'httpclient'
 require 'json'
 
@@ -20,6 +21,7 @@ module MediaWiki
     include MediaWiki::Edit
     include MediaWiki::Administration
     include MediaWiki::Watch
+    include MediaWiki::Purge
 
     attr_accessor :query_limit_default
     attr_accessor :use_continuation

data/lib/mediawiki/purge.rb

@@ -0,0 +1,57 @@
+module MediaWiki
+  module Purge
+    # Purges the provided pages, without updating link tables. This will warn for every invalid purge with the reason
+    # it is invalid, as provided by the MediaWiki API.
+    # @param *titles [Array<String>] A list of the pages to purge.
+    # @return [Hash<String, Boolean>] The key is the page title, and the value is whether it was a successful purge.
+    # @see https://www.mediawiki.org/wiki/API:Purge MediaWiki API Docs
+    # @note This creates a warning for every invalid purge with the reason it is invalid, as provided by the MediaWiki
+    #   API, as well as the title of the invalid page.
+    def purge(*titles)
+      purge_request({}, titles)
+    end
+
+    # Purges the provided pages and updates their link tables.
+    # @param (see #purge)
+    # @return (see #purge)
+    # @see (see #purge)
+    # @note (see #purge)
+    def purge_link_update(*titles)
+      purge_request({ forcelinkupdate: 1 }, titles)
+    end
+
+    # Purges the provided pages and recursively updates the link tables.
+    # @param (see #purge)
+    # @return (see #purge)
+    # @see (see #purge)
+    # @note (see #purge)
+    def purge_recursive_link_update(*titles)
+      purge_request({ forcerecursivelinkupdate: 1 }, titles)
+    end
+
+    private
+
+    # Sends a purge API request, and handles the return value and warnings.
+    # @param params [Hash<Object, Object>] The parameter hash to begin with. Cannot include the titles or action keys.
+    # @param (see #purge)
+    # @return (see #purge)
+    # @see (see #purge)
+    # @note (see #purge)
+    def purge_request(params, *titles)
+      params[:action] = 'purge'
+      params[:titles] = titles.join('|')
+
+      response = post(params)
+
+      ret = {}
+
+      response['purge'].each do |hash|
+        title = hash['title']
+        ret[title] = hash.key?('purged') && !hash.key?('missing')
+        warn "Invalid purge (#{title}) #{hash['invalidreason']}" if hash.key?('invalid')
+      end
+
+      ret
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -42,6 +42,7 @@ files:
 - lib/mediawiki/constants.rb
 - lib/mediawiki/edit.rb
 - lib/mediawiki/exceptions.rb
+- lib/mediawiki/purge.rb
 - lib/mediawiki/query/lists/all.rb
 - lib/mediawiki/query/lists/backlinks.rb
 - lib/mediawiki/query/lists/categories.rb