supplejack_api 1

data/app/controllers/supplejack_api/concerns/ignore_metrics.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module Concerns
+    module IgnoreMetrics
+      extend ActiveSupport::Concern
+
+      included do
+        def log_request_for_metrics?
+          !params.key? :ignore_metrics
+        end
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/concerns/records_controller_metrics.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module Concerns
+    module RecordsControllerMetrics
+      extend ActiveSupport::Concern
+      include IgnoreMetrics
+
+      included do
+        after_action :log_search, only: :index
+        after_action :log_record_view, only: :show
+
+        def log_search
+          return unless @search.valid? && log_request_for_metrics?
+
+          SupplejackApi::InteractionModels::Record.create_search(@search)
+        end
+
+        def log_record_view
+          return unless log_request_for_metrics?
+
+          SupplejackApi::InteractionModels::Record.create_find(@record)
+        end
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/concerns/set_items_controller_metrics.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module Concerns
+    module SetItemsControllerMetrics
+      extend ActiveSupport::Concern
+      include IgnoreMetrics
+
+      included do
+        before_action :create_set_interaction, only: :create
+
+        def create_set_interaction
+          return unless log_request_for_metrics?
+
+          record = SupplejackApi::Record.custom_find(params[:record][:record_id])
+          SupplejackApi::InteractionModels::Set.create(interaction_type: :creation, facet: record.display_collection)
+        end
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/concerns/user_sets_controller_metrics.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module Concerns
+    module UserSetsControllerMetrics
+      extend ActiveSupport::Concern
+      include IgnoreMetrics
+
+      included do
+        after_action :create_set_record_view, only: :show
+        after_action :create_set_interaction, only: :create
+
+        def create_set_record_view
+          return unless @user_set && log_request_for_metrics?
+
+          SupplejackApi::InteractionModels::Record.create_user_set(@user_set)
+        end
+
+        def create_set_interaction
+          return unless @user_set && log_request_for_metrics?
+          record = SupplejackApi::Record.custom_find(@user_set.set_items.first.record_id)
+          SupplejackApi::InteractionModels::Set.create(interaction_type: :creation, facet: record.display_collection)
+        end
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/harvester/concepts_controller.rb

@@ -0,0 +1,41 @@
+# 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 Harvester
+    class ConceptsController < ActionController::Base
+      respond_to :json
+
+      def create
+        if params[:preview]
+          klass = SupplejackApi::PreviewRecord
+          attribute = :record_id
+        else
+          klass = SupplejackApi::Concept
+          attribute = :concept_id
+        end
+
+        @concept = klass.find_or_initialize_by_identifier(params[:concept])
+        @concept.set_status(params[:required_fragments])
+        @concept.create_or_update_fragment(params[:concept])
+        @concept.save
+        @concept.unset_null_fields
+
+        render json: { attribute => @concept.concept_id }
+      end
+
+      def update
+        @concept = Concept.custom_find(params[:id], nil, status: :all)
+        if params[:concept].present? && params[:concept][:status].present?
+          @concept.update_attribute(:status, params[:concept][:status])
+        end
+        respond_with @concept
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/harvester/fragments_controller.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
+  module Harvester
+    class FragmentsController < ActionController::Base
+      respond_to :json
+
+      def create
+        klass = params[:preview] ? PreviewRecord : Record
+        @record = klass.find(params[:record_id])
+        @record.create_or_update_fragment(params[:fragment])
+        @record.set_status(params[:required_fragments])
+        @record.save
+        render json: { record_id: @record.record_id }
+      end
+
+      def destroy
+        SupplejackApi::Record.where("fragments.source_id": params[:id])
+                             .update_all('$pull' => { fragments: { source_id: params[:id] } })
+        respond_with
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/harvester/records_controller.rb

@@ -0,0 +1,68 @@
+# 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 Harvester
+    class RecordsController < ActionController::Base
+      respond_to :json
+
+      def create
+        klass = params[:preview] ? SupplejackApi::PreviewRecord : SupplejackApi::Record
+        @record = klass.find_or_initialize_by_identifier(params[:record])
+
+        # In the long run this condition shouldn't be here.
+        # It's because the data_handler interfaces are using update_from_harvest,
+        # and clear_attributes that I can't factor it back in.
+        if params[:record][:priority] && params[:record][:priority].to_i.nonzero?
+          @record.create_or_update_fragment(params[:record])
+        else
+          @record.clear_attributes
+          @record.update_from_harvest(params[:record])
+        end
+
+        @record.set_status(params[:required_fragments])
+        @record.save
+        @record.unset_null_fields
+        render json: { record_id: @record.record_id }
+      end
+
+      def flush
+        Resque.enqueue(FlushOldRecordsWorker, params[:source_id], params[:job_id])
+        render nothing: true, status: 204
+      end
+
+      def delete
+        @record = Record.where(internal_identifier: params[:id]).first
+        @record.update_attribute(:status, 'deleted') if @record.present?
+        render nothing: true, status: 204
+      end
+
+      def update
+        @record = Record.custom_find(params[:id], nil, status: :all)
+        if params[:record].present? && params[:record][:status].present?
+          @record.update_attribute(:status, params[:record][:status])
+        end
+        respond_with @record
+      end
+
+      def show
+        @record = Record.where(record_id: params[:id]).first
+
+        if @record.present?
+          render json: {
+            record_id: @record.record_id,
+            title: @record.title,
+            status: @record.status
+          }.to_json
+        else
+          render nothing: true, status: 204
+        end
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/metrics_api_controller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module SupplejackApi
+  class MetricsApiController < ApplicationController
+    skip_before_action :authenticate_user!
+
+    API_VERSIONS = {
+      'v3' => MetricsApi::V3::Api
+    }.freeze
+
+    def root
+      render_response(:root)
+    end
+
+    def facets
+      render_response(:facets)
+    end
+
+    def global
+      render_response(:global)
+    end
+
+    private
+
+    def render_response(endpoint)
+      api_version = params[:version]
+      api = API_VERSIONS[api_version].new(params.dup, endpoint)
+
+      api_response = api.call
+
+      handle_errors(api_response)
+
+      # don't double render if we've already rendered an exception
+      render json: api_response.to_json(include_root: false) unless performed?
+    end
+
+    def handle_errors(api_response)
+      return unless api_response.is_a? Hash
+
+      ex = api_response[:exception]
+
+      render json: { errors: ex[:message] }, status: ex[:status]
+    end
+  end
+end

