hyper_navigator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 153aa069f454992869ca73604cfd58b63abceb83
+  data.tar.gz: 8753b08c926a28fd9e29bf7b401ccab668340245
+SHA512:
+  metadata.gz: a69db4f2c27ca273580b5eceab5535a7591e866bcba43f066cf0d87da3593450ac60dd90abc3384da5e6910f2d9054fe8a6d0a39e8d966710306bbb2ce7c9481
+  data.tar.gz: 42a615509a65e5b9fb46ef341feaebfa9f53b0ad4573ac2cb9b5e16a416f8feb6aaa3d1d21bcd6e7fa162258446eb91dd0f8029081b30e72e2fbb8604ab0042d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 105003+carld@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 hyper_navigator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Douglas
+
+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,93 @@
+# HyperNavigator
+
+A RESTful resource client that fetches documents following a given path.
+
+It expects each resource to return a structure in the given format:
+
+```JSON
+{
+  "links": [
+    {
+      "rel": "apple",
+      "href": "/path/to/apple"
+    },
+    {
+      "rel": "banana",
+      "href": "/path/to/banana"
+    }
+  ]
+}
+
+The main entry point for this gem is
+
+```ruby
+  HyperNavigator.surf(url, traversal-path)
+```
+
+The `traversal-path` argument provided is an array of `rel` names.  This array should contain the rel names in order of traversal.
+
+An example path, that will look for an `apple` rel in the resource, fetch from it's corresponding href, then look for a `pudding` rel in that resource and fetch its corresponding href:
+
+```ruby
+  traversal-path = ["apple", "pudding"]
+
+  HyperNavigator.surf("https://fruitful-resources.io", traversal-path)
+```
+
+The return value of `#surf` will be a `HyperNavigator::Node`.
+
+Some useful attributes of `HyperNavigator::Node` are:
+
+- `response`, what the HTTP service returned
+- `rel`, the rel name for the resource that fetched this document
+- `href`, the href the resource was fetched from
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hyper_navigator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hyper_navigator
+
+## Usage
+
+`#surf` will return all nodes encountered during a browse.
+`#surf_to_leaves` will return just the leaf nodes during a browse.
+
+Example usage:
+
+```ruby
+  require 'hyper_navigator'
+
+  path = ["apple", "pudding"]
+  headers = { "Authorization": "Bearer #{$token}" }
+
+  result = HyperNavigator.surf_to_leaves('https://fruitful-resources.io', path, headers)
+```
+
+## 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/carld/hyper_navigator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HyperNavigator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/carld/hyper_navigator/blob/master/CODE_OF_CONDUCT.md).

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 "hyper_navigator"
+
+# 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/hyper_navigator.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hyper_navigator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hyper_navigator"
+  spec.version       = HyperNavigator::VERSION
+  spec.authors       = ["Carl Douglas"]
+  spec.email         = ["105003+carld@users.noreply.github.com"]
+
+  spec.summary       = %q{Automate navigation of networks of Hypertext as the Engine of Application State}
+  spec.description   = %q{Automate navigation of networks of Hypertext as the Engine of Application State}
+  spec.homepage      = ""
+  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"] = "TODO: Set to 'http://mygemserver.com'"
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/hyper_navigator/node.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module HyperNavigator
+
+  def self.get(href, headers={})
+    uri = URI.parse(href)
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.scheme == 'https'
+    request = Net::HTTP::Get.new(uri.request_uri, headers)
+
+    http.request(request)
+  end
+
+  def self.post(href, body, headers={})
+    uri = URI.parse(href)
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true if uri.scheme == 'https'
+    request = Net::HTTP::Post.new(uri.request_uri, headers)
+    request.body = body
+
+    http.request(request)
+  end
+
+  class Node
+
+    attr_reader :ancestor, :descendants, :rel, :href, :depth, :response, :path
+
+    def initialize(rel, href, ancestor=nil, depth=nil, path=nil, headers={})
+      @ancestor = ancestor
+      @descendants = []
+      @rel = rel
+      @href = href
+      @depth = depth
+      @path = path
+      @headers = headers
+
+      @response = HyperNavigator.get(href, headers)
+      @descendants = follow_links
+    end
+
+    private
+
+    def links
+      json = JSON.parse(@response.body) rescue nil
+      return [] unless json
+      # If we've been given a path then only follow the links in the path
+      if @path
+        json["links"].select { |link| link["rel"] == @path.first }
+      else
+        json["links"].reject {|i| ["self","up","next","prev"].any?{|r| r == i["rel"]} }
+      end
+    end
+
+    def next_step
+      return @path.drop(1) if @path
+      nil
+    end
+
+    def follow_links
+      links.map do |link|
+        Node.new(link["rel"], link["href"], self, @depth + 1, next_step, @headers)
+      end
+    end
+
+  end
+end

data/lib/hyper_navigator/version.rb

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

data/lib/hyper_navigator.rb

@@ -0,0 +1,26 @@
+require "hyper_navigator/version"
+require "hyper_navigator/node"
+
+module HyperNavigator
+
+  def self.surf(home, path=nil, headers={})
+    root = Node.new('rel', home, nil, 0, path, headers)
+    nodes = lambda do |node|
+      node.descendants + node.descendants.flat_map {|d| nodes.call(d) }
+    end
+    nodes.call(root)
+  end
+
+  def self.surf_to_leaves(home, path=nil, headers={})
+    root = Node.new('rel', home, nil, 0, path, headers)
+    nodes = lambda do |node|
+      if node.descendants.empty?
+        node
+      else
+        node.descendants.flat_map {|d| nodes.call(d) }
+      end
+    end
+    nodes.call(root)
+  end
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: hyper_navigator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Douglas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !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: Automate navigation of networks of Hypertext as the Engine of Application
+  State
+email:
+- 105003+carld@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hyper_navigator.gemspec
+- lib/hyper_navigator.rb
+- lib/hyper_navigator/node.rb
+- lib/hyper_navigator/version.rb
+homepage: ''
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Automate navigation of networks of Hypertext as the Engine of Application
+  State
+test_files: []