supplejack_api 1

data/app/controllers/supplejack_api/sources_controller.rb

@@ -0,0 +1,67 @@
+# 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 SourcesController < ActionController::Base
+    respond_to :json
+
+    def create
+      params[:source][:partner_id] = params[:partner_id]
+      if params[:source][:_id].present?
+        @source = Source.find_or_initialize_by(_id: params[:source][:_id])
+        @source.update_attributes(params[:source])
+      else
+        @source = Source.create(params[:source])
+      end
+
+      render json: @source
+    end
+
+    def index
+      @sources = params[:source].nil? ? Source.all : Source.where(params[:source])
+      render json: @sources
+    end
+
+    def show
+      @source = Source.find(params[:id])
+      render json: @source
+    end
+
+    def update
+      @source = Source.find(params[:id])
+      @source.update_attributes(params[:source])
+      render json: @source
+    end
+
+    def reindex
+      @source = Source.find(params[:id])
+      Resque.enqueue(IndexSourceWorker, @source.source_id, params[:date])
+
+      render nothing: true
+    end
+
+    def link_check_records
+      @source = Source.find(params[:id])
+      @records = []
+
+      @records += first_two_records(@source.source_id, :oldest).map(&:source_url)
+      @records += first_two_records(@source.source_id, :latest).map(&:source_url)
+
+      render json: @records.to_json
+    end
+
+    private
+
+    def first_two_records(source_id, direction)
+      sort = direction == :latest ? -1 : 1
+      records = Record.where('fragments.source_id' => source_id, :status => 'active')
+                      .sort('fragments.syndication_date' => sort)
+      records.limit(2).to_a
+    end
+  end
+end

data/app/controllers/supplejack_api/status_controller.rb

@@ -0,0 +1,67 @@
+# 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
+  # rubocop:disable Metrics/LineLength
+  # FIXME: make log lines smaller
+  class StatusController < ApplicationController
+    skip_before_filter :authenticate_user!, only: [:show]
+    skip_before_filter :verify_limits!,     only: [:show]
+    around_filter :handle_timeout, only: :show
+
+    newrelic_ignore if defined? NewRelic
+
+    TIMEOUT = 10.seconds
+
+    def show
+      both_ok = Timeout.timeout(TIMEOUT) do
+        solr_ok = solr_up?
+        mongo_ok = mongod_up?
+        solr_ok && mongo_ok
+      end
+
+      if both_ok
+        render status: 200, nothing: true
+      else
+        render status: 500, nothing: true
+      end
+    rescue Timeout::Error => e
+      Support::StatusLogger.logger.error("Solr or MongoDB is down or took longer than #{TIMEOUT} seconds to respond. Exception is #{e}.\nBacktrace #{e.backtrace[0..2].join("\n")}")
+
+      render status: 500, nothing: true
+    end
+
+    private
+
+    def handle_timeout
+      time = Benchmark.ms { yield }
+      Support::StatusLogger.logger.warn("/status request took #{time.round}ms to complete") if time > 5000
+    end
+
+    def solr_up?
+      resource = RestClient.get ENV['SOLR_PING'], open_timeout: 5
+      success = Hash.from_xml(resource)['response']['str'] == 'OK'
+      Support::StatusLogger.logger.error("Solr ping command not successful. Ping output: #{Hash.from_xml(resource)['response']}") unless success
+      success
+    rescue StandardError => e
+      Support::StatusLogger.logger.error("Exception when attempting to ping Solr. Exception is #{e}.\nBacktrace #{e.backtrace[0..2].join("\n")}")
+      false
+    end
+
+    def mongod_up?
+      session = Record.collection.database.session
+      success = session.command(ping: 1)['ok'] == 1
+      Support::StatusLogger.logger.error("MongoDB ping command not successful. Ping output: #{session.command(ping: 1)}") unless success
+      success
+    rescue StandardError => e
+      Support::StatusLogger.logger.error("Exception when attempting to ping MongoDB. Exception is #{e}.\nBacktrace #{e.backtrace[0..2].join("\n")}")
+      false
+    end
+  end
+  # rubocop:enable Metrics/LineLength
+end

