triannon 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c06b2318bdc1a94d4146dc592bb7b4fcb342f15b
-  data.tar.gz: 0ff0a8f5ead3e6f81b43581608de22f9024db270
+  metadata.gz: 2548790e908598e117e457e7e2d051e30a9f40e4
+  data.tar.gz: 92b887940f9dcc100cb1c6aeca47f44b1aa2f641
 SHA512:
-  metadata.gz: 40452508dfc9e3a9a131ab837b4e1042d38fa2fdcb11d4dd6066e492f0a287d832a8858c2985866d92e8d48302110d250794a602bcd88a4fad434cc633e90df5
-  data.tar.gz: 91b264efab1f7449eed84376f5b8019f2a734ad43037377908e0d6c269f90529a8c2a2f4125d3b2bb03a92972892d3a79526d1403ba3379d497456a8815457d6
+  metadata.gz: 1fefd1bc5ea2b5e8d69d2c48c4cd7d8422ba861815f6ad79b89a44abf05bd2d81588e2226f41f2c8ab823741e56188023da18b4429ba7eb520dc1b46a7f42ba6
+  data.tar.gz: 87e9f142299da474e9f4ea8ba7405efa549429e883d2d0350986814571dd4d73bee2ad9cc993d2061b55949530cf8e8c6c48188725172a31087e1800bcb35de5

data/Rakefile

@@ -11,13 +11,9 @@ require 'jettywrapper'
 
 require 'engine_cart/rake_task'
 desc 'run the triannon specs'
-task :ci => ['engine_cart:generate', 'jetty:clean'] do
-  # run the tests
+task :ci => 'engine_cart:generate' do
   RAILS_ENV = 'test'
-  jetty_params = Jettywrapper.load_config.merge({:jetty_home => File.expand_path(File.dirname(__FILE__) + '/jetty')})
-  Jettywrapper.wrap(jetty_params) do
-    Rake::Task['spec'].invoke
-  end
+  Rake::Task['spec'].invoke
 end
 
 namespace :triannon do

data/app/controllers/triannon/annotations_controller.rb

@@ -4,9 +4,11 @@ module Triannon
   class AnnotationsController < ApplicationController
     include RdfResponseFormats
 
+    rescue_from Triannon::LDPStorageError, with: :ldp_storage_error
+    rescue_from Triannon::ExternalReferenceError, with: :ext_ref_error
+    rescue_from Triannon::SearchError, with: :search_error
     before_action :default_format_jsonld, only: [:show]
     before_action :set_annotation, only: [:show, :update, :destroy]
-    rescue_from Triannon::ExternalReferenceError, with: :ext_ref_error
 
     # GET /annotations
     def index
@@ -133,9 +135,21 @@ private
       @annotation = Annotation.find(params[:id])
     end
 
-    # handle Triannon::ExternalReferenceError
-    def ext_ref_error(exception)
-      render plain: exception.message, status: 403
+    # render Triannon::ExternalReferenceError
+    def ext_ref_error(err)
+      render plain: err.message, status: 403
+    end
+
+    # render Triannon::LDPStorage error
+    def ldp_storage_error(err)
+      render :body => "<h2>#{err.message}</h2>" + err.ldp_resp_body, status: err.ldp_resp_status, content_type: "text/html"
+    end
+
+    # render Triannon::SearchError
+    def search_error(err)
+      render :body => "<h2>#{err.message}</h2>" + (err.search_resp_body ? err.search_resp_body : ""),
+        status: err.search_resp_status ? err.search_resp_status : 400,
+        content_type: "text/html"
     end
 
     # render json_ld respecting requested context

data/app/controllers/triannon/search_controller.rb

@@ -5,6 +5,7 @@ module Triannon
     include RdfResponseFormats
 
     before_action :default_format_jsonld, only: [:find]
+    rescue_from Triannon::SearchError, with: :search_error
 
     def find
       anno_graphs_array = solr_searcher.find(params)
