supplejack_api 1

data/app/models/supplejack_api/interaction_updaters/all_usage_metric.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module InteractionUpdaters
+    class AllUsageMetric
+      BLACKLISTED_FIELDS = [:_id, :created_at, :updated_at, :date, :record_field_value].freeze
+      attr_reader :model
+
+      def initialize
+        # Slightly nonstandard model, so mock ActiveRecord interactions
+        # that the InteractionMetricsWorker performs
+        @model = OpenStruct.new(all: OpenStruct.new(delete_all: true))
+      end
+
+      def process(*)
+        usage_metrics = SupplejackApi::UsageMetrics
+                        .where(:record_field_value.ne => 'all')
+                        .created_on(Time.zone.today)
+        fields_to_update = SupplejackApi::UsageMetrics
+                           .fields
+                           .keys
+                           .map(&:to_sym)
+                           .reject { |field| BLACKLISTED_FIELDS.include? field }
+        summed_usage_metrics_fields = usage_metrics.reduce({}) do |acc, el|
+          fields_to_update.each_with_object(acc) do |field, accumulator|
+            accumulator[field] = accumulator[field].to_i + el[field]
+          end
+        end
+        all_metric = SupplejackApi::UsageMetrics.find_or_create_by(
+          record_field_value: 'all',
+          date: Time.zone.today
+        ) do |m|
+          m.record_field_value = 'all'
+          m.date = Time.zone.today
+        end
+
+        all_metric.update(summed_usage_metrics_fields)
+        true
+      end
+    end
+  end
+end

data/app/models/supplejack_api/interaction_updaters/set_metrics.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module InteractionUpdaters
+    class SetMetrics
+      attr_reader :model
+
+      def initialize
+        @model = SupplejackApi::InteractionModels::Set
+      end
+
+      def process(set_interactions)
+        unique_facets = set_interactions.map(&:facet).uniq
+
+        unique_facets.each do |facet|
+          metric = SupplejackApi::UsageMetrics.find_or_create_by(
+            date: Date.current,
+            record_field_value: facet
+          ) do |um|
+            um.date = Date.current
+            um.record_field_value = facet
+          end
+
+          records_added = set_interactions.count { |x| x.facet == facet }
+          metric.records_added_to_user_sets += records_added
+          metric.save!
+        end
+
+        true
+      end
+    end
+  end
+end

data/app/models/supplejack_api/interaction_updaters/usage_metrics.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module InteractionUpdaters
+    class UsageMetrics
+      attr_reader :model
+
+      def initialize
+        @model = SupplejackApi::InteractionModels::Record
+      end
+
+      def process(record_interactions)
+        search_counts = build_hash_for(record_interactions, 'search')
+        get_counts = build_hash_for(record_interactions, 'get')
+        user_set_counts = build_hash_for(record_interactions, 'user_set')
+
+        unique_facets = (search_counts.keys + get_counts.keys + user_set_counts.keys).uniq
+
+        # Creating metrics for each primary collection
+        unique_facets.each do |facet|
+          process_facet(facet, search_counts, get_counts, user_set_counts)
+        end
+
+        true
+      end
+
+      private
+
+      def process_facet(facet, search_counts, get_counts, user_set_counts)
+        usage_metric_entry = SupplejackApi::UsageMetrics.find_or_create_by(
+          date: Date.current,
+          record_field_value: facet
+        ) do |metric|
+          metric.date = Date.current
+          metric.record_field_value = facet
+        end
+
+        # set everything to default value of 0 if no value is present, makes following code simpler
+        [search_counts, get_counts, user_set_counts].each do |x|
+          x[facet] = 0 unless x[facet]
+        end
+
+        searches = usage_metric_entry.searches + search_counts[facet]
+        gets = usage_metric_entry.gets + get_counts[facet]
+        user_set_views = usage_metric_entry.user_set_views + user_set_counts[facet]
+
+        total = searches + gets + user_set_views
+
+        usage_metric_entry.update(
+          searches: searches,
+          gets: gets,
+          user_set_views: user_set_views,
+          total_views: total
+        )
+      end
+
+      def build_hash_for(record_interactions, request_type)
+        filtered_record_interactions = record_interactions.select { |rl| rl.request_type == request_type }
+        counts_by_facet = {}
+
+        filtered_record_interactions.each do |rl|
+          next unless rl.log_values.present?
+
+          rl.log_values.each do |facet|
+            counts_by_facet[facet] = 0 unless counts_by_facet.key? facet
+            counts_by_facet[facet] += 1
+          end
+        end
+
+        counts_by_facet
+      end
+    end
+  end
+end

