mediawiki_api 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05fde886762b19553fe636b7e7d8cccb220a7481
-  data.tar.gz: 37036c78dcbd186c31f9da0a08f754f7931d1daa
+  metadata.gz: 20db69d02e685dd6c01f43a617e783310b884784
+  data.tar.gz: 8ea86db0e30f32006981ba4e04779f0e8eb1b73c
 SHA512:
-  metadata.gz: ab02ae9dd0aaca8aac8c4d4bd08a8a9dabe2e907b2b6f656575d1ee29be059f4a39eb8802e720360c36b301e198a8579648802d4accfaf132d5416961d50ab50
-  data.tar.gz: e18cd950e866512999fb22e86fc7021ce260d99935f8f558b782ef75c38ad6e7aa4fa2df03e99970742e165f9bc17dd4033320c0785cc7948f760453b7c0cf4c
+  metadata.gz: c5c9196a44d8975fb8081273791487d88188ed4f452c892d656d2de940fc9e1049b61dd64ec14d2a71e7c0c6935109bfb006378eb697bd189f70536d10ed80b9
+  data.tar.gz: cd1f86124b668e951ec1a608be92ec7c6aee66273eb3c360da85b546ffd460d87427d16a4dcac23c5e0c476c5f77c207cdce673af3053bb4b9a9a3ce03bc21c9

data/.gitignore

@@ -1,4 +1,6 @@
 .bundle/
+/.yardoc/
+/doc/
 .ruby-version
 .ruby-gemset
 .gem

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,102 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-10 11:44:33 -0700 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Lint/UselessAssignment:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 122
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 53
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 182
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Alias:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 6
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 30
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/DotPosition:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/LeadingCommentSpace:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 1
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false
+
+# Offense count: 9
+# Cop supports --auto-correct.
+Style/SpaceInsideParens:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 299
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Enabled: false
+
+# Offense count: 4
+# Cop supports --auto-correct.
+Style/WordArray:
+  MinSize: 2

data/.yardopts

@@ -0,0 +1 @@
+--title "MediaWiki Ruby API"

data/README.md

@@ -54,6 +54,11 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.3.0 2014-10-14
+
+- HTTP 400 and 500 responses now result in an HttpError exception.
+- Edit failures now result in an EditError exception.
+
 ### 0.2.1 2014-08-26
 
 - Fix error handling for token requests

data/lib/mediawiki_api/client.rb

@@ -37,8 +37,10 @@ module MediawikiApi
 
       response = @conn.send(method, "", params.merge(action: name, format: FORMAT))
 
+      raise HttpError, response.status if response.status >= 400
+
       if response.headers.include?("mediawiki-api-error")
-        raise ApiError.new(Response.new(response, ["error"]))
+        raise ApiError, Response.new(response, ["error"])
       end
 
       Response.new(response, envelope)
@@ -64,13 +66,19 @@ module MediawikiApi
     end
 
     def create_page(title, content)
-      action(:edit, title: title, text: content)
+      edit(title: title, text: content)
     end
 
     def delete_page(title, reason)
       action(:delete, title: title, reason: reason)
     end
 
+    def edit(params = {})
+      response = action(:edit, params)
+      raise EditError, response if response.data["result"] == "Failure"
+      response
+    end
+
     def get_wikitext(title)
       @conn.get "/w/index.php", { action: "raw", title: title }
     end

data/lib/mediawiki_api/exceptions.rb

@@ -28,6 +28,24 @@ module MediawikiApi
   class CreateAccountError < StandardError
   end
 
+  class HttpError < StandardError
+    attr_reader :status
+
+    def initialize(status)
+      @status = status
+    end
+
+    def to_s
+      "unexpected HTTP response (#{status})"
+    end
+  end
+
+  class EditError < ApiError
+    def to_s
+      "check the response data for details"
+    end
+  end
+
   class LoginError < StandardError
   end
 

data/lib/mediawiki_api/version.rb