data/app/controllers/supplejack_api/user_sets_controller.rb

@@ -0,0 +1,97 @@
+# 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 UserSetsController < ApplicationController
+    include Concerns::UserSetsControllerMetrics
+
+    respond_to :json
+
+    prepend_before_filter :find_user_set, only: [:update, :destroy]
+    before_filter :authenticate_admin!, only: [:admin_index, :public_index]
+
+    def index
+      @user_sets = current_user.user_sets
+      render json: serializable_array(@user_sets).to_json
+    end
+
+    # Endpoint for the administrator to get a list of sets for any user.
+    #
+    def admin_index
+      @user = User.find_by_api_key(params[:user_id])
+
+      if @user
+        @user_sets = @user.user_sets
+        render json: serializable_array(@user_sets).to_json
+      else
+        render json: { errors: "The user with api key: '#{params[:user_id]}' was not found" }, status: :not_found
+      end
+    end
+
+    # Enpoint for the administrator to fetch a list of all public sets
+    #
+    def public_index
+      @user_sets = UserSet.public_sets(page: params[:page])
+      render json: serializable_array(@user_sets, user: true, total: true).to_json
+    end
+
+    def featured_sets_index
+      @user_sets = UserSet.featured_sets(4)
+      render json: serializable_array(@user_sets, user: true, featured: true).to_json
+    end
+
+    def show
+      @user_set = UserSet.custom_find(params[:id])
+      if @user_set
+        render json: UserSetSerializer.new(@user_set, user: current_user)
+      else
+        render json: { errors: "Set with id: #{params[:id]} was not found." }, status: :not_found
+      end
+    end
+
+    def create
+      @user_set = current_user.user_sets.build
+      if @user_set.update_attributes_and_embedded(params[:set])
+        render json: UserSetSerializer.new(@user_set, user: true)
+      else
+        render json: { errors: @user_set.errors.to_hash }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      if @user_set.update_attributes_and_embedded(params[:set], current_user)
+        render json: UserSetSerializer.new(@user_set, user: true)
+      else
+        render json: { errors: @user_set.errors.to_hash }, status: :unprocessable_entity
+      end
+    end
+
+    def destroy
+      @user_set.destroy
+      respond_with(@user_set)
+    end
+
+    private
+
+    def serializable_array(user_sets, options = {})
+      options.reverse_merge!(root: false, items: false, user: false, total: false)
+      hash = { 'sets' => [] }
+      user_sets.each do |set|
+        hash['sets'] << UserSetSerializer.new(set, options).as_json
+      end
+      hash['total'] = UserSet.public_sets_count if options[:total]
+      hash
+    end
+
+    rescue_from UserSet::WrongRecordsFormat do |_exception|
+      render json: {
+        errors: { records: ['The records array is not in a valid format.'] }
+      }, status: :unprocessable_entity
+    end
+  end
+end

data/app/controllers/supplejack_api/users_controller.rb

@@ -0,0 +1,49 @@
+# 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 UsersController < ApplicationController
+    respond_to :xml, :json
+    before_filter :authenticate_admin!, except: :show
+
+    def show
+      @user = User.custom_find(params[:id])
+      respond_with @user, serializer: UserSerializer
+    end
+
+    def create
+      @user = User.create(user_params)
+      respond_with @user, location: user_url(@user), serializer: UserSerializer
+    end
+
+    def update
+      @user = User.custom_find(params[:id])
+      @user.update_attributes(user_params)
+      render json: @user, serializer: UserSerializer
+    end
+
+    def destroy
+      @user = User.custom_find(params[:id])
+      @user.destroy
+      respond_with @user
+    end
+
+    private
+
+    def user_params
+      params.require(:user).permit(
+        :name,
+        :username,
+        :email,
+        :encrypted_password,
+        :authentication_token,
+        sets: [:name, :privacy, :priority]
+      )
+    end
+  end
+end