data/app/models/supplejack_api/partner.rb

@@ -0,0 +1,24 @@
+# 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 Partner
+    include Mongoid::Document
+    include ActiveModel::MassAssignmentSecurity
+
+    store_in collection: 'partners', session: 'strong'
+
+    attr_accessible :_id, :name
+
+    field :name, type: String
+
+    has_many :sources, class_name: 'SupplejackApi::Source'
+
+    validates :name, presence: true
+  end
+end

data/app/models/supplejack_api/preview_record.rb

@@ -0,0 +1,30 @@
+# 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 PreviewRecord
+    # These records are used for previewing in squirrel, expire after 60 seconds
+
+    include Support::Storable
+    include Support::FragmentHelpers
+    include Support::Harvestable
+
+    store_in collection: 'preview_records'
+
+    embeds_many :fragments, cascade_callbacks: true, class_name: 'SupplejackApi::ApiRecord::RecordFragment'
+    embeds_one :merged_fragment, class_name: 'SupplejackApi::ApiRecord::RecordFragment'
+
+    auto_increment :record_id, session: 'strong', collection: 'preview_sequences'
+
+    build_model_fields
+
+    def fragment_class
+      SupplejackApi::ApiRecord::RecordFragment
+    end
+  end
+end

data/app/models/supplejack_api/record.rb

@@ -0,0 +1,18 @@
+# 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 Record
+    include Support::Storable
+    include Support::Searchable
+    include Support::Harvestable
+    include Support::FragmentHelpers
+    include ActiveModel::SerializerSupport
+    include SupplejackApi::Concerns::Record
+  end
+end

data/app/models/supplejack_api/record_search.rb

@@ -0,0 +1,12 @@
+# 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 RecordSearch < Search
+  end
+end

data/app/models/supplejack_api/schema_definition.rb