@@ -1,3 +1,3 @@
 module MediawikiApi
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/mediawiki_api.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
   spec.add_development_dependency "webmock", "~> 1.17", ">= 1.17.2"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "yard"
 end

data/spec/client_spec.rb

@@ -18,7 +18,8 @@ describe MediawikiApi::Client do
     let(:token_type) { action }
     let(:params) { {} }
 
-    let(:response) { { headers: response_headers, body: response_body.to_json } }
+    let(:response) { { status: response_status, headers: response_headers, body: response_body.to_json } }
+    let(:response_status) { 200 }
     let(:response_headers) { nil }
     let(:response_body) { { "something" => {} } }
 
@@ -100,6 +101,22 @@ describe MediawikiApi::Client do
       end
     end
 
+    context "when the response status is in the 400 range" do
+      let(:response_status) { 403 }
+
+      it "raises an HttpError" do
+        expect { subject }.to raise_error(MediawikiApi::HttpError, "unexpected HTTP response (403)")
+      end
+    end
+
+    context "when the response status is in the 500 range" do
+      let(:response_status) { 502 }
+
+      it "raises an HttpError" do
+        expect { subject }.to raise_error(MediawikiApi::HttpError, "unexpected HTTP response (502)")
+      end
+    end
+
     context "when the response is an error" do
       let(:response_headers) { { "MediaWiki-API-Error" => "code" } }
       let(:response_body) { { error: { info: "detailed message", code: "code" } } }
@@ -189,17 +206,21 @@ describe MediawikiApi::Client do
   end
 
   describe "#create_page" do
+    subject { client.create_page(title, text) }
+
+    let(:title) { "Test" }
+    let(:text) { "test123" }
+    let(:response) { {} }
+
     before do
-      stub_request(:get, api_url).
-        with(query: { format: "json", action: "tokens", type: "edit" }).
-        to_return(body: { tokens: { edittoken: "t123" } }.to_json )
-      @edit_req = stub_request(:post, api_url).
-        with(body: { format: "json", action: "edit", title: "Test", text: "test123", token: "t123" })
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:edit, title: title, text: text).
+        to_return(body: response.to_json)
     end
 
-    it "creates a page using an edit token" do
-      subject.create_page("Test", "test123")
-      expect(@edit_req).to have_been_requested
+    it "makes the right request" do
+      subject
+      expect(@edit_request).to have_been_requested
     end
   end
 
@@ -220,6 +241,31 @@ describe MediawikiApi::Client do
     # evaluate results
   end
 
+  describe "#edit" do
+    subject { client.edit(params) }
+
+    let(:params) { {} }
+    let(:response) { { edit: {} } }
+
+    before do
+      stub_token_request(:edit)
+      @edit_request = stub_action_request(:edit).to_return(body: response.to_json)
+    end
+
+    it "makes the request" do
+      subject
+      expect(@edit_request).to have_been_requested
+    end
+
+    context "upon an edit failure" do
+      let(:response) { { edit: { result: "Failure" } } }
+
+      it "raises an EditError" do
+        expect { subject }.to raise_error(MediawikiApi::EditError)
+      end
+    end
+  end
+
   describe "#get_wikitext" do
     before do
       @get_req = stub_request(:get, index_url).with(query: { action: "raw", title: "Test" })

data/spec/support/request_helpers.rb

@@ -12,6 +12,8 @@ module MediawikiApi::RequestHelpers
   end
 
   def stub_api_request(method, params)
+    params = params.each.with_object({}) { |(k, v), p| p[k] = v.to_s }
+
     stub_request(method, api_url).
       with((method == :post ? :body : :query) => params.merge(format: "json"))
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Amir Aharoni
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -123,6 +123,34 @@ dependencies:
     - - ">="
       - !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.
 email:
 - amir.aharoni@mail.huji.ac.il
@@ -138,6 +166,9 @@ files:
 - ".gitignore"
 - ".gitreview"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".yardopts"
 - CREDITS
 - Gemfile
 - LICENSE.txt