krikri 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7201a4fbfc0b94c3f5f6fca1705681f31dbd4eb
-  data.tar.gz: 729f1451596fe611c644ea81557e1bbdc1a2adb2
+  metadata.gz: ad17bc3b4f055517e8aff27ba12b45a4c1639903
+  data.tar.gz: bbf4193141bc931d5b28c4b0d3b20f179e409665
 SHA512:
-  metadata.gz: 63202230aa9760b1136860afe2932723dd36a09da2f10a3292d59102d9b3893d4ca1b4164c8d56e6b558e5edda83af9b237b6f04c676f166e7d41a8eab07ccb3
-  data.tar.gz: f0be5d7d562cd1586c4b9ac705d22680ffed35627ad6a6d14ed7cdb60f7f14ba36d49f6f696a03cdf59d514656d1c22914e1d126270d2dc8366bd30b6412e4a8
+  metadata.gz: 4da334a69fde7f3bd29a9e21950d25b48182b4e44067c1cd8174dcbc813f37c7cc7f6383781c7e31ec8913cf262f383201b39900a0a04072d577805b7959012c
+  data.tar.gz: ed2ccce206e5b347066e0d7f39f0ddc53731605357c17e74a2350227683b281dfb7867abca80afc82baaa216cc8a86ebe54c6134a482c21464f13d99b27937a3

data/app/controllers/krikri/_qa_report_list.html.erb~

@@ -0,0 +1,10 @@
+<h3>Validation Reports</h3>
+<% if @validation_reports %>
+  <ul>
+    <% @validation_reports.each do |validation_report| %>
+      <li><%= render_validation_report(validation_report) %></li>
+    <% end %>
+  </ul>
+<% else %>
+  <div>There was an error generating the QA reports.</div>
+<% end %>

data/app/controllers/krikri/concerns/provider_context.rb~

@@ -0,0 +1,7 @@
+module Krikri::Concerns
+  class ProviderContext
+    def set_current_provider(provider_id = params[:provider])
+      @current_provider = Krikri::Provider.find(provider_id)
+    end
+  end
+end

data/app/controllers/krikri/field_value_reports_controller.rb

@@ -0,0 +1,21 @@
+module Krikri
+  ##
+  # Handles HTTP requests for Field Value Reports
+  #
+  # @see Krikri::FieldValueReport
+  class FieldValueReportsController < ApplicationController
+    ##
+    # Renders the show view for the field value report, given by a compound key.
+    # The compound key is comprised by the field value report's field
+    # (represented by the route's id param) and the provider's id.
+
+    def show
+      @field_value_report = Krikri::FieldValueReport.find(params[:id], 
+                                                          params[:provider_id])
+
+      respond_to do |format|
+        format.csv
+      end
+    end
+  end
+end

data/app/controllers/krikri/qa_reports_controller.rb~

@@ -0,0 +1,18 @@
+module Krikri
+  ##
+  # Handles HTTP requests for QA Reports
+  class QAReportsController < ApplicationController
+    include Concerns::ProviderContext
+
+    before_action :authenticate_user!, :set_current_provider
+
+    def show
+      require 'pry'
+      binding.pry
+      respond_to do |format|
+        format.html
+        format.csv { render csv: 'test'  }
+      end
+    end
+  end
+end

data/app/controllers/krikri/reports_controller.rb

@@ -15,6 +15,7 @@ module Krikri
       @validation_reports = report.all
 
       if @current_provider
+        @provider = Krikri::Provider.find(@current_provider)
         @qa_reports = Array(Krikri::QAReport.find_by(provider: @current_provider))
       else
         @qa_reports = Krikri::QAReport.all

data/app/models/krikri/active_model_base.rb

@@ -0,0 +1,36 @@
+module Krikri
+  ##
+  # ActiveModelBase is a Superclass for ActiveModel objects.
+  class ActiveModelBase
+    include ActiveModel::Conversion
+    include ActiveModel::Dirty
+    include ActiveModel::Validations
+    extend ActiveModel::Naming
+
+    ##
+    # Initializes a Krikri::ActiveModelBase object.
+    #
+    # @param attributes [Hash]
+    #
+    # @raise [NoMethodError] if the params Hash includes a key that does not
+    # match any of the Class's writeable attributes.
+    #
+    # @example
+    #   Given: MyActiveModel is a subclass of ActiveModelBase
+    #   Given: :name is a writeable attribute of MyActiveModel
+    #   MyActiveModel.new({ :name => 'value' })
+    #
+    # @return [Krikri::ActiveModelBase]
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+
+    ##
+    # Required ActiveModel method.
+    def persisted?
+      false
+    end
+  end
+end

data/app/models/krikri/field_value_report.rb

@@ -0,0 +1,124 @@
+module Krikri
+  ##
+  # FieldValueReport gives all unique values for a given field within a
+  # document.  It represents data that has been indexed into Solr.
+  #
+  # This is a read-only object.  FieldValueReports are not persisted.
+  class FieldValueReport < Krikri::ActiveModelBase
+    ##
+    # @!attribute :field [String] the name of the field.
+    #   @example: 'sourceResource_title'
+    #
+    # @!attribute :provider [Krikri::Provider]
+    attr_accessor :field, :provider
+
+    ##
+    # @param field [String] the name of the field being reported on
+    #   @example: 'sourceResource_title'
+    # @param provider_id [String] the id of the provider being reported on
+    # These two params act as a compound key.
+    #
+    # @return [Krikri::FieldValueReport]
+    def self.find(field, provider_id)
+      return nil unless fields.include? field.to_sym
+      provider = Krikri::Provider.find(provider_id)
+      return nil unless provider.present?
+      new({ :field => field,
+            :provider => provider })
+    end
+
+    ##
+    # All of the fields for which a report can be created.
+    def self.fields
+      [:dataProvider_providedLabel,
+       :sourceResource_alternative_providedLabel,
+       :sourceResource_collection_title,
+       :sourceResource_contributor_providedLabel,
+       :sourceResource_creator_providedLabel,
+       :sourceResource_date_providedLabel,
+       :sourceResource_description,
+       :sourceResource_format,
+       :sourceResource_genre_providedLabel,
+       :sourceResource_language_providedLabel,
+       :sourceResource_publisher_providedLabel,
+       :sourceResource_rights,
+       :sourceResource_rightsHolder_providedLabel,
+       :sourceResource_spatial_providedLabel,
+       :sourceResource_subject_providedLabel,
+       :sourceResource_temporal,
+       :sourceResource_title,
+       :sourceResource_type_name]
+    end
+
+    ##
+    # The headers for the report table, and the values to be returned from a
+    # Solr query.
+    def headers
+      [:id, :isShownAt_id, field.to_sym]
+    end
+
+    ##
+    # @param opts [Hash] optional parameters for the solr request
+    #   @example: enumerate_rows(batch_size: 1000)
+    # 
+    # @return Enumerator[<Array>] an enumerator over the rows
+    def enumerate_rows(opts = {})
+      Enumerator.new do |yielder|
+        loop do
+          opts = query_opts(opts)
+          response = Krikri::SolrResponseBuilder.new(opts).response
+          break if response.docs.empty?
+
+          parse_solr_response(response).each do |row|
+            yielder <<  headers.map { |header| row[header] }
+          end
+
+          opts[:start] += opts[:batch_size]
+          break if opts[:start] >= response.total
+        end
+      end
+    end
+
+    private
+
+    ##
+    # @param opts [Hash] additional options for the query params
+    # @return [Hash] parameters for a Solr request
+    def query_opts(opts = {})
+      { :fq => "provider_id:\"#{provider.rdf_subject}\"",
+        :fl => headers,
+        :rows => opts.fetch(:batch_size, 1000).to_i,
+        :start => opts.fetch(:start, 0).to_i }
+    end
+
+    ##
+    # @param [Blacklight::SolrResponse] response
+    # @return [Array<Hash>]
+    #
+    # The return Hashes should include keys for all headers defined in the
+    # :headers method
+    def parse_solr_response(response)
+      rows = []
+
+      response.docs.each do |doc|
+        id = doc['id'].split('/').last
+        isShownAt_id = doc['isShownAt_id'].respond_to?(:first) ?
+          doc['isShownAt_id'].first : '__MISSING__'
+
+        if doc[field].present?
+          doc[field].each do |value|
+            rows << { :id => id,
+                      field.to_sym => value,
+                      :isShownAt_id => isShownAt_id }
+          end
+        else
+          rows << { :id => id,
+                    field.to_sym => '__MISSING__',
+                    :isShownAt_id => isShownAt_id }
+        end
+      end
+
+      rows
+    end
+  end
+end

data/app/models/krikri/harvesters/oai_harvester.rb~

@@ -0,0 +1,10 @@
+module Krikri::Harvesters
+  class OAIHarvester < Krikri::Harvester
+
+    attr_accessor :client
+
+    def initialize(opts={})
+      @client = OAI::Client.new(opts[:endpoint])
+    end
+  end
+end

data/app/models/krikri/original_record_desc.rb~

@@ -0,0 +1,6 @@
+module Krikri
+  ##
+  # Descriptive Metadata for OriginalRecord
+  class OriginalRecordMetadata < ActiveTriples::Resource
+  end
+end

data/app/models/krikri/original_record_metadata.rb~

@@ -0,0 +1,9 @@
+module Krikri
+  ##
+  # Descriptive Metadata for OriginalRecord
+  class OriginalRecordMetadata < ActiveTriples::Resource
+    include Krikri::Ldp::RdfSource
+
+    property :wasGeneratedBy, predicate: RDF::PROV.wasGeneratedBy
+  end
+end

data/app/models/krikri/parser.rb~

@@ -0,0 +1,5 @@
+module Krikri
+  class Parser
+    
+  end
+end

data/app/models/krikri/parsers/xml_parser.rb~

@@ -0,0 +1,5 @@
+module Krikri::Parsers
+
+  class XmlParser
+  end
+end

data/app/models/krikri/provider.rb

@@ -6,18 +6,17 @@ module Krikri
   # This is a read-only object. It does not write new providers to Solr, nor
   # does it update or delete providers.
   #
+  # If Provider is initialized with a valid value for :rdf_subject, the model
+  # can extrapolate all other attributes.
+  #
   # 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
+  #   @example Krikri::Provider.new(rdf_subject: 'http://blah.com/123').agent
   #     => [DPLA::MAP::Agent]
   #
-  class Provider
-    include ActiveModel::Validations
-    include ActiveModel::Conversion
-    extend ActiveModel::Naming
-
+  class Provider < Krikri::ActiveModelBase
     ##
     # @!attribute :rdf_subject [String] the URI identifying the provider
     #   @example: "http://blah.com/contributor/123"
@@ -29,29 +28,10 @@ module Krikri
     #
     # @!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
+    # @!attribute :field_value_reports [Array<Krikri::FieldValueReport>]
+    attr_accessor :rdf_subject, :name, :field_value_reports
+    attr_reader :agent, :id
 
     ##
     # Gives a list of all providers, ignoring those with no URI (bnodes).
@@ -69,7 +49,8 @@ module Krikri
 
       response.facet_pivot['provider_id,provider_name'].map do |facet|
         rdf_subject = facet['value']
-        name = facet['pivot'].present? ? facet['pivot'].first['value'] : nil
+        name = facet['pivot'].present? ? facet['pivot'].first['value'] :
+          rdf_subject
         provider = new({ :rdf_subject => rdf_subject, :name => name })
         provider.valid_rdf_subject? ? provider : nil
       end.compact
@@ -89,8 +70,10 @@ module Krikri
                        :fl => 'provider_id provider_name' }
       response = Krikri::SolrResponseBuilder.new(query_params).response
       return nil unless response.docs.count > 0
+      name = response.docs.first['provider_name'].respond_to?(:first) ?
+        response.docs.first['provider_name'].first : rdf_subject
       new({ :rdf_subject => rdf_subject,
-            :name => response.docs.first['provider_name'].first })
+            :name => name })
     end
 
     ##
@@ -113,6 +96,10 @@ module Krikri
       @agent ||= initialize_agent
     end
 
+    def field_value_reports
+      @field_value_reports ||= initialize_field_value_reports
+    end
+
     ##
     # 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
@@ -122,12 +109,6 @@ module Krikri
       rdf_subject.start_with?(self.class.base_uri) ? true : false
     end
 
-    ##
-    # Required ActiveModel method.
-    def persisted?
-      false
-    end
-
     private
 
     ##
@@ -170,5 +151,11 @@ module Krikri
       return nil unless valid_rdf_subject?
       DPLA::MAP::Agent.new(rdf_subject).tap { |agent| agent.label = name }
     end
+
+    def initialize_field_value_reports
+      Krikri::FieldValueReport.fields.map do |field|
+        Krikri::FieldValueReport.new({ field: field, provider: self })
+      end
+    end
   end
 end

data/app/models/krikri/qa_report.rb~

@@ -0,0 +1,7 @@
+module Krikri
+  class QAReport
+    class << self
+      def all
+    end
+  end
+end

data/app/views/krikri/field_value_reports/show.csv.erb

@@ -0,0 +1 @@
+<%= @field_value_report.headers.to_csv %><% @field_value_report.enumerate_rows.each do |row| %><%= row.to_csv %><% end %>

data/app/views/krikri/qa_reports/index.html.erb~

@@ -0,0 +1,3 @@
+<% # krikri/qa_records/index %>
+
+<% content_for :title do %>Institutions<% end %>

data/app/views/krikri/qa_reports/show.html.erb~

@@ -0,0 +1 @@
+<% # krikri/institutions/show %>

data/app/views/krikri/reports/_field_value_report_list.html.erb

@@ -0,0 +1,14 @@
+<h3>Field Value Reports</h3>
+<% if @provider.present? %>
+  <p>Available as CSV downloads</p>
+  <ul>
+    <% @provider.field_value_reports.each do |report| %>
+      <li>
+        <%= link_to report.field, 
+                    provider_field_value_report_path(id: report.field,
+                                                     provider_id: @provider.id,
+                                                     format: :csv) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -6,6 +6,6 @@
   <h1>Reports</h1>
   <h2><%= provider_name(@current_provider) %></h2>
   <%= render "validation_report_list" %>
-
+  <%= render "field_value_report_list" %>
   <%= render "qa_report_list" %>
 </div>