supplejack_api 1

data/app/models/supplejack_api/concerns/user_set.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+module SupplejackApi::Concerns::UserSet
+  extend ActiveSupport::Concern
+
+  included do
+    store_in collection: 'user_sets', session: 'strong'
+
+    belongs_to :user, class_name: 'SupplejackApi::User'
+    belongs_to :record, class_name: 'SupplejackApi::Record', inverse_of: nil
+
+    embeds_many :set_items, class_name: 'SupplejackApi::SetItem' do
+      def find_by_record_id(record_id)
+        where(record_id: record_id).first
+      end
+    end
+
+    field :name,              type: String
+    field :description,       type: String
+    field :privacy,           type: String,   default: 'public'
+    field :url,               type: String
+    field :priority,          type: Integer,  default: 0
+    field :count,             type: Integer,  default: 0
+    field :count_updated_at,  type: DateTime
+    field :tags,              type: Array,    default: []
+    field :approved,          type: Boolean,  default: false
+    field :featured,          type: Boolean,  default: false
+    field :featured_at,       type: DateTime
+
+    scope :excluding_favorites, -> { where(:name.ne => 'Favorites') }
+    scope :publicly_viewable,              -> { where(privacy: 'public') }
+
+    index 'set_items.record_id' => 1
+    index featured: 1
+
+    attr_accessible :name, :description, :privacy, :priority, :tags, :tag_list, :records, :approved
+
+    validates :name, presence: true
+    validates :privacy, inclusion: { in: %w(public hidden private) }
+
+    before_validation :set_default_privacy
+    before_save :calculate_count
+    before_save :strip_html_tags
+    before_save :update_record
+    after_save :reindex_items
+    before_destroy :delete_record
+
+    # Force-capitalize only the first word of the set name
+    #
+    def name=(name)
+      write_attribute(:name, Utils.capitalize_first_word(name))
+    end
+
+    # Find a set based on the MongoDB ObjectID or the set url.
+    #
+    def self.custom_find(id)
+      user_set = if id.to_s.length == 24
+                   find(id) rescue nil
+                 else
+                   where(url: id).first
+                 end
+    end
+
+    def self.public_sets(options = {})
+      options.reverse_merge!(page: 1, per_page: 100)
+      page = options[:page].to_i
+      page = page.zero? ? 1 : page
+      where(privacy: 'public', :name.ne => 'Favourites').desc(:created_at).page(page)
+    end
+
+    def self.public_sets_count
+      where(privacy: 'public', :name.ne => 'Favourites').count
+    end
+
+    def self.featured_sets(num = 16)
+      sets = where(privacy: 'public', featured: true).desc(:featured_at).limit(num).to_a
+      sets.delete_if { |s| s.records(1).try(:empty?) }
+      sets
+    end
+
+    # Accept a hash of attributes with the user_set attributes, a array
+    # of hashes with the set_items information and a optional "featured"
+    # attribute which only the administrator is allowed to modify
+    #
+    def update_attributes_and_embedded(new_attributes = {}, user = nil)
+      new_attributes = new_attributes.try(:symbolize_keys) || {}
+
+      if set_items = new_attributes.delete(:records)
+        if set_items.is_a? Array
+          begin
+            new_set_items = []
+            set_items.each do |set_item_hash|
+              set_item = self.set_items.find_or_initialize_by(record_id: set_item_hash['record_id'])
+              set_item.position = set_item_hash['position']
+              new_set_items << set_item if set_item.valid?
+            end
+            self.set_items = new_set_items
+          rescue StandardError => e
+            raise WrongRecordsFormat
+          end
+        end
+      end
+
+      if new_attributes.key?(:featured)
+        featured_value = new_attributes.delete(:featured)
+        if user.try(:can_change_featured_sets?)
+          self.featured = featured_value
+          self.featured_at = Time.now if featured_changed?
+        end
+      end
+
+      self.attributes = new_attributes
+      save
+    end
+
+    def calculate_count
+      self.count = records.size
+    end
+
+    def set_default_privacy
+      self.privacy = 'public' if self[:privacy].blank?
+    end
+
+    def record_status
+      privacy == 'public' && approved ? 'active' : 'suppressed'
+    end
+
+    # Remove HTML tags from the name, description and tags
+    #
+    def strip_html_tags
+      [:name, :description].each do |attr|
+        send("#{attr}=", strip_tags(self[attr])) if self[attr].present?
+      end
+
+      self.tags = self[:tags].map { |t| strip_tags(t) } if tags.try(:any?)
+    end
+
+    def update_record
+      if set_items.empty?
+        suppress_record
+        return nil
+      end
+
+      self.record = SupplejackApi::Record.new if record.nil?
+
+      record.status = record_status
+      record.internal_identifier = "user_set_#{id}"
+
+      primary_fragment = record.primary_fragment
+
+      record.save!
+    end
+
+    def delete_record
+      if record
+        record.status = 'deleted'
+        record.save!
+      end
+    end
+
+    def suppress_record
+      if record
+        record.status = 'suppressed'
+        record.save!
+      end
+    end
+
+    def record_ids
+      set_items.asc(:position).map(&:record_id)
+    end
+
+    # Return a array of actual Record objects
+    #
+    def records(amount = nil)
+      @records ||= begin
+        ids_to_fetch = record_ids || []
+        records = SupplejackApi::Record.find_multiple(ids_to_fetch)
+        records = records[0..amount.to_i - 1] if amount
+        records
+      end
+    end
+
+    def tags=(list)
+      self[:tags] = *list
+    end
+
+    def tag_list=(tags_string)
+      tags_string = tags_string.to_s.gsub(/[^A-Za-z0-9\p{Word} ,_-]/, '')
+      self.tags = tags_string.to_s.split(',').map(&:strip).reject(&:blank?)
+    end
+
+    def tag_list
+      tags.join(', ') if tags.present?
+    end
+
+    # Return a array of SetItem objects with the actual Record object attached through
+    # the "record" virtual attribute.
+    #
+    # The set items are sorted by position.
+    #
+    def items_with_records(amount = nil)
+      records = self.records(amount)
+
+      items_with_records = set_items.map do |set_item|
+        set_item.record = records.detect { |r| r.record_id == set_item.record_id }
+        set_item
+      end
+
+      items_with_records.reject { |i| i.record.nil? }.sort_by(&:position)
+    end
+
+    def reindex_items
+      set_items.each do |i|
+        SupplejackApi::Record.custom_find(i.record_id).index rescue nil
+      end
+    end
+
+    class WrongRecordsFormat < RuntimeError; end
+  end
+end

