wikiscript 0.0.1 → 0.1.0

data/HISTORY.md

@@ -1,3 +1,3 @@
-### 0.0.1 / 2014-07-03
-
-* Everything is new. First release.
+### 0.0.1 / 2014-07-03
+
+* Everything is new. First release.

data/Manifest.txt

@@ -1,7 +1,10 @@
-HISTORY.md
-Manifest.txt
-README.md
-Rakefile
-lib/wikiscript.rb
-lib/wikiscript/client.rb
-lib/wikiscript/version.rb
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+lib/wikiscript.rb
+lib/wikiscript/client.rb
+lib/wikiscript/page.rb
+lib/wikiscript/version.rb
+test/helper.rb
+test/test_austria.rb

data/README.md

@@ -8,7 +8,18 @@
 
 ## Usage
 
-TBD
+Read-only access to wikikpedia pages.
+Example - Get wikitext source (via `en.wikipedia.org/w/index.php?action=raw&title=<title>`):
+
+
+    >> page = Wikiscript::Page.new( '2014_FIFA_World_Cup_squads' )
+    >> page.text
+    
+    The [[2014 FIFA World Cup]] is an international [[association football|football]]
+    tournament which is currently being held in Brazil from 12 June to 13 July 2014.
+    The 32 national teams involved in the tournament were required to register
+    a squad of 23 players, including three goalkeepers...
+
 
 ## Install
 
@@ -17,6 +28,11 @@ Just install the gem:
     $ gem install wikiscript
 
 
+## Alternatives
+
+TBD
+
+
 ## License
 
 The `wikiscript` scripts are dedicated to the public domain.

data/Rakefile

@@ -1,30 +1,30 @@
-require 'hoe'
-require './lib/wikiscript/version.rb'
-
-Hoe.spec 'wikiscript' do
-
-  self.version = Wikiscript::VERSION
-
-  self.summary = 'wikiscript - scripts for wikipedia (get wikitext for page etc.)'
-  self.description = summary
-
-  self.urls = ['https://github.com/wikiscript/wikiscript.ruby']
-
-  self.author = 'Gerald Bauer'
-  self.email = 'opensport@googlegroups.com'
-
-  # switch extension to .markdown for gihub formatting
-  self.readme_file = 'README.md'
-  self.history_file = 'HISTORY.md'
-
-  self.extra_deps = [
-    ['logutils' ]
-  ]
-
-  self.licenses = ['Public Domain']
-
-  self.spec_extras = {
-   :required_ruby_version => '>= 1.9.2'
-  }
-
-end
+require 'hoe'
+require './lib/wikiscript/version.rb'
+
+Hoe.spec 'wikiscript' do
+
+  self.version = Wikiscript::VERSION
+
+  self.summary = 'wikiscript - scripts for wikipedia (get wikitext for page etc.)'
+  self.description = summary
+
+  self.urls = ['https://github.com/wikiscript/wikiscript.ruby']
+
+  self.author = 'Gerald Bauer'
+  self.email = 'opensport@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.extra_deps = [
+    ['logutils' ]
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   :required_ruby_version => '>= 1.9.2'
+  }
+
+end

data/lib/wikiscript.rb

@@ -1,36 +1,37 @@
-## stdlibs
-
-require 'net/http'
-require 'uri'
-require 'json'
-require 'pp'
-require 'ostruct'
-
-
-## 3rd party gems/libs
-## require 'props'
-
-require 'logutils'
-
-
-# our own code
-
-require 'wikiscript/version' # let it always go first
-require 'wikiscript/client'
-
-
-module Wikiscript
-
-  def self.banner
-    "wikiscript/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
-  end
-
-  def self.root
-    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
-  end
-  
-end # module Wikiscript
-
-
-
-puts Wikiscript.banner
+## stdlibs
+
+require 'net/http'
+require 'uri'
+require 'json'
+require 'pp'
+require 'ostruct'
+
+
+## 3rd party gems/libs
+## require 'props'
+
+require 'logutils'
+
+
+# our own code
+
+require 'wikiscript/version' # let it always go first
+require 'wikiscript/client'
+require 'wikiscript/page'
+
+
+module Wikiscript
+
+  def self.banner
+    "wikiscript/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(__FILE__)) )}"
+  end
+  
+end # module Wikiscript
+
+
+
+puts Wikiscript.banner

