supplejack_api 1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fac6e00165771116324b1cd5df5cb74e8d66d0bf
+  data.tar.gz: 5c2a0ff79bfa7d4b23805c1f2926f90aaa7690cd
+SHA512:
+  metadata.gz: ad4a665dbe19895b3f832c1b8a28e45e9e63ded92a07a7bcc554af8451179b110c8eb366d1bc32fdeef1bc27638573417fe8c69e5f20e6305f4fe8c585589f4c
+  data.tar.gz: dcf93cfdf99e4b4e22827956eb592977daadf56eef9a6c4b6e7ec4bbac78f995070e8aea12ad3cbf684449f486a8ec4f089c2a7c08534f7fdb39f95d80a2fb7f

data/README.md

@@ -0,0 +1,80 @@
+# Supplejack API
+
+[![Build Status](https://travis-ci.org/DigitalNZ/supplejack_api.svg?branch=master)](https://travis-ci.org/DigitalNZ/supplejack_api)
+
+The Supplejack API is a [mountable engine](http://guides.rubyonrails.org/engines.html) which provides functionality to store, index and retrieve metadata via an API.
+
+For more information on how to configure and use this application refer to the [documentation](http://digitalnz.github.io/supplejack).
+
+## Installation
+
+[Install & Setup instructions](http://digitalnz.github.io/supplejack/start/development-setup.html)
+
+
+## Engine Development
+
+### Rails console
+
+```
+cd spec/dummy/
+bundle exec rails console
+```
+
+### Rails server
+
+```
+cd spec/dummy/
+bundle exec rails server
+```
+
+### Solr
+
+```
+cd spec/dummy/
+bundle exec rake app:sunspot:solr:start
+``` 
+
+This will start the server based on the configuration in `config/sunspot.yml`
+
+```
+cd spec/dummy/
+bundle exec rake app:sunspot:solr:stop
+```
+
+## Engine Testing
+
+### Rspec Specs
+
+From the root of the engine, run 
+
+```
+bundle exec rspec spec/
+```
+
+This uses `spec/dummy` to mount the engine into and then runs the specs.
+
+### Cucumber Features
+
+From the root of the engine, run
+
+```
+bundle exec cucumber features/
+```
+
+This uses a test Solr instance from `spec/dummy/solr` in order to test searching.
+
+## COPYRIGHT AND LICENSING


+
+### MAJORITY OF SUPPLEJACK CODE - GNU GENERAL PUBLIC LICENCE, VERSION 3


+
+Supplejack is a tool for aggregating, searching and sharing metadata records. Supplejack API is a component of Supplejack. Except as indicated below, the Supplejack API code is Crown copyright (C) 2014, New Zealand Government. Supplejack was created by DigitalNZ at the National Library of NZ and the Department of Internal Affairs. http://digitalnz.org/supplejack
+
+Except as indicated below, this program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses / http://www.gnu.org/licenses/gpl-3.0.txt
+
+### SUPPLEJACK API SUNSPOTSESSIONPROXY


+
+The Supplejack API SunspotSessionProxy was authored by HeyZap (http://www.heyzap.com/) and is available at http://stdout.heyzap.com/2011/08/17/sunspot-resque-session-proxy/.

data/Rakefile

@@ -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
+
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SupplejackApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/javascripts/supplejack_api/application.js

@@ -0,0 +1,26 @@
+/*
+ *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
+ */
+
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require highcharts/highcharts                                                           
+//= require highcharts/highcharts-more                                                         
+//= require highcharts/highstock
+//= require_tree .

data/app/assets/stylesheets/supplejack_api/application.css

@@ -0,0 +1,30 @@
+/*
+ *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
+ */
+
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ *= require foundation
+ */
+
+.table { 
+	width: 100%;
+}
+
+.site-activities, .users {
+	overflow: scroll;
+}

data/app/controllers/supplejack_api/admin/base_controller.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
+  module Admin
+    class BaseController < ApplicationController
+      skip_before_filter :authenticate_user!
+      before_filter :authenticate_admin_user!
+      before_filter :restrict_to_admin_users!
+
+      def restrict_to_admin_users!
+        return if current_admin_user.admin?
+
+        sign_out
+        redirect_to new_admin_user_session_path, alert: t('admin.not_a_admin')
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/admin/sessions_controller.rb

@@ -0,0 +1,25 @@
+# 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 Admin
+    class SessionsController < Devise::SessionsController
+      layout 'supplejack_api/application'
+
+      skip_before_filter :authenticate_user!
+
+      def after_sign_in_path_for(resource)
+        stored_location_for(resource) || admin_users_path
+      end
+
+      def after_sign_out_path_for(_resource_or_scope)
+        new_admin_user_session_path
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/admin/site_activities_controller.rb

@@ -0,0 +1,21 @@
+# 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 Admin
+    class SiteActivitiesController < BaseController
+      respond_to :html
+      respond_to :csv, only: :index
+
+      def index
+        @site_activities = SupplejackApi::SiteActivity.sortable(order: params[:order], page: params[:page])
+                                                      .order_by(date: :desc)
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/admin/users_controller.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
+  module Admin
+    class UsersController < BaseController
+      layout 'supplejack_api/application'
+
+      respond_to :html
+      respond_to :csv, only: :index
+
+      def index
+        @users = User.sortable(order: params[:order] || :daily_requests_desc, page: params[:page])
+      end
+
+      def show
+        @user = User.find(params[:id])
+        @api_requests = LazyHighCharts::HighChart.new('graph') do |f|
+          f.title(text: 'API requests/day for the last 90 days')
+          f.series(name: 'API Requests',
+                   data: @user.requests_per_day(90),
+                   pointStart: 89.days.ago,
+                   pointInterval: 1.day)
+          f.xAxis(type: :datetime)
+          f.yAxis(title: { text: 'Number of Requests' }, min: 0)
+        end
+      end
+
+      def edit
+        @user = User.find(params[:id])
+      end
+
+      def update
+        @user = User.find(params[:id])
+
+        if @user.update_attributes(user_params)
+          redirect_to admin_users_path
+        else
+          render :edit
+        end
+      end
+
+      private
+
+      def user_params
+        params.require(:user).permit(:max_requests)
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/application_controller.rb

@@ -0,0 +1,70 @@
+# 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 ApplicationController < ActionController::Base
+    protect_from_forgery
+
+    before_filter :authenticate_user!
+
+    def authenticate_user!
+      error_message = nil
+
+      if params[:api_key].blank?
+        error_message = I18n.t('users.blank_token')
+      elsif current_user
+        if current_user.over_limit?
+          error_message = I18n.t('users.reached_limit')
+        else
+          current_user.update_tracked_fields(request)
+          current_user.update_daily_activity(request)
+          current_user.check_daily_requests
+          current_user.save(validate: false)
+        end
+      else
+        error_message = I18n.t('users.invalid_token')
+      end
+
+      format = :json
+      format = request.format.to_sym if [:xml, :json, :rss].include?(request.format.try(:to_sym))
+
+      if error_message
+        render format => { errors: error_message }, status: :forbidden
+      end
+    end
+
+    def current_user
+      @current_user ||= User.find_by_api_key(params[:api_key])
+    end
+
+    def authenticate_admin!
+      if RecordSchema.roles[current_user.role.to_sym].try(:admin)
+        return true
+      else
+        render request.format.to_sym => {
+          errors: 'You need Administrator privileges to perform this request'
+        }, status: :forbidden
+        return false
+      end
+    end
+
+    def find_user_set
+      user_set_id = params[:user_set_id] || params[:id]
+
+      @user_set = if RecordSchema.roles[current_user.role.to_sym].try(:admin)
+                    UserSet.custom_find(user_set_id)
+                  else
+                    current_user.user_sets.custom_find(user_set_id)
+                  end
+
+      unless @user_set
+        render json: { errors: "Set with id: #{params[:id]} was not found." }, status: :not_found
+      end
+    end
+  end
+end

data/app/controllers/supplejack_api/concepts_controller.rb

@@ -0,0 +1,52 @@
+# 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 ConceptsController < ApplicationController
+    skip_before_filter :authenticate_user!, only: [:source]
+    skip_before_filter :verify_limits!,     only: [:source]
+
+    respond_to :json, :xml, :rss
+
+    def index
+      @search = ConceptSearch.new(params)
+      @search.request_url = request.original_url
+      @search.scope = current_user
+
+      begin
+        if @search.valid?
+          respond_with @search, serializer: ConceptSearchSerializer
+        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 show
+      @concept = SupplejackApi::Concept.custom_find(params[:id], current_user, params[:search])
+      respond_with @concept, root: false, serializer: ConceptSerializer
+    rescue Mongoid::Errors::DocumentNotFound
+      render request.format.to_sym => { errors: "Concept with ID #{params[:id]} was not found" }, status: :not_found
+    end
+
+    def default_serializer_options
+      default_options = {}
+      @search ||= SupplejackApi::ConceptSearch.new(params)
+      default_options[:fields] = @search.field_list if @search.field_list.present?
+      default_options[:groups] = @search.group_list if @search.group_list.present?
+      if params[:inline_context].try(:downcase) == 'true'
+        default_options[:inline_context] = params[:inline_context]
+      end
+      default_options
+    end
+  end
+end