roadforest 0.0.3 → 0.1

data/lib/roadforest/http/user-agent.rb

@@ -0,0 +1,115 @@
+require 'roadforest/http'
+require 'roadforest/http/keychain'
+
+module RoadForest
+  module HTTP
+    class UserAgent
+      def initialize(http_client)
+        @http_client = http_client
+        @trace = nil
+        @cache = Hash.new do |cache, url|
+          cache[url] = {}
+        end
+      end
+
+      attr_accessor :http_client, :trace
+      attr_reader :cache
+
+      def make_request(method, url, headers = nil, body=nil, retry_limit=5)
+        headers ||= {}
+
+        method = method.to_s.upcase
+
+        validate(method, url, headers, body)
+
+        request = setup_request(method, url, headers, body)
+
+        response = send_request(request, retry_limit)
+
+        cache_response(url, response)
+
+        return response
+      end
+
+      def setup_request(method, url, headers, body)
+        request = Request.new(method, url)
+        request.headers.merge!(headers)
+        request.body = body
+        add_authorization(request)
+        add_cache_headers(request)
+        request
+      end
+
+      def send_request(request, retry_limit=5)
+        #Check expires headers on received
+
+        trace_message(request)
+        response = http_client.do_request(request)
+        trace_message(response)
+        case response.status
+        when 304 #Not Modified
+          response = cache.fetch(request.url).fetch(response.etag)
+          trace_message(response)
+          return response
+        when 401
+          #XXX What if challenge matches existing Auth header? i.e. current
+          #creds are wrong?
+          request.headers["Authorization"] = keychain.challenge_response(url, response.headers["WWW-Authenticate"])
+          raise Retryable
+        end
+        return response
+      rescue Retryable
+        raise unless (retry_limit -= 1) > 0
+        retry
+      end
+
+      def trace_message(message)
+        return unless @trace
+        @trace = $stderr unless @trace.respond_to?(:puts)
+        @trace.puts message.inspect
+      end
+
+      def keychain
+        @keychain ||= Keychain.new
+      end
+
+      def cache_response(url, response)
+        return if response.etag.nil?
+        return if response.etag.empty?
+        #XXX large bodies
+        cache[url][response.etag] = response
+      end
+
+      def validate(method, url, headers, body)
+        case method
+        when "GET", "HEAD", "DELETE"
+          raise "Method #{method} requires an empty body" unless body.nil?
+        when "POST", "PATCH", "PUT"
+          raise "Method #{method} requires a body" if body.nil?
+        #when "OPTION", "TRACE" #Need to put verbs where they go
+        else
+          raise "Unrecognized method: #{method}"
+        end
+      end
+
+      def add_authorization(request)
+        request.headers["Authorization"] = keychain.preemptive_response(request.url)
+      end
+
+      def add_cache_headers(request)
+        case request.method
+        when "GET"
+          return unless cache.has_key?(request.url)
+          cached = cache[request.url]
+          return if cached.empty?
+          request.headers["If-None-Match"] = cached.keys.join(", ")
+        when "POST", "PUT"
+          return unless cache.has_key?(request.url)
+          cached = cache[request.url]
+          return if cached.empty?
+          request.headers["If-Match"] = cached.keys.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/roadforest/http.rb

@@ -0,0 +1,8 @@
+module RoadForest
+  module HTTP
+    class Retryable < StandardError; end
+  end
+end
+
+require 'roadforest/http/message'
+require 'roadforest/http/graph-response'

data/lib/roadforest/model.rb

@@ -1,4 +1,8 @@
 require 'roadforest/rdf/graph-store'
+require 'roadforest/rdf/etagging'
+require 'roadforest/rdf/access-manager'
+require 'roadforest/rdf/graph-focus'
+
 module RoadForest
   class ProcessingSequenceError < StandardError
   end
@@ -15,7 +19,34 @@ module RoadForest
     attr_reader :response_values
 
     def path_for(route_name = nil, params = nil)
