mediawiki_api 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd5041d5380d783963ff227ea117400d7ad7c942
-  data.tar.gz: b9019f1481fc05e4eeea1061cf09fd42f45ff20c
+  metadata.gz: 4033e20e939a4e529667d68f9980dbecbf546e39
+  data.tar.gz: 26a103f6d54867b344c0e8542d42cbb58ae5ecb1
 SHA512:
-  metadata.gz: 222b03e90a95dbd7b8c65b9e6e05ab99d7e1edd404975c96d1dc1555db66c04fd4686e8d8c7c98d84d10f6237977123cf1287917b318fd3b15bef497f7f0fdca
-  data.tar.gz: af192c8a05c649a1d22bfcb97c9342bd6bb1ef6c0dec3fc7638c4dc2c0eec6f7c36dcf43d61c5e9aad7b8f9feae810bc0ee2d0c6328e94a224a2cadacd400cea
+  metadata.gz: 3b9163974f7c7dcbfcf57de36c9339c978a856c5d199d2cd4706ac3a06d34e4ef8b4c110975fd601a27f5d1c0e19936c24d116f4fb8bd3f7195e68f34954d1fa
+  data.tar.gz: 7cc523a723658d551cff463f92aa20d78810fd21f2e66bab690aa229815619bd75bcaf1254ea6b0a39c90b13a8c813a74d3af83342d0a9e7609ccdec7948017e

data/README.md

@@ -32,8 +32,8 @@ 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"
-client.watch "title"
-client.unwatch "title"
+client.watch_page "title"
+client.unwatch_page "title"
 client.meta :siteinfo, siprop: "extensions"
 client.prop :info, titles: "Some page"
 client.query titles: ["Some page", "Some other page"]
@@ -49,10 +49,10 @@ By default, the client will attempt to get a csrf token before attempting the
 action. For actions that do not require a token, you can specify
 `token_type: false` to avoid requesting the unnecessary token before the real
 request. For example:
-```client.action :parse, page: 'Main Page', token_type: false
-```
-
 
+```ruby
+client.action :parse, page: 'Main Page', token_type: false
+```
 
 ## Links
 
@@ -65,11 +65,14 @@ See https://www.mediawiki.org/wiki/Gerrit
 
 ## Release notes
 
+### 0.4.1 2015-06-17
+- Allow for response-less ApiError exceptions to make mocking in tests easier
+
 ### 0.4.0 2015-06-16
-- use action=query&meta=tokens to fetch tokens, instead of deprecated action=tokens
+- Use action=query&meta=tokens to fetch tokens, instead of deprecated action=tokens
 
 ### 0.3.1 2015-01-06
-- actions now automatically refresh token and re-submit action if first attempt returns 'badtoken'.
+- Actions now automatically refresh token and re-submit action if first attempt returns 'badtoken'.
 
 ### 0.3.0 2014-10-14
 

data/lib/mediawiki_api/exceptions.rb

@@ -3,16 +3,16 @@ module MediawikiApi
   class ApiError < StandardError
     attr_reader :response
 
-    def initialize(response)
+    def initialize(response = nil)
       @response = response
     end
 
     def code
-      data['code']
+      response_data['code'] || '000'
     end
 
     def info
-      data['info']
+      response_data['info'] || 'unknown API error'
     end
 
     def to_s
@@ -21,8 +21,12 @@ module MediawikiApi
 
     private
 
-    def data
-      @response.data || {}
+    def response_data
+      if @response
+        @response.data || {}
+      else
+        {}
+      end
     end
   end
 

data/lib/mediawiki_api/version.rb

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

data/spec/exceptions_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+module MediawikiApi
+  describe ApiError do
+    def mock_error_response(data = {})
+      instance_double(Response, data: data)
+    end
+
+    describe '#code' do
+      it 'returns the code from `error/code` in the response' do
+        error = ApiError.new(mock_error_response('code' => '123'))
+
+        expect(error.code).to eq('123')
+      end
+
+      it 'defaults to "000" when a code is not present in the response' do
+        error = ApiError.new(mock_error_response)
+
+        expect(error.code).to eq('000')
+      end
+
+      it 'defaults to "000" when a response is not provided' do
+        error = ApiError.new
+
+        expect(error.code).to eq('000')
+      end
+    end
+
+    describe '#info' do
+      it 'returns the info from `error/info` in the response' do
+        error = ApiError.new(mock_error_response('info' => 'some error'))
+
+        expect(error.info).to eq('some error')
+      end
+
+      it 'defaults to "unknown API error" when info is not present in the response' do
+        error = ApiError.new(mock_error_response)
+
+        expect(error.info).to eq('unknown API error')
+      end
+
+      it 'defaults to "unknown API error" when a response is not provided' do
+        error = ApiError.new
+
+        expect(error.info).to eq('unknown API error')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Amir Aharoni
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -195,6 +195,7 @@ files:
 - lib/mediawiki_api/version.rb
 - mediawiki_api.gemspec
 - spec/client_spec.rb
+- spec/exceptions_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/request_helpers.rb
@@ -224,6 +225,7 @@ specification_version: 4
 summary: A library for interacting with MediaWiki API from Ruby.
 test_files:
 - spec/client_spec.rb
+- spec/exceptions_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/support/request_helpers.rb