krikri 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d72a1b6b8d6ea4472d527c4ecacac7095211bdfe
-  data.tar.gz: 521e0ed975aaaf8e9ed132948e8a4ad6e396e21d
+  metadata.gz: 96bca4e27356f470641703f33e18cf175ebd69ff
+  data.tar.gz: bc9ae30eda3a0afb8bddf6acf303b4613f74a779
 SHA512:
-  metadata.gz: 3ba3aacbb12f39c70b9643c2cb1288ae46d80557efacc5c6766f51c0bfd79be67cdd611fb601b54002bddc66278d6083f97e5bc1712ee502f1d948b14dfadb83
-  data.tar.gz: 5ad8d81909cebfd15f2517267f27028ad0667e2c4712f34fea4e61a90fae727976675df9a89898abc8c2e9ae42c474f93624fdfeb0313f766e85fc17cc4ed094
+  metadata.gz: d4d51fb35e997ca7ec9100d2d8ea55fbb54dcda052374794e3c40518f77da172dfa690e2d65f2be238beefca0447d1a08272483b4618d28ded01ee78f9037136
+  data.tar.gz: 6df381f8ac7c5defc2ac5a05421b24a80cec0f948c3481b06f4e5b8989a5750b65ed33acd988f933dce334dcb5328017961f4c61cb4e39b5b9d7969a9c14037c

data/app/controllers/krikri/records_controller.rb

@@ -134,9 +134,9 @@ module Krikri
     # @param [Hash] user_parameters a hash of user-supplied parameters.
     def records_by_provider(solr_params, user_params)
       if @provider_id.present?
-        provider = Krikri::Provider.find(@provider_id)
+        rdf_subject = Krikri::Provider.base_uri + @provider_id
         solr_params[:fq] ||= []
-        solr_params[:fq] << "provider_id:\"#{provider.rdf_subject}\""
+        solr_params[:fq] << "provider_id:\"#{rdf_subject}\""
       end
     end
 

data/app/helpers/krikri/application_helper.rb

@@ -15,7 +15,7 @@ module Krikri
     # @return [String]
     def provider_name(provider)
       provider = Krikri::Provider.find(provider) if provider.is_a? String
-      provider.present? ? provider.provider_name : "All Providers"
+      provider.present? ? provider.name : 'All Providers'
     end
 
     ##

data/app/models/krikri/provider.rb

@@ -1,80 +1,173 @@
 module Krikri
   ##
-  # This models provider data from the {Krikri::Repository}.
+  # Provider is an ActiveModel object. It represents a provider that has been
+  # indexed in Solr.
   #
-  # @todo create an appropriate `ActiveTriples::PersistenceStrategy' for
-  #   handling providers as data from a repository alongside LDP data.
-  # @see ActiveTriples::Resource
-  class Provider < DPLA::MAP::Agent
-    configure :base_uri => Krikri::Settings.prov.provider_base
+  # This is a read-only object. It does not write new providers to Solr, nor
+  # does it update or delete providers.
+  #
+  # A DPLA::MAP::Agent object can be constructed from an instance of this
+  # ActiveModel object using the :agent method. The DPLA::MAP::Agent object
+  # interacts with Marmotta, rather than Solr.
+  #
+  #   @example Krikri::Provider.find(rdf_subject: 'http://blah.com/123').agent
+  #     => [DPLA::MAP::Agent]
+  #
+  class Provider
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    ##
+    # @!attribute :rdf_subject [String] the URI identifying the provider
+    #   @example: "http://blah.com/contributor/123"
+    #
+    # @!attribute :id [String] the stub id
+    #   @example: "123"
+    #
+    # @!attribute :name [String] the human-redable name of the provider
+    #
+    # @!attribute :agent [DPLA::MAP::Agent] an ActiveTriples representation of
+    # the provider, read from Marmotta.
+    attr_accessor :rdf_subject, :name
+    attr_reader :agent, :id
+
+    ##
+    # Initializes a Provider object.
+    #
+    # @param attributes [Hash]
+    # If the params Hash contains a valid value for :rdf_subject, the model can
+    # extrapolate all other attributes.
+    #
+    # @example
+    #   Krikri::Provider.new({ rdf_subject: 'http:://blah.com/contributor/123',
+    #                          name: 'Moomin Valley Historical Society' })
+    #
+    # @raise [NoMethodError] if the params Hash includes a key that does not
+    # match listed attr_accessors
+    #
+    # @return [<Krikri::Provider>]
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
 
     ##
     # Gives a list of all providers, ignoring those with no URI (bnodes).
     #