data/lib/wikiscript/client.rb

@@ -1,62 +1,63 @@
-
-module Wikiscript
-
-  class Client
-
-    include LogUtils::Logging
-
-    SITE_BASE = 'http://en.wikipedia.org/w/index.php'
-
-    ### API_BASE  = 'http://en.wikipedia.org/w/api.php'
-
-    def initialize( opts={} )
-      @opts = opts
-    end
-
-    def text( title )
-      ## todo/fix: urlencode title ???
-      get( "?action=raw&title=#{title}" )
-    end
-
-private
-    ### fix: reuse code from fetcher gem!!!!
-    ##  do NOT duplicate!!! also cleanup jogo gem!!!!
-
-    def get( params )
-      uri = URI.parse( "#{SITE_BASE}?#{params}" )
-
-    
-      # new code: honor proxy env variable HTTP_PROXY
-      proxy = ENV['HTTP_PROXY']
-      proxy = ENV['http_proxy'] if proxy.nil?   # try possible lower/case env variable (for *nix systems) is this necessary??
-    
-      if proxy
-        proxy = URI.parse( proxy )
-        logger.debug "using net http proxy: proxy.host=#{proxy.host}, proxy.port=#{proxy.port}"
-        if proxy.user && proxy.password
-          logger.debug "  using credentials: proxy.user=#{proxy.user}, proxy.password=****"
-        else
-          logger.debug "  using no credentials"
-        end
-      else
-        logger.debug "using direct net http access; no proxy configured"
-        proxy = OpenStruct.new   # all fields return nil (e.g. proxy.host, etc.)
-      end
-
-      http_proxy = Net::HTTP::Proxy( proxy.host, proxy.port, proxy.user, proxy.password )
-
-      http = http_proxy.new( uri.host, uri.port )
-      response = http.request( Net::HTTP::Get.new( uri.request_uri ))
-
-      if response.code == '200'
-        t = response.body
-        ## pp t
-        t
-      else
-        logger.error "fetch HTTP - #{response.code} #{response.message}"
-        nil
-      end
-    end
-
-  end # class Client
-end # Wikiscript
+
+module Wikiscript
+
+  class Client
+
+    include LogUtils::Logging
+
+    SITE_BASE = 'http://en.wikipedia.org/w/index.php'
+
+    ### API_BASE  = 'http://en.wikipedia.org/w/api.php'
+
+    def initialize( opts={} )
+      @opts = opts
+    end
+
+    def text( title )
+      ## todo/fix: urlencode title ???
+      ## fix: use params hash!!!
+      get( "action=raw&title=#{title}" )
+    end
+
+private
+    ### fix: reuse code from fetcher gem!!!!
+    ##  do NOT duplicate!!! also cleanup jogo gem!!!!
+
+    def get( params )
+      uri = URI.parse( "#{SITE_BASE}?#{params}" )
+
+    
+      # new code: honor proxy env variable HTTP_PROXY
+      proxy = ENV['HTTP_PROXY']
+      proxy = ENV['http_proxy'] if proxy.nil?   # try possible lower/case env variable (for *nix systems) is this necessary??
+    
+      if proxy
+        proxy = URI.parse( proxy )
+        logger.debug "using net http proxy: proxy.host=#{proxy.host}, proxy.port=#{proxy.port}"
+        if proxy.user && proxy.password
+          logger.debug "  using credentials: proxy.user=#{proxy.user}, proxy.password=****"
+        else
+          logger.debug "  using no credentials"
+        end
+      else
+        logger.debug "using direct net http access; no proxy configured"
+        proxy = OpenStruct.new   # all fields return nil (e.g. proxy.host, etc.)
+      end
+
+      http_proxy = Net::HTTP::Proxy( proxy.host, proxy.port, proxy.user, proxy.password )
+
+      http = http_proxy.new( uri.host, uri.port )
+      response = http.request( Net::HTTP::Get.new( uri.request_uri ))
+
+      if response.code == '200'
+        t = response.body
+        ## pp t
+        t
+      else
+        logger.error "fetch HTTP - #{response.code} #{response.message}"
+        nil
+      end
+    end
+
+  end # class Client
+end # Wikiscript