-      services.router.path_for(route_name, (params || self.params).to_hash)
+      services.router.path_for(route_name, params || self.params)
+    end
+
+    def url_for(route_name, params = nil)
+      Addressable::URI.parse(canonical_host.to_s).join(path_for(route_name, params))
+    end
+
+    def model_for(route_name = nil, params = nil)
+      services.router.model_for(route_name, params || self.params)
+    end
+
+    def required_grants(method)
+      services.authz.build_grants do |grants|
+        grants.add(:admin)
+      end
+    end
+
+    def authorization(method, header)
+      required = required_grants(method)
+      if required.empty?
+        :public
+      else
+        services.authz.authorization(header, required_grants(method))
+      end
+    end
+
+    def authentication_challenge
+      services.authz.challenge(:realm => "Roadforest")
     end
 
     def canonical_host
@@ -23,7 +54,7 @@ module RoadForest
     end
 
     def canonical_uri
-      Addressable::URI.parse(canonical_host.to_s).join(my_path)
+      url_for(route_name, params)
     end
 
     def type_handling
@@ -104,7 +135,6 @@ module RoadForest
 
   end
 
-  require 'roadforest/rdf/etagging'
   class RDFModel < Model
     include RDF::Etagging
 
@@ -141,6 +171,21 @@ module RoadForest
       return focus
     end
 
+    def copy_model(node, route_name, params=nil)
+      params ||= {}
+
+      url = url_for(route_name, params)
+      source_model = model_for(route_name, params)
+
+      access = RDF::CopyManager.new
+      access.source_graph = source_model.current_graph
+      access.target_graph = node.access_manager.destination_graph
+      copier = RDF::GraphFocus.new(access, url)
+
+      yield copier if block_given?
+      copier
+    end
+
     def etag
       @etag ||= etag_from(etag_graph)
     end

data/lib/roadforest/rdf/graph-focus.rb

@@ -78,7 +78,7 @@ module RoadForest::RDF
     end
 
     def inspect
-      "#<#{self.class.name}:0x#{"%x" % object_id} (#{subject.to_s}) #{forward_properties.inspect}>"
+      "#<#{self.class.name}:0x#{"%x" % object_id} s:(#{subject.to_s}) p->o:#{forward_properties.inspect}>" #ok
     end
     alias to_s inspect
 
@@ -151,7 +151,7 @@ module RoadForest::RDF
     end
 
     def add_list(property, extra=nil)
-      list = FocusList.new(nil, access_manager)
+      list = FocusList.new(::RDF::Node.new, access_manager)
       access_manager.insert([subject, normalize_property(property, extra), list.subject])
       yield list if block_given?
       return list
@@ -171,8 +171,10 @@ module RoadForest::RDF
 
     def unwrap_value(value)
       return nil if value.nil?
-      if value.respond_to? :object
+      if RDF::Literal === value
         value.object
+      elsif value == RDF.nil
+        nil
       else
         wrap_node(value)
       end

data/lib/roadforest/rdf/graph-store.rb

@@ -1,4 +1,5 @@
 require 'rdf'
+require 'roadforest/debug'
 require 'roadforest/rdf/vocabulary'
 require 'roadforest/rdf/normalization'
 
@@ -51,8 +52,9 @@ module RoadForest::RDF
     end
 
     def debug(message)
-      return if @debug_io.nil?
-      @debug_io.puts(message)
+      io = @debug_io || RoadForest.debug_io
+      return if io.nil?
+      io.puts(message)
     end
 
     def repository_dump(format = :turtle)

data/lib/roadforest/rdf/normalization.rb

@@ -1,3 +1,4 @@
+require 'addressable/uri'
 require 'rdf'
 
 module RoadForest::RDF
@@ -118,7 +119,11 @@ module RoadForest::RDF
         end
         vocab
       end
-      vocab[property]
+      begin
+        vocab[property]
+      rescue KeyError
+        raise KeyError, "No property #{property} in #{vocab.inspect} - (try: #{vocab.methods(false).sort.inspect})"
+      end
     end
 
     def expand_curie(from)

data/lib/roadforest/remote-host.rb

@@ -1,8 +1,11 @@
 require 'roadforest/rdf/source-rigor'
 require 'roadforest/rdf/source-rigor/credence-annealer'
 require 'roadforest/rdf/graph-store'
+require 'roadforest/http/user-agent'
 require 'roadforest/http/graph-transfer'
 require 'roadforest/http/adapters/excon'