data/app/models/supplejack_api/daily_metrics.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class DailyMetrics
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include SupplejackApi::Concerns::QueryableByDate
+
+    store_in collection: 'daily_metrics'
+
+    field :total_public_sets, type: Integer
+    field :date,               type: Date
+  end
+end

data/app/models/supplejack_api/faceted_metrics.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class FacetedMetrics
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include SupplejackApi::Concerns::QueryableByDate
+
+    before_save :replace_periods
+    after_save :replace_unicode_periods
+    after_find :replace_unicode_periods
+
+    store_in collection: 'faceted_metrics'
+
+    field :date,                 type: Date
+    field :name,                 type: String
+    field :total_active_records, type: Integer
+    field :total_new_records,    type: Integer
+    field :category_counts,      type: Hash
+    field :copyright_counts,     type: Hash
+
+    # MongoDB does not allow you to store hashes that have keys with peroids in the name
+    # Some of the copyrights contain version numbers which prevents them from being stored
+    # as keys directly. This replaces periods with the unicode equivalent
+    def replace_periods
+      self.category_counts  = Hash[category_counts. map(&key_replacer('.', "\u2024"))] if category_counts
+      self.copyright_counts = Hash[copyright_counts.map(&key_replacer('.', "\u2024"))] if copyright_counts
+    end
+
+    # MongoDB does not allow you to store hashes that have keys with peroids in the name
+    # Some of the copyrights contain version numbers which prevents them from being stored
+    # as keys directly. This replaces unicode periods with normal periods so this quirk
+    # doesn't affect the application code
+    def replace_unicode_periods
+      self.category_counts  = Hash[category_counts. map(&key_replacer("\u2024", '.'))] if category_counts
+      self.copyright_counts = Hash[copyright_counts.map(&key_replacer("\u2024", '.'))] if copyright_counts
+    end
+
+    private
+
+    def key_replacer(target, replacement)
+      lambda do |kv|
+        key, value = kv
+
+        [key.gsub(target, replacement), value]
+      end
+    end
+  end
+end