+    # Providers will be initialized with both an :rdf_subject and a :name,
+    # if both exist in the Solr index.
+    #
     # @return [Array<Krikri::Provider>]
     def self.all
       query_params = { :rows => 0,
                        :id => '*:*',
-                       'facet.field' => 'provider_id' }
+                       :facet => true,
+                       'facet.pivot' => 'provider_id,provider_name' }
       response = Krikri::SolrResponseBuilder.new(query_params).response
-      response.facets.first.items.map do |item|
-        provider = new(item.value)
-        provider.node? ? nil : provider
+
+      response.facet_pivot['provider_id,provider_name'].map do |facet|
+        rdf_subject = facet['value']
+        name = facet['pivot'].present? ? facet['pivot'].first['value'] : nil
+        provider = new({ :rdf_subject => rdf_subject, :name => name })
+        provider.valid_rdf_subject? ? provider : nil
       end.compact
     end
 
     ##
-    # @param id [#to_s] the identifier (local name or URI) of the provider
-    #   to find
+    # Finds a provider in Solr that matches the given ID, ignoring bnodes.
+    #
+    # @param [String] :id or :rdf_subject
     #
     # @return [Krikri::Provider]
-    # @todo Use {ActiveTriples}/{RDF::Repository} to populate the object
     def self.find(id)
-      return nil if id.nil?
-      provider = new(id)
-      provider.reload
-      return nil if provider.empty?
-      provider
+      rdf_subject = id.start_with?(base_uri) ? id : base_uri + id
+      query_params = { :rows => 1,
+                       :q => rdf_subject,
+                       :qf => 'provider_id',
+                       :fl => 'provider_id provider_name' }
+      response = Krikri::SolrResponseBuilder.new(query_params).response
+      return nil unless response.docs.count > 0
+      new({ :rdf_subject => rdf_subject,
+            :name => response.docs.first['provider_name'].first })
     end
 
     ##
-    # Loads the provider's data from the repository.
-    #
-    # @return [Krikri::Provider] self
-    def reload
-      query = Krikri::Repository.query_client.select.distinct.where([self, :p, :o])
-      query.each_solution do |solution|
-        set_value(solution.p, solution.o)
-      end
+    # Get the base of the :rdf_subject for any provider
+    # @return [String] ending in "/"
+    def self.base_uri
+      base_uri = Krikri::Settings.prov.provider_base
+      base_uri.end_with?('/') ? base_uri : base_uri << '/'
+    end
+
+    def id
+      @id ||= local_name
+    end
 
-      self
+    def name
+      @name ||= initialize_name
+    end
+
+    def agent
+      @agent ||= initialize_agent
     end
 
     ##
-    # A list of records of type ore:Aggregation associated with this provider
-    #
-    # @return [Array<DPLA::MAP::Aggregation>] the Aggregations with this
-    #   provider
-    def records
-      query = Krikri::Repository.query_client.select
-              .where([:record, RDF::EDM.provider, self],
-                     [:record, RDF.type, RDF::ORE.Aggregation])
+    # Tests for providers that have valid a :rdf_subject (not a bnode).
+    # A valid :rdf_subject does not necessarily match and :rdf_subject in the
+    # Solr index, but it has the correct URI format.
+    def valid_rdf_subject?
+      return false unless rdf_subject.present?
+      rdf_subject.start_with?(self.class.base_uri) ? true : false
+    end
 
-      query.execute.map do |solution|
-        DPLA::MAP::Aggregation.new(solution.record)
-      end
+    ##
+    # Required ActiveModel method.
+    def persisted?
+      false
     end
 
+    private
+
     ##
