hyper_navigator 0.1.0 → 0.2.0

checksums.yaml

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

data/README.md

@@ -21,17 +21,17 @@ It expects each resource to return a structure in the given format:
 The main entry point for this gem is
 
 ```ruby
-  HyperNavigator.surf(url, traversal-path)
+  HyperNavigator.surf(href, traversal_pattern)
 ```
 
-The `traversal-path` argument provided is an array of `rel` names.  This array should contain the rel names in order of traversal.
+The `traversal_pattern` 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"]
+  traversal_pattern = ["apple", "pudding"]
 
-  HyperNavigator.surf("https://fruitful-resources.io", traversal-path)
+  HyperNavigator.surf("https://fruitful-resources.io", traversal_pattern)
 ```
 
 The return value of `#surf` will be a `HyperNavigator::Node`.
@@ -61,7 +61,6 @@ Or install it yourself as:
 ## Usage
 
 `#surf` will return all nodes encountered during a browse.
-`#surf_to_leaves` will return just the leaf nodes during a browse.
 
 Example usage:
 
@@ -71,9 +70,17 @@ Example usage:
   path = ["apple", "pudding"]
   headers = { "Authorization": "Bearer #{$token}" }
 
-  result = HyperNavigator.surf_to_leaves('https://fruitful-resources.io', path, headers)
+  result = HyperNavigator.surf("https://fruitful-resources.io", traversal_pattern, headers)
 ```
 
+### Pattern Matching
+
+The traversal pattern can contain the special matching symbols `:any` and `:star`.
+They are analogous to the regular expression metacharacters `.` and `*`.
+
+`:any` will match any rel.
+`:star` matches the preceding element zero or more times.
+
 ## 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.

data/examples/surf.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optparse"
+require "ostruct"
+require "hyper_navigator"
+require "pp"
+
+options = OpenStruct.new
+options.verbose = false
+
+OptionParser.new do |opts|
+  opts.banner ="Usage: #{ARGV[0]} [options]"
+  opts.on("-uURL", "--root-url=URL", "required root URL") do |url|
+    options.url = url
+  end
+  opts.on("-pPATTERN", "--pattern=PATTERN", "required traversal pattern") do |pattern|
+    options.pattern = eval(pattern)
+  end
+  opts.on("-a[AUTH_URL]", "--auth-url=[AUTH_URL]") do |url|
+    options.auth_url = url
+  end
+  opts.on("-v", "--verbose") do |v|
+    options.verbose = true
+  end
+end.parse!
+
+CLIENT_ID=ENV['CLIENT_ID']
+CLIENT_SECRET=ENV['CLIENT_SECRET']
+
+if options.auth_url
+  headers = {"Content-type" => "application/x-www-form-urlencoded"}
+  body = URI.encode_www_form(
+    "client_id" => CLIENT_ID,
+    "client_secret" => CLIENT_SECRET,
+    "grant_type" => "client_credentials",
+    "response_type" => "code")
+  response = HyperNavigator.post(options.auth_url, body, headers)
+  json = JSON.parse(response.body)
+  $token = json['id_token']
+  options.headers = { "Authorization" => "Bearer #{$token}" }
+else
+  options.headers = {}
+end
+
+result = HyperNavigator.surf(options.url, options.pattern, options.headers, { :verbose => options.verbose })
+
+result.map do |n|
+  pp JSON.parse(n.response.body) rescue nil
+end

data/lib/hyper_navigator.rb

@@ -3,24 +3,8 @@ 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)
+  def self.surf(root_url, exp, headers={}, options={})
+    PatternMatcher.new(headers, options).match(root_url, exp).flatten_branch
   end
 
 end

data/lib/hyper_navigator/node.rb

@@ -25,46 +25,105 @@ module HyperNavigator
     http.request(request)
   end
 
-  class Node
-
-    attr_reader :ancestor, :descendants, :rel, :href, :depth, :response, :path
+  class PatternMatcher
 
-    def initialize(rel, href, ancestor=nil, depth=nil, path=nil, headers={})
-      @ancestor = ancestor
-      @descendants = []
-      @rel = rel
-      @href = href
-      @depth = depth
-      @path = path
+    def initialize(headers,opts={})
+      @opts = opts
       @headers = headers
+    end
 
-      @response = HyperNavigator.get(href, headers)
-      @descendants = follow_links
+    def match(href, exp)
+      match_here(exp, Node.new(:root, href, @headers, 0))
     end
 
-    private
+    def match_here(exp, node)
+      if exp == nil
+        return node
+      elsif exp[1] == :star
+        match_star(exp[0], exp.drop(2), node)
+        return node
+      elsif exp[0] == :any
+        match_here_descendants(exp, node)
+        return node
+      elsif exp[0] == node.rel
+        match_here_descendants(exp, node)
+        return node
+      end
+      return NullNode.new
+    end
 
-    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 }
+    def match_here_descendants(exp, node)
+      links = node.links.map {|link| make_node(link, node.depth + 1)}
+      descendants = links.map {|n| match_here(exp.drop(1), n) }
+      node.descendants = descendants.select {|d| d.class == Node }
+    end
+
+    def match_star(exp_star, exp, node)
+      # in case of zero matches, exp can match here
+      node_here = match_here(exp, node)
+
+      if node_here.is_a? NullNode
+        match_star_descendants(exp_star, exp, node)
+      end
+    end
+
+    def match_star_descendants(exp_star, exp, node)
+      if exp_star == :any
+        links = node.links
       else
-        json["links"].reject {|i| ["self","up","next","prev"].any?{|r| r == i["rel"]} }
+        links = node.links.select { |link| link["rel"] == exp_star }
       end
+
+      node.descendants = links.map { |link| make_node(link, node.depth + 1) }
+      node.descendants.map {|desc| match_star(exp_star, exp, desc) }
     end
 
-    def next_step
-      return @path.drop(1) if @path
-      nil
+    def make_node(link, depth=nil)
+      padding = '  ' * depth
+      puts "#{padding}#{link}" if @opts[:verbose]
+      Node.new(link["rel"], link["href"], @headers, depth)
     end
 
-    def follow_links
-      links.map do |link|
-        Node.new(link["rel"], link["href"], self, @depth + 1, next_step, @headers)
+  end
+
+  class Node
+
+    IGNORE_REFS = ["self", "up", "next", "prev"]
+
+    attr_reader :rel, :href, :headers, :response
+    attr_accessor :descendants, :depth
+
+    def initialize(rel, href, headers={}, depth=nil)
+      @rel = rel
+      @href = href
+      @headers = headers
+      @descendants = []
+      @depth = depth
+      if href
+        @response = HyperNavigator.get(href, headers)
+        raise RuntimeError, @response unless @response.code =~ /^2..$/
       end
     end
 
+    def links
+      @cached_links ||= begin
+        json = JSON.parse(@response.body) rescue nil
+        return [] unless json
+        json["links"].reject do |i|
+          IGNORE_REFS.any? { |r| r == i["rel"] }
+        end
+      end
+    end
+
+    def flatten_branch
+      descendants + descendants.flat_map { | d| d.flatten_branch }
+    end
+
+  end
+
+  class NullNode < Node
+    def initialize()
+      super(nil, nil)
+    end
   end
-end
+end

data/lib/hyper_navigator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyper_navigator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Carl Douglas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2018-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/surf.rb
 - hyper_navigator.gemspec
 - lib/hyper_navigator.rb
 - lib/hyper_navigator/node.rb