wiki-yggdrasil 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb439b993ec8d953183a78347ba0823ea19f93351315965e22df8765d157ecaa
+  data.tar.gz: dec29e7e24a77c1a15bbd0a8af3bac4b5e552cd2de0e4d267e156e05a94a2556
+SHA512:
+  metadata.gz: 240261bfd3dd92c15ac716e50ab7951750dd9738560fbed4cf5ff5a6e7ed6a8ef3d1d3fe093fdfab5de66074b2562ed7db383a63128782c31d9662c84b8f9602
+  data.tar.gz: 819209e6592bc880931476265e8c6e5a9d365923966c5229868f4e5ddd6ce5759a0c710bb0e25de3a69ce241154ced34a4032ef87a695b7de4ec2f3a87042780

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore Gemfile.lock
+*.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in wiki-yggdrasil.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 alex0112
+
+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,55 @@
+# Wiki::Yggdrasil
+![Travis CI Build](https://travis-ci.org/alex0112/wiki-yggdrasil.svg?branch=master)
+
+You.  You're up late at night again reading up on some obscure mathematical topic.  You find yourself with *so many* open tabs on Wikipedia.  Wouldn't it be nice if you could just pick an article, and then view a tree of the articles it references?
+
+Introducing Wiki::Yggdrasil.  Named after the tree in Norse mythology that drinks from the well of all wisdom, Wiki::Yggdrasil is here to help you drink just as deeply from the well of wisdom that is Wikipedia.
+
+Wiki::Yggdrasil takes a Wikipedia URI as an argument, and proceeds to spider out a dependency tree of referenced articles.
+
+## Usage
+```ruby
+require 'wiki/yggdrasil'
+
+@tree               = Wiki::Yggdrasil::Yggdrasil.new(uri: 'http://en.wikipedia.org/wiki/Yggdrasil')
+referenced_articles = @tree.children(depth: 3) ## A hash of of articles linked by the parent
+```
+
+## FAQ
+
+### This is taking a long time.  Is that normal?
+Yes.  This is normal. Any Yggdrasil object created with a depth of three or higher will likely take a few minutes to scrape the necessary information.
+
+### Why didn't you just use Wikipedia's API?
+Wikipedia's API doesn't have an endpoint that allows you to programatically view the summary section of each article and its children.  If it did that would obviously be the ideal choice.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wiki-yggdrasil'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wiki-yggdrasil
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alex0112/wiki-yggdrasil.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wiki/yggdrasil"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wiki/article.rb

@@ -0,0 +1,43 @@
+require 'nokogiri'
+require 'open-uri'
+module Wiki::Yggdrasil
+  
+  class Article
+    attr_reader :uri
+    
+    def initialize(uri:)
+      raise ArgumentError unless Wiki::Yggdrasil::Article.is_valid_wiki_article?(uri: uri)
+      @uri         = uri
+      @summary     = nil
+      @child_links = nil
+    end
+
+    def summary
+      @summary ||= Nokogiri::HTML(Nokogiri::HTML(open(self.uri)).to_s.split('<div id="toc" class="toc">')[0]).css('p') ## TODO: Cleanup
+    end
+
+    def child_links
+      formatted_links = format_links
+      validated_links =  formatted_links.select { |uri| Wiki::Yggdrasil::Article.is_valid_wiki_article?(uri: uri) }
+      @child_links  ||= validated_links
+    end
+
+    def scrape_all_summary_links
+      self.summary.css('p a')
+    end
+
+    def format_links(anchors: self.scrape_all_summary_links)
+      uris = anchors.map do |anchor|
+        anchor.nil? || anchor['href'].nil? ? next : 'https://en.wikipedia.org' << anchor['href'] ## nil href attributes are often self refs (but possibly not always). Ignore them.
+      end
+
+      uris.compact
+    end
+    
+    def self.is_valid_wiki_article?(uri:)
+      ## Is this URI a wikipedia article?
+      uri =~ /.*wikipedia\.org\/wiki\/.+/ ? true : false
+    end
+    
+  end
+end

data/lib/wiki/yggdrasil/version.rb

@@ -0,0 +1,5 @@
+module Wiki
+  module Yggdrasil
+    VERSION = "0.1.0"
+  end
+end

data/lib/wiki/yggdrasil.rb

@@ -0,0 +1,33 @@
+require "wiki/yggdrasil/version"
+
+module Wiki
+  module Yggdrasil
+    require 'wiki/article'
+    
+    class Yggdrasil
+      attr_reader :root
+
+      def initialize(uri:)
+        @root     = Wiki::Yggdrasil::Article.new(uri: uri)
+        @children = nil
+      end
+
+      def children(depth: 4, article_children: self.root.child_links)
+        get_children = lambda do |depth, article_children|
+          article_children.each_with_object({}) do |uri, tree|
+            if (depth == 1)
+              tree[uri] = nil
+            else
+              article   = Wiki::Yggdrasil::Article.new(uri: uri)
+              @children = tree
+              tree[uri] = get_children.call(depth - 1, article.child_links)
+            end
+          end
+        end
+
+        @children ||= get_children.call(depth, article_children)
+      end
+
+    end
+  end
+end

data/wiki-yggdrasil.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "wiki/yggdrasil/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "wiki-yggdrasil"
+  spec.version       = Wiki::Yggdrasil::VERSION
+  spec.authors       = ["alex0112"]
+  spec.email         = ["alarsen0112@gmail.com"]
+
+  spec.summary       = %q{ Scrape Wikipedia articles and generate a json tree }
+  spec.description   = %q{ Given a Wikipedia article, generate a tree of linked articles from the summary of the first.}
+  spec.homepage      = "https://github.com/alex0112/wiki-yggdrasil"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.8.2"
+  
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: wiki-yggdrasil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alex0112
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: " Given a Wikipedia article, generate a tree of linked articles from
+  the summary of the first."
+email:
+- alarsen0112@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wiki/article.rb
+- lib/wiki/yggdrasil.rb
+- lib/wiki/yggdrasil/version.rb
+- wiki-yggdrasil.gemspec
+homepage: https://github.com/alex0112/wiki-yggdrasil
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.4
+signing_key: 
+specification_version: 4
+summary: Scrape Wikipedia articles and generate a json tree
+test_files: []