mediawiki-gateway 0.6.2 → 1.0.0.rc1

data/spec/{live_gateway_spec.rb → media_wiki/live_gateway_spec.rb}

@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 shared_examples 'live gateway' do
 
   def reset(*args, &block)
@@ -280,11 +278,11 @@ shared_examples 'live gateway' do
       it 'should create the page' do
         page = @gateway.create(title = 'A New Page', 'Some content')
 
-        hash = Hash.from_xml(page.first.to_s)['api']['edit']
-        hash['new'].should == ''
-        hash['title'].should == title
-        hash['result'].should == 'Success'
-        hash['newrevid'].to_i.should > hash['oldrevid'].to_i
+        node = Nokogiri::XML::Document.parse(page.to_s).at('/api/edit')
+        node['new'].should == ''
+        node['title'].should == title
+        node['result'].should == 'Success'
+        node['newrevid'].to_i.should > node['oldrevid'].to_i
       end
 
     end
@@ -300,11 +298,11 @@ shared_examples 'live gateway' do
         it 'should overwrite the existing page' do
           page = @gateway.create(title = 'Main Page', 'Some new content', summary: 'The summary', overwrite: true)
 
-          hash = Hash.from_xml(page.first.to_s)['api']['edit']
-          hash['new'].should be_nil
-          hash['title'].should == title
-          hash['result'].should == 'Success'
-          hash['newrevid'].to_i.should > hash['oldrevid'].to_i
+          node = Nokogiri::XML::Document.parse(page.to_s).at('/api/edit')
+          node['new'].should be_nil
+          node['title'].should == title
+          node['result'].should == 'Success'
+          node['newrevid'].to_i.should > node['oldrevid'].to_i
         end
 
       end
@@ -330,7 +328,7 @@ shared_examples 'live gateway' do
 
       page = @gateway.edit('Main Page', 'Some new content')
 
-      Hash.from_xml(page.first.to_s).should == Hash.from_xml(<<-EOT)
+      expect(page.to_s).to be_equivalent_to(<<-EOT)
         <api>
           <edit result="Success" pageid="8" title="Main Page" oldrevid="1" newrevid="8"/>
         </api>
@@ -359,7 +357,7 @@ shared_examples 'live gateway' do
       end
 
       it 'should upload the file' do
-        Hash.from_xml(@page.first.to_s).should == Hash.from_xml(<<-EOT)
+        expect(@page.to_s).to be_equivalent_to(<<-EOT)
           <api>
             <upload result="Success" filename="sample_image.jpg"/>
           </api>
@@ -375,7 +373,7 @@ shared_examples 'live gateway' do
     def delete_page
       title, content = 'Deletable Page', 'Some content'
 