data/app/helpers/supplejack_api/application_helper.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
+  module ApplicationHelper
+    def flash_messages
+      return nil if flash.empty?
+
+      flash.map do |type, message|
+        type = :success if type.to_s == 'notice'
+        content_tag(:div, message, class: "alert-box #{type} margin-top")
+      end.join.html_safe
+    end
+
+    def sortable(klass, column)
+      path = "admin_#{klass.to_s.tableize}_path"
+      sort_column, sort_direction = extract_sort_info
+      direction = column == sort_column && sort_direction == 'asc' ? 'desc' : 'asc'
+      css_class = column == sort_column ? "current #{sort_direction}" : nil
+
+      label = safe_join([t("#{klass.to_s.tableize}.#{column}", default: column.titleize), content_tag(:span)])
+      link_to label, send(path, order: "#{column}_#{direction}"), class: css_class
+    end
+
+    def extract_sort_info
+      return unless params[:order].to_s =~ /^([\w\_\.]+)_(desc|asc)$/
+
+      @sort_column = Regexp.last_match(1)
+      @sort_direction = Regexp.last_match(2)
+
+      [@sort_column, @sort_direction]
+    end
+  end
+end

data/app/helpers/supplejack_api/facets_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module SupplejackApi
+  module FacetsHelper
+    # Given a facet key, returns list of facets under that key
+    #
+    # @parameter facet_key [String] facet to retrieve all values of
+    # @returns [Array<String>] all values for this facet
+    def get_list_of_facet_values(facet_key)
+      facets_list = []
+      facets_page = 1
+
+      loop do
+        s = RecordSearch.new(facets: facet_key, facets_per_page: 150, facets_page: facets_page)
+        # HACK: We override SearchSerializable#facets_list in the api_app to
+        # replace :display_collection with :primary_collection, this transparently fixes it
+        mappings = { primary_collection: :display_collection }
+        facets = Hash[s.facets_hash.map { |k, v| [mappings[k] || k, v] }][facet_key.to_sym]
+
+        # Gone past last page of facets
+        break if facets.length.zero?
+
+        facets_list << facets.keys
+        facets_page += 1
+      end
+
+      facets_list.flatten
+    end
+    module_function :get_list_of_facet_values
+  end
+end

data/app/mailers/supplejack_api/request_limit_mailer.rb

@@ -0,0 +1,43 @@
+# 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 RequestLimitMailer < ActionMailer::Base
+    default from: ENV['REQUEST_LIMIT_MAILER']
+
+    def at90percent(user)
+      @limit = user.max_requests
+
+      mail(to: [user.email].join(', '),
+           subject: 'Your API key has exceeded 90% of its daily limit')
+    end
+
+    def at100percent(user)
+      @limit = user.max_requests
+
+      mail(to: [user.email].join(', '),
+           subject: 'Your API key exceeded its daily limit')
+    end
+
+    def at90percent_admin(user)
+      @limit = user.max_requests
+      @email = user.email
+
+      mail(to: ENV['REQUEST_LIMIT_MAILER'],
+           subject: 'A API key has exceeded 90% of its daily limit')
+    end
+
+    def at100percent_admin(user)
+      @limit = user.max_requests
+      @email = user.email
+
+      mail(to: ENV['REQUEST_LIMIT_MAILER'],
+           subject: 'A API key exceeded its daily limit')
+    end
+  end
+end

data/app/models/supplejack_api/api_concept/concept_fragment.rb

@@ -0,0 +1,31 @@
+# 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 ApiConcept
+    class ConceptFragment < SupplejackApi::Fragment
+      embedded_in :concept
+
+      delegate :concept_id, to: :concept
+
+      def self.schema_class
+        ConceptSchema
+      end
+
+      build_mongoid_schema
+
+      def self.mutable_fields
+        @@mutable_fields ||= begin
+                               immutable_fields = %w(_id _type source_id created_at updated_at)
+                               mutable_fields = fields.keys - immutable_fields
+                               Hash[mutable_fields.map { |name| [name, fields[name].type] }]
+                             end.freeze
+      end
+    end
+  end
+end

data/app/models/supplejack_api/api_record/record_fragment.rb

@@ -0,0 +1,15 @@
+# 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 ApiRecord
+    class RecordFragment < SupplejackApi::Fragment
+      include SupplejackApi::Concerns::RecordFragmentable
+    end
+  end
+end