wik 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8010372cb4c94c11e2e50fab27a2b58ac5b79fd6
+  data.tar.gz: 38bee032bfda2048e3dce6f3fa9459a0e14ed4b9
+SHA512:
+  metadata.gz: 2b775f5234a53db595ade5f00ffce3f939d0f2954f9ec192b8ee3656f3bd63688b87325d1e1f959efd23d721621336fc2a00f5f7dbd0eba98e046d9ea05883b8
+  data.tar.gz: c315b58dd5aa29880cd85354825a93f8e735119f195ce595a051a13b1aea07469d5ee53aad7908599323f013c59ae60efa3929322148d58445ef3d90346dd16b

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.rake_tasks~

@@ -0,0 +1,6 @@
+build
+clean
+clobber
+install
+install:local
+release[remote]

data/API.md

@@ -0,0 +1,123 @@
+# Wik's Ruby API
+
+## Getting Started
+
+### Install
+Getting started is simple, first install the gem:
+
++ `sudo gem install wik`
+
+### Trying it out
+Now that we have Wik installed, lets play around with it in `irb`:
+
+```
+daniel@pancake:~/wik$ irb
+irb(main):001:0> require "wik" # Get the modules from the wik gem
+=> true
+irb(main):002:0> include Wik # Load in the module "Wik"
+=> Object
+irb(main):003:0> find("api", 2) # Query Wikipedia for the first two results under "api"
+Total hits : 11280
+Displaying 2 results:
+
+'Application programming interface'
+
+'API gravity'
+=> {"batchcomplete"=>"", "continue"=>{"sroffset"=>2, "continue"=>"-||"}, "query"=>{"searchinfo"=>...
+```
+
+Great, we just ran a simple find function for "api", we limited the output, and the function
+returned to us a hash with all the raw data we could ever want, straight from Wikipedia.
+
+### Simple scripting
+Now lets see how we can script our own little search tool.
+
+```
+# wiki_search.rb
+
+# Load all the good stuff
+require "wik"
+include Wik
+
+# Ask the user what to do
+puts "Should we [1] Find based on topic, [2] Search for a page, [3] Describe a page, or [4] View by page title?"
+print "[1/2/3] > "
+choice = gets.chomp.to_i
+
+# Run the magic
+case choice
+  when 1
+    print "Find what? > "
+    find(gets.chomp)
+  when 2
+    print "Search what? > "
+    search(gets.chomp)
+  when 3
+    print "View what? > "
+    view(gets.chomp)
+  else
+    puts "Did't get that..."
+    exit
+end
+```
+
+Nice, now we have a simple search tool we can run on our own.
+
+## search(phrase, limit=5, description=true, display=true)
+
+### Usage
+Searching Wikipedia is done easily with `search()`, for example, running
+`search("page")` will search for "page" and return a hash with raw data,
+but also print the useful data to console.
+
+### Arguments
++ `phrase`
+  - A string to search for, don't worry, whitespace is delt with automatically
++ `limit`
+  - An integer telling the maximum number of results allowed back, default 5
++ `description`
+  - A boolean deciding if a short description should be printed out or not, default true
++ `display`
+  - A boolean that decides if any output should be put to the console, default true
+
+### Output
+
+```
+irb> search("ruby!", 1)
+Displaying 1 results:
+
+'Ruby (programming language)' : Ruby is a dynamic, reflective, object-oriented, general-purpose programming language. It was designed and developed in the mid-1990s by Yukihiro "Matz" Matsumoto in Japan.
+=> ["ruby!", ["Ruby (programming language)"], ["Ruby is a dynamic, reflective, object-oriented, general-purpose programming language. It was designed and developed in the mid-1990s by Yukihiro \"Matz\" Matsumoto in Japan."], ["https://en.wikipedia.org/wiki/Ruby_(programming_language)"]]
+```
+
+## find(phrase, limit=15, snippet=false, display=true)
+
+### Usage
+
+### Arguments
+
+### Output
+
+## info(titles=nil, ids=nil, display=true)
+
+### Usage
+
+### Arguments
+
+### Output
+
+## view(title=nil, id=nil)
+
+### Usage
+
+### Arguments
+
+### Output
+
+## describe(title=nil, id=nil)
+
+### Usage
+
+### Arguments
+
+### Output

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Daniel E
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Wik - Quick and easy Wikipedia searches
+
+## Wik makes it quick
+
+With Wik, you have access to all of Wikipedia, in your terminal.
+If you have to know something **NOW**, it's as simple as....
+
+ ▶ `wik wiki`
+
+Control is important, so a common action like searching is available with `wik -s keyword`.
+Once you know the name of a page, type `wik -v "page name"` for a full page view.
+To get just a summed up description of a page, run `wik -d "page name"`.
+If you ever just want to find a list of entries relating to a keyword, `wik -f topic` will do just that.
+
+## Installation
+
+Pretty easy, you only need to have Ruby installed.
+
++ `sudo gem install wik`
+
+## CLI Usage
+
+`wik hello, world!` - Automatically handle everything
+
+`wik -s keyword` - Search Wikipedia
+
+`wik -f topic` - Find a list of available pages about a topic
+
+`wik -v page name` - View "page name"
+
+`wik -d page name` - Get a short description of "page name"
+
+## [API](https://github.com/wlib/wik/blob/master/API.md)
+
+Wik has a comfortably simple API, have a look at [API.md](https://github.com/wlib/wik/blob/master/API.md)
+
+## Contribute
+
+Help me out if you have nothing better to do:
+
+[Fork the project](https://github.com/wlib/wik/fork)
+
+## [MIT License](https://github.com/wlib/wik/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/wik

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+# Wik - Quick and easy Wikipedia searches
+# Daniel Ethridge
+
+require "wik"
+include Wik
+require "wik/version"
+
+# If there are no arguments, display a message to help you remember what the program does
+if ARGV.length == 0
+  puts "Try to tell me what you need...`wik wiki`"
+  exit
+end
+
+help = """Wik is a quick and easy Wikipedia search tool for the command line, try it out:
+hello, world!   -   Automatically handle everything
+-s keyword      -   Search Wikipedia
+-f topic        -   Find a list of available pages about a topic
+-v api          -   View API
+-d ruby         -   Get a short description of ruby
+"""
+
+# Argument "parser" if you want to call it that
+case ARGV[0]
+  when "--help", "-h"
+    puts help
+    exit
+  when "--version", "-V"
+    puts "Wik v#{VERSION}"
+    exit
+  when "--search", "-s"
+    search(ARGV[1..-1].join(" "))
+    exit
+  when "--find", "-f"
+    find(ARGV[1..-1].join(" "))
+    exit
+  when "--view", "-v"
+    view(ARGV[1..-1].join(" "))
+    exit
+  when "--describe", "-d"
+    describe(ARGV[1..-1].join(" "))
+    exit
+  else
+    handle(ARGV[0..-1].join(" "))
+    exit
+end

data/lib/wik.rb

@@ -0,0 +1,149 @@
+#!/usr/bin/env ruby
+# Daniel Ethridge
+
+require 'uri'
+require 'open-uri'
+require 'json'
+require 'yaml'
+require 'io/console'
+
+module Wik
+  # Do a get request and, by default, return the response as parsed json
+  def get(endpoint, parse=true)
+    ua = "Wik-RubyGem (https://github.com/wlib/wik; danielethridge@icloud.com) Command Line Wikipedia"
+    body = open(endpoint, "User-Agent" => ua).read
+    if parse
+      return JSON.parse(body)
+    else
+      return body
+    end
+  end
+
+  # Do a search by phrase, returns a hash with full search data, but first prints the parsed search data
+  def find(phrase, limit=15, snippet=false, display=true)
+    search = phrase.split.join("_")
+    if snippet
+      endpoint = "https://en.wikipedia.org/w/api.php?action=query&format=json&list=search&srsearch=#{search}&srlimit=#{limit}"
+    else
+      endpoint = "https://en.wikipedia.org/w/api.php?action=query&format=json&list=search&srsearch=#{search}&srlimit=#{limit}&srprop"
+    end
+    hash = get(endpoint)
+    info = hash["query"]["searchinfo"]
+    results = hash["query"]["search"]
+    if display
+      puts "Total hits : #{ info["totalhits"] }"
+      if info["suggestion"]
+        puts "Suggestion : #{ info["suggestion"] }"
+      end
+      puts "Displaying #{results.length} results:"
+      results.each do |result|
+        # https://stackoverflow.com/a/1732454
+        if snippet
+          snip = result["snippet"].gsub( /<.*?>/, "" ).gsub( /&\w+;/, "" ).split.join(" ")
+          puts "\n'#{result["title"]}' : #{snip}..."
+        else
+          puts "\n'#{result["title"]}'"
+        end
+      end
+    end
+    return hash
+  end
+
+  # Open Search is a different way to search Wikipedia
+  # It returns descriptions automatically and has a more consistent typo-correct
+  def search(phrase, limit=5, description=true, display=true)
+    search = phrase.split.join("_")
+    endpoint = "https://en.wikipedia.org/w/api.php?action=opensearch&format=json&search=#{search}&limit=#{limit}"
+    hash = get(endpoint)
+    results = hash[1]
+    descriptions = hash[2]
+    if display
+      puts "Displaying #{results.length} results:"
+      for i in 0...results.length
+        if description
+          if ! descriptions[i].empty?
+            puts "\n'#{results[i]}' : #{descriptions[i]}"
+          else
+            puts "\n'#{results[i]}' : No Immediate Description Available. Try `wik -d #{results[i]}`"
+          end
+        else
+          puts "\n'#{results[i]}'"
+        end
+      end
+    end
+    return hash
+  end
+
+  # Get info for titles
+  def info(titles=nil, ids=nil, display=true)
+    if titles
+      if titles.is_a?(Array)
+        encoded = titles.join("|").split.join("_")
+      elsif titles.is_a?(String)
+        encoded = titles
+      else
+        puts "Titles should be a string or array"
+        return false
+      end
+      endpoint = "https://en.wikipedia.org/w/api.php?action=query&format=json&prop=info&inprop=url&titles=#{encoded}&redirects"
+    elsif ids
+      if ids.is_a?(Array)
+        encoded = ids.join("|").split.join("_")
+      elsif ids.is_a?(String)
+        encoded = ids
+      else
+        puts "ID's should be a string or array"
+        return false
+      end
+      endpoint = "https://en.wikipedia.org/w/api.php?action=query&format=json&prop=info&inprop=url&pageids=#{encoded}&redirects"
+    end
+    hash = get(endpoint)
+    pages = hash["query"]["pages"]
+    redirects = hash["query"]["redirects"]
+    if display
+      if redirects
+        redirects.each do |redirect|
+          puts "Redirected from '#{redirect["from"]}' to '#{redirect["to"]}'"
+        end
+      end
+      pages.keys.each do |id|
+        page = pages[id]
+        if page["missing"]
+          puts "The page '#{page["title"]}' is missing"
+        else
+          puts "The page '#{page["title"]}' has the ID: #{page["pageid"]}, and is written in #{page["pagelanguage"]}"
+        end
+      end
+    end
+    return hash
+  end
+
+  # Get the entire page of an entry
+  def view(title=nil, id=nil)
+    if title
+      encoded = title.split.join("_")
+      endpoint = "https://en.wikipedia.org/w/api.php?action=parse&format=json&prop=wikitext&page=#{encoded}&redirects"
+    elsif id
+      encoded = title.split.join("_")
+      endpoint = "https://en.wikipedia.org/w/api.php?action=parse&format=json&prop=wikitext&pageid=#{encoded}"
+    end
+    hash = get(endpoint)
+    page = hash["parse"]["wikitext"].to_s.gsub( '\n', "\n" )
+    tmp = Tempfile.new("wik-#{encoded}-")
+    tmp.puts page
+    system "less #{tmp.path}"
+    tmp.close
+    tmp.unlink
+    return hash
+  end
+
+  # Just give a description of an entry
+  def describe(title=nil, id=nil)
+    puts "In development..."
+  end
+
+  # Automatically handle the process of searching, redirecting, and viewing
+  def handle(input)
+    search(input)
+  end
+end

data/lib/wik/version.rb

@@ -0,0 +1,3 @@
+module Wik
+  VERSION = "0.1.0"
+end

data/wik.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wik/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "wik"
+  gem.version       = Wik::VERSION
+  gem.authors       = ["Daniel Ethridge"]
+  gem.email         = ["danielethridge@icloud.com"]
+  gem.license = 'MIT'
+
+  gem.summary       = %q{Wik - Quick and easy Wikipedia searches}
+  gem.homepage      = "https://github.com/wlib/wik"
+
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem.bindir        = "bin"
+  gem.executables   = ["wik"]
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.13"
+  gem.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: wik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Ethridge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- danielethridge@icloud.com
+executables:
+- wik
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rake_tasks~"
+- API.md
+- LICENSE
+- README.md
+- Rakefile
+- bin/setup
+- bin/wik
+- lib/wik.rb
+- lib/wik/version.rb
+- wik.gemspec
+homepage: https://github.com/wlib/wik
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wik - Quick and easy Wikipedia searches
+test_files: []