mediawiki_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8395abe251559d9bdf235ea57ac6f03e53bc6f0
-  data.tar.gz: ad8ff2632ce626ee44fbaee68e0188ed2a7da3b8
+  metadata.gz: 61335636d79746833c9ce6320e349c4ddc3b0eb0
+  data.tar.gz: 50ff419bf6cff5deacd013c516e8dbfe611b8b57
 SHA512:
-  metadata.gz: c93261cc228782ebac21aa2193824dcc65aa739eb254ec55ba0e7a217ee6f754e964f47f6faf543ccc36d7805dc67b084c9f28a3a16441c017532ca4998ab1cb
-  data.tar.gz: 724a2f1c2d41578427ed0bae7ed3bef54541d406f014bf274e45eccc9a8a6267bee9ca48538e740a4a8b2c4a51389b73dc3cd0bf08b78a7d3df1094b6a78e33f
+  metadata.gz: 8e49ec787cc5313d0db2206062202e350b6c06f4497681a85aed857252518515fde8f5b1c6dedcb113bb246d599d366b1b1fcec4b3ec0114bf935e506e5d2695
+  data.tar.gz: e674171587b3975ad3d5b14ab0a3527b4160d03336ee8b07cf107f88b6bf98a1190197b79e2357d2967da88fa4a1e38196631e662ca76a0cdf2b9cf402c1759e

data/Gemfile

@@ -1,4 +1,4 @@
-#ruby=ruby-2.1.1
+#ruby=ruby-2.1.2
 #ruby-gemset=mediawiki_api
 
 source "https://rubygems.org"

data/Gemfile.lock

@@ -1,18 +1,18 @@
 PATH
   remote: .
   specs:
-    mediawiki_api (0.1.2)
+    mediawiki_api (0.1.4)
       faraday (~> 0.9, >= 0.9.0)
       faraday-cookie_jar (~> 0.0, >= 0.0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.5)
+    addressable (2.3.6)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
-    domain_name (0.5.18)
+    domain_name (0.5.19)
       unf (>= 0.0.5, < 1.0.0)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
@@ -23,20 +23,24 @@ GEM
       domain_name (~> 0.5)
     multipart-post (2.0.0)
     rake (0.9.6)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    safe_yaml (1.0.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    safe_yaml (1.0.3)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.6)
-    webmock (1.17.4)
-      addressable (>= 2.2.7)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
 
 PLATFORMS
@@ -46,5 +50,5 @@ DEPENDENCIES
   bundler (~> 1.3)
   mediawiki_api!
   rake (~> 0)
-  rspec (~> 2.14, >= 2.14.1)
+  rspec (~> 3.0, >= 3.0.0)
   webmock (~> 1.17, >= 1.17.2)

data/README.md

@@ -19,14 +19,19 @@ Or install it yourself as:
 
 ## Usage
 
+Assuming you have MediaWiki installed via [MediaWiki-Vagrant](https://www.mediawiki.org/wiki/MediaWiki-Vagrant).
+
 ```ruby
 require "mediawiki_api"
 
-client = MediawikiApi::Client.new("http://127.0.0.1/w/api.php")
-client.create_account("username", "password")
-client.log_in("username", "password")
-client.create_page("title", "content")
-client.delete_page("title", "reason")
+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_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"
 ```
 
 ## Links
@@ -41,3 +46,37 @@ MediaWiki API gem at: [Gerrit](https://gerrit.wikimedia.org/r/#/admin/projects/m
 3. Commit your changes (`git commit -am "Add some feature"`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Release notes
+
+### 0.1.4 2014-07-??
+
+- Added MediawikiApi::Client#protect_page.
+- Updated documentation.
+
+### 0.1.3 2014-06-28
+
+- Added MediawikiApi::Client#upload_image.
+
+### 0.1.2 2014-04-11
+
+- Added MediawikiApi::Client#get_wikitext.
+
+### 0.1.1 2014-04-01
+
+- Updated documentation.
+
+### 0.1.0 2014-03-13
+
+- Complete refactoring.
+- Removed MediawikiApi#create_article, #create_user and #delete_article.
+- Added MediawikiApi::Client#new, #log_in, #create_page, #delete_page, #create_account.
+- Added unit tests.
+
+### 0.0.2 2014-02-11
+
+- Added MediawikiApi#delete_article.
+
+### 0.0.1 2014-02-07
+
+- Added MediawikiApi#create_article and #create_user.

data/lib/mediawiki_api/client.rb

@@ -15,13 +15,11 @@ module MediawikiApi
   class Client
     attr_accessor :logged_in
 
-    def initialize(url, log=false)
+    def initialize(url, log = false)
       @conn = Faraday.new(url: url) do |faraday|
         faraday.request :multipart
         faraday.request :url_encoded
-        if log then
-          faraday.response :logger
-        end
+        faraday.response :logger if log
         faraday.use :cookie_jar
         faraday.adapter Faraday.default_adapter
       end
@@ -64,21 +62,26 @@ module MediawikiApi
 
     def create_page(title, content)
       token = get_token "edit"
-      resp = @conn.post "", { action: "edit", title: title, text: content, token: token, format: "json" }
+      @conn.post "", action: "edit", title: title, text: content, token: token, format: "json"
     end
 
     def delete_page(title, reason)
       token = get_token "delete"
-      resp = @conn.post "", { action: "delete", title: title, reason: reason, token: token, format: "json" }
+      @conn.post "", action: "delete", title: title, reason: reason, token: token, format: "json"
     end
 
-    def upload_image(filename ,path , comment, ignorewarnings)
+    def upload_image(filename, path, comment, ignorewarnings)
       token = get_token "edit"
-      @conn.post "", { action: "upload", filename: filename, file: Faraday::UploadIO.new(path, 'image/png'), token: token, comment: comment, ignorewarnings: ignorewarnings, format: "json"}
+      @conn.post "", action: "upload", filename: filename, file: Faraday::UploadIO.new(path, 'image/png'), token: token, comment: comment, ignorewarnings: ignorewarnings, format: "json"
     end
 
     def get_wikitext(title)
-      resp = @conn.get "/w/index.php", { action: "raw", title: title }
+      @conn.get "/w/index.php", { action: "raw", title: title }
+    end
+
+    def protect_page(title, reason, protections="edit=sysop|move=sysop")
+      token = get_token "protect"
+      @conn.post "", action: "protect", title: title, reason: reason, token: token, format: "json", protections: protections
     end
 
     protected

data/lib/mediawiki_api/version.rb

@@ -1,3 +1,3 @@
 module MediawikiApi
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/mediawiki_api.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"
-  spec.add_development_dependency "rspec", "~> 2.14", ">= 2.14.1"
+  spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
   spec.add_development_dependency "webmock", "~> 1.17", ">= 1.17.2"
 end

data/spec/client_spec.rb

@@ -12,7 +12,7 @@ describe MediawikiApi::Client do
         to_return(body: { login: body_base.merge({ result: "Success" }) }.to_json )
 
       subject.log_in "Test", "qwe123"
-      subject.logged_in.should be true
+      expect(subject.logged_in).to be true
     end
 
     context "when API returns NeedToken" do
@@ -34,12 +34,12 @@ describe MediawikiApi::Client do
 
       it "logs in" do
         subject.log_in "Test", "qwe123"
-        subject.logged_in.should be true
+        expect(subject.logged_in).to be true
       end
 
       it "sends second request with token and cookies" do
         subject.log_in "Test", "qwe123"
-        @success_req.should have_been_requested
+        expect(@success_req).to have_been_requested
       end
     end
 
@@ -52,7 +52,7 @@ describe MediawikiApi::Client do
 
       it "does not log in" do
         expect { subject.log_in "Test", "qwe123" }.to raise_error
-        subject.logged_in.should be false
+        expect(subject.logged_in).to be false
       end
 
       it "raises error with proper message" do
@@ -72,7 +72,7 @@ describe MediawikiApi::Client do
 
     it "creates a page using an edit token" do
       subject.create_page("Test", "test123")
-      @edit_req.should have_been_requested
+      expect(@edit_req).to have_been_requested
     end
 
     context "when API returns Success" do
@@ -95,7 +95,7 @@ describe MediawikiApi::Client do
 
     it "deletes a page using a delete token" do
       subject.delete_page("Test", "deleting")
-      @delete_req.should have_been_requested
+      expect(@delete_req).to have_been_requested
     end
 
     # evaluate results
@@ -108,7 +108,7 @@ describe MediawikiApi::Client do
 
     it "fetches a page" do
       subject.get_wikitext("Test")
-      @get_req.should have_been_requested
+      expect(@get_req).to have_been_requested
     end
   end
 
@@ -118,7 +118,7 @@ describe MediawikiApi::Client do
         with(body: { format: "json", action: "createaccount", name: "Test", password: "qwe123" }).
         to_return(body: { createaccount: body_base.merge({ result: "Success" }) }.to_json )
 
-      subject.create_account("Test", "qwe123").should be true
+      expect(subject.create_account("Test", "qwe123")).to be true
     end
 
     context "when API returns NeedToken" do
@@ -139,12 +139,12 @@ describe MediawikiApi::Client do
       end
 
       it "creates an account" do
-        subject.create_account("Test", "qwe123").should be true
+        expect(subject.create_account("Test", "qwe123")).to be true
       end
 
       it "sends second request with token and cookies" do
         subject.create_account "Test", "qwe123"
-        @success_req.should have_been_requested
+        expect(@success_req).to have_been_requested
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Amir Aharoni
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-28 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -88,20 +88,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A library for interacting with MediaWiki API from Ruby.