-    # @return [String] the local name (last uri segment) for the provider
-    def id
-      node? ? nil : rdf_subject.to_s.gsub(base_uri.to_s, '')
+    # Gives the last path fragment for :rdf_subject in HTML escaped form,
+    # ignoring :rdf_subjects, ignoring bnodes.
+    #
+    # @example
+    #   Given: rdf_subject == 'http://my_domain/blah/0123'
+    #   local_name == '0123'
+    #
+    # @return [String]
+    def local_name
+      return nil unless valid_rdf_subject?
+      rdf_subject.split('/').last.html_safe
+    end
+
+    ##
+    # Gives the :provider_name associated with a provider's :rdf_subject
+    # (ie. :provider_id) in Solr, ignoring bnodes.
+    #
+    # @return [String]
+    def initialize_name
+      return nil unless valid_rdf_subject?
+      query_params = { :rows => 1,
+                       :q => rdf_subject,
+                       :qf => 'provider_id',
+                       :fl => 'provider_name' }
+      response = Krikri::SolrResponseBuilder.new(query_params).response
+      return nil unless response.docs.count > 0
+      response.docs.first['provider_name'].first
     end
 
     ##
-    # @return [String] the name of the provider
-    def provider_name
-      label.first || providedLabel.first || id
+    # Creates DPLA::MAP::Agent object from the :rdf_subject and :name, ignoring
+    # bnodes.
+    #
+    # @return [DPLA::MAP::Agent]
+    def initialize_agent
+      return nil unless valid_rdf_subject?
+      DPLA::MAP::Agent.new(rdf_subject).tap { |agent| agent.label = name }
     end
   end
 end

data/app/models/krikri/qa_report.rb

@@ -136,7 +136,7 @@ module Krikri
     # @todo figure out a better relations pattern between {ActiveRecord} objects
     #   and {ActiveTriples}
     def build_provider
-      Krikri::Provider.find(provider)
+      Krikri::Provider.new(:rdf_subject => provider).agent
     end
 
     private

data/app/models/krikri/validation_report.rb

@@ -63,9 +63,11 @@ module Krikri
 
     private
 
+    ##
+    # Get the full URI identifier for the provider
     def provider_uri
       return unless provider_id.present?
-      Krikri::Provider.new(provider_id).rdf_subject
+      Krikri::Provider.base_uri + provider_id
     end
   end
 end

data/app/views/krikri/providers/index.html.erb

@@ -9,7 +9,7 @@
   <ul>
   <% @providers.each do |provider| %>
     <li>
-      <%= link_to provider_name(provider), { controller: 'providers',
+      <%= link_to provider.name, { controller: 'providers',
         action: 'show', id: provider.id } %>
     </li>
   <% end %>

data/lib/krikri/harvesters/oai_harvester.rb

@@ -184,26 +184,16 @@ module Krikri::Harvesters
 
     ##
     # Transforms an OAI::Record to xml suitable for saving with the
-    # OriginalRecord
+    # OriginalRecord. It's necessary to build a new document and add the 
+    # namespace manually to normalize record output between `ListRecords` and
+    # `GetRecord` requests.
     #
     # @param rec [OAI::Record]
     # @return [String] an xml string
     def record_xml(rec)
-      doc = Nokogiri::XML::Builder.new do |xml|
-        xml.record('xmlns' => 'http://www.openarchives.org/OAI/2.0/') {
-          xml.header {
-            xml.identifier rec.header.identifier
-            xml.datestamp  rec.header.datestamp
-            rec.header.set_spec.each do |set|
-              xml.set_spec set.text
-            end
-          }
-          xml << rec.metadata.to_s unless rec.metadata.nil?
-          xml << rec.about.to_s unless rec.about.nil?
-        }
-      end
-      doc.doc.at_css('header')['status'] = rec.header.status if
-        rec.header.status
+      doc = Nokogiri.XML(rec._source.to_s)
+      doc.root
+        .add_namespace_definition(nil, 'http://www.openarchives.org/OAI/2.0/')
       doc.to_xml
     end
   end

data/lib/krikri/parser.rb

@@ -273,17 +273,54 @@ module Krikri
       end
 
       ##
+      # @example selecting by presence of an attribute; returns all nodes where
+      #   `#attribute?(:type)` is true
+      #
+      #   match_attribute(:type) 
+      #
+      # @example selecting by the value of an attribute; returns all nodes with
+      #   `#attribute(:type) == other`
+      #
+      #   match_attribute(:type, other)
+      #
+      # @example selecting by block against an attribute; returns all nodes with
+      #   `block.call(attribute(:type))` is true
+      #
+      #   match_attribute(:type) { |value| value.starts_with? 'blah' }
+      #
+      # @example selecting by block against an attribute; returns all nodes with
+      #   `block.call(attribute(:type)) == other` is true
+      #
+      #   match_attribute(:type, 'moomin') { |value| value.downcase }
+      #   
       # @param name [#to_sym] an attribute name
-      # @param other [Object] an object to for equality with the
+      # @param other [Object] an object to check for equality with the
       #   values from the given attribute.
       #
+      # @yield [value] yields each value with the attribute in name to the block
+      #
       # @return [ValueArray] an array containing nodes for which the specified
-      #   attribute has a value matching the given object.
-      def match_attribute(name, other)
-        select do |v|
-          next unless v.attribute?(name.to_sym)
-          v.send(name).downcase == other.downcase
-        end
+      #   attribute has a value matching the given attribute name, object, and 
+      #   block.
+      def match_attribute(name, other = nil, &block)
+        select(&compare_to_attribute(name, other, &block))
+      end
+
+      ##
+      # @param name [#to_sym] an attribute name
+      # @param other [Object] an object to check for equality with the
+      #   values from the given attribute.
+      #
+      # @yield [value] yields each value with the attribute in name to the block
+      #
+      # @return [ValueArray] an array containing nodes for which the specified
+      #   attribute does not have a value matching the given attribute name, 
+      #   object, and block.
+      #
+      # @see #match_attribute  for examples; this calls #reject, where it calls
+      #   #select.
+      def reject_attribute(name, other = nil, &block)
+        reject(&compare_to_attribute(name, other, &block))
       end
 
       ##
@@ -301,6 +338,20 @@ module Krikri
         self.class.new(flat_map { |val| val[name] })
       end
 
+      private
+      
+      ##
+      # @see #match_attribute, #reject_attribute
+      def compare_to_attribute(name, other, &block)
+        lambda do |v|
+          next unless v.attribute?(name.to_sym)
+          result = v.send(name)
+          result = yield(result) if block_given?
+          return result == other if other
+          result
+        end
+      end
+
       public
 
       class InvalidParserValueError < TypeError; end

data/lib/krikri/version.rb

@@ -1,3 +1,3 @@
 module Krikri
-  VERSION = '0.7.2'.freeze
+  VERSION = '0.7.3'.freeze
 end

data/lib/tasks/krikri.rake

@@ -27,12 +27,13 @@ namespace :krikri do
       original_record = build(:oai_dc_record)
       original_record.save unless original_record.exists?
 
-      provider = Krikri::Provider.new('123')
-      provider.label = 'Moomin valley Historical Society'
+      provider_uri = Krikri::Provider.base_uri + '123'
+      provider = Krikri::Provider.new(:rdf_subject => provider_uri).agent
+      provider.label = 'Moomin Valley Historical Society'
 
-      agg = build(:aggregation)
-      agg.originalRecord = original_record.rdf_source
-      agg.provider = provider
+      agg = build(:aggregation,
+                  :originalRecord => original_record.rdf_source,
+                  :provider => provider)
 
       agg.mint_id!('krikri_sample')
 
@@ -47,11 +48,15 @@ namespace :krikri do
       original_record = build(:json_record)
       original_record.save unless original_record.exists?
 
+      provider_uri = Krikri::Provider.base_uri + '456'
+      provider = Krikri::Provider.new(:rdf_subject => provider_uri).agent
+      provider.label = 'Snork Maiden Archives'
+
       agg = build(:aggregation,
                   :originalRecord => ActiveTriples::Resource
                                       .new(original_record.rdf_subject),
-                  :sourceResource => build(:source_resource, title: nil)
-            )
+                  :sourceResource => build(:source_resource, title: nil),
+                  :provider => provider)
 
       agg.mint_id!('krikri_sample_invalid')