@@ -0,0 +1,147 @@
+# 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 SchemaDefinition
+    extend ActiveSupport::Concern
+
+    ALLOWED_ATTRIBUTES = {
+      field: [:type, :search_value, :search_boost, :multi_value, :search_as, :store,
+              :solr_name, :namespace, :namespace_field, :default_value, :date_format],
+      group: [:fields, :includes],
+      role: [:default, :field_restrictions, :record_restrictions, :admin],
+      namespace: [:url],
+      mongo_index: [:fields, :index_options],
+      model_field: [:type, :field_options, :validation, :index_fields, :index_options,
+                    :search_value, :search_as, :store, :namespace]
+    }.freeze
+
+    included do
+      cattr_accessor :fields, :groups, :roles, :default_role, :namespaces, :mongo_indexes, :model_fields
+    end
+
+    module ClassMethods
+      [:string, :integer, :datetime, :boolean, :latlon].each do |type|
+        define_method(type) do |*args, &block|
+          field(type, *args, &block)
+        end
+      end
+
+      private
+
+      def field(type, name, options = {}, &block)
+        self.fields ||= {}
+        options[:type] = type
+
+        field = Field.new(name, options, &block)
+        self.fields[name] = field
+      end
+
+      def group(name, options = {}, &block)
+        self.groups ||= {}
+
+        group = Group.new(name, options, &block)
+        group.include_groups_from(groups)
+
+        self.groups[name] = group
+      end
+
+      def role(name, options = {}, &block)
+        self.roles ||= {}
+
+        role = Role.new(name, options, &block)
+        self.default_role = role if role.default
+
+        self.roles[name] = role
+      end
+
+      def namespace(name, options = {})
+        self.namespaces ||= {}
+
+        namespace = Namespace.new(name, options)
+        self.namespaces[name] = namespace
+      end
+
+      def mongo_index(name, options = {})
+        self.mongo_indexes ||= {}
+
+        mongo_index = MongoIndex.new(name, options)
+        self.mongo_indexes[name] = mongo_index
+      end
+
+      def model_field(name, options = {}, &block)
+        self.model_fields ||= {}
+
+        model_field = ModelField.new(name, options, &block)
+        self.model_fields[name] = model_field
+      end
+    end
+
+    class SchemaObject
+      ALLOWED_ATTRIBUTES = ALLOWED_ATTRIBUTES.values.flatten
+
+      attr_reader :name
+
+      def initialize(name, options, &block)
+        @name = name
+
+        builder = SchemaObjectBuilder.new(options)
+        builder.instance_eval(&block) if block_given?
+
+        @options = builder.options
+      end
+
+      ALLOWED_ATTRIBUTES.each do |attr|
+        define_method(attr) do
+          @options[attr]
+        end
+      end
+
+      class SchemaObjectBuilder
+        attr_reader :options
+
+        def initialize(options)
+          @options = options
+        end
+
+        ALLOWED_ATTRIBUTES.each do |attr|
+          define_method(attr) do |*args, &block|
+            @options[attr] = block || args.first
+          end
+        end
+      end
+    end
+
+    class Field < SchemaObject
+      def namespace_field
+        namespace_field = !!@options[:namespace_field] ? @options[:namespace_field] : @name
+      end
+    end
+
+    class Namespace < SchemaObject
+    end
+
+    class Group < SchemaObject
+      def include_groups_from(existing_groups)
+        return unless @options[:includes].present?
+
+        included_fields = @options[:includes].collect { |g| existing_groups[g].fields }
+        @options[:fields] = included_fields.flatten | @options[:fields]
+      end
+    end
+
+    class Role < SchemaObject
+    end
+
+    class MongoIndex < SchemaObject
+    end
+
+    class ModelField < SchemaObject
+    end
+  end
+end

data/app/models/supplejack_api/search.rb

@@ -0,0 +1,14 @@
+# 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 Search
+    include ActiveModel::SerializerSupport
+    include SupplejackApi::Concerns::Searchable
+  end
+end

data/app/models/supplejack_api/set_item.rb

@@ -0,0 +1,57 @@
+# 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 SetItem
+    include Mongoid::Document
+
+    ATTRIBUTES = RecordSchema.groups[:sets].fields
+
+    attr_accessor :record
+
+    embedded_in :user_set, class_name: 'SupplejackApi::UserSet'
+
+    field :record_id,   type: Integer
+    field :position,    type: Integer
+
+    validates :record_id,   presence: true, uniqueness: true, numericality: { greater_than: 0 }
+    validates :position,    presence: true
+    validate  :not_adding_set_to_itself
+
+    before_validation :set_position
+    after_destroy :reindex_record
+
+    def not_adding_set_to_itself
+      return unless user_set.record && record_id == user_set.record.record_id
+
+      errors.add(:set, "can't be added to itself")
+    end
+
+    # Dynamically define methods for the attributes that get added to the set_item from
+    # the actual Record.
+    #
+    ATTRIBUTES.each do |record_attr|
+      define_method(record_attr) do
+        record.try(:send, record_attr)
+      end
+    end
+
+    # Set the default position as the last in the set, if not defined.
+    #
+    def set_position
+      return if position
+
+      positions = user_set.set_items.map(&:position)
+      self.position = positions.compact.max.to_i + 1
+    end
+
+    def reindex_record
+      SupplejackApi::Record.custom_find(record_id).index rescue nil
+    end
+  end
+end