wiki-api 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+SHA1:
+  metadata.gz: !binary |-
+    NjgxOGUxZjQ2MWQ2MjNhMDA2ZGUwMTRhOGI4MWFlOGQ3MzI4MWFjOA==
+  data.tar.gz: !binary |-
+    ZmZkNDFhMzc0ZTNmZDBlYTFmMTIwMmU5ZDgzYTQ2YjM0ZTk1ZmQzYg==
+SHA512:
+  metadata.gz: !binary |-
+    NGM4YTU2MjQ3Njk1MzJkMDhlYjcxODYxNDFkNzRlODI5MjMwNmU5ZGEzZmJj
+    MjhjZjYxYzcxMmYzYjA0YzA3NzdlYTJhMjM0ZTllNzgyMDk0MGJiNjBiZWRl
+    N2Y5YzMwZWZjZmY3NWQ0YmJiMjdiOTkwOTU1ZmE4MDg5Njk4M2Y=
+  data.tar.gz: !binary |-
+    MGZlMTYzZTgzZWE3YmYzZmIyMjc0OTZhMGY0NDEwYzJmNmFiMTZkNDM3OGM2
+    Mjc1MDdjMzQ3MjM1NmVlODM3Mzg5ZTViMGRmOGI2NzE1NDZjODJhZTA2MjI5
+    NWE3YmI4MDYxY2I4NGM3MGUwNzAzNjQ3YjMwODU5NDBlMWYxZDM=

data/README.md

@@ -17,17 +17,21 @@ Requests to the MediaWiki API use the following URI structure:
 
 ### Roadmap
 
-* Version (0.0.1) (current)
-
-  Initial project.
-
-* Version (0.0.2)
+* Version (0.0.2) (current)
 
   Index important words per block, page, list item;
 
   Parse objects for more elements within a Page.
 
 
+### Changelog
+
+* Version (0.0.1) -> (0.0.2)
+  
+  Nested ListItems, Links (within Page)
+
+  Search on Page headline (ignore case, and underscore)
+
 
 ### Known Issues
 
@@ -132,7 +136,7 @@ end
 ```
 
 
-### Example (https://en.wikipedia.org/wiki/Ruby_on_rails)
+### Example using Global config (https://en.wikipedia.org/wiki/Ruby_on_rails)
 
 This is a example of querying wikipedia.org on the page: "Ruby_on_rails", and printing the References headline links for each list item.
 
@@ -161,6 +165,28 @@ end
 
 
 
+### Example passing URI (https://en.wikipedia.org/wiki/Ruby_on_rails)
+
+This is the same example as the one above, except for setting a global config to direct the requests to a given URI.
+
+```ruby
+# querying the page
+page = Wiki::Api::Page.new name: "Ruby_on_rails", uri: "https://en.wikipedia.org"
+
+# get headlines with name Reference (there can be multiple headlines with the same name!)
+headlines = page.headline "References"
+
+# iterate headlines
+headlines.each do |headline|
+  # iterate list items on the given headline
+  headline.block.list_items.each do |list_item|
+
+    # print the uri of all links
+    puts list_item.links.map{ |l| l.uri }
+    
+  end
+end
+```
 
 
 

data/lib/wiki/api/connect.rb

@@ -10,6 +10,7 @@ module Wiki
       attr_accessor :uri, :api_path, :api_options, :http, :request, :response, :html, :parsed
 
       def initialize(options={})
+        @@config ||= nil
         options.merge! @@config unless @@config.nil?
         self.uri = options[:uri] if options.include? :uri
         self.api_path = options[:api_path] if options.include? :api_path

data/lib/wiki/api/page.rb

@@ -3,14 +3,16 @@ module Wiki
 
     class Page
 
-      attr_accessor :name, :parsed_page
+      attr_accessor :name, :parsed_page, :uri
 
       def initialize(options={})
         self.name = options[:name] if options.include? :name
+        uri = options[:uri] if options.include? :uri
+
         @@config ||= nil
-        if @@config.nil?
+        if @@config.nil? || !uri.nil?
           # use the connection to collect HTML pages for parsing
-          @connect = Wiki::Api::Connect.new
+          @connect = Wiki::Api::Connect.new uri: uri
         else
           # using a local HTML file for parsing
         end
@@ -79,8 +81,8 @@ module Wiki
 
         # get headline nodes by span class
         xs = self.parsed_page.xpath("//span[@class='mw-headline']")
-        # filter single headline by name
-        xs = xs.reject{|t| t.attributes["id"].value != headline_name } unless headline_name.nil?
+        # filter single headline by name (ignore case)
+        xs = self.filter_headline xs, headline_name unless headline_name.nil?
 
         # NOTE: first_part has no id attribute and thus cannot be filtered or processed within xpath (xs)
         if headline_name == self.name || headline_name.nil?
@@ -119,6 +121,14 @@ module Wiki
         elements
       end
 
+      def filter_headline xs, headline_name
+        # transform name to a wiki_id (downcase and space replace with underscore)
+        headline_name = headline_name.downcase.gsub(" ", "_")
+        # reject not matching id's
+        xs.reject do |t| 
+          !t.attributes["id"].value.downcase.start_with?(headline_name)
+        end
+      end
 
     end
 

data/lib/wiki/api/util.rb

@@ -22,6 +22,7 @@ module Wiki
           result.map{|k,v| v.join("")}
         end
 
+
         protected
         def clean_text text
           text.gsub(/\n/, " ").squeeze(" ").gsub(/\s(\W)/, '\1').gsub(/(\W)\s/, '\1 ').strip

data/lib/wiki/api/version.rb

@@ -1,5 +1,5 @@
 module Wiki
   module Api
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/unit/wiki_page_config.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'test/unit'
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/wiki/api")
+
+#
+# Testing the parsing of URI by passing a uri variable to Page:
+#   https://en.wiktionary.org/wiki/Wiktionary:Welcome,_newcomers
+#
+
+class WikiPageConfig < Test::Unit::TestCase
+
+  def setup
+    # NOTE: comment Page.config, to use the online MediaWiki instance
+    # Wiki::Api::Page.config = PAGE_CONFIG
+    # Wiki::Api::Connect.config = GLB_CONFIG
+    # @page_name = "Wiktionary:Welcome,_newcomers"
+  end
+
+  def teardown
+  end
+
+  # test simple page invocation
+  def test_page_invocation_with_uri
+    page = Wiki::Api::Page.new name: "Wiktionary:Welcome,_newcomers", uri: "http://en.wiktionary.org"
+    headlines = page.headlines
+    assert !headlines.empty?, "expected headlines"
+    assert headlines.size < 1, "expected more than one headline"
+    headlines.each do |headline|
+      assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
+    end
+  end
+
+  def test_wrong_page_invocation_with_uri
+    begin
+      page = Wiki::Api::Page.new name: "A_Wrong_Page_Name", uri: "http://en.wiktionary.org"
+      assert false, "expected a failiure"
+    rescue Exception => e
+      assert true, "expected a failiure"
+    end
+  end
+
+end
+

data/test/unit/wiki_page_object.rb

@@ -45,6 +45,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       elements = headline.elements.flatten
@@ -62,6 +63,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       block = headline.block
@@ -74,6 +76,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       block = headline.block
@@ -91,6 +94,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       block = headline.block
@@ -108,6 +112,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       block = headline.block
@@ -126,6 +131,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
     headlines.each do |headline|
       assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       block = headline.block
@@ -148,6 +154,7 @@ class WikiPageObject < Test::Unit::TestCase
     page = Wiki::Api::Page.new name: @page_name
     headlines = page.headlines
     assert !headlines.empty?, "expected headlines"
+    assert headlines.size > 1, "expected more than one headline"
 
     # collect headline names
     hs = []
@@ -162,10 +169,61 @@ class WikiPageObject < Test::Unit::TestCase
       headlines = page.headline h
       # test for at least one (many indicates multiple headlines with the same name)
       assert !headlines.empty?, "expected a list of headlines"
+      assert headlines.size == 1, "expected one headline"
       headlines.each do |headline|
         assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
       end
     end
   end
 
+  def test_page_headline_search_downcase
+    page = Wiki::Api::Page.new name: @page_name
+
+    headlines = page.headline "Editing_Wiktionary"
+    assert !headlines.empty?, "expected headlines"
+    assert headlines.size == 1, "expected one headline"
+
+
+    # iterate headlines
+    headlines.each do |headline|
+      assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
+    end
+
+    # search downcase
+    headlines = page.headline "editing_wiktionary"
+    assert !headlines.empty?, "expected headlines"
+
+    # iterate headlines
+    headlines.each do |headline|
+      assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
+    end
+
+  end
+
+  def test_page_headline_search_regular
+    page = Wiki::Api::Page.new name: @page_name
+
+    headlines = page.headline "Editing_Wiktionary"
+    assert !headlines.empty?, "expected headlines"
+    assert headlines.size == 1, "expected one headline"
+
+    # iterate headlines
+    headlines.each do |headline|
+      assert headline.is_a?(Wiki::Api::PageHeadline), "expected headline object"
+    end
+
+    # search downcase
+    headlines = page.headline "editing_wiktionary"
+    assert headlines.size == 1, "expected one headline"
+
+    # search downcase with spaces
+    headlines = page.headline "editing wiktionary"
+    assert headlines.size == 1, "expected one headline"
+
+    # search idiot case with spaces
+    headlines = page.headline "eDiTinG wiKtiOnarY"
+    assert headlines.size == 1, "expected one headline"
+
+  end
+
 end

data/wiki-api.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Wiki::Api::VERSION
   spec.authors       = ["Dennis Blommesteijn"]
   spec.email         = ["dennis@blommesteijn.com"]
-  spec.description   = %q{MediaWiki API and parser}
-  spec.summary       = %q{MediaWiki API and parser}
-  spec.homepage      = ""
+  spec.description   = %q{MediaWiki API and Page content parser for Headlines, Blocks, Elements, ListItems, and Links.}
+  spec.summary       = %q{MediaWiki API and Page content parser for Headlines, Blocks, Elements, ListItems, and Links.}
+  spec.homepage      = "https://github.com/dblommesteijn/wiki-api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -22,8 +22,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
 
   # dependencies
-  spec.add_dependency 'nokogiri'
-  spec.add_dependency 'json'
-  spec.add_development_dependency "test-unit"
+  spec.add_dependency 'nokogiri', "~> 1.5.0"
+  spec.add_dependency 'json', "~> 1.6.1"
+  spec.add_development_dependency "test-unit", "~> 2.0.0"
 
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wiki-api
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dennis Blommesteijn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-03-28 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,13 +17,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-    none: false
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
@@ -33,73 +30,57 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: '0'
   prerelease: false
   type: :development
 - !ruby/object:Gem::Dependency
   name: nokogiri
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 1.5.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 1.5.0
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   name: json
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 1.6.1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 1.6.1
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
   name: test-unit
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 2.0.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: !binary |-
-          MA==
-    none: false
+        version: 2.0.0
   prerelease: false
   type: :development
-description: MediaWiki API and parser
+description: MediaWiki API and Page content parser for Headlines, Blocks, Elements, ListItems, and Links.
 email:
 - dennis@blommesteijn.com
 executables: []
@@ -123,11 +104,13 @@ files:
 - test/test_helper.rb
 - test/unit/files/Wiktionary_Welcome,_newcomers.html
 - test/unit/wiki_connect.rb
+- test/unit/wiki_page_config.rb
 - test/unit/wiki_page_object.rb
 - wiki-api.gemspec
-homepage: ''
+homepage: https://github.com/dblommesteijn/wiki-api
 licenses:
 - MIT
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -136,30 +119,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key:
-specification_version: 3
-summary: MediaWiki API and parser
+specification_version: 4
+summary: MediaWiki API and Page content parser for Headlines, Blocks, Elements, ListItems, and Links.
 test_files:
 - test/test_helper.rb
 - test/unit/files/Wiktionary_Welcome,_newcomers.html
 - test/unit/wiki_connect.rb
+- test/unit/wiki_page_config.rb
 - test/unit/wiki_page_object.rb