data/lib/wikiscript/page.rb

@@ -0,0 +1,28 @@
+
+module Wikiscript
+
+  class Page
+
+    include LogUtils::Logging
+
+    attr_reader :title, :text
+
+    def initialize( title )
+      ## todo: check title
+      ## replace title spaces w/ _ ????
+      ##  to allow "pretty" titles - why? why not??
+
+      @title = title
+      @text  = nil
+    end
+    
+    def text
+      if @text.nil?
+        # cache text (from request)
+        @text = Client.new.text( @title )
+      end
+      @text
+    end
+
+  end # class Page
+end # Wikiscript

data/lib/wikiscript/version.rb

@@ -1,4 +1,5 @@
-
-module Wikiscript
-   VERSION = '0.0.1'
-end
+
+module Wikiscript
+   VERSION = '0.1.0'
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+# require 'minitest/unit'
+require 'minitest/autorun'
+
+# include MiniTest::Unit # lets us use TestCase instead of MiniTest::Unit::TestCase
+
+## our own code
+
+require 'wikiscript'
+

data/test/test_austria.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+
+require 'helper'
+
+
+class TestAustria < MiniTest::Unit::TestCase
+
+  def test_text
+    page = Wikiscript::Page.new( 'Austria' )
+    text = page.text
+
+    ## print first 600 chars
+    pp text[0..600]
+
+    ## check for some snippets
+    assert( /{{Infobox country/ =~ text ) 
+    assert( /common_name = Austria/ =~ text )
+    assert( /capital = \[\[Vienna\]\]/ =~ text )
+    assert( /The origins of modern-day Austria date back to the time/ =~ text )
+  end
+
+end # class TestAustria
+

metadata

@@ -1,57 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: wikiscript
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &73243800 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *73243800
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &73243290 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.0'
+  version_requirements: *73243290
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &73242780 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.10'
+  version_requirements: *73242780
 description: wikiscript - scripts for wikipedia (get wikitext for page etc.)
 email: opensport@googlegroups.com
 executables: []
@@ -67,11 +59,14 @@ files:
 - Rakefile
 - lib/wikiscript.rb
 - lib/wikiscript/client.rb
+- lib/wikiscript/page.rb
 - lib/wikiscript/version.rb
+- test/helper.rb
+- test/test_austria.rb
+- .gemtest
 homepage: https://github.com/wikiscript/wikiscript.ruby
 licenses:
 - Public Domain
-metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -79,19 +74,22 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 1.8.17
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: wikiscript - scripts for wikipedia (get wikitext for page etc.)
-test_files: []
+test_files:
+- test/test_austria.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 4fd62d114d9a91fc66c7ab7ff876c483b8f56492
-  data.tar.gz: 3035ff53b83b8cb4d110b1be3046adb6adb89f46
-SHA512:
-  metadata.gz: a580bfa164a812dded6a2d267fde47dfdf413bb2f587e9ce72d7b68af8af483be3ecd4e8d9036b3c4a54c11d41228c2808eba2d2076cffffb1ae766ba90b9e9b
-  data.tar.gz: 8cd5d6104a444cf9ce2edf904275d2a14fdd9c423806c1ccebc2dd7ee0b59d7cd866c96ec609ddb5fde208f06a02961df521135de37f739745869b5dc816a239