@@ -40,6 +41,14 @@ module Triannon
       @ss ||= Triannon::SolrSearcher.new
     end
 
+  private
+
+    # render Triannon::SearchError
+    def search_error(err)
+      render :body => "<h2>#{err.message}</h2>" + (err.search_resp_body ? err.search_resp_body : ""),
+        status: err.search_resp_status ? err.search_resp_status : 400,
+        content_type: "text/html"
+    end
 
   end # SearchController
 

data/app/models/triannon/annotation.rb

@@ -1,7 +1,7 @@
 module Triannon
   class Annotation
     include ActiveModel::Model
-    
+
     define_model_callbacks :save, :destroy
     after_save :solr_save
     after_destroy :solr_delete
@@ -19,7 +19,7 @@ module Triannon
 
 
     # Class Methods ----------------------------------------------------------------
-  
+
     def self.create(attrs = {})
       a = Triannon::Annotation.new attrs
       a.save
@@ -77,12 +77,12 @@ module Triannon
         @graph = Triannon::Graph.new g
       end
     end
-    
+
     # @return json-ld representation of anno with OpenAnnotation context as a url
     def jsonld_oa
       graph.jsonld_oa
     end
-    
+
     # @return json-ld representation of anno with IIIF context as a url
     def jsonld_iiif
       graph.jsonld_iiif
@@ -109,7 +109,7 @@ protected
     def solr_delete
       solr_writer.delete(id) if id
     end
-    
+
 private
 
     # loads RDF::Graph from data attribute.  If data is in json-ld or rdfxml, converts it to turtle.
@@ -130,7 +130,7 @@ private
         else # infer the content type from the content itself
           case data
             # \A and \Z and m are needed instead of ^$ due to \n in data
-            when /\A\{.+\}\Z/m  
+            when /\A\{.+\}\Z/m
               g = jsonld_to_graph
             when /\A<.+>\Z/m
               g = rdfxml_to_graph
@@ -143,7 +143,7 @@ private
       end
       g
     end
-    
+
     # create and load an RDF::Graph object from turtle in data attrib
     # @return [RDF::Graph] populated RDF::Graph object, or nil
     def ttl_to_graph

data/app/services/triannon/ldp_loader.rb

@@ -37,7 +37,7 @@ module Triannon
 
     # load body objects into @ldp_annotation's (our Triannon::AnnotationLdp object) graph
     def load_bodies