data/app/models/supplejack_api/fragment.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  class Fragment
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Attributes::Dynamic
+
+    default_scope -> { asc(:priority) }
+
+    field :source_id, type: String
+    field :priority,  type: Integer, default: 1
+    field :job_id,  type: String
+
+    MONGOID_TYPE_NAMES = {
+      string: String,
+      integer: Integer,
+      datetime: DateTime,
+      boolean: Boolean
+    }.freeze
+
+    def self.schema_class
+      raise NotImplementedError, 'All subclasses of SupplejackApi::Fragment must define a #schema_class method.'
+    end
+
+    def self.build_mongoid_schema
+      # Build fields
+      schema_class.fields.each do |name, field|
+        next if field.store == false
+        type = field.multi_value.presence ? Array : MONGOID_TYPE_NAMES[field.type]
+        self.field name, type: type
+      end
+
+      # Build indexes
+      if schema_class.mongo_indexes.present?
+        schema_class.mongo_indexes.each do |_name, index|
+          index_options = !!index.index_options ? index.index_options : {}
+          self.index index.fields.first, index_options
+        end
+      end
+    end
+
+    def primary?
+      priority.zero?
+    end
+
+    def clear_attributes
+      mutable_fields = self.class.mutable_fields.dup
+      mutable_fields.delete('priority') if primary?
+      raw_attributes.each do |name, _value|
+        self[name] = nil if mutable_fields.key?(name)
+      end
+    end
+
+    def update_from_harvest(attributes = {})
+      attributes = attributes.try(:symbolize_keys) || {}
+
+      self.source_id = Array(attributes[:source_id]).first if attributes[:source_id].present?
+
+      attributes.each do |field, value|
+        if self.class.mutable_fields[field.to_s] == Array
+          self[field] ||= []
+          values = *value
+          existing_values = *self[field]
+          values = existing_values += values
+          send("#{field}=", values.uniq)
+        elsif self.class.mutable_fields[field.to_s]
+          value = value.first if value.is_a?(Array)
+          send("#{field}=", value)
+        end
+      end
+
+      self.updated_at = Time.now
+    end
+  end
+end

data/app/models/supplejack_api/interaction_models/record.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# The majority of the Supplejack API code is Crown copyright (C) 2014, New Zealand Government,
+# and is licensed under the GNU General Public License, version 3.
+# One component is a third party component. See https://github.com/DigitalNZ/supplejack_api for details.
+#
+# Supplejack was created by DigitalNZ at the National Library of NZ and
+# the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+module SupplejackApi
+  module InteractionModels
+    class Record
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      store_in collection: 'record_interactions'
+
+      field :request_type, type: String
+      field :log_values,   type: Array
+
+      @field = :display_collection
+
+      def self.create_search(object)
+        results = object.results.map(&@field).flatten
+        create(request_type: 'search', log_values: results) unless results.empty?
+      rescue
+        Rails.logger.warn "[RecordInteraction] Field #{field} does not exist"
+      end
+
+      def self.create_find(object)
+        return if object.nil?
+        result = object.send(@field)
+        result = [result] unless result.is_a? Array
+        create(request_type: 'get', log_values: result) unless result.empty?
+      rescue
+        Rails.logger.warn "[RecordInteraction] Field #{field} does not exist"
+      end
+
+      # Creates one Interaction Model that contains set items in a set
+      #
+      # @param object [SupplejackApi::UserSet]
+      def self.create_user_set(object)
+        results = []
+        unless object.set_items.empty?
+          object.set_items.each do |item|
+            next if item.record.nil?
+            record = SupplejackApi::Record.custom_find(item.record_id)
+            if record
+              result = record.send(@field)
+              results << result if result
+            end
+          end
+        end
+
+        create(request_type: 'user_set', log_values: results.flatten) unless results.empty?
+      rescue
+        Rails.logger.warn "[RecordInteraction] Field #{field} does not exist"
+      end
+    end
+  end
+end

data/app/models/supplejack_api/interaction_models/set.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module InteractionModels
+    class Set
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      # Potential values are :creation and :view
+      field :interaction_type,   type: Symbol
+      field :facet, type: String
+    end
+  end
+end