+require 'roadforest/rdf/access-manager'
+require 'roadforest/rdf/graph-focus'
 
 module RoadForest
   class RemoteHost
@@ -26,10 +29,20 @@ module RoadForest
       @http_client ||= HTTP::ExconAdapter.new(url)
     end
 
+    def trace=(target)
+      user_agent.trace = target
+    end
+
+    def user_agent
+      @user_agent ||= HTTP::UserAgent.new(http_client)
+    end
+
     def graph_transfer
-      @graph_transfer ||= HTTP::GraphTransfer.new.tap do |transfer|
-        transfer.http_client = http_client
-      end
+      @graph_transfer ||= HTTP::GraphTransfer.new(user_agent)
+    end
+
+    def add_credentials(username, password)
+      user_agent.keychain.add(url, username, password)
     end
 
     def source_rigor
@@ -54,11 +67,13 @@ module RoadForest
     end
 
     def putting(&block)
+
       graph = build_graph_store
       access = RDF::UpdateManager.new
       access.rigor = source_rigor
       access.source_graph = graph
       updater = RDF::GraphFocus.new(access, url)
+
       annealer = RDF::SourceRigor::CredenceAnnealer.new(graph)
 
       annealer.resolve do
@@ -75,11 +90,13 @@ module RoadForest
 
     def posting(&block)
       require 'roadforest/rdf/post-focus'
+
       graph = build_graph_store
       access = RDF::PostManager.new
       access.rigor = source_rigor
       access.source_graph = graph
       poster = RDF::PostFocus.new(access, url)
+
       graphs = {}
       poster.graphs = graphs
 
@@ -91,6 +108,7 @@ module RoadForest
     end
 
     def getting(&block)
+
       graph = build_graph_store
       access = RDF::ReadOnlyManager.new
       access.rigor = source_rigor
@@ -106,10 +124,7 @@ module RoadForest
       elsif destination.respond_to?(:to_s)
         destination = destination.to_s
       end
-      request = HTTP::Request.new("PUT", destination)
-      request.body = io
-      request.headers["Content-Type"] = type
-      response = http_client.do_request request
+      response = user_agent.make_request("PUT", destination, {"Content-Type" => type}, io)
     end
 
     #TODO:

data/lib/roadforest/resource/rdf/read-only.rb

@@ -6,7 +6,7 @@ module RoadForest
     def self.registry_purpose; "resource type"; end
     extend Utility::ClassRegistry::Registrar
 
-    module RDF
+    module RDF #XXX This shouldn't be in RDF - resource roles are on the REST side
       #Used for a resource that presents a read-only representation
       class ReadOnly < Webmachine::Resource
         def self.register(method_name)
@@ -84,6 +84,20 @@ module RoadForest
 
         def content_types_provided
           model.type_handling.renderers.type_map
+        rescue => ex
+          super
+        end
+
+        def is_authorized?(header)
+          @authorization = @model.authorization(request.method, header)
+          if(@authorization == :public || @authorization == :granted)
+            return true
+          end
+          @model.authentication_challenge
+        end
+
+        #Add cache-control headers here
+        def finish_request
         end
 
         def resource_exists?

data/lib/roadforest/templates/base/doc.haml

@@ -0,0 +1,13 @@
+!!! XML
+!!! 5
+%html{:xmlns => "http://www.w3.org/1999/xhtml", :lang => lang, :prefix => prefix}
+  - if base || title
+    %head
+      - if base
+        %base{:href => base}
+      - if title
+        %title= title
+  %body
+    - subjects.each do |subject|
+      %div{subject.attrs}
+        != yield(subject)

data/lib/roadforest/templates/base/property_value.haml

@@ -0,0 +1,12 @@
+- if heading_predicates.include?(predicate) && object.literal?
+  %h1{object.simple_attrs}= escape_entities(get_value(object.object))
+- else
+  %div.property
+    %span.label
+      = get_predicate_name(predicate)
+    - if object.is_subject?
+      %div{object.attrs}= yield object
+    - elsif object.attrs.empty?
+      = yield object
+    - else
+      %span{object.attrs}<= yield object

data/lib/roadforest/templates/base/property_values.haml