-      @ldp_annotation.body_uris.each { |body_uri|  
+      @ldp_annotation.body_uris.each { |body_uri|
         body_obj_path = body_uri.to_s.split(@base_uri + '/').last
         load_object_into_annotation_graph(body_obj_path)
       }
@@ -45,12 +45,12 @@ module Triannon
 
     # load target objects into @ldp_annotation's (our Triannon::AnnotationLdp object) graph
     def load_targets
-      @ldp_annotation.target_uris.each { |target_uri| 
+      @ldp_annotation.target_uris.each { |target_uri|
         target_obj_path = target_uri.to_s.split(@base_uri + '/').last
         load_object_into_annotation_graph(target_obj_path)
       }
     end
-    
+
     # @return [Array<Triannon::Annotation>] an array of Triannon::Annotation objects with just the id set. Enough info to build the index page
     def find_all
       root_ttl = get_ttl
@@ -83,13 +83,17 @@ module Triannon
         req.url "#{sub_path}" if sub_path
         req.headers['Accept'] = 'application/x-turtle'
       end
-      resp.body
+      if resp.status.between?(400, 600)
+        raise Triannon::LDPStorageError.new("error getting #{sub_path} from LDP", resp.status, resp.body)
+      else
+        resp.body
+      end
     end
 
     # turns turtle serialization into Array of RDF::Statements, removing fedora-specific triples
     #  (leaving LDP and OA triples)
     # @param [String] ttl a String containing RDF serialized as turtle
-    # @return [Array<RDF::Statements>] the RDF statements represented in the ttl 
+    # @return [Array<RDF::Statements>] the RDF statements represented in the ttl
     def statements_from_ttl_minus_fedora ttl
       # RDF::Turtle::Reader.new(ttl).statements.to_a
       g = RDF::Graph.new.from_ttl(ttl) if ttl
@@ -98,6 +102,8 @@ module Triannon
 
     def conn
       @c ||= Faraday.new @base_uri
+      @c.headers['Prefer'] = 'return=respresentation; omit="http://fedora.info/definitions/v4/repository#ServerManaged"'
+      @c
     end
 
   end

data/app/services/triannon/ldp_writer.rb

@@ -7,7 +7,7 @@ module Triannon
     # @param [Triannon::Annotation] anno a Triannon::Annotation object, from which we use the graph
     def self.create_anno(anno)
       if anno && anno.graph
-        # TODO:  special case if the Annotation object already has an id -- 
+        # TODO:  special case if the Annotation object already has an id --
         #  see https://github.com/sul-dlss/triannon/issues/84
         ldp_writer = Triannon::LdpWriter.new anno
         id = ldp_writer.create_base
@@ -39,11 +39,11 @@ module Triannon
         ldpw.delete_containers id
       end
     end
-    
+
     class << self
       alias_method :delete_anno, :delete_container
     end
-    
+
     # @param [Triannon::Annotation] anno a Triannon::Annotation object
     # @param [String] id the unique id for the LDP container for the passed annotation; defaults to nil
     def initialize(anno, id=nil)
@@ -59,14 +59,14 @@ module Triannon
       if @anno.graph.query([nil, RDF::Triannon.externalReference, nil]).count > 0
         raise Triannon::ExternalReferenceError, "Incoming annotations may not have http://triannon.stanford.edu/ns/externalReference as a predicate."
       end
-      
+
       if @anno.graph.id_as_url && @anno.graph.id_as_url.size > 0
         raise Triannon::ExternalReferenceError, "Incoming new annotations may not have an existing id (yet)."
       end
 
-      # TODO:  special case if the Annotation object already has an id -- 
+      # TODO:  special case if the Annotation object already has an id --
       #  see https://github.com/sul-dlss/triannon/issues/84
-      
+
       # we need to work with a copy of the graph so we don't change @anno.graph
       g = RDF::Graph.new
       @anno.graph.each { |s|
@@ -93,7 +93,7 @@ module Triannon
     def create_body_resources
       create_resources_in_container RDF::OpenAnnotation.hasBody
     end
-    
+
     # create the target resources inside the (already created) target container
     def create_target_resources
       create_resources_in_container RDF::OpenAnnotation.hasTarget
@@ -108,11 +108,11 @@ module Triannon
         ldp_container_uris = [ldp_container_uris]
       end
       something_deleted = false
-      ldp_container_uris.each { |uri|  
+      ldp_container_uris.each { |uri|
         ldp_id = uri.to_s.split(@base_uri + '/').last
         resp = conn.delete { |req| req.url ldp_id }
         if resp.status != 204
-          raise "Unable to delete LDP container: #{ldp_id}\nResponse Status: #{resp.status}\nResponse Body: #{resp.body}"
+          raise Triannon::LDPStorageError.new("Unable to delete LDP container #{ldp_id}", resp.status, resp.body)
         end
         something_deleted = true
       }
@@ -121,8 +121,8 @@ module Triannon
 
   protected
 
-    # POSTS a ttl representation of a graph to a newly created LDP container in the LDP store
-    # @param [String] ttl a turtle representation of RDF data to be put in the new LDP container
+    # POSTS a ttl representation of a graph to an existing LDP container in the LDP store
+    # @param [String] ttl a turtle representation of RDF data to be put in the LDP container
     # @param [String] parent_path the path portion of the url for the LDP parent container for this resource
     #   if no path is supplied, then the resource will be created as a child of the root annotation;
     #   expected paths would also be (anno_id)/t  for a target resource (inside the target container of anno_id)
@@ -136,12 +136,12 @@ module Triannon
         req.body = ttl
       end
       if resp.status != 200 && resp.status != 201
-        raise "Unable to create LDP resource in container #{parent_path}: Response Status: #{resp.status}\nResponse Body: #{resp.body}\nAnnotation sent: #{body}"
+        raise Triannon::LDPStorageError.new("Unable to create LDP resource in container #{parent_path}; RDF sent: #{ttl}", resp.status, resp.body)
       end
       new_url = resp.headers['Location'] ? resp.headers['Location'] : resp.headers['location']
       new_url.split('/').last if new_url
     end
-  
+
     # Creates an empty LDP DirectContainer in LDP Storage that is a member of the base container and has the memberRelation per the oa_vocab_term
     # The id of the created containter will be (base container id)/b  if hasBody or  (base container id)/t  if hasTarget
     # @param [RDF::Vocabulary::Term] oa_vocab_term RDF::OpenAnnotation.hasTarget or RDF::OpenAnnotation.hasBody
@@ -160,7 +160,7 @@ module Triannon
         req.body = g.to_ttl
       end
       if resp.status != 201
-        raise "Unable to create #{oa_vocab_term.fragment.sub('has', '')} LDP container for anno: Response Status: #{resp.status}\nResponse Body: #{resp.body}"
+        raise Triannon::LDPStorageError.new("Unable to create #{oa_vocab_term.fragment.sub('has', '')} LDP container for anno; RDF sent: #{g.to_ttl}", resp.status, resp.body)
       end
       resp
     end
@@ -176,7 +176,7 @@ module Triannon
         if predicate_obj.is_a?(RDF::Node)
           # we need to use the null relative URI representation of blank nodes to write to LDP
           predicate_subject = RDF::URI.new
-        else 
+        else
           # it's already a URI, but we need to use the null relative URI representation so we can
           # write out as a Triannon:externalRef property with the URL, and any addl props too.
           if predicate_obj.to_str
@@ -185,7 +185,7 @@ module Triannon
                                                   :predicate => RDF::Triannon.externalReference,
                                                   :object => RDF::URI.new(predicate_obj.to_str)})
             addl_stmts = @anno.graph.query([predicate_obj, nil, nil])
-            addl_stmts.each { |s|  
+            addl_stmts.each { |s|
               graph_for_resource << RDF::Statement({:subject => predicate_subject,
                                                     :predicate => s.predicate,
                                                     :object => s.object})
@@ -194,13 +194,13 @@ module Triannon
             predicate_subject = predicate_obj
           end
         end
-        
+
         # add statements with predicate_obj as the subject
         orig_hash_uri_objs = [] # the orig URI objects from [targetObject, OA.hasSource/.default/.item, (uri)] statements
         hash_uri_counter = 1
         Triannon::Graph.subject_statements(predicate_obj, @anno.graph).each { |s|
           if s.subject == predicate_obj
-            # deal with any external URI references which may occur in: 
+            # deal with any external URI references which may occur in:
             #  OA.hasSource (from SpecificResource), OA.default or OA.item (from Choice, Composite, List)
             if s.object.is_a?(RDF::URI) && s.object.to_s
               # do we need to represent the URL as an externalReference with hash URI
@@ -218,7 +218,7 @@ module Triannon
                                                       :predicate => s.predicate,
                                                       :object => s.object})
               end
-              
+
               if hash_uri_str
                 # represent the object URL as an external ref
                 new_hash_uri_obj = RDF::URI.new(hash_uri_str)
@@ -228,7 +228,7 @@ module Triannon
                 graph_for_resource << RDF::Statement({:subject => predicate_subject,
                                                       :predicate => s.predicate,
                                                       :object => new_hash_uri_obj})
-                
+
                 # add externalReference triple to graph
                 graph_for_resource << RDF::Statement({:subject => new_hash_uri_obj,
                                                       :predicate => RDF::Triannon.externalReference,
@@ -251,15 +251,15 @@ module Triannon
                                                     :predicate => s.predicate,
                                                     :object => s.object})
             end
-          else 
-            # s.subject != predicate_obj 
+          else
+            # s.subject != predicate_obj
             graph_for_resource << s
           end
         }
         # make sure the graph we will write contains no extraneous statements about URIs
         #  now represented as hash URIs
-        orig_hash_uri_objs.each { |uri_node| 
-          Triannon::Graph.subject_statements(uri_node, graph_for_resource).each { |s|  
+        orig_hash_uri_objs.each { |uri_node|
+          Triannon::Graph.subject_statements(uri_node, graph_for_resource).each { |s|
             graph_for_resource.delete(s)
           }
         }
@@ -274,6 +274,8 @@ module Triannon
 
     def conn
       @c ||= Faraday.new @base_uri
+      @c.headers['Prefer'] = 'return=respresentation; omit="http://fedora.info/definitions/v4/repository#ServerManaged"'
+      @c
     end
 
   end

data/app/services/triannon/solr_searcher.rb

@@ -14,7 +14,7 @@ module Triannon
       }
       result
     end
-    
+
     # @note hardcoded Solr search service expectation in generated search params
     # @note hardcoded mapping of REST params for /search to Solr params
     #
@@ -114,6 +114,8 @@ module Triannon
     end
 
 
+    attr_accessor :rsolr_client
+
     def initialize
       @rsolr_client = RSolr.connect :url => Triannon.config[:solr_url]
       @logger = Rails.logger
@@ -145,6 +147,12 @@ module Triannon
     def search(solr_params = {})
       handler = Proc.new do |exception, attempt_cnt, total_delay|
         @logger.debug "#{exception.inspect} on Solr search attempt #{attempt_cnt} for #{solr_params.inspect}"
+        if exception.kind_of?(RSolr::Error::Http)
+          # Note there are extra shenanigans b/c RSolr hijacks the Solr error to return RSolr Error
+          raise Triannon::SearchError.new("error searching Solr with params #{solr_params.inspect}: #{exception.message}", exception.response[:status], exception.response[:body])
+        elsif exception.kind_of?(StandardError)
+          raise Triannon::SearchError.new("error searching Solr with params #{solr_params.inspect}: #{exception.message}")
+        end
       end
 
       response = nil
@@ -154,6 +162,7 @@ module Triannon
                     :max_sleep_seconds => @max_sleep_seconds) do |attempt|
         @logger.debug "Solr search attempt #{attempt} for #{solr_params.inspect}"
         # use POST in case of long params
+        #  RSolr throws RSolr::Error::Http for any Solr response without status 200 or 302
         response = @rsolr_client.post 'select', :params => solr_params
         @logger.info "Successfully searched Solr on attempt #{attempt}"
       end

data/app/services/triannon/solr_writer.rb

@@ -47,6 +47,7 @@ module Triannon
       doc_hash
     end
 
+    attr_accessor :rsolr_client
 
     def initialize
       @rsolr_client = RSolr.connect :url => Triannon.config[:solr_url]
@@ -72,37 +73,51 @@ module Triannon
 
       handler = Proc.new do |exception, attempt_cnt, total_delay|
         @logger.debug "#{exception.inspect} on Solr add attempt #{attempt_cnt} for #{id}"
+        if exception.kind_of?(RSolr::Error::Http)
+          # Note there are extra shenanigans b/c RSolr hijacks the Solr error to return RSolr Error
+          raise Triannon::SearchError.new("error adding doc #{id} to Solr #{doc.inspect}; #{exception.message}", exception.response[:status], exception.response[:body])
+        elsif exception.kind_of?(StandardError)
+          raise Triannon::SearchError.new("error adding doc #{id} to Solr #{doc.inspect}; #{exception.message}")
+        end
       end
 
-      with_retries(:handler => handler, 
-                    :max_tries => @max_retries, 
-                    :base_sleep_seconds => @base_sleep_seconds, 
+      with_retries(:handler => handler,
+                    :max_tries => @max_retries,
+                    :base_sleep_seconds => @base_sleep_seconds,
                     :max_sleep_seconds => @max_sleep_seconds) do |attempt|
         @logger.debug "Solr add attempt #{attempt} for #{id}"
         # add it and commit within 0.5 seconds
         @rsolr_client.add(doc, :add_attributes => {:commitWithin => 500})
+        #  RSolr throws RSolr::Error::Http for any Solr response without status 200 or 302
         @logger.info "Successfully indexed #{id} to Solr on attempt #{attempt}"
       end
     end
-    
+
     # Delete the document from Solr, retrying if an error occurs.
     # See https://github.com/ooyala/retries for info on with_retries.
     # @param [String] id the id of the Solr document to be deleted
     def delete(id)
       handler = Proc.new do |exception, attempt_cnt, total_delay|
         @logger.debug "#{exception.inspect} on Solr delete attempt #{attempt_cnt} for #{id}"
-      end  
+        if exception.kind_of?(RSolr::Error::Http)
+          # Note there are extra shenanigans b/c RSolr hijacks the Solr error to return RSolr Error
+          raise Triannon::SearchError.new("error deleting doc #{id} from Solr: #{exception.message}", exception.response[:status], exception.response[:body])
+        elsif exception.kind_of?(StandardError)
+          raise Triannon::SearchError.new("error deleting doc #{id} from Solr: #{exception.message}")
+        end
+      end
 
-      with_retries(:handler => handler, 
-                    :max_tries => @max_retries, 
-                    :base_sleep_seconds => @base_sleep_seconds, 
+      with_retries(:handler => handler,
+                    :max_tries => @max_retries,
+                    :base_sleep_seconds => @base_sleep_seconds,
                     :max_sleep_seconds => @max_sleep_seconds) do |attempt|
         @logger.debug "Solr delete attempt #{attempt} for #{id}"
+        #  RSolr throws RSolr::Error::Http for any Solr response without status 200 or 302
         @rsolr_client.delete_by_id(id)
         @rsolr_client.commit
         @logger.info "Successfully deleted #{id} from Solr"
-      end      
+      end
     end
-    
+
   end
 end

data/lib/triannon/error.rb

@@ -2,8 +2,31 @@ module Triannon
   # generic Triannon error allowing rescue to catch all Triannon exceptions
   class Error < RuntimeError
   end
-  
+
   class ExternalReferenceError < Triannon::Error
+    def initialize(message = nil)
+      super(message)
+    end
   end
-  
+
+  # used to keep HTTP response info from LDP
+  class LDPStorageError < Triannon::Error
+    attr_accessor :ldp_resp_status, :ldp_resp_body
+    def initialize(message = nil, ldp_resp_status = nil, ldp_resp_body = nil)
+      super(message)
+      self.ldp_resp_status = ldp_resp_status if ldp_resp_status
+      self.ldp_resp_body = ldp_resp_body if ldp_resp_body
+    end
+  end
+
+  # used to keep HTTP response info from Solr
+  class SearchError < Triannon::Error
+    attr_accessor :search_resp_status, :search_resp_body
+    def initialize(message = nil, search_resp_status = nil, search_resp_body = nil)
+      super(message)
+      self.search_resp_status = search_resp_status if search_resp_status
+      self.search_resp_body = search_resp_body if search_resp_body
+    end
+  end
+
 end

data/lib/triannon/version.rb

@@ -1,3 +1,3 @@
 module Triannon
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: triannon
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Chris Beer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-07 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails