supplejack_api 1

data/app/models/supplejack_api/site_activity.rb

@@ -0,0 +1,59 @@
+# 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 SiteActivity
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Sortable::Query
+
+    store_in collection: 'site_activities'
+
+    field :date,      type: Date
+    field :user_sets, type: Integer
+    field :search,    type: Integer
+    field :records,   type: Integer
+    field :source_clicks, type: Integer
+    field :total,     type: Integer
+
+    validates_uniqueness_of :date
+
+    IMPLICIT_FIELDS = %w(_type _id created_at updated_at).freeze
+
+    def self.generate_activity(time = Time.now)
+      site_activity_date = time.to_date
+      user_activities = SupplejackApi::UserActivity.gt(created_at: time - 12.hours).lte(created_at: time)
+
+      attributes = { user_sets: 0, search: 0, records: 0 }
+
+      user_activities.each do |user_activity|
+        [:user_sets, :search, :records].each do |field|
+          attributes[field] += user_activity.send(field)['total'] if user_activity.send(field)
+        end
+      end
+
+      # The date stored is yesterday's date since the activity corresponds to the day before.
+      attributes[:date] = site_activity_date
+
+      site_activity = new(attributes)
+      site_activity.source_clicks = SupplejackApi::SourceActivity.get_source_clicks || 0
+      SupplejackApi::SourceActivity.reset
+      site_activity.calculate_total
+      site_activity.save
+      site_activity
+    end
+
+    def self.activities
+      %w(date search user_sets records source_clicks total) - IMPLICIT_FIELDS
+    end
+
+    def calculate_total
+      self.total = user_sets + records + search + source_clicks
+    end
+  end
+end

data/app/models/supplejack_api/source.rb

@@ -0,0 +1,28 @@
+# 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 Source
+    include Mongoid::Document
+    include ActiveModel::MassAssignmentSecurity
+
+    store_in collection: 'sources', session: 'strong'
+
+    attr_accessible :name, :source_id, :_id, :partner_id, :status
+
+    field :name,        type: String
+    field :source_id,   type: String
+    field :status, 		type: String, default: 'active'
+
+    belongs_to :partner, class_name: 'SupplejackApi::Partner'
+
+    validates :name, presence: true
+
+    scope :suppressed,  -> { where(status: 'suppressed') }
+  end
+end

data/app/models/supplejack_api/source_activity.rb

@@ -0,0 +1,36 @@
+# 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 SourceActivity
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    store_in collection: 'source_activities'
+
+    field :source_clicks,	type: Integer, default: 0
+
+    private_class_method :new
+
+    def self.increment
+      if first
+        first.inc(source_clicks: 1)
+      else
+        SupplejackApi::SourceActivity.create(source_clicks: 1)
+      end
+    end
+
+    def self.get_source_clicks
+      SupplejackApi::SourceActivity.first.try(:source_clicks)
+    end
+
+    def self.reset
+      SupplejackApi::SourceActivity.first.try(:delete)
+    end
+  end
+end

data/app/models/supplejack_api/source_authority.rb

@@ -0,0 +1,42 @@
+# 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 SourceAuthority
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Mongoid::Attributes::Dynamic
+
+    # TODO: Move this to a class/module that store all the constants
+    MONGOID_TYPE_NAMES = {
+      string: String,
+      integer: Integer,
+      datetime: DateTime,
+      boolean: Boolean
+    }.freeze
+
+    store_in collection: 'source_authorities'
+
+    field :concept_type,                       type: String
+    field :internal_identifier,         type: String
+    field :concept_score,               type: Integer
+    field :source_id,                   type: String
+    field :source_name,                 type: String
+    field :url,                         type: String
+
+    # TODO: Add field validations
+
+    belongs_to :concept, class_name: 'SupplejackApi::Concept'
+
+    ConceptSchema.fields.each do |name, field|
+      next if field.store == false
+      type = field.multi_value.presence ? Array : MONGOID_TYPE_NAMES[field.type]
+      field name, type: type
+    end
+  end
+end

data/app/models/supplejack_api/supplejack_schema.rb

@@ -0,0 +1,37 @@
+# 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 SupplejackSchema
+    extend ActiveSupport::Concern
+    include SupplejackApi::SchemaDefinition
+
+    CORE_FIELDS = [
+      :internal_identifier,
+      :status,
+      :record_type,
+      :created_at,
+      :updated_at
+    ].freeze
+
+    included do
+      CORE_FIELDS.each do |field|
+        string field, store: false
+      end
+
+      group :internal_fields do
+        fields CORE_FIELDS
+      end
+
+      # Index core fields in mongo
+      # mongo_index :status,              fields: [{status: 1}]
+      # mongo_index :internal_identifier, fields: [{internal_identifier: 1}]
+      # mongo_index :updated_at,          fields: [{updated_at: 1}]
+    end
+  end
+end

data/app/models/supplejack_api/support/concept/searchable.rb