@@ -0,0 +1,6 @@
+%div.property
+  %span.label
+    = get_predicate_name(predicate)
+  %ul
+    - objects.each do |object|
+      %li{object.attrs}<= yield(object)

data/lib/roadforest/templates/base/subject.haml

@@ -0,0 +1,4 @@
+- if typeof
+  %span.type!= typeof
+- predicates.each do |predicate|
+  != yield(predicate)

data/lib/roadforest/templates/distiller/doc.haml

@@ -0,0 +1,20 @@
+!!! XML
+!!! 5
+%html{:xmlns => "http://www.w3.org/1999/xhtml", :lang => lang, :prefix => prefix}
+  - if base || title
+    %head
+      - if base
+        %base{:href => base}
+      - if title
+        %title= title
+      %link{:rel => "stylesheet", :href => "http://rdf.kellogg-assoc.com/css/distiller.css", :type => "text/css"}
+      %script{:src => "https://ajax.googleapis.com/ajax/libs/jquery/1.5.1/jquery.min.js", :type => "text/javascript"}
+      %script{:src => "http://rdf.kellogg-assoc.com/js/distiller.js", :type => "text/javascript"}
+  %body
+    - if base
+      %p= "RDFa serialization URI base: <#{base}>"
+    - subjects.each do |subject|
+      %td{subject.attrs}
+        != yield(subject)
+    %footer
+      %p= "Written by <a href='http://rubygems.org/gems/rdf-rdfa'>RDF::RDFa</a> version #{RDF::RDFa::VERSION}"

data/lib/roadforest/templates/distiller/nil-object.haml

@@ -0,0 +1 @@
+Empty

data/lib/roadforest/templates/distiller/property_value.haml

@@ -0,0 +1,7 @@
+- if heading_predicates.include?(predicate) && object.literal?
+  %h1{object.simple_attrs}= escape_entities(get_value(object.object))
+- else
+  %tr.property
+    %td.label
+      = get_predicate_name(predicate)
+    %td{object.attrs}<= yield(object)

data/lib/roadforest/templates/distiller/property_values.haml

@@ -0,0 +1,7 @@
+%tr.property
+  %td.label
+    = get_predicate_name(predicate)
+  %td
+    %ul
+      - objects.each do |object|
+        %li{object.attrs}<= yield(object)

data/lib/roadforest/templates/distiller/subject.haml

@@ -0,0 +1,5 @@
+- if typeof
+  %span.type!= typeof
+%table.properties
+  - predicates.each do |predicate|
+    != yield(predicate)

data/lib/roadforest/templates/min/doc.haml

@@ -0,0 +1,10 @@
+!!! XML
+!!! 5
+%html{:xmlns => "http://www.w3.org/1999/xhtml", :lang => lang, :prefix => prefix}
+  - if base
+    %head
+      %base{:href => base}
+  %body
+    - subjects.each do |subject|
+      %div{subject.attrs}<
+        != yield(subject)

data/lib/roadforest/templates/min/property_values.haml

@@ -0,0 +1,7 @@
+- objects.each do |object|
+  - if object.is_subject?
+    %div{object.attrs}!= yield(object)
+  - elsif object.attrs.empty?
+    != yield(object)
+  - else
+    %span{object.attrs}!= yield(object)

data/lib/roadforest/templates/min/subject.haml

@@ -0,0 +1,2 @@
+- predicates.each do |predicate|
+  != yield(predicate)

data/lib/roadforest/templates/node-object.haml

@@ -0,0 +1 @@
+=get_curie(object)

data/lib/roadforest/templates/object.haml

@@ -0,0 +1 @@
+#{escape_entities(get_value(object))}

data/lib/roadforest/templates/uri-object.haml

@@ -0,0 +1 @@
+%a{:property => get_curie(predicate), :href => object.to_s, :inlist => inlist}= object.to_s

data/lib/roadforest/templates/xml-literal-object.haml

@@ -0,0 +1 @@
+!~ get_value(object)

data/lib/roadforest/utility/class-registry.rb

@@ -46,6 +46,10 @@ module RoadForest
         @classes[name.to_s] = klass
       end
 
+      def names
+        @classes.keys.select{|key| key.is_a? Symbol}
+      end
+
       def get(name)
         @classes.fetch(name)
       rescue KeyError