data/app/controllers/supplejack_api/partners_controller.rb

@@ -0,0 +1,39 @@
+# 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 PartnersController < ActionController::Base
+    respond_to :json
+
+    def create
+      if params[:partner][:_id].present?
+        @partner = Partner.find_or_initialize_by(_id: params[:partner][:_id])
+        @partner.update_attributes(params[:partner])
+      else
+        @partner = Partner.create(params[:partner])
+      end
+      render json: @partner
+    end
+
+    def show
+      @partner = Partner.find params[:id]
+      render json: @partner
+    end
+
+    def index
+      @partners = Partner.all
+      render json: @partners
+    end
+
+    def update
+      @partner = Partner.find(params[:id])
+      @partner.update_attributes(params[:partner])
+      render json: @partner
+    end
+  end
+end

data/app/controllers/supplejack_api/records_controller.rb

@@ -0,0 +1,71 @@
+# 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 RecordsController < ApplicationController
+    include SupplejackApi::Concerns::RecordsControllerMetrics
+
+    skip_before_action :authenticate_user!, only: [:source, :status]
+    before_action :set_concept_param, only: :index
+    respond_to :json, :xml, :rss
+
+    def index
+      @search = SupplejackApi::RecordSearch.new(params)
+      @search.request_url = request.original_url
+      @search.scope = current_user
+
+      begin
+        if @search.valid?
+          respond_with @search, serializer: RecordSearchSerializer
+        else
+          render request.format.to_sym => { errors: @search.errors }, status: :bad_request
+        end
+      rescue RSolr::Error::Http => e
+        render request.format.to_sym => { errors: solr_error_message(e) }, status: :bad_request
+      rescue Sunspot::UnrecognizedFieldError => e
+        render request.format.to_sym => { errors: e.to_s }, status: :bad_request
+      end
+    end
+
+    def status
+      render nothing: true
+    end
+
+    def show
+      @record = SupplejackApi::Record.custom_find(params[:id], current_user, params[:search])
+      respond_with @record, serializer: RecordSerializer
+    rescue Mongoid::Errors::DocumentNotFound
+      render request.format.to_sym => { errors: "Record with ID #{params[:id]} was not found" }, status: :not_found
+    end
+
+    def multiple
+      @records = Record.find_multiple(params[:record_ids])
+      respond_with @records
+    end
+
+    # This options are merged with the serializer options. Which will allow the serializer
+    # to know which fields to render for a specific request
+    #
+    def default_serializer_options
+      default_options = {}
+      @search ||= SupplejackApi::RecordSearch.new(params)
+      default_options[:fields] = @search.field_list if @search.field_list.present?
+      default_options[:groups] = @search.group_list if @search.group_list.present?
+      default_options
+    end
+
+    private
+
+    def set_concept_param
+      if params[:concept_id].present?
+        params[:and] ||= {}
+        params[:and][:concept_id] = params[:concept_id]
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/schema_controller.rb

@@ -0,0 +1,19 @@
+# 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 SchemaController < ApplicationController
+    skip_before_filter :authenticate_user!
+    respond_to :json, :xml
+
+    def show
+      @schema_fields = Concept.build_context(ConceptSchema.model_fields.keys)
+      respond_with @schema_fields
+    end
+  end
+end

data/app/controllers/supplejack_api/set_items_controller.rb

@@ -0,0 +1,38 @@
+# 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 SetItemsController < ApplicationController
+    include SupplejackApi::Concerns::SetItemsControllerMetrics
+
+    before_filter :find_user_set
+
+    respond_to :json
+
+    def create
+      @set_item = @user_set.set_items.build(record_params)
+      @user_set.save
+      respond_with @user_set, @set_item
+    end
+
+    def destroy
+      @set_item = @user_set.set_items.find_by_record_id(params[:id])
+      if @set_item
+        @set_item.destroy
+        @user_set.save
+        respond_with @user_set, @set_item
+      else
+        render json: { errors: "The record with id: #{params[:id]} was not found." }, status: :not_found
+      end
+    end
+
+    def record_params
+      params.require(:record).permit(:record_id)
+    end
+  end
+end