@@ -0,0 +1,79 @@
+# 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 Support
+    module Concept
+      module Searchable
+        extend ActiveSupport::Concern
+
+        SUNSPOT_TYPE_NAMES = {
+          string: :string,
+          integer: :integer,
+          datetime: :time,
+          boolean: :boolean,
+          latlon: :latlon
+        }.freeze
+
+        included do
+          include Sunspot::Mongoid
+
+          searchable do
+            build_sunspot_schema(self)
+          end # searchable
+        end # included
+
+        module ClassMethods
+          def custom_find(id, _scope = nil, options = {})
+            options ||= {}
+            class_scope = unscoped
+
+            if id.to_s =~ /^\d+$/
+              data = class_scope.where(concept_id: id).first
+            elsif id.to_s =~ /^[0-9a-f]{24}$/i
+              data = class_scope.find(id)
+            end
+
+            raise Mongoid::Errors::DocumentNotFound.new(self, [id], [id]) unless data
+
+            data
+          end
+
+          def build_sunspot_schema(builder)
+            ConceptSchema.model_fields.each do |_name, field|
+              options = {}
+              search_as = field.search_as || []
+
+              value_block = nil
+              if field.search_value.present?
+                value_block = proc do
+                  field.search_value.call(self)
+                end
+              end
+
+              options[:as] = field.solr_name if field.solr_name.present?
+
+              if search_as.include? :filter
+                filter_options = {}
+                filter_options[:multiple] = true if field.multi_value.present?
+                type = SUNSPOT_TYPE_NAMES[field.type]
+
+                builder.public_send(type, field.name, options.merge(filter_options), &value_block)
+              end
+
+              if search_as.include? :fulltext
+                options[:boost] = field.search_boost if field.search_boost.present?
+                builder.text field.name, options, &value_block
+              end
+            end
+          end
+        end # module ClassMethods
+      end # module Searchable
+    end # module Concept
+  end # module Support
+end # module SupplejackApi

data/app/models/supplejack_api/support/concept/storable.rb

@@ -0,0 +1,59 @@
+# 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 Support
+    module Concept
+      module Storable
+        extend ActiveSupport::Concern
+
+        included do
+          include Mongoid::Document
+          include Mongoid::Timestamps
+          include Mongoid::Attributes::Dynamic
+
+          store_in collection: 'concepts'
+
+          has_many :source_authorities, class_name: 'SupplejackApi::SourceAuthority'
+
+          # Both of these fields are required in SJ API Core
+          # No need to configure in *Schema
+          field           :concept_type,         type: String
+          auto_increment  :concept_id
+
+          index({ concept_id: 1 }, unique: true)
+
+          ConceptSchema.model_fields.each do |name, option|
+            next if option.store == false
+            field name.to_sym, option.field_options if !!option.field_options
+
+            # TODO: Set the Mongo index
+            # TODO: Set the validation
+          end
+
+          def records
+            # Limit the number of records by 50
+            SupplejackApi::Record.where(concept_ids: id).limit(50).to_a
+          end
+        end # included
+
+        def edm_type
+          concept_type.gsub(/edm:/, '').downcase.pluralize
+        end
+
+        def site_id
+          [ENV['CONCEPT_HTTP_HOST'], 'concepts', concept_id].join('/')
+        end
+
+        def context
+          [ENV['HTTP_HOST'], 'schema'].join('/')
+        end
+      end # module
+    end
+  end
+end

data/app/models/supplejack_api/support/fragment_helpers.rb

@@ -0,0 +1,96 @@
+# 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 Support
+    module FragmentHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        validate :validate_unique_source_ids
+      end
+
+      def source_ids
+        fragments.map(&:source_id)
+      end
+
+      def duplicate_source_ids?
+        source_ids.size != fragments.distinct(:source_id).count
+      end
+
+      def validate_unique_source_ids
+        return unless duplicate_source_ids?
+
+        errors.add(:base, "fragment source_ids must be unique, source_ids: #{source_ids}")
+        klass_name = fragment_class.to_s.demodulize.gsub(/Fragment/, '')
+        klass_id = "#{klass_name.downcase}_id"
+        log_message = "#{klass_name} with #{klass_id}:#{send(klass_id)},"
+        log_message += " internal_identifier:#{internal_identifier} failed validation."
+        log_message += "  Fragment source_ids must be unique, source_ids: #{source_ids}"
+        ValidationLogger.logger.error(log_message)
+      end
+
+      def primary_fragment(attributes = {})
+        primary = fragments.where(priority: 0).first
+        primary ? primary : fragments.build(attributes.merge(priority: 0))
+      end
+
+      def primary_fragment!(attributes = {})
+        primary_fragment(attributes).tap(&:save)
+      end
+
+      def merge_fragments
+        self.merged_fragment = nil
+
+        return unless fragments.size > 1
+
+        self.merged_fragment = fragment_class.new
+
+        fragment_class.mutable_fields.each do |name, field_type|
+          if field_type == Array
+            values = Set.new
+            sorted_fragments.each do |s|
+              values += Array(s.public_send(name))
+            end
+            merged_fragment.public_send("#{name}=", values.to_a)
+          else
+            values = sorted_fragments.to_a.map { |s| s.public_send(name) }
+            merged_fragment.public_send("#{name}=", values.compact.first)
+          end
+        end
+
+        merged_fragment.unset(:priority)
+      end
+
+      # Fetch the attribute from the underlying
+      # merged_fragment or only fragment.
+      # Means that record.{attribute} (ie. record.name) works for convenience
+      # and abstracts away the fact that fragments exist
+      # rubocop:disable Style/MethodMissing
+      def method_missing(symbol, *_args)
+        type = fragment_class.mutable_fields[symbol.to_s]
+
+        if merged_fragment
+          value = merged_fragment.public_send(symbol)
+        elsif fragments.first
+          value = fragments.first.public_send(symbol)
+        end
+        type == Array ? Array(value) : value
+      end
+      # rubocop:enable Style/MethodMissing
+
+      def sorted_fragments
+        fragments.sort_by { |s| s.priority || Integer::INT32_MAX }
+      end
+
+      def find_fragment(source_id)
+        fragments.where(source_id: source_id).first
+      end
+    end
+  end
+end