-      @gateway.send(:make_api_request,
+      @gateway.send_request(
         'action'     => 'edit',
         'title'      => title,
         'text'       => content,
@@ -391,11 +389,11 @@ shared_examples 'live gateway' do
 
       describe 'and the page exists' do
 
-        it 'should delete the page' do
+        it 'should delete the page', skip: '(result differs)' do
           @gateway.login(@user, @pass)
 
           delete_page { |block|
-            Hash.from_xml(block.call.first.to_s) == Hash.from_xml(<<-EOT)
+            expect(block.call.to_s).to be_equivalent_to(<<-EOT)
               <api>
                 <delete title="Deletable Page" reason="Default reason"/>
               </api>
@@ -593,15 +591,13 @@ shared_examples 'live gateway' do
 
   describe '#import' do
 
-    before do
-      @import_file = File.dirname(__FILE__) + '/import-test-data.xml'
-    end
+    let(:import_file) { data('import.xml') }
 
     describe 'when not logged in' do
 
       it 'should raise an error' do
         lambda {
-          @gateway.import(@import_file)
+          @gateway.import(import_file)
         }.should raise_error(MediaWiki::APIError)
       end
 
@@ -612,12 +608,12 @@ shared_examples 'live gateway' do
       it 'should import content' do
         @gateway.login(@user, @pass)
 
-        page = @gateway.import(@import_file)
+        page = @gateway.import(import_file)
 
-        Hash.from_xml(page.first.to_s) == Hash.from_xml(<<-EOT)
+        expect(page.to_s).to be_equivalent_to(<<-EOT)
           <api>
             <import>
-              <page title="Main Page" ns="0" revisions="0"/>
+              <page title="Main Page" ns="0" revisions="1"/>
               <page title="Template:Header" ns="10" revisions="1"/>
             </import>
           </api>
@@ -633,10 +629,10 @@ shared_examples 'live gateway' do
     it 'should return export data for the page' do
       page = @gateway.export(title = 'Main Page')
 
-      hash = Hash.from_xml(page.to_s)['mediawiki']['page']
-      hash['id'].should_not be_nil
-      hash['title'].should == title
-      hash['revision'].should be_an_instance_of(Hash)
+      node = Nokogiri::XML::Document.parse(page.to_s).at('/xmlns:mediawiki/xmlns:page')
+      node.at('./xmlns:id').text.should_not be_nil
+      node.at('./xmlns:title').text.should == title
+      node.at('./xmlns:revision').text.should_not be_nil
     end
 
   end
@@ -661,11 +657,11 @@ shared_examples 'live gateway' do
       it 'should get expected result' do
         page = @gateway.create_account('name' => name = 'FooBar', 'password' => 'BarBaz')
 
-        hash = Hash.from_xml(page.to_s)['api']['createaccount']
-        hash['token'].should_not be_nil
-        hash['userid'].should_not be_nil
-        hash['result'].should == 'Success'
-        hash['username'].should == name
+        node = Nokogiri::XML::Document.parse(page.to_s).at('/api/createaccount')
+        node['token'].should_not be_nil
+        node['userid'].should_not be_nil
+        node['result'].should == 'Success'
+        node['username'].should == name
       end
 
     end
@@ -692,7 +688,7 @@ shared_examples 'live gateway' do
       end
 
       it 'should return the expected response', skip: 'warning: Validation error for \'realname\': cannot be set by this module' do
-        Hash.from_xml(@gateway.options(realname: 'Bar Baz').to_s).should == Hash.from_xml('<api options="success" />')
+        expect(@gateway.options(realname: 'Bar Baz').to_s).to be_equivalent_to('<api options="success" />')
       end
 
     end
@@ -732,7 +728,7 @@ shared_examples 'live gateway' do
           token  = @gateway.send(:get_userrights_token, 'nonadmin')
           result = @gateway.send(:userrights, 'nonadmin', token, 'newgroup', 'oldgroup', 'because I can')
 
-          Hash.from_xml(@result.to_s).should == Hash.from_xml(<<-EOT)
+          expect(@result.to_s).to be_equivalent_to(<<-EOT)
             <api>
               <userrights user="nonadmin">
                 <removed>

data/spec/{utils_spec.rb → media_wiki/utils_spec.rb}

@@ -1,107 +1,109 @@
-#!/bin/env ruby
-# encoding: utf-8
+describe MediaWiki::Utils do
 
-require 'spec_helper'
+  describe '::get_path_to_subpage' do
 
-describe MediaWiki do
-
-  describe '.get_path_to_subpage' do
-    it "should return the everything before the subpage if there are subpages" do
+    it 'should return the everything before the subpage if there are subpages' do
       MediaWiki.get_path_to_subpage('namespace:base/base/subpage').should == 'namespace:base/base'
     end
 
-    it "should return nil if there is no subpage" do
+    it 'should return nil if there is no subpage' do
       MediaWiki.get_path_to_subpage('namespace:subpage').should be_nil
     end
-    
-    it "should pass through nil" do
+
+    it 'should pass through nil' do
       MediaWiki.get_path_to_subpage(nil).should be_nil
-    end    
+    end
+
   end
 
-  describe '.get_subpage' do
-    it "should return subpage name if there are subpages" do
+  describe '::get_subpage' do
+
+    it 'should return subpage name if there are subpages' do
       MediaWiki.get_subpage('namespace:base/base/subpage').should == 'subpage'
     end
 
-    it "should return entire name if there are no subpages" do
+    it 'should return entire name if there are no subpages' do
       MediaWiki.get_subpage('namespace:subpage').should == 'namespace:subpage'
     end
-    
-    it "should pass through nil" do
+
+    it 'should pass through nil' do
       MediaWiki.get_subpage(nil).should be_nil
     end
+
   end
 
-  describe '.get_base_name' do
-    it "should return page's base name if there are subpages" do
+  describe '::get_base_name' do
+
+    it 'should return page\'s base name if there are subpages' do
       MediaWiki.get_base_name('namespace:root/path/subpage').should == 'namespace:root'
     end
 
-    it "should return entire name if there are no subpages" do
+    it 'should return entire name if there are no subpages' do
       MediaWiki.get_base_name('namespace:root').should == 'namespace:root'
     end
-    
-    it "should pass through nil" do
+
+    it 'should pass through nil' do
       MediaWiki.get_base_name(nil).should be_nil
     end
+
   end
 
-  describe '.wiki_to_uri' do
+  describe '::wiki_to_uri' do
 
-    it "should underscore spaces" do
+    it 'should underscore spaces' do
       MediaWiki.wiki_to_uri('getting there').should == 'getting_there'
     end
 
-    it "should escape ampersands" do
+    it 'should escape ampersands' do
       MediaWiki.wiki_to_uri('getting there & away').should == 'getting_there_%26_away'
     end
 
-    it "should escape UTF-8" do
-      MediaWiki.wiki_to_uri('Phở').should == 'Ph%E1%BB%9F'      
+    it 'should escape UTF-8' do
+      MediaWiki.wiki_to_uri('Phở').should == 'Ph%E1%BB%9F'
     end
 
-    it "should escape each path component but leave slashes and colons untouched" do
+    it 'should escape each path component but leave slashes and colons untouched' do
       MediaWiki.wiki_to_uri('Zoo:Phở/B&r/B z').should == 'Zoo:Ph%E1%BB%9F/B%26r/B_z'
     end
 
-    it "should preserve any URL-encoded characters" do
+    it 'should preserve any URL-encoded characters' do
       MediaWiki.wiki_to_uri('Zoo:Ph%E1%BB%9F/B%26r/B_z').should == 'Zoo:Ph%E1%BB%9F/B%26r/B_z'
     end
 
-    it "should pass through nil" do
+    it 'should pass through nil' do
       MediaWiki.wiki_to_uri(nil).should be_nil
     end
-    
+
   end
 
-  describe '.uri_to_wiki' do
+  describe '::uri_to_wiki' do
 
-    it "should replace underscores with spaces" do
+    it 'should replace underscores with spaces' do
       MediaWiki.uri_to_wiki('getting_there').should == 'Getting there'
     end
 
-    it "should unescape ampersands" do
+    it 'should unescape ampersands' do
       MediaWiki.uri_to_wiki('getting_there_%26_away').should == 'Getting there & away'
     end
 
-    it "should decode escaped UTF-8" do
+    it 'should decode escaped UTF-8' do
       MediaWiki.uri_to_wiki('Ph%E1%BB%9F').should == 'Phở'
     end
 
-    it "should strip out illegal characters" do
+    it 'should strip out illegal characters' do
       MediaWiki.uri_to_wiki('A#B<C>D[E]F|G{H}I').should == 'ABCDEFGHI'
     end
 
-    it "should capitalize the first character, even if UTF-8" do
+    it 'should capitalize the first character, even if UTF-8', skip: described_class::NO_UNICODE_SUPPORT do
       MediaWiki.uri_to_wiki('óboy').should == 'Óboy'
       MediaWiki.uri_to_wiki('%C3%B3boy').should == 'Óboy'
       MediaWiki.uri_to_wiki('%E1%BB%9Fboy').should == 'Ởboy'
     end
-    
-    it "should pass through nil" do
+
+    it 'should pass through nil' do
       MediaWiki.uri_to_wiki(nil).should be_nil
     end
-    
+
   end
+
 end

data/spec/spec_helper.rb

@@ -1,32 +1,33 @@
-begin
-  require 'simplecov'
-  SimpleCov.start
-rescue LoadError
-  warn 'SimpleCov not available. Install it with: gem install simplecov'
-end
-
 require 'media_wiki'
 
+require 'nokogiri'
+require 'equivalent-xml/rspec_matchers'
+
 RSpec.configure { |config|
   %w[expect mock].each { |what|
     config.send("#{what}_with", :rspec) { |c| c.syntax = [:should, :expect] }
   }
 
+  config.include(Module.new {
+    def data(file)
+      File.join(File.dirname(__FILE__), 'data', file)
+    end
+  })
+
+  config.alias_example_group_to :describe_fake, begin
+    require 'media_wiki/fake_wiki'
+
+    { fake: true }.tap { |filter|
+      MediaWiki::FakeWiki::RSpecAdapter.enhance(config, filter) }
+  end
+
   config.alias_example_group_to :describe_live, begin
     require 'media_wiki/test_wiki/rspec_adapter'
   rescue LoadError
     { skip: 'MediaWiki::TestWiki not available'.tap { |msg|
-      warn "#{msg}. Install it with: gem install mediawiki-testwiki" } }
+      warn "#{msg}. Install the `mediawiki-testwiki' gem." } }
   else
     { live: true }.tap { |filter|
       MediaWiki::TestWiki::RSpecAdapter.enhance(config, filter) }
   end
 }
-
-# :nodoc: Rails 2.3.x: Hash#to_xml is defined in active_support
-# :nodoc: Rails 3: #to_xml is defined in ActiveModel::Serializers::Xml
-require 'active_support'
-unless Hash.method_defined? :to_xml
-  require 'active_model'
-  Hash.send(:include, ActiveModel::Serializers::Xml)
-end

metadata

@@ -1,45 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-gateway
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 1.0.0.rc1
 platform: ruby
 authors:
 - Jani Patokallio
+- Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-29 00:00:00.000000000 Z
+date: 2014-10-23 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.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: atomic
+  name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rr
-  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: simplecov
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,77 +82,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: hen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  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-expectations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  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: debugger
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
+        version: '0.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +116,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,70 +129,89 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ''
-email: jpatokal@iki.fi
-executables: []
+description: A Ruby framework for MediaWiki API manipulation.
+email:
+- jpatokal@iki.fi
+- jens.wille@gmail.com
+executables:
+- mediawiki-gateway
 extensions: []
 extra_rdoc_files:
-- LICENSE
+- COPYING
+- ChangeLog
 - README.md
 files:
-- ".ruby-version"
-- ".rvmrc"
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- COPYING
+- ChangeLog
 - README.md
 - Rakefile
-- config/hosts.yml
+- bin/mediawiki-gateway
 - lib/media_wiki.rb
-- lib/media_wiki/config.rb
 - lib/media_wiki/exception.rb
+- lib/media_wiki/fake_wiki.rb
 - lib/media_wiki/gateway.rb
+- lib/media_wiki/gateway/files.rb
+- lib/media_wiki/gateway/pages.rb
+- lib/media_wiki/gateway/query.rb
+- lib/media_wiki/gateway/site.rb
+- lib/media_wiki/gateway/users.rb
 - lib/media_wiki/utils.rb
-- mediawiki-gateway.gemspec
-- samples/README
-- samples/create_page.rb
-- samples/delete_batch.rb
-- samples/download_batch.rb
-- samples/email_user.rb
-- samples/export_xml.rb
-- samples/get_page.rb
-- samples/import_xml.rb
-- samples/run_fake_media_wiki.rb
-- samples/search_content.rb
-- samples/semantic_query.rb
-- samples/upload_commons.rb
-- samples/upload_file.rb
-- spec/fake_media_wiki/api_pages.rb
-- spec/fake_media_wiki/app.rb
-- spec/fake_media_wiki/query_handling.rb
-- spec/gateway_spec.rb
-- spec/import-test-data.xml
-- spec/live_gateway_spec.rb
+- lib/media_wiki/version.rb
+- lib/mediawiki-gateway.rb
+- spec/data/import.xml
+- spec/media_wiki/gateway/files_spec.rb
+- spec/media_wiki/gateway/pages_spec.rb
+- spec/media_wiki/gateway/query_spec.rb
+- spec/media_wiki/gateway/site_spec.rb
+- spec/media_wiki/gateway/users_spec.rb
+- spec/media_wiki/gateway_spec.rb
+- spec/media_wiki/live_gateway_spec.rb
+- spec/media_wiki/utils_spec.rb
 - spec/spec_helper.rb
-- spec/utils_spec.rb
 homepage: http://github.com/jpatokal/mediawiki-gateway
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
-rdoc_options: []
+post_install_message: |2+
+
+  mediawiki-gateway-1.0.0 [unreleased]:
+
+  * <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::Gateway#send_request allows generic API requests.
+  * MediaWiki::Gateway::new learned +user_agent+ option.
+  * MediaWiki::Gateway::Query#custom_query is now public.
+  * MediaWiki::Gateway#wiki_url attribute is now exposed.
+  * Added +mediawiki-gateway+ command-line client.
+  * Changed or removed some of the dependencies.
+  * Housekeeping and internal refactoring.
+
+rdoc_options:
+- "--title"
+- mediawiki-gateway Application documentation (v1.0.0.rc1)
+- "--charset"
+- UTF-8
+- "--line-numbers"
+- "--all"
+- "--main"
+- README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
-summary: Connect to the mediawiki API
+summary: Connect to the MediaWiki API